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 shorten(limit)\r
  24     if self.length > limit\r
  25       self+". " =~ /^(.{#{limit}}[^.!;?]*[.!;?])/mi\r
  26       return $1\r
  27     end\r
  28     self\r
  29   end\r
  30 \r
  31   def riphtml\r
  32     self.gsub(/<[^>]+>/, '').gsub(/&amp;/,'&').gsub(/&quot;/,'"').gsub(/&lt;/,'<').gsub(/&gt;/,'>').gsub(/&ellip;/,'...').gsub(/&apos;/, "'").gsub("\n",'')\r
  33   end\r
  34 \r
  35   def mysqlize\r
  36     self.gsub(/'/, "''")\r
  37   end\r
  38 end\r
  39 \r
  40 class ::RssBlob\r
  41   attr :url\r
  42   attr :handle\r
  43   attr :type\r
  44   attr :watchers\r
  45 \r
  46   def initialize(url,handle=nil,type=nil,watchers=[])\r
  47     @url = url\r
  48     if handle\r
  49       @handle = handle\r
  50     else\r
  51       @handle = url\r
  52     end\r
  53     @type = type\r
  54     @watchers = watchers\r
  55   end\r
  56 \r
  57   def watched?\r
  58     !@watchers.empty?\r
  59   end\r
  60 \r
  61   def watched_by?(who)\r
  62     # We need to check bot 'who' itself and the String form, because rss\r
  63     # watches added before the new Irc framework represented watchers as\r
  64     # Strings whereas they are now Channels.\r
  65     #\r
  66     @watchers.include?(who) || @watchers.include?(who.to_s) \r
  67   end\r
  68 \r
  69   def add_watch(who)\r
  70     if watched_by?(who)\r
  71       return nil\r
  72     end\r
  73     # TODO FIXME? should we just store watchers as Strings instead?\r
  74     # This should then be @watchers << who.downcase\r
  75     @watchers << who\r
  76     return who\r
  77   end\r
  78 \r
  79   def rm_watch(who)\r
  80     # See comment to watched_by?\r
  81     #\r
  82     @watchers.delete(who)\r
  83     @watchers.delete(who.to_s)\r
  84   end\r
  85 \r
  86   def to_a\r
  87     [@handle,@url,@type,@watchers]\r
  88   end\r
  89 \r
  90   def to_s(watchers=false)\r
  91     if watchers\r
  92       a = self.to_a.flatten\r
  93     else\r
  94       a = self.to_a[0,3]\r
  95     end\r
  96     a.join(" | ")\r
  97   end\r
  98 end\r
  99 \r
 100 class RSSFeedsPlugin < Plugin\r
 101   BotConfig.register BotConfigIntegerValue.new('rss.head_max',\r
 102     :default => 30, :validate => Proc.new{|v| v > 0 && v < 200},\r
 103     :desc => "How many characters to use of a RSS item header")\r
 104 \r
 105   BotConfig.register BotConfigIntegerValue.new('rss.text_max',\r
 106     :default => 90, :validate => Proc.new{|v| v > 0 && v < 400},\r
 107     :desc => "How many characters to use of a RSS item text")\r
 108 \r
 109   BotConfig.register BotConfigIntegerValue.new('rss.thread_sleep',\r
 110     :default => 300, :validate => Proc.new{|v| v > 30},\r
 111     :desc => "How many seconds to sleep before checking RSS feeds again")\r
 112 \r
 113   @@watchThreads = Hash.new\r
 114   @@mutex = Mutex.new\r
 115 \r
 116   def initialize\r
 117     super\r
 118     kill_threads\r
 119     if @registry.has_key?(:feeds)\r
 120       @feeds = @registry[:feeds]\r
 121     else\r
 122       @feeds = Hash.new\r
 123     end\r
 124     rewatch_rss\r
 125   end\r
 126 \r
 127   def watchlist\r
 128     @feeds.select { |h, f| f.watched? }\r
 129   end\r
 130 \r
 131   def cleanup\r
 132     kill_threads\r
 133   end\r
 134 \r
 135   def save\r
 136     @registry[:feeds] = @feeds\r
 137   end\r
 138 \r
 139   def kill_threads\r
 140     @@mutex.synchronize {\r
 141       # Abort all running threads.\r
 142       @@watchThreads.each { |url, thread|\r
 143         debug "Killing thread for #{url}"\r
 144         thread.kill\r
 145       }\r
 146       @@watchThreads = Hash.new\r
 147     }\r
 148   end\r
 149 \r
 150   def help(plugin,topic="")\r
 151     case topic\r
 152     when "show"\r
 153       "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
 154     when "list"\r
 155       "rss list [#{Bold}handle#{Bold}] : list all rss feeds (matching #{Bold}handle#{Bold})"\r
 156     when "watched"\r
 157       "rss watched [#{Bold}handle#{Bold}] : list all watched rss feeds (matching #{Bold}handle#{Bold})"\r
 158     when "add"\r
 159       "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
 160     when /^(del(ete)?|rm)$/\r
 161       "rss del(ete)|rm #{Bold}handle#{Bold} : delete rss feed #{Bold}handle#{Bold}"\r
 162     when "replace"\r
 163       "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
 164     when "forcereplace"\r
 165       "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
 166     when "watch"\r
 167       "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
 168     when /(un|rm)watch/\r
 169       "rss unwatch|rmwatch #{Bold}handle#{Bold} : stop watching rss #{Bold}handle#{Bold} for changes"\r
 170     when "rewatch"\r
 171       "rss rewatch : restart threads that watch for changes in watched rss"\r
 172     else\r
 173       "manage RSS feeds: rss show|list|watched|add|del(ete)|rm|(force)replace|watch|unwatch|rmwatch|rewatch"\r
 174     end\r
 175   end\r
 176 \r
 177   def report_problem(report, e=nil, m=nil)\r
 178     if m && m.respond_to?(:reply)\r
 179       m.reply report\r
 180     else\r
 181       warning report\r
 182     end\r
 183     if e\r
 184       debug e.inspect\r
 185       debug e.backtrace.join("\n") if e.respond_to?(:backtrace)\r
 186     end\r
 187   end\r
 188 \r
 189   def show_rss(m, params)\r
 190     handle = params[:handle]\r
 191     lims = params[:limit].to_s.match(/(\d+)(?:..(\d+))?/)\r
 192     debug lims.to_a.inspect\r
 193     if lims[2]\r
 194       ll = [[lims[1].to_i-1,lims[2].to_i-1].min,  0].max\r
 195       ul = [[lims[1].to_i-1,lims[2].to_i-1].max, 14].min\r
 196       rev = lims[1].to_i > lims[2].to_i\r
 197     else\r
 198       ll = 0\r
 199       ul = [[lims[1].to_i-1, 1].max, 14].min\r
 200       rev = false\r
 201     end\r
 202 \r
 203     feed = @feeds.fetch(handle, nil)\r
 204     unless feed\r
 205       m.reply "I don't know any feeds named #{handle}"\r
 206       return\r
 207     end\r
 208 \r
 209     m.reply "lemme fetch it..."\r
 210     title = items = nil\r
 211     @@mutex.synchronize {\r
 212       title, items = fetchRss(feed, m)\r
 213     }\r
 214     return unless items\r
 215 \r
 216     # We sort the feeds in freshness order (newer ones first)\r
 217     items = freshness_sort(items)\r
 218     disp = items[ll..ul]\r
 219     disp.reverse! if rev\r
 220 \r
 221     m.reply "Channel : #{title}"\r
 222     disp.each do |item|\r
 223       printFormattedRss(feed, item, {:places=>[m.replyto],:handle=>nil,:date=>true})\r
 224     end\r
 225   end\r
 226 \r
 227   def itemDate(item,ex=nil)\r
 228     return item.pubDate if item.respond_to?(:pubDate)\r
 229     return item.date if item.respond_to?(:date)\r
 230     return ex\r
 231   end\r
 232 \r
 233   def freshness_sort(items)\r
 234     notime = Time.at(0)\r
 235     items.sort { |a, b|\r
 236       itemDate(b, notime) <=> itemDate(a, notime)\r
 237     }\r
 238   end\r
 239 \r
 240   def list_rss(m, params)\r
 241     wanted = params[:handle]\r
 242     reply = String.new\r
 243     @@mutex.synchronize {\r
 244       @feeds.each { |handle, feed|\r
 245         next if wanted and !handle.match(wanted)\r
 246         reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})"\r
 247         (reply << " (watched)") if feed.watched_by?(m.replyto)\r
 248         reply << "\n"\r
 249       }\r
 250     }\r
 251     if reply.empty?\r
 252       reply = "no feeds found"\r
 253       reply << " matching #{wanted}" if wanted\r
 254     end\r
 255     m.reply reply\r
 256   end\r
 257 \r
 258   def watched_rss(m, params)\r
 259     wanted = params[:handle]\r
 260     reply = String.new\r
 261     @@mutex.synchronize {\r
 262       watchlist.each { |handle, feed|\r
 263         next if wanted and !handle.match(wanted)\r
 264         next unless feed.watched_by?(m.replyto)\r
 265         reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})\n"\r
 266       }\r
 267     }\r
 268     if reply.empty?\r
 269       reply = "no watched feeds"\r
 270       reply << " matching #{wanted}" if wanted\r
 271     end\r
 272     m.reply reply\r
 273   end\r
 274 \r
 275   def add_rss(m, params, force=false)\r
 276     handle = params[:handle]\r
 277     url = params[:url]\r
 278     unless url.match(/https?/)\r
 279       m.reply "I only deal with feeds from HTTP sources, so I can't use #{url} (maybe you forgot the handle?)"\r
 280       return\r
 281     end\r
 282     type = params[:type]\r
 283     if @feeds.fetch(handle, nil) && !force\r
 284       m.reply "There is already a feed named #{handle} (URL: #{@feeds[handle].url})"\r
 285       return\r
 286     end\r
 287     unless url\r
 288       m.reply "You must specify both a handle and an url to add an RSS feed"\r
 289       return\r
 290     end\r
 291     @@mutex.synchronize {\r
 292       @feeds[handle] = RssBlob.new(url,handle,type)\r
 293     }\r
 294     reply = "Added RSS #{url} named #{handle}"\r
 295     if type\r
 296       reply << " (format: #{type})"\r
 297     end\r
 298     m.reply reply\r
 299     return handle\r
 300   end\r
 301 \r
 302   def del_rss(m, params, pass=false)\r
 303     feed = unwatch_rss(m, params, true)\r
 304     if feed.watched?\r
 305       m.reply "someone else is watching #{feed.handle}, I won't remove it from my list"\r
 306       return\r
 307     end\r
 308     @@mutex.synchronize {\r
 309       @feeds.delete(feed.handle)\r
 310     }\r
 311     m.okay unless pass\r
 312     return\r
 313   end\r
 314 \r
 315   def replace_rss(m, params)\r
 316     handle = params[:handle]\r
 317     if @feeds.key?(handle)\r
 318       del_rss(m, {:handle => handle}, true)\r
 319     end\r
 320     if @feeds.key?(handle)\r
 321       m.reply "can't replace #{feed.handle}"\r
 322     else\r
 323       add_rss(m, params, true)\r
 324     end\r
 325   end\r
 326 \r
 327   def forcereplace_rss(m, params)\r
 328     add_rss(m, params, true)\r
 329   end\r
 330 \r
 331   def watch_rss(m, params)\r
 332     handle = params[:handle]\r
 333     url = params[:url]\r
 334     type = params[:type]\r
 335     if url\r
 336       add_rss(m, params)\r
 337     end\r
 338     feed = nil\r
 339     @@mutex.synchronize {\r
 340       feed = @feeds.fetch(handle, nil)\r
 341     }\r
 342     if feed\r
 343       @@mutex.synchronize {\r
 344         if feed.add_watch(m.replyto)\r
 345           watchRss(feed, m)\r
 346           m.okay\r
 347         else\r
 348           m.reply "Already watching #{feed.handle}"\r
 349         end\r
 350       }\r
 351     else\r
 352       m.reply "Couldn't watch feed #{handle} (no such feed found)"\r
 353     end\r
 354   end\r
 355 \r
 356   def unwatch_rss(m, params, pass=false)\r
 357     handle = params[:handle]\r
 358     unless @feeds.has_key?(handle)\r
 359       m.reply("dunno that feed")\r
 360       return\r
 361     end\r
 362     feed = @feeds[handle]\r
 363     if feed.rm_watch(m.replyto)\r
 364       m.reply "#{m.replyto} has been removed from the watchlist for #{feed.handle}"\r
 365     else\r
 366       m.reply("#{m.replyto} wasn't watching #{feed.handle}") unless pass\r
 367     end\r
 368     if !feed.watched?\r
 369       @@mutex.synchronize {\r
 370         if @@watchThreads[handle].kind_of? Thread\r
 371           @@watchThreads[handle].kill\r
 372           debug "rmwatch: Killed thread for #{handle}"\r
 373           @@watchThreads.delete(handle)\r
 374         end\r
 375       }\r
 376     end\r
 377     return feed\r
 378   end\r
 379 \r
 380   def rewatch_rss(m=nil, params=nil)\r
 381     kill_threads\r
 382 \r
 383     # Read watches from list.\r
 384     watchlist.each{ |handle, feed|\r
 385       watchRss(feed, m)\r
 386     }\r
 387     m.okay if m\r
 388   end\r
 389 \r
 390   private\r
 391   def watchRss(feed, m=nil)\r
 392     if @@watchThreads.has_key?(feed.handle)\r
 393       report_problem("watcher thread for #{feed.handle} is already running", nil, m)\r
 394       return\r
 395     end\r
 396     @@watchThreads[feed.handle] = Thread.new do\r
 397       debug "watcher for #{feed} started"\r
 398       oldItems = []\r
 399       firstRun = true\r
 400       failures = 0\r
 401       loop do\r
 402         begin\r
 403           debug "fetching #{feed}"\r
 404           title = newItems = nil\r
 405           @@mutex.synchronize {\r
 406             title, newItems = fetchRss(feed)\r
 407           }\r
 408           unless newItems\r
 409             debug "no items in feed #{feed}"\r
 410             failures +=1\r
 411           else\r
 412             debug "Checking if new items are available for #{feed}"\r
 413             if firstRun\r
 414               debug "First run, we'll see next time"\r
 415               firstRun = false\r
 416             else\r
 417               otxt = oldItems.map { |item| item.to_s }\r
 418               dispItems = newItems.reject { |item|\r
 419                 otxt.include?(item.to_s)\r
 420               }\r
 421               if dispItems.length > 0\r
 422                 debug "Found #{dispItems.length} new items in #{feed}"\r
 423                 # When displaying watched feeds, publish them from older to newer\r
 424                 dispItems.reverse.each { |item|\r
 425                   @@mutex.synchronize {\r
 426                     printFormattedRss(feed, item)\r
 427                   }\r
 428                 }\r
 429               else\r
 430                 debug "No new items found in #{feed}"\r
 431               end\r
 432             end\r
 433             oldItems = newItems.dup\r
 434           end\r
 435         rescue Exception => e\r
 436           error "Error watching #{feed}: #{e.inspect}"\r
 437           debug e.backtrace.join("\n")\r
 438           failures += 1\r
 439         end\r
 440 \r
 441         seconds = @bot.config['rss.thread_sleep'] * (failures + 1)\r
 442         seconds += seconds * (rand(100)-50)/100\r
 443         debug "watcher for #{feed} going to sleep #{seconds} seconds.."\r
 444         sleep seconds\r
 445       end\r
 446     end\r
 447   end\r
 448 \r
 449   def printFormattedRss(feed, item, opts=nil)\r
 450     places = feed.watchers\r
 451     handle = "::#{feed.handle}:: "\r
 452     date = String.new\r
 453     if opts\r
 454       places = opts[:places] if opts.key?(:places)\r
 455       handle = opts[:handle].to_s if opts.key?(:handle)\r
 456       if opts.key?(:date) && opts[:date]\r
 457         if item.respond_to?(:pubDate) \r
 458           if item.pubDate.class <= Time\r
 459             date = item.pubDate.strftime("%Y/%m/%d %H.%M.%S")\r
 460           else\r
 461             date = item.pubDate.to_s\r
 462           end\r
 463         elsif  item.respond_to?(:date)\r
 464           if item.date.class <= Time\r
 465             date = item.date.strftime("%Y/%m/%d %H.%M.%S")\r
 466           else\r
 467             date = item.date.to_s\r
 468           end\r
 469         else\r
 470           date = "(no date)"\r
 471         end\r
 472         date += " :: "\r
 473       end\r
 474     end\r
 475     title = "#{Bold}#{item.title.chomp.riphtml}#{Bold}" if item.title\r
 476     desc = item.description.gsub(/\s+/,' ').strip.riphtml.shorten(@bot.config['rss.text_max']) if item.description\r
 477     link = item.link.chomp if item.link\r
 478     places.each { |loc|\r
 479       case feed.type\r
 480       when 'blog'\r
 481         @bot.say loc, "#{handle}#{date}#{item.category.content} blogged at #{link}"\r
 482         @bot.say loc, "#{handle}#{title} - #{desc}"\r
 483       when 'forum'\r
 484         @bot.say loc, "#{handle}#{date}#{title}#{' @ ' if item.title && item.link}#{link}"\r
 485       when 'wiki'\r
 486         @bot.say loc, "#{handle}#{date}#{item.title} has been edited by #{item.dc_creator}. #{desc} #{link}"\r
 487       when 'gmame'\r
 488         @bot.say loc, "#{handle}#{date}Message #{title} sent by #{item.dc_creator}. #{desc}"\r
 489       when 'trac'\r
 490         @bot.say loc, "#{handle}#{date}#{title} @ #{link}"\r
 491         unless item.title =~ /^Changeset \[(\d+)\]/\r
 492           @bot.say loc, "#{handle}#{date}#{desc}"\r
 493         end\r
 494       else\r
 495         @bot.say loc, "#{handle}#{date}#{title}#{' @ ' if item.title && item.link}#{link}"\r
 496       end\r
 497     }\r
 498   end\r
 499 \r
 500   def fetchRss(feed, m=nil)\r
 501     begin\r
 502       # Use 60 sec timeout, cause the default is too low\r
 503       # Do not use get_cached for RSS until we have proper cache handling\r
 504       # xml = @bot.httputil.get_cached(feed.url,60,60)\r
 505       xml = @bot.httputil.get(feed.url,60,60)\r
 506     rescue URI::InvalidURIError, URI::BadURIError => e\r
 507       report_problem("invalid rss feed #{feed.url}", e, m)\r
 508       return\r
 509     rescue => e\r
 510       report_problem("error getting #{feed.url}", e, m)\r
 511       return\r
 512     end\r
 513     debug "fetched #{feed}"\r
 514     unless xml\r
 515       report_problem("reading feed #{feed} failed", nil, m)\r
 516       return\r
 517     end\r
 518 \r
 519     begin\r
 520       ## do validate parse\r
 521       rss = RSS::Parser.parse(xml)\r
 522       debug "parsed #{feed}"\r
 523     rescue RSS::InvalidRSSError\r
 524       ## do non validate parse for invalid RSS 1.0\r
 525       begin\r
 526         rss = RSS::Parser.parse(xml, false)\r
 527       rescue RSS::Error => e\r
 528         report_problem("parsing rss stream failed, whoops =(", e, m)\r
 529         return\r
 530       end\r
 531     rescue RSS::Error => e\r
 532       report_problem("parsing rss stream failed, oioi", e, m)\r
 533       return\r
 534     rescue => e\r
 535       report_problem("processing error occured, sorry =(", e, m)\r
 536       return\r
 537     end\r
 538     items = []\r
 539     if rss.nil?\r
 540       report_problem("#{feed} does not include RSS 1.0 or 0.9x/2.0", nil, m)\r
 541     else\r
 542       begin\r
 543         rss.output_encoding = 'UTF-8'\r
 544       rescue RSS::UnknownConvertMethod => e\r
 545         report_problem("bah! something went wrong =(", e, m)\r
 546         return\r
 547       end\r
 548       rss.channel.title ||= "Unknown"\r
 549       title = rss.channel.title\r
 550       rss.items.each do |item|\r
 551         item.title ||= "Unknown"\r
 552         items << item\r
 553       end\r
 554     end\r
 555 \r
 556     if items.empty?\r
 557       report_problem("no items found in the feed, maybe try weed?", e, m)\r
 558       return\r
 559     end\r
 560     return [title, items]\r
 561   end\r
 562 end\r
 563 \r
 564 plugin = RSSFeedsPlugin.new\r
 565 \r
 566 plugin.map 'rss show :handle :limit',\r
 567   :action => 'show_rss',\r
 568   :requirements => {:limit => /^\d+(?:\.\.\d+)?$/},\r
 569   :defaults => {:limit => 5}\r
 570 plugin.map 'rss list :handle',\r
 571   :action => 'list_rss',\r
 572   :defaults =>  {:handle => nil}\r
 573 plugin.map 'rss watched :handle',\r
 574   :action => 'watched_rss',\r
 575   :defaults =>  {:handle => nil}\r
 576 plugin.map 'rss add :handle :url :type',\r
 577   :action => 'add_rss',\r
 578   :defaults => {:type => nil}\r
 579 plugin.map 'rss del :handle',\r
 580   :action => 'del_rss'\r
 581 plugin.map 'rss delete :handle',\r
 582   :action => 'del_rss'\r
 583 plugin.map 'rss rm :handle',\r
 584   :action => 'del_rss'\r
 585 plugin.map 'rss replace :handle :url :type',\r
 586   :action => 'replace_rss',\r
 587   :defaults => {:type => nil}\r
 588 plugin.map 'rss forcereplace :handle :url :type',\r
 589   :action => 'forcereplace_rss',\r
 590   :defaults => {:type => nil}\r
 591 plugin.map 'rss watch :handle :url :type',\r
 592   :action => 'watch_rss',\r
 593   :defaults => {:url => nil, :type => nil}\r
 594 plugin.map 'rss unwatch :handle',\r
 595   :action => 'unwatch_rss'\r
 596 plugin.map 'rss rmwatch :handle',\r
 597   :action => 'unwatch_rss'\r
 598 plugin.map 'rss rewatch',\r
 599   :action => 'rewatch_rss'\r
 600 \r