]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blob - data/rbot/plugins/url.rb
url plugin: store info with urls, optionally display it when listing or searching...
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / url.rb
1 Url = Struct.new("Url", :channel, :nick, :time, :url, :info)
2
3 class ::UrlLinkError < RuntimeError
4 end
5
6 class UrlPlugin < Plugin
7   TITLE_RE = /<\s*?title\s*?>(.+?)<\s*?\/title\s*?>/im
8   LINK_INFO = "[Link Info]"
9
10   BotConfig.register BotConfigIntegerValue.new('url.max_urls',
11     :default => 100, :validate => Proc.new{|v| v > 0},
12     :desc => "Maximum number of urls to store. New urls replace oldest ones.")
13   BotConfig.register BotConfigBooleanValue.new('url.display_link_info',
14     :default => false,
15     :desc => "Get the title of any links pasted to the channel and display it (also tells if the link is broken or the site is down)")
16   BotConfig.register BotConfigBooleanValue.new('url.titles_only',
17     :default => false,
18     :desc => "Only show info for links that have <title> tags (in other words, don't display info for jpegs, mpegs, etc.)")
19   BotConfig.register BotConfigBooleanValue.new('url.first_par',
20     :default => false,
21     :desc => "Also try to get the first paragraph of a web page")
22   BotConfig.register BotConfigBooleanValue.new('url.info_on_list',
23     :default => false,
24     :desc => "Show link info when listing/searching for urls")
25
26
27   def initialize
28     super
29     @registry.set_default(Array.new)
30   end
31
32   def help(plugin, topic="")
33     "urls [<max>=4] => list <max> last urls mentioned in current channel, urls search [<max>=4] <regexp> => search for matching urls. In a private message, you must specify the channel to query, eg. urls <channel> [max], urls search <channel> [max] <regexp>"
34   end
35
36   def get_title_from_html(pagedata)
37     return unless TITLE_RE.match(pagedata)
38     $1.ircify_html
39   end
40
41   def get_title_for_url(uri_str)
42
43     url = uri_str.kind_of?(URI) ? uri_str : URI.parse(uri_str)
44     return if url.scheme !~ /https?/
45
46     title = nil
47     extra = String.new
48
49     begin
50       debug "+ getting #{url.request_uri}"
51       @bot.httputil.get_response(url) { |resp|
52         case resp
53         when Net::HTTPSuccess
54
55           if resp['content-type'] =~ /^text\/|(?:x|ht)ml/
56             # The page is text or HTML, so we can try finding a title and, if
57             # requested, the first par.
58             #
59             # We act differently depending on whether we want the first par or
60             # not: in the first case we download the initial part and the parse
61             # it; in the second case we only download as much as we need to find
62             # the title
63             #
64             if @bot.config['url.first_par']
65               partial = resp.partial_body(@bot.config['http.info_bytes'])
66               title = get_title_from_html(partial)
67               first_par = Utils.ircify_first_html_par(partial, :strip => title)
68               extra << ", #{Bold}text#{Bold}: #{first_par}" unless first_par.empty?
69               return "#{Bold}title#{Bold}: #{title}#{extra}" if title
70             else
71               resp.partial_body(@bot.config['http.info_bytes']) { |part|
72                 title = get_title_from_html(part)
73                 return "#{Bold}title#{Bold}: #{title}" if title
74               }
75             end
76           # if nothing was found, provide more basic info, as for non-html pages
77           end
78
79           debug resp.to_hash.inspect
80
81           enc = resp['content-encoding']
82
83           extra << ", #{Bold}encoding#{Bold}: #{enc}" if enc
84
85           unless @bot.config['url.titles_only']
86             # content doesn't have title, just display info.
87             size = resp['content-length'].gsub(/(\d)(?=\d{3}+(?:\.|$))(\d{3}\..*)?/,'\1,\2') rescue nil
88             size = size ? ", #{Bold}size#{Bold}: #{size} bytes" : ""
89             return "#{Bold}type#{Bold}: #{resp['content-type']}#{size}#{extra}"
90           end
91         else
92           raise UrlLinkError, "getting link (#{resp.code} - #{resp.message})"
93         end
94       }
95     rescue Exception => e
96       case e
97       when UrlLinkError
98         raise e
99       else
100         error e
101         raise "connecting to site/processing information (#{e.message})"
102       end
103     end
104   end
105
106   def listen(m)
107     return unless m.kind_of?(PrivMessage)
108     return if m.address?
109     # TODO support multiple urls in one line
110     if m.message =~ /(f|ht)tps?:\/\//
111       if m.message =~ /((f|ht)tps?:\/\/.*?)(?:\s+|$)/
112         urlstr = $1
113         list = @registry[m.target]
114
115         title = nil
116         if @bot.config['url.display_link_info']
117           Thread.start do
118             debug "Getting title for #{urlstr}..."
119             begin
120               title = get_title_for_url urlstr
121               if title
122                 m.reply "#{LINK_INFO} #{title}", :overlong => :truncate
123                 debug "Title found!"
124               else
125                 debug "Title not found!"
126               end
127             rescue => e
128               m.reply "Error #{e.message}"
129             end
130           end
131         end
132
133         # check to see if this url is already listed
134         return if list.find {|u| u.url == urlstr }
135
136         url = Url.new(m.target, m.sourcenick, Time.new, urlstr, title)
137         debug "#{list.length} urls so far"
138         if list.length > @bot.config['url.max_urls']
139           list.pop
140         end
141         debug "storing url #{url.url}"
142         list.unshift url
143         debug "#{list.length} urls now"
144         @registry[m.target] = list
145       end
146     end
147   end
148
149   def reply_urls(m, list, max)
150     list[0..(max-1)].each do |url|
151       disp = "[#{url.time.strftime('%Y/%m/%d %H:%M:%S')}] <#{url.nick}> #{url.url}"
152       if @bot.config['url.info_on_list']
153         title = url.info || get_title_for_url(url.url) rescue nil
154         if title and not url.info
155           url.info = title
156         end
157         disp << " --> #{title}" if title
158       end
159       m.reply disp, :overlong => :truncate
160     end
161   end
162
163   def urls(m, params)
164     channel = params[:channel] ? params[:channel] : m.target
165     max = params[:limit].to_i
166     max = 10 if max > 10
167     max = 1 if max < 1
168     list = @registry[channel]
169     if list.empty?
170       m.reply "no urls seen yet for channel #{channel}"
171     else
172       reply_urls(m, list, max)
173     end
174   end
175
176   def search(m, params)
177     channel = params[:channel] ? params[:channel] : m.target
178     max = params[:limit].to_i
179     string = params[:string]
180     max = 10 if max > 10
181     max = 1 if max < 1
182     regex = Regexp.new(string, Regexp::IGNORECASE)
183     list = @registry[channel].find_all {|url|
184       regex.match(url.url) || regex.match(url.nick)
185     }
186     if list.empty?
187       m.reply "no matches for channel #{channel}"
188     else
189       reply_urls(m, list, max)
190     end
191   end
192 end
193
194 plugin = UrlPlugin.new
195 plugin.map 'urls search :channel :limit :string', :action => 'search',
196                           :defaults => {:limit => 4},
197                           :requirements => {:limit => /^\d+$/},
198                           :public => false
199 plugin.map 'urls search :limit :string', :action => 'search',
200                           :defaults => {:limit => 4},
201                           :requirements => {:limit => /^\d+$/},
202                           :private => false
203 plugin.map 'urls :channel :limit', :defaults => {:limit => 4},
204                           :requirements => {:limit => /^\d+$/},
205                           :public => false
206 plugin.map 'urls :limit', :defaults => {:limit => 4},
207                           :requirements => {:limit => /^\d+$/},
208                           :private => false