Class: Gem::RemoteFetcher

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

Overview

:stopdoc:

Defined Under Namespace

Classes: FetchError

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/rubygems/remote_fetcher.rb', line 55

def initialize(proxy = nil)
  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
end

Class Method Details

.fetcher ⇒ Object

Cached RemoteFetcher instance.



40
41
42
 
# File 'lib/rubygems/remote_fetcher.rb', line 40

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

.fetcher=(fetcher) ⇒ Object 



132
133
134
 
# File 'lib/rubygems/test_utilities.rb', line 132

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

Instance Method Details

#connection_for(uri) ⇒ Object

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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/rubygems/remote_fetcher.rb', line 299

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

  if @proxy_uri 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 uri.scheme == 'https' and not connection.started? then
    require 'net/https'
    connection.use_ssl = true
    connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
  end

  connection.start unless connection.started?

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

#correct_for_windows_path(path) ⇒ Object 



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

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.



98
99
100
101
102
103
104
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
 
# File 'lib/rubygems/remote_fetcher.rb', line 98

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

  if File.writable?(install_dir)
    cache_dir = File.join install_dir, "cache"
  else
    cache_dir = 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

  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}"

        gem = self.fetch_path remote_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}"

        gem = self.fetch_path remote_gem_path
      end

      File.open local_gem_path, 'wb' do |fp|
        fp.write gem
      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.expand_path(source_path) == File.expand_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 Gem::InstallError, "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



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/rubygems/remote_fetcher.rb', line 82

def download_to_cache dependency
  found = Gem::SpecFetcher.fetcher.fetch dependency, true, true,
                                         dependency.prerelease?

  return if found.empty?

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

  download spec, source_uri
end

#escape(str) ⇒ Object 



251
252
253
254
255
 
# File 'lib/rubygems/remote_fetcher.rb', line 251

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.



194
195
196
 
# File 'lib/rubygems/remote_fetcher.rb', line 194

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.



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/rubygems/remote_fetcher.rb', line 201

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']
    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.



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/rubygems/remote_fetcher.rb', line 224

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

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

  data = send "fetch_#{uri.scheme}", uri, mtime, head
  data = Gem.gunzip data if data and not head and uri.to_s =~ /gz$/
  data
rescue FetchError
  raise
rescue Timeout::Error
  raise FetchError.new('timed out', uri.to_s)
rescue IOError, SocketError, SystemCallError => e
  raise FetchError.new("#{e.class}: #{e}", uri.to_s)
end

#fetch_size(uri) ⇒ Object

Returns the size of uri in bytes.



245
246
247
248
249
 
# File 'lib/rubygems/remote_fetcher.rb', line 245

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

  response['content-length'].to_i
end

#get_proxy_from_env ⇒ Object

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/rubygems/remote_fetcher.rb', line 272

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

#normalize_uri(uri) ⇒ Object

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



291
292
293
 
# File 'lib/rubygems/remote_fetcher.rb', line 291

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

#open_uri_or_path(uri, last_modified = nil, head = false, depth = 0) ⇒ Object

Read the data from the (source based) URI, but if it is a file:// URI, read from the filesystem instead.



340
341
342
343
 
# File 'lib/rubygems/remote_fetcher.rb', line 340

def open_uri_or_path(uri, last_modified = nil, head = false, depth = 0)
  raise "NO: Use fetch_path instead"
  # TODO: deprecate for fetch_path
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:



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/rubygems/remote_fetcher.rb', line 350

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.



442
443
444
445
446
447
 
# File 'lib/rubygems/remote_fetcher.rb', line 442

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

  connection.finish
  connection.start
end

#unescape(str) ⇒ Object 



257
258
259
260
261
 
# File 'lib/rubygems/remote_fetcher.rb', line 257

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

#uri_escaper ⇒ Object 



263
264
265
266
267
 
# File 'lib/rubygems/remote_fetcher.rb', line 263

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

#user_agent ⇒ Object 



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/rubygems/remote_fetcher.rb', line 449

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