data/rbot/plugins/rss.rb

   1 #-- vim:sw=2:et\r
   2 #++\r
   3 #\r
   4 # :title: RSS feed plugin for rbot\r
   5 #\r
   6 # Author:: Stanislav Karchebny <berkus@madfire.net>\r
   7 # Author:: Ian Monroe <ian@monroe.nu>\r
   8 # Author:: Mark Kretschmann <markey@web.de>\r
   9 # Author:: Giuseppe Bilotta <giuseppe.bilotta@gmail.com>\r
  10 #\r
  11 # Copyright:: (C) 2004 Stanislav Karchebny\r
  12 # Copyright:: (C) 2005 Ian Monroe, Mark Kretschmann\r
  13 # Copyright:: (C) 2006-2007 Giuseppe Bilotta\r
  14 #\r
  15 # License:: MIT license\r
  16 \r
  17 require 'rss'\r
  18 \r
  19 module ::RSS\r
  20 \r
  21   # Make an  'unique' ID for a given item, based on appropriate bot options\r
  22   # Currently only suppored is bot.config['rss.show_updated']: when true, the\r
  23   # description is included in the uid hashing, otherwise it's not\r
  24   #\r
  25   def RSS.item_uid_for_bot(item, opts={})\r
  26     options = { :show_updated => true}.merge(opts)\r
  27     desc = options[:show_updated] ? item.description : nil\r
  28     [item.title, item.link, desc].hash\r
  29   end\r
  30 \r
  31   # Add support for Slashdot namespace in RDF. The code is just an adaptation\r
  32   # of the DublinCore code.\r
  33   unless defined?(SLASH_PREFIX)\r
  34     SLASH_PREFIX = 'slash'\r
  35     SLASH_URI = "http://purl.org/rss/1.0/modules/slash/"\r
  36 \r
  37     RDF.install_ns(SLASH_PREFIX, SLASH_URI)\r
  38 \r
  39     module BaseSlashModel\r
  40       def append_features(klass)\r
  41         super\r
  42 \r
  43         return if klass.instance_of?(Module)\r
  44         SlashModel::ELEMENT_NAME_INFOS.each do |name, plural_name|\r
  45           plural = plural_name || "#{name}s"\r
  46           full_name = "#{SLASH_PREFIX}_#{name}"\r
  47           full_plural_name = "#{SLASH_PREFIX}_#{plural}"\r
  48           klass_name = "Slash#{Utils.to_class_name(name)}"\r
  49           klass.install_must_call_validator(SLASH_PREFIX, SLASH_URI)\r
  50           klass.install_have_children_element(name, SLASH_URI, "*",\r
  51                                               full_name, full_plural_name)\r
  52           klass.module_eval(<<-EOC, *get_file_and_line_from_caller(0))\r
  53           remove_method :#{full_name}\r
  54           remove_method :#{full_name}=\r
  55           remove_method :set_#{full_name}\r
  56 \r
  57           def #{full_name}\r
  58             @#{full_name}.first and @#{full_name}.first.value\r
  59           end\r
  60 \r
  61           def #{full_name}=(new_value)\r
  62             @#{full_name}[0] = Utils.new_with_value_if_need(#{klass_name}, new_value)\r
  63           end\r
  64           alias set_#{full_name} #{full_name}=\r
  65         EOC\r
  66         end\r
  67       end\r
  68     end\r
  69 \r
  70     module SlashModel\r
  71       extend BaseModel\r
  72       extend BaseSlashModel\r
  73 \r
  74       TEXT_ELEMENTS = {\r
  75       "department" => nil,\r
  76       "section" => nil,\r
  77       "comments" =>  nil,\r
  78       "hit_parade" => nil\r
  79       }\r
  80 \r
  81       ELEMENT_NAME_INFOS = SlashModel::TEXT_ELEMENTS.to_a\r
  82 \r
  83       ELEMENTS = TEXT_ELEMENTS.keys\r
  84 \r
  85       ELEMENTS.each do |name, plural_name|\r
  86         module_eval(<<-EOC, *get_file_and_line_from_caller(0))\r
  87         class Slash#{Utils.to_class_name(name)} < Element\r
  88           include RSS10\r
  89 \r
  90           content_setup\r
  91 \r
  92           class << self\r
  93             def required_prefix\r
  94               SLASH_PREFIX\r
  95             end\r
  96 \r
  97             def required_uri\r
  98               SLASH_URI\r
  99             end\r
 100           end\r
 101 \r
 102           @tag_name = #{name.dump}\r
 103 \r
 104           alias_method(:value, :content)\r
 105           alias_method(:value=, :content=)\r
 106 \r
 107           def initialize(*args)\r
 108             if Utils.element_initialize_arguments?(args)\r
 109               super\r
 110             else\r
 111               super()\r
 112               self.content = args[0]\r
 113             end\r
 114           end\r
 115 \r
 116           def full_name\r
 117             tag_name_with_prefix(SLASH_PREFIX)\r
 118           end\r
 119 \r
 120           def maker_target(target)\r
 121             target.new_#{name}\r
 122           end\r
 123 \r
 124           def setup_maker_attributes(#{name})\r
 125             #{name}.content = content\r
 126           end\r
 127         end\r
 128       EOC\r
 129       end\r
 130     end\r
 131 \r
 132     class RDF\r
 133       class Item; include SlashModel; end\r
 134     end\r
 135 \r
 136     SlashModel::ELEMENTS.each do |name|\r
 137       class_name = Utils.to_class_name(name)\r
 138       BaseListener.install_class_name(SLASH_URI, name, "Slash#{class_name}")\r
 139     end\r
 140 \r
 141     SlashModel::ELEMENTS.collect! {|name| "#{SLASH_PREFIX}_#{name}"}\r
 142   end\r
 143 end\r
 144 \r
 145 \r
 146 class ::RssBlob\r
 147   attr_accessor :url\r
 148   attr_accessor :handle\r
 149   attr_accessor :type\r
 150   attr :watchers\r
 151   attr_accessor :refresh_rate\r
 152   attr_accessor :xml\r
 153   attr_accessor :title\r
 154   attr_accessor :items\r
 155   attr_accessor :mutex\r
 156 \r
 157   def initialize(url,handle=nil,type=nil,watchers=[], xml=nil)\r
 158     @url = url\r
 159     if handle\r
 160       @handle = handle\r
 161     else\r
 162       @handle = url\r
 163     end\r
 164     @type = type\r
 165     @watchers=[]\r
 166     @refresh_rate = nil\r
 167     @xml = xml\r
 168     @title = nil\r
 169     @items = nil\r
 170     @mutex = Mutex.new\r
 171     sanitize_watchers(watchers)\r
 172   end\r
 173 \r
 174   def dup\r
 175     @mutex.synchronize do\r
 176       self.class.new(@url,\r
 177                      @handle,\r
 178                      @type ? @type.dup : nil,\r
 179                      @watchers.dup,\r
 180                      @xml ? @xml.dup : nil)\r
 181     end\r
 182   end\r
 183 \r
 184   # Downcase all watchers, possibly turning them into Strings if they weren't\r
 185   def sanitize_watchers(list=@watchers)\r
 186     ls = list.dup\r
 187     @watchers.clear\r
 188     ls.each { |w|\r
 189       add_watch(w)\r
 190     }\r
 191   end\r
 192 \r
 193   def watched?\r
 194     !@watchers.empty?\r
 195   end\r
 196 \r
 197   def watched_by?(who)\r
 198     @watchers.include?(who.downcase)\r
 199   end\r
 200 \r
 201   def add_watch(who)\r
 202     if watched_by?(who)\r
 203       return nil\r
 204     end\r
 205     @mutex.synchronize do\r
 206       @watchers << who.downcase\r
 207     end\r
 208     return who\r
 209   end\r
 210 \r
 211   def rm_watch(who)\r
 212     @mutex.synchronize do\r
 213       @watchers.delete(who.downcase)\r
 214     end\r
 215   end\r
 216 \r
 217   def to_a\r
 218     [@handle,@url,@type,@refresh_rate,@watchers]\r
 219   end\r
 220 \r
 221   def to_s(watchers=false)\r
 222     if watchers\r
 223       a = self.to_a.flatten\r
 224     else\r
 225       a = self.to_a[0,3]\r
 226     end\r
 227     a.compact.join(" | ")\r
 228   end\r
 229 end\r
 230 \r
 231 class RSSFeedsPlugin < Plugin\r
 232   BotConfig.register BotConfigIntegerValue.new('rss.head_max',\r
 233     :default => 100, :validate => Proc.new{|v| v > 0 && v < 200},\r
 234     :desc => "How many characters to use of a RSS item header")\r
 235 \r
 236   BotConfig.register BotConfigIntegerValue.new('rss.text_max',\r
 237     :default => 200, :validate => Proc.new{|v| v > 0 && v < 400},\r
 238     :desc => "How many characters to use of a RSS item text")\r
 239 \r
 240   BotConfig.register BotConfigIntegerValue.new('rss.thread_sleep',\r
 241     :default => 300, :validate => Proc.new{|v| v > 30},\r
 242     :desc => "How many seconds to sleep before checking RSS feeds again")\r
 243 \r
 244   BotConfig.register BotConfigBooleanValue.new('rss.show_updated',\r
 245     :default => true,\r
 246     :desc => "Whether feed items for which the description was changed should be shown as new")\r
 247 \r
 248   # We used to save the Mutex with the RssBlob, which was idiotic. And\r
 249   # since Mutexes dumped in one version might not be resotrable in another,\r
 250   # we need a few tricks to be able to restore data from other versions of Ruby\r
 251   #\r
 252   # When migrating 1.8.6 => 1.8.5, all we need to do is define an empty\r
 253   # #marshal_load() method for Mutex. For 1.8.5 => 1.8.6 we need something\r
 254   # dirtier, as seen later on in the initialization code.\r
 255   unless Mutex.new.respond_to?(:marshal_load)\r
 256     class ::Mutex\r
 257       def marshal_load(str)\r
 258         return\r
 259       end\r
 260     end\r
 261   end\r
 262 \r
 263   attr_reader :feeds\r
 264 \r
 265   def initialize\r
 266     super\r
 267     if @registry.has_key?(:feeds)\r
 268       # When migrating from Ruby 1.8.5 to 1.8.6, dumped Mutexes may render the\r
 269       # data unrestorable. If this happens, we patch the data, thus allowing\r
 270       # the restore to work.\r
 271       #\r
 272       # This is actually pretty safe for a number of reasons:\r
 273       #  * the code is only called if standard marshalling fails\r
 274       #  * the string we look for is quite unlikely to appear randomly\r
 275       #  * if the string appears somewhere and the patched string isn't recoverable\r
 276       #    either, we'll get another (unrecoverable) error, which makes the rss\r
 277       #    plugin unsable, just like it was if no recovery was attempted\r
 278       #  * if the string appears somewhere and the patched string is recoverable,\r
 279       #    we may get a b0rked feed, which is eventually overwritten by a clean\r
 280       #    one, so the worst thing that can happen is that a feed update spams\r
 281       #    the watchers once\r
 282       @registry.recovery = Proc.new { |val|\r
 283         patched = val.sub(":\v@mutexo:\nMutex", ":\v@mutexo:\vObject")\r
 284         ret = Marshal.restore(patched)\r
 285         ret.each_value { |blob|\r
 286           blob.mutex = nil\r
 287           blob\r
 288         }\r
 289       }\r
 290 \r
 291       @feeds = @registry[:feeds]\r
 292       raise unless @feeds\r
 293 \r
 294       @registry.recovery = nil\r
 295 \r
 296       @feeds.keys.grep(/[A-Z]/) { |k|\r
 297         @feeds[k.downcase] = @feeds[k]\r
 298         @feeds.delete(k)\r
 299       }\r
 300       @feeds.each { |k, f|\r
 301         f.mutex = Mutex.new\r
 302         f.sanitize_watchers\r
 303         parseRss(f) if f.xml\r
 304       }\r
 305     else\r
 306       @feeds = Hash.new\r
 307     end\r
 308     @watch = Hash.new\r
 309     rewatch_rss\r
 310   end\r
 311 \r
 312   def name\r
 313     "rss"\r
 314   end\r
 315 \r
 316   def watchlist\r
 317     @feeds.select { |h, f| f.watched? }\r
 318   end\r
 319 \r
 320   def cleanup\r
 321     stop_watches\r
 322     super\r
 323   end\r
 324 \r
 325   def save\r
 326     unparsed = Hash.new()\r
 327     @feeds.each { |k, f|\r
 328       unparsed[k] = f.dup\r
 329       # we don't want to save the mutex\r
 330       unparsed[k].mutex = nil\r
 331     }\r
 332     @registry[:feeds] = unparsed\r
 333   end\r
 334 \r
 335   def stop_watch(handle)\r
 336     if @watch.has_key?(handle)\r
 337       begin\r
 338         debug "Stopping watch #{handle}"\r
 339         @bot.timer.remove(@watch[handle])\r
 340         @watch.delete(handle)\r
 341       rescue Exception => e\r
 342         report_problem("Failed to stop watch for #{handle}", e, nil)\r
 343       end\r
 344     end\r
 345   end\r
 346 \r
 347   def stop_watches\r
 348     @watch.each_key { |k|\r
 349       stop_watch(k)\r
 350     }\r
 351   end\r
 352 \r
 353   def help(plugin,topic="")\r
 354     case topic\r
 355     when "show"\r
 356       "rss show #{Bold}handle#{Bold} [#{Bold}limit#{Bold}] : show #{Bold}limit#{Bold} (default: 5, max: 15) entries from rss #{Bold}handle#{Bold}; #{Bold}limit#{Bold} can also be in the form a..b, to display a specific range of items"\r
 357     when "list"\r
 358       "rss list [#{Bold}handle#{Bold}] : list all rss feeds (matching #{Bold}handle#{Bold})"\r
 359     when "watched"\r
 360       "rss watched [#{Bold}handle#{Bold}] [in #{Bold}chan#{Bold}]: list all watched rss feeds (matching #{Bold}handle#{Bold}) (in channel #{Bold}chan#{Bold})"\r
 361     when "who", "watches", "who watches"\r
 362       "rss who watches [#{Bold}handle#{Bold}]]: list all watchers for rss feeds (matching #{Bold}handle#{Bold})"\r
 363     when "add"\r
 364       "rss add #{Bold}handle#{Bold} #{Bold}url#{Bold} [#{Bold}type#{Bold}] : add a new rss called #{Bold}handle#{Bold} from url #{Bold}url#{Bold} (of type #{Bold}type#{Bold})"\r
 365     when "change"\r
 366       "rss change #{Bold}what#{Bold} of #{Bold}handle#{Bold} to #{Bold}new#{Bold} : change the #{Underline}handle#{Underline}, #{Underline}url#{Underline}, #{Underline}type#{Underline} or #{Underline}refresh#{Underline} rate of rss called #{Bold}handle#{Bold} to value #{Bold}new#{Bold}"\r
 367     when /^(del(ete)?|rm)$/\r
 368       "rss del(ete)|rm #{Bold}handle#{Bold} : delete rss feed #{Bold}handle#{Bold}"\r
 369     when "replace"\r
 370       "rss replace #{Bold}handle#{Bold} #{Bold}url#{Bold} [#{Bold}type#{Bold}] : try to replace the url of rss called #{Bold}handle#{Bold} with #{Bold}url#{Bold} (of type #{Bold}type#{Bold}); only works if nobody else is watching it"\r
 371     when "forcereplace"\r
 372       "rss forcereplace #{Bold}handle#{Bold} #{Bold}url#{Bold} [#{Bold}type#{Bold}] : replace the url of rss called #{Bold}handle#{Bold} with #{Bold}url#{Bold} (of type #{Bold}type#{Bold})"\r
 373     when "watch"\r
 374       "rss watch #{Bold}handle#{Bold} [#{Bold}url#{Bold} [#{Bold}type#{Bold}]]  [in #{Bold}chan#{Bold}]: watch rss #{Bold}handle#{Bold} for changes (in channel #{Bold}chan#{Bold}); when the other parameters are present, the feed will be created if it doesn't exist yet"\r
 375     when /(un|rm)watch/\r
 376       "rss unwatch|rmwatch #{Bold}handle#{Bold} [in #{Bold}chan#{Bold}]: stop watching rss #{Bold}handle#{Bold} (in channel #{Bold}chan#{Bold}) for changes"\r
 377     when "rewatch"\r
 378       "rss rewatch : restart threads that watch for changes in watched rss"\r
 379     else\r
 380       "manage RSS feeds: rss show|list|watched|add|change|del(ete)|rm|(force)replace|watch|unwatch|rmwatch|rewatch"\r
 381     end\r
 382   end\r
 383 \r
 384   def report_problem(report, e=nil, m=nil)\r
 385     if m && m.respond_to?(:reply)\r
 386       m.reply report\r
 387     else\r
 388       warning report\r
 389     end\r
 390     if e\r
 391       debug e.inspect\r
 392       debug e.backtrace.join("\n") if e.respond_to?(:backtrace)\r
 393     end\r
 394   end\r
 395 \r
 396   def show_rss(m, params)\r
 397     handle = params[:handle]\r
 398     lims = params[:limit].to_s.match(/(\d+)(?:..(\d+))?/)\r
 399     debug lims.to_a.inspect\r
 400     if lims[2]\r
 401       ll = [[lims[1].to_i-1,lims[2].to_i-1].min,  0].max\r
 402       ul = [[lims[1].to_i-1,lims[2].to_i-1].max, 14].min\r
 403       rev = lims[1].to_i > lims[2].to_i\r
 404     else\r
 405       ll = 0\r
 406       ul = [[lims[1].to_i-1, 0].max, 14].min\r
 407       rev = false\r
 408     end\r
 409 \r
 410     feed = @feeds.fetch(handle.downcase, nil)\r
 411     unless feed\r
 412       m.reply "I don't know any feeds named #{handle}"\r
 413       return\r
 414     end\r
 415 \r
 416     m.reply "lemme fetch it..."\r
 417     title = items = nil\r
 418     we_were_watching = false\r
 419 \r
 420     if @watch.key?(feed.handle)\r
 421       # If a feed is being watched, we run the watcher thread\r
 422       # so that all watchers can be informed of changes to\r
 423       # the feed. Before we do that, though, we remove the\r
 424       # show requester from the watchlist, if present, lest\r
 425       # he gets the update twice.\r
 426       if feed.watched_by?(m.replyto)\r
 427         we_were_watching = true\r
 428         feed.rm_watch(m.replyto)\r
 429       end\r
 430       @bot.timer.reschedule(@watch[feed.handle], 0)\r
 431       if we_were_watching\r
 432         feed.add_watch(m.replyto)\r
 433       end\r
 434     else\r
 435       fetched = fetchRss(feed, m, false)\r
 436     end\r
 437     return unless fetched or feed.xml\r
 438     if not fetched and feed.items\r
 439       m.reply "using old data"\r
 440     else\r
 441       parsed = parseRss(feed, m)\r
 442       m.reply "using old data" unless parsed\r
 443     end\r
 444     return unless feed.items\r
 445     title = feed.title\r
 446     items = feed.items\r
 447 \r
 448     # We sort the feeds in freshness order (newer ones first)\r
 449     items = freshness_sort(items)\r
 450     disp = items[ll..ul]\r
 451     disp.reverse! if rev\r
 452 \r
 453     m.reply "Channel : #{title}"\r
 454     disp.each do |item|\r
 455       printFormattedRss(feed, item, {:places=>[m.replyto],:handle=>nil,:date=>true})\r
 456     end\r
 457   end\r
 458 \r
 459   def itemDate(item,ex=nil)\r
 460     return item.pubDate if item.respond_to?(:pubDate) and item.pubDate\r
 461     return item.date if item.respond_to?(:date) and item.date\r
 462     return ex\r
 463   end\r
 464 \r
 465   def freshness_sort(items)\r
 466     notime = Time.at(0)\r
 467     items.sort { |a, b|\r
 468       itemDate(b, notime) <=> itemDate(a, notime)\r
 469     }\r
 470   end\r
 471 \r
 472   def list_rss(m, params)\r
 473     wanted = params[:handle]\r
 474     reply = String.new\r
 475     @feeds.each { |handle, feed|\r
 476       next if wanted and !handle.match(/#{wanted}/i)\r
 477       reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})"\r
 478       (reply << " refreshing every #{Utils.secs_to_string(feed.refresh_rate)}") if feed.refresh_rate\r
 479       (reply << " (watched)") if feed.watched_by?(m.replyto)\r
 480       reply << "\n"\r
 481     }\r
 482     if reply.empty?\r
 483       reply = "no feeds found"\r
 484       reply << " matching #{wanted}" if wanted\r
 485     end\r
 486     m.reply reply, :max_lines => reply.length\r
 487   end\r
 488 \r
 489   def watched_rss(m, params)\r
 490     wanted = params[:handle]\r
 491     chan = params[:chan] || m.replyto\r
 492     reply = String.new\r
 493     watchlist.each { |handle, feed|\r
 494       next if wanted and !handle.match(/#{wanted}/i)\r
 495       next unless feed.watched_by?(chan)\r
 496       reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})"\r
 497       (reply << " refreshing every #{Utils.secs_to_string(feed.refresh_rate)}") if feed.refresh_rate\r
 498       reply << "\n"\r
 499     }\r
 500     if reply.empty?\r
 501       reply = "no watched feeds"\r
 502       reply << " matching #{wanted}" if wanted\r
 503     end\r
 504     m.reply reply\r
 505   end\r
 506 \r
 507   def who_watches(m, params)\r
 508     wanted = params[:handle]\r
 509     reply = String.new\r
 510     watchlist.each { |handle, feed|\r
 511       next if wanted and !handle.match(/#{wanted}/i)\r
 512       reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})"\r
 513       (reply << " refreshing every #{Utils.secs_to_string(feed.refresh_rate)}") if feed.refresh_rate\r
 514       reply << ": watched by #{feed.watchers.join(', ')}"\r
 515       reply << "\n"\r
 516     }\r
 517     if reply.empty?\r
 518       reply = "no watched feeds"\r
 519       reply << " matching #{wanted}" if wanted\r
 520     end\r
 521     m.reply reply\r
 522   end\r
 523 \r
 524   def add_rss(m, params, force=false)\r
 525     handle = params[:handle]\r
 526     url = params[:url]\r
 527     unless url.match(/https?/)\r
 528       m.reply "I only deal with feeds from HTTP sources, so I can't use #{url} (maybe you forgot the handle?)"\r
 529       return\r
 530     end\r
 531     type = params[:type]\r
 532     if @feeds.fetch(handle.downcase, nil) && !force\r
 533       m.reply "There is already a feed named #{handle} (URL: #{@feeds[handle.downcase].url})"\r
 534       return\r
 535     end\r
 536     unless url\r
 537       m.reply "You must specify both a handle and an url to add an RSS feed"\r
 538       return\r
 539     end\r
 540     @feeds[handle.downcase] = RssBlob.new(url,handle,type)\r
 541     reply = "Added RSS #{url} named #{handle}"\r
 542     if type\r
 543       reply << " (format: #{type})"\r
 544     end\r
 545     m.reply reply\r
 546     return handle\r
 547   end\r
 548 \r
 549   def change_rss(m, params)\r
 550     handle = params[:handle].downcase\r
 551     feed = @feeds.fetch(handle, nil)\r
 552     unless feed\r
 553       m.reply "No such feed with handle #{handle}"\r
 554       return\r
 555     end\r
 556     case params[:what].intern\r
 557     when :handle\r
 558       new = params[:new].downcase\r
 559       if @feeds.key?(new) and @feeds[new]\r
 560         m.reply "There already is a feed with handle #{new}"\r
 561         return\r
 562       else\r
 563         feed.mutex.synchronize do\r
 564           @feeds[new] = feed\r
 565           @feeds.delete(handle)\r
 566           feed.handle = new\r
 567         end\r
 568         handle = new\r
 569       end\r
 570     when :url\r
 571       new = params[:new]\r
 572       feed.mutex.synchronize do\r
 573         feed.url = new\r
 574       end\r
 575     when :format, :type\r
 576       new = params[:new]\r
 577       new = nil if new == 'default'\r
 578       feed.mutex.synchronize do\r
 579         feed.type = new\r
 580       end\r
 581     when :refresh\r
 582       new = params[:new].to_i\r
 583       new = nil if new == 0\r
 584       feed.mutex.synchronize do\r
 585         feed.refresh_rate = new\r
 586       end\r
 587     else\r
 588       m.reply "Don't know how to change #{params[:what]} for feeds"\r
 589       return\r
 590     end\r
 591     m.reply "Feed changed:"\r
 592     list_rss(m, {:handle => handle})\r
 593   end\r
 594 \r
 595   def del_rss(m, params, pass=false)\r
 596     feed = unwatch_rss(m, params, true)\r
 597     return unless feed\r
 598     if feed.watched?\r
 599       m.reply "someone else is watching #{feed.handle}, I won't remove it from my list"\r
 600       return\r
 601     end\r
 602     @feeds.delete(feed.handle.downcase)\r
 603     m.okay unless pass\r
 604     return\r
 605   end\r
 606 \r
 607   def replace_rss(m, params)\r
 608     handle = params[:handle]\r
 609     if @feeds.key?(handle.downcase)\r
 610       del_rss(m, {:handle => handle}, true)\r
 611     end\r
 612     if @feeds.key?(handle.downcase)\r
 613       m.reply "can't replace #{feed.handle}"\r
 614     else\r
 615       add_rss(m, params, true)\r
 616     end\r
 617   end\r
 618 \r
 619   def forcereplace_rss(m, params)\r
 620     add_rss(m, params, true)\r
 621   end\r
 622 \r
 623   def watch_rss(m, params)\r
 624     handle = params[:handle]\r
 625     chan = params[:chan] || m.replyto\r
 626     url = params[:url]\r
 627     type = params[:type]\r
 628     if url\r
 629       add_rss(m, params)\r
 630     end\r
 631     feed = @feeds.fetch(handle.downcase, nil)\r
 632     if feed\r
 633       if feed.add_watch(chan)\r
 634         watchRss(feed, m)\r
 635         m.okay\r
 636       else\r
 637         m.reply "Already watching #{feed.handle} in #{chan}"\r
 638       end\r
 639     else\r
 640       m.reply "Couldn't watch feed #{handle} (no such feed found)"\r
 641     end\r
 642   end\r
 643 \r
 644   def unwatch_rss(m, params, pass=false)\r
 645     handle = params[:handle].downcase\r
 646     chan = params[:chan] || m.replyto\r
 647     unless @feeds.has_key?(handle)\r
 648       m.reply("dunno that feed")\r
 649       return\r
 650     end\r
 651     feed = @feeds[handle]\r
 652     if feed.rm_watch(chan)\r
 653       m.reply "#{chan} has been removed from the watchlist for #{feed.handle}"\r
 654     else\r
 655       m.reply("#{chan} wasn't watching #{feed.handle}") unless pass\r
 656     end\r
 657     if !feed.watched?\r
 658       stop_watch(handle)\r
 659     end\r
 660     return feed\r
 661   end\r
 662 \r
 663   def rewatch_rss(m=nil, params=nil)\r
 664     stop_watches\r
 665 \r
 666     # Read watches from list.\r
 667     watchlist.each{ |handle, feed|\r
 668       watchRss(feed, m)\r
 669     }\r
 670     m.okay if m\r
 671   end\r
 672 \r
 673   private\r
 674   def watchRss(feed, m=nil)\r
 675     if @watch.has_key?(feed.handle)\r
 676       report_problem("watcher thread for #{feed.handle} is already running", nil, m)\r
 677       return\r
 678     end\r
 679     status = Hash.new\r
 680     status[:failures] = 0\r
 681     status[:first_run] = true\r
 682     @watch[feed.handle] = @bot.timer.add(0) {\r
 683       debug "watcher for #{feed} started"\r
 684       failures = status[:failures]\r
 685       first_run = status.delete(:first_run)\r
 686       begin\r
 687         debug "fetching #{feed}"\r
 688         oldxml = feed.xml ? feed.xml.dup : nil\r
 689         unless fetchRss(feed)\r
 690           failures += 1\r
 691         else\r
 692           if first_run\r
 693             debug "first run for #{feed}, getting items"\r
 694             parseRss(feed)\r
 695           elsif oldxml and oldxml == feed.xml\r
 696             debug "xml for #{feed} didn't change"\r
 697             failures -= 1 if failures > 0\r
 698           else\r
 699             if not feed.items\r
 700               debug "no previous items in feed #{feed}"\r
 701               parseRss(feed)\r
 702               failures -= 1 if failures > 0\r
 703             else\r
 704               # This one is used for debugging\r
 705               otxt = []\r
 706 \r
 707               # These are used for checking new items vs old ones\r
 708               uid_opts = { :show_updated => @bot.config['rss.show_updated'] }\r
 709               oids = Set.new feed.items.map { |item|\r
 710                 uid = RSS.item_uid_for_bot(item, uid_opts)\r
 711                 otxt << item.to_s\r
 712                 debug [uid, item].inspect\r
 713                 debug [uid, otxt.last].inspect\r
 714                 uid\r
 715               }\r
 716 \r
 717               unless parseRss(feed)\r
 718                 debug "no items in feed #{feed}"\r
 719                 failures += 1\r
 720               else\r
 721                 debug "Checking if new items are available for #{feed}"\r
 722                 failures -= 1 if failures > 0\r
 723                 # debug "Old:"\r
 724                 # debug oldxml\r
 725                 # debug "New:"\r
 726                 # debug feed.xml\r
 727 \r
 728                 dispItems = feed.items.reject { |item|\r
 729                   uid = RSS.item_uid_for_bot(item, uid_opts)\r
 730                   txt = item.to_s\r
 731                   if oids.include?(uid)\r
 732                     debug "rejecting old #{uid} #{item.inspect}"\r
 733                     debug [uid, txt].inspect\r
 734                     true\r
 735                   else\r
 736                     debug "accepting new #{uid} #{item.inspect}"\r
 737                     debug [uid, txt].inspect\r
 738                     warning "same text! #{txt}" if otxt.include?(txt)\r
 739                     false\r
 740                   end\r
 741                 }\r
 742 \r
 743                 if dispItems.length > 0\r
 744                   debug "Found #{dispItems.length} new items in #{feed}"\r
 745                   # When displaying watched feeds, publish them from older to newer\r
 746                   dispItems.reverse.each { |item|\r
 747                     printFormattedRss(feed, item)\r
 748                   }\r
 749                 else\r
 750                   debug "No new items found in #{feed}"\r
 751                 end\r
 752               end\r
 753             end\r
 754           end\r
 755         end\r
 756       rescue Exception => e\r
 757         error "Error watching #{feed}: #{e.inspect}"\r
 758         debug e.backtrace.join("\n")\r
 759         failures += 1\r
 760       end\r
 761 \r
 762       status[:failures] = failures\r
 763 \r
 764       timer = nil\r
 765       seconds = @bot.config['rss.thread_sleep']\r
 766       feed.mutex.synchronize do\r
 767         timer = @watch[feed.handle]\r
 768         seconds = feed.refresh_rate if feed.refresh_rate\r
 769       end\r
 770       seconds *= failures + 1\r
 771       seconds += seconds * (rand(100)-50)/100\r
 772       debug "watcher for #{feed} going to sleep #{seconds} seconds.."\r
 773       @bot.timer.reschedule(timer, seconds) rescue warning "watcher for #{feed} failed to reschedule: #{$!.inspect}"\r
 774     }\r
 775     debug "watcher for #{feed} added"\r
 776   end\r
 777 \r
 778   def printFormattedRss(feed, item, opts=nil)\r
 779     places = feed.watchers\r
 780     handle = "::#{feed.handle}:: "\r
 781     date = String.new\r
 782     if opts\r
 783       places = opts[:places] if opts.key?(:places)\r
 784       handle = opts[:handle].to_s if opts.key?(:handle)\r
 785       if opts.key?(:date) && opts[:date]\r
 786         if item.respond_to?(:pubDate) \r
 787           if item.pubDate.class <= Time\r
 788             date = item.pubDate.strftime("%Y/%m/%d %H:%M")\r
 789           else\r
 790             date = item.pubDate.to_s\r
 791           end\r
 792         elsif  item.respond_to?(:date)\r
 793           if item.date.class <= Time\r
 794             date = item.date.strftime("%Y/%m/%d %H:%M")\r
 795           else\r
 796             date = item.date.to_s\r
 797           end\r
 798         else\r
 799           date = "(no date)"\r
 800         end\r
 801         date += " :: "\r
 802       end\r
 803     end\r
 804 \r
 805     title = "#{Bold}#{item.title.ircify_html :limit => @bot.config['rss.head_max']}#{Bold}" if item.title\r
 806 \r
 807     desc = item.description.ircify_html(:limit => @bot.config['rss.text_max'], :a_href => :link_out) if item.description\r
 808 \r
 809     link = item.link.chomp if item.link\r
 810 \r
 811     debug item.inspect\r
 812     category = item.dc_subject rescue item.category.content rescue nil\r
 813     category = nil if category and category.empty?\r
 814     author = item.dc_creator rescue item.author rescue nil\r
 815     author = nil if author and author.empty?\r
 816 \r
 817     line1 = nil\r
 818     line2 = nil\r
 819 \r
 820     at = ((item.title && item.link) ? ' @ ' : '')\r
 821     case feed.type\r
 822     when 'blog'\r
 823       author << " " if author\r
 824       abt = category ? "about #{category} " : ""\r
 825       line1 = "#{handle}#{date}#{author}blogged #{abt}at #{link}"\r
 826       line2 = "#{handle}#{title} - #{desc}"\r
 827     when 'forum'\r
 828       line1 = "#{handle}#{date}#{title}#{at}#{link}"\r
 829     when 'wiki'\r
 830       line1 = "#{handle}#{date}#{title}#{at}#{link} has been edited by #{author}. #{desc}"\r
 831     when 'gmane'\r
 832       line1 = "#{handle}#{date}Message #{title} sent by #{author}. #{desc}"\r
 833     when 'trac'\r
 834       line1 = "#{handle}#{date}#{title} @ #{link}"\r
 835       unless item.title =~ /^Changeset \[(\d+)\]/\r
 836         line2 = "#{handle}#{date}#{desc}"\r
 837       end\r
 838     when '/.'\r
 839       dept = "(from the #{item.slash_department} dept) " rescue nil\r
 840       sec = " in section #{item.slash_section}" rescue nil\r
 841 \r
 842       line1 = "#{handle}#{date}#{dept}#{title}#{at}#{link} (posted by #{author}#{sec})"\r
 843     else\r
 844       line1 = "#{handle}#{date}#{title}#{at}#{link}"\r
 845     end\r
 846     places.each { |loc|\r
 847       @bot.say loc, line1, :overlong => :truncate\r
 848       next unless line2\r
 849       @bot.say loc, line2, :overlong => :truncate\r
 850     }\r
 851   end\r
 852 \r
 853   def fetchRss(feed, m=nil, cache=true)\r
 854     begin\r
 855       # Use 60 sec timeout, cause the default is too low\r
 856       xml = @bot.httputil.get(feed.url,\r
 857                               :read_timeout => 60,\r
 858                               :open_timeout => 60,\r
 859                               :cache => cache)\r
 860     rescue URI::InvalidURIError, URI::BadURIError => e\r
 861       report_problem("invalid rss feed #{feed.url}", e, m)\r
 862       return nil\r
 863     rescue => e\r
 864       report_problem("error getting #{feed.url}", e, m)\r
 865       return nil\r
 866     end\r
 867     debug "fetched #{feed}"\r
 868     unless xml\r
 869       report_problem("reading feed #{feed} failed", nil, m)\r
 870       return nil\r
 871     end\r
 872     # Ok, 0.9 feeds are not supported, maybe because\r
 873     # Netscape happily removed the DTD. So what we do is just to\r
 874     # reassign the 0.9 RDFs to 1.0, and hope it goes right.\r
 875     xml.gsub!("xmlns=\"http://my.netscape.com/rdf/simple/0.9/\"",\r
 876               "xmlns=\"http://purl.org/rss/1.0/\"")\r
 877     feed.mutex.synchronize do\r
 878       feed.xml = xml\r
 879     end\r
 880     return true\r
 881   end\r
 882 \r
 883   def parseRss(feed, m=nil)\r
 884     return nil unless feed.xml\r
 885     feed.mutex.synchronize do\r
 886       xml = feed.xml\r
 887       begin\r
 888         ## do validate parse\r
 889         rss = RSS::Parser.parse(xml)\r
 890         debug "parsed and validated #{feed}"\r
 891       rescue RSS::InvalidRSSError\r
 892         ## do non validate parse for invalid RSS 1.0\r
 893         begin\r
 894           rss = RSS::Parser.parse(xml, false)\r
 895           debug "parsed but not validated #{feed}"\r
 896         rescue RSS::Error => e\r
 897           report_problem("parsing rss stream failed, whoops =(", e, m)\r
 898           return nil\r
 899         end\r
 900       rescue RSS::Error => e\r
 901         report_problem("parsing rss stream failed, oioi", e, m)\r
 902         return nil\r
 903       rescue => e\r
 904         report_problem("processing error occured, sorry =(", e, m)\r
 905         return nil\r
 906       end\r
 907       items = []\r
 908       if rss.nil?\r
 909         report_problem("#{feed} does not include RSS 1.0 or 0.9x/2.0", nil, m)\r
 910       else\r
 911         begin\r
 912           rss.output_encoding = 'UTF-8'\r
 913         rescue RSS::UnknownConvertMethod => e\r
 914           report_problem("bah! something went wrong =(", e, m)\r
 915           return nil\r
 916         end\r
 917         rss.channel.title ||= "Unknown"\r
 918         title = rss.channel.title\r
 919         rss.items.each do |item|\r
 920           item.title ||= "Unknown"\r
 921           items << item\r
 922         end\r
 923       end\r
 924 \r
 925       if items.empty?\r
 926         report_problem("no items found in the feed, maybe try weed?", e, m)\r
 927         return nil\r
 928       end\r
 929       feed.title = title\r
 930       feed.items = items\r
 931       return true\r
 932     end\r
 933   end\r
 934 end\r
 935 \r
 936 plugin = RSSFeedsPlugin.new\r
 937 \r
 938 plugin.map 'rss show :handle :limit',\r
 939   :action => 'show_rss',\r
 940   :requirements => {:limit => /^\d+(?:\.\.\d+)?$/},\r
 941   :defaults => {:limit => 5}\r
 942 plugin.map 'rss list :handle',\r
 943   :action => 'list_rss',\r
 944   :defaults => {:handle => nil}\r
 945 plugin.map 'rss watched :handle [in :chan]',\r
 946   :action => 'watched_rss',\r
 947   :defaults => {:handle => nil}\r
 948 plugin.map 'rss who watches :handle',\r
 949   :action => 'who_watches',\r
 950   :defaults => {:handle => nil}\r
 951 plugin.map 'rss add :handle :url :type',\r
 952   :action => 'add_rss',\r
 953   :defaults => {:type => nil}\r
 954 plugin.map 'rss change :what of :handle to :new',\r
 955   :action => 'change_rss',\r
 956   :requirements => { :what => /handle|url|format|type|refresh/ }\r
 957 plugin.map 'rss change :what for :handle to :new',\r
 958   :action => 'change_rss',\r
 959   :requirements => { :what => /handle|url|format|type|refesh/ }\r
 960 plugin.map 'rss del :handle',\r
 961   :action => 'del_rss'\r
 962 plugin.map 'rss delete :handle',\r
 963   :action => 'del_rss'\r
 964 plugin.map 'rss rm :handle',\r
 965   :action => 'del_rss'\r
 966 plugin.map 'rss replace :handle :url :type',\r
 967   :action => 'replace_rss',\r
 968   :defaults => {:type => nil}\r
 969 plugin.map 'rss forcereplace :handle :url :type',\r
 970   :action => 'forcereplace_rss',\r
 971   :defaults => {:type => nil}\r
 972 plugin.map 'rss watch :handle [in :chan]',\r
 973   :action => 'watch_rss',\r
 974   :defaults => {:url => nil, :type => nil}\r
 975 plugin.map 'rss watch :handle :url :type [in :chan]',\r
 976   :action => 'watch_rss',\r
 977   :defaults => {:url => nil, :type => nil}\r
 978 plugin.map 'rss unwatch :handle [in :chan]',\r
 979   :action => 'unwatch_rss'\r
 980 plugin.map 'rss rmwatch :handle [in :chan]',\r
 981   :action => 'unwatch_rss'\r
 982 plugin.map 'rss rewatch',\r
 983   :action => 'rewatch_rss'\r
 984 \r