data/rbot/plugins/rss.rb

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