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