Club Drupal

<?php

// $Id: drush_make.download.inc,v 1.1.2.87 2010/09/06 15:54:23 dmitrig01 Exp $

function drush_make_download_factory($type, $name, $download, $download_location) {

  $function = 'drush_make_download_' . $type;

  if (function_exists($function)) {

    return $function($name, $download, $download_location);

  }

  else {

    return FALSE;

  }

}

function drush_make_download_cvs($name, $download, $download_location) {

  if (!empty($download['module'])) {

    if (drush_get_option('working-copy')) {

      if ($download['module'] == 'drupal') {

        $download['root'] = ":pserver:anonymous:anonymous@cvs.drupal.org:/cvs/drupal";

      }

      elseif (isset($_ENV['CVSROOT'])) {

        $download['root'] = trim($_ENV['CVSROOT']);

      }

      else {

        drush_log(dt('Please set the CVSROOT variable in your shell environment when using the --working-copy option.'), 'ok');

      }

    }

    // Fallback to anonymous @ cvs.drupal.org

    if (!isset($download['root'])) {

      $download['root'] = ":pserver:anonymous:anonymous@cvs.drupal.org:/cvs/drupal-contrib";

    }

    // Checkout or export the module. CVS can't use absolute paths for named

    // directories, so change into the directory just above the final

    // destination for the checkout. 

    $cd_to_directory = dirname($download_location);

    $destination_directory = basename($download_location);

    $command = 'cvs -d%s ' . (drush_get_option('working-copy') ? 'checkout' : 'export') . ' -d%s';

    $args = array($download['root'], $destination_directory);

    if (isset($download['revision'])) {

      $command .= ' -r %s';

      $args[] = $download['revision'];

    }

    if (isset($download['date'])) {

      $command .= ' -D %s';

      $args[] = $download['date'];

    }

    $args[] = $download['module'];

    $command .= ' %s';

    array_unshift($args, $command);

    array_unshift($args, dirname($download_location));

    if (call_user_func_array('drush_shell_cd_and_exec', $args)) {

       drush_log(dt('%project downloaded from %module.', array('%project' => $name, '%module' => $download['module'])), 'ok');

      return $download_location;

    }

  }

  else {

    $download['module'] = dt("unspecified module");

  }

  drush_make_error('DOWNLOAD_ERROR', dt('Unable to download %project from %root %module.', array('%project' => $name, '%root' => $download['root'], '%module' => $download['module'])));

  return FALSE;

}

function drush_make_download_file($name, $download, $download_location) {

  if ($filename = _drush_make_download_file($download)) {

    drush_log(dt('%project downloaded from %url.', array('%project' => $name, '%url' => $download['url'])), 'ok');

    return drush_make_download_file_unpack($filename, $download_location);

  }

  drush_make_error('DOWNLOAD_ERROR', dt('Unable to download %project from %url.', array('%project' => $name, '%url' => $download['url'])));

  return FALSE;

}

function _drush_make_download_file($download) {

  // Static variable to keep track of whether to use curl or wget.

  static $download_mechanism;

  $tmp_path = drush_make_tmp();

  $filename = FALSE;

  if (is_string($download)) {

    $download = array('url' => $download);

  }

  if (!isset($download['request_type'])) {

    $download['request_type'] = 'get';

  }

  if (!empty($download['url'])) {

    $url = $download['url'];

    if (drush_get_context('DRUSH_SIMULATE')) {

      $filename = t('file');

    }

    else {

      // For first try or if wget was detected already, try using wget 

      // for downloading.

      $success = FALSE;

      $download_path = $tmp_path . '/__download__';

      drush_make_mkdir($download_path);

      if (!isset($download_mechanism) || $download_mechanism == 'curl') {

        $header_file = $tmp_path . '/__header__';

        drush_shell_exec("ls %s", $download_path);

        $files = drush_shell_exec_output();

        if ($download['request_type'] == 'get' && drush_shell_cd_and_exec($download_path, 'curl -LOD %s %s', $header_file, $url)) {

          $download_mechanism = 'curl';

          $success = TRUE;

        }

        elseif ($download['request_type'] == 'post' && drush_shell_cd_and_exec($download_path, 'curl -d %s -LOD %s %s', $download['data'], $header_file, $url)) {

          $download_mechanism = 'curl';

          $success = TRUE;

        }

        drush_shell_exec("ls %s", $download_path);

        $files_new = drush_shell_exec_output();

        // Can't use list beacuse it's not guarenteed to be at offset 0.

        $diff = array_diff($files_new, $files);

        $filename = $tmp_path . '/__download__/' . array_shift($diff);

        // Determine the proper filename, or at least, the extension.

        $header = explode("\n", trim(str_replace("\r", '', file_get_contents($header_file))));

        $current_header = array();

        $headers = array();

        $first = TRUE;

        foreach ($header as $h) {

          if ($h == '') {

            $headers[] = $current_header;

            $current_header = array();

            $first = TRUE;

          }

          else {

            if (!$first) {

              list($name, $value) = explode(': ', $h, 2);

              $current_header[$name] = $value;

            }

            else {

              $first = FALSE;

            }

          }

        }

        if (!empty($current_header)) {

          $headers[] = $current_header;

        }

      }

      if (!isset($download_mechanism) || $download_mechanism == 'drush_make') {

        $retry = 5;

        $url = $download['url'];

        $filename = $download_path . '/__destination__';

        $request_type = strtoupper($download['request_type']);

        $data = (isset($download['data']) ? $download['data'] : '');

        $headers = array();

        while ($retry) {

          $result = drush_make_http_request($url, $filename, array(), $request_type, $data);

          switch ($result->code) {

            case 200: // OK

            case 304: // Not modified

              $retry = FALSE;

              break;

            case 301: // Moved permanently

            case 302: // Moved temporarily

            case 307: // Moved temporarily

              $retry--;

              if ($retry) {

                $url = $result->headers['Location'];

                $request_type = 'GET';

                $data = NULL;

              }

              break;

            default:

              // Oops, error.

              drush_make_error('BUILD_ERROR', $result->message);

              return;

          }

          $download_mechanism = 'drush_make';

          $headers[] = $result->headers;

          $success = TRUE;

        }

      }

      if (!$success) {

        return;

      }

      // Much more useful in reverse order.

      $headers = array_reverse($headers);

      $content_type = '';

      $file = '';

      foreach ($headers as $header) {

        if (isset($header['Location'])) {

          $file = basename($header['Location']);

          break;

        }

      }

      if (isset($headers[0]['Content-Disposition'])) {

        $parts = explode(';', $headers[0]['Content-Disposition']);

        foreach ($parts as $part) {

          list($name, $value) = explode('=', $part, 2);

          if ($inner_parts[0] == 'filename') {

            $file = $value;

            break;

          }

        }

      }

      if (isset($headers[0]['Content-Type'])) {

        // These still need finalizing.

        switch ($headers[0]['Content-Type']) {

          case 'application/zip':

            $content_type = 'zip';

            break;

          case 'application/x-gzip':

            $content_type = 'tar.gz';

            break;

          case 'application/x-tar':

            $content_type = 'tar';

            break;

        }

      }

      if (!$file) {

        $file = basename($url);

      }

      if ($content_type) {

        $file .= '.' . $content_type;

      }

      drush_shell_exec('mv %s %s', $filename, $tmp_path . '/' . $file);

      drush_shell_exec('rm -f %s', $tmp_path . '/__header__');

      drush_shell_exec('rm -rf %s', $tmp_path . '/__download__');

      return $tmp_path . '/' . $file;

    }

  }

  return FALSE;

}

function drush_make_download_file_unpack($filename, $download_location) {

  $extension = array_pop(explode('.', $filename));

  $gzip = FALSE;

  switch ($extension) {

    case 'gz':

    case 'tgz':

      // I'd like to just use tar -z, but apparently it breaks on windoze. Why do they always have to ruin everything?

      drush_make_download_file_unpack_gzip($filename, $download_location);

      break;

    case 'tar':

      drush_make_download_file_unpack_tar($filename, $download_location);

      break;

    case 'zip':

      drush_make_download_file_unpack_zip($filename, $download_location);

      break;

    default:

      drush_make_error('DOWNLOAD_ERROR', dt('Unable to unpack %file', array('%file' => $filename)));

  }

}

function drush_make_download_file_unpack_tar($filename, $download_location) {

  $tmp_path = drush_make_tmp();

  // Tarbomb detection.

  drush_shell_exec('tar -tf %s', $filename);

  $lines = drush_shell_exec_output();

  if (!$lines) {

    return FALSE;

  }

  $directory = drush_make_download_file_protect_bomb($lines);

  if (!$directory) {

    drush_shell_exec('tar -x -C %s -f %s', $download_location, $filename);

  }

  else {

    list($main_directory) = array_reverse(explode('/', $download_location));

    drush_make_mkdir($tmp_path . '/__unzip__');

    drush_shell_exec('tar -x -C %s -f %s', $tmp_path . '/__unzip__', $filename);

    if ($directory != $main_directory) {

      drush_shell_exec('mv %s %s', $tmp_path . '/__unzip__/' . $directory, $tmp_path . '/__unzip__/' . $main_directory);

    }

    drush_shell_exec('cp -Rf %s %s', $tmp_path . '/__unzip__/' . $main_directory, dirname($download_location));

    drush_shell_exec('rm -rf %s', $tmp_path . '/__unzip__');

  }

  // Remove the tarball.

  if (file_exists($filename)) {

    drush_shell_exec('rm %s', $filename);

  }

}

function drush_make_download_file_unpack_gzip($filename, $download_location) {

  // Find out where contents will end up. Retrieve last column of output using awk.

  drush_shell_exec("gzip --list %s | awk '{print $4;}'", $filename);

  $info = drush_shell_exec_output();

  if ($info) {

    $info = array_pop($info);

    $matches = array();

    preg_match('/[a-zA-Z0-9.\-_,]*.tar/', $info, $matches);

    if (isset($matches[0])) {

      $file = dirname($filename) . '/' . $matches[0];

      // Unzip it and then delete the tar file.

      drush_shell_exec('gzip -d %s', $filename);

      $filename = $file;

      return drush_make_download_file_unpack_tar($filename, $download_location);

    }

  }

  drush_make_error('PACKAGE_ERROR', dt('Could not retrieve package information for %filename.', array('%filename' => $filename)));

  return;

}

function drush_make_download_file_unpack_zip($filename, $download_location) {

  $tmp_path = drush_make_tmp();

  // Find the main directory in the zip file.

  drush_shell_exec("unzip -l %s", $filename);

  $info = drush_shell_exec_output();

  if ($info) {

    foreach ($info as $line) {

      $matches = array();

      preg_match('/^\s+[0-9]+\s+[0-9-]+\s+[0-9:]+\s+(.*)$/', $line, $matches);

      if (isset($matches[1])) {

        $lines[] = $matches[1];

      }

    }

    $directory = drush_make_download_file_protect_bomb($lines);

    if ($directory) {

      list($main_directory) = array_reverse(explode('/', $download_location));

      if ($main_directory == $directory) {

        // Directory names match up.

        drush_shell_exec("unzip %s -d %s", $filename, dirname($download_location));

      }

      else {

        // Directories don't match up. Use cp.

        drush_make_mkdir($tmp_path . '/__unzip__');

        drush_shell_exec('unzip %s -d %s', $filename, $tmp_path . '/__unzip__');

        if (file_exists($filename)) {

          drush_shell_exec('rm %s', $filename);

        }

        if (is_dir($tmp_path . '/__unzip__' . $directory . '/__MACOSX')) {

          drush_shell_exec('rm -rf %s', $tmp_path . '/__unzip__' . $directory . '/__MACOSX');

        }

        drush_shell_exec('mv %s %s', $tmp_path . '/__unzip__/' . $directory, $tmp_path . '/__unzip__/' . $main_directory);

        drush_shell_exec('cp -Rf %s %s', $tmp_path . '/__unzip__/' . $main_directory, dirname($download_location));

        drush_shell_exec('rm -rf %s', $tmp_path . '/__unzip__');

      }

    }

    else {

      // It's a bomb, so we can just unpack it right at its destination.

      drush_shell_exec("unzip %s -d %s", $filename, $download_location);

    }

    if (file_exists($filename)) {

      drush_shell_exec('rm %s', $filename);

    }

    if (is_dir($download_location . '/__MACOSX')) {

      drush_shell_exec('rm -rf %s', $download_location . '/__MACOSX');

    }

  }

  else {

    drush_make_error('PACKAGE_ERROR', dt('Could not retrieve package information for %filename.', array('%filename' => $filename)));

  }

  return;

}

function drush_make_download_file_protect_bomb($lines) {

  $directory = FALSE;

  foreach ($lines as $line) {

    if (strpos($line, '/') !== FALSE) {

      list($dir) = explode('/', $line);

      if (!$directory) {

        $directory = $dir;

      }

      elseif ($dir != $directory) {

        // More than one root-level item detected. We're not safe - BOMB!

        return FALSE;

      }

    }

  }

  if (!$directory) {

    // If we didn't come upon anything, that is to say, they were only

    // root-level files, it's a bomb.

    return FALSE;

  }

  return $directory;

}

// Backwards compatibility.

function drush_make_download_get($name, $download, $download_location) {

  return drush_make_download_file($name, $download, $download_location);

}

function drush_make_download_post($name, $download, $download_location) {

  $download['request_type'] = 'post';

  $download['data'] = $download['post_data'];

  return drush_make_download_file($name, $download, $download_location);

}

function drush_make_download_git($name, $download, $download_location) {

  $tmp_path = drush_make_tmp();

  $wc = drush_get_option('working-copy');

  // check if branch option is set in info file, otherwise set default to master branch

  $download['branch'] = isset($download['branch']) ? $download['branch'] : 'master';

  // check if tag option is set in info file, otherwise we set it to false

  $download['tag'] = isset($download['tag']) ? $download['tag'] : FALSE;

  // check if specific revision is set in info file

  $download['revision'] = isset($download['revision']) ? $download['revision'] : FALSE;

  // only progress if we have a download url...

  if (!empty($download['url'])) {

    // split the given download url into pieces

    $url_array = array();

    // Get the protocol, site and resource parts of the URL

    // original url = http://example.com/blog/index?name=foo

    // protocol = http://

    // site = example.com/

    // resource = blog/index?name=foo

    $regex = '#^(.*?//)*([\w\.\d]*)(:(\d+))*(/*)(.*)$#';

    $matches = array();

    preg_match($regex, $download['url'], $matches);

    // Assign the matched parts of url to the result array

    $url_array['protocol'] = $matches[1];

    $url_array['port']     = $matches[4];

    $url_array['host']     = $matches[2];

    $url_array['resource'] = $matches[6];

    // clean up the site portion by removing the trailing /

    $url_array['host'] = preg_replace('#/$#', '', $result['host']);

    // clean up the protocol portion by removing the trailing ://

    $url_array['protocol'] = preg_replace('#://$#', '', $result['protocol']);

    if (empty($url_array['protocol'])) {

      // If protocol is not given, assume an SSH URL.

      $url = $download['url'];

    }

    else {

      // build url for git clone to support different protocols

      // currently all protocols seems to use the same url schema

      switch ($url_array['protocol']) {

        case 'git':

          // github uses two different urls, working copy urls using scp format

          // git@domain:repo export url format are git://domain/repo

          if ($wc) {

            // working copy is set

            $url = 'git@'. $url_array['host'] .':'. $url_array['resource'];

            break;

          }

        case 'ssh':

        case 'http':

        case 'https':

        case 'ftp':

        case 'ftps':

        case 'rsync':

        case 'file':

          // @TODO: implement port & user options

          $url = $url_array['protocol'] .'://'. $url_array['host'] .'/'. $url_array['resource'];

          break;

        default:

          drush_make_error('DOWNLOAD_ERROR', dt('unknown protocol @protocol in %project', array('@protocol' => $url_array['protocol'], '%project' => $name)));

          return false;

      }

    }

    $tmp_location = $tmp_path . '/__git__/' . basename($download_location);

    drush_make_mkdir($tmp_path . '/__git__/');

    // clone the given repository

    if (drush_shell_exec("git clone %s %s", $url, $tmp_location)) {

      drush_log(dt('%project cloned from %url.', array('%project' => $name, '%url' => $url)), 'ok');

      // GIT Checkout only work on a ready cloned repo. So we switch to branch or to tag (only if we have no branch) after cloneing.

      if ($download['branch'] !== 'master' || $download['tag'] || $download['revision'] || !empty($download['submodule'])) {

        // get current directory (for move back later)

        $cwd = getcwd();

        // change path to working copy of cloned repo

        chdir($tmp_location);

        // Progress branch / tag / revision download. Ensure that only one option ist set (branch OR tag OR revision)

        // check if branch a other than master

        if ($download['branch'] !== 'master' && !$download['tag'] && !$download['revision']) {

          if (drush_shell_exec("git checkout -b %s %s", $download['branch'], 'origin/' . $download['branch'])) {

            drush_log(dt("Checked out branch %branch.", array('%branch' => $download['branch'])), 'ok');

          }

          else {

            drush_make_error('DOWNLOAD_ERROR', dt("Unable to check out branch %branch.", array('%branch' => $download['branch'])));

          }

        }

        // progress if: tag is set but not the others

        elseif ($download['branch'] == 'master' && $download['tag'] && !$download['revision']) {

          // @TODO: change checkout to refs path

          if (drush_shell_exec("git checkout %s", 'refs/tags/' . $download['tag'])) {

            drush_log(dt("Checked out tag %tag.", array('%tag' => $download['tag'])), 'ok');

          }

          else {

            drush_make_error('DOWNLOAD_ERROR', dt("Unable to check out tag %tag.", array('%tag' => $download['tag'])));

          }

        }

        // progress if: revision is set but not the others

        elseif ($download['branch'] == 'master' && !$download['tag'] && $download['revision']) {

          if (drush_shell_exec("git checkout %s", $download['revision'])) {

            drush_log(dt("Checked out revision %revision.", array('%revision' => $download['revision'])), 'ok');

          }

          else {

            drush_make_error('DOWNLOAD_ERROR', dt("Unable to checkout revision %revision", array('%revision' => $download['revision'])));

          }

        }

        // more than one option is set so we throw a error message

        elseif ($download['branch'] !== 'master' || $download['tag'] || $download['revision']) {

          drush_make_error('DOWNLOAD_ERROR', dt("You can only specific branch or tag or revision but not combined in make file."));

          return false;

        }

        if (!empty($download['submodule'])) {

          $command = 'git submodule update';

          foreach ($download['submodule'] as $option) {

            $command .= ' --%s';

          }

          if (call_user_func_array('drush_shell_exec', array_merge(array($command), $download['submodule']))) {

            drush_log(dt('Initialized registered submodules.'), 'ok');

          }

          else {

            drush_make_error('DOWNLOAD_ERROR', dt('Unable to initialize submodules.'));

          }

        }

        // move back to last current directory (first line)

        chdir($cwd);

      }

      // Remove .git/ directory if working-copy flag was not specified.

      if (!$wc && file_exists($tmp_location . '/.git')) {

        drush_shell_exec("rm -rf %s", $tmp_location . '/.git');

      }

      drush_shell_exec('cp -Rf %s %s', $tmp_location, dirname($download_location));

      drush_shell_exec("rm -rf %s", dirname($tmp_location));

      return dirname($tmp_location);

    }

    else {

      drush_make_error('DOWNLOAD_ERROR', dt('Unable to clone %project from %url.', array('%project' => $name, '%url' => $url)));

    }

  }

  else {

    $download['url'] = dt("unspecified location");

  }

  return FALSE;

}

function drush_make_download_bzr($name, $download, $download_location) {

  $tmp_path = drush_make_tmp();

  $tmp_location = $tmp_path . '/__bzr__/' . basename($download_location);

  drush_make_mkdir(dirname($tmp_location));

  if (!empty($download['url'])) {

    $args = array();

    $command = 'bzr';

    if (drush_get_option('working-copy')) {

      $command .= ' branch  --use-existing-dir';

    }

    else {

      $command .= ' export';

    }

    if (isset($download['revision'])) {

      $command .= ' -r %s';

      $args[] = $download['revision'];

    }

    $command .= ' %s %s';

    if (drush_get_option('working-copy')) {

      $args[] = $download['url'];

      $args[] = $tmp_location;

    }

    else {

      $args[] = $tmp_location;

      $args[] = $download['url'];

    }

    array_unshift($args, $command);

    if (call_user_func_array('drush_shell_exec', $args)) {

      drush_log(dt('%project downloaded from %url.', array('%project' => $name, '%url' => $download['url'])), 'ok');

      drush_shell_exec('cp -Rf %s %s', $tmp_location, dirname($download_location));

      drush_shell_exec('rm -rf %s', dirname($tmp_location));

      return dirname($download_location);

    }

  }

  else {

    $download['url'] = dt("unspecified location");

  }

  drush_make_error('DOWNLOAD_ERROR', dt('Unable to download %project from %url.', array('%project' => $name, '%url' => $download['url'])));

  drush_shell_exec('rm -rf %s', dirname($tmp_location));

  return FALSE;

}

function drush_make_download_svn($name, $download, $download_location) {

  $command = 'svn  --force --non-interactive export';

  if (!empty($download['url'])) {

    if (drush_get_option('working-copy')) {

      $command = 'svn  --force --non-interactive checkout';

    }

    $args = array();

    if (isset($download['revision'])) {

      $command .= ' -r%s';

      $args[] = $download['revision'];

    }

    $command .= ' %s %s';

    $args[] = $download['url'];

    $args[] = $download_location;

    if (!empty($download['username'])) {

      $command .= ' --username %s --password %s';

      $args[] = $download['username'];

      $args[] = $download['password'];

    }

    array_unshift($args, $command);

    $result = call_user_func_array('drush_shell_exec', $args);

    if ($result) {

      drush_log(dt('%project @command from %url.', array('%project' => $name, '@command' => $command, '%url' => $download['url'])), 'ok');

      return $download_location;

    }

    else {

      $download['url'] = dt("unspecified location");

    }

  }

  else {

    drush_make_error('DOWNLOAD_ERROR', dt('Unable to download %project from %url.', array('%project' => $name, '%url' => $download['url'])));

    return FALSE;

  }

}