3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 +--------------------------------------------------------------------+
28 define('API_V3_EXTENSION_DELIMITER', ',');
32 * This provides an api interface for CiviCRM extension management.
34 * @package CiviCRM_APIv3
38 * Install an extension.
40 * @param array $params
42 * - key: string, eg "com.example.myextension"
43 * - keys: array of string, eg array("com.example.myextension1", "com.example.myextension2")
45 * Using 'keys' should be more performant than making multiple API calls with 'key'
49 function civicrm_api3_extension_install($params) {
50 $keys = _civicrm_api3_getKeys($params);
52 return civicrm_api3_create_success();
56 CRM_Extension_System
::singleton()->getManager()->install($keys);
58 catch (CRM_Extension_Exception
$e) {
59 return civicrm_api3_create_error($e->getMessage());
62 return civicrm_api3_create_success();
66 * Spec function for getfields
69 function _civicrm_api3_extension_install_spec(&$fields) {
70 $fields['keys'] = array(
71 'title' => 'Extension Key(s)',
73 'api.aliases' => array('key'),
74 'type' => CRM_Utils_Type
::T_STRING
,
75 'description' => 'Fully qualified name of one or more extensions',
80 * Upgrade an extension - runs upgrade_N hooks and system.flush.
85 function civicrm_api3_extension_upgrade() {
86 CRM_Core_Invoke
::rebuildMenuAndCaches(TRUE);
87 $queue = CRM_Extension_Upgrades
::createQueue();
88 $runner = new CRM_Queue_Runner(array(
89 'title' => 'Extension Upgrades',
91 'errorMode' => CRM_Queue_Runner
::ERROR_ABORT
,
95 $result = $runner->runAll();
97 catch (CRM_Extension_Exception
$e) {
98 return civicrm_api3_create_error($e->getMessage());
101 if ($result === TRUE) {
102 return civicrm_api3_create_success();
110 * Enable an extension.
112 * @param array $params
114 * - key: string, eg "com.example.myextension"
115 * - keys: array of string, eg array("com.example.myextension1", "com.example.myextension2")
117 * Using 'keys' should be more performant than making multiple API calls with 'key'
121 function civicrm_api3_extension_enable($params) {
122 $keys = _civicrm_api3_getKeys($params);
123 if (count($keys) == 0) {
124 return civicrm_api3_create_success();
127 CRM_Extension_System
::singleton()->getManager()->enable($keys);
128 return civicrm_api3_create_success();
132 * Spec function for getfields
135 function _civicrm_api3_extension_enable_spec(&$fields) {
136 _civicrm_api3_extension_install_spec($fields);
140 * Disable an extension.
142 * @param array $params
144 * - key: string, eg "com.example.myextension"
145 * - keys: array of string, eg array("com.example.myextension1", "com.example.myextension2")
147 * Using 'keys' should be more performant than making multiple API calls with 'key'
151 function civicrm_api3_extension_disable($params) {
152 $keys = _civicrm_api3_getKeys($params);
153 if (count($keys) == 0) {
154 return civicrm_api3_create_success();
157 CRM_Extension_System
::singleton()->getManager()->disable($keys);
158 return civicrm_api3_create_success();
162 * Spec function for getfields
165 function _civicrm_api3_extension_disable_spec(&$fields) {
166 _civicrm_api3_extension_install_spec($fields);
170 * Uninstall an extension.
172 * @param array $params
174 * - key: string, eg "com.example.myextension"
175 * - keys: array of string, eg array("com.example.myextension1", "com.example.myextension2")
177 * Using 'keys' should be more performant than making multiple API calls with 'key'
179 * @todo: removeFiles as optional param
183 function civicrm_api3_extension_uninstall($params) {
184 $keys = _civicrm_api3_getKeys($params);
185 if (count($keys) == 0) {
186 return civicrm_api3_create_success();
189 CRM_Extension_System
::singleton()->getManager()->uninstall($keys);
190 return civicrm_api3_create_success();
194 * Spec function for getfields
197 function _civicrm_api3_extension_uninstall_spec(&$fields) {
198 _civicrm_api3_extension_install_spec($fields);
199 //$fields['removeFiles'] = array(
200 // 'title' => 'Remove files',
201 // 'description' => 'Whether to remove the source tree. Default FALSE.',
202 // 'type' => CRM_Utils_Type::T_BOOLEAN,
207 * Download and install an extension.
209 * @param array $params
211 * - key: string, eg "com.example.myextension"
212 * - url: string eg "http://repo.com/myextension-1.0.zip"
214 * @throws API_Exception
218 function civicrm_api3_extension_download($params) {
219 if (!array_key_exists('url', $params)) {
220 if (!CRM_Extension_System
::singleton()->getBrowser()->isEnabled()) {
221 throw new API_Exception('Automatic downloading is disabled. Try adding parameter "url"');
223 if ($reqs = CRM_Extension_System
::singleton()->getBrowser()->checkRequirements()) {
224 $first = array_shift($reqs);
225 throw new API_Exception($first['message']);
227 if ($info = CRM_Extension_System
::singleton()->getBrowser()->getExtension($params['key'])) {
228 if ($info->downloadUrl
) {
229 $params['url'] = $info->downloadUrl
;
234 if (!array_key_exists('url', $params)) {
235 throw new API_Exception('Cannot resolve download url for extension. Try adding parameter "url"');
238 foreach (CRM_Extension_System
::singleton()->getDownloader()->checkRequirements() as $requirement) {
239 return civicrm_api3_create_error($requirement['message']);
242 if (!CRM_Extension_System
::singleton()->getDownloader()->download($params['key'], $params['url'])) {
243 return civicrm_api3_create_error('Download failed - ZIP file is unavailable or malformed');
245 CRM_Extension_System
::singleton()->getCache()->flush();
246 CRM_Extension_System
::singleton(TRUE);
247 if (CRM_Utils_Array
::value('install', $params, TRUE)) {
248 CRM_Extension_System
::singleton()->getManager()->install(array($params['key']));
251 return civicrm_api3_create_success();
255 * Spec function for getfields
258 function _civicrm_api3_extension_download_spec(&$fields) {
259 $fields['key'] = array(
260 'title' => 'Extension Key',
262 'type' => CRM_Utils_Type
::T_STRING
,
263 'description' => 'Fully qualified name of the extension',
265 $fields['url'] = array(
266 'title' => 'Download URL',
267 'type' => CRM_Utils_Type
::T_STRING
,
268 'description' => 'Optional as the system can determine the url automatically for public extensions',
270 $fields['install'] = array(
271 'title' => 'Auto-install',
272 'type' => CRM_Utils_Type
::T_STRING
,
273 'description' => 'Automatically install the downloaded extension',
274 'api.default' => TRUE,
279 * Download and install an extension.
281 * @param array $params
283 * - local: bool, whether to rescan local filesystem (default: TRUE)
284 * - remote: bool, whether to rescan remote repository (default: TRUE)
289 function civicrm_api3_extension_refresh($params) {
290 $system = CRM_Extension_System
::singleton(TRUE);
292 if ($params['local']) {
293 $system->getManager()->refresh();
294 $system->getManager()->getStatuses(); // force immediate scan
297 if ($params['remote']) {
298 if ($system->getBrowser()->isEnabled() && empty($system->getBrowser()->checkRequirements
)) {
299 $system->getBrowser()->refresh();
300 $system->getBrowser()->getExtensions(); // force immediate download
304 return civicrm_api3_create_success();
308 * Spec function for getfields
311 function _civicrm_api3_extension_refresh_spec(&$fields) {
312 $fields['local'] = array(
313 'title' => 'Rescan Local',
315 'type' => CRM_Utils_Type
::T_BOOLEAN
,
316 'description' => 'Whether to rescan the local filesystem (default TRUE)',
318 $fields['remote'] = array(
319 'title' => 'Rescan Remote',
321 'type' => CRM_Utils_Type
::T_BOOLEAN
,
322 'description' => 'Whether to rescan the remote repository (default TRUE)',
327 * Get a list of available extensions.
329 * @param array $params
334 function civicrm_api3_extension_get($params) {
335 $full_names = _civicrm_api3_getKeys($params, 'full_name');
336 $keys = _civicrm_api3_getKeys($params, 'key');
337 $keys = array_merge($full_names, $keys);
338 $statuses = CRM_Extension_System
::singleton()->getManager()->getStatuses();
339 $mapper = CRM_Extension_System
::singleton()->getMapper();
342 foreach ($statuses as $key => $status) {
344 $obj = $mapper->keyToInfo($key);
346 catch (CRM_Extension_Exception
$ex) {
347 CRM_Core_Session
::setStatus(ts('Failed to read extension (%1). Please refresh the extension list.', array(1 => $key)));
350 $info = CRM_Extension_System
::createExtendedInfo($obj);
351 $info['id'] = $id++
; // backward compatibility with indexing scheme
353 if (in_array($key, $keys)) {
361 $options = _civicrm_api3_get_options_from_params($params);
362 $returnFields = !empty($options['return']) ?
$options['return'] : array();
363 return _civicrm_api3_basic_array_get('Extension', $params, $result, 'id', $returnFields);
367 * Get a list of remotely available extensions.
369 * @param array $params
374 function civicrm_api3_extension_getremote($params) {
375 $extensions = CRM_Extension_System
::singleton()->getBrowser()->getExtensions();
378 foreach ($extensions as $key => $obj) {
380 $info['id'] = $id++
; // backward compatibility with indexing scheme
381 $info = array_merge($info, (array) $obj);
384 return _civicrm_api3_basic_array_get('Extension', $params, $result, 'id', CRM_Utils_Array
::value('return', $params, array()));
388 * Determine the list of extension keys.
390 * @param array $params
392 * API request params with 'keys'.
396 function _civicrm_api3_getKeys($params, $key = 'keys') {
397 if (isset($params[$key])) {
398 if (is_array($params[$key])) {
399 return $params[$key];
401 if ($params[$key] == '') {
404 return explode(API_V3_EXTENSION_DELIMITER
, $params[$key]);