3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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.
55 public function preProcess() {
56 CRM_Utils_System
::setTitle(ts('CiviCRM Extensions'));
57 $destination = CRM_Utils_System
::url('civicrm/admin/extensions',
60 $destination = urlencode($destination);
61 $this->assign('destination', $destination);
70 public function getBAOName() {
71 return 'CRM_Core_BAO_Extension';
78 * (reference) of action links
80 public function &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 'title' => ts('Disable'),
102 CRM_Core_Action
::DELETE
=> array(
103 'name' => ts('Uninstall'),
104 'url' => 'civicrm/admin/extensions',
105 'qs' => 'action=delete&id=%%id%%&key=%%key%%',
106 'title' => ts('Uninstall Extension'),
108 CRM_Core_Action
::UPDATE
=> array(
109 'name' => ts('Download'),
110 'url' => 'civicrm/admin/extensions',
111 'qs' => 'action=update&id=%%id%%&key=%%key%%',
112 'title' => ts('Download Extension'),
116 return self
::$_links;
120 * Run the basic page (run essentially starts execution for that page).
124 public function run() {
126 return parent
::run();
136 public function browse() {
137 $mapper = CRM_Extension_System
::singleton()->getMapper();
138 $manager = CRM_Extension_System
::singleton()->getManager();
140 // build announcements at the top of the page
141 $this->assign('extAddNewEnabled', CRM_Extension_System
::singleton()->getBrowser()->isEnabled());
142 $reqs = CRM_Extension_System
::singleton()->getDownloader()->checkRequirements();
144 $reqs = CRM_Extension_System
::singleton()->getBrowser()->checkRequirements();
147 $reqs = CRM_Extension_System
::singleton()->getDefaultContainer()->checkRequirements();
149 $this->assign('extAddNewReqs', $reqs);
151 $this->assign('extDbUpgrades', CRM_Extension_Upgrades
::hasPending());
152 $this->assign('extDbUpgradeUrl', CRM_Utils_System
::url('civicrm/admin/extensions/upgrade', 'reset=1'));
154 // TODO: Debate whether to immediately detect changes in underlying source tree
155 // $manager->refresh();
157 // build list of local extensions
158 $localExtensionRows = array(); // array($pseudo_id => extended_CRM_Extension_Info)
159 $keys = array_keys($manager->getStatuses());
161 foreach ($keys as $key) {
163 $obj = $mapper->keyToInfo($key);
165 catch (CRM_Extension_Exception
$ex) {
166 CRM_Core_Session
::setStatus(ts('Failed to read extension (%1). Please refresh the extension list.', array(1 => $key)));
170 $row = self
::createExtendedInfo($obj);
171 $row['id'] = $obj->key
;
175 switch ($row['status']) {
176 case CRM_Extension_Manager
::STATUS_UNINSTALLED
:
177 $action +
= CRM_Core_Action
::ADD
;
180 case CRM_Extension_Manager
::STATUS_DISABLED
:
181 $action +
= CRM_Core_Action
::ENABLE
;
182 $action +
= CRM_Core_Action
::DELETE
;
185 case CRM_Extension_Manager
::STATUS_DISABLED_MISSING
:
186 $action +
= CRM_Core_Action
::DELETE
;
189 case CRM_Extension_Manager
::STATUS_INSTALLED
:
190 case CRM_Extension_Manager
::STATUS_INSTALLED_MISSING
:
191 $action +
= CRM_Core_Action
::DISABLE
;
196 // TODO if extbrowser is enabled and extbrowser has newer version than extcontainer,
197 // then $action += CRM_Core_Action::UPDATE
198 $row['action'] = CRM_Core_Action
::formLink(self
::links(),
206 'extension.local.action',
210 // Key would be better to send, but it's not an integer. Moreover, sending the
211 // values to hook_civicrm_links means that you can still get at the key
213 $localExtensionRows[$row['id']] = $row;
215 $this->assign('localExtensionRows', $localExtensionRows);
217 // build list of availabe downloads
218 $remoteExtensionRows = array();
219 foreach (CRM_Extension_System
::singleton()->getBrowser()->getExtensions() as $info) {
220 $row = (array) $info;
221 $row['id'] = $info->key
;
222 $action = CRM_Core_Action
::UPDATE
;
223 $row['action'] = CRM_Core_Action
::formLink(self
::links(),
227 'key' => $row['key'],
231 'extension.remote.action',
235 if (isset($localExtensionRows[$info->key
])) {
236 if (version_compare($localExtensionRows[$info->key
]['version'], $info->version
, '<')) {
237 $row['is_upgradeable'] = TRUE;
240 $remoteExtensionRows[$row['id']] = $row;
242 $this->assign('remoteExtensionRows', $remoteExtensionRows);
246 * Get name of edit form
249 * Classname of edit form.
251 public function editForm() {
252 return 'CRM_Admin_Form_Extensions';
261 public function editName() {
262 return 'CRM_Admin_Form_Extensions';
273 public function userContext($mode = NULL) {
274 return 'civicrm/admin/extensions';
278 * Get userContext params
281 * Mode that we are in.
285 public function userContextParams($mode = NULL) {
286 return 'reset=1&action=browse';
290 * Take an extension's raw XML info and add information about the
291 * extension's status on the local system.
293 * The result format resembles the old CRM_Core_Extensions_Extension.
295 * @param CRM_Extension_Info $obj
299 public static function createExtendedInfo(CRM_Extension_Info
$obj) {
300 $mapper = CRM_Extension_System
::singleton()->getMapper();
301 $manager = CRM_Extension_System
::singleton()->getManager();
303 $extensionRow = (array) $obj;
305 $extensionRow['path'] = $mapper->keyToBasePath($obj->key
);
307 catch (CRM_Extension_Exception
$e) {
308 $extensionRow['path'] = '';
310 $extensionRow['status'] = $manager->getStatus($obj->key
);
312 switch ($extensionRow['status']) {
313 case CRM_Extension_Manager
::STATUS_UNINSTALLED
:
314 $extensionRow['statusLabel'] = ''; // ts('Uninstalled');
317 case CRM_Extension_Manager
::STATUS_DISABLED
:
318 $extensionRow['statusLabel'] = ts('Disabled');
321 case CRM_Extension_Manager
::STATUS_INSTALLED
:
322 $extensionRow['statusLabel'] = ts('Enabled'); // ts('Installed');
325 case CRM_Extension_Manager
::STATUS_DISABLED_MISSING
:
326 $extensionRow['statusLabel'] = ts('Disabled (Missing)');
329 case CRM_Extension_Manager
::STATUS_INSTALLED_MISSING
:
330 $extensionRow['statusLabel'] = ts('Enabled (Missing)'); // ts('Installed');
334 $extensionRow['statusLabel'] = '(' . $extensionRow['status'] . ')';
336 return $extensionRow;