lib/rbot/core/utils/httputil.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: rbot HTTP provider
   5 #
   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>
   9 #
  10 # Copyright:: (C) 2002-2005 Tom Gilbert
  11 # Copyright:: (C) 2006 Tom Gilbert, Giuseppe Bilotta
  12 # Copyright:: (C) 2007 Giuseppe Bilotta, Dmitry Kim
  13
  14 require 'resolv'
  15 require 'net/http'
  16 require 'cgi'
  17 require 'iconv'
  18 begin
  19   require 'net/https'
  20 rescue LoadError => e
  21   error "Couldn't load 'net/https':  #{e.pretty_inspect}"
  22   error "Secured HTTP connections will fail"
  23 end
  24
  25 # To handle Gzipped pages
  26 require 'stringio'
  27 require 'zlib'
  28
  29 module ::Net
  30   class HTTPResponse
  31     attr_accessor :no_cache
  32     if !instance_methods.include?('raw_body')
  33       alias :raw_body :body
  34     end
  35
  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
  39
  40       charsets = ['latin1'] # should be in config
  41
  42       if self['content-type'].match(/charset=["']?([^\s"']+)["']?/i)
  43         charsets << $1
  44         debug "charset #{charsets.last} added from header"
  45       end
  46
  47       case str
  48       when /<\?xml\s[^>]*encoding=['"]([^\s"'>]+)["'][^>]*\?>/i
  49         charsets << $1
  50         debug "xml charset #{charsets.last} added from xml pi"
  51       when /<(meta\s[^>]*http-equiv=["']?Content-Type["']?[^>]*)>/i
  52         meta = $1
  53         if meta =~ /charset=['"]?([^\s'";]+)['"]?/
  54           charsets << $1
  55           debug "html charset #{charsets.last} added from meta"
  56         end
  57       end
  58       return charsets.uniq
  59     end
  60
  61     def body_to_utf(str)
  62       charsets = self.body_charset(str) or return str
  63
  64       charsets.reverse_each do |charset|
  65         # XXX: this one is really ugly, but i don't know how to make it better
  66         #  -jsn
  67
  68         0.upto(5) do |off|
  69           begin
  70             debug "trying #{charset} / offset #{off}"
  71             return Iconv.iconv('utf-8//ignore',
  72                                charset,
  73                                str.slice(0 .. (-1 - off))).first
  74           rescue
  75             debug "conversion failed for #{charset} / offset #{off}"
  76           end
  77         end
  78       end
  79       return str
  80     end
  81
  82     def decompress_body(str)
  83       method = self['content-encoding']
  84       case method
  85       when nil
  86         return str
  87       when 'gzip', 'x-gzip'
  88         debug "gunzipping body"
  89         begin
  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
  93           # partial read
  94           debug "full gunzipping failed (#{e}), trying to recover as much as possible"
  95           ret = ""
  96           begin
  97             Zlib::GzipReader.new(StringIO.new(str)).each_byte { |byte|
  98               ret << byte
  99             }
 100           rescue
 101           end
 102           return ret
 103         end
 104       else
 105         raise "Unhandled content encoding #{method}"
 106       end
 107     end
 108
 109     def cooked_body
 110       return self.body_to_utf(self.decompress_body(self.raw_body))
 111     end
 112
 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)
 116
 117       self.no_cache = true
 118       partial = String.new
 119
 120       self.read_body { |chunk|
 121         partial << 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
 124       }
 125
 126       return self.body_to_utf(self.decompress_body(partial))
 127     end
 128   end
 129 end
 130
 131 Net::HTTP.version_1_2
 132
 133 module ::Irc
 134 module Utils
 135
 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.
 139 class HttpUtil
 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',
 145       :default => nil,
 146       :desc => "User for authenticating with the http proxy (if required)")
 147     BotConfig.register BotConfigStringValue.new('http.proxy_pass',
 148       :default => nil,
 149       :desc => "Password for authenticating with the http proxy (if required)")
 150     BotConfig.register BotConfigArrayValue.new('http.proxy_include',
 151       :default => [],
 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',
 154       :default => [],
 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',
 157       :default => 5,
 158       :desc => "Maximum number of redirections to be used when getting a document")
 159     BotConfig.register BotConfigIntegerValue.new('http.expire_time',
 160       :default => 60,
 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',
 163       :default => 60*24,
 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',
 166       :default => false,
 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',
 169       :default => 8192,
 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.")
 171
 172   class CachedObject
 173     attr_accessor :response, :last_used, :first_used, :count, :expires, :date
 174
 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
 182
 183       cc = resp['cache-control']
 184       return nil if cc && (cc =~ /no-cache/i)
 185
 186       date = Time.now
 187       if d = resp['date']
 188         date = Time.httpdate(d)
 189       end
 190
 191       return nil if resp['expires'] && (Time.httpdate(resp['expires']) < date)
 192
 193       debug "creating cache obj"
 194
 195       self.new(resp)
 196     end
 197
 198     def use
 199       now = Time.now
 200       @first_used = now if @count == 0
 201       @last_used = now
 202       @count += 1
 203     end
 204
 205     def expired?
 206       debug "checking expired?"
 207       if cc = self.response['cache-control'] && cc =~ /must-revalidate/
 208         return true
 209       end
 210       return self.expires < Time.now
 211     end
 212
 213     def setup_headers(hdr)
 214       hdr['if-modified-since'] = self.date.rfc2822
 215
 216       debug "ims == #{hdr['if-modified-since']}"
 217
 218       if etag = self.response['etag']
 219         hdr['if-none-match'] = etag
 220         debug "etag: #{etag}"
 221       end
 222     end
 223
 224     def revalidate(resp = self.response)
 225       @count = 0
 226       self.use
 227       self.date = resp.key?('date') ? Time.httpdate(resp['date']) : Time.now
 228
 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
 237         delta /= 5
 238         self.expires = self.date + delta
 239       else
 240         self.expires = self.date + 300
 241       end
 242       # self.expires = Time.now + 10 # DEBUG
 243       debug "expires on #{self.expires}"
 244
 245       return true
 246     end
 247
 248     private
 249     def initialize(resp)
 250       @response = resp
 251       begin
 252         self.revalidate
 253         self.response.raw_body
 254       rescue Exception => e
 255         error e
 256         raise e
 257       end
 258     end
 259   end
 260
 261   def initialize(bot)
 262     @bot = bot
 263     @cache = Hash.new
 264     @headers = {
 265       'Accept-Charset' => 'utf-8;q=1.0, *;q=0.8',
 266       'Accept-Encoding' => 'gzip;q=1, identity;q=0.8, *;q=0.2',
 267       'User-Agent' =>
 268         "rbot http util #{$version} (http://linuxbrit.co.uk/rbot/)"
 269     }
 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']
 273     }
 274   end
 275
 276   def cleanup
 277     debug 'stopping http cache cleanup timer'
 278     @bot.timer.remove(@timer)
 279     super
 280   end
 281
 282   # if http_proxy_include or http_proxy_exclude are set, then examine the
 283   # uri to see if this is a proxied uri
 284   # the in/excludes are a list of regexps, and each regexp is checked against
 285   # the server name, and its IP addresses
 286   def proxy_required(uri)
 287     use_proxy = true
 288     if @bot.config["http.proxy_exclude"].empty? && @bot.config["http.proxy_include"].empty?
 289       return use_proxy
 290     end
 291
 292     list = [uri.host]
 293     begin
 294       list.concat Resolv.getaddresses(uri.host)
 295     rescue StandardError => err
 296       warning "couldn't resolve host uri.host"
 297     end
 298
 299     unless @bot.config["http.proxy_exclude"].empty?
 300       re = @bot.config["http.proxy_exclude"].collect{|r| Regexp.new(r)}
 301       re.each do |r|
 302         list.each do |item|
 303           if r.match(item)
 304             use_proxy = false
 305             break
 306           end
 307         end
 308       end
 309     end
 310     unless @bot.config["http.proxy_include"].empty?
 311       re = @bot.config["http.proxy_include"].collect{|r| Regexp.new(r)}
 312       re.each do |r|
 313         list.each do |item|
 314           if r.match(item)
 315             use_proxy = true
 316             break
 317           end
 318         end
 319       end
 320     end
 321     debug "using proxy for uri #{uri}?: #{use_proxy}"
 322     return use_proxy
 323   end
 324
 325   # uri:: Uri to create a proxy for
 326   #
 327   # return a net/http Proxy object, which is configured correctly for
 328   # proxying based on the bot's proxy configuration.
 329   # This will include per-url proxy configuration based on the bot config
 330   # +http_proxy_include/exclude+ options.
 331
 332   def get_proxy(uri, options = {})
 333     opts = {
 334       :read_timeout => 10,
 335       :open_timeout => 5
 336     }.merge(options)
 337
 338     proxy = nil
 339     proxy_host = nil
 340     proxy_port = nil
 341     proxy_user = nil
 342     proxy_pass = nil
 343
 344     if @bot.config["http.use_proxy"]
 345       if (ENV['http_proxy'])
 346         proxy = URI.parse ENV['http_proxy'] rescue nil
 347       end
 348       if (@bot.config["http.proxy_uri"])
 349         proxy = URI.parse @bot.config["http.proxy_uri"] rescue nil
 350       end
 351       if proxy
 352         debug "proxy is set to #{proxy.host} port #{proxy.port}"
 353         if proxy_required(uri)
 354           proxy_host = proxy.host
 355           proxy_port = proxy.port
 356           proxy_user = @bot.config["http.proxy_user"]
 357           proxy_pass = @bot.config["http.proxy_pass"]
 358         end
 359       end
 360     end
 361
 362     h = Net::HTTP.new(uri.host, uri.port, proxy_host, proxy_port, proxy_user, proxy_port)
 363     h.use_ssl = true if uri.scheme == "https"
 364
 365     h.read_timeout = opts[:read_timeout]
 366     h.open_timeout = opts[:open_timeout]
 367     return h
 368   end
 369
 370   def handle_response(uri, resp, opts, &block)
 371     if Net::HTTPRedirection === resp && opts[:max_redir] >= 0
 372       if resp.key?('location')
 373         raise 'Too many redirections' if opts[:max_redir] <= 0
 374         yield resp if opts[:yield] == :all && block_given?
 375         loc = resp['location']
 376         new_loc = URI.join(uri.to_s, loc) rescue URI.parse(loc)
 377         new_opts = opts.dup
 378         new_opts[:max_redir] -= 1
 379         case opts[:method].to_s.downcase.intern
 380         when :post, :"net::http::post"
 381           new_opts[:method] = :get
 382         end
 383         debug "following the redirect to #{new_loc}"
 384         return get_response(new_loc, new_opts, &block)
 385       else
 386         warning ":| redirect w/o location?"
 387       end
 388     end
 389     class << resp
 390       undef_method :body
 391       alias :body :cooked_body
 392     end
 393     if block_given?
 394       yield(resp)
 395     else
 396       # Net::HTTP wants us to read the whole body here
 397       resp.raw_body
 398     end
 399     return resp
 400   end
 401
 402   # uri::         uri to query (Uri object or String)
 403   # opts::        options. Currently used:
 404   # :method::     request method [:get (default), :post or :head]
 405   # :open_timeout::     open timeout for the proxy
 406   # :read_timeout::     read timeout for the proxy
 407   # :cache::            should we cache results?
 408   # :yield::      if :final [default], call &block for the response object
 409   #               if :all, call &block for all intermediate redirects, too
 410   # :max_redir::  how many redirects to follow before raising the exception
 411   #               if -1, don't follow redirects, just return them
 412   # :range::      make a ranged request (usually GET). accepts a string
 413   #               for HTTP/1.1 "Range:" header (i.e. "bytes=0-1000")
 414   # :body::       request body (usually for POST requests)
 415   #
 416   # Generic http transaction method
 417   #
 418   # It will return a Net::HTTPResponse object or raise an exception
 419   #
 420   # If a block is given, it will yield the response (see :yield option)
 421
 422   def get_response(uri_or_s, options = {}, &block)
 423     uri = uri_or_s.kind_of?(URI) ? uri_or_s : URI.parse(uri_or_s.to_s)
 424     opts = {
 425       :max_redir => @bot.config['http.max_redir'],
 426       :yield => :final,
 427       :cache => true,
 428       :method => :GET
 429     }.merge(options)
 430
 431     resp = nil
 432     cached = nil
 433
 434     req_class = case opts[:method].to_s.downcase.intern
 435                 when :head, :"net::http::head"
 436                   opts[:max_redir] = -1
 437                   Net::HTTP::Head
 438                 when :get, :"net::http::get"
 439                   Net::HTTP::Get
 440                 when :post, :"net::http::post"
 441                   opts[:cache] = false
 442                   opts[:body] or raise 'post request w/o a body?'
 443                   warning "refusing to cache POST request" if options[:cache]
 444                   Net::HTTP::Post
 445                 else
 446                   warning "unsupported method #{opts[:method]}, doing GET"
 447                   Net::HTTP::Get
 448                 end
 449
 450     if req_class != Net::HTTP::Get && opts[:range]
 451       warning "can't request ranges for #{req_class}"
 452       opts.delete(:range)
 453     end
 454
 455     cache_key = "#{opts[:range]}|#{req_class}|#{uri.to_s}"
 456
 457     if req_class != Net::HTTP::Get && req_class != Net::HTTP::Head
 458       if opts[:cache]
 459         warning "can't cache #{req_class.inspect} requests, working w/o cache"
 460         opts[:cache] = false
 461       end
 462     end
 463
 464     debug "get_response(#{uri}, #{opts.inspect})"
 465
 466     if opts[:cache] && cached = @cache[cache_key]
 467       debug "got cached"
 468       if !cached.expired?
 469         debug "using cached"
 470         cached.use
 471         return handle_response(uri, cached.response, opts, &block)
 472       end
 473     end
 474
 475     headers = @headers.dup.merge(opts[:headers] || {})
 476     headers['Range'] = opts[:range] if opts[:range]
 477
 478     cached.setup_headers(headers) if cached && (req_class == Net::HTTP::Get)
 479     req = req_class.new(uri.request_uri, headers)
 480     req.basic_auth(uri.user, uri.password) if uri.user && uri.password
 481     req.body = opts[:body] if req_class == Net::HTTP::Post
 482     debug "prepared request: #{req.to_hash.inspect}"
 483
 484     get_proxy(uri, opts).start do |http|
 485       http.request(req) do |resp|
 486         resp['x-rbot-location'] = uri.to_s
 487         if Net::HTTPNotModified === resp
 488           debug "not modified"
 489           begin
 490             cached.revalidate(resp)
 491           rescue Exception => e
 492             error e
 493           end
 494           debug "reusing cached"
 495           resp = cached.response
 496         elsif Net::HTTPServerError === resp || Net::HTTPClientError === resp
 497           debug "http error, deleting cached obj" if cached
 498           @cache.delete(cache_key)
 499         elsif opts[:cache]
 500           begin
 501             return handle_response(uri, resp, opts, &block)
 502           ensure
 503             if cached = CachedObject.maybe_new(resp) rescue nil
 504               debug "storing to cache"
 505               @cache[cache_key] = cached
 506             end
 507           end
 508           return ret
 509         end
 510         return handle_response(uri, resp, opts, &block)
 511       end
 512     end
 513   end
 514
 515   # uri::         uri to query (Uri object)
 516   #
 517   # simple get request, returns (if possible) response body following redirs
 518   # and caching if requested
 519   def get(uri, opts = {}, &block)
 520     begin
 521       resp = get_response(uri, opts, &block)
 522       raise "http error: #{resp}" unless Net::HTTPOK === resp ||
 523         Net::HTTPPartialContent === resp
 524       return resp.body
 525     rescue Exception => e
 526       error e
 527     end
 528     return nil
 529   end
 530
 531   def head(uri, options = {}, &block)
 532     opts = {:method => :head}.merge(options)
 533     begin
 534       resp = get_response(uri, opts, &block)
 535       raise "http error #{resp}" if Net::HTTPClientError === resp ||
 536         Net::HTTPServerError == resp
 537       return resp
 538     rescue Exception => e
 539       error e
 540     end
 541     return nil
 542   end
 543
 544   def post(uri, data, options = {}, &block)
 545     opts = {:method => :post, :body => data, :cache => false}.merge(options)
 546     begin
 547       resp = get_response(uri, opts, &block)
 548       raise 'http error' unless Net::HTTPOK === resp
 549       return resp
 550     rescue Exception => e
 551       error e
 552     end
 553     return nil
 554   end
 555
 556   def get_partial(uri, nbytes = @bot.config['http.info_bytes'], options = {}, &block)
 557     opts = {:range => "bytes=0-#{nbytes}"}.merge(options)
 558     return get(uri, opts, &block)
 559   end
 560
 561   def remove_stale_cache
 562     debug "Removing stale cache"
 563     now = Time.new
 564     max_last = @bot.config['http.expire_time'] * 60
 565     max_first = @bot.config['http.max_cache_time'] * 60
 566     debug "#{@cache.size} pages before"
 567     begin
 568       @cache.reject! { |k, val|
 569         (now - val.last_used > max_last) || (now - val.first_used > max_first)
 570       }
 571     rescue => e
 572       error "Failed to remove stale cache: #{e.pretty_inspect}"
 573     end
 574     debug "#{@cache.size} pages after"
 575   end
 576
 577 end
 578 end
 579 end
 580
 581 class HttpUtilPlugin < CoreBotModule
 582   def initialize(*a)
 583     super(*a)
 584     debug 'initializing httputil'
 585     @bot.httputil = Irc::Utils::HttpUtil.new(@bot)
 586   end
 587
 588   def cleanup
 589     debug 'shutting down httputil'
 590     @bot.httputil.cleanup
 591     @bot.httputil = nil
 592   end
 593 end
 594
 595 HttpUtilPlugin.new