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