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