]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blob - data/rbot/plugins/shortenurls.rb
7eeb005f8fce8705569e695e04a1f467d24217d6
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / shortenurls.rb
1 #-- vim:sw=2:et
2 #++
3 #
4 # :title: ShortURL plugin for rbot
5 #
6 # Author:: Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
7 # Copyright:: (C) 2007 Giuseppe Bilotta
8 # License:: GPL v2
9 #
10 # Plugin to handle ShortURL, merges the funcionality of the old rubyurl and tinyurl plugins
11 # Note that it's called ShortenURLs and not ShortURL, to prevent conflicts with
12 # the actual ruby package used
13
14 require "shorturl"
15 require "uri"
16
17 class ShortenURLs < Plugin
18   # starting from about shorturl 0.8.4, the WWW module is not defined 
19   include WWW rescue nil
20
21   Config.register Config::ArrayValue.new('shortenurls.services_blacklist',
22     :default => ['rubyurl', 'shorterlink'],
23     :requires_rescan => true,
24     :desc => "List of nonfunctioning shorturl services")
25
26   attr_accessor :services
27   def initialize
28     super
29     @blacklist = @bot.config['shortenurls.services_blacklist'].map { |s| s.intern }
30     # Instead of catering for all the services, we only pick the ones with 'link' or 'url' in the name
31     @services = ShortURL.valid_services.select { |service| service.to_s =~ /(?:link|url)/ } - @blacklist
32     if @services.include?(:rubyurl)
33       @services << :shorturl
34     end
35   end
36
37   # return a help string when the bot is asked for help on this plugin
38   def help(plugin, topic="")
39     return "shorten urls. syntax: <service> <your long url> => creates a shortened url using the required service (choose between #{@services.join(', ')}). Example: #{@bot.nick}, tinyurl http://some.long.url/wow-this-is/really-long.html"
40   end
41
42   # do the dirty job. This method can be called by other plugins, in which case you
43   # should set the :called param to true
44   def shorten(m, params)
45     url = params[:url]
46     if url == "help"
47       m.reply help(m.plugin) unless params[:called]
48       return nil
49     end
50     begin
51       to_uri = URI.parse(url)
52       # We don't accept 'generic' URLs because almost everything gets in there
53       raise URI::InvalidURIError if to_uri.class == URI::Generic
54     rescue URI::InvalidURIError
55       m.reply "#{url} doesn't look like an URL to me ..." unless params[:called]
56       return nil
57     end
58
59     service = (params[:service] || m.plugin).to_sym
60     service = :rubyurl if service == :shorturl
61
62     tried = []
63     short = nil
64
65     begin
66       tried << service
67       raise InvalidService, "#{service} blacklisted" if @blacklist.include?(service)
68       short = ShortURL.shorten(url, service)
69       raise InvalidService, "#{service} returned an empty string for #{url}" unless short and not short.empty?
70     rescue InvalidService
71       pool = services - tried
72       if pool.empty?
73         m.reply "#{service} failed, and I don't know what else to try next" unless params[:called]
74         return nil
75       else
76         service = pool.pick_one
77         m.reply "#{tried.last} failed, I'll try #{service} instead" unless params[:called]
78         retry
79       end
80     end
81
82     m.reply "#{url} shortened to #{short}" unless params[:called]
83     return short
84   end
85
86 end
87
88 # create an instance of the RubyURL class and register it as a plugin
89 plugin = ShortenURLs.new
90
91 plugin.services.each { |service|
92   plugin.map "#{service} :url", :action => 'shorten'
93 }