Class: Gem::RemoteFetcher
- Inherits:
-
Object
- Object
- Gem::RemoteFetcher
- Includes:
- UserInteraction
- Defined in:
- lib/rubygems/remote_fetcher.rb,
lib/rubygems/test_utilities.rb
Overview
:stopdoc:
Defined Under Namespace
Classes: FetchError, UnknownHostError
Instance Attribute Summary collapse
-
#headers ⇒ Object
Returns the value of attribute headers.
Class Method Summary collapse
-
.fetcher ⇒ Object
Cached RemoteFetcher instance.
- .fetcher=(fetcher) ⇒ Object
Instance Method Summary collapse
-
#api_endpoint(uri) ⇒ Object
Given a source at
uri
, calculate what hostname to actually connect to query the data for it. -
#cache_update_path(uri, path = nil, update = true) ⇒ Object
Downloads
uri
topath
if necessary. - #close_all ⇒ Object
- #correct_for_windows_path(path) ⇒ Object
-
#download(spec, source_uri, install_dir = Gem.dir) ⇒ Object
Moves the gem
spec
fromsource_uri
to the cache dir unless it is already there. -
#download_to_cache(dependency) ⇒ Object
Given a name and requirement, downloads this gem into cache and returns the filename.
-
#fetch_file(uri, *_) ⇒ Object
File Fetcher.
-
#fetch_http(uri, last_modified = nil, head = false, depth = 0) ⇒ Object
(also: #fetch_https)
HTTP Fetcher.
-
#fetch_path(uri, mtime = nil, head = false) ⇒ Object
Downloads
uri
and returns it as a String. - #fetch_s3(uri, mtime = nil, head = false) ⇒ Object
-
#fetch_size(uri) ⇒ Object
Returns the size of
uri
in bytes. - #https?(uri) ⇒ Boolean
-
#initialize(proxy = nil, dns = Resolv::DNS.new, headers = {}) ⇒ RemoteFetcher
constructor
Initialize a remote fetcher using the source URI and possible proxy information.
-
#request(uri, request_class, last_modified = nil) ⇒ Object
Performs a Net::HTTP request of type
request_class
onuri
returning a Net::HTTP response object.
Methods included from UserInteraction
#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction, #verbose
Methods included from DefaultUserInteraction
ui, #ui, ui=, #ui=, use_ui, #use_ui
Constructor Details
#initialize(proxy = nil, dns = Resolv::DNS.new, headers = {}) ⇒ 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.
headers
: A set of additional HTTP headers to be sent to the server when
fetching the gem.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/rubygems/remote_fetcher.rb', line 74 def initialize(proxy=nil, dns=Resolv::DNS.new, headers={}) require 'net/http' require 'stringio' require 'time' require 'uri' Socket.do_not_reverse_lookup = true @proxy = proxy @pools = {} @pool_lock = Mutex.new @cert_files = Gem::Request.get_cert_files @dns = dns @headers = headers end |
Instance Attribute Details
#headers ⇒ Object
Returns the value of attribute headers.
55 56 57 |
# File 'lib/rubygems/remote_fetcher.rb', line 55 def headers @headers end |
Class Method Details
.fetcher ⇒ Object
Cached RemoteFetcher instance.
51 52 53 |
# File 'lib/rubygems/remote_fetcher.rb', line 51 def self.fetcher @fetcher ||= self.new Gem.configuration[:http_proxy] end |
.fetcher=(fetcher) ⇒ Object
176 177 178 |
# File 'lib/rubygems/test_utilities.rb', line 176 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.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/rubygems/remote_fetcher.rb', line 95 def api_endpoint(uri) host = uri.host begin res = @dns.getresource "_rubygems._tcp.#{host}", Resolv::DNS::Resource::IN::SRV rescue Resolv::ResolvError => e verbose "Getting SRV record failed: #{e}" uri else target = res.target.to_s.strip if /\.#{Regexp.quote(host)}\z/ =~ target return URI.parse "#{uri.scheme}://#{target}#{uri.path}" end uri 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.
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/rubygems/remote_fetcher.rb', line 315 def cache_update_path uri, path = nil, update = true mtime = path && File.stat(path).mtime rescue nil data = fetch_path(uri, mtime) if data == nil # indicates the server returned 304 Not Modified return Gem.read_binary(path) end if update and path begin open(path, 'wb') do |io| io.flock(File::LOCK_EX) io.write data end rescue Errno::ENOLCK # NFS if Thread.main != Thread.current raise else open(path, 'wb') do |io| io.write data end end end end data end |
#close_all ⇒ Object
381 382 383 |
# File 'lib/rubygems/remote_fetcher.rb', line 381 def close_all @pools.each_value {|pool| pool.close_all} end |
#correct_for_windows_path(path) ⇒ Object
353 354 355 356 357 358 359 |
# File 'lib/rubygems/remote_fetcher.rb', line 353 def correct_for_windows_path(path) if path[0].chr == '/' && path[1].chr =~ /[a-z]/i && path[2].chr == ':' 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.
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 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/rubygems/remote_fetcher.rb', line 137 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 # It should also be considered that source_uri may already be # a valid URI with escaped characters. e.g. "{DESede}" is encoded # as "%7BDESede%7D". If this is escaped again the percentage # symbols will be escaped. unless source_uri.is_a?(URI::Generic) begin source_uri = URI.parse(source_uri) rescue source_uri = URI.parse(URI.const_defined?(:DEFAULT_PARSER) ? URI::DEFAULT_PARSER.escape(source_uri.to_s) : URI.escape(source_uri.to_s)) end 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', 's3' then unless File.exist? local_gem_path then begin verbose "Downloading gem #{gem_file_name}" 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" verbose "Failed, downloading gem #{alternate_name}" 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 verbose "Using local gem #{local_gem_path}" 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 verbose "Using local gem #{local_gem_path}" 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 encompassing effort. -erikh
122 123 124 125 126 127 128 129 130 |
# File 'lib/rubygems/remote_fetcher.rb', line 122 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.
236 237 238 |
# File 'lib/rubygems/remote_fetcher.rb', line 236 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.
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
# File 'lib/rubygems/remote_fetcher.rb', line 243 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 do |req| headers.each { |k,v| req.add_field(k,v) } end case response when Net::HTTPOK, Net::HTTPNotModified then response.uri = uri if response.respond_to? :uri 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.} #{response.code}", uri) end end |
#fetch_path(uri, mtime = nil, head = false) ⇒ Object
Downloads uri
and returns it as a String.
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 |
# File 'lib/rubygems/remote_fetcher.rb', line 274 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. =~ /getaddrinfo/ raise UnknownHostError.new('no such name', uri.to_s) else raise FetchError.new("#{e.class}: #{e}", uri.to_s) end end |
#fetch_s3(uri, mtime = nil, head = false) ⇒ Object
306 307 308 309 |
# File 'lib/rubygems/remote_fetcher.rb', line 306 def fetch_s3(uri, mtime = nil, head = false) public_uri = sign_s3_url(uri) fetch_https public_uri, mtime, head end |
#fetch_size(uri) ⇒ Object
Returns the size of uri
in bytes.
347 348 349 350 351 |
# File 'lib/rubygems/remote_fetcher.rb', line 347 def fetch_size(uri) # TODO: phase this out response = fetch_path(uri, nil, true) response['content-length'].to_i end |
#https?(uri) ⇒ Boolean
377 378 379 |
# File 'lib/rubygems/remote_fetcher.rb', line 377 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.
366 367 368 369 370 371 372 373 374 375 |
# File 'lib/rubygems/remote_fetcher.rb', line 366 def request(uri, request_class, last_modified = nil) proxy = proxy_for @proxy, uri pool = pools_for(proxy).pool_for uri request = Gem::Request.new uri, request_class, last_modified, pool request.fetch do |req| yield req if block_given? end end |