Class: Gem::RemoteFetcher

Inherits:
Object
  • Object
show all
Includes:
UserInteraction
Defined in:
lib/rubygems/test_utilities.rb,
lib/rubygems/remote_fetcher.rb

Overview

RemoteFetcher handles the details of fetching gems and gem information from a remote source.

Defined Under Namespace

Classes: FetchError, UnknownHostError

Class Method 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(proxy = nil, dns = Resolv::DNS.new) ⇒ RemoteFetcher

Initialize a remote fetcher using the source URI and possible proxy information.

proxy

  • [String]: explicit specification of proxy; overrides any environment

    variable setting

  • nil: respect environment variables (HTTP_PROXY, HTTP_PROXY_USER,

    HTTP_PROXY_PASS)

  • :no_proxy: ignore environment variables and _don’t_ use a proxy

dns: An object to use for DNS resolution of the API endpoint.

By default, use Resolv::DNS.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/rubygems/remote_fetcher.rb', line 66

def initialize(proxy=nil, dns=Resolv::DNS.new)
  require 'net/http'
  require 'stringio'
  require 'time'
  require 'uri'

  Socket.do_not_reverse_lookup = true

  @connections = {}
  @requests = Hash.new 0
  @proxy_uri =
    case proxy
    when :no_proxy then nil
    when nil then get_proxy_from_env
    when URI::HTTP then proxy
    else URI.parse(proxy)
    end
  @user_agent = user_agent
  @env_no_proxy = get_no_proxy_from_env

  @dns = dns
end

Class Method Details

.fetcher ⇒ Object

Cached RemoteFetcher instance.



48
49
50
 
# File 'lib/rubygems/remote_fetcher.rb', line 48

def self.fetcher
  @fetcher ||= self.new Gem.configuration[:http_proxy]
end

.fetcher=(fetcher) ⇒ Object 



152
153
154
 
# File 'lib/rubygems/test_utilities.rb', line 152

def self.fetcher=(fetcher)
  @fetcher = fetcher
end

Instance Method Details

#add_rubygems_trusted_certs(store) ⇒ Object 



429
430
431
432
433
434
 
# File 'lib/rubygems/remote_fetcher.rb', line 429

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

#api_endpoint(uri) ⇒ Object

Given a source at uri, calculate what hostname to actually connect to query the data for it.



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/rubygems/remote_fetcher.rb', line 94

def api_endpoint(uri)
  host = uri.host

  begin
    res = @dns.getresource "_rubygems._tcp.#{host}",
                           Resolv::DNS::Resource::IN::SRV
  rescue Resolv::ResolvError
    uri
  else
    URI.parse "#{res.target}#{uri.path}"
  end
end

#cache_update_path(uri, path = nil, update = true) ⇒ Object

Downloads uri to path if necessary. If no path is given, it just passes the data.



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/rubygems/remote_fetcher.rb', line 297

def cache_update_path uri, path = nil, update = true
  mtime = path && File.stat(path).mtime rescue nil

  if mtime && Net::HTTPNotModified === fetch_path(uri, mtime, true)
    Gem.read_binary(path)
  else
    data = fetch_path(uri)

    if update and path then
      open(path, 'wb') do |io|
        io.write data
      end
    end

    data
  end
end

#configure_connection_for_https(connection) ⇒ Object 



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/rubygems/remote_fetcher.rb', line 410

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_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
end

#connection_for(uri) ⇒ Object

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



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/rubygems/remote_fetcher.rb', line 383

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,
      @proxy_uri.user,
      @proxy_uri.password
    ]
  end

  connection_id = [Thread.current.object_id, *net_http_args].join ':'
  @connections[connection_id] ||= Net::HTTP.new(*net_http_args)
  connection = @connections[connection_id]

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

  connection.start unless connection.started?

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

#correct_for_windows_path(path) ⇒ Object 



436
437
438
439
440
441
442
 
# File 'lib/rubygems/remote_fetcher.rb', line 436

def correct_for_windows_path(path)
  if path[0].chr == '/' && path[1].chr =~ /[a-z]/i && path[2].chr == ':'
    path = path[1..-1]
  else
    path
  end
end

#download(spec, source_uri, install_dir = Gem.dir) ⇒ Object

Moves the gem spec from source_uri to the cache dir unless it is already there. If the source_uri is local the gem cache dir copy is always replaced.



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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/rubygems/remote_fetcher.rb', line 129

def download(spec, source_uri, install_dir = Gem.dir)
  Gem.ensure_gem_subdirectories(install_dir) rescue nil

  cache_dir =
    if Dir.pwd == install_dir then # see fetch_command
      install_dir
    elsif File.writable? install_dir then
      File.join install_dir, "cache"
    else
      File.join Gem.user_dir, "cache"
    end

  gem_file_name = File.basename spec.cache_file
  local_gem_path = File.join cache_dir, gem_file_name

  FileUtils.mkdir_p cache_dir rescue nil unless File.exist? cache_dir

 # Always escape URI's to deal with potential spaces and such
  unless URI::Generic === source_uri
    source_uri = URI.parse(URI.const_defined?(:DEFAULT_PARSER) ?
                           URI::DEFAULT_PARSER.escape(source_uri.to_s) :
                           URI.escape(source_uri.to_s))
  end

  scheme = source_uri.scheme

  # URI.parse gets confused by MS Windows paths with forward slashes.
  scheme = nil if scheme =~ /^[a-z]$/i

  # REFACTOR: split this up and dispatch on scheme (eg download_http)
  # REFACTOR: be sure to clean up fake fetcher when you do this... cleaner
  case scheme
  when 'http', 'https' then
    unless File.exist? local_gem_path then
      begin
        say "Downloading gem #{gem_file_name}" if
          Gem.configuration.really_verbose

        remote_gem_path = source_uri + "gems/#{gem_file_name}"

        self.cache_update_path remote_gem_path, local_gem_path
      rescue Gem::RemoteFetcher::FetchError
        raise if spec.original_platform == spec.platform

        alternate_name = "#{spec.original_name}.gem"

        say "Failed, downloading gem #{alternate_name}" if
          Gem.configuration.really_verbose

        remote_gem_path = source_uri + "gems/#{alternate_name}"

        self.cache_update_path remote_gem_path, local_gem_path
      end
    end
  when 'file' then
    begin
      path = source_uri.path
      path = File.dirname(path) if File.extname(path) == '.gem'

      remote_gem_path = correct_for_windows_path(File.join(path, 'gems', gem_file_name))

      FileUtils.cp(remote_gem_path, local_gem_path)
    rescue Errno::EACCES
      local_gem_path = source_uri.to_s
    end

    say "Using local gem #{local_gem_path}" if
      Gem.configuration.really_verbose
  when nil then # TODO test for local overriding cache
    source_path = if Gem.win_platform? && source_uri.scheme &&
                     !source_uri.path.include?(':') then
                    "#{source_uri.scheme}:#{source_uri.path}"
                  else
                    source_uri.path
                  end

    source_path = unescape source_path

    begin
      FileUtils.cp source_path, local_gem_path unless
        File.identical?(source_path, local_gem_path)
    rescue Errno::EACCES
      local_gem_path = source_uri.to_s
    end

    say "Using local gem #{local_gem_path}" if
      Gem.configuration.really_verbose
  else
    raise ArgumentError, "unsupported URI scheme #{source_uri.scheme}"
  end

  local_gem_path
end

#download_to_cache(dependency) ⇒ Object

Given a name and requirement, downloads this gem into cache and returns the filename. Returns nil if the gem cannot be located. – Should probably be integrated with #download below, but that will be a larger, more emcompassing effort. -erikh



114
115
116
117
118
119
120
121
122
 
# File 'lib/rubygems/remote_fetcher.rb', line 114

def download_to_cache dependency
  found, _ = Gem::SpecFetcher.fetcher.spec_for_dependency dependency

  return if found.empty?

  spec, source = found.sort_by { |(s,_)| s.version }.last

  download spec, source.uri.to_s
end

#escape(str) ⇒ Object 



324
325
326
327
328
 
# File 'lib/rubygems/remote_fetcher.rb', line 324

def escape(str)
  return unless str
  @uri_parser ||= uri_escaper
  @uri_parser.escape str
end

#fetch_file(uri, *_) ⇒ Object

File Fetcher. Dispatched by fetch_path. Use it instead.



226
227
228
 
# File 'lib/rubygems/remote_fetcher.rb', line 226

def fetch_file uri, *_
  Gem.read_binary correct_for_windows_path uri.path
end

#fetch_http(uri, last_modified = nil, head = false, depth = 0) ⇒ Object Also known as: fetch_https

HTTP Fetcher. Dispatched by fetch_path. Use it instead.



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/rubygems/remote_fetcher.rb', line 233

def fetch_http uri, last_modified = nil, head = false, depth = 0
  fetch_type = head ? Net::HTTP::Head : Net::HTTP::Get
  response   = request uri, fetch_type, last_modified

  case response
  when Net::HTTPOK, Net::HTTPNotModified then
    head ? response : response.body
  when Net::HTTPMovedPermanently, Net::HTTPFound, Net::HTTPSeeOther,
       Net::HTTPTemporaryRedirect then
    raise FetchError.new('too many redirects', uri) if depth > 10

    location = URI.parse response['Location']

    if https?(uri) && !https?(location)
      raise FetchError.new("redirecting to non-https resource: #{location}", uri)
    end

    fetch_http(location, last_modified, head, depth + 1)
  else
    raise FetchError.new("bad response #{response.message} #{response.code}", uri)
  end
end

#fetch_path(uri, mtime = nil, head = false) ⇒ Object

Downloads uri and returns it as a String.



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/rubygems/remote_fetcher.rb', line 261

def fetch_path(uri, mtime = nil, head = false)
  uri = URI.parse uri unless URI::Generic === uri

  raise ArgumentError, "bad uri: #{uri}" unless uri

  unless uri.scheme
    raise ArgumentError, "uri scheme is invalid: #{uri.scheme.inspect}"
  end

  data = send "fetch_#{uri.scheme}", uri, mtime, head

  if data and !head and uri.to_s =~ /gz$/
    begin
      data = Gem.gunzip data
    rescue Zlib::GzipFile::Error
      raise FetchError.new("server did not return a valid file", uri.to_s)
    end
  end

  data
rescue FetchError
  raise
rescue Timeout::Error
  raise UnknownHostError.new('timed out', uri.to_s)
rescue IOError, SocketError, SystemCallError => e
  if e.message =~ /getaddrinfo/
    raise UnknownHostError.new('no such name', uri.to_s)
  else
    raise FetchError.new("#{e.class}: #{e}", uri.to_s)
  end
end

#fetch_size(uri) ⇒ Object

Returns the size of uri in bytes.



318
319
320
321
322
 
# File 'lib/rubygems/remote_fetcher.rb', line 318

def fetch_size(uri) # TODO: phase this out
  response = fetch_path(uri, nil, true)

  response['content-length'].to_i
end

#get_no_proxy_from_env ⇒ Object

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



345
346
347
348
349
350
351
 
# File 'lib/rubygems/remote_fetcher.rb', line 345

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 ⇒ Object

Returns an HTTP proxy URI if one is set in the environment variables.



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/rubygems/remote_fetcher.rb', line 356

def get_proxy_from_env
  env_proxy = ENV['http_proxy'] || ENV['HTTP_PROXY']

  return nil if env_proxy.nil? or env_proxy.empty?

  uri = URI.parse(normalize_uri(env_proxy))

  if uri and uri.user.nil? and uri.password.nil? then
    # Probably we have http_proxy_* variables?
    uri.user = escape(ENV['http_proxy_user'] || ENV['HTTP_PROXY_USER'])
    uri.password = escape(ENV['http_proxy_pass'] || ENV['HTTP_PROXY_PASS'])
  end

  uri
end

#https?(uri) ⇒ Boolean

Returns:

  • (Boolean) 


576
577
578
 
# File 'lib/rubygems/remote_fetcher.rb', line 576

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

#no_proxy?(host) ⇒ Boolean

Returns:

  • (Boolean) 


444
445
446
447
448
449
450
451
 
# File 'lib/rubygems/remote_fetcher.rb', line 444

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

#normalize_uri(uri) ⇒ Object

Normalize the URI by adding “http://” if it is missing.



375
376
377
 
# File 'lib/rubygems/remote_fetcher.rb', line 375

def normalize_uri(uri)
  (uri =~ /^(https?|ftp|file):/i) ? uri : "http://#{uri}"
end

#request(uri, request_class, last_modified = nil) {|request| ... } ⇒ Object

Performs a Net::HTTP request of type request_class on uri returning a Net::HTTP response object. request maintains a table of persistent connections to reduce connect overhead.

Yields:



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/rubygems/remote_fetcher.rb', line 458

def request(uri, request_class, last_modified = nil)
  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
    last_modified = last_modified.utc
    request.add_field 'If-Modified-Since', last_modified.rfc2822
  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 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 FetchError.new('too many connection resets', uri) if retried

    reset connection

    retried = true
    retry
  end

  response
end

#reset(connection) ⇒ Object

Resets HTTP connection connection.



550
551
552
553
554
555
 
# File 'lib/rubygems/remote_fetcher.rb', line 550

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

  connection.finish
  connection.start
end

#unescape(str) ⇒ Object 



330
331
332
333
334
 
# File 'lib/rubygems/remote_fetcher.rb', line 330

def unescape(str)
  return unless str
  @uri_parser ||= uri_escaper
  @uri_parser.unescape str
end

#uri_escaper ⇒ Object 



336
337
338
339
340
 
# File 'lib/rubygems/remote_fetcher.rb', line 336

def uri_escaper
  URI::Parser.new
rescue NameError
  URI
end

#user_agent ⇒ Object 



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/rubygems/remote_fetcher.rb', line 557

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