Class: Gem::Request

Inherits:
Object
  • Object
show all
Includes:
UserInteraction
Defined in:
lib/rubygems/request.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from UserInteraction

#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction

Methods included from DefaultUserInteraction

ui, #ui, ui=, #ui=, use_ui, #use_ui

Constructor Details

#initialize(uri, request_class, last_modified, proxy) ⇒ Request

Returns a new instance of Request.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/rubygems/request.rb', line 12

def initialize(uri, request_class, last_modified, proxy)
  @uri = uri
  @request_class = request_class
  @last_modified = last_modified
  @requests = Hash.new 0
  @connections = {}
  @connections_mutex = Mutex.new
  @user_agent = user_agent

  @proxy_uri =
    case proxy
    when :no_proxy then nil
    when nil       then get_proxy_from_env uri.scheme
    when URI::HTTP then proxy
    else URI.parse(proxy)
    end
  @env_no_proxy = get_no_proxy_from_env
end

Instance Attribute Details

#proxy_uri ⇒ Object (readonly)

Returns the value of attribute proxy_uri



10
11
12
 
# File 'lib/rubygems/request.rb', line 10

def proxy_uri
  @proxy_uri
end

Instance Method Details

#add_rubygems_trusted_certs(store) ⇒ Object 



31
32
33
34
35
36
 
# File 'lib/rubygems/request.rb', line 31

def add_rubygems_trusted_certs(store)
  pattern = File.expand_path("./ssl_certs/*.pem", File.dirname(__FILE__))
  Dir.glob(pattern).each do |ssl_cert_file|
    store.add_file ssl_cert_file
  end
end

#configure_connection_for_https(connection) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/rubygems/request.rb', line 38

def configure_connection_for_https(connection)
  require 'net/https'
  connection.use_ssl = true
  connection.verify_mode =
    Gem.configuration.ssl_verify_mode || OpenSSL::SSL::VERIFY_PEER
  store = OpenSSL::X509::Store.new

  if Gem.configuration.ssl_client_cert then
    pem = File.read Gem.configuration.ssl_client_cert
    connection.cert = OpenSSL::X509::Certificate.new pem
    connection.key = OpenSSL::PKey::RSA.new pem
  end

  if Gem.configuration.ssl_ca_cert
    if File.directory? Gem.configuration.ssl_ca_cert
      store.add_path Gem.configuration.ssl_ca_cert
    else
      store.add_file Gem.configuration.ssl_ca_cert
    end
  else
    store.set_default_paths
    add_rubygems_trusted_certs(store)
  end
  connection.cert_store = store
rescue LoadError => e
  raise unless (e.respond_to?(:path) && e.path == 'openssl') ||
               e.message =~ / -- openssl$/

  raise Gem::Exception.new(
          'Unable to require openssl, install OpenSSL and rebuild ruby (preferred) or use non-HTTPS sources')
end

#connection_for(uri) ⇒ Object

Creates or an HTTP connection based on uri, or retrieves an existing connection, using a proxy if needed.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/rubygems/request.rb', line 74

def connection_for(uri)
  net_http_args = [uri.host, uri.port]

  if @proxy_uri and not no_proxy?(uri.host) then
    net_http_args += [
      @proxy_uri.host,
      @proxy_uri.port,
      Gem::UriFormatter.new(@proxy_uri.user).unescape,
      Gem::UriFormatter.new(@proxy_uri.password).unescape,
    ]
  end

  connection_id = [Thread.current.object_id, *net_http_args].join ':'

  connection = @connections_mutex.synchronize do
    @connections[connection_id] ||= Net::HTTP.new(*net_http_args)
    @connections[connection_id]
  end

  if https?(uri) and not connection.started? then
    configure_connection_for_https(connection)
  end

  connection.start unless connection.started?

  connection
rescue defined?(OpenSSL::SSL) ? OpenSSL::SSL::SSLError : Errno::EHOSTDOWN,
       Errno::EHOSTDOWN => e
  raise Gem::RemoteFetcher::FetchError.new(e.message, uri)
end

#fetch {|request| ... } ⇒ Object

Yields:

  • (request) 


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/rubygems/request.rb', line 105

def fetch
  request = @request_class.new @uri.request_uri

  unless @uri.nil? || @uri.user.nil? || @uri.user.empty? then
    request.basic_auth @uri.user, @uri.password
  end

  request.add_field 'User-Agent', @user_agent
  request.add_field 'Connection', 'keep-alive'
  request.add_field 'Keep-Alive', '30'

  if @last_modified then
    request.add_field 'If-Modified-Since', @last_modified.httpdate
  end

  yield request if block_given?

  connection = connection_for @uri

  retried = false
  bad_response = false

  begin
    @requests[connection.object_id] += 1

    say "#{request.method} #{@uri}" if
      Gem.configuration.really_verbose

    file_name = File.basename(@uri.path)
    # perform download progress reporter only for gems
    if request.response_body_permitted? && file_name =~ /\.gem$/
      reporter = ui.download_reporter
      response = connection.request(request) do |incomplete_response|
        if Net::HTTPOK === incomplete_response
          reporter.fetch(file_name, incomplete_response.content_length)
          downloaded = 0
          data = ''

          incomplete_response.read_body do |segment|
            data << segment
            downloaded += segment.length
            reporter.update(downloaded)
          end
          reporter.done
          if incomplete_response.respond_to? :body=
            incomplete_response.body = data
          else
            incomplete_response.instance_variable_set(:@body, data)
          end
        end
      end
    else
      response = connection.request request
    end

    say "#{response.code} #{response.message}" if
      Gem.configuration.really_verbose

  rescue Net::HTTPBadResponse
    say "bad response" if Gem.configuration.really_verbose

    reset connection

    raise Gem::RemoteFetcher::FetchError.new('too many bad responses', @uri) if bad_response

    bad_response = true
    retry
  # HACK work around EOFError bug in Net::HTTP
  # NOTE Errno::ECONNABORTED raised a lot on Windows, and make impossible
  # to install gems.
  rescue EOFError, Timeout::Error,
         Errno::ECONNABORTED, Errno::ECONNRESET, Errno::EPIPE

    requests = @requests[connection.object_id]
    say "connection reset after #{requests} requests, retrying" if
      Gem.configuration.really_verbose

    raise Gem::RemoteFetcher::FetchError.new('too many connection resets', @uri) if retried

    reset connection

    retried = true
    retry
  end

  response
end

#get_no_proxy_from_env ⇒ Object

Returns list of no_proxy entries (if any) from the environment



196
197
198
199
200
201
202
 
# File 'lib/rubygems/request.rb', line 196

def get_no_proxy_from_env
  env_no_proxy = ENV['no_proxy'] || ENV['NO_PROXY']

  return [] if env_no_proxy.nil?  or env_no_proxy.empty?

  env_no_proxy.split(/\s*,\s*/)
end

#get_proxy_from_env(scheme = 'http') ⇒ Object

Returns a proxy URI for the given scheme if one is set in the environment variables.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/rubygems/request.rb', line 208

def get_proxy_from_env scheme = 'http'
  _scheme = scheme.downcase
  _SCHEME = scheme.upcase
  env_proxy = ENV["#{_scheme}_proxy"] || ENV["#{_SCHEME}_PROXY"]

  no_env_proxy = env_proxy.nil? || env_proxy.empty?

  return get_proxy_from_env 'http' if no_env_proxy and _scheme != 'http'
  return nil                       if no_env_proxy

  uri = URI(Gem::UriFormatter.new(env_proxy).normalize)

  if uri and uri.user.nil? and uri.password.nil? then
    user     = ENV["#{_scheme}_proxy_user"] || ENV["#{_SCHEME}_PROXY_USER"]
    password = ENV["#{_scheme}_proxy_pass"] || ENV["#{_SCHEME}_PROXY_PASS"]

    uri.user     = Gem::UriFormatter.new(user).escape
    uri.password = Gem::UriFormatter.new(password).escape
  end

  uri
end

#https?(uri) ⇒ Boolean

Returns:

  • (Boolean) 


231
232
233
 
# File 'lib/rubygems/request.rb', line 231

def https?(uri)
  uri.scheme.downcase == 'https'
end

#no_proxy?(host) ⇒ Boolean

Returns:

  • (Boolean) 


235
236
237
238
239
240
241
242
 
# File 'lib/rubygems/request.rb', line 235

def no_proxy? host
  host = host.downcase
  @env_no_proxy.each do |pattern|
    pattern = pattern.downcase
    return true if host[-pattern.length, pattern.length ] == pattern
  end
  return false
end

#reset(connection) ⇒ Object

Resets HTTP connection connection.



247
248
249
250
251
252
 
# File 'lib/rubygems/request.rb', line 247

def reset(connection)
  @requests.delete connection.object_id

  connection.finish
  connection.start
end

#user_agent ⇒ Object 



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/rubygems/request.rb', line 254

def user_agent
  ua = "RubyGems/#{Gem::VERSION} #{Gem::Platform.local}"

  ruby_version = RUBY_VERSION
  ruby_version += 'dev' if RUBY_PATCHLEVEL == -1

  ua << " Ruby/#{ruby_version} (#{RUBY_RELEASE_DATE}"
  if RUBY_PATCHLEVEL >= 0 then
    ua << " patchlevel #{RUBY_PATCHLEVEL}"
  elsif defined?(RUBY_REVISION) then
    ua << " revision #{RUBY_REVISION}"
  end
  ua << ")"

  ua << " #{RUBY_ENGINE}" if defined?(RUBY_ENGINE) and RUBY_ENGINE != 'ruby'

  ua
end