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