libraries.drush.inc in Libraries API 8.3

Drush integration for Libraries API.

File

libraries.drush.inc

<?php

/**
 * @file
 * Drush integration for Libraries API.
 */
use Drupal\Component\Utility\Unicode;

/**
 * Implements hook_drush_command().
 */
function libraries_drush_command() {
  $items['libraries-list'] = [
    'callback' => 'libraries_drush_list',
    'description' => dt('Lists registered library information.'),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_FULL,
  ];

  /*
    $items['libraries-download'] = array[
      'callback' => 'libraries_drush_download',
      'description' => dt('Downloads a registered library into the libraries directory for the active site.'),
      'arguments' => [
        'name' => dt('The internal name of the registered library.'),
      ],
    ];
  */
  return $items;
}

/**
 * Implements hook_drush_help().
 */
function libraries_drush_help($section) {
  switch ($section) {
    case 'drush:libraries-list':
      return dt('Lists registered library information.');
    case 'drush:libraries-download':
      return dt('Downloads a registered library into the libraries directory for the active site.

See libraries-list for a list of registered libraries.');
  }
}

/**
 * Implements hook_drush_cache_clear().
 *
 * @see drush_cache_clear_types()
 */
function libraries_drush_cache_clear(&$types) {
  $types['libraries'] = 'libraries_drush_invalidate_cache';
}

/**
 * Clears the library cache.
 */
function libraries_drush_invalidate_cache() {
  \Drupal::cache('libraries')
    ->deleteAll();
}

/**
 * Lists registered library information.
 */
function libraries_drush_list() {
  $libraries = [];
  foreach (\Drupal::service('libraries.manager')
    ->info() as $name => $info) {
    $libraries[$name] = \Drupal::service('libraries.manager')
      ->getLibrary($name);
  }
  ksort($libraries);
  if (empty($libraries)) {
    drush_print('There are no registered libraries.');
  }
  else {
    $rows = [];

    // drush_print_table() automatically treats the first row as the header, if
    // $header is TRUE.
    $rows[] = [
      dt('Name'),
      dt('Status'),
      dt('Version'),
      dt('Variants'),
      dt('Dependencies'),
    ];
    foreach ($libraries as $name => $library) {
      $status = $library['installed'] ? dt('OK') : Unicode::ucfirst($library['error']);
      $version = $library['installed'] && !empty($library['version']) ? $library['version'] : '-';

      // Only list installed variants.
      $variants = [];
      foreach ($library['variants'] as $variant_name => $variant) {
        if ($variant['installed']) {
          $variants[] = $variant_name;
        }
      }
      $variants = empty($variants) ? '-' : implode(', ', $variants);
      $dependencies = !empty($library['dependencies']) ? implode(', ', $library['dependencies']) : '-';
      $rows[] = [
        $name,
        $status,
        $version,
        $variants,
        $dependencies,
      ];
    }

    // Make the possible values for the 'Status' column and the 'Version' header
    // wrap nicely.
    $widths = [
      0,
      12,
      7,
      0,
      0,
    ];
    drush_print_table($rows, TRUE, $widths);
  }
}

/**
 * Downloads a library.
 *
 * @param string $name
 *   The internal name of the library to download.
 */
function libraries_drush_download($name) {
  return;

  // @todo Looks wonky?
  if (!drush_shell_exec('type unzip')) {
    return drush_set_error(dt('Missing dependency: unzip. Install it before using this command.'));
  }

  // @todo Simply use current drush site.
  $args = func_get_args();
  if ($args[0]) {
    $path = $args[0];
  }
  else {
    $path = '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', [
      '@path' => $path,
    ]), 'notice');
  }

  // Set the directory to the download location.
  $olddir = getcwd();
  chdir($path);
  $filename = basename(COLORBOX_DOWNLOAD_URI);
  $dirname = basename(COLORBOX_DOWNLOAD_URI, '.zip');

  // Remove any existing Colorbox plugin directory.
  if (is_dir($dirname)) {
    drush_log(dt('A existing Colorbox plugin was overwritten at @path', [
      '@path' => $path,
    ]), 'notice');
  }

  // Remove any existing Colorbox plugin zip archive.
  if (is_file($filename)) {
    drush_op('unlink', $filename);
  }

  // Download the zip archive.
  if (!drush_shell_exec('wget ' . COLORBOX_DOWNLOAD_URI)) {
    drush_shell_exec('curl -O ' . COLORBOX_DOWNLOAD_URI);
  }
  if (is_file($filename)) {

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

    // Remove the zip archive.
    drush_op('unlink', $filename);
  }

  // Set working directory back to the previous working directory.
  chdir($olddir);
  if (is_dir($path . '/' . $dirname)) {
    drush_log(dt('Colorbox plugin has been downloaded to @path', [
      '@path' => $path,
    ]), 'success');
  }
  else {
    drush_log(dt('Drush was unable to download the Colorbox plugin to @path', [
      '@path' => $path,
    ]), 'error');
  }
}

Functions

Name	Description
libraries_drush_cache_clear	Implements hook_drush_cache_clear().
libraries_drush_command	Implements hook_drush_command().
libraries_drush_download	Downloads a library.
libraries_drush_help	Implements hook_drush_help().
libraries_drush_invalidate_cache	Clears the library cache.
libraries_drush_list	Lists registered library information.