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
10 # Licensed under MIT License.
\r
12 require 'rss/parser'
\r
15 require 'rss/dublincore'
\r
17 # require 'rss/dublincore/2.0'
\r
19 # warning "Unable to load RSS libraries, RSS plugin functionality crippled"
\r
24 if self.length > limit
\r
25 self+". " =~ /^(.{#{limit}}[^.!;?]*[.!;?])/mi
\r
32 self.gsub(/<[^>]+>/, '').gsub(/&/,'&').gsub(/"/,'"').gsub(/</,'<').gsub(/>/,'>').gsub(/&ellip;/,'...').gsub(/'/, "'").gsub("\n",'')
\r
42 def initialize(url,handle=nil,type=nil,watchers=[])
\r
51 sanitize_watchers(watchers)
\r
54 # Downcase all watchers, possibly turning them into Strings if they weren't
\r
55 def sanitize_watchers(list=@watchers)
\r
67 def watched_by?(who)
\r
68 @watchers.include?(who.downcase)
\r
75 @watchers << who.downcase
\r
80 @watchers.delete(who.downcase)
\r
84 [@handle,@url,@type,@watchers]
\r
87 def to_s(watchers=false)
\r
89 a = self.to_a.flatten
\r
93 a.compact.join(" | ")
\r
97 class RSSFeedsPlugin < Plugin
\r
98 BotConfig.register BotConfigIntegerValue.new('rss.head_max',
\r
99 :default => 30, :validate => Proc.new{|v| v > 0 && v < 200},
\r
100 :desc => "How many characters to use of a RSS item header")
\r
102 BotConfig.register BotConfigIntegerValue.new('rss.text_max',
\r
103 :default => 90, :validate => Proc.new{|v| v > 0 && v < 400},
\r
104 :desc => "How many characters to use of a RSS item text")
\r
106 BotConfig.register BotConfigIntegerValue.new('rss.thread_sleep',
\r
107 :default => 300, :validate => Proc.new{|v| v > 30},
\r
108 :desc => "How many seconds to sleep before checking RSS feeds again")
\r
112 if @registry.has_key?(:feeds)
\r
113 @feeds = @registry[:feeds]
\r
114 @feeds.keys.grep(/[A-Z]/) { |k|
\r
115 @feeds[k.downcase] = @feeds[k]
\r
118 @feeds.each { |k, f|
\r
119 f.sanitize_watchers
\r
133 @feeds.select { |h, f| f.watched? }
\r
141 @registry[:feeds] = @feeds
\r
144 def stop_watch(handle)
\r
145 if @watch.has_key?(handle)
\r
147 debug "Stopping watch #{handle}"
\r
148 @bot.timer.remove(@watch[handle])
\r
149 @watch.delete(handle)
\r
151 report_problem("Failed to stop watch for #{handle}", e, nil)
\r
157 @watch.each_key { |k|
\r
162 def help(plugin,topic="")
\r
165 "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
167 "rss list [#{Bold}handle#{Bold}] : list all rss feeds (matching #{Bold}handle#{Bold})"
\r
169 "rss watched [#{Bold}handle#{Bold}] : list all watched rss feeds (matching #{Bold}handle#{Bold})"
\r
171 "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
172 when /^(del(ete)?|rm)$/
\r
173 "rss del(ete)|rm #{Bold}handle#{Bold} : delete rss feed #{Bold}handle#{Bold}"
\r
175 "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
176 when "forcereplace"
\r
177 "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
179 "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
180 when /(un|rm)watch/
\r
181 "rss unwatch|rmwatch #{Bold}handle#{Bold} : stop watching rss #{Bold}handle#{Bold} for changes"
\r
183 "rss rewatch : restart threads that watch for changes in watched rss"
\r
185 "manage RSS feeds: rss show|list|watched|add|del(ete)|rm|(force)replace|watch|unwatch|rmwatch|rewatch"
\r
189 def report_problem(report, e=nil, m=nil)
\r
190 if m && m.respond_to?(:reply)
\r
197 debug e.backtrace.join("\n") if e.respond_to?(:backtrace)
\r
201 def show_rss(m, params)
\r
202 handle = params[:handle]
\r
203 lims = params[:limit].to_s.match(/(\d+)(?:..(\d+))?/)
\r
204 debug lims.to_a.inspect
\r
206 ll = [[lims[1].to_i-1,lims[2].to_i-1].min, 0].max
\r
207 ul = [[lims[1].to_i-1,lims[2].to_i-1].max, 14].min
\r
208 rev = lims[1].to_i > lims[2].to_i
\r
211 ul = [[lims[1].to_i-1, 0].max, 14].min
\r
215 feed = @feeds.fetch(handle.downcase, nil)
\r
217 m.reply "I don't know any feeds named #{handle}"
\r
221 m.reply "lemme fetch it..."
\r
222 title = items = nil
\r
223 title, items = fetchRss(feed, m)
\r
224 return unless items
\r
226 # We sort the feeds in freshness order (newer ones first)
\r
227 items = freshness_sort(items)
\r
228 disp = items[ll..ul]
\r
229 disp.reverse! if rev
\r
231 m.reply "Channel : #{title}"
\r
232 disp.each do |item|
\r
233 printFormattedRss(feed, item, {:places=>[m.replyto],:handle=>nil,:date=>true})
\r
237 def itemDate(item,ex=nil)
\r
238 return item.pubDate if item.respond_to?(:pubDate) and item.pubDate
\r
239 return item.date if item.respond_to?(:date) and item.date
\r
243 def freshness_sort(items)
\r
244 notime = Time.at(0)
\r
245 items.sort { |a, b|
\r
246 itemDate(b, notime) <=> itemDate(a, notime)
\r
250 def list_rss(m, params)
\r
251 wanted = params[:handle]
\r
253 @feeds.each { |handle, feed|
\r
254 next if wanted and !handle.match(/#{wanted}/i)
\r
255 reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})"
\r
256 (reply << " (watched)") if feed.watched_by?(m.replyto)
\r
260 reply = "no feeds found"
\r
261 reply << " matching #{wanted}" if wanted
\r
266 def watched_rss(m, params)
\r
267 wanted = params[:handle]
\r
269 watchlist.each { |handle, feed|
\r
270 next if wanted and !handle.match(/#{wanted}/i)
\r
271 next unless feed.watched_by?(m.replyto)
\r
272 reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})\n"
\r
275 reply = "no watched feeds"
\r
276 reply << " matching #{wanted}" if wanted
\r
281 def add_rss(m, params, force=false)
\r
282 handle = params[:handle]
\r
284 unless url.match(/https?/)
\r
285 m.reply "I only deal with feeds from HTTP sources, so I can't use #{url} (maybe you forgot the handle?)"
\r
288 type = params[:type]
\r
289 if @feeds.fetch(handle.downcase, nil) && !force
\r
290 m.reply "There is already a feed named #{handle} (URL: #{@feeds[handle.downcase].url})"
\r
294 m.reply "You must specify both a handle and an url to add an RSS feed"
\r
297 @feeds[handle.downcase] = RssBlob.new(url,handle,type)
\r
298 reply = "Added RSS #{url} named #{handle}"
\r
300 reply << " (format: #{type})"
\r
306 def del_rss(m, params, pass=false)
\r
307 feed = unwatch_rss(m, params, true)
\r
309 m.reply "someone else is watching #{feed.handle}, I won't remove it from my list"
\r
312 @feeds.delete(feed.handle.downcase)
\r
317 def replace_rss(m, params)
\r
318 handle = params[:handle]
\r
319 if @feeds.key?(handle.downcase)
\r
320 del_rss(m, {:handle => handle}, true)
\r
322 if @feeds.key?(handle.downcase)
\r
323 m.reply "can't replace #{feed.handle}"
\r
325 add_rss(m, params, true)
\r
329 def forcereplace_rss(m, params)
\r
330 add_rss(m, params, true)
\r
333 def watch_rss(m, params)
\r
334 handle = params[:handle]
\r
336 type = params[:type]
\r
340 feed = @feeds.fetch(handle.downcase, nil)
\r
342 if feed.add_watch(m.replyto)
\r
346 m.reply "Already watching #{feed.handle}"
\r
349 m.reply "Couldn't watch feed #{handle} (no such feed found)"
\r
353 def unwatch_rss(m, params, pass=false)
\r
354 handle = params[:handle].downcase
\r
355 unless @feeds.has_key?(handle)
\r
356 m.reply("dunno that feed")
\r
359 feed = @feeds[handle]
\r
360 if feed.rm_watch(m.replyto)
\r
361 m.reply "#{m.replyto} has been removed from the watchlist for #{feed.handle}"
\r
363 m.reply("#{m.replyto} wasn't watching #{feed.handle}") unless pass
\r
371 def rewatch_rss(m=nil, params=nil)
\r
374 # Read watches from list.
\r
375 watchlist.each{ |handle, feed|
\r
382 def watchRss(feed, m=nil)
\r
383 if @watch.has_key?(feed.handle)
\r
384 report_problem("watcher thread for #{feed.handle} is already running", nil, m)
\r
388 status[:oldItems] = []
\r
389 status[:firstRun] = true
\r
390 status[:failures] = 0
\r
391 @watch[feed.handle] = @bot.timer.add(@bot.config['rss.thread_sleep'], status) {
\r
392 debug "watcher for #{feed} started"
\r
393 oldItems = status[:oldItems]
\r
394 firstRun = status[:firstRun]
\r
395 failures = status[:failures]
\r
397 debug "fetching #{feed}"
\r
398 title = newItems = nil
\r
399 title, newItems = fetchRss(feed)
\r
401 debug "no items in feed #{feed}"
\r
404 debug "Checking if new items are available for #{feed}"
\r
406 debug "First run, we'll see next time"
\r
409 otxt = oldItems.map { |item| item.to_s }
\r
410 dispItems = newItems.reject { |item|
\r
411 otxt.include?(item.to_s)
\r
413 if dispItems.length > 0
\r
414 debug "Found #{dispItems.length} new items in #{feed}"
\r
415 # When displaying watched feeds, publish them from older to newer
\r
416 dispItems.reverse.each { |item|
\r
417 printFormattedRss(feed, item)
\r
420 debug "No new items found in #{feed}"
\r
423 oldItems = newItems.dup
\r
425 rescue Exception => e
\r
426 error "Error watching #{feed}: #{e.inspect}"
\r
427 debug e.backtrace.join("\n")
\r
431 status[:oldItems] = oldItems
\r
432 status[:firstRun] = firstRun
\r
433 status[:failures] = failures
\r
435 seconds = @bot.config['rss.thread_sleep'] * (failures + 1)
\r
436 seconds += seconds * (rand(100)-50)/100
\r
437 debug "watcher for #{feed} going to sleep #{seconds} seconds.."
\r
438 @bot.timer.reschedule(@watch[feed.handle], seconds)
\r
442 def printFormattedRss(feed, item, opts=nil)
\r
443 places = feed.watchers
\r
444 handle = "::#{feed.handle}:: "
\r
447 places = opts[:places] if opts.key?(:places)
\r
448 handle = opts[:handle].to_s if opts.key?(:handle)
\r
449 if opts.key?(:date) && opts[:date]
\r
450 if item.respond_to?(:pubDate)
\r
451 if item.pubDate.class <= Time
\r
452 date = item.pubDate.strftime("%Y/%m/%d %H.%M.%S")
\r
454 date = item.pubDate.to_s
\r
456 elsif item.respond_to?(:date)
\r
457 if item.date.class <= Time
\r
458 date = item.date.strftime("%Y/%m/%d %H.%M.%S")
\r
460 date = item.date.to_s
\r
468 title = "#{Bold}#{item.title.chomp.riphtml}#{Bold}" if item.title
\r
469 desc = item.description.gsub(/\s+/,' ').strip.riphtml.shorten(@bot.config['rss.text_max']) if item.description
\r
470 link = item.link.chomp if item.link
\r
471 places.each { |loc|
\r
474 @bot.say loc, "#{handle}#{date}#{item.category.content} blogged at #{link}"
\r
475 @bot.say loc, "#{handle}#{title} - #{desc}"
\r
477 @bot.say loc, "#{handle}#{date}#{title}#{' @ ' if item.title && item.link}#{link}"
\r
479 @bot.say loc, "#{handle}#{date}#{item.title} has been edited by #{item.dc_creator}. #{desc} #{link}"
\r
481 @bot.say loc, "#{handle}#{date}Message #{title} sent by #{item.dc_creator}. #{desc}"
\r
483 @bot.say loc, "#{handle}#{date}#{title} @ #{link}"
\r
484 unless item.title =~ /^Changeset \[(\d+)\]/
\r
485 @bot.say loc, "#{handle}#{date}#{desc}"
\r
488 @bot.say loc, "#{handle}#{date}#{title}#{' @ ' if item.title && item.link}#{link}"
\r
493 def fetchRss(feed, m=nil)
\r
495 # Use 60 sec timeout, cause the default is too low
\r
496 xml = @bot.httputil.get_cached(feed.url, 60, 60)
\r
497 rescue URI::InvalidURIError, URI::BadURIError => e
\r
498 report_problem("invalid rss feed #{feed.url}", e, m)
\r
501 report_problem("error getting #{feed.url}", e, m)
\r
504 debug "fetched #{feed}"
\r
506 report_problem("reading feed #{feed} failed", nil, m)
\r
511 ## do validate parse
\r
512 rss = RSS::Parser.parse(xml)
\r
513 debug "parsed #{feed}"
\r
514 rescue RSS::InvalidRSSError
\r
515 ## do non validate parse for invalid RSS 1.0
\r
517 rss = RSS::Parser.parse(xml, false)
\r
518 rescue RSS::Error => e
\r
519 report_problem("parsing rss stream failed, whoops =(", e, m)
\r
522 rescue RSS::Error => e
\r
523 report_problem("parsing rss stream failed, oioi", e, m)
\r
526 report_problem("processing error occured, sorry =(", e, m)
\r
531 report_problem("#{feed} does not include RSS 1.0 or 0.9x/2.0", nil, m)
\r
534 rss.output_encoding = 'UTF-8'
\r
535 rescue RSS::UnknownConvertMethod => e
\r
536 report_problem("bah! something went wrong =(", e, m)
\r
539 rss.channel.title ||= "Unknown"
\r
540 title = rss.channel.title
\r
541 rss.items.each do |item|
\r
542 item.title ||= "Unknown"
\r
548 report_problem("no items found in the feed, maybe try weed?", e, m)
\r
551 return [title, items]
\r
555 plugin = RSSFeedsPlugin.new
\r
557 plugin.map 'rss show :handle :limit',
\r
558 :action => 'show_rss',
\r
559 :requirements => {:limit => /^\d+(?:\.\.\d+)?$/},
\r
560 :defaults => {:limit => 5}
\r
561 plugin.map 'rss list :handle',
\r
562 :action => 'list_rss',
\r
563 :defaults => {:handle => nil}
\r
564 plugin.map 'rss watched :handle',
\r
565 :action => 'watched_rss',
\r
566 :defaults => {:handle => nil}
\r
567 plugin.map 'rss add :handle :url :type',
\r
568 :action => 'add_rss',
\r
569 :defaults => {:type => nil}
\r
570 plugin.map 'rss del :handle',
\r
571 :action => 'del_rss'
\r
572 plugin.map 'rss delete :handle',
\r
573 :action => 'del_rss'
\r
574 plugin.map 'rss rm :handle',
\r
575 :action => 'del_rss'
\r
576 plugin.map 'rss replace :handle :url :type',
\r
577 :action => 'replace_rss',
\r
578 :defaults => {:type => nil}
\r
579 plugin.map 'rss forcereplace :handle :url :type',
\r
580 :action => 'forcereplace_rss',
\r
581 :defaults => {:type => nil}
\r
582 plugin.map 'rss watch :handle :url :type',
\r
583 :action => 'watch_rss',
\r
584 :defaults => {:url => nil, :type => nil}
\r
585 plugin.map 'rss unwatch :handle',
\r
586 :action => 'unwatch_rss'
\r
587 plugin.map 'rss rmwatch :handle',
\r
588 :action => 'unwatch_rss'
\r
589 plugin.map 'rss rewatch',
\r
590 :action => 'rewatch_rss'
\r