CRM-15626 fixes - Relationship Create Widget Not always showing the correct available...

[civicrm-core.git] / CRM / Core / ClassLoader.php

diff --git a/CRM/Core/ClassLoader.php b/CRM/Core/ClassLoader.php
index 79279479409a696156ef406ed31c1ad7ebe30fdc..46ed87ae1e5aa02cb52c54b141cdb2507d1249df 100644 (file)
--- a/CRM/Core/ClassLoader.php
+++ b/CRM/Core/ClassLoader.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -29,7 +29,7 @@
  *
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -43,6 +43,11 @@ class CRM_Core_ClassLoader {
    */
   private static $_singleton = NULL;
 
+  /**
+   * @param bool $force
+   *
+   * @return object
+   */
   static function &singleton($force = FALSE) {
     if ($force || self::$_singleton === NULL) {
       self::$_singleton = new CRM_Core_ClassLoader();
@@ -55,6 +60,9 @@ class CRM_Core_ClassLoader {
    */
   protected $_registered;
 
+  /**
+   *
+   */
   protected function __construct() {
     $this->_registered = FALSE;
   }
@@ -70,50 +78,82 @@ class CRM_Core_ClassLoader {
     if ($this->_registered) {
       return;
     }
+    $civicrm_base_path = dirname(dirname(__DIR__));
+
+    require_once dirname(dirname(__DIR__)) . '/packages/vendor/autoload.php';
 
     // we do this to prevent a autoloader errors with joomla / 3rd party packages
     // use absolute path since we dont know the content of include_path as yet
     // CRM-11304
+    // TODO Remove this autoloader. For civicrm-core and civicrm-packages, the composer autoloader works fine.
+    // Extensions rely on include_path-based autoloading
+    spl_autoload_register(array($this, 'loadClass'), TRUE, $prepend);
+    $this->initHtmlPurifier($prepend);
 
-    // since HTML Purifier could potentially be loaded / used by other modules / components
-    // lets check it its already loaded
-    // we also check if the bootstrap file exists since during install of a drupal distro profile
-    // the files might not exists, in which case we skip loading the file
-    // if you change the below, please test on Joomla and also PCP pages
-    $includeHTMLPurifier = TRUE;
-    $htmlPurifierPath = dirname(__FILE__) . '/../../packages/IDS/vendors/htmlpurifier/HTMLPurifier/Bootstrap.php';
-    if (
-      class_exists('HTMLPurifier_Bootstrap') ||
-      !file_exists($htmlPurifierPath)
-    ) {
-      $includeHTMLPurifier = FALSE;
+    $this->_registered = TRUE;
+    $packages_path = implode(DIRECTORY_SEPARATOR, array($civicrm_base_path, 'packages'));
+    $include_paths = array(
+      '.',
+      $civicrm_base_path,
+      $packages_path
+    );
+    $include_paths = implode(PATH_SEPARATOR, $include_paths);
+    set_include_path($include_paths . PATH_SEPARATOR . get_include_path());
+    require_once "$civicrm_base_path/packages/vendor/autoload.php";
+  }
+
+  function initHtmlPurifier($prepend) {
+    if (class_exists('HTMLPurifier_Bootstrap')) {
+      // HTMLPurifier is already initialized, e.g. by the Drupal module.
+      return;
     }
-    else {
-      require_once $htmlPurifierPath;
+
+    $htmlPurifierPath = $this->getHtmlPurifierPath();
+
+    if (FALSE === $htmlPurifierPath) {
+      // No HTMLPurifier available, e.g. during installation.
+      return;
     }
+    require_once $htmlPurifierPath;
+    spl_autoload_register(array('HTMLPurifier_Bootstrap', 'autoload'), TRUE, $prepend);
+  }
 
-    if (version_compare(PHP_VERSION, '5.3.0') >= 0) {
-      spl_autoload_register(array($this, 'loadClass'), TRUE, $prepend);
-      if ($includeHTMLPurifier) {
-        spl_autoload_register(array('HTMLPurifier_Bootstrap', 'autoload'), TRUE, $prepend);
-      }
+  /**
+   * @return string|false
+   *   Path to the file where the class HTMLPurifier_Bootstrap is defined, or
+   *   FALSE, if such a file does not exist.
+   */
+  private function getHtmlPurifierPath() {
+    if (function_exists('libraries_get_path')
+      && ($path = libraries_get_path('htmlpurifier'))
+      && file_exists($file = $path . '/library/HTMLPurifier/Bootstrap.php')
+    ) {
+      // We are in Drupal 7, and the HTMLPurifier module is installed.
+      // Use Drupal's HTMLPurifier path, to avoid conflicts.
+      // @todo Verify that we are really in Drupal 7, and not in some other
+      // environment that happens to provide a 'libraries_get_path()' function.
+      return $file;
     }
-    else {
-      // http://www.php.net/manual/de/function.spl-autoload-register.php#107362
-      // "when specifying the third parameter (prepend), the function will fail badly in PHP 5.2"
-      spl_autoload_register(array($this, 'loadClass'), TRUE);
-      if ($includeHTMLPurifier) {
-        spl_autoload_register(array('HTMLPurifier_Bootstrap', 'autoload'), TRUE);
-      }
+
+    // we do this to prevent a autoloader errors with joomla / 3rd party packages
+    // Use absolute path, since we don't know the content of include_path yet.
+    // CRM-11304
+    $file = dirname(__FILE__) . '/../../packages/IDS/vendors/htmlpurifier/HTMLPurifier/Bootstrap.php';
+    if (file_exists($file)) {
+      return $file;
     }
 
-    $this->_registered = TRUE;
+    return FALSE;
   }
 
+  /**
+   * @param $class
+   */
   function loadClass($class) {
     if (
       // Only load classes that clearly belong to CiviCRM.
-      0 === strncmp($class, 'CRM_', 4) &&
+      // Note: api/v3 does not use classes, but api_v3's test-suite does
+      (0 === strncmp($class, 'CRM_', 4) || 0 === strncmp($class, 'api_v3_', 7) || 0 === strncmp($class, 'WebTest_', 8)) &&
       // Do not load PHP 5.3 namespaced classes.
       // (in a future version, maybe)
       FALSE === strpos($class, '\\')
@@ -127,4 +167,3 @@ class CRM_Core_ClassLoader {
     }
   }
 }
-