danielebarchiesi@2: <?php
danielebarchiesi@3: // $Id: libraries.module,v 1.19.2.1 2011/01/27 02:31:41 sun Exp $
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * @file
danielebarchiesi@2:  * External library handling for Drupal modules.
danielebarchiesi@2:  */
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Gets the path of a library.
danielebarchiesi@2:  *
danielebarchiesi@2:  * @param $name
danielebarchiesi@2:  *   The machine name of a library to return the path for.
danielebarchiesi@2:  * @param $base_path
danielebarchiesi@2:  *   Whether to prefix the resulting path with base_path().
danielebarchiesi@2:  *
danielebarchiesi@2:  * @return
danielebarchiesi@3:  *   The path to the specified library.
danielebarchiesi@2:  *
danielebarchiesi@2:  * @ingroup libraries
danielebarchiesi@2:  */
danielebarchiesi@2: function libraries_get_path($name, $base_path = FALSE) {
danielebarchiesi@2:   $libraries = &drupal_static(__FUNCTION__);
danielebarchiesi@2: 
danielebarchiesi@2:   if (!isset($libraries)) {
danielebarchiesi@2:     $libraries = libraries_get_libraries();
danielebarchiesi@2:   }
danielebarchiesi@2: 
danielebarchiesi@2:   $path = ($base_path ? base_path() : '');
danielebarchiesi@2:   if (!isset($libraries[$name])) {
danielebarchiesi@3:     // Most often, external libraries can be shared across multiple sites, so
danielebarchiesi@3:     // we return sites/all/libraries as the default path.
danielebarchiesi@3:     $path .= 'sites/all/libraries/' . $name;
danielebarchiesi@2:   }
danielebarchiesi@2:   else {
danielebarchiesi@2:     $path .= $libraries[$name];
danielebarchiesi@2:   }
danielebarchiesi@2: 
danielebarchiesi@2:   return $path;
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Returns an array of library directories.
danielebarchiesi@2:  *
danielebarchiesi@2:  * Returns an array of library directories from the all-sites directory
danielebarchiesi@2:  * (i.e. sites/all/libraries/), the profiles directory, and site-specific
danielebarchiesi@2:  * directory (i.e. sites/somesite/libraries/). The returned array will be keyed
danielebarchiesi@2:  * by the library name. Site-specific libraries are prioritized over libraries
danielebarchiesi@2:  * in the default directories. That is, if a library with the same name appears
danielebarchiesi@2:  * in both the site-wide directory and site-specific directory, only the
danielebarchiesi@2:  * site-specific version will be listed.
danielebarchiesi@2:  *
danielebarchiesi@2:  * @return
danielebarchiesi@2:  *   A list of library directories.
danielebarchiesi@2:  *
danielebarchiesi@2:  * @ingroup libraries
danielebarchiesi@2:  */
danielebarchiesi@2: function libraries_get_libraries() {
danielebarchiesi@3:   $directory = 'libraries';
danielebarchiesi@2:   $searchdir = array();
danielebarchiesi@3:   $profile = drupal_get_profile();
danielebarchiesi@2:   $config = conf_path();
danielebarchiesi@2: 
danielebarchiesi@2:   // Similar to 'modules' and 'themes' directories in the root directory,
danielebarchiesi@2:   // certain distributions may want to place libraries into a 'libraries'
danielebarchiesi@2:   // directory in Drupal's root directory.
danielebarchiesi@3:   $searchdir[] = $directory;
danielebarchiesi@2: 
danielebarchiesi@3:   // The 'profiles' directory contains pristine collections of modules and
danielebarchiesi@3:   // themes as organized by a distribution.  It is pristine in the same way
danielebarchiesi@3:   // that /modules is pristine for core; users should avoid changing anything
danielebarchiesi@3:   // there in favor of sites/all or sites/<domain> directories.
danielebarchiesi@3:   if (file_exists("profiles/$profile/$directory")) {
danielebarchiesi@3:     $searchdir[] = "profiles/$profile/$directory";
danielebarchiesi@3:   }
danielebarchiesi@2: 
danielebarchiesi@3:   // Always search sites/all/*.
danielebarchiesi@3:   $searchdir[] = 'sites/all/' . $directory;
danielebarchiesi@2: 
danielebarchiesi@2:   // Also search sites/<domain>/*.
danielebarchiesi@3:   if (file_exists("$config/$directory")) {
danielebarchiesi@3:     $searchdir[] = "$config/$directory";
danielebarchiesi@3:   }
danielebarchiesi@2: 
danielebarchiesi@2:   // Retrieve list of directories.
danielebarchiesi@3:   // @todo Core: Allow to scan for directories.
danielebarchiesi@2:   $directories = array();
danielebarchiesi@2:   $nomask = array('CVS');
danielebarchiesi@2:   foreach ($searchdir as $dir) {
danielebarchiesi@2:     if (is_dir($dir) && $handle = opendir($dir)) {
danielebarchiesi@2:       while (FALSE !== ($file = readdir($handle))) {
danielebarchiesi@2:         if (!in_array($file, $nomask) && $file[0] != '.') {
danielebarchiesi@2:           if (is_dir("$dir/$file")) {
danielebarchiesi@2:             $directories[$file] = "$dir/$file";
danielebarchiesi@2:           }
danielebarchiesi@2:         }
danielebarchiesi@2:       }
danielebarchiesi@2:       closedir($handle);
danielebarchiesi@2:     }
danielebarchiesi@2:   }
danielebarchiesi@2: 
danielebarchiesi@2:   return $directories;
danielebarchiesi@2: }
danielebarchiesi@2: