8 # class for making http requests easier (mainly for plugins to use)
9 # this class can check the bot proxy configuration to determine if a proxy
10 # needs to be used, which includes support for per-url proxy configuration.
12 BotConfig.register BotConfigBooleanValue.new('http.use_proxy',
13 :default => false, :desc => "should a proxy be used for HTTP requests?")
14 BotConfig.register BotConfigStringValue.new('http.proxy_uri', :default => false,
15 :desc => "Proxy server to use for HTTP requests (URI, e.g http://proxy.host:port)")
16 BotConfig.register BotConfigStringValue.new('http.proxy_user',
18 :desc => "User for authenticating with the http proxy (if required)")
19 BotConfig.register BotConfigStringValue.new('http.proxy_pass',
21 :desc => "Password for authenticating with the http proxy (if required)")
22 BotConfig.register BotConfigArrayValue.new('http.proxy_include',
24 :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")
25 BotConfig.register BotConfigArrayValue.new('http.proxy_exclude',
27 :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")
32 'User-Agent' => "rbot http util #{$version} (http://linuxbrit.co.uk/rbot/)",
36 # if http_proxy_include or http_proxy_exclude are set, then examine the
37 # uri to see if this is a proxied uri
38 # the in/excludes are a list of regexps, and each regexp is checked against
39 # the server name, and its IP addresses
40 def proxy_required(uri)
42 if @bot.config["http.proxy_exclude"].empty? && @bot.config["http.proxy_include"].empty?
48 list.concat Resolv.getaddresses(uri.host)
49 rescue StandardError => err
50 puts "warning: couldn't resolve host uri.host"
53 unless @bot.config["http.proxy_exclude"].empty?
54 re = @bot.config["http.proxy_exclude"].collect{|r| Regexp.new(r)}
64 unless @bot.config["http.proxy_include"].empty?
65 re = @bot.config["http.proxy_include"].collect{|r| Regexp.new(r)}
75 debug "using proxy for uri #{uri}?: #{use_proxy}"
79 # uri:: Uri to create a proxy for
81 # return a net/http Proxy object, which is configured correctly for
82 # proxying based on the bot's proxy configuration.
83 # This will include per-url proxy configuration based on the bot config
84 # +http_proxy_include/exclude+ options.
92 if @bot.config["http.use_proxy"]
93 if (ENV['http_proxy'])
94 proxy = URI.parse ENV['http_proxy'] rescue nil
96 if (@bot.config["http.proxy_uri"])
97 proxy = URI.parse @bot.config["http.proxy_uri"] rescue nil
100 debug "proxy is set to #{proxy.uri}"
101 if proxy_required(uri)
102 proxy_host = proxy.host
103 proxy_port = proxy.port
104 proxy_user = @bot.config["http.proxy_user"]
105 proxy_pass = @bot.config["http.proxy_pass"]
110 return Net::HTTP.new(uri.host, uri.port, proxy_host, proxy_port, proxy_user, proxy_port)
113 # uri:: uri to query (Uri object)
114 # readtimeout:: timeout for reading the response
115 # opentimeout:: timeout for opening the connection
117 # simple get request, returns response body if the status code is 200 and
118 # the request doesn't timeout.
119 def get(uri, readtimeout=10, opentimeout=5)
120 proxy = get_proxy(uri)
121 proxy.open_timeout = opentimeout
122 proxy.read_timeout = readtimeout
125 proxy.start() {|http|
126 resp = http.get(uri.request_uri(), @headers)
127 if resp.code == "200"
130 puts "HttpUtil.get return code #{resp.code} #{resp.body}"
134 rescue StandardError, Timeout::Error => e
135 $stderr.puts "HttpUtil.get exception: #{e}, while trying to get #{uri}"