Club Drupal

Libraries 7.x-2.3, 2016-05-12

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

#1884246 by BR0kEN, tstoeckler et al: Allow downloading libraries via Drush.

by tstoeckler: Allow detecting all libraries by calling libraries_detect().

by tstoeckler: Prevent LibrariesWebTestBase from being displayed in the UI.

#819610 by tstoeckler: Add tests for the Libraries UI.

#1884246 by BR0kEN, tstoeckler: Show the provider in drush libraries-list

#819610 by Pol, tstoeckler: Show the provider in the UI.

#2634732 by Rob Holmes, tstoeckler: Sort libraries by title in the UI.

#2585395 by robinsonsarah01: Allow object methods as version callbacks.

#819610 by tstoeckler, Pol: Provide a status report for library information.

#2352251 by netw3rker: Fix incorrect hook name in libraries.api.php.

#2352237 by netw3rker, tstoeckler: Allow clearing the libraries cache from Drush.

#2193969 by tstoeckler: Avoid warnings for stale library caches.

#2287529 by drupalshrek, tstoeckler: Update installation link in README.txt.

* Install as usual, see

  https://www.drupal.org/documentation/install/modules-themes/modules-7 for

  further information. Note that installing external libraries is separate from

  installing this module and should happen in the sites/all/libraries directory.

  See http://drupal.org/node/1440066 for more information.

<?php

/**

 * @file

 * Provides administrative page and form callbacks for Libraries module.

 */

/**

 * Form generation callback for the libraries overview table.

 *

 * This is a form instead of a page to allow easier extending in contributed

 * modules.

 *

 * @param array $form

 *   An associative array containing the structure of the form.

 * @param array $form_state

 *   A keyed array containing the current state of the form.

 *

 * @return array

 *   The form array for the overview form.

 */

function libraries_admin_overview(array $form, array &$form_state) {

  $header = array(t('Name'), t('Status'), t('Installed version'), t('Provider'), t('Links'));

  $rows = array();

  $libraries = libraries_detect();

  uasort($libraries, 'libraries_admin_sort_title');

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

    $actions = array();

    if ($library['vendor url']) {

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

    }

    if ($library['download url']) {

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

    }

    $rows[] = array(

      'data' => array(

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

        ($library['installed'] ? t('OK') : drupal_ucfirst($library['error'])),

        (isset($library['version']) ? $library['version'] : ''),

        libraries_admin_get_provider_with_type($library),

        implode(' | ', $actions),

      ),

      'class' => ($library['installed'] ? array('ok') : array('error')),

    );

  }

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

    '#theme' => 'table',

    '#header' => $header,

    '#rows' => $rows,

    '#empty' => t('There are currently no libraries installed'),

  );

  return $form;

}

/**

 * Form generation callback for the status overview for a single library.

 *

 * This is a form instead of a page to allow easier extending in contributed

 * modules.

 *

 * @param array $form

 *   An associative array containing the structure of the form.

 * @param array $form_state

 *   A keyed array containing the current state of the form.

 * @param array $library

 *   A library information array.

 *

 * @return array|null

 *   The form array for the status form or NULL if the library was not found.

 *

 * @todo Add some var_export($library)-style output

 */

function libraries_admin_library_status_form(array $form, array &$form_state, $library) {

  drupal_set_title(t('Status report for library %library', array('%library' => $library['name'])), PASS_THROUGH);

  if ($library['installed']) {

    drupal_set_message(t('The %name library is installed correctly.', array('%name' => $library['name'])));

    $form['status'] = libraries_admin_status_table($library);

  }

  else {

    drupal_set_message($library['error message'], 'error');

    switch ($library['error']) {

      case 'not found':

        $form['instructions'] = libraries_admin_instructions_missing($library);

        break;

      case 'not detected':

        $form['instructions'] = libraries_admin_instructions_undetected($library);;

        break;

      case 'not supported':

        $form['instructions'] = libraries_admin_instructions_unsupported($library);

        break;

      case 'missing dependency':

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

        break;

      case 'incompatible dependency':

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

        break;

    }

  }

  return $form;

}

/**

 * Displays a table of status information about a library.

 *

 * @param array $library

 *   A library information array.

 *

 * @return array

 *   A renderable array containing a table with status information.

 */

function libraries_admin_status_table(array $library) {

  $header = array(array(

    // @todo The title implies that other type of information is displayed, as

    //   well, but this is currently not the case.

    // @todo Use CSS instead of a <strong> element.

    'data' => '<strong>' . t('General information') . '</strong>',

    'colspan' => 2,

    'class' => 'table-heading',

    'no_striping' => TRUE,

  ));

  $rows = array();

  // @todo Use CSS instead of <strong> elements.

  $rows['name'] = array('<strong>' . t('Name') . '</strong>', check_plain($library['name']));

  $rows['machine_name'] = array('<strong>' . t('Machine name') . '</strong>', check_plain($library['machine name']));

  if ($library['vendor url']) {

    $rows['vendor_url'] = array('<strong>' . t('Vendor URL') . '</strong>', l($library['vendor url'], $library['vendor url']));

  }

  if ($library['download url']) {

    $rows['download_url'] = array('<strong>' . t('Download URL') . '</strong>', l($library['download url'], $library['download url']));

  }

  $rows['provider'] = array('<strong>' . t('Provider') . '</strong>', libraries_admin_get_provider_with_type($library));

  $rows['library_path'] = array('<strong>' . t('Library path') . '</strong>', $library['library path']);

  $rows['version'] = array('<strong>' . t('Version') . '</strong>', $library['version']);

  if (!empty($library['variants'])) {

    $rows['variants'] = array('<strong>' . t('Variants') . '</strong>', implode(', ', array_keys($library['variants'])));

  }

  return array(

    '#theme' => 'table',

    '#header' => $header,

    '#rows' => $rows,

  );

}

/**

 * Returns instructions for dealing with a missing library.

 *

 * @param array $library

 *   A library information array.

 *

 * @return array

 *   A renderable array containing the instructions.

 */

function libraries_admin_instructions_missing(array $library) {

  $build = array();

  $build['instruction']['#markup'] = t('Follow these steps to install the library:');

  $items = array();

  // 1. Download the library.

  // If no supported versions are specified, the latest version is

  // recommended.

  if (empty($library['versions'])) {

    $items[] = t('Download the latest version of the library <a href="@download-url">here</a>.', array(

      '@download-url' => $library['download url'],

    ));

  }

  // Otherwise, the latest supported version is recommended.

  else {

    $versions = array_keys($library['versions']);

    usort($versions, 'version_compare');

    $versions = array_reverse($versions);

    $version = $versions[0];

    $items[] = t('Download version %version of the library <a href="@download-url">here</a>.', array(

      '%version' => $version,

      '@download-url' => $library['download url'],

    ));

  }

  // 2. Unpack it.

  $items[] = t('If the library is an archive, i.e. if the file ending is for example <em>.tar.gz</em> or <em>.zip</em>, unpack it.');

  // 3. Create the libraries folder.

  $items[] = t('In the %library-directory directory of your Drupal installation create a %library directory.', array(

    '%library-directory' => 'sites/all/libraries',

    '%library' => $library['machine name'],

  ));

  // 4. Upload it.

  // If the library has variant-independent files, give the user the

  // location of an example file to check his filesystem against.

  if ($directory_layout = libraries_admin_directory_layout($library)) {

    $items[] = t('Upload the whole library (which can consist of multiple directories) into the newly created %library-path directory. The following files and directories should be contained in that directory: !directory-layout', array(

      '%library-path' => 'sites/all/libraries/' . $library['machine name'],

      '!directory-layout' => drupal_render($directory_layout),

    ));

  }

  else {

    $items[] = t('Upload the whole library (which can consist of multiple directories) into the newly created %library-path directory.', array(

      '%library-path' => 'sites/all/libraries/' . $library['machine name'],

    ));

  }

  // 5. Reload.

  $items[] = t('<a href="">Reload</a> the page. If successful, you should see status information about this library.');

  $build['steps'] = array(

    '#theme' => 'item_list',

    '#items' => $items,

    '#type' => 'ol'

  );

  return $build;

}

/**

 * Returns instructions for dealing with an undetected library.

 *

 * @param array $library

 *   A library information array.

 *

 * @return array

 *   A renderable array containing the instructions.

 */

function libraries_admin_instructions_undetected($library) {

  $build = array();

  // Re-check location.

  // @todo Avoid usage of <br> elements.

  $build['instruction']['#markup'] = t('Check that the whole library is located at %library-path.', array(

      '%library-path' => $library['library path'],

    )) . '<br>';

  // If the library has variant-independent files, give the user the

  // exact location of the files to check against.

  // @todo It should be possible to display even variant-specific files

  //   in case the variant is installed, but libraries_detect() does not

  //   detect variants if the library version cannot be detected.

  if ($directory_layout = libraries_admin_directory_layout($library)) {

    $build['directory_layout'] = $directory_layout;

    $build['directory_layout']['#prefix'] = t('The following files and directories should be contained in that directory:');

  }

  // If the library is placed correctly the library information is

  // incorrect.

  // This switch could be avoided by using $library['info type'], but that would

  // hinder properly translating these strings.

  $build['reload']['#markup'] = t('If you have moved any files, <a href="">reload</a> the page. If successful, you should see status information about this library.') . '<br>';

  $build['notice']['#markup'] = t('If the files are placed correctly and the version can still not be detected, the library information is incorrect.') . '<br>';

  $provider = libraries_admin_get_provider($library);

  switch ($library['info type']) {

    case 'module':

      $build['contact']['#markup'] = t('Contact the maintainer of the %module module to correct this.', array(

          '%module' => $provider,

        )) . '<br>';

      break;

    case 'theme':

      $build['contact']['#markup'] = t('Contact the maintainer of the %theme theme to correct this.', array(

          '%theme' => $provider,

        )) . '<br>';

      break;

    case 'info file':

      $build['contact']['#markup'] = t('Contact the maintainer of the %info-file info file to correct this.', array(

          '%info-file' => $provider,

        )) . '<br>';

      break;

  }

  return $build;

}

/**

 * Returns instructions for dealing with an unsupported library.

 *

 * @param array $library

 *   A library information array.

 *

 * @return array

 *   A renderable array containing the instructions.

 */

function libraries_admin_instructions_unsupported($library) {

  $build = array();

  $items = array();

  // Either download a different version of the library...

  $versions = array_keys($library['versions']);

  usort($versions, 'version_compare');

  $versions = array_reverse($versions);

  $version = $versions[0];

  $build['instruction']['#markup'] = t('Please install version %version of the library by following the following steps:',

    array(

      '%version' => $version,

    ));

  // 1. Delete the old library.

  $items[] = t('Delete the entire contents of the %library-path directory.',

    array(

      '%library-path' => $library['library path'],

    ));

  // 2. Download the new library.

  $items[] = t('Download version %version of the library <a href="@download-url">here</a>.',

    array(

      '%version' => $version,

      '@download-url' => $library['download url'],

    ));

  // 3. Unpack it.

  $items[] = t('If the library is an archive, i.e. if the file ending is for example <em>.tar.gz</em> or <em>.zip</em>, unpack it.');

  // 4. Upload the new library.

  // If the library has variant-independent files, give the user the

  // location of an example file to check his filesystem against.

  if ($directory_layout = libraries_admin_directory_layout($library)) {

    $items[] = t('Upload the new files into the %library-path directory. The following files and directories should be contained in that directory: !directory-layout',

      array(

        '%library-path' => $library['library path'],

        '!directory-layout' => drupal_render($directory_layout),

      ));

  }

  else {

    $items[] = t('Upload the new files into the %library-path directory.',

      array(

        '%library-path' => $library['library path'],

      ));

  }

  // 5. Reload.

  $items[] = t('<a href="">Reload</a> the page. If successful, you should see status information about this library.');

  $build['steps'] = array(

    '#theme' => 'item_list',

    '#items' => $items,

    '#type' => 'ol',

  );

  // ...or contact the maintainer of the library information.

  $provider = libraries_admin_get_provider($library);

  switch ($library['info type']) {

    case 'module':

      $build['contact']['#markup'] = t('If you are bound to version @version of the library, ask the maintainer of the %module module to provide support for it.', array(

          '@version' => $library['version'],

          '%module' => $provider,

        )) . '<br>';

      break;

    case 'theme':

      $build['contact']['#markup'] = t('If you are bound to version @version of the library, ask the maintainer of the %theme theme to provide support for it.', array(

          '@version' => $library['version'],

          '%theme' => $provider,

        )) . '<br>';

      break;

    case 'info file':

      $build['contact']['#markup'] = t('If you are bound to version @version of the library, ask the maintainer of the %info-file info file to provide support for it.', array(

          '@version' => $library['version'],

          '%info-file' => $provider,

        )) . '<br>';

      break;

  }

  return $build;

}

/**

 * Returns the directory layout of the library, if possible.

 *

 * The result of this function can help users to verify that they have uploaded

 * the library to the correct location.

 *

 * @param array $library

 *   A library information array.

 *

 * @return array|false

 *   A renderable array containing the directory layout of the library or FALSE

 *   if a directory layout could not be generated.

 */

function libraries_admin_directory_layout(array $library) {

  $build = array(

    '#theme' => 'item_list',

    '#type' => 'ul',

    '#items' => array(),

  );

  $items = &$build['#items'];

  if ($library['path']) {

    $items = &libraries_admin_path_to_tree($items, $library['path']);

  }

  foreach (array('js', 'css', 'php') as $type) {

    if (!empty($library['files'][$type])) {

      $files = array_keys($library['files'][$type]);

      foreach ($files as $file) {

        // Skip JavaScript settings.

        if (is_int($file)) {

          continue;

        }

        $children = &$items;

        libraries_admin_path_to_tree($children, $file);

      }

    }

  }

  return $build['#items'] ? $build : FALSE;

}

/**

 * Converts a file path into a tree structure for use in an item list.

 *

 * For example, the path 'foo/bar/baz' will be converted into the tree structure

 * represented by the following list:

 * - foo

 *   - bar

 *     - baz

 *

 * The $items array that is modified by reference or returned (see below) can

 * be used as the 'items' variable for theme_item_list().

 *

 * This function modifies passed-in $items array, so that multiple paths can

 * be placed into the same tree structure easily.

 *

 * @code

 *   $items = array();

 *   foreach ($paths as $path) {

 *     libraries_admin_path_to_tree($items, $path);

 *   }

 * @endcode

 *

 * It also returns the last item by reference, so that it can also be used to

 * traverse into a sub-structure and add further children there.

 *

 * @code

 *   $items = array();

 *   $children = &libraries_admin_path_to_tree($items, $path);

 *   foreach ($sub_paths as $sub_path) {

 *     libraries_admin_path_to_tree($children, $sub_path);

 *   }

 * @endcode

 *

 * @param array $items

 * @param string $path

 *

 * @return array

 */

function &libraries_admin_path_to_tree(array &$items, $path) {

  $part = strtok($path, '/');

  while ($part) {

    if (!isset($items[$part])) {

      $items[$part] = array(

        'data' => $part,

        'children' => array(),

      );

    }

    $items = &$items[$part]['children'];

    $part = strtok('/');

  }

  return $items;

}

/**

 * Sorts libraries by name.

 *

 * This function can be used as a callback for usort() or uasort().

 *

 * @param array $a

 *   The first library information array.

 * @param array $b

 *   The second library information array.

 *

 * @return int

 *   Returns -1 if $a is considered smaller than $b, 1 if $a considered greater

 *   than $b and 0 if $a and $b are considered equal.

 *

 * @see strnatcasecmp()

 * @see usort()

 * @see uasort()

 */

function libraries_admin_sort_title(array $a, array $b) {

  return strnatcasecmp($a['name'], $b['name']);

}

/**

 * Returns the library's provider.

 *

 * The provider can be a module, a theme, or an info file.

 *

 * @param array $library

 *   A library information array.

 *

 * @return string

 *   The provider.

 */

function libraries_admin_get_provider($library) {

  $provider = '';

  switch ($library['info type']) {

    case 'module':

    case 'theme':

      $info = system_get_info($library['info type'], $library[$library['info type']]);

      $provider = $info['name'];

      break;

    case 'info file':

      $provider = basename($library['info file']);

      break;

  }

  return $provider;

}

/**

 * Returns the library's provider and provider type.

 *

 * The provider type is either 'module', 'theme', or 'info file'.

 *

 * @param array $library

 *   A library information array.

 *

 * @return string

 *   The provider and provider type.

 */

function libraries_admin_get_provider_with_type($library) {

  $provider = libraries_admin_get_provider($library);

  $provider_with_type = '';

  // This switch could be avoided by using $library['info type'], but that would

  // hinder properly translating these strings.

  switch ($library['info type']) {

    case 'module':

      $provider_with_type = t('%module module', array('%module' => $provider));

      break;

    case 'theme':

      $provider_with_type = t('%theme theme', array('%theme' => $provider));

      break;

    case 'info file':

      $provider_with_type = t('%info-file info file', array('%info-file' => $provider));

      break;

  }

  return $provider_with_type;

}

 *   - download file url: (optional) The URL where the latest version of the

 *     library can be downloaded. In case such a static URL exists the library

 *     can be downloaded automatically via Drush. Run

 *     'drush help libraries-download' in the command-line for more information.

    // It is important that this URL does not include the actual version to

    // download. Not all libraries provide such a static URL.

    'download file url' => 'http://example.com/latest.tar.gz',

    // The download file URL can also point to a single file (instead of an

    // archive).

    'download file url' => 'http://example.com/latest/simple.js',

function hook_libraries_info_file_paths() {

  $items = array();

    'description' => dt('Show a list of registered libraries.'),

    'aliases' => array('lls', 'lib-list'),

  $items['libraries-download'] = array(

    'description' => dt('Download library files of registered libraries.'),

    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_FULL,

    'aliases' => array('ldl', 'lib-download'),

      'libraries' => 'A comma delimited list of library machine names.',

    'required-arguments' => TRUE,

  );

 * Implements hook_drush_cache_clear().

 *

 * @see drush_cache_clear_types()

function libraries_drush_cache_clear(array &$types) {

  $types['libraries'] = 'libraries_drush_invalidate_cache';

}

/**

 * Clears the library cache.

 */

function libraries_drush_invalidate_cache() {

  // @see drupal_flush_all_caches()

  foreach (libraries_flush_caches() as $table) {

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

 * Command callback. Show a list of registered libraries.

function drush_libraries_list() {

  $libraries = libraries_detect();

    module_load_include('inc', 'libraries', 'libraries.admin');

    $rows[] = array(

      dt('Name'),

      dt('Status'),

      dt('Version'),

      dt('Variants'),

      dt('Dependencies'),

      dt('Provider'),

    );

      $rows[] = array(

        $name,

        $library['installed'] ? dt('OK') : drupal_ucfirst($library['error']),

        ($library['installed'] && $library['version']) ? '-' : $library['version'],

        $variants ? implode(', ', $variants) : '-',

        $library['dependencies'] ? implode(', ', $library['dependencies']) : '-',

        libraries_admin_get_provider($library),

      );

    $widths = array(0, 12, 7, 0, 0, 0);

 * Command callback. Downloads a library.

 *

 * Only libraries that provide a download file URL can be downloaded.

 * @see hook_libraries_info()

 * @see drush_pm_download()

function drush_libraries_download() {

  drush_command_include('pm-download');

  $libraries = libraries_info();

  // @todo Consider supporting downloading all downloadable libraries.

  // @todo Consider offering a selection if no library is specified.

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

    if (!isset($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;

    }

    $library = $libraries[$machine_name];

    if (empty($library['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;

    }

    $download_url = $library['download file url'];

    drush_log(dt('Downloading library !name ...', array('!name' => $machine_name)));

    // @see package_handler_download_project() in wget.inc

    // It cannot be used directly because it will always try to extract the

    // archive which fails when downloading a single file.

    // @todo Modify upstream to be able to use

    //   package_handler_download_project() directly.

    // Prepare download path. On Windows file name cannot contain '?'.

    // See http://drupal.org/node/1782444

    $filename = str_replace('?', '_', basename($download_url));

    $download_path = drush_tempdir() . '/' . $filename;

    // Download the tarball.

    // Never cache the downloaded file. The downloading relies on the fact that

    // different versions of the library are available under the same URL as new

    // versions are released.

    $download_path = drush_download_file($download_url, $download_path, 0);

    if ($download_path || drush_get_context('DRUSH_SIMULATE')) {

      drush_log(dt('Downloading !filename was successful.', array('!filename' => $filename)));

    }

    else {

      drush_set_error('DRUSH_PM_DOWNLOAD_FAILED', dt('Unable to download !project to !path from !url.', array('!project' => $machine_name, '!path' => $download_path, '!url' => $download_url)));

      drush_log(dt('Error downloading !name', array('!name' => $machine_name)), 'error');

      continue;

    }

    // @todo Suport MD5 file hashing.

    // Extract the tarball in place and return the full path to the untarred directory.

    $download_base = dirname($download_path);

    if (drush_file_is_tarball($download_path)) {

      if (!$tar_file_list = drush_tarball_extract($download_path, $download_base, TRUE)) {

        // An error has been logged.

        return FALSE;

      }

      $tar_directory = drush_trim_path($tar_file_list[0]);

      $download_path = $download_base . '/' . $tar_directory;

    }

    else {

      $download_path = $download_base;

    }

    // Determine the install location for the project.  User provided

    // --destination has preference.

    $destination = drush_get_option('destination');

    if (!empty($destination)) {

      if (!file_exists($destination)) {

        drush_mkdir($destination);

      }

      $install_location = realpath($destination);

    }

    else {

      /** @see _pm_download_destination_lookup() */

      // _pm_download_destination_lookup() pluralizes the passed type by

      // appending an s.

      // This relies on the fact that there is no library named 'contrib'.

      // @todo Request that this be turned into a proper API upstream.

      $install_location = _pm_download_destination('librarie');

    }

    // @todo Consider invoking a hook similar to

    //   hook_drush_pm_download_destination_alter().

    // @todo Consider adding version-control support similar to pm-download.

    $install_location .= '/' . $machine_name;

    // Check if install location already exists.

    if (is_dir($install_location)) {

      if (drush_confirm(dt('Install location !location already exists. Do you want to overwrite it?', array('!location' => $install_location)))) {

        drush_delete_dir($install_location, TRUE);

      }

      else {

        drush_log(dt("Skip installation of !project to !dest.", array('!project' => $library['machine name'], '!dest' => $install_location)), 'warning');

        continue;

      }

    }

    // Copy the project to the install location.

    if (drush_op('_drush_recursive_copy', $download_path, $install_location)) {

      drush_log(dt("Library !project downloaded to !dest.", array('!project' => $machine_name, '!dest' => $install_location)), 'success');

      // @todo Consider invoking a hook similar to

      //   hook_drush_pm_post_download().

      // @todo Support printing release notes.

    }

    else {

      // We don't `return` here in order to proceed with downloading additional projects.

      drush_set_error('DRUSH_PM_DOWNLOAD_FAILED', dt("Project !project could not be downloaded to !dest.", array('!project' => $machine_name, '!dest' => $install_location)));

    }

    // @todo Consider adding notify support.

files[] = tests/LibrariesAdminWebTest.test

files[] = tests/LibrariesLoadWebTest.test

files[] = tests/LibrariesUnitTest.test

files[] = tests/LibrariesWebTestBase.test

; Information added by Drupal.org packaging script on 2016-05-12

version = "7.x-2.3"

datestamp = "1463077450"

/**

 * Rebuild the class registry.

 */

function libraries_update_7201() {

  // The tests were split from a single libraries.test file into multiple files

  // during the 7.x-2.x cycle.

  registry_rebuild();

}

 * @return string

 * @return array

 * @return array

 * @param array $library

 * @param string $name

 *

 * @return array

 *   The library information array with defaults populated.

function libraries_info_defaults(array &$library, $name) {

    'download file url' => '',

 * @param string $name

 *   (optional) The machine name of a library to detect and return registered

 *   information for. If omitted, information about all registered libraries is

 *   returned.

 *   An associative array containing registered information for all libraries,

 *   the registered information for the library specified by $name, or FALSE if

 *   the library $name is not registered.

function libraries_detect($name = NULL) {

  if (!isset($name)) {

    $libraries = &libraries_info();

    foreach ($libraries as $name => $library) {

      libraries_detect($name);

    }

    return $libraries;

  }

      $library['version'] = call_user_func($library['version callback'], $library, $library['version arguments']);

  // As this key was added after 7.x-2.1 cached library structures might not

  // have it.

  $library += array('post-load integration files' => FALSE);

/**

 * Implements hook_help().

 */

function libraries_help($path, $arg) {

  switch ($path) {

    case 'admin/reports/libraries':

      return t('Click on a library for a status report or detailed installation instructions in case the library is not installed correctly.');

  }

}

/**

 * Implements hook_menu().

 */

function libraries_menu() {

  $items = array();

  $items['admin/reports/libraries'] = array(

    'title' => 'Libraries',

    'description' => 'An overview of libraries installed on this site.',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('libraries_admin_overview'),

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

    'file' => 'libraries.admin.inc'

  );

  $items['admin/reports/libraries/%libraries_ui'] = array(

    'title' => 'Library status report',

    'description' => 'Status overview for a single library',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('libraries_admin_library_status_form', 3),

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

    'file' => 'libraries.admin.inc'

  );

  return $items;

}

/**

 * Loads library information for display in the user interface.

 *

 * This can be used as a menu loader function by specifying a '%libraries_ui'

 * parameter in a path.

 *

 * We do not use libraries_load() (and, thus, a '%libraries' parameter) directly

 * for displaying library information in the user interface as we do not want

 * the library files to be loaded.

 *

 * @param string $name

 *   The machine name of a library to return registered information for.

 *

 * @return array|false

 *   An associative array containing registered information for the library

 *   specified by $name, or FALSE if the library $name is not registered.

 *

 * @see libraries_detect()

 * @see libraries_menu()

 */

function libraries_ui_load($name) {

  return libraries_detect($name);

}

<?php

/**

 * @file

 * Contains LibrariesAdminWebTest.

 *

 * Simpletest automatically discovers test files using PSR-4. We cannot,

 * however, declare a namespace for this class, as that would require PHP 5.3.

 * To prepare the PHP 5.3 requirement and the usage of PSR-4 in 7.x-3.x, we

 * split each test class into its own file and use the correct base name, but

 * for now use the 'test' extension and register them explicitly in

 * libraries.info.

 *

 * @see simpletest_test_get_all()

 */

/**

 * Tests the administrative interface for libraries.

 */

class LibrariesAdminWebTest extends LibrariesWebTestBase {

  /**

   * Provides metadata about this test.

   *

   * @return array

   *   An array of test metadata with the following keys:

   *   - name: The name of the test.

   *   - description: The description of the test.

   *   - group: The group of the test.

   */

  public static function getInfo() {

    return array(

      'name' => 'Libraries administration',

      'description' => 'Tests the administrative interface for libraries.',

      'group' => 'Libraries API',

    );

  }

  /**

   * Tests the libraries report at /admin/reports/libraries.

   */

  public function testLibrariesReportOverview() {

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

    $this->assertRaw('Libraries');

    // Make sure that all the libraries are listed.

    $libraries = libraries_info();

    $this->assertTrue($libraries);

    foreach ($libraries as $library) {

      $this->assertText($library['name']);

      $this->assertLinkByHref('admin/reports/libraries/' . $library['machine name']);

    }

    // Make sure that all possible statuses are displayed.

    $this->assertText('OK');

    $this->assertText('Not found');

    $this->assertText('Not detected');

    $this->assertText('Not supported');

    $this->assertText('Missing dependency');

    $this->assertText('Incompatible dependency');

    // Make sure that the providers are displayed.

    $this->assertRaw('<em class="placeholder">Libraries test module</em> module');

    $this->assertRaw('<em class="placeholder">Libraries test theme</em> theme');

    $this->assertRaw('<em class="placeholder">example_info_file.libraries.info</em> info file');

    // Make sure that homepage and download links are displayed.

    $this->assertLinkByHref('http://example.com');

    $this->assertLinkByHref('http://example.com/download');

  }

  /**

   * Tests the libraries report for an installed library.

   */

  public function testLibrariesReportInstalled() {

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

    $this->assertRaw('Status report for library <em class="placeholder">Example files</em>');

    $this->assertRaw('The <em class="placeholder">Example files</em> library is installed correctly.');

    // Check that the information in the status report is displayed.

    $this->assertText('Example files');

    $this->assertText('example_files');

    $this->assertRaw('<em class="placeholder">Libraries test module</em> module');

    $this->assertText(drupal_get_path('module', 'libraries') . '/tests/libraries/example');

    $this->assertText('1');

  }

  /**

   * Tests the libraries report for a missing library.

   */

  public function testLibrariesReportMissing() {

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

    $this->assertRaw('Status report for library <em class="placeholder">Example missing</em>');

    $this->assertRaw('The <em class="placeholder">Example missing</em> library could not be found.');

    // Check that the download link is being displayed.

    $this->assertLinkByHref('http://example.com/download');

  }

  /**

   * Tests the libraries report for a missing library.

   */

  public function testLibrariesReportNotDetected() {

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

    $this->assertRaw('Status report for library <em class="placeholder">Example undetected version</em>');

    $this->assertRaw('The version of the <em class="placeholder">Example undetected version</em> library could not be detected.');

  }

  /**

   * Tests the libraries report for a missing library.

   */

  public function testLibrariesReportNotSupported() {

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

    $this->assertRaw('Status report for library <em class="placeholder">Example unsupported version</em>');

    $this->assertRaw('The installed version <em class="placeholder">1</em> of the <em class="placeholder">Example unsupported version</em> library is not supported.');

    // Check that the download link is being displayed.

    $this->assertLinkByHref('http://example.com/download');

  }

}

 * Contains LibrariesLoadWebTest.

 *

 * Simpletest automatically discovers test files using PSR-4. We cannot,

 * however, declare a namespace for this class, as that would require PHP 5.3.

 * To prepare the PHP 5.3 requirement and the usage of PSR-4 in 7.x-3.x, we

 * place the test files in the correct directory already, but for now register

 * them explicitly in libraries.info

 * Tests basic detection and loading of libraries.

class LibrariesLoadWebTest extends LibrariesWebTestBase {

   * Provides metadata about this test.

   *

   * @return array

   *   An array of test metadata with the following keys:

   *   - name: The name of the test.

   *   - description: The description of the test.

   *   - group: The group of the test.

  public function testLibrariesDetectDependencies() {

  public function testLibrariesScanInfoFiles() {

  public function testLibrariesInfo() {

  public function testLibrariesDetect() {

  /**

   * Tests libraries_detect() without a $name parameter.

   */

  public function testLibrariesDetectAll() {

    // Test that an array with all library information is returned and that the

    // libraries are properly detected.

    $libraries = libraries_detect();

    $this->verbose('<pre>' . var_export($libraries, TRUE) . '</pre>');

    $this->assertEqual($libraries['example_missing']['error'], 'not found');

    $this->assertEqual($libraries['example_undetected_version']['error'], 'not detected');

    $this->assertEqual($libraries['example_unsupported_version']['error'], 'not supported');

    $this->assertEqual($libraries['example_supported_version']['installed'], TRUE);

  }

  public function testLibrariesLoad() {

  public function testCallbacks() {

  public function testLibrariesOutput() {

  public function assertLibraryFiles($name, $label = '', $extensions = array('js', 'css', 'php')) {