CRM/Core/ClassLoader.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2014
  33  * $Id$
  34  *
  35  */
  36 class CRM_Core_ClassLoader {
  37
  38   /**
  39    * We only need one instance of this object. So we use the singleton
  40    * pattern and cache the instance in this variable
  41    * @var object
  42    */
  43   private static $_singleton = NULL;
  44
  45   /**
  46    * @param bool $force
  47    *
  48    * @return object
  49    */
  50   public static function &singleton($force = FALSE) {
  51     if ($force || self::$_singleton === NULL) {
  52       self::$_singleton = new CRM_Core_ClassLoader();
  53     }
  54     return self::$_singleton;
  55   }
  56
  57   /**
  58    * @var bool TRUE if previously registered
  59    */
  60   protected $_registered;
  61
  62   /**
  63    */
  64   protected function __construct() {
  65     $this->_registered = FALSE;
  66   }
  67
  68   /**
  69    * Registers this instance as an autoloader.
  70    *
  71    * @param bool $prepend
  72    *   Whether to prepend the autoloader or not.
  73    *
  74    * @api
  75    */
  76   public function register($prepend = FALSE) {
  77     if ($this->_registered) {
  78       return;
  79     }
  80     $civicrm_base_path = dirname(dirname(__DIR__));
  81
  82     require_once dirname(dirname(__DIR__)) . '/vendor/autoload.php';
  83
  84     // we do this to prevent a autoloader errors with joomla / 3rd party packages
  85     // use absolute path since we dont know the content of include_path as yet
  86     // CRM-11304
  87     // TODO Remove this autoloader. For civicrm-core and civicrm-packages, the composer autoloader works fine.
  88     // Extensions rely on include_path-based autoloading
  89     spl_autoload_register(array($this, 'loadClass'), TRUE, $prepend);
  90     $this->initHtmlPurifier($prepend);
  91
  92     $this->_registered = TRUE;
  93     $packages_path = implode(DIRECTORY_SEPARATOR, array($civicrm_base_path, 'packages'));
  94     $include_paths = array(
  95       '.',
  96       $civicrm_base_path,
  97       $packages_path,
  98     );
  99     $include_paths = implode(PATH_SEPARATOR, $include_paths);
 100     set_include_path($include_paths . PATH_SEPARATOR . get_include_path());
 101     require_once "$civicrm_base_path/vendor/autoload.php";
 102   }
 103
 104   public function initHtmlPurifier($prepend) {
 105     if (class_exists('HTMLPurifier_Bootstrap')) {
 106       // HTMLPurifier is already initialized, e.g. by the Drupal module.
 107       return;
 108     }
 109
 110     $htmlPurifierPath = $this->getHtmlPurifierPath();
 111
 112     if (FALSE === $htmlPurifierPath) {
 113       // No HTMLPurifier available, e.g. during installation.
 114       return;
 115     }
 116     require_once $htmlPurifierPath;
 117     spl_autoload_register(array('HTMLPurifier_Bootstrap', 'autoload'), TRUE, $prepend);
 118   }
 119
 120   /**
 121    * @return string|false
 122    *   Path to the file where the class HTMLPurifier_Bootstrap is defined, or
 123    *   FALSE, if such a file does not exist.
 124    */
 125   private function getHtmlPurifierPath() {
 126     if (function_exists('libraries_get_path')
 127       && ($path = libraries_get_path('htmlpurifier'))
 128       && file_exists($file = $path . '/library/HTMLPurifier/Bootstrap.php')
 129     ) {
 130       // We are in Drupal 7, and the HTMLPurifier module is installed.
 131       // Use Drupal's HTMLPurifier path, to avoid conflicts.
 132       // @todo Verify that we are really in Drupal 7, and not in some other
 133       // environment that happens to provide a 'libraries_get_path()' function.
 134       return $file;
 135     }
 136
 137     // we do this to prevent a autoloader errors with joomla / 3rd party packages
 138     // Use absolute path, since we don't know the content of include_path yet.
 139     // CRM-11304
 140     $file = dirname(__FILE__) . '/../../packages/IDS/vendors/htmlpurifier/HTMLPurifier/Bootstrap.php';
 141     if (file_exists($file)) {
 142       return $file;
 143     }
 144
 145     return FALSE;
 146   }
 147
 148   /**
 149    * @param $class
 150    */
 151   public function loadClass($class) {
 152     if (
 153       // Only load classes that clearly belong to CiviCRM.
 154       // Note: api/v3 does not use classes, but api_v3's test-suite does
 155       (0 === strncmp($class, 'CRM_', 4) || 0 === strncmp($class, 'api_v3_', 7) || 0 === strncmp($class, 'WebTest_', 8)) &&
 156       // Do not load PHP 5.3 namespaced classes.
 157       // (in a future version, maybe)
 158       FALSE === strpos($class, '\\')
 159     ) {
 160       $file = strtr($class, '_', '/') . '.php';
 161       // There is some question about the best way to do this.
 162       // "require_once" is nice because it's simple and throws
 163       // intelligible errors.
 164       if (FALSE != stream_resolve_include_path($file)) {
 165         require_once $file;
 166       }
 167     }
 168   }
 169
 170 }