3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 * This class generates form components for Extensions.
37 class CRM_Admin_Form_Extensions
extends CRM_Admin_Form
{
40 * Form pre-processing.
42 public function preProcess() {
45 $mainPage = new CRM_Admin_Page_Extensions();
46 $localExtensionRows = $mainPage->formatLocalExtensionRows();
47 $this->assign('localExtensionRows', $localExtensionRows);
49 $remoteExtensionRows = $mainPage->formatRemoteExtensionRows($localExtensionRows);
50 $this->assign('remoteExtensionRows', $remoteExtensionRows);
52 $this->_key
= CRM_Utils_Request
::retrieve('key', 'String',
55 if (!CRM_Utils_Type
::validate($this->_key
, 'ExtensionKey') && !empty($this->_key
)) {
56 throw new CRM_Core_Exception('Extension Key does not match expected standard');
58 $session = CRM_Core_Session
::singleton();
59 $url = CRM_Utils_System
::url('civicrm/admin/extensions', 'reset=1&action=browse');
60 $session->pushUserContext($url);
61 $this->assign('id', $this->_id
);
62 $this->assign('key', $this->_key
);
64 switch ($this->_action
) {
65 case CRM_Core_Action
::ADD
:
66 case CRM_Core_Action
::DELETE
:
67 case CRM_Core_Action
::ENABLE
:
68 case CRM_Core_Action
::DISABLE
:
69 $info = CRM_Extension_System
::singleton()->getMapper()->keyToInfo($this->_key
);
70 $extInfo = CRM_Admin_Page_Extensions
::createExtendedInfo($info);
71 $this->assign('extension', $extInfo);
74 case CRM_Core_Action
::UPDATE
:
75 if (!CRM_Extension_System
::singleton()->getBrowser()->isEnabled()) {
76 CRM_Core_Error
::fatal(ts('The system administrator has disabled this feature.'));
78 $info = CRM_Extension_System
::singleton()->getBrowser()->getExtension($this->_key
);
79 $extInfo = CRM_Admin_Page_Extensions
::createExtendedInfo($info);
80 $this->assign('extension', $extInfo);
84 CRM_Core_Error
::fatal(ts('Unsupported action'));
90 * Set default values for the form.
92 public function setDefaultValues() {
98 * Build the form object.
100 public function buildQuickForm() {
101 switch ($this->_action
) {
102 case CRM_Core_Action
::ADD
:
103 $buttonName = ts('Install');
104 $title = ts('Install "%1"?', [
109 case CRM_Core_Action
::UPDATE
:
110 $buttonName = ts('Download and Install');
111 $title = ts('Download and Install "%1"?', [
116 case CRM_Core_Action
::DELETE
:
117 $buttonName = ts('Uninstall');
118 $title = ts('Uninstall "%1"?', [
123 case CRM_Core_Action
::ENABLE
:
124 $buttonName = ts('Enable');
125 $title = ts('Enable "%1"?', [
130 case CRM_Core_Action
::DISABLE
:
131 $buttonName = ts('Disable');
132 $title = ts('Disable "%1"?', [
138 $this->assign('title', $title);
142 'name' => $buttonName,
147 'name' => ts('Cancel'),
155 * @param array $fields
156 * The input form values.
157 * @param array $files
158 * The uploaded files if any.
163 * true if no errors, else an array of errors
165 public static function formRule($fields, $files, $self) {
168 return empty($errors) ?
TRUE : $errors;
172 * Process the form submission.
174 public function postProcess() {
175 CRM_Utils_System
::flushCache();
177 if ($this->_action
& CRM_Core_Action
::DELETE
) {
179 CRM_Extension_System
::singleton()->getManager()->uninstall([$this->_key
]);
180 CRM_Core_Session
::setStatus("", ts('Extension Uninstalled'), "success");
182 catch (CRM_Extension_Exception_DependencyException
$e) {
183 // currently only thrown for payment-processor dependencies
184 CRM_Core_Session
::setStatus(ts('Cannot uninstall this extension - there is at least one payment processor using the payment processor type provided by it.'), ts('Uninstall Error'), 'error');
188 if ($this->_action
& CRM_Core_Action
::ADD
) {
189 civicrm_api3('Extension', 'install', ['keys' => $this->_key
]);
190 CRM_Core_Session
::setStatus("", ts('Extension Installed'), "success");
193 if ($this->_action
& CRM_Core_Action
::ENABLE
) {
194 civicrm_api3('Extension', 'enable', ['keys' => $this->_key
]);
195 CRM_Core_Session
::setStatus("", ts('Extension Enabled'), "success");
198 if ($this->_action
& CRM_Core_Action
::DISABLE
) {
199 CRM_Extension_System
::singleton()->getManager()->disable([$this->_key
]);
200 CRM_Core_Session
::setStatus("", ts('Extension Disabled'), "success");
203 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
204 $result = civicrm_api('Extension', 'download', [
206 'key' => $this->_key
,
208 if (empty($result['is_error'])) {
209 CRM_Core_Session
::setStatus("", ts('Extension Upgraded'), "success");
212 CRM_Core_Session
::setStatus($result['error_message'], ts('Extension Upgrade Failed'), "error");
216 CRM_Utils_System
::redirect(
217 CRM_Utils_System
::url(
218 'civicrm/admin/extensions',
219 'reset=1&action=browse'