123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511 |
- # Copyright (C) 2012-2016 Zammad Foundation, http://zammad-foundation.org/
- require 'net/http'
- require 'net/https'
- require 'net/ftp'
- class UserAgent
- =begin
- get http/https calls
- result = UserAgent.get('http://host/some_dir/some_file?param1=123')
- result = UserAgent.get(
- 'http://host/some_dir/some_file?param1=123',
- {
- param1: 'some value',
- },
- {
- open_timeout: 4,
- read_timeout: 10,
- },
- )
- returns
- result.body # as response
- get json object
- result = UserAgent.get(
- 'http://host/some_dir/some_file?param1=123',
- {},
- {
- json: true,
- }
- )
- returns
- result.data # as json object
- =end
- def self.get(url, params = {}, options = {}, count = 10)
- uri = URI.parse(url)
- http = get_http(uri, options)
- # prepare request
- request = Net::HTTP::Get.new(uri, { 'User-Agent' => 'Zammad User Agent' })
- # http basic auth (if needed)
- request = set_basic_auth(request, options)
- # set params
- request = set_params(request, params, options)
- # start http call
- begin
- total_timeout = options[:total_timeout] || 60
- Timeout.timeout(total_timeout) do
- response = http.request(request)
- return process(request, response, uri, count, params, options)
- end
- rescue => e
- log(url, request, nil, options)
- return Result.new(
- error: e.inspect,
- success: false,
- code: 0,
- )
- end
- end
- =begin
- post http/https calls
- result = UserAgent.post(
- 'http://host/some_dir/some_file',
- {
- param1: 1,
- param2: 2,
- },
- {
- open_timeout: 4,
- read_timeout: 10,
- total_timeout: 60,
- },
- )
- returns
- result # result object
- =end
- def self.post(url, params = {}, options = {}, count = 10)
- uri = URI.parse(url)
- http = get_http(uri, options)
- # prepare request
- request = Net::HTTP::Post.new(uri, { 'User-Agent' => 'Zammad User Agent' })
- # set params
- request = set_params(request, params, options)
- # http basic auth (if needed)
- request = set_basic_auth(request, options)
- # start http call
- begin
- total_timeout = options[:total_timeout] || 60
- Timeout.timeout(total_timeout) do
- response = http.request(request)
- return process(request, response, uri, count, params, options)
- end
- rescue => e
- log(url, request, nil, options)
- return Result.new(
- error: e.inspect,
- success: false,
- code: 0,
- )
- end
- end
- =begin
- put http/https calls
- result = UserAgent.put(
- 'http://host/some_dir/some_file',
- {
- param1: 1,
- param2: 2,
- },
- {
- open_timeout: 4,
- read_timeout: 10,
- },
- )
- returns
- result # result object
- =end
- def self.put(url, params = {}, options = {}, count = 10)
- uri = URI.parse(url)
- http = get_http(uri, options)
- # prepare request
- request = Net::HTTP::Put.new(uri, { 'User-Agent' => 'Zammad User Agent' })
- # set params
- request = set_params(request, params, options)
- # http basic auth (if needed)
- request = set_basic_auth(request, options)
- # start http call
- begin
- total_timeout = options[:total_timeout] || 60
- Timeout.timeout(total_timeout) do
- response = http.request(request)
- return process(request, response, uri, count, params, options)
- end
- rescue => e
- log(url, request, nil, options)
- return Result.new(
- error: e.inspect,
- success: false,
- code: 0,
- )
- end
- end
- =begin
- delete http/https calls
- result = UserAgent.delete(
- 'http://host/some_dir/some_file',
- {
- open_timeout: 4,
- read_timeout: 10,
- },
- )
- returns
- result # result object
- =end
- def self.delete(url, options = {}, count = 10)
- uri = URI.parse(url)
- http = get_http(uri, options)
- # prepare request
- request = Net::HTTP::Delete.new(uri, { 'User-Agent' => 'Zammad User Agent' })
- # http basic auth (if needed)
- request = set_basic_auth(request, options)
- # start http call
- begin
- total_timeout = options[:total_timeout] || 60
- Timeout.timeout(total_timeout) do
- response = http.request(request)
- return process(request, response, uri, count, {}, options)
- end
- rescue => e
- log(url, request, nil, options)
- return Result.new(
- error: e.inspect,
- success: false,
- code: 0,
- )
- end
- end
- =begin
- perform get http/https/ftp calls
- result = UserAgent.request('ftp://host/some_dir/some_file.bin')
- result = UserAgent.request('http://host/some_dir/some_file.bin')
- result = UserAgent.request('https://host/some_dir/some_file.bin')
- # get request
- result = UserAgent.request(
- 'http://host/some_dir/some_file?param1=123',
- {
- open_timeout: 4,
- read_timeout: 10,
- },
- )
- returns
- result # result object
- =end
- def self.request(url, options = {})
- uri = URI.parse(url)
- case uri.scheme.downcase
- when /ftp/
- ftp(uri, options)
- when /http|https/
- get(url, {}, options)
- end
- end
- def self.get_http(uri, options)
- proxy = options['proxy'] || Setting.get('proxy')
- proxy_no = options['proxy_no'] || Setting.get('proxy_no') || ''
- proxy_no = proxy_no.split(',').map(&:strip) || []
- proxy_no.push('localhost', '127.0.0.1', '::1')
- if proxy.present? && !proxy_no.include?(uri.host.downcase)
- if proxy =~ /^(.+?):(.+?)$/
- proxy_host = $1
- proxy_port = $2
- end
- if proxy_host.blank? || proxy_port.blank?
- raise "Invalid proxy address: #{proxy} - expect e.g. proxy.example.com:3128"
- end
- proxy_username = options['proxy_username'] || Setting.get('proxy_username')
- if proxy_username.blank?
- proxy_username = nil
- end
- proxy_password = options['proxy_password'] || Setting.get('proxy_password')
- if proxy_password.blank?
- proxy_password = nil
- end
- http = Net::HTTP::Proxy(proxy_host, proxy_port, proxy_username, proxy_password).new(uri.host, uri.port)
- else
- http = Net::HTTP.new(uri.host, uri.port)
- end
- http.open_timeout = options[:open_timeout] || 4
- http.read_timeout = options[:read_timeout] || 10
- if uri.scheme.match?(/https/i)
- http.use_ssl = true
- # @TODO verify_mode should be configurable
- http.verify_mode = OpenSSL::SSL::VERIFY_NONE
- end
- http
- end
- def self.set_basic_auth(request, options)
- # http basic auth (if needed)
- if options[:user] && options[:user] != '' && options[:password] && options[:password] != ''
- request.basic_auth options[:user], options[:password]
- end
- request
- end
- def self.set_params(request, params, options)
- if options[:json]
- request.add_field('Content-Type', 'application/json')
- if params.present?
- request.body = params.to_json
- end
- elsif params.present?
- request.set_form_data(params)
- end
- request
- end
- def self.log(url, request, response, options)
- return if !options[:log]
- # request
- request_data = {
- content: '',
- content_type: request['Content-Type'],
- content_encoding: request['Content-Encoding'],
- source: request['User-Agent'] || request['Server'],
- }
- request.each_header do |key, value|
- request_data[:content] += "#{key}: #{value}\n"
- end
- body = request.body
- if body
- request_data[:content] += "\n" + body
- end
- request_data[:content] = request_data[:content].slice(0, 8000)
- # response
- response_data = {
- code: 0,
- content: '',
- content_type: nil,
- content_encoding: nil,
- source: nil,
- }
- if response
- response_data[:code] = response.code
- response_data[:content_type] = response['Content-Type']
- response_data[:content_encoding] = response['Content-Encoding']
- response_data[:source] = response['User-Agent'] || response['Server']
- response.each_header do |key, value|
- response_data[:content] += "#{key}: #{value}\n"
- end
- body = response.body
- if body
- response_data[:content] += "\n" + body
- end
- response_data[:content] = response_data[:content].slice(0, 8000)
- end
- record = {
- direction: 'out',
- facility: options[:log][:facility],
- url: url,
- status: response_data[:code],
- ip: nil,
- request: request_data,
- response: response_data,
- method: request.method,
- }
- HttpLog.create(record)
- end
- def self.process(request, response, uri, count, params, options) # rubocop:disable Metrics/ParameterLists
- log(uri.to_s, request, response, options)
- if !response
- return Result.new(
- error: "Can't connect to #{uri}, got no response!",
- success: false,
- code: 0,
- )
- end
- case response
- when Net::HTTPNotFound
- return Result.new(
- error: "No such file #{uri}, 404!",
- success: false,
- code: response.code,
- )
- when Net::HTTPClientError
- return Result.new(
- error: "Client Error: #{response.inspect}!",
- success: false,
- code: response.code,
- )
- when Net::HTTPInternalServerError
- return Result.new(
- error: "Server Error: #{response.inspect}!",
- success: false,
- code: response.code,
- )
- when Net::HTTPRedirection
- raise 'Too many redirections for the original URL, halting.' if count <= 0
- url = response['location']
- return get(url, params, options, count - 1)
- when Net::HTTPOK
- data = nil
- if options[:json] && !options[:jsonParseDisable] && response.body
- data = JSON.parse(response.body)
- end
- return Result.new(
- data: data,
- body: response.body,
- content_type: response['Content-Type'],
- success: true,
- code: response.code,
- )
- when Net::HTTPCreated
- data = nil
- if options[:json] && !options[:jsonParseDisable] && response.body
- data = JSON.parse(response.body)
- end
- return Result.new(
- data: data,
- body: response.body,
- content_type: response['Content-Type'],
- success: true,
- code: response.code,
- )
- end
- raise "Unable to process http call '#{response.inspect}'"
- end
- def self.ftp(uri, options)
- host = uri.host
- filename = File.basename(uri.path)
- remote_dir = File.dirname(uri.path)
- temp_file = Tempfile.new("download-#{filename}")
- temp_file.binmode
- begin
- Net::FTP.open(host) do |ftp|
- ftp.passive = true
- if options[:user] && options[:password]
- ftp.login(options[:user], options[:password])
- else
- ftp.login
- end
- ftp.chdir(remote_dir) if remote_dir != '.'
- begin
- ftp.getbinaryfile(filename, temp_file)
- rescue => e
- return Result.new(
- error: e.inspect,
- success: false,
- code: '550',
- )
- end
- end
- rescue => e
- return Result.new(
- error: e.inspect,
- success: false,
- code: 0,
- )
- end
- contents = temp_file.read
- temp_file.close
- Result.new(
- body: contents,
- success: true,
- code: '200',
- )
- end
- class Result
- attr_reader :error
- attr_reader :body
- attr_reader :data
- attr_reader :code
- attr_reader :content_type
- def initialize(options)
- @success = options[:success]
- @body = options[:body]
- @data = options[:data]
- @code = options[:code]
- @content_type = options[:content_type]
- @error = options[:error]
- end
- def success?
- return true if @success
- false
- end
- end
- end
|