3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
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 is a part of CiviCRM extension management functionality.
32 * @copyright CiviCRM LLC (c) 2004-2013
38 * This page displays the list of extensions registered in the system.
40 class CRM_Admin_Page_Extensions
extends CRM_Core_Page_Basic
{
43 * The action links that we need to display for the browse screen
48 static $_links = NULL;
51 * Obtains the group name from url and sets the title.
57 function preProcess() {
58 CRM_Utils_System
::setTitle(ts('CiviCRM Extensions'));
59 $destination = CRM_Utils_System
::url( 'civicrm/admin/extensions',
62 $destination = urlencode( $destination );
63 $this->assign( 'destination', $destination );
69 * @return string Classname of BAO.
71 function getBAOName() {
72 return 'CRM_Core_BAO_Extension';
78 * @return array (reference) of action links
81 if (!(self
::$_links)) {
82 self
::$_links = array(
83 CRM_Core_Action
::ADD
=> array(
84 'name' => ts('Install'),
85 'url' => 'civicrm/admin/extensions',
86 'qs' => 'action=add&id=%%id%%&key=%%key%%',
87 'title' => ts('Install'),
89 CRM_Core_Action
::ENABLE
=> array(
90 'name' => ts('Enable'),
91 'url' => 'civicrm/admin/extensions',
92 'qs' => 'action=enable&id=%%id%%&key=%%key%%',
93 'ref' => 'enable-action',
94 'title' => ts('Enable'),
96 CRM_Core_Action
::DISABLE
=> array(
97 'name' => ts('Disable'),
98 'url' => 'civicrm/admin/extensions',
99 'qs' => 'action=disable&id=%%id%%&key=%%key%%',
100 'ref' => 'disable-action',
101 'title' => ts('Disable'),
103 CRM_Core_Action
::DELETE
=> array(
104 'name' => ts('Uninstall'),
105 'url' => 'civicrm/admin/extensions',
106 'qs' => 'action=delete&id=%%id%%&key=%%key%%',
107 'title' => ts('Uninstall Extension'),
109 CRM_Core_Action
::UPDATE
=> array(
110 'name' => ts('Download'),
111 'url' => 'civicrm/admin/extensions',
112 'qs' => 'action=update&id=%%id%%&key=%%key%%',
113 'title' => ts('Download Extension'),
117 return self
::$_links;
121 * Run the basic page (run essentially starts execution for that page).
127 return parent
::run();
139 $mapper = CRM_Extension_System
::singleton()->getMapper();
140 $manager = CRM_Extension_System
::singleton()->getManager();
142 // build announcements at the top of the page
143 $this->assign('extAddNewEnabled', CRM_Extension_System
::singleton()->getBrowser()->isEnabled());
144 $reqs = CRM_Extension_System
::singleton()->getDownloader()->checkRequirements();
146 $reqs = CRM_Extension_System
::singleton()->getBrowser()->checkRequirements();
149 $reqs = CRM_Extension_System
::singleton()->getDefaultContainer()->checkRequirements();
151 $this->assign('extAddNewReqs', $reqs);
153 $this->assign('extDbUpgrades', CRM_Extension_Upgrades
::hasPending());
154 $this->assign('extDbUpgradeUrl', CRM_Utils_System
::url('civicrm/admin/extensions/upgrade', 'reset=1'));
156 // TODO: Debate whether to immediately detect changes in underlying source tree
157 // $manager->refresh();
159 // build list of local extensions
160 $localExtensionRows = array(); // array($pseudo_id => extended_CRM_Extension_Info)
161 $keys = array_keys($manager->getStatuses());
163 foreach($keys as $key) {
165 $obj = $mapper->keyToInfo($key);
166 } catch (CRM_Extension_Exception
$ex) {
167 CRM_Core_Session
::setStatus(ts('Failed to read extension (%1). Please refresh the extension list.', array(1 => $key)));
171 $row = self
::createExtendedInfo($obj);
172 $row['id'] = $obj->key
;
176 switch ($row['status']) {
177 case CRM_Extension_Manager
::STATUS_UNINSTALLED
:
178 $action +
= CRM_Core_Action
::ADD
;
180 case CRM_Extension_Manager
::STATUS_DISABLED
:
181 $action +
= CRM_Core_Action
::ENABLE
;
182 $action +
= CRM_Core_Action
::DELETE
;
184 case CRM_Extension_Manager
::STATUS_DISABLED_MISSING
:
185 $action +
= CRM_Core_Action
::DELETE
;
187 case CRM_Extension_Manager
::STATUS_INSTALLED
:
188 case CRM_Extension_Manager
::STATUS_INSTALLED_MISSING
:
189 $action +
= CRM_Core_Action
::DISABLE
;
193 // TODO if extbrowser is enabled and extbrowser has newer version than extcontainer,
194 // then $action += CRM_Core_Action::UPDATE
195 $row['action'] = CRM_Core_Action
::formLink(self
::links(),
203 'extension.local.action',
207 // Key would be better to send, but it's not an integer. Moreover, sending the
208 // values to hook_civicrm_links means that you can still get at the key
210 $localExtensionRows[$row['id']] = $row;
212 $this->assign('localExtensionRows', $localExtensionRows);
214 // build list of availabe downloads
215 $remoteExtensionRows = array();
216 foreach (CRM_Extension_System
::singleton()->getBrowser()->getExtensions() as $info) {
217 $row = (array) $info;
218 $row['id'] = $info->key
;
219 $action = CRM_Core_Action
::UPDATE
;
220 $row['action'] = CRM_Core_Action
::formLink(self
::links(),
224 'key' => $row['key'],
228 'extension.remote.action',
232 if (isset($localExtensionRows[$info->key
])) {
233 if (version_compare($localExtensionRows[$info->key
]['version'], $info->version
, '<')) {
234 $row['is_upgradeable'] = TRUE;
237 $remoteExtensionRows[$row['id']] = $row;
239 $this->assign('remoteExtensionRows', $remoteExtensionRows);
243 * Get name of edit form
245 * @return string Classname of edit form.
247 function editForm() {
248 return 'CRM_Admin_Form_Extensions';
254 * @return string name of this page.
256 function editName() {
257 return 'CRM_Admin_Form_Extensions';
263 * @return string user context.
265 function userContext($mode = NULL) {
266 return 'civicrm/admin/extensions';
270 * function to get userContext params
272 * @param int $mode mode that we are in
277 function userContextParams($mode = NULL) {
278 return 'reset=1&action=browse';
282 * Take an extension's raw XML info and add information about the
283 * extension's status on the local system.
285 * The result format resembles the old CRM_Core_Extensions_Extension.
289 public static function createExtendedInfo(CRM_Extension_Info
$obj) {
290 $mapper = CRM_Extension_System
::singleton()->getMapper();
291 $manager = CRM_Extension_System
::singleton()->getManager();
293 $extensionRow = (array) $obj;
295 $extensionRow['path'] = $mapper->keyToBasePath($obj->key
);
296 } catch (CRM_Extension_Exception
$e) {
297 $extensionRow['path'] = '';
299 $extensionRow['status'] = $manager->getStatus($obj->key
);
301 switch ($extensionRow['status']) {
302 case CRM_Extension_Manager
::STATUS_UNINSTALLED
:
303 $extensionRow['statusLabel'] = ''; // ts('Uninstalled');
305 case CRM_Extension_Manager
::STATUS_DISABLED
:
306 $extensionRow['statusLabel'] = ts('Disabled');
308 case CRM_Extension_Manager
::STATUS_INSTALLED
:
309 $extensionRow['statusLabel'] = ts('Enabled'); // ts('Installed');
311 case CRM_Extension_Manager
::STATUS_DISABLED_MISSING
:
312 $extensionRow['statusLabel'] = ts('Disabled (Missing)');
314 case CRM_Extension_Manager
::STATUS_INSTALLED_MISSING
:
315 $extensionRow['statusLabel'] = ts('Enabled (Missing)'); // ts('Installed');
318 $extensionRow['statusLabel'] = '(' . $extensionRow['status'] . ')';
320 return $extensionRow;