You are here

print_pdf.drush.inc in Printer, email and PDF versions 7

Same filename and directory in other branches
  1. 6 print_pdf/print_pdf.drush.inc
  2. 7.2 print_pdf/print_pdf.drush.inc

drush integration for print_pdf module PDF libraries download.

File

print_pdf/print_pdf.drush.inc
View source
<?php

/**
 * @file
 * drush integration for print_pdf module PDF libraries download.
 */

/**
 * The PDF project download URL
 */

// TCPDF is in sourceforge, and nicely provides a link to the latest version
define('TCPDF_DOWNLOAD_URI', 'http://sourceforge.net/projects/tcpdf/files/latest');

// URI to the the latest dompdf version.. Hardcoded version unfortunately
define('DOMPDF_DOWNLOAD_URI', 'https://github.com/dompdf/dompdf/releases/download/v0.6.1/dompdf-0.6.1.zip');

// wkhtmltopdf is a binary, requiring a different download for each platform
define('WKHTMLTOPDF_AMD64_DOWNLOAD_URI', 'http://downloads.sourceforge.net/project/wkhtmltopdf/0.12.0/wkhtmltox-linux-amd64_0.12.0-03c001d.tar.xz');
define('WKHTMLTOPDF_I386_DOWNLOAD_URI', 'http://downloads.sourceforge.net/project/wkhtmltopdf/0.12.0/wkhtmltox-linux-i386_0.12.0-03c001d.tar.xz');
define('WKHTMLTOPDF_WIN64_DOWNLOAD_URI', 'http://downloads.sourceforge.net/project/wkhtmltopdf/0.12.0/wkhtmltox-win64_0.12.0-03c001d.exe');
define('WKHTMLTOPDF_WIN_DOWNLOAD_URI', 'http://downloads.sourceforge.net/project/wkhtmltopdf/0.12.0/wkhtmltox-win32_0.12.0-03c001d.exe');
define('WKHTMLTOPDF_OSX_DOWNLOAD_URI', 'http://wkhtmltopdf.googlecode.com/files/wkhtmltopdf-OSX-0.10.0_rc2-static.tar.bz2');

/**
 * Implements hook_drush_command().
 */
function print_pdf_drush_command() {
  $items = array();
  $items['print-pdf-download'] = array(
    'description' => 'Download a PDF library.',
    'arguments' => array(
      'library' => dt('The PDF library to download. Either tcpdf, dompdf or wkhtmltopdf.'),
    ),
    'options' => array(
      'path' => dt('A path to the download folder. If omitted Drush will use the default location (@path).', array(
        '@path' => 'sites/all/libraries',
      )),
    ),
    'aliases' => array(
      'pdfdl',
    ),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT,
  );
  return $items;
}

/**
 * Download and extract PDF archive.
 */
function drush_print_pdf_download($library) {
  if (isset($library)) {
    $download_url = _drush_print_pdf_download_url($library);
    if ($download_url) {
      $path = drush_get_option('path');
      if (empty($path)) {
        $path = drush_get_context('DRUSH_DRUPAL_ROOT') . '/sites/all/libraries';
      }

      // Create the path if it does not exist.
      if (!is_dir($path)) {
        drush_op('mkdir', $path);
        drush_log(dt('Directory @path was created', array(
          '@path' => $path,
        )), 'notice');
      }

      // Chdir to the download location.
      $olddir = getcwd();
      drush_op('chdir', $path);

      // Warn about an existing dir
      if (is_dir($library)) {

        // drush_op('rmdir', $library); // Directory must be empty for the php rmdir to work..
        drush_log(dt('An existing @library was overwritten at @path', array(
          '@library' => $library,
          '@path' => $path . '/' . $library,
        )), 'notice');
      }

      // Download the archive
      $filename = _drush_print_pdf_download_file($download_url);
      if ($filename) {
        $extract_ret = _drush_print_pdf_download_extract($filename);
        if ($extract_ret) {

          // Remove the archive
          drush_op('unlink', $filename);
          drush_log(dt('@file has been downloaded and extracted in @path', array(
            '@file' => $filename,
            '@path' => $path,
          )), 'success');
        }
        else {
          drush_log(dt('@file has been downloaded to @path, but extract failed. Check that you have the necessary program installed, and if necessary extract it manually.', array(
            '@file' => $filename,
            '@path' => $path,
          )), 'warning');
        }
      }
      else {
        drush_log(dt('Drush was unable to download @library to @path', array(
          '@library' => $library,
          '@path' => $path,
        )), 'error');
      }

      // Set working directory back to the previous working directory.
      drush_op('chdir', $olddir);
    }
  }
  else {
    drush_log(dt('Please specify a PDF library. Currently supported libraries are dompdf, tcpdf and wkhtmltopdf.'), 'error');
  }
}

/**
 * Discover the correct URL of the package to download
 */
function _drush_print_pdf_download_url($library) {
  $ret = FALSE;
  switch (drupal_strtolower($library)) {
    case 'dompdf':
      $ret = DOMPDF_DOWNLOAD_URI;
      break;
    case 'tcpdf':
      $ret = TCPDF_DOWNLOAD_URI;
      break;
    case 'wkhtmltopdf':
      switch (drupal_substr(php_uname('s'), 0, 3)) {
        case 'Lin':
          $ret = php_uname('m') == 'x86_64' ? WKHTMLTOPDF_AMD64_DOWNLOAD_URI : WKHTMLTOPDF_I386_DOWNLOAD_URI;
          break;
        case 'Win':
          $ret = WKHTMLTOPDF_WIN_DOWNLOAD_URI;
          break;
        case 'Dar':
          $ret = WKHTMLTOPDF_OSX_DOWNLOAD_URI;
          break;
        default:
          drush_log(dt('wkhtmltopdf is not supported in this system, please choose another library.'), 'error');
          break;
      }
      break;
    default:
      drush_log(dt('Unknown PDF library specified, please use one of the supported PDF libraries.'), 'error');
      break;
  }
  return $ret;
}

/**
 * Helper to download and extract the zip/tar archive.
 */
function _drush_print_pdf_download_extract($filename) {
  $arch_ret = FALSE;
  if (drush_op('is_file', $filename)) {
    switch (drush_op('mime_content_type', $filename)) {
      case 1:
        $arch_ret = TRUE;
        break;
      case 'application/zip':

        // Decompress the zip archive
        $arch_ret = drush_shell_exec('unzip -qq -o ' . $filename);

        // ZIP archives usually get the access rights wrong
        drush_log(dt('@filename is a Zip file. Check the access permissions of the extracted files.', array(
          '@filename' => $filename,
        )), 'warning');
        break;
      case 'application/x-gzip':

        // Decompress the tar gz archive
        $arch_ret = drush_shell_exec('tar xzf ' . $filename);
        break;
      case 'application/x-bzip2':

        // Decompress the tar bz2 archive
        $arch_ret = drush_shell_exec('tar xjf ' . $filename);
        break;
      case 'application/x-xz':

        // Decompress the tar xz archive
        $arch_ret = drush_shell_exec('tar xJf %s', $filename);
        break;
    }
  }
  else {
    drush_log(dt('@filename not found.', array(
      '@filename' => $filename,
    )), 'error');
  }
  return $arch_ret;
}

/**
 * Download a file using wget or curl
 *
 * Adapted from a function in drush/includes/drush.inc to support 302 redirects.
 *
 * @param string $download_url
 *   The path to the file to download
 *
 * @return string
 *   The filename that was downloaded, or NULL if the file could not be
 *   downloaded.
 */
function _drush_print_pdf_download_file($download_url) {
  $wget_ret = drush_shell_exec("wget -nv --trust-server-names %s", $download_url);
  if (!drush_get_context('DRUSH_SIMULATE')) {
    if ($wget_ret) {

      // Get the filename of the saved file from the output
      $wget_out = explode('"', array_shift(drush_shell_exec_output()));
      $filename = $wget_out[1];
    }
    else {
      $tempnam = uniqid('drush_print_pdf_');
      $curl_ret = drush_shell_exec("curl -s -L -o %s %s -w '%%{url_effective}'", $tempnam, $download_url);
      if ($curl_ret) {

        // File was donwloaded with the tempname
        // Find the effective name
        $filename = explode('/', array_shift(drush_shell_exec_output()));
        $filename = array_pop($filename);

        // Rename file from tempname to effective name
        if (!drush_op('rename', $tempnam, './' . $filename)) {
          $filename = $tempnam;
        }
      }
      else {
        $filename = FALSE;
      }
    }
  }
  else {
    $filename = basename($download_url);
  }
  return $filename;
}

Functions

Namesort descending Description
drush_print_pdf_download Download and extract PDF archive.
print_pdf_drush_command Implements hook_drush_command().
_drush_print_pdf_download_extract Helper to download and extract the zip/tar archive.
_drush_print_pdf_download_file Download a file using wget or curl
_drush_print_pdf_download_url Discover the correct URL of the package to download

Constants