lib/rbot/httputil.rb

   1 module Irc
   2 module Utils
   3
   4 require 'resolv'
   5 require 'net/http'
   6 require 'net/https'
   7 Net::HTTP.version_1_2
   8
   9 # class for making http requests easier (mainly for plugins to use)
  10 # this class can check the bot proxy configuration to determine if a proxy
  11 # needs to be used, which includes support for per-url proxy configuration.
  12 class HttpUtil
  13     BotConfig.register BotConfigBooleanValue.new('http.use_proxy',
  14       :default => false, :desc => "should a proxy be used for HTTP requests?")
  15     BotConfig.register BotConfigStringValue.new('http.proxy_uri', :default => false,
  16       :desc => "Proxy server to use for HTTP requests (URI, e.g http://proxy.host:port)")
  17     BotConfig.register BotConfigStringValue.new('http.proxy_user',
  18       :default => nil,
  19       :desc => "User for authenticating with the http proxy (if required)")
  20     BotConfig.register BotConfigStringValue.new('http.proxy_pass',
  21       :default => nil,
  22       :desc => "Password for authenticating with the http proxy (if required)")
  23     BotConfig.register BotConfigArrayValue.new('http.proxy_include',
  24       :default => [],
  25       :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")
  26     BotConfig.register BotConfigArrayValue.new('http.proxy_exclude',
  27       :default => [],
  28       :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")
  29     BotConfig.register BotConfigIntegerValue.new('http.max_redir',
  30       :default => 5,
  31       :desc => "Maximum number of redirections to be used when getting a document")
  32     BotConfig.register BotConfigIntegerValue.new('http.expire_time',
  33       :default => 60,
  34       :desc => "After how many minutes since last use a cached document is considered to be expired")
  35     BotConfig.register BotConfigIntegerValue.new('http.max_cache_time',
  36       :default => 60*24,
  37       :desc => "After how many minutes since first use a cached document is considered to be expired")
  38     BotConfig.register BotConfigIntegerValue.new('http.no_expire_cache',
  39       :default => false,
  40       :desc => "Set this to true if you want the bot to never expire the cached pages")
  41
  42   def initialize(bot)
  43     @bot = bot
  44     @cache = Hash.new
  45     @headers = {
  46       'User-Agent' => "rbot http util #{$version} (http://linuxbrit.co.uk/rbot/)",
  47     }
  48   end
  49
  50   # if http_proxy_include or http_proxy_exclude are set, then examine the
  51   # uri to see if this is a proxied uri
  52   # the in/excludes are a list of regexps, and each regexp is checked against
  53   # the server name, and its IP addresses
  54   def proxy_required(uri)
  55     use_proxy = true
  56     if @bot.config["http.proxy_exclude"].empty? && @bot.config["http.proxy_include"].empty?
  57       return use_proxy
  58     end
  59
  60     list = [uri.host]
  61     begin
  62       list.concat Resolv.getaddresses(uri.host)
  63     rescue StandardError => err
  64       warning "couldn't resolve host uri.host"
  65     end
  66
  67     unless @bot.config["http.proxy_exclude"].empty?
  68       re = @bot.config["http.proxy_exclude"].collect{|r| Regexp.new(r)}
  69       re.each do |r|
  70         list.each do |item|
  71           if r.match(item)
  72             use_proxy = false
  73             break
  74           end
  75         end
  76       end
  77     end
  78     unless @bot.config["http.proxy_include"].empty?
  79       re = @bot.config["http.proxy_include"].collect{|r| Regexp.new(r)}
  80       re.each do |r|
  81         list.each do |item|
  82           if r.match(item)
  83             use_proxy = true
  84             break
  85           end
  86         end
  87       end
  88     end
  89     debug "using proxy for uri #{uri}?: #{use_proxy}"
  90     return use_proxy
  91   end
  92
  93   # uri:: Uri to create a proxy for
  94   #
  95   # return a net/http Proxy object, which is configured correctly for
  96   # proxying based on the bot's proxy configuration.
  97   # This will include per-url proxy configuration based on the bot config
  98   # +http_proxy_include/exclude+ options.
  99   def get_proxy(uri)
 100     proxy = nil
 101     proxy_host = nil
 102     proxy_port = nil
 103     proxy_user = nil
 104     proxy_pass = nil
 105
 106     if @bot.config["http.use_proxy"]
 107       if (ENV['http_proxy'])
 108         proxy = URI.parse ENV['http_proxy'] rescue nil
 109       end
 110       if (@bot.config["http.proxy_uri"])
 111         proxy = URI.parse @bot.config["http.proxy_uri"] rescue nil
 112       end
 113       if proxy
 114         debug "proxy is set to #{proxy.host} port #{proxy.port}"
 115         if proxy_required(uri)
 116           proxy_host = proxy.host
 117           proxy_port = proxy.port
 118           proxy_user = @bot.config["http.proxy_user"]
 119           proxy_pass = @bot.config["http.proxy_pass"]
 120         end
 121       end
 122     end
 123
 124     h = Net::HTTP.new(uri.host, uri.port, proxy_host, proxy_port, proxy_user, proxy_port)
 125     h.use_ssl = true if uri.scheme == "https"
 126     return h
 127   end
 128
 129   # uri::         uri to query (Uri object)
 130   # readtimeout:: timeout for reading the response
 131   # opentimeout:: timeout for opening the connection
 132   #
 133   # simple get request, returns (if possible) response body following redirs
 134   # and caching if requested
 135   # if a block is given, it yields the urls it gets redirected to
 136   def get(uri_or_str, readtimeout=10, opentimeout=5, max_redir=@bot.config["http.max_redir"], cache=false)
 137     if uri_or_str.class <= URI
 138       uri = uri_or_str
 139     else
 140       uri = URI.parse(uri_or_str.to_s)
 141     end
 142
 143     proxy = get_proxy(uri)
 144     proxy.open_timeout = opentimeout
 145     proxy.read_timeout = readtimeout
 146
 147     begin
 148       proxy.start() {|http|
 149         yield uri.request_uri() if block_given?
 150         resp = http.get(uri.request_uri(), @headers)
 151         case resp
 152         when Net::HTTPSuccess
 153           if cache
 154             k = uri.to_s
 155             @cache[k] = Hash.new
 156             @cache[k][:body] = resp.body
 157             @cache[k][:last_mod] = Time.httpdate(resp['last-modified']) if resp.key?('last-modified')
 158             if resp.key?('date')
 159               @cache[k][:first_use] = Time.httpdate(resp['date'])
 160               @cache[k][:last_use] = Time.httpdate(resp['date'])
 161             else
 162               now = Time.new
 163               @cache[k][:first_use] = now
 164               @cache[k][:last_use] = now
 165             end
 166             @cache[k][:count] = 1
 167           end
 168           return resp.body
 169         when Net::HTTPRedirection
 170           debug "Redirecting #{uri} to #{resp['location']}"
 171           yield resp['location'] if block_given?
 172           if max_redir > 0
 173             return get( URI.parse(resp['location']), readtimeout, opentimeout, max_redir-1, cache)
 174           else
 175             warning "Max redirection reached, not going to #{resp['location']}"
 176           end
 177         else
 178           debug "HttpUtil.get return code #{resp.code} #{resp.body}"
 179         end
 180         return nil
 181       }
 182     rescue StandardError, Timeout::Error => e
 183       error "HttpUtil.get exception: #{e.inspect}, while trying to get #{uri}"
 184       debug e.backtrace.join("\n")
 185     end
 186     return nil
 187   end
 188
 189   # just like the above, but only gets the head
 190   def head(uri_or_str, readtimeout=10, opentimeout=5, max_redir=@bot.config["http.max_redir"])
 191     if uri_or_str.class <= URI
 192       uri = uri_or_str
 193     else
 194       uri = URI.parse(uri_or_str.to_s)
 195     end
 196
 197     proxy = get_proxy(uri)
 198     proxy.open_timeout = opentimeout
 199     proxy.read_timeout = readtimeout
 200
 201     begin
 202       proxy.start() {|http|
 203         yield uri.request_uri() if block_given?
 204         resp = http.head(uri.request_uri(), @headers)
 205         case resp
 206         when Net::HTTPSuccess
 207           return resp
 208         when Net::HTTPRedirection
 209           debug "Redirecting #{uri} to #{resp['location']}"
 210           yield resp['location'] if block_given?
 211           if max_redir > 0
 212             return head( URI.parse(resp['location']), readtimeout, opentimeout, max_redir-1)
 213           else
 214             warning "Max redirection reached, not going to #{resp['location']}"
 215           end
 216         else
 217           debug "HttpUtil.head return code #{resp.code}"
 218         end
 219         return nil
 220       }
 221     rescue StandardError, Timeout::Error => e
 222       error "HttpUtil.head exception: #{e.inspect}, while trying to get #{uri}"
 223       debug e.backtrace.join("\n")
 224     end
 225     return nil
 226   end
 227
 228   # gets a page from the cache if it's still (assumed to be) valid
 229   # TODO remove stale cached pages, except when called with noexpire=true
 230   def get_cached(uri_or_str, readtimeout=10, opentimeout=5,
 231                  max_redir=@bot.config['http.max_redir'],
 232                  noexpire=@bot.config['http.no_expire_cache'])
 233     if uri_or_str.class <= URI
 234       uri = uri_or_str
 235     else
 236       uri = URI.parse(uri_or_str.to_s)
 237     end
 238
 239     k = uri.to_s
 240     if !@cache.key?(k)
 241       remove_stale_cache unless noexpire
 242       return get(uri, readtimeout, opentimeout, max_redir, true)
 243     end
 244     now = Time.new
 245     begin
 246       # See if the last-modified header can be used
 247       # Assumption: the page was not modified if both the header
 248       # and the cached copy have the last-modified value, and it's the same time
 249       # If only one of the cached copy and the header have the value, or if the
 250       # value is different, we assume that the cached copyis invalid and therefore
 251       # get a new one.
 252       # On our first try, we tested for last-modified in the webpage first,
 253       # and then on the local cache. however, this is stupid (in general),
 254       # so we only test for the remote page if the local copy had the header
 255       # in the first place.
 256       if @cache[k].key?(:last_mod)
 257         h = head(uri, readtimeout, opentimeout, max_redir)
 258         if h.key?('last-modified')
 259           if Time.httpdate(h['last-modified']) == @cache[k][:last_mod]
 260             if h.key?('date')
 261               @cache[k][:last_use] = Time.httpdate(h['date'])
 262             else
 263               @cache[k][:last_use] = now
 264             end
 265             @cache[k][:count] += 1
 266             return @cache[k][:body]
 267           end
 268           remove_stale_cache unless noexpire
 269           return get(uri, readtimeout, opentimeout, max_redir, true)
 270         end
 271         remove_stale_cache unless noexpire
 272         return get(uri, readtimeout, opentimeout, max_redir, true)
 273       end
 274     rescue => e
 275       warning "Error #{e.inspect} getting the page #{uri}, using cache"
 276       debug e.backtrace.join("\n")
 277       return @cache[k][:body]
 278     end
 279     # If we still haven't returned, we are dealing with a non-redirected document
 280     # that doesn't have the last-modified attribute
 281     debug "Could not use last-modified attribute for URL #{uri}, guessing cache validity"
 282     if noexpire or !expired?(@cache[k], now)
 283       @cache[k][:count] += 1
 284       @cache[k][:last_use] = now
 285       debug "Using cache"
 286       return @cache[k][:body]
 287     end
 288     debug "Cache expired, getting anew"
 289     @cache.delete(k)
 290     remove_stale_cache unless noexpire
 291     return get(uri, readtimeout, opentimeout, max_redir, true)
 292   end
 293
 294   def expired?(hash, time)
 295     (time - hash[:last_use] > @bot.config['http.expire_time']*60) or
 296     (time - hash[:first_use] > @bot.config['http.max_cache_time']*60)
 297   end
 298
 299   def remove_stale_cache
 300     now = Time.new
 301     @cache.reject! { |k, val|
 302       !val.key?(:last_modified) && expired?(val, now)
 303     }
 304   end
 305
 306 end
 307 end
 308 end