CRM/Extension/System.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  * This class glues together the various parts of the extension
  30  * system.
  31  *
  32  * @package CRM
  33  * @copyright CiviCRM LLC (c) 2004-2014
  34  * $Id$
  35  *
  36  */
  37 class CRM_Extension_System {
  38   private static $singleton;
  39
  40   private $cache = NULL;
  41   private $fullContainer = NULL;
  42   private $defaultContainer = NULL;
  43   private $mapper = NULL;
  44   private $manager = NULL;
  45   private $browser = NULL;
  46   private $downloader = NULL;
  47
  48   /**
  49    * The URL of the remote extensions repository
  50    *
  51    * @var string|FALSE
  52    */
  53   private $_repoUrl = NULL;
  54
  55   /**
  56    * @param bool $fresh
  57    *
  58    * @return CRM_Extension_System
  59    */
  60   public static function singleton($fresh = FALSE) {
  61     if (! self::$singleton || $fresh) {
  62       if (self::$singleton) {
  63         self::$singleton = new CRM_Extension_System(self::$singleton->parameters);
  64       }
  65       else {
  66         self::$singleton = new CRM_Extension_System();
  67       }
  68     }
  69     return self::$singleton;
  70   }
  71
  72   /**
  73    * @param CRM_Extension_System $singleton
  74    */
  75   public static function setSingleton(CRM_Extension_System $singleton) {
  76     self::$singleton = $singleton;
  77   }
  78
  79   /**
  80    * @param array $parameters
  81    */
  82   public function __construct($parameters = array()) {
  83     $config = CRM_Core_Config::singleton();
  84     if (!array_key_exists('extensionsDir', $parameters)) {
  85       $parameters['extensionsDir'] = $config->extensionsDir;
  86     }
  87     if (!array_key_exists('extensionsURL', $parameters)) {
  88       $parameters['extensionsURL'] = $config->extensionsURL;
  89     }
  90     $this->parameters = $parameters;
  91   }
  92
  93   /**
  94    * Get a container which represents all available extensions
  95    *
  96    * @return CRM_Extension_Container_Interface
  97    */
  98   public function getFullContainer() {
  99     if ($this->fullContainer === NULL) {
 100       $containers = array();
 101
 102       if ($this->getDefaultContainer()) {
 103         $containers['default'] = $this->getDefaultContainer();
 104       }
 105
 106       $config = CRM_Core_Config::singleton();
 107       global $civicrm_root;
 108       $containers['civiroot']  = new CRM_Extension_Container_Basic($civicrm_root, $config->resourceBase, $this->getCache(), 'civiroot');
 109
 110       // TODO: CRM_Extension_Container_Basic( /sites/all/modules )
 111       // TODO: CRM_Extension_Container_Basic( /sites/$domain/modules
 112       // TODO: CRM_Extension_Container_Basic( /modules )
 113       // TODO: CRM_Extension_Container_Basic( /vendors )
 114
 115       // At time of writing, D6, D7, and WP support cmsRootPath() but J does not
 116       $cmsRootPath = $config->userSystem->cmsRootPath();
 117       if (NULL !== $cmsRootPath) {
 118         $vendorPath = $cmsRootPath . DIRECTORY_SEPARATOR . 'vendor';
 119         if (is_dir($vendorPath)) {
 120           $containers['cmsvendor'] = new CRM_Extension_Container_Basic($vendorPath, $config->userFrameworkBaseURL  . DIRECTORY_SEPARATOR . 'vendor', $this->getCache(), 'cmsvendor');
 121         }
 122       }
 123
 124       $this->fullContainer = new CRM_Extension_Container_Collection($containers, $this->getCache(), 'full');
 125     }
 126     return $this->fullContainer;
 127   }
 128
 129   /**
 130    * Get the container to which new extensions are installed
 131    *
 132    * This container should be a particular, writeable directory.
 133    *
 134    * @return CRM_Extension_Container_Default|FALSE (false if not configured)
 135    */
 136   public function getDefaultContainer() {
 137     if ($this->defaultContainer === NULL) {
 138       if ($this->parameters['extensionsDir']) {
 139         $this->defaultContainer = new CRM_Extension_Container_Default($this->parameters['extensionsDir'], $this->parameters['extensionsURL'], $this->getCache(), 'default');
 140       }
 141       else {
 142         $this->defaultContainer = FALSE;
 143       }
 144     }
 145     return $this->defaultContainer;
 146   }
 147
 148   /**
 149    * Get the service which provides runtime information about extensions
 150    *
 151    * @return CRM_Extension_Mapper
 152    */
 153   public function getMapper() {
 154     if ($this->mapper === NULL) {
 155       $this->mapper = new CRM_Extension_Mapper($this->getFullContainer(), $this->getCache(), 'mapper');
 156     }
 157     return $this->mapper;
 158   }
 159
 160   /**
 161    * Get the service for enabling and disabling extensions
 162    *
 163    * @return CRM_Extension_Manager
 164    */
 165   public function getManager() {
 166     if ($this->manager === NULL) {
 167       $typeManagers = array(
 168         'payment' => new CRM_Extension_Manager_Payment($this->getMapper()),
 169         'report' => new CRM_Extension_Manager_Report(),
 170         'search' => new CRM_Extension_Manager_Search(),
 171         'module' => new CRM_Extension_Manager_Module($this->getMapper()),
 172       );
 173       $this->manager = new CRM_Extension_Manager($this->getFullContainer(), $this->getDefaultContainer(), $this->getMapper(), $typeManagers);
 174     }
 175     return $this->manager;
 176   }
 177
 178   /**
 179    * Get the service for finding remotely-available extensions
 180    *
 181    * @return CRM_Extension_Browser
 182    */
 183   public function getBrowser() {
 184     if ($this->browser === NULL) {
 185       $cacheDir = NULL;
 186       if ($this->getDefaultContainer()) {
 187         $cacheDir = $this->getDefaultContainer()->getBaseDir() . DIRECTORY_SEPARATOR . 'cache';
 188       }
 189       $this->browser = new CRM_Extension_Browser($this->getRepositoryUrl(), '', $cacheDir);
 190     }
 191     return $this->browser;
 192   }
 193
 194   /**
 195    * Get the service for loading code from remotely-available extensions
 196    *
 197    * @return CRM_Extension_Downloader
 198    */
 199   public function getDownloader() {
 200     if ($this->downloader === NULL) {
 201       $basedir = ($this->getDefaultContainer() ? $this->getDefaultContainer()->getBaseDir() : NULL);
 202       $this->downloader = new CRM_Extension_Downloader(
 203         $this->getManager(),
 204         $basedir,
 205         CRM_Utils_File::tempdir() // WAS: $config->extensionsDir . DIRECTORY_SEPARATOR . 'tmp';
 206       );
 207     }
 208     return $this->downloader;
 209   }
 210
 211   /**
 212    * @return CRM_Utils_Cache_Interface
 213    */
 214   public function getCache() {
 215     if ($this->cache === NULL) {
 216       if (defined('CIVICRM_DSN')) {
 217         $this->cache = new CRM_Utils_Cache_SqlGroup(array(
 218           'group' => 'ext',
 219           'prefetch' => TRUE,
 220         ));
 221       }
 222       else {
 223         $this->cache = new CRM_Utils_Cache_ArrayCache(array());
 224       }
 225     }
 226     return $this->cache;
 227   }
 228
 229   /**
 230    * Determine the URL which provides a feed of available extensions
 231    *
 232    * @return string|FALSE
 233    */
 234   public function getRepositoryUrl() {
 235     if (empty($this->_repoUrl) && $this->_repoUrl !== FALSE) {
 236       $config = CRM_Core_Config::singleton();
 237       $url = CRM_Core_BAO_Setting::getItem('Extension Preferences', 'ext_repo_url', NULL, CRM_Extension_Browser::DEFAULT_EXTENSIONS_REPOSITORY);
 238
 239       // boolean false means don't try to check extensions
 240       // http://issues.civicrm.org/jira/browse/CRM-10575
 241       if ($url === FALSE) {
 242         $this->_repoUrl = FALSE;
 243       }
 244       else {
 245         $this->_repoUrl = CRM_Utils_System::evalUrl($url);
 246       }
 247     }
 248     return $this->_repoUrl;
 249   }
 250 }