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
Class Method Summary (collapse)
-
+ (Object) fetcher
Cached RemoteFetcher instance.
- + (Object) fetcher=(fetcher)
Instance Method Summary (collapse)
-
- (Object) connection_for(uri)
Creates or an HTTP connection based on uri, or retrieves an existing connection, using a proxy if needed.
-
- (Object) download(spec, source_uri, install_dir = Gem.dir)
Moves the gem spec from source_uri to the cache dir unless it is already there.
- - (Object) escape(str)
-
- (Object) fetch_path(uri, mtime = nil, head = false)
Downloads uri and returns it as a String.
-
- (Object) fetch_size(uri)
Returns the size of uri in bytes.
-
- (Object) get_proxy_from_env
Returns an HTTP proxy URI if one is set in the environment variables.
-
- (RemoteFetcher) initialize(proxy = nil)
constructor
Initialize a remote fetcher using the source URI and possible proxy information.
-
- (Object) normalize_uri(uri)
Normalize the URI by adding "http://" if it is missing.
-
- (Object) open_uri_or_path(uri, last_modified = nil, head = false, depth = 0)
Read the data from the (source based) URI, but if it is a file:// URI, read from the filesystem instead.
-
- (Object) request(uri, request_class, last_modified = nil) {|request| ... }
Performs a Net::HTTP request of type request_class on uri returning a Net::HTTP response object.
-
- (Object) reset(connection)
Resets HTTP connection connection.
- - (Object) unescape(str)
Methods included from UserInteraction
Methods included from DefaultUserInteraction
ui, #ui, #ui=, ui=, use_ui, #use_ui
Constructor Details
- (RemoteFetcher) initialize(proxy = nil)
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 |
# 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 end |
Class Method Details
+ (Object) fetcher
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 |
+ (Object) fetcher=(fetcher)
121 122 123 |
# File 'lib/rubygems/test_utilities.rb', line 121 def self.fetcher=(fetcher) @fetcher = fetcher end |
Instance Method Details
- (Object) connection_for(uri)
Creates or an HTTP connection based on uri, or retrieves an existing connection, using a proxy if needed.
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/rubygems/remote_fetcher.rb', line 236 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., uri) end |
- (Object) download(spec, source_uri, install_dir = Gem.dir)
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.
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 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 |
# File 'lib/rubygems/remote_fetcher.rb', line 79 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 = spec.file_name 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) : URI.escape(source_uri)) 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 = 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.(source_path) == File.(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 |
- (Object) escape(str)
196 197 198 199 |
# File 'lib/rubygems/remote_fetcher.rb', line 196 def escape(str) return unless str URI.escape(str) end |
- (Object) fetch_path(uri, mtime = nil, head = false)
Downloads uri and returns it as a String.
175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/rubygems/remote_fetcher.rb', line 175 def fetch_path(uri, mtime = nil, head = false) data = open_uri_or_path 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) rescue IOError, SocketError, SystemCallError => e raise FetchError.new("#{e.class}: #{e}", uri) end |
- (Object) fetch_size(uri)
Returns the size of uri in bytes.
190 191 192 193 194 |
# File 'lib/rubygems/remote_fetcher.rb', line 190 def fetch_size(uri) # TODO: phase this out response = fetch_path(uri, nil, true) response['content-length'].to_i end |
- (Object) get_proxy_from_env
Returns an HTTP proxy URI if one is set in the environment variables.
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/rubygems/remote_fetcher.rb', line 209 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 |
- (Object) normalize_uri(uri)
Normalize the URI by adding "http://" if it is missing.
228 229 230 |
# File 'lib/rubygems/remote_fetcher.rb', line 228 def normalize_uri(uri) (uri =~ /^(https?|ftp|file):/) ? uri : "http://#{uri}" end |
- (Object) open_uri_or_path(uri, last_modified = nil, head = false, depth = 0)
Read the data from the (source based) URI, but if it is a file:// URI, read from the filesystem instead.
269 270 271 272 273 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 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 |
# File 'lib/rubygems/remote_fetcher.rb', line 269 def open_uri_or_path(uri, last_modified = nil, head = false, depth = 0) # XXX MACRUBY a much faster / more stable downloader code path, using # Foundation instead of Net::HTTP framework 'Foundation' say "Fetching #{uri.to_s}" if Gem.configuration.really_verbose url = NSURL.URLWithString(uri.to_s) data = NSMutableData.dataWithContentsOfURL(url) if data.nil? raise Gem::RemoteFetcher::FetchError.new('error when fetching data', uri) end say "OK" if Gem.configuration.really_verbose data = String.new(data) data.force_encoding(Encoding::BINARY) return data raise "block is dead" if block_given? uri = URI.parse uri unless URI::Generic === uri # This check is redundant unless Gem::RemoteFetcher is likely # to be used directly, since the scheme is checked elsewhere. # - Daniel Berger unless ['http', 'https', 'file'].include?(uri.scheme) raise ArgumentError, 'uri scheme is invalid' end if uri.scheme == 'file' path = uri.path # Deal with leading slash on Windows paths if path[0].chr == '/' && path[1].chr =~ /[a-zA-Z]/ && path[2].chr == ':' path = path[1..-1] end return Gem.read_binary(path) end 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 open_uri_or_path(response['Location'], last_modified, head, depth + 1) else raise FetchError.new("bad response #{response.} #{response.code}", uri) end end |
- (Object) request(uri, request_class, last_modified = nil) {|request| ... }
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.
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 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 |
# File 'lib/rubygems/remote_fetcher.rb', line 327 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 ua = "RubyGems/#{Gem::VERSION} #{Gem::Platform.local}" ua << " Ruby/#{RUBY_VERSION} (#{RUBY_RELEASE_DATE}" ua << " patchlevel #{RUBY_PATCHLEVEL}" if defined? RUBY_PATCHLEVEL ua << ")" request.add_field 'User-Agent', ua 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.}" 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 |
- (Object) reset(connection)
Resets HTTP connection connection.
424 425 426 427 428 429 |
# File 'lib/rubygems/remote_fetcher.rb', line 424 def reset(connection) @requests.delete connection.object_id connection.finish connection.start end |
- (Object) unescape(str)
201 202 203 204 |
# File 'lib/rubygems/remote_fetcher.rb', line 201 def unescape(str) return unless str URI.unescape(str) end |