colorbox.drush.inc in Colorbox 8

Drush integration for colorbox.

File

drush/colorbox.drush.inc

<?php

/**
 * @file
 * Drush integration for colorbox.
 */
use Symfony\Component\Filesystem\Filesystem;

/**
 * The Colorbox plugin URI.
 */
define('COLORBOX_DOWNLOAD_URI', 'https://github.com/jackmoore/colorbox/archive/master.zip');
define('COLORBOX_DOWNLOAD_PREFIX', 'colorbox-');

/**
 * Implements hook_drush_command().
 */
function colorbox_drush_command() {
  $items = [];

  // The key in the $items array is the name of the command.
  $items['colorbox-plugin'] = [
    'callback' => 'drush_colorbox_plugin',
    'description' => dt('Download and install the Colorbox plugin.'),
    // No bootstrap.
    'bootstrap' => DRUSH_BOOTSTRAP_DRUSH,
    'arguments' => [
      'path' => dt('Optional. A path where to install the Colorbox plugin. If omitted Drush will use the default location.'),
    ],
    'aliases' => [
      'colorboxplugin',
    ],
  ];
  return $items;
}

/**
 * Implements hook_drush_help().
 *
 * This function is called whenever a drush user calls
 * 'drush help <name-of-your-command>'
 */
function colorbox_drush_help($section) {
  switch ($section) {
    case 'drush:colorbox-plugin':
      return dt('Download and install the Colorbox plugin from jacklmoore.com/colorbox, default location is the libraries directory.');
  }
}

/**
 * Command to download the Colorbox plugin.
 */
function drush_colorbox_plugin() {
  $args = func_get_args();
  if (!empty($args[0])) {
    $path = $args[0];
  }
  else {
    $path = 'libraries';
  }

  // Create the path if it does not exist.
  if (!is_dir($path)) {
    drush_op('mkdir', $path);
    \Drupal::logger(dt('Directory @path was created', [
      '@path' => $path,
    ]))
      ->notice('notice');
  }

  // Set the directory to the download location.
  $olddir = getcwd();
  chdir($path);

  // Download the zip archive.
  if ($filepath = drush_download_file(COLORBOX_DOWNLOAD_URI)) {
    $filename = basename($filepath);
    $dirname = COLORBOX_DOWNLOAD_PREFIX . basename($filepath, '.zip');

    // Remove any existing Colorbox plugin directory.
    if (is_dir($dirname) || is_dir('colorbox')) {
      Filesystem::remove($dirname, TRUE);
      Filesystem::remove('colorbox', TRUE);
      \Drupal::logger(dt('A existing Colorbox plugin was deleted from @path', [
        '@path' => $path,
      ]))
        ->notice('notice');
    }

    // Decompress the zip archive.
    drush_tarball_extract($filename);

    // Change the directory name to "colorbox" if needed.
    if ($dirname != 'colorbox') {
      drush_move_dir($dirname, 'colorbox', TRUE);
      $dirname = 'colorbox';
    }
  }
  if (is_dir($dirname)) {
    \Drupal::logger(dt('Colorbox plugin has been installed in @path', [
      '@path' => $path,
    ]))
      ->success('success');
  }
  else {
    \Drupal::logger(dt('Drush was unable to install the Colorbox plugin to @path', [
      '@path' => $path,
    ]))
      ->error('error');
  }

  // Set working directory back to the previous working directory.
  chdir($olddir);
}

Functions

Name	Description
colorbox_drush_command	Implements hook_drush_command().
colorbox_drush_help	Implements hook_drush_help().
drush_colorbox_plugin	Command to download the Colorbox plugin.

Constants

Name	Description
COLORBOX_DOWNLOAD_PREFIX
COLORBOX_DOWNLOAD_URI	The Colorbox plugin URI.