class hackedProjectWebDownloader in Hacked! 7.2

Base class for downloading remote versions of projects.

Hierarchy

• class \hackedProjectWebDownloader

File

includes/hackedProjectWebDownloader.inc, line 6

class hackedProjectWebDownloader {
  var $project;

  /**
   * Constructor, pass in the project this downloaded is expected to download.
   */
  function __construct(&$project) {
    $this->project = $project;
  }

  /**
   * Returns a temp directory to work in.
   *
   * @param $namespace
   *   The optional namespace of the temp directory, defaults to the classname.
   */
  function get_temp_directory($namespace = NULL) {
    if (is_null($namespace)) {
      $namespace = get_class($this);
    }
    $segments = array(
      file_directory_temp(),
      'hacked-cache-' . get_current_user(),
      $namespace,
    );
    $dir = implode('/', array_filter($segments));
    if (!file_prepare_directory($dir, FILE_CREATE_DIRECTORY) && !mkdir($dir, 0775, TRUE)) {
      watchdog('hacked', 'Failed to create temp directory: %dir', array(
        '%dir' => $dir,
      ), WATCHDOG_ERROR);
      return FALSE;
    }
    return $dir;
  }

  /**
   * Returns a directory to save the downloaded project into.
   */
  function get_destination() {
    $type = $this->project->project_type;
    $name = $this->project->name;
    $version = $this->project->existing_version;
    $dir = $this
      ->get_temp_directory() . "/{$type}/{$name}";

    // Build the destination folder tree if it doesn't already exists.
    if (!file_prepare_directory($dir, FILE_CREATE_DIRECTORY) && !mkdir($dir, 0775, TRUE)) {
      watchdog('hacked', 'Failed to create temp directory: %dir', array(
        '%dir' => $dir,
      ), WATCHDOG_ERROR);
      return FALSE;
    }
    return "{$dir}/{$version}";
  }

  /**
   * Returns the final destination of the unpacked project.
   */
  function get_final_destination() {
    $dir = $this
      ->get_destination();
    $name = $this->project->name;
    $version = $this->project->existing_version;
    $type = $this->project->project_type;

    // More special handling for core:
    if ($type != 'core') {
      $module_dir = $dir . "/{$name}";
    }
    else {
      $module_dir = $dir . '/' . $name . '-' . $version;
    }
    return $module_dir;
  }

  /**
   * Download the remote files to the local filesystem.
   */
  function download() {
  }

  /**
   * Recursively delete all files and folders in the specified filepath, then
   * delete the containing folder.
   *
   * Note that this only deletes visible files with write permission.
   *
   * @param string $path
   *   A filepath relative to file_directory_path.
   */
  function remove_dir($path) {
    if (is_file($path) || is_link($path)) {
      unlink($path);
    }
    elseif (is_dir($path)) {
      $d = dir($path);
      while (($entry = $d
        ->read()) !== FALSE) {
        if ($entry == '.' || $entry == '..') {
          continue;
        }
        $entry_path = $path . '/' . $entry;
        $this
          ->remove_dir($entry_path);
      }
      $d
        ->close();
      rmdir($path);
    }
    else {
      watchdog('hacked', 'Unknown file type(%path) stat: %stat ', array(
        '%path' => $path,
        '%stat' => print_r(stat($path), 1),
      ), WATCHDOG_ERROR);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
hackedProjectWebDownloader::$project		property
hackedProjectWebDownloader::download		function	Download the remote files to the local filesystem.	2
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.