CRM/Core/ClassLoader.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  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    * The classes in CiviTest have ucky, non-standard naming.
  47    *
  48    * @var array
  49    *   Array(string $className => string $filePath).
  50    */
  51   private $civiTestClasses;
  52
  53   /**
  54    * @param bool $force
  55    *
  56    * @return object
  57    */
  58   public static function &singleton($force = FALSE) {
  59     if ($force || self::$_singleton === NULL) {
  60       self::$_singleton = new CRM_Core_ClassLoader();
  61     }
  62     return self::$_singleton;
  63   }
  64
  65   /**
  66    * @var bool TRUE if previously registered
  67    */
  68   protected $_registered;
  69
  70   /**
  71    */
  72   protected function __construct() {
  73     $this->_registered = FALSE;
  74     $this->civiTestClasses = array(
  75       'CiviCaseTestCase',
  76       'CiviDBAssert',
  77       'CiviMailUtils',
  78       'CiviReportTestCase',
  79       'CiviSeleniumTestCase',
  80       'CiviTestSuite',
  81       'CiviUnitTestCase',
  82       'CiviEndToEndTestCase',
  83       'Contact',
  84       'ContributionPage',
  85       'Custom',
  86       'Event',
  87       'Membership',
  88       'Participant',
  89       'PaypalPro',
  90     );
  91   }
  92
  93   /**
  94    * Registers this instance as an autoloader.
  95    *
  96    * @param bool $prepend
  97    *   Whether to prepend the autoloader or not.
  98    *
  99    * @api
 100    */
 101   public function register($prepend = FALSE) {
 102     if ($this->_registered) {
 103       return;
 104     }
 105     $civicrm_base_path = dirname(dirname(__DIR__));
 106
 107     // @todo: need some way to check if we should register vendor or not
 108     //require_once dirname(dirname(__DIR__)) . '/vendor/autoload.php';
 109
 110     // we do this to prevent a autoloader errors with joomla / 3rd party packages
 111     // use absolute path since we dont know the content of include_path as yet
 112     // CRM-11304
 113     // TODO Remove this autoloader. For civicrm-core and civicrm-packages, the composer autoloader works fine.
 114     // Extensions rely on include_path-based autoloading
 115     spl_autoload_register(array($this, 'loadClass'), TRUE, $prepend);
 116     $this->initHtmlPurifier($prepend);
 117
 118     $this->_registered = TRUE;
 119     $packages_path = implode(DIRECTORY_SEPARATOR, array($civicrm_base_path, 'packages'));
 120     $include_paths = array(
 121       '.',
 122       $civicrm_base_path,
 123       $packages_path,
 124     );
 125     $include_paths = implode(PATH_SEPARATOR, $include_paths);
 126     set_include_path($include_paths . PATH_SEPARATOR . get_include_path());
 127     // @todo: need some way to check if we should register vendor or not
 128     //require_once "$civicrm_base_path/vendor/autoload.php";
 129   }
 130
 131   /**
 132    * Initialize HTML purifier class.
 133    *
 134    * @param string $prepend
 135    */
 136   public function initHtmlPurifier($prepend) {
 137     if (class_exists('HTMLPurifier_Bootstrap')) {
 138       // HTMLPurifier is already initialized, e.g. by the Drupal module.
 139       return;
 140     }
 141
 142     $htmlPurifierPath = $this->getHtmlPurifierPath();
 143
 144     if (FALSE === $htmlPurifierPath) {
 145       // No HTMLPurifier available, e.g. during installation.
 146       return;
 147     }
 148     require_once $htmlPurifierPath;
 149     spl_autoload_register(array('HTMLPurifier_Bootstrap', 'autoload'), TRUE, $prepend);
 150   }
 151
 152   /**
 153    * @return string|false
 154    *   Path to the file where the class HTMLPurifier_Bootstrap is defined, or
 155    *   FALSE, if such a file does not exist.
 156    */
 157   private function getHtmlPurifierPath() {
 158     if (function_exists('libraries_get_path')
 159       && ($path = libraries_get_path('htmlpurifier'))
 160       && file_exists($file = $path . '/library/HTMLPurifier/Bootstrap.php')
 161     ) {
 162       // We are in Drupal 7, and the HTMLPurifier module is installed.
 163       // Use Drupal's HTMLPurifier path, to avoid conflicts.
 164       // @todo Verify that we are really in Drupal 7, and not in some other
 165       // environment that happens to provide a 'libraries_get_path()' function.
 166       return $file;
 167     }
 168
 169     // we do this to prevent a autoloader errors with joomla / 3rd party packages
 170     // Use absolute path, since we don't know the content of include_path yet.
 171     // CRM-11304
 172     $file = dirname(__FILE__) . '/../../packages/IDS/vendors/htmlpurifier/HTMLPurifier/Bootstrap.php';
 173     if (file_exists($file)) {
 174       return $file;
 175     }
 176
 177     return FALSE;
 178   }
 179
 180   /**
 181    * @param $class
 182    */
 183   public function loadClass($class) {
 184     if (
 185       // Only load classes that clearly belong to CiviCRM.
 186       // Note: api/v3 does not use classes, but api_v3's test-suite does
 187       (0 === strncmp($class, 'CRM_', 4) || 0 === strncmp($class, 'api_v3_', 7) || 0 === strncmp($class, 'WebTest_', 8) || 0 === strncmp($class, 'E2E_', 4)) &&
 188       // Do not load PHP 5.3 namespaced classes.
 189       // (in a future version, maybe)
 190       FALSE === strpos($class, '\\')
 191     ) {
 192       $file = strtr($class, '_', '/') . '.php';
 193       // There is some question about the best way to do this.
 194       // "require_once" is nice because it's simple and throws
 195       // intelligible errors.
 196       if (FALSE != stream_resolve_include_path($file)) {
 197         require_once $file;
 198       }
 199     }
 200     elseif (in_array($class, $this->civiTestClasses)) {
 201       $file = "tests/phpunit/CiviTest/{$class}.php";
 202       if (FALSE != stream_resolve_include_path($file)) {
 203         require_once $file;
 204       }
 205     }
 206     elseif ($class === 'CiviSeleniumSettings') {
 207       if (!empty($GLOBALS['_CV'])) {
 208         require_once 'tests/phpunit/CiviTest/CiviSeleniumSettings.auto.php';
 209       }
 210       elseif (CRM_Utils_File::isIncludable('tests/phpunit/CiviTest/CiviSeleniumSettings.php')) {
 211         require_once 'tests/phpunit/CiviTest/CiviSeleniumSettings.php';
 212       }
 213     }
 214   }
 215
 216 }