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, 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.



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/rubygems/remote_fetcher.rb', line 67

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

  Socket.do_not_reverse_lookup = true

  @proxy = proxy

  @dns = dns
end

Class Method Details

.fetcher ⇒ Object

Cached RemoteFetcher instance.



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

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

.fetcher=(fetcher) ⇒ Object 



173
174
175
 
# File 'lib/rubygems/test_utilities.rb', line 173

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

Instance Method Details

#api_endpoint(uri) ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/rubygems/remote_fetcher.rb', line 84

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 "#{uri.scheme}://#{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.



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/rubygems/remote_fetcher.rb', line 285

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.flock(File::LOCK_EX)
        io.write data
      end
    end

    data
  end
end

#correct_for_windows_path(path) ⇒ Object 



313
314
315
316
317
318
319
 
# File 'lib/rubygems/remote_fetcher.rb', line 313

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.



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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/rubygems/remote_fetcher.rb', line 119

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]$/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 = Gem::UriFormatter.new(source_path).unescape

    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



104
105
106
107
108
109
110
111
112
 
# File 'lib/rubygems/remote_fetcher.rb', line 104

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

  return if found.empty?

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

  download spec, source.uri.to_s
end

#fetch_file(uri, *_) ⇒ Object

File Fetcher. Dispatched by fetch_path. Use it instead.



214
215
216
 
# File 'lib/rubygems/remote_fetcher.rb', line 214

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.



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

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.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/rubygems/remote_fetcher.rb', line 249

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.



307
308
309
310
311
 
# File 'lib/rubygems/remote_fetcher.rb', line 307

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

  response['content-length'].to_i
end

#https?(uri) ⇒ Boolean

Returns:

  • (Boolean) 


334
335
336
 
# File 'lib/rubygems/remote_fetcher.rb', line 334

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

#request(uri, request_class, last_modified = nil) ⇒ 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.



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

def request(uri, request_class, last_modified = nil)
  request = Gem::Request.new uri, request_class, last_modified, @proxy

  request.fetch do |req|
    yield req if block_given?
  end
end