data/rbot/plugins/rss.rb

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