Club Drupal

Libraries 7.x-2.x, xxxx-xx-xx

-----------------------------

#2699799 by flaviovs, hanoii: Support reading version from package.json.

#2816781 by joelstein: Add a 'access library reports' permission.

#2823735 by amanaplan, tstoeckler: Add admin_menu cache clear integration.

#2745763 by Albert Volkman, tstoeckler: Allow downloading all libraries at once.

#2310753 by tstoeckler: Avoid libraries_get_libraries() scanning the root.

#2341955 by sadashiv, tstoeckler: Clear library cache on library report.

#819610 by tstoeckler: Show variants and dependencies in the UI.

#2724925 by ron_s, tstoeckler: Separate installed from uninstalled libraries.

.libraries-table {

  margin-bottom: 2em;

}

  // Only show variants for installed libraries.

  $header_installed = array(t('Name'), t('Version'), t('Variants'), t('Dependencies'), t('Provider'), t('Links'));

  // Only show status for libraries with an error.

  $header_error = array(t('Name'), t('Status'), t('Version'), t('Dependencies'), t('Provider'), t('Links'));

  // For unregistered libraries the only information we can show is the path.

  $header_unregistered = array(t('Name'), t('Path'));

  $rows_installed = array();

  $rows_error = array();

  $rows_unregistered = array();

  // Registered libraries: we prefer to use libraries_detect() since it provides

  // library metadata.

  $libraries_registered = libraries_detect();

  uasort($libraries_registered, 'libraries_admin_sort_title');

  // Unregistered libraries: modules can depend on Libraries API without sharing

  // metadata by using libraries_get_path(). Libraries can also be placed in the

  // filesystem that are incorrectly installed, a wrong version, or a standalone

  // not connected to any module. In these cases, libraries_get_libraries()

  // provides a full library list. Libraries found by libraries_get_libraries(),

  // but not identified by libraries_detect, are displayed in a separate table.

  $libraries_unregistered = libraries_get_libraries();

  natcasesort($libraries_unregistered);

  foreach ($libraries_registered as $machine_name => $library) {

    $row = array();

      $actions[] = l(t('Homepage'), $library['vendor url']);

      $actions[] = l(t('Download'), $library['download url']);

    }

    $row['data'][] = l($library['name'], 'admin/reports/libraries/' . $machine_name);

    // Only show status for libraries with an error. See above.

    if (!$library['installed']) {

      $row['data'][] = drupal_ucfirst($library['error']);

    }

    $row['data'][] = isset($library['version']) ? $library['version'] : '';

    if ($library['installed']) {

      $row['data'][] = implode(', ', array_keys($library['variants']));

    }

    $row['data'][] = libraries_admin_get_dependencies($library);

    $row['data'][] = libraries_admin_get_provider_with_type($library);

    $row['data'][] = implode(' | ', $actions);

    $row['class'] = $library['installed'] ? array('ok') : array('warning');

    if ($library['installed']) {

      $rows_installed[] = $row;

    else {

      $rows_error[] = $row;

    }

    // Filter registered libraries from unregistered libraries.

    unset($libraries_unregistered[$library['machine name']]);

  }

  // Build table of registered libraries with installed status.

  $form['libraries']['installed'] = array(

    '#theme' => 'libraries_table_with_title',

    '#title' => t('Installed'),

    '#header' => $header_installed,

    '#rows' => $rows_installed,

    '#description' => t('These libraries are registered and installed correctly.'),

    '#empty' => t('There are currently no libraries that are registered and installed.'),

  );

  // Build table of registered libraries with error status.

  $form['libraries']['error'] = array(

    '#theme' => 'libraries_table_with_title',

    '#title' => t('Uninstalled'),

    '#header' => $header_error,

    '#rows' => $rows_error,

    '#description' => t('These libraries are registered but not installed. They may not need to be installed in case a module or theme provides optional integration with a library.'),

    '#empty' => t('There are currently no libraries that are registered but not installed.'),

  );

  // Build table of unregistered libraries.

  foreach ($libraries_unregistered as $name => $path) {

    $rows_unregistered[] = array(

        $name,

        $path,

  $form['libraries']['unregistered'] = array(

    '#theme' => 'libraries_table_with_title',

    '#title' => t('Unregistered'),

    '#header' => $header_unregistered,

    '#rows' => $rows_unregistered,

    '#description' => t('These libraries were found in the filesystem but there is no metadata about them.'),

    // Do not show the table at all, if there are no unregistered libraries.

    '#access' => (bool) $libraries_unregistered,

  // Clear the cached library information so that the library can be loaded if

  // it was just downloaded. Because these instructions use libraries_detect()

  // directly, they will never use the cached information, but this avoids the

  // overview showing a library as installed but it not being loadable.

  libraries_cache_clear();

        $form['instructions']['instruction']['#markup'] = t('There is a missing dependency in your configuration that prevents this library from working properly.') . '<br>';

        $form['instructions']['instruction']['#markup'] = t('There is an incompatible dependency in your configuration that prevents this library from working properly.') . '<br>';

/**

 * Returns the library's dependencies, if any.

 *

 * @param array $library

 *   A library information array.

 *

 * @return string

 *   The dependencies.

 */

function libraries_admin_get_dependencies($library) {

  $dependencies = array();

  foreach ($library['dependencies'] as $dependency_name) {

    if ($dependency = libraries_info($dependency_name)) {

      $dependencies[] = $dependency['name'];

    }

    else {

      $dependencies[] = $dependency_name;

    }

  }

  return implode(', ', $dependencies);

}

 *     For libraries that provide a package.json file, use

 *     'libraries_get_package_json_version' as the version callback.

    'options' => array(

      'all' => 'Download all registered libraries.',

    ),

  libraries_cache_clear();

  $all_libraries = libraries_detect();

  // Prepare a list of names of downloadable libraries.

  $downloadable_names = array();

  foreach ($all_libraries as $machine_name => $library) {

    // Skip libraries that are already installed.

    // @todo Allow (optionally) re-downloading installing libraries.

    if (!empty($library['download file url']) && !$library['installed']) {

      $downloadable_names[] = $machine_name;

  }

  // Gather a list of libraries to download. If '--all' was specified, that

  // takes precedence over any other arguments. Otherwise and if no arguments

  // are specified, we present a choice of all downloadable libraries.

  if (drush_get_option('all', FALSE) && $downloadable_names) {

    $machine_names = $downloadable_names;

  }

  elseif (pm_parse_arguments(func_get_args(), FALSE)) {

    $machine_names = array();

    foreach (pm_parse_arguments(func_get_args(), FALSE) as $machine_name) {

      // If there was an error with with one of the libraries, continue to try

      // to install any remaining libraries.

      if (!isset($all_libraries[$machine_name])) {

        $message = dt("The !library library is not registered with Libraries API.\n", array('!library' => $machine_name));

        $message .= dt("Provide an info file for it or implement hook_libraries_info().\n");

        $message .= dt("See hook_libraries_info() for more information.\n");

        drush_set_error('DRUSH_LIBRARY_UKNOWN', $message);

        continue;

      }

      if (empty($all_libraries[$machine_name]['download file url'])) {

        $message = dt("The !library library cannot be downloaded.\n", array('!library' => $machine_name));

        $message .= dt("Libraries need to specify a download file URL to support being downloaded via Drush.\n");

        $message .= dt("See hook_libraries_info() for more information.\n");

        drush_set_error('DRUSH_LIBRARY_NOT_DOWNLOADABLE', $message);

        continue;

      }

      $machine_names[] = $machine_name;

    }

  }

  elseif ($downloadable_names) {

    $machine_names = drush_choice_multiple(drupal_map_assoc($downloadable_names), FALSE, 'Select which libraries to download.');

    // If the operation was cancelled by the user, or if no libraries were

    // selected, bail out without any further error message.

    if (!$machine_names) {

      return;

  }

  else {

    drush_log(dt('There are no registered, uninstalled libraries that can be downloaded.'), 'warning');

    return;

  }

  foreach ($machine_names as $machine_name) {

    $download_url = $all_libraries[$machine_name]['download file url'];

        drush_log(dt("Skip installation of !project to !dest.", array('!project' => $machine_name, '!dest' => $install_location)), 'warning');

; Information added by Drupal.org packaging script on 2018-09-10

version = "7.x-2.4"

datestamp = "1536581584"

/**

 * Grant the "View library reports" permission to roles with the "View site reports" permission.

 */

function libraries_update_7202() {

  $rids = array_keys(user_roles(FALSE, 'access site reports'));

  foreach ($rids as $rid) {

    _update_7000_user_role_grant_permissions($rid, array('access library reports'), 'libraries');

  }

}

/**

 * Implements hook_admin_menu_cache_info().

 */

function libraries_admin_menu_cache_info() {

  $caches['libraries'] = array(

    'title' => t('Libraries'),

    'callback' => 'libraries_cache_clear',

  );

  return $caches;

}

/**

 * Clears the cached library information.

 */

function libraries_cache_clear() {

  foreach (libraries_flush_caches() as $bin) {

    // Using the wildcard argument leads to DrupalDatabaseCache::clear()

    // truncating the libraries cache table which is more performant that

    // deleting the rows.

    cache_clear_all('*', $bin, TRUE);

  }

}

  // $config and $profile should never be empty in a proper Drupal setup.

  // However, we should never search into the root filesystem under any

  // circumstances, so just bail out in that case.

  if (!$profile || !$config) {

    return array();

  }

      $library['version'] = call_user_func_array($library['version callback'], array(&$library, $library['version arguments']));

/**

 * Gets the version information from a library's package.json file.

 *

 * @param $library

 *   An associative array containing all information about the library.

 * @param $options

 *   This callback expects no option.

 * @return

 *   A string containing the version of the library.

 *

 * @see libraries_get_path()

 */

function libraries_get_package_json_version($library, $options) {

  $file = DRUPAL_ROOT . '/' . $library['library path'] . '/package.json';

  if (!file_exists($file)) {

    return;

  }

  $content = file_get_contents($file);

  if (!$content) {

    return;

  }

  $data = drupal_json_decode($content);

  if (isset($data['version'])) {

    return $data['version'];

  }

}

      return t('Click on a library for a status report or detailed installation instructions.');

/**

 * Implements hook_permission().

 */

function libraries_permission() {

  return array(

    'access library reports' => array(

      'title' => t('View library reports'),

    ),

  );

}

    'access arguments' => array('access library reports'),

    'access arguments' => array('access library reports'),

/**

 * Implements hook_theme().

 */

function libraries_theme($existing, $type, $theme, $path) {

  // Because we extend the 'table' theme function, fetch the respective

  // variables dynamically.

  $common_theme = drupal_common_theme();

  $variables = $common_theme['table']['variables'] + array('title' => '', 'description' => '');

  return array(

    'libraries_table_with_title' => array(

      'variables' => $variables,

      'file' => 'libraries.theme.inc',

    ),

  );

}

<?php

/**

 * @file

 * Provides theme and preprocess functions for Libraries API.

 */

/**

 * Prepare variables for theming a table with a title.

 * 

 * @param array $variables

 *   An array of theme variables, passed by reference.

 */

function template_preprocess_libraries_table_with_title(&$variables) {

  drupal_add_css(drupal_get_path('module', 'libraries') . '/css/libraries.admin.css');

  $variables['attributes'] += array('class' => array());

  $variables['attributes']['class'][] = 'libraries-table';

}

/**

 * Returns HTML for a table with a title.

 * 

 * @param array $variables

 *   An array theme variables.

 * 

 * @return string

 *   The HTML output for this table with a title.

 */

function theme_libraries_table_with_title(array $variables) {

  $output = '';

  $output .= '<h2>' . $variables['title'] . '</h2>';

  $output .= '<div class="description">' . $variables['description'] . '</div>';

  $output .= theme_table($variables);

  return $output;

}

    $this->getWithPermissions(array('access library reports'), 'admin/reports/libraries');

    // Assert the page title and table titles show up.

    $this->assertText('Libraries');

    $this->assertRaw('<h2>Installed</h2>');

    $this->assertRaw('<h2>Uninstalled</h2>');

    // Make sure the table headings show up.

    $this->assertText('Name');

    $this->assertText('Status');

    $this->assertText('Version');

    $this->assertText('Variants');

    $this->assertText('Dependencies');

    $this->assertText('Provider');

    $this->assertText('Links');

    // Make sure that all possible error statuses are displayed.

    $this->getWithPermissions(array('access library reports'), 'admin/reports/libraries/example_files');

    $this->getWithPermissions(array('access library reports'), 'admin/reports/libraries/example_missing');

    $this->getWithPermissions(array('access library reports'), 'admin/reports/libraries/example_undetected_version');

    $this->getWithPermissions(array('access library reports'), 'admin/reports/libraries/example_unsupported_version');

; Information added by Drupal.org packaging script on 2018-09-10

version = "7.x-2.4"

datestamp = "1536581584"

; Information added by Drupal.org packaging script on 2018-09-10

version = "7.x-2.4"

datestamp = "1536581584"

; Information added by Drupal.org packaging script on 2018-09-10

version = "7.x-2.4"

datestamp = "1536581584"