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',
26 :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")
31 'User-Agent' => "rbot http util #{$version} (http://linuxbrit.co.uk/rbot/)",
35 # if http_proxy_include or http_proxy_exclude are set, then examine the
36 # uri to see if this is a proxied uri
37 # the in/excludes are a list of regexps, and each regexp is checked against
38 # the server name, and its IP addresses
39 def proxy_required(uri)
41 if @bot.config["http.proxy_exclude"].empty? && @bot.config["http.proxy_include"].empty?
47 list.concat Resolv.getaddresses(uri.host)
48 rescue StandardError => err
49 puts "warning: couldn't resolve host uri.host"
52 unless @bot.config["http.proxy_exclude"].empty?
53 re = @bot.config["http.proxy_exclude"].collect{|r| Regexp.new(r)}
63 unless @bot.config["http.proxy_include"].empty?
64 re = @bot.config["http.proxy_include"].collect{|r| Regexp.new(r)}
74 debug "using proxy for uri #{uri}?: #{use_proxy}"
78 # uri:: Uri to create a proxy for
80 # return a net/http Proxy object, which is configured correctly for
81 # proxying based on the bot's proxy configuration.
82 # This will include per-url proxy configuration based on the bot config
83 # +http_proxy_include/exclude+ options.
91 if @bot.config["http.use_proxy"]
92 if (ENV['http_proxy'])
93 proxy = URI.parse ENV['http_proxy'] rescue nil
95 if (@bot.config["http.proxy_uri"])
96 proxy = URI.parse @bot.config["http.proxy_uri"] rescue nil
99 debug "proxy is set to #{proxy.uri}"
100 if proxy_required(uri)
101 proxy_host = proxy.host
102 proxy_port = proxy.port
103 proxy_user = @bot.config["http.proxy_user"]
104 proxy_pass = @bot.config["http.proxy_pass"]
109 return Net::HTTP.new(uri.host, uri.port, proxy_host, proxy_port, proxy_user, proxy_port)
112 # uri:: uri to query (Uri object)
113 # readtimeout:: timeout for reading the response
114 # opentimeout:: timeout for opening the connection
116 # simple get request, returns response body if the status code is 200 and
117 # the request doesn't timeout.
118 def get(uri, readtimeout=10, opentimeout=5)
119 proxy = get_proxy(uri)
120 proxy.open_timeout = opentimeout
121 proxy.read_timeout = readtimeout
124 proxy.start() {|http|
125 resp = http.get(uri.request_uri(), @headers)
126 if resp.code == "200"
129 puts "HttpUtil.get return code #{resp.code} #{resp.body}"
133 rescue StandardError, Timeout::Error => e
134 $stderr.puts "HttpUtil.get exception: #{e}, while trying to get #{uri}"