Class: CurlDownloadStrategy

Inherits:
AbstractFileDownloadStrategy show all
Includes:
Utils::Curl
Defined in:
download_strategy.rb

Overview

Strategy for downloading files using curl.

Instance Attribute Summary collapse

Attributes inherited from AbstractDownloadStrategy

#cache, #cached_location, #source_modified_time, #url

Instance Method Summary collapse

Methods included from Utils::Curl

curl, curl_args, curl_check_http_content, curl_download, curl_executable, curl_http_content_headers_and_checksum, curl_output, curl_with_workarounds, http_status_ok?, parse_headers, url_protected_by_cloudflare?, url_protected_by_incapsula?

Methods inherited from AbstractFileDownloadStrategy

#basename, #cached_location, #symlink_location, #temporary_path

Methods inherited from AbstractDownloadStrategy

#basename, #quiet?, #shutup!, #stage

Methods included from Context

current, current=, #debug?, #quiet?, #verbose?, #with_context

Constructor Details

#initialize(url, name, version, **meta) ⇒ CurlDownloadStrategy

Returns a new instance of CurlDownloadStrategy.



370
371
372
373
# File 'download_strategy.rb', line 370

def initialize(url, name, version, **meta)
  super
  @mirrors = meta.fetch(:mirrors, [])
end

Instance Attribute Details

#mirrorsObject (readonly)



368
369
370
# File 'download_strategy.rb', line 368

def mirrors
  @mirrors
end

Instance Method Details

#clear_cacheObject



433
434
435
436
# File 'download_strategy.rb', line 433

def clear_cache
  super
  rm_rf(temporary_path)
end

#fetch(timeout: nil) ⇒ Object

Download and cache the file at AbstractFileDownloadStrategy#cached_location.



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
# File 'download_strategy.rb', line 378

def fetch(timeout: nil)
  end_time = Time.now + timeout if timeout

  download_lock = LockFile.new(temporary_path.basename)
  download_lock.lock

  urls = [url, *mirrors]

  begin
    url = urls.shift

    ohai "Downloading #{url}"

    resolved_url, _, url_time, _, is_redirection =
      resolve_url_basename_time_file_size(url, timeout: end_time&.remaining!)
    # Authorization is no longer valid after redirects
    meta[:headers]&.delete_if { |header| header.first&.start_with?("Authorization") } if is_redirection

    fresh = if cached_location.exist? && url_time
      url_time <= cached_location.mtime
    elsif version.respond_to?(:latest?)
      !version.latest?
    else
      true
    end

    if cached_location.exist? && fresh
      puts "Already downloaded: #{cached_location}"
    else
      begin
        _fetch(url: url, resolved_url: resolved_url, timeout: end_time&.remaining!)
      rescue ErrorDuringExecution
        raise CurlDownloadStrategyError, url
      end
      ignore_interrupts do
        cached_location.dirname.mkpath
        temporary_path.rename(cached_location)
        symlink_location.dirname.mkpath
      end
    end

    FileUtils.ln_s cached_location.relative_path_from(symlink_location.dirname), symlink_location, force: true
  rescue CurlDownloadStrategyError
    raise if urls.empty?

    puts "Trying a mirror..."
    retry
  rescue Timeout::Error => e
    raise Timeout::Error, "Timed out downloading #{self.url}: #{e}"
  end
ensure
  download_lock&.unlock
  download_lock&.path&.unlink
end

#resolved_time_file_size(timeout: nil) ⇒ Object



438
439
440
441
# File 'download_strategy.rb', line 438

def resolved_time_file_size(timeout: nil)
  _, _, time, file_size = resolve_url_basename_time_file_size(url, timeout: timeout)
  [time, file_size]
end