git.oblomov.eu Git - rbot/blob - data/rbot/plugins/rss.rb

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