In Files

  • rubygems/remote_fetcher.rb
  • rubygems/test_utilities.rb

Class/Module Index [+]

Quicksearch

Gem::RemoteFetcher

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

Public Class Methods

fetcher() click to toggle source

Cached RemoteFetcher instance.

 
               # File rubygems/remote_fetcher.rb, line 50
def self.fetcher
  @fetcher ||= self.new Gem.configuration[:http_proxy]
end
            
fetcher=(fetcher) click to toggle source
 
               # File rubygems/test_utilities.rb, line 155
def self.fetcher=(fetcher)
  @fetcher = fetcher
end
            
new(proxy=nil, dns=Resolv::DNS.new) click to toggle source

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.
 
               # File rubygems/remote_fetcher.rb, line 68
def initialize(proxy=nil, dns=Resolv::DNS.new)
  require 'net/http'
  require 'stringio'
  require 'time'
  require 'uri'

  Socket.do_not_reverse_lookup = true

  @connections = {}
  @connections_mutex = Mutex.new
  @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
            

Public Instance Methods

add_rubygems_trusted_certs(store) click to toggle source
 
               # File rubygems/remote_fetcher.rb, line 448
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) click to toggle source

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

 
               # File rubygems/remote_fetcher.rb, line 97
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) click to toggle source

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

 
               # File rubygems/remote_fetcher.rb, line 298
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) click to toggle source
 
               # File rubygems/remote_fetcher.rb, line 423
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
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) click to toggle source

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

 
               # File rubygems/remote_fetcher.rb, line 392
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,
      unescape_auth_info(@proxy_uri.user),
      unescape_auth_info(@proxy_uri.password)
    ]
  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 FetchError.new(e.message, uri)
end
            
correct_for_windows_path(path) click to toggle source
 
               # File rubygems/remote_fetcher.rb, line 455
def correct_for_windows_path(path)
  if path[0].chr == '/' && path[1].chr =~ /[a-z]/ && path[2].chr == ':'
    path = path[1..-1]
  else
    path
  end
end
            
download(spec, source_uri, install_dir = Gem.dir) click to toggle source

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.

 
               # File rubygems/remote_fetcher.rb, line 132
def download(spec, source_uri, install_dir = Gem.dir)
  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]$/

  # 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) click to toggle source

Given a name and requirement, downloads this gem into cache and returns the filename. Returns nil if the gem cannot be located.

 
               # File rubygems/remote_fetcher.rb, line 117
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) click to toggle source
 
               # File rubygems/remote_fetcher.rb, line 333
def escape(str)
  return unless str
  @uri_parser ||= uri_escaper
  @uri_parser.escape str
end
            
escape_auth_info(str) click to toggle source
 
               # File rubygems/remote_fetcher.rb, line 325
def escape_auth_info(str)
  str && CGI.escape(str)
end
            
fetch_file(uri, *_) click to toggle source

File Fetcher. Dispatched by fetch_path. Use it instead.

 
               # File rubygems/remote_fetcher.rb, line 227
def fetch_file uri, *_
  Gem.read_binary correct_for_windows_path uri.path
end
            
fetch_http(uri, last_modified = nil, head = false, depth = 0) click to toggle source

HTTP Fetcher. Dispatched by fetch_path. Use it instead.

 
               # File rubygems/remote_fetcher.rb, line 234
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
            
Also aliased as: fetch_https
fetch_https(uri, last_modified = nil, head = false, depth = 0) click to toggle source
Alias for: fetch_http
fetch_path(uri, mtime = nil, head = false) click to toggle source

Downloads uri and returns it as a String.

 
               # File rubygems/remote_fetcher.rb, line 262
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) click to toggle source

Returns the size of uri in bytes.

 
               # File rubygems/remote_fetcher.rb, line 319
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() click to toggle source

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

 
               # File rubygems/remote_fetcher.rb, line 354
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() click to toggle source

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

 
               # File rubygems/remote_fetcher.rb, line 365
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_auth_info(ENV['http_proxy_user'] || ENV['HTTP_PROXY_USER'])
    uri.password = escape_auth_info(ENV['http_proxy_pass'] || ENV['HTTP_PROXY_PASS'])
  end

  uri
end
            
https?(uri) click to toggle source
 
               # File rubygems/remote_fetcher.rb, line 595
def https?(uri)
  uri.scheme.downcase == 'https'
end
            
no_proxy?(host) click to toggle source
 
               # File rubygems/remote_fetcher.rb, line 463
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) click to toggle source

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

 
               # File rubygems/remote_fetcher.rb, line 384
def normalize_uri(uri)
  (uri =~ /^(https?|ftp|file):/) ? uri : "http://#{uri}"
end
            
request(uri, request_class, last_modified = nil) click to toggle source

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.

 
               # File rubygems/remote_fetcher.rb, line 477
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) click to toggle source

Resets HTTP connection connection.

 
               # File rubygems/remote_fetcher.rb, line 569
def reset(connection)
  @requests.delete connection.object_id

  connection.finish
  connection.start
end
            
unescape(str) click to toggle source
 
               # File rubygems/remote_fetcher.rb, line 339
def unescape(str)
  return unless str
  @uri_parser ||= uri_escaper
  @uri_parser.unescape str
end
            
unescape_auth_info(str) click to toggle source
 
               # File rubygems/remote_fetcher.rb, line 329
def unescape_auth_info(str)
  str && CGI.unescape(str)
end
            
uri_escaper() click to toggle source
 
               # File rubygems/remote_fetcher.rb, line 345
def uri_escaper
  URI::Parser.new
rescue NameError
  URI
end
            
user_agent() click to toggle source
 
               # File rubygems/remote_fetcher.rb, line 576
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