4 # :title: rbot HTTP provider
6 # Author:: Tom Gilbert <tom@linuxbrit.co.uk>
7 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
8 # Author:: Dmitry "jsn" Kim <dmitry point kim at gmail point com>
10 # Copyright:: (C) 2002-2005 Tom Gilbert
11 # Copyright:: (C) 2006 Tom Gilbert, Giuseppe Bilotta
12 # Copyright:: (C) 2007 Giuseppe Bilotta, Dmitry Kim
21 error "Couldn't load 'net/https': #{e.pretty_inspect}"
22 error "Secured HTTP connections will fail"
25 # To handle Gzipped pages
31 attr_accessor :no_cache
32 if !instance_methods.include?('raw_body')
36 def body_charset(str=self.raw_body)
37 ctype = self['content-type'] || 'text/html'
38 return nil unless ctype =~ /^text/i || ctype =~ /x(ht)?ml/i
40 charsets = ['latin1'] # should be in config
42 if self['content-type'].match(/charset=["']?([^\s"']+)["']?/i)
44 debug "charset #{charsets.last} added from header"
48 when /<\?xml\s[^>]*encoding=['"]([^\s"'>]+)["'][^>]*\?>/i
50 debug "xml charset #{charsets.last} added from xml pi"
51 when /<(meta\s[^>]*http-equiv=["']?Content-Type["']?[^>]*)>/i
53 if meta =~ /charset=['"]?([^\s'";]+)['"]?/
55 debug "html charset #{charsets.last} added from meta"
62 charsets = self.body_charset(str) or return str
64 charsets.reverse_each do |charset|
65 # XXX: this one is really ugly, but i don't know how to make it better
70 debug "trying #{charset} / offset #{off}"
71 return Iconv.iconv('utf-8//ignore',
73 str.slice(0 .. (-1 - off))).first
75 debug "conversion failed for #{charset} / offset #{off}"
82 def decompress_body(str)
83 method = self['content-encoding']
88 debug "gunzipping body"
90 return Zlib::GzipReader.new(StringIO.new(str)).read
91 rescue Zlib::Error => e
92 # If we can't unpack the whole stream (e.g. because we're doing a
94 debug "full gunzipping failed (#{e}), trying to recover as much as possible"
97 Zlib::GzipReader.new(StringIO.new(str)).each_byte { |byte|
105 raise "Unhandled content encoding #{method}"
110 return self.body_to_utf(self.decompress_body(self.raw_body))
113 # Read chunks from the body until we have at least _size_ bytes, yielding
114 # the partial text at each chunk. Return the partial body.
115 def partial_body(size=0, &block)
120 self.read_body { |chunk|
122 yield self.body_to_utf(self.decompress_body(partial)) if block_given?
123 break if size and size > 0 and partial.length >= size
126 return self.body_to_utf(self.decompress_body(partial))
131 Net::HTTP.version_1_2
136 # class for making http requests easier (mainly for plugins to use)
137 # this class can check the bot proxy configuration to determine if a proxy
138 # needs to be used, which includes support for per-url proxy configuration.
140 BotConfig.register BotConfigBooleanValue.new('http.use_proxy',
141 :default => false, :desc => "should a proxy be used for HTTP requests?")
142 BotConfig.register BotConfigStringValue.new('http.proxy_uri', :default => false,
143 :desc => "Proxy server to use for HTTP requests (URI, e.g http://proxy.host:port)")
144 BotConfig.register BotConfigStringValue.new('http.proxy_user',
146 :desc => "User for authenticating with the http proxy (if required)")
147 BotConfig.register BotConfigStringValue.new('http.proxy_pass',
149 :desc => "Password for authenticating with the http proxy (if required)")
150 BotConfig.register BotConfigArrayValue.new('http.proxy_include',
152 :desc => "List of regexps to check against a URI's hostname/ip to see if we should use the proxy to access this URI. All URIs are proxied by default if the proxy is set, so this is only required to re-include URIs that might have been excluded by the exclude list. e.g. exclude /.*\.foo\.com/, include bar\.foo\.com")
153 BotConfig.register BotConfigArrayValue.new('http.proxy_exclude',
155 :desc => "List of regexps to check against a URI's hostname/ip to see if we should use avoid the proxy to access this URI and access it directly")
156 BotConfig.register BotConfigIntegerValue.new('http.max_redir',
158 :desc => "Maximum number of redirections to be used when getting a document")
159 BotConfig.register BotConfigIntegerValue.new('http.expire_time',
161 :desc => "After how many minutes since last use a cached document is considered to be expired")
162 BotConfig.register BotConfigIntegerValue.new('http.max_cache_time',
164 :desc => "After how many minutes since first use a cached document is considered to be expired")
165 BotConfig.register BotConfigIntegerValue.new('http.no_expire_cache',
167 :desc => "Set this to true if you want the bot to never expire the cached pages")
168 BotConfig.register BotConfigIntegerValue.new('http.info_bytes',
170 :desc => "How many bytes to download from a web page to find some information. Set to 0 to let the bot download the whole page.")
173 attr_accessor :response, :last_used, :first_used, :count, :expires, :date
175 def self.maybe_new(resp)
176 debug "maybe new #{resp}"
177 return nil if resp.no_cache
178 return nil unless Net::HTTPOK === resp ||
179 Net::HTTPMovedPermanently === resp ||
180 Net::HTTPFound === resp ||
181 Net::HTTPPartialContent === resp
183 cc = resp['cache-control']
184 return nil if cc && (cc =~ /no-cache/i)
188 date = Time.httpdate(d)
191 return nil if resp['expires'] && (Time.httpdate(resp['expires']) < date)
193 debug "creating cache obj"
200 @first_used = now if @count == 0
206 debug "checking expired?"
207 if cc = self.response['cache-control'] && cc =~ /must-revalidate/
210 return self.expires < Time.now
213 def setup_headers(hdr)
214 hdr['if-modified-since'] = self.date.rfc2822
216 debug "ims == #{hdr['if-modified-since']}"
218 if etag = self.response['etag']
219 hdr['if-none-match'] = etag
220 debug "etag: #{etag}"
224 def revalidate(resp = self.response)
227 self.date = resp.key?('date') ? Time.httpdate(resp['date']) : Time.now
229 cc = resp['cache-control']
230 if cc && (cc =~ /max-age=(\d+)/)
231 self.expires = self.date + $1.to_i
232 elsif resp.key?('expires')
233 self.expires = Time.httpdate(resp['expires'])
234 elsif lm = resp['last-modified']
235 delta = self.date - Time.httpdate(lm)
236 delta = 10 if delta <= 0
238 self.expires = self.date + delta
240 self.expires = self.date + 300
242 # self.expires = Time.now + 10 # DEBUG
243 debug "expires on #{self.expires}"
253 self.response.raw_body
254 rescue Exception => e
265 'Accept-Charset' => 'utf-8;q=1.0, *;q=0.8',
266 'Accept-Encoding' => 'gzip;q=1, identity;q=0.8, *;q=0.2',
268 "rbot http util #{$version} (http://linuxbrit.co.uk/rbot/)"
270 debug "starting http cache cleanup timer"
271 @timer = @bot.timer.add(300) {
272 self.remove_stale_cache unless @bot.config['http.no_expire_cache']
277 debug 'stopping http cache cleanup timer'
278 @bot.timer.remove(@timer)
281 # if http_proxy_include or http_proxy_exclude are set, then examine the
282 # uri to see if this is a proxied uri
283 # the in/excludes are a list of regexps, and each regexp is checked against
284 # the server name, and its IP addresses
285 def proxy_required(uri)
287 if @bot.config["http.proxy_exclude"].empty? && @bot.config["http.proxy_include"].empty?
293 list.concat Resolv.getaddresses(uri.host)
294 rescue StandardError => err
295 warning "couldn't resolve host uri.host"
298 unless @bot.config["http.proxy_exclude"].empty?
299 re = @bot.config["http.proxy_exclude"].collect{|r| Regexp.new(r)}
309 unless @bot.config["http.proxy_include"].empty?
310 re = @bot.config["http.proxy_include"].collect{|r| Regexp.new(r)}
320 debug "using proxy for uri #{uri}?: #{use_proxy}"
324 # uri:: Uri to create a proxy for
326 # return a net/http Proxy object, which is configured correctly for
327 # proxying based on the bot's proxy configuration.
328 # This will include per-url proxy configuration based on the bot config
329 # +http_proxy_include/exclude+ options.
331 def get_proxy(uri, options = {})
343 if @bot.config["http.use_proxy"]
344 if (ENV['http_proxy'])
345 proxy = URI.parse ENV['http_proxy'] rescue nil
347 if (@bot.config["http.proxy_uri"])
348 proxy = URI.parse @bot.config["http.proxy_uri"] rescue nil
351 debug "proxy is set to #{proxy.host} port #{proxy.port}"
352 if proxy_required(uri)
353 proxy_host = proxy.host
354 proxy_port = proxy.port
355 proxy_user = @bot.config["http.proxy_user"]
356 proxy_pass = @bot.config["http.proxy_pass"]
361 h = Net::HTTP.new(uri.host, uri.port, proxy_host, proxy_port, proxy_user, proxy_port)
362 h.use_ssl = true if uri.scheme == "https"
364 h.read_timeout = opts[:read_timeout]
365 h.open_timeout = opts[:open_timeout]
369 def handle_response(uri, resp, opts, &block)
370 if Net::HTTPRedirection === resp && opts[:max_redir] >= 0
371 if resp.key?('location')
372 raise 'Too many redirections' if opts[:max_redir] <= 0
373 yield resp if opts[:yield] == :all && block_given?
374 loc = resp['location']
375 new_loc = URI.join(uri.to_s, loc) rescue URI.parse(loc)
377 new_opts[:max_redir] -= 1
378 case opts[:method].to_s.downcase.intern
379 when :post, :"net::http::post"
380 new_opts[:method] = :get
382 debug "following the redirect to #{new_loc}"
383 return get_response(new_loc, new_opts, &block)
385 warning ":| redirect w/o location?"
390 alias :body :cooked_body
395 # Net::HTTP wants us to read the whole body here
401 # uri:: uri to query (Uri object or String)
402 # opts:: options. Currently used:
403 # :method:: request method [:get (default), :post or :head]
404 # :open_timeout:: open timeout for the proxy
405 # :read_timeout:: read timeout for the proxy
406 # :cache:: should we cache results?
407 # :yield:: if :final [default], call &block for the response object
408 # if :all, call &block for all intermediate redirects, too
409 # :max_redir:: how many redirects to follow before raising the exception
410 # if -1, don't follow redirects, just return them
411 # :range:: make a ranged request (usually GET). accepts a string
412 # for HTTP/1.1 "Range:" header (i.e. "bytes=0-1000")
413 # :body:: request body (usually for POST requests)
415 # Generic http transaction method
417 # It will return a Net::HTTPResponse object or raise an exception
419 # If a block is given, it will yield the response (see :yield option)
421 def get_response(uri_or_s, options = {}, &block)
422 uri = uri_or_s.kind_of?(URI) ? uri_or_s : URI.parse(uri_or_s.to_s)
424 :max_redir => @bot.config['http.max_redir'],
433 req_class = case opts[:method].to_s.downcase.intern
434 when :head, :"net::http::head"
435 opts[:max_redir] = -1
437 when :get, :"net::http::get"
439 when :post, :"net::http::post"
441 opts[:body] or raise 'post request w/o a body?'
442 warning "refusing to cache POST request" if options[:cache]
445 warning "unsupported method #{opts[:method]}, doing GET"
449 if req_class != Net::HTTP::Get && opts[:range]
450 warning "can't request ranges for #{req_class}"
454 cache_key = "#{opts[:range]}|#{req_class}|#{uri.to_s}"
456 if req_class != Net::HTTP::Get && req_class != Net::HTTP::Head
458 warning "can't cache #{req_class.inspect} requests, working w/o cache"
463 debug "get_response(#{uri}, #{opts.inspect})"
465 if opts[:cache] && cached = @cache[cache_key]
470 return handle_response(uri, cached.response, opts, &block)
474 headers = @headers.dup.merge(opts[:headers] || {})
475 headers['Range'] = opts[:range] if opts[:range]
477 cached.setup_headers(headers) if cached && (req_class == Net::HTTP::Get)
478 req = req_class.new(uri.request_uri, headers)
479 req.basic_auth(uri.user, uri.password) if uri.user && uri.password
480 req.body = opts[:body] if req_class == Net::HTTP::Post
481 debug "prepared request: #{req.to_hash.inspect}"
483 get_proxy(uri, opts).start do |http|
484 http.request(req) do |resp|
485 resp['x-rbot-location'] = uri.to_s
486 if Net::HTTPNotModified === resp
489 cached.revalidate(resp)
490 rescue Exception => e
493 debug "reusing cached"
494 resp = cached.response
495 elsif Net::HTTPServerError === resp || Net::HTTPClientError === resp
496 debug "http error, deleting cached obj" if cached
497 @cache.delete(cache_key)
500 return handle_response(uri, resp, opts, &block)
502 if cached = CachedObject.maybe_new(resp) rescue nil
503 debug "storing to cache"
504 @cache[cache_key] = cached
509 return handle_response(uri, resp, opts, &block)
514 # uri:: uri to query (Uri object)
516 # simple get request, returns (if possible) response body following redirs
517 # and caching if requested
518 def get(uri, opts = {}, &block)
520 resp = get_response(uri, opts, &block)
521 raise "http error: #{resp}" unless Net::HTTPOK === resp ||
522 Net::HTTPPartialContent === resp
524 rescue Exception => e
530 def head(uri, options = {}, &block)
531 opts = {:method => :head}.merge(options)
533 resp = get_response(uri, opts, &block)
534 raise "http error #{resp}" if Net::HTTPClientError === resp ||
535 Net::HTTPServerError == resp
537 rescue Exception => e
543 def post(uri, data, options = {}, &block)
544 opts = {:method => :post, :body => data, :cache => false}.merge(options)
546 resp = get_response(uri, opts, &block)
547 raise 'http error' unless Net::HTTPOK === resp
549 rescue Exception => e
555 def get_partial(uri, nbytes = @bot.config['http.info_bytes'], options = {}, &block)
556 opts = {:range => "bytes=0-#{nbytes}"}.merge(options)
557 return get(uri, opts, &block)
560 def remove_stale_cache
561 debug "Removing stale cache"
563 max_last = @bot.config['http.expire_time'] * 60
564 max_first = @bot.config['http.max_cache_time'] * 60
565 debug "#{@cache.size} pages before"
567 @cache.reject! { |k, val|
568 (now - val.last_used > max_last) || (now - val.first_used > max_first)
571 error "Failed to remove stale cache: #{e.pretty_inspect}"
573 debug "#{@cache.size} pages after"
580 class HttpUtilPlugin < CoreBotModule
583 debug 'initializing httputil'
584 @bot.httputil = Irc::Utils::HttpUtil.new(@bot)
588 debug 'shutting down httputil'
589 @bot.httputil.cleanup