3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This class glues together the various parts of the extension
33 * @copyright CiviCRM LLC (c) 2004-2013
37 class CRM_Extension_System
{
38 private static $singleton;
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;
49 * The URL of the remote extensions repository
53 private $_repoUrl = NULL;
56 * @return CRM_Extension_System
58 public static function singleton($fresh = FALSE) {
59 if (! self
::$singleton ||
$fresh) {
60 if (self
::$singleton) {
61 self
::$singleton = new CRM_Extension_System(self
::$singleton->parameters
);
63 self
::$singleton = new CRM_Extension_System();
66 return self
::$singleton;
69 public static function setSingleton(CRM_Extension_System
$singleton) {
70 self
::$singleton = $singleton;
73 public function __construct($parameters = array()) {
74 $config = CRM_Core_Config
::singleton();
75 if (!array_key_exists('extensionsDir', $parameters)) {
76 $parameters['extensionsDir'] = $config->extensionsDir
;
78 if (!array_key_exists('extensionsURL', $parameters)) {
79 $parameters['extensionsURL'] = $config->extensionsURL
;
81 $this->parameters
= $parameters;
85 * Get a container which represents all available extensions
87 * @return CRM_Extension_Container_Interface
89 public function getFullContainer() {
90 if ($this->fullContainer
=== NULL) {
91 $containers = array();
93 if ($this->getDefaultContainer()) {
94 $containers['default'] = $this->getDefaultContainer();
97 $config = CRM_Core_Config
::singleton();
99 $containers['civiroot'] = new CRM_Extension_Container_Basic($civicrm_root, $config->resourceBase
, $this->getCache(), 'civiroot');
101 // TODO: CRM_Extension_Container_Basic( /sites/all/modules )
102 // TODO: CRM_Extension_Container_Basic( /sites/$domain/modules
103 // TODO: CRM_Extension_Container_Basic( /modules )
104 // TODO: CRM_Extension_Container_Basic( /vendors )
106 // At time of writing, D6, D7, and WP support cmsRootPath() but J does not
107 $cmsRootPath = $config->userSystem
->cmsRootPath();
108 if (NULL !== $cmsRootPath) {
109 $vendorPath = $cmsRootPath . DIRECTORY_SEPARATOR
. 'vendor';
110 if (is_dir($vendorPath)) {
111 $containers['cmsvendor'] = new CRM_Extension_Container_Basic($vendorPath, $config->userFrameworkBaseURL
. DIRECTORY_SEPARATOR
. 'vendor', $this->getCache(), 'cmsvendor');
115 $this->fullContainer
= new CRM_Extension_Container_Collection($containers, $this->getCache(), 'full');
117 return $this->fullContainer
;
121 * Get the container to which new extensions are installed
123 * This container should be a particular, writeable directory.
125 * @return CRM_Extension_Container_Default|FALSE (false if not configured)
127 public function getDefaultContainer() {
128 if ($this->defaultContainer
=== NULL) {
129 if ($this->parameters
['extensionsDir']) {
130 $this->defaultContainer
= new CRM_Extension_Container_Default($this->parameters
['extensionsDir'], $this->parameters
['extensionsURL'], $this->getCache(), 'default');
132 $this->defaultContainer
= FALSE;
135 return $this->defaultContainer
;
139 * Get the service which provides runtime information about extensions
141 * @return CRM_Extension_Mapper
143 public function getMapper() {
144 if ($this->mapper
=== NULL) {
145 $this->mapper
= new CRM_Extension_Mapper($this->getFullContainer(), $this->getCache(), 'mapper');
147 return $this->mapper
;
151 * Get the service for enabling and disabling extensions
153 * @return CRM_Extension_Manager
155 public function getManager() {
156 if ($this->manager
=== NULL) {
157 $typeManagers = array(
158 'payment' => new CRM_Extension_Manager_Payment($this->getMapper()),
159 'report' => new CRM_Extension_Manager_Report(),
160 'search' => new CRM_Extension_Manager_Search(),
161 'module' => new CRM_Extension_Manager_Module($this->getMapper()),
163 $this->manager
= new CRM_Extension_Manager($this->getFullContainer(), $this->getDefaultContainer(), $this->getMapper(), $typeManagers);
165 return $this->manager
;
169 * Get the service for finding remotely-available extensions
171 * @return CRM_Extension_Browser
173 public function getBrowser() {
174 if ($this->browser
=== NULL) {
176 if ($this->getDefaultContainer()) {
177 $cacheDir = $this->getDefaultContainer()->getBaseDir() . DIRECTORY_SEPARATOR
. 'cache';
179 $this->browser
= new CRM_Extension_Browser($this->getRepositoryUrl(), '', $cacheDir);
181 return $this->browser
;
185 * Get the service for loading code from remotely-available extensions
187 * @return CRM_Extension_Downloader
189 public function getDownloader() {
190 if ($this->downloader
=== NULL) {
191 $basedir = ($this->getDefaultContainer() ?
$this->getDefaultContainer()->getBaseDir() : NULL);
192 $this->downloader
= new CRM_Extension_Downloader(
195 CRM_Utils_File
::tempdir() // WAS: $config->extensionsDir . DIRECTORY_SEPARATOR . 'tmp';
198 return $this->downloader
;
202 * @return CRM_Utils_Cache_Interface
204 public function getCache() {
205 if ($this->cache
=== NULL) {
206 if (defined('CIVICRM_DSN')) {
207 $this->cache
= new CRM_Utils_Cache_SqlGroup(array(
212 $this->cache
= new CRM_Utils_Cache_ArrayCache(array());
219 * Determine the URL which provides a feed of available extensions
221 * @return string|FALSE
223 public function getRepositoryUrl() {
224 if (empty($this->_repoUrl
) && $this->_repoUrl
!== FALSE) {
225 $config = CRM_Core_Config
::singleton();
226 $url = CRM_Core_BAO_Setting
::getItem('Extension Preferences', 'ext_repo_url', NULL, CRM_Extension_Browser
::DEFAULT_EXTENSIONS_REPOSITORY
);
228 // boolean false means don't try to check extensions
229 // http://issues.civicrm.org/jira/browse/CRM-10575
231 $this->_repoUrl
= false;
234 $this->_repoUrl
= CRM_Utils_System
::evalUrl($url);
237 return $this->_repoUrl
;