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/parser'\r
  18 require 'rss/1.0'\r
  19 require 'rss/2.0'\r
  20 require 'rss/dublincore'\r
  21 # begin\r
  22 #   require 'rss/dublincore/2.0'\r
  23 # rescue\r
  24 #   warning "Unable to load RSS libraries, RSS plugin functionality crippled"\r
  25 # end\r
  26 \r
  27 class ::RssBlob\r
  28   attr_accessor :url\r
  29   attr_accessor :handle\r
  30   attr_accessor :type\r
  31   attr :watchers\r
  32   attr_accessor :refresh_rate\r
  33   attr_accessor :xml\r
  34   attr_accessor :title\r
  35   attr_accessor :items\r
  36   attr_accessor :mutex\r
  37 \r
  38   def initialize(url,handle=nil,type=nil,watchers=[], xml=nil)\r
  39     @url = url\r
  40     if handle\r
  41       @handle = handle\r
  42     else\r
  43       @handle = url\r
  44     end\r
  45     @type = type\r
  46     @watchers=[]\r
  47     @refresh_rate = nil\r
  48     @xml = xml\r
  49     @title = nil\r
  50     @items = nil\r
  51     @mutex = Mutex.new\r
  52     sanitize_watchers(watchers)\r
  53   end\r
  54 \r
  55   def dup\r
  56     self.class.new(@url,\r
  57                    @handle,\r
  58                    @type ? @type.dup : nil,\r
  59                    @watchers.dup,\r
  60                    @xml ? @xml.dup : nil)\r
  61   end\r
  62 \r
  63   # Downcase all watchers, possibly turning them into Strings if they weren't\r
  64   def sanitize_watchers(list=@watchers)\r
  65     ls = list.dup\r
  66     @watchers.clear\r
  67     ls.each { |w|\r
  68       add_watch(w)\r
  69     }\r
  70   end\r
  71 \r
  72   def watched?\r
  73     !@watchers.empty?\r
  74   end\r
  75 \r
  76   def watched_by?(who)\r
  77     @watchers.include?(who.downcase)\r
  78   end\r
  79 \r
  80   def add_watch(who)\r
  81     if watched_by?(who)\r
  82       return nil\r
  83     end\r
  84     @watchers << who.downcase\r
  85     return who\r
  86   end\r
  87 \r
  88   def rm_watch(who)\r
  89     @watchers.delete(who.downcase)\r
  90   end\r
  91 \r
  92   def to_a\r
  93     [@handle,@url,@type,@refresh_rate,@watchers]\r
  94   end\r
  95 \r
  96   def to_s(watchers=false)\r
  97     if watchers\r
  98       a = self.to_a.flatten\r
  99     else\r
 100       a = self.to_a[0,3]\r
 101     end\r
 102     a.compact.join(" | ")\r
 103   end\r
 104 end\r
 105 \r
 106 class RSSFeedsPlugin < Plugin\r
 107   BotConfig.register BotConfigIntegerValue.new('rss.head_max',\r
 108     :default => 30, :validate => Proc.new{|v| v > 0 && v < 200},\r
 109     :desc => "How many characters to use of a RSS item header")\r
 110 \r
 111   BotConfig.register BotConfigIntegerValue.new('rss.text_max',\r
 112     :default => 90, :validate => Proc.new{|v| v > 0 && v < 400},\r
 113     :desc => "How many characters to use of a RSS item text")\r
 114 \r
 115   BotConfig.register BotConfigIntegerValue.new('rss.thread_sleep',\r
 116     :default => 300, :validate => Proc.new{|v| v > 30},\r
 117     :desc => "How many seconds to sleep before checking RSS feeds again")\r
 118 \r
 119   def initialize\r
 120     super\r
 121     if @registry.has_key?(:feeds)\r
 122       @feeds = @registry[:feeds]\r
 123       @feeds.keys.grep(/[A-Z]/) { |k|\r
 124         @feeds[k.downcase] = @feeds[k]\r
 125         @feeds.delete(k)\r
 126       }\r
 127       @feeds.each { |k, f|\r
 128         f.mutex = Mutex.new unless f.mutex\r
 129         f.sanitize_watchers\r
 130         parseRss(f) if f.xml\r
 131       }\r
 132     else\r
 133       @feeds = Hash.new\r
 134     end\r
 135     @watch = Hash.new\r
 136     rewatch_rss\r
 137   end\r
 138 \r
 139   def name\r
 140     "rss"\r
 141   end\r
 142 \r
 143   def watchlist\r
 144     @feeds.select { |h, f| f.watched? }\r
 145   end\r
 146 \r
 147   def cleanup\r
 148     stop_watches\r
 149   end\r
 150 \r
 151   def save\r
 152     unparsed = Hash.new()\r
 153     @feeds.each { |k, f|\r
 154       f.mutex.synchronize do\r
 155         unparsed[k] = f.dup\r
 156       end\r
 157     }\r
 158     @registry[:feeds] = unparsed\r
 159   end\r
 160 \r
 161   def stop_watch(handle)\r
 162     if @watch.has_key?(handle)\r
 163       begin\r
 164         debug "Stopping watch #{handle}"\r
 165         @bot.timer.remove(@watch[handle])\r
 166         @watch.delete(handle)\r
 167       rescue => e\r
 168         report_problem("Failed to stop watch for #{handle}", e, nil)\r
 169       end\r
 170     end\r
 171   end\r
 172 \r
 173   def stop_watches\r
 174     @watch.each_key { |k|\r
 175       stop_watch(k)\r
 176     }\r
 177   end\r
 178 \r
 179   def help(plugin,topic="")\r
 180     case topic\r
 181     when "show"\r
 182       "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
 183     when "list"\r
 184       "rss list [#{Bold}handle#{Bold}] : list all rss feeds (matching #{Bold}handle#{Bold})"\r
 185     when "watched"\r
 186       "rss watched [#{Bold}handle#{Bold}] [in #{Bold}chan#{Bold}]: list all watched rss feeds (matching #{Bold}handle#{Bold}) (in channel #{Bold}chan#{Bold})"\r
 187     when "who", "watches", "who watches"\r
 188       "rss who watches [#{Bold}handle#{Bold}]]: list all watchers for rss feeds (matching #{Bold}handle#{Bold})"\r
 189     when "add"\r
 190       "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
 191     when "change"\r
 192       "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
 193     when /^(del(ete)?|rm)$/\r
 194       "rss del(ete)|rm #{Bold}handle#{Bold} : delete rss feed #{Bold}handle#{Bold}"\r
 195     when "replace"\r
 196       "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
 197     when "forcereplace"\r
 198       "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
 199     when "watch"\r
 200       "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
 201     when /(un|rm)watch/\r
 202       "rss unwatch|rmwatch #{Bold}handle#{Bold} [in #{Bold}chan#{Bold}]: stop watching rss #{Bold}handle#{Bold} (in channel #{Bold}chan#{Bold}) for changes"\r
 203     when "rewatch"\r
 204       "rss rewatch : restart threads that watch for changes in watched rss"\r
 205     else\r
 206       "manage RSS feeds: rss show|list|watched|add|change|del(ete)|rm|(force)replace|watch|unwatch|rmwatch|rewatch"\r
 207     end\r
 208   end\r
 209 \r
 210   def report_problem(report, e=nil, m=nil)\r
 211     if m && m.respond_to?(:reply)\r
 212       m.reply report\r
 213     else\r
 214       warning report\r
 215     end\r
 216     if e\r
 217       debug e.inspect\r
 218       debug e.backtrace.join("\n") if e.respond_to?(:backtrace)\r
 219     end\r
 220   end\r
 221 \r
 222   def show_rss(m, params)\r
 223     handle = params[:handle]\r
 224     lims = params[:limit].to_s.match(/(\d+)(?:..(\d+))?/)\r
 225     debug lims.to_a.inspect\r
 226     if lims[2]\r
 227       ll = [[lims[1].to_i-1,lims[2].to_i-1].min,  0].max\r
 228       ul = [[lims[1].to_i-1,lims[2].to_i-1].max, 14].min\r
 229       rev = lims[1].to_i > lims[2].to_i\r
 230     else\r
 231       ll = 0\r
 232       ul = [[lims[1].to_i-1, 0].max, 14].min\r
 233       rev = false\r
 234     end\r
 235 \r
 236     feed = @feeds.fetch(handle.downcase, nil)\r
 237     unless feed\r
 238       m.reply "I don't know any feeds named #{handle}"\r
 239       return\r
 240     end\r
 241 \r
 242     m.reply "lemme fetch it..."\r
 243     title = items = nil\r
 244     fetched = fetchRss(feed, m)\r
 245     return unless fetched or feed.xml\r
 246     if not fetched and feed.items\r
 247       m.reply "using old data"\r
 248     else\r
 249       parsed = parseRss(feed, m)\r
 250       m.reply "using old data" unless parsed\r
 251     end\r
 252     return unless feed.items\r
 253     title = feed.title\r
 254     items = feed.items\r
 255 \r
 256     # We sort the feeds in freshness order (newer ones first)\r
 257     items = freshness_sort(items)\r
 258     disp = items[ll..ul]\r
 259     disp.reverse! if rev\r
 260 \r
 261     m.reply "Channel : #{title}"\r
 262     disp.each do |item|\r
 263       printFormattedRss(feed, item, {:places=>[m.replyto],:handle=>nil,:date=>true})\r
 264     end\r
 265   end\r
 266 \r
 267   def itemDate(item,ex=nil)\r
 268     return item.pubDate if item.respond_to?(:pubDate) and item.pubDate\r
 269     return item.date if item.respond_to?(:date) and item.date\r
 270     return ex\r
 271   end\r
 272 \r
 273   def freshness_sort(items)\r
 274     notime = Time.at(0)\r
 275     items.sort { |a, b|\r
 276       itemDate(b, notime) <=> itemDate(a, notime)\r
 277     }\r
 278   end\r
 279 \r
 280   def list_rss(m, params)\r
 281     wanted = params[:handle]\r
 282     reply = String.new\r
 283     @feeds.each { |handle, feed|\r
 284       next if wanted and !handle.match(/#{wanted}/i)\r
 285       reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})"\r
 286       (reply << " refreshing every #{Utils.secs_to_string(feed.refresh_rate)}") if feed.refresh_rate\r
 287       (reply << " (watched)") if feed.watched_by?(m.replyto)\r
 288       reply << "\n"\r
 289     }\r
 290     if reply.empty?\r
 291       reply = "no feeds found"\r
 292       reply << " matching #{wanted}" if wanted\r
 293     end\r
 294     m.reply reply\r
 295   end\r
 296 \r
 297   def watched_rss(m, params)\r
 298     wanted = params[:handle]\r
 299     chan = params[:chan] || m.replyto\r
 300     reply = String.new\r
 301     watchlist.each { |handle, feed|\r
 302       next if wanted and !handle.match(/#{wanted}/i)\r
 303       next unless feed.watched_by?(chan)\r
 304       reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})"\r
 305       (reply << " refreshing every #{Utils.secs_to_string(feed.refresh_rate)}") if feed.refresh_rate\r
 306       reply << "\n"\r
 307     }\r
 308     if reply.empty?\r
 309       reply = "no watched feeds"\r
 310       reply << " matching #{wanted}" if wanted\r
 311     end\r
 312     m.reply reply\r
 313   end\r
 314 \r
 315   def who_watches(m, params)\r
 316     wanted = params[:handle]\r
 317     reply = String.new\r
 318     watchlist.each { |handle, feed|\r
 319       next if wanted and !handle.match(/#{wanted}/i)\r
 320       reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})"\r
 321       (reply << " refreshing every #{Utils.secs_to_string(feed.refresh_rate)}") if feed.refresh_rate\r
 322       reply << ": watched by #{feed.watchers.join(', ')}"\r
 323       reply << "\n"\r
 324     }\r
 325     if reply.empty?\r
 326       reply = "no watched feeds"\r
 327       reply << " matching #{wanted}" if wanted\r
 328     end\r
 329     m.reply reply\r
 330   end\r
 331 \r
 332   def add_rss(m, params, force=false)\r
 333     handle = params[:handle]\r
 334     url = params[:url]\r
 335     unless url.match(/https?/)\r
 336       m.reply "I only deal with feeds from HTTP sources, so I can't use #{url} (maybe you forgot the handle?)"\r
 337       return\r
 338     end\r
 339     type = params[:type]\r
 340     if @feeds.fetch(handle.downcase, nil) && !force\r
 341       m.reply "There is already a feed named #{handle} (URL: #{@feeds[handle.downcase].url})"\r
 342       return\r
 343     end\r
 344     unless url\r
 345       m.reply "You must specify both a handle and an url to add an RSS feed"\r
 346       return\r
 347     end\r
 348     @feeds[handle.downcase] = RssBlob.new(url,handle,type)\r
 349     reply = "Added RSS #{url} named #{handle}"\r
 350     if type\r
 351       reply << " (format: #{type})"\r
 352     end\r
 353     m.reply reply\r
 354     return handle\r
 355   end\r
 356 \r
 357   def change_rss(m, params)\r
 358     handle = params[:handle].downcase\r
 359     feed = @feeds.fetch(handle, nil)\r
 360     unless feed\r
 361       m.reply "No such feed with handle #{handle}"\r
 362       return\r
 363     end\r
 364     case params[:what].intern\r
 365     when :handle\r
 366       new = params[:new].downcase\r
 367       if @feeds.key?(new) and @feeds[new]\r
 368         m.reply "There already is a feed with handle #{new}"\r
 369         return\r
 370       else\r
 371         feed.mutex.synchronize do\r
 372           @feeds[new] = feed\r
 373           @feeds.delete(handle)\r
 374           feed.handle = new\r
 375         end\r
 376         handle = new\r
 377       end\r
 378     when :url\r
 379       new = params[:new]\r
 380       feed.mutex.synchronize do\r
 381         feed.url = new\r
 382       end\r
 383     when :format, :type\r
 384       new = params[:new]\r
 385       new = nil if new == 'default'\r
 386       feed.mutex.synchronize do\r
 387         feed.type = new\r
 388       end\r
 389     when :refresh\r
 390       new = params[:new].to_i\r
 391       new = nil if new == 0\r
 392       feed.mutex.synchronize do\r
 393         feed.refresh_rate = new\r
 394       end\r
 395     else\r
 396       m.reply "Don't know how to change #{params[:what]} for feeds"\r
 397       return\r
 398     end\r
 399     m.reply "Feed changed:"\r
 400     list_rss(m, {:handle => handle})\r
 401   end\r
 402 \r
 403   def del_rss(m, params, pass=false)\r
 404     feed = unwatch_rss(m, params, true)\r
 405     if feed.watched?\r
 406       m.reply "someone else is watching #{feed.handle}, I won't remove it from my list"\r
 407       return\r
 408     end\r
 409     @feeds.delete(feed.handle.downcase)\r
 410     m.okay unless pass\r
 411     return\r
 412   end\r
 413 \r
 414   def replace_rss(m, params)\r
 415     handle = params[:handle]\r
 416     if @feeds.key?(handle.downcase)\r
 417       del_rss(m, {:handle => handle}, true)\r
 418     end\r
 419     if @feeds.key?(handle.downcase)\r
 420       m.reply "can't replace #{feed.handle}"\r
 421     else\r
 422       add_rss(m, params, true)\r
 423     end\r
 424   end\r
 425 \r
 426   def forcereplace_rss(m, params)\r
 427     add_rss(m, params, true)\r
 428   end\r
 429 \r
 430   def watch_rss(m, params)\r
 431     handle = params[:handle]\r
 432     chan = params[:chan] || m.replyto\r
 433     url = params[:url]\r
 434     type = params[:type]\r
 435     if url\r
 436       add_rss(m, params)\r
 437     end\r
 438     feed = @feeds.fetch(handle.downcase, nil)\r
 439     if feed\r
 440       if feed.add_watch(chan)\r
 441         watchRss(feed, m)\r
 442         m.okay\r
 443       else\r
 444         m.reply "Already watching #{feed.handle} in #{chan}"\r
 445       end\r
 446     else\r
 447       m.reply "Couldn't watch feed #{handle} (no such feed found)"\r
 448     end\r
 449   end\r
 450 \r
 451   def unwatch_rss(m, params, pass=false)\r
 452     handle = params[:handle].downcase\r
 453     chan = params[:chan] || m.replyto\r
 454     unless @feeds.has_key?(handle)\r
 455       m.reply("dunno that feed")\r
 456       return\r
 457     end\r
 458     feed = @feeds[handle]\r
 459     if feed.rm_watch(chan)\r
 460       m.reply "#{chan} has been removed from the watchlist for #{feed.handle}"\r
 461     else\r
 462       m.reply("#{chan} wasn't watching #{feed.handle}") unless pass\r
 463     end\r
 464     if !feed.watched?\r
 465       stop_watch(handle)\r
 466     end\r
 467     return feed\r
 468   end\r
 469 \r
 470   def rewatch_rss(m=nil, params=nil)\r
 471     stop_watches\r
 472 \r
 473     # Read watches from list.\r
 474     watchlist.each{ |handle, feed|\r
 475       watchRss(feed, m)\r
 476     }\r
 477     m.okay if m\r
 478   end\r
 479 \r
 480   private\r
 481   def watchRss(feed, m=nil)\r
 482     if @watch.has_key?(feed.handle)\r
 483       report_problem("watcher thread for #{feed.handle} is already running", nil, m)\r
 484       return\r
 485     end\r
 486     status = Hash.new\r
 487     status[:failures] = 0\r
 488     @watch[feed.handle] = @bot.timer.add(0, status) {\r
 489       debug "watcher for #{feed} started"\r
 490       failures = status[:failures]\r
 491       begin\r
 492         debug "fetching #{feed}"\r
 493         oldxml = feed.xml ? feed.xml.dup : nil\r
 494         unless fetchRss(feed)\r
 495           failures += 1\r
 496         else\r
 497           if oldxml and oldxml == feed.xml\r
 498             debug "xml for #{feed} didn't change"\r
 499             failures -= 1 if failures > 0\r
 500           else\r
 501             if not feed.items\r
 502               debug "no previous items in feed #{feed}"\r
 503               parseRss(feed)\r
 504               failures -= 1 if failures > 0\r
 505             else\r
 506               otxt = feed.items.map { |item| item.to_s }\r
 507               unless parseRss(feed)\r
 508                 debug "no items in feed #{feed}"\r
 509                 failures += 1\r
 510               else\r
 511                 debug "Checking if new items are available for #{feed}"\r
 512                 failures -= 1 if failures > 0\r
 513                 dispItems = feed.items.reject { |item|\r
 514                   otxt.include?(item.to_s)\r
 515                 }\r
 516                 if dispItems.length > 0\r
 517                   debug "Found #{dispItems.length} new items in #{feed}"\r
 518                   # When displaying watched feeds, publish them from older to newer\r
 519                   dispItems.reverse.each { |item|\r
 520                     printFormattedRss(feed, item)\r
 521                   }\r
 522                 else\r
 523                   debug "No new items found in #{feed}"\r
 524                 end\r
 525               end\r
 526             end\r
 527           end\r
 528         end\r
 529       rescue Exception => e\r
 530         error "Error watching #{feed}: #{e.inspect}"\r
 531         debug e.backtrace.join("\n")\r
 532         failures += 1\r
 533       end\r
 534 \r
 535       status[:failures] = failures\r
 536 \r
 537       feed.mutex.synchronize do\r
 538         seconds = (feed.refresh_rate || @bot.config['rss.thread_sleep']) * (failures + 1)\r
 539         seconds += seconds * (rand(100)-50)/100\r
 540         debug "watcher for #{feed} going to sleep #{seconds} seconds.."\r
 541         @bot.timer.reschedule(@watch[feed.handle], seconds)\r
 542       end\r
 543     }\r
 544     debug "watcher for #{feed} added"\r
 545   end\r
 546 \r
 547   def printFormattedRss(feed, item, opts=nil)\r
 548     places = feed.watchers\r
 549     handle = "::#{feed.handle}:: "\r
 550     date = String.new\r
 551     if opts\r
 552       places = opts[:places] if opts.key?(:places)\r
 553       handle = opts[:handle].to_s if opts.key?(:handle)\r
 554       if opts.key?(:date) && opts[:date]\r
 555         if item.respond_to?(:pubDate) \r
 556           if item.pubDate.class <= Time\r
 557             date = item.pubDate.strftime("%Y/%m/%d %H.%M.%S")\r
 558           else\r
 559             date = item.pubDate.to_s\r
 560           end\r
 561         elsif  item.respond_to?(:date)\r
 562           if item.date.class <= Time\r
 563             date = item.date.strftime("%Y/%m/%d %H.%M.%S")\r
 564           else\r
 565             date = item.date.to_s\r
 566           end\r
 567         else\r
 568           date = "(no date)"\r
 569         end\r
 570         date += " :: "\r
 571       end\r
 572     end\r
 573     title = "#{Bold}#{item.title.chomp.riphtml}#{Bold}" if item.title\r
 574     desc = item.description.gsub(/\s+/,' ').strip.riphtml if item.description\r
 575     link = item.link.chomp if item.link\r
 576     line1 = nil\r
 577     line2 = nil\r
 578     case feed.type\r
 579     when 'blog'\r
 580       line1 = "#{handle}#{date}#{item.category.content} blogged at #{link}"\r
 581       line2 = "#{handle}#{title} - #{desc}"\r
 582     when 'forum'\r
 583       line1 = "#{handle}#{date}#{title}#{' @ ' if item.title && item.link}#{link}"\r
 584     when 'wiki'\r
 585       line1 = "#{handle}#{date}#{title}#{' @ ' if item.title && item.link}#{link} has been edited by #{item.dc_creator}. #{desc}"\r
 586     when 'gmane'\r
 587       line1 = "#{handle}#{date}Message #{title} sent by #{item.dc_creator}. #{desc}"\r
 588     when 'trac'\r
 589       line1 = "#{handle}#{date}#{title} @ #{link}"\r
 590       unless item.title =~ /^Changeset \[(\d+)\]/\r
 591         line2 = "#{handle}#{date}#{desc}"\r
 592       end\r
 593     else\r
 594       line1 = "#{handle}#{date}#{title}#{' @ ' if item.title && item.link}#{link}"\r
 595     end\r
 596     places.each { |loc|\r
 597       @bot.say loc, line1, :overlong => :truncate\r
 598       next unless line2\r
 599       @bot.say loc, line2, :overlong => :truncate\r
 600     }\r
 601   end\r
 602 \r
 603   def fetchRss(feed, m=nil)\r
 604     begin\r
 605       # Use 60 sec timeout, cause the default is too low\r
 606       xml = @bot.httputil.get_cached(feed.url, 60, 60)\r
 607     rescue URI::InvalidURIError, URI::BadURIError => e\r
 608       report_problem("invalid rss feed #{feed.url}", e, m)\r
 609       return nil\r
 610     rescue => e\r
 611       report_problem("error getting #{feed.url}", e, m)\r
 612       return nil\r
 613     end\r
 614     debug "fetched #{feed}"\r
 615     unless xml\r
 616       report_problem("reading feed #{feed} failed", nil, m)\r
 617       return nil\r
 618     end\r
 619     feed.mutex.synchronize do\r
 620       feed.xml = xml\r
 621     end\r
 622     return true\r
 623   end\r
 624 \r
 625   def parseRss(feed, m=nil)\r
 626     return nil unless feed.xml\r
 627     feed.mutex.synchronize do\r
 628       xml = feed.xml\r
 629       begin\r
 630         ## do validate parse\r
 631         rss = RSS::Parser.parse(xml)\r
 632         debug "parsed #{feed}"\r
 633       rescue RSS::InvalidRSSError\r
 634         ## do non validate parse for invalid RSS 1.0\r
 635         begin\r
 636           rss = RSS::Parser.parse(xml, false)\r
 637         rescue RSS::Error => e\r
 638           report_problem("parsing rss stream failed, whoops =(", e, m)\r
 639           return nil\r
 640         end\r
 641       rescue RSS::Error => e\r
 642         report_problem("parsing rss stream failed, oioi", e, m)\r
 643         return nil\r
 644       rescue => e\r
 645         report_problem("processing error occured, sorry =(", e, m)\r
 646         return nil\r
 647       end\r
 648       items = []\r
 649       if rss.nil?\r
 650         report_problem("#{feed} does not include RSS 1.0 or 0.9x/2.0", nil, m)\r
 651       else\r
 652         begin\r
 653           rss.output_encoding = 'UTF-8'\r
 654         rescue RSS::UnknownConvertMethod => e\r
 655           report_problem("bah! something went wrong =(", e, m)\r
 656           return nil\r
 657         end\r
 658         rss.channel.title ||= "Unknown"\r
 659         title = rss.channel.title\r
 660         rss.items.each do |item|\r
 661           item.title ||= "Unknown"\r
 662           items << item\r
 663         end\r
 664       end\r
 665 \r
 666       if items.empty?\r
 667         report_problem("no items found in the feed, maybe try weed?", e, m)\r
 668         return nil\r
 669       end\r
 670       feed.title = title\r
 671       feed.items = items\r
 672       return true\r
 673     end\r
 674   end\r
 675 end\r
 676 \r
 677 plugin = RSSFeedsPlugin.new\r
 678 \r
 679 plugin.map 'rss show :handle :limit',\r
 680   :action => 'show_rss',\r
 681   :requirements => {:limit => /^\d+(?:\.\.\d+)?$/},\r
 682   :defaults => {:limit => 5}\r
 683 plugin.map 'rss list :handle',\r
 684   :action => 'list_rss',\r
 685   :defaults => {:handle => nil}\r
 686 plugin.map 'rss watched :handle [in :chan]',\r
 687   :action => 'watched_rss',\r
 688   :defaults => {:handle => nil}\r
 689 plugin.map 'rss who watches :handle',\r
 690   :action => 'who_watches',\r
 691   :defaults => {:handle => nil}\r
 692 plugin.map 'rss add :handle :url :type',\r
 693   :action => 'add_rss',\r
 694   :defaults => {:type => nil}\r
 695 plugin.map 'rss change :what of :handle to :new',\r
 696   :action => 'change_rss',\r
 697   :requirements => { :what => /handle|url|format|type|refresh/ }\r
 698 plugin.map 'rss change :what for :handle to :new',\r
 699   :action => 'change_rss',\r
 700   :requirements => { :what => /handle|url|format|type|refesh/ }\r
 701 plugin.map 'rss del :handle',\r
 702   :action => 'del_rss'\r
 703 plugin.map 'rss delete :handle',\r
 704   :action => 'del_rss'\r
 705 plugin.map 'rss rm :handle',\r
 706   :action => 'del_rss'\r
 707 plugin.map 'rss replace :handle :url :type',\r
 708   :action => 'replace_rss',\r
 709   :defaults => {:type => nil}\r
 710 plugin.map 'rss forcereplace :handle :url :type',\r
 711   :action => 'forcereplace_rss',\r
 712   :defaults => {:type => nil}\r
 713 plugin.map 'rss watch :handle :url :type [in :chan]',\r
 714   :action => 'watch_rss',\r
 715   :defaults => {:url => nil, :type => nil}\r
 716 plugin.map 'rss unwatch :handle [in :chan]',\r
 717   :action => 'unwatch_rss'\r
 718 plugin.map 'rss rmwatch :handle [in :chan]',\r
 719   :action => 'unwatch_rss'\r
 720 plugin.map 'rss rewatch',\r
 721   :action => 'rewatch_rss'\r
 722 \r