class hackedProjectWebDevDownloader in Hacked! 8.2

Downloads a development snapshot of a project using Git.

View source

class hackedProjectWebDevDownloader extends hackedProjectWebDownloader {

  /**
   * Get download information for the dev release.
   *
   * @return array
   *   'module'    => The name of the project.
   *   'giturl'    => The upstream URL of the project.
   *   'branch'    => The development branch the snapshot was taken from.
   *   'timestamp' => When the project was originally downloaded.
   */
  function download_link() {
    $info = array();
    $project =& $this->project->project_info;

    // Get the branch we're on.
    $release = strtok($project['existing_version'], '-') . '-' . $project['existing_major'] . '.x-dev';
    $branch = $project['releases'][$release]['tag'];

    // Assign some information depending on the project type.
    if ($project['project_type'] == 'core') {

      // Special handling for core.
      $info['module'] = 'drupal';
    }
    else {

      // Contrib.
      $info['module'] = $project['name'];
    }

    // Assign all of the other information.
    $info['giturl'] = 'https://git.drupal.org/project/' . $project['name'] . '.git';
    $info['branch'] = $branch;
    $info['timestamp'] = $project['datestamp'];

    // Return it.
    return $info;
  }

  /**
   * Download the version of the project to compare.
   *
   * @return boolean
   *   TRUE if the download was successful; FALSE otherwise.
   */
  function download() {

    // Get detailed information about the download.
    $destination = $this
      ->get_destination();
    $info = $this
      ->download_link();
    $giturl = $info['giturl'];
    $branch = $info['branch'];
    $module = $info['module'];
    $timestamp = $info['timestamp'];

    // Return the path if the project version has already been downloaded to
    // the cache.
    if (file_exists($destination)) {
      return $destination;
    }

    // Clone the project repository and check out the appropriate branch.
    try {
      $this
        ->git_clone($giturl, $destination, $branch);
    } catch (Exception $e) {
      \Drupal::logger('hacked')
        ->error($e
        ->getMessage());
      return FALSE;
    }

    // Attempt to checkout the last commit before timestamp on the local version.
    try {
      $this
        ->git_checkout($destination, $branch, $timestamp);
    } catch (Exception $e) {
      \Drupal::logger('hacked')
        ->error($e
        ->getMessage());
      return FALSE;
    }
    return TRUE;
  }

  /**
   * Clones a git repository in a temporary directory.
   *
   * @param $giturl
   *   URL of the project.
   * @param $path
   *   The location in which to place the checkout.
   * @param $branch
   *   The branch to check out.
   * @throws Exception on failure.
   */
  function git_clone($giturl, $path, $branch) {

    // Get the Git command and location information.
    $git_cmd = $this
      ->git_get_command();
    $dirname = dirname($path);
    $basename = basename($path);

    // Prepare the download location.
    \Drupal::service('file_system')
      ->prepareDirectory($dirname, FileSystemInterface::CREATE_DIRECTORY);
    \Drupal::service('file_system')
      ->prepareDirectory($path, FileSystemInterface::CREATE_DIRECTORY);

    // Perform the clone operation, and leave us in the appropriate branch.
    exec("cd {$dirname}; {$git_cmd} clone --branch {$branch} {$giturl} {$basename}", $output_lines, $return_value);

    // Throw an exception if it didn't work.
    if ($return_value != 0) {
      throw new Exception($this
        ->t('Could not clone project %project into path %path at branch %branch.', [
        '%project' => $this->project
          ->title(),
        '%path' => $path,
        '%branch' => $branch,
      ]));
    }
  }

  /**
   * Checks out the last Git commit prior to the project's timestamp.
   *
   * @param $path
   *   The path of the Git repository where the checkout should happen.
   * @param $branch
   *   The desired branch within the repository containing the commit.
   * @param $timestamp
   *   The UNIX timestamp for the downloaded project.
   * @throws Exception on failure.
   */
  function git_checkout($path, $branch, $timestamp) {

    // Fetch the Git command.
    $git_cmd = $this
      ->git_get_command();

    // Point the working tree at the commit just before the timestamp.
    // This takes us to the point in time when the local project was downloaded.
    exec("cd {$path}; {$git_cmd} checkout \$({$git_cmd} rev-list -n 1 --before='{$timestamp}' {$branch})", $output_lines, $return_value);

    // Throw an exception if it didn't work.
    if ($return_value != 0) {
      throw new Exception(t('Could not check out latest commit before %timestamp in Git repository %repository.', [
        '%timestamp' => $timestamp,
        '%repository' => $path,
      ]));
    }
  }

  /**
   * Helper function to return the command to run git on the command line.
   *
   * @return string
   *   The command with which to run Git.
   */
  function git_get_command() {
    $command = \Drupal::config('hacked.settings')
      ->get('git_cmd');
    return is_null($command) ? 'git' : $command;
  }

  /**
   * Returns the final destination of the unpacked project.
   *
   * @return string
   *   The unpacked project's path.
   */
  function get_final_destination() {

    // Simply return the original destination as Git's cloning already provides
    // an unpacked project.
    return $this
      ->get_destination();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
hackedProjectWebDevDownloader::download		function	Download the version of the project to compare. Overrides hackedProjectWebDownloader::download
hackedProjectWebDevDownloader::download_link		function	Get download information for the dev release.
hackedProjectWebDevDownloader::get_final_destination		function	Returns the final destination of the unpacked project. Overrides hackedProjectWebDownloader::get_final_destination
hackedProjectWebDevDownloader::git_checkout		function	Checks out the last Git commit prior to the project's timestamp.
hackedProjectWebDevDownloader::git_clone		function	Clones a git repository in a temporary directory.
hackedProjectWebDevDownloader::git_get_command		function	Helper function to return the command to run git on the command line.
hackedProjectWebDownloader::$project		property
hackedProjectWebDownloader::get_destination		function	Returns a directory to save the downloaded project into.
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.
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.

You are here

class hackedProjectWebDevDownloader in Hacked! 8.2

Hierarchy

File

Namespace

Members

API Navigation