class hackedProjectWebFilesDownloader in Hacked! 8.2

Downloads a project using a standard Drupal method.

Hierarchy

• class \Drupal\hacked\hackedProjectWebDownloader uses StringTranslationTrait
  • class \Drupal\hacked\hackedProjectWebFilesDownloader

File

src/hackedProjectWebFilesDownloader.php, line 12

Namespace

Drupal\hacked

class hackedProjectWebFilesDownloader extends hackedProjectWebDownloader {
  function download_link() {
    if (!empty($this->project->project_info['releases'][$this->project->existing_version])) {
      $this_release = $this->project->project_info['releases'][$this->project->existing_version];
      return $this_release['download_link'];
    }
  }
  function download() {
    $dir = $this
      ->get_destination();
    if (!($release_url = $this
      ->download_link())) {
      return FALSE;
    }

    // If our directory already exists, we can just return the path to this cached version
    if (file_exists($dir) && count(hacked_file_scan_directory($dir, '/.*/', [
      '.',
      '..',
      'CVS',
      '.svn',
      '.git',
    ]))) {
      return $dir;
    }

    // Build the destination folder tree if it doesn't already exists.
    if (!\Drupal::service('file_system')
      ->prepareDirectory($dir, FileSystemInterface::CREATE_DIRECTORY) && !mkdir($dir, 0775, TRUE)) {
      $message = $this
        ->t('Failed to create temp directory: %dir', [
        '%dir' => $dir,
      ]);
      \Drupal::logger('hacked')
        ->error($message
        ->render());
      return FALSE;
    }
    if (!($local_file = $this
      ->file_get($release_url))) {
      $message = $this
        ->t('Could not download the project: @name from URL: @url', [
        '@name' => $this->project
          ->title(),
        '@url' => $release_url,
      ]);
      \Drupal::logger('hacked')
        ->error($message
        ->render());
      return FALSE;
    }
    try {
      $this
        ->archive_extract($local_file, $dir);
    } catch (Exception $e) {
      $message = $this
        ->t('Could not extract the project: @name. Error was: !error', [
        '@name' => $this->project
          ->title(),
        '!error' => $e
          ->getMessage(),
      ]);
      \Drupal::logger('hacked')
        ->error($message
        ->render());
      return FALSE;
    }
    return TRUE;
  }

  /**
   * Copies a file from $url to the temporary directory for updates.
   *
   * If the file has already been downloaded, returns the the local path.
   *
   * @param $url
   *   The URL of the file on the server.
   *
   * @return string
   *   Path to local file.
   */
  function file_get($url) {
    $parsed_url = parse_url($url);
    $remote_schemes = [
      'http',
      'https',
      'ftp',
      'ftps',
      'smb',
      'nfs',
    ];
    if (!in_array($parsed_url['scheme'], $remote_schemes)) {

      // This is a local file, just return the path.
      return \Drupal::service('file_system')
        ->realpath($url);
    }

    // Check the cache and download the file if needed.
    $cache_directory = 'temporary://hacked-cache';
    $local = $cache_directory . '/' . basename($parsed_url['path']);
    if (!file_exists($cache_directory)) {
      mkdir($cache_directory);
    }
    return system_retrieve_file($url, $local, FALSE, FileSystemInterface::EXISTS_REPLACE);
  }

  /**
   * Unpack a downloaded archive file.
   *
   * @param string $file
   *   The filename of the archive you wish to extract.
   * @param string $directory
   *   The directory you wish to extract the archive into.
   * @return Archiver
   *   The Archiver object used to extract the archive.
   * @throws Exception on failure.
   */
  function archive_extract($file, $directory) {
    $archiver = \Drupal::service('plugin.manager.archiver')
      ->getInstance([
      'filepath' => $file,
    ]);
    if (!$archiver) {
      throw new Exception(t('Cannot extract %file, not a valid archive.', [
        '%file' => $file,
      ]));
    }

    // Remove the directory if it exists, otherwise it might contain a mixture of
    // old files mixed with the new files (e.g. in cases where files were removed
    // from a later release).
    $files = $archiver
      ->listContents();

    // Unfortunately, we can only use the directory name for this. :(
    $project = mb_substr($files[0], 0, -1);
    $extract_location = $directory . '/' . $project;
    if (file_exists($extract_location)) {
      \Drupal::service('file_system')
        ->deleteRecursive($extract_location);
    }
    $archiver
      ->extract($directory);
    return $archiver;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
hackedProjectWebDownloader::$project		property
hackedProjectWebDownloader::get_destination		function	Returns a directory to save the downloaded project into.
hackedProjectWebDownloader::get_final_destination		function	Returns the final destination of the unpacked project.	1
hackedProjectWebDownloader::get_temp_directory		function	Returns a temp directory to work in.
hackedProjectWebDownloader::remove_dir		function	Recursively delete all files and folders in the specified filepath, then delete the containing folder.
hackedProjectWebDownloader::__construct		function	Constructor, pass in the project this downloaded is expected to download.
hackedProjectWebFilesDownloader::archive_extract		function	Unpack a downloaded archive file.
hackedProjectWebFilesDownloader::download		function	Download the remote files to the local filesystem. Overrides hackedProjectWebDownloader::download
hackedProjectWebFilesDownloader::download_link		function
hackedProjectWebFilesDownloader::file_get		function	Copies a file from $url to the temporary directory for updates.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.