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