3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
16 * @copyright CiviCRM LLC https://civicrm.org/licensing
18 class CRM_Core_ClassLoader
{
21 * We only need one instance of this object. So we use the singleton
22 * pattern and cache the instance in this variable
25 private static $_singleton = NULL;
28 * The classes in CiviTest have ucky, non-standard naming.
31 * Array(string $className => string $filePath).
33 private $civiTestClasses;
40 public static function &singleton($force = FALSE) {
41 if ($force || self
::$_singleton === NULL) {
42 self
::$_singleton = new CRM_Core_ClassLoader();
44 return self
::$_singleton;
48 * Has this been registered already.
52 protected $_registered;
57 protected function __construct() {
58 $this->_registered
= FALSE;
59 $this->civiTestClasses
= [
64 'CiviSeleniumTestCase',
67 'CiviEndToEndTestCase',
79 * Requires the autoload.php generated by composer
83 protected function requireComposerAutoload() {
84 // We are trying to locate 'vendor/autoload.php'. When installing CiviCRM
85 // manually from the built tarball, that will be two directories up in the
86 // civicrm-core directory. However, if civicrm-core was installed via
87 // composer as a library, that'll be 5 directories up where composer was
88 // run (ex. the Drupal root on a Drupal 8 site).
89 $civicrm_base_path = dirname(dirname(__DIR__
));
90 $top_path = dirname(dirname(dirname(dirname(dirname(__DIR__
)))));
92 if (file_exists($civicrm_base_path . '/vendor/autoload.php')) {
93 require_once $civicrm_base_path . '/vendor/autoload.php';
95 elseif (file_exists($top_path . '/vendor/autoload.php')) {
96 require_once $top_path . '/vendor/autoload.php';
101 * Registers this instance as an autoloader.
103 * @param bool $prepend
104 * Whether to prepend the autoloader or not.
108 public function register($prepend = FALSE) {
109 if ($this->_registered
) {
112 $civicrm_base_path = dirname(dirname(__DIR__
));
114 $this->requireComposerAutoload();
116 // we do this to prevent a autoloader errors with joomla / 3rd party packages
117 // use absolute path since we dont know the content of include_path as yet
119 // TODO Remove this autoloader. For civicrm-core and civicrm-packages, the composer autoloader works fine.
120 // Extensions rely on include_path-based autoloading
121 spl_autoload_register([$this, 'loadClass'], TRUE, $prepend);
122 $this->initHtmlPurifier($prepend);
124 $this->_registered
= TRUE;
125 // The ClassLoader runs before the classes are available. Approximate Civi::paths()->get('[civicrm.packages]').
126 if (isset($GLOBALS['civicrm_paths']['civicrm.packages']['path'])) {
127 $packages_path = rtrim($GLOBALS['civicrm_paths']['civicrm.packages']['path'], DIRECTORY_SEPARATOR
);
130 $packages_path = implode(DIRECTORY_SEPARATOR
, [$civicrm_base_path, 'packages']);
137 $include_paths = implode(PATH_SEPARATOR
, $include_paths);
138 set_include_path($include_paths . PATH_SEPARATOR
. get_include_path());
139 // @todo Why do we need to load this again?
140 $this->requireComposerAutoload();
144 * Initialize HTML purifier class.
146 * @param string $prepend
148 public function initHtmlPurifier($prepend) {
149 if (class_exists('HTMLPurifier_Bootstrap')) {
150 // HTMLPurifier is already initialized, e.g. by the Drupal module.
154 $htmlPurifierPath = $this->getHtmlPurifierPath();
156 if (FALSE === $htmlPurifierPath) {
157 // No HTMLPurifier available, e.g. during installation.
160 require_once $htmlPurifierPath;
161 spl_autoload_register(['HTMLPurifier_Bootstrap', 'autoload'], TRUE, $prepend);
165 * @return string|false
166 * Path to the file where the class HTMLPurifier_Bootstrap is defined, or
167 * FALSE, if such a file does not exist.
169 private function getHtmlPurifierPath() {
170 if (function_exists('libraries_get_path')
171 && ($path = libraries_get_path('htmlpurifier'))
172 && file_exists($file = $path . '/library/HTMLPurifier/Bootstrap.php')
174 // We are in Drupal 7, and the HTMLPurifier module is installed.
175 // Use Drupal's HTMLPurifier path, to avoid conflicts.
176 // @todo Verify that we are really in Drupal 7, and not in some other
177 // environment that happens to provide a 'libraries_get_path()' function.
181 // we do this to prevent a autoloader errors with joomla / 3rd party packages
182 // Use absolute path, since we don't know the content of include_path yet.
184 if (isset($GLOBALS['civicrm_paths']['civicrm.packages']['path'])) {
185 $file = rtrim($GLOBALS['civicrm_paths']['civicrm.packages']['path'], DIRECTORY_SEPARATOR
) . '/IDS/vendors/htmlpurifier/HTMLPurifier/Bootstrap.php';
188 $file = dirname(__FILE__
) . '/../../packages/IDS/vendors/htmlpurifier/HTMLPurifier/Bootstrap.php';
190 if (file_exists($file)) {
200 public function loadClass($class) {
201 if ($class === 'CiviCRM_API3_Exception' ||
$class === 'API_Exception') {
202 //call internal error class api/Exception first
203 // allow api/Exception class call external error class
204 // CiviCRM_API3_Exception
205 require_once 'api/Exception.php';
208 // Only load classes that clearly belong to CiviCRM.
209 // Note: api/v3 does not use classes, but api_v3's test-suite does
210 (0 === strncmp($class, 'CRM_', 4) ||
0 === strncmp($class, 'CRMTraits', 9) ||
0 === strncmp($class, 'api_v3_', 7) ||
0 === strncmp($class, 'WebTest_', 8) ||
0 === strncmp($class, 'E2E_', 4)) &&
211 // Do not load PHP 5.3 namespaced classes.
212 // (in a future version, maybe)
213 FALSE === strpos($class, '\\')
215 $file = strtr($class, '_', '/') . '.php';
216 // There is some question about the best way to do this.
217 // "require_once" is nice because it's simple and throws
218 // intelligible errors.
219 if (FALSE != stream_resolve_include_path($file)) {
223 elseif (in_array($class, $this->civiTestClasses
)) {
224 $file = "tests/phpunit/CiviTest/{$class}.php";
225 if (FALSE != stream_resolve_include_path($file)) {
229 elseif ($class === 'CiviSeleniumSettings') {
230 if (!empty($GLOBALS['_CV'])) {
231 require_once 'tests/phpunit/CiviTest/CiviSeleniumSettings.auto.php';
233 elseif (CRM_Utils_File
::isIncludable('tests/phpunit/CiviTest/CiviSeleniumSettings.php')) {
234 require_once 'tests/phpunit/CiviTest/CiviSeleniumSettings.php';