Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * This is a part of CiviCRM extension management functionality. | |
30 | * | |
31 | * @package CRM | |
06b69b18 | 32 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
33 | * $Id$ |
34 | * | |
35 | */ | |
36 | ||
37 | /** | |
38 | * This page displays the list of extensions registered in the system. | |
39 | */ | |
40 | class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic { | |
41 | ||
42 | /** | |
43 | * The action links that we need to display for the browse screen | |
44 | * | |
45 | * @var array | |
46 | * @static | |
47 | */ | |
48 | static $_links = NULL; | |
49 | ||
50 | /** | |
51 | * Obtains the group name from url and sets the title. | |
52 | * | |
53 | * @return void | |
54 | * @access public | |
55 | * | |
56 | */ | |
57 | function preProcess() { | |
58 | CRM_Utils_System::setTitle(ts('CiviCRM Extensions')); | |
59 | $destination = CRM_Utils_System::url( 'civicrm/admin/extensions', | |
60 | 'reset=1' ); | |
8ef12e64 | 61 | |
6a488035 TO |
62 | $destination = urlencode( $destination ); |
63 | $this->assign( 'destination', $destination ); | |
64 | } | |
65 | ||
66 | /** | |
67 | * Get BAO Name | |
68 | * | |
69 | * @return string Classname of BAO. | |
70 | */ | |
71 | function getBAOName() { | |
72 | return 'CRM_Core_BAO_Extension'; | |
73 | } | |
74 | ||
75 | /** | |
76 | * Get action Links | |
77 | * | |
78 | * @return array (reference) of action links | |
79 | */ | |
80 | 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'), | |
88 | ), | |
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'), | |
95 | ), | |
96 | CRM_Core_Action::DISABLE => array( | |
97 | 'name' => ts('Disable'), | |
98 | 'url' => 'civicrm/admin/extensions', | |
99 | 'qs' => 'action=disable&id=%%id%%&key=%%key%%', | |
6a488035 TO |
100 | 'title' => ts('Disable'), |
101 | ), | |
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'), | |
107 | ), | |
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'), | |
113 | ), | |
114 | ); | |
115 | } | |
116 | return self::$_links; | |
117 | } | |
118 | ||
119 | /** | |
120 | * Run the basic page (run essentially starts execution for that page). | |
121 | * | |
122 | * @return void | |
123 | */ | |
124 | function run() { | |
125 | $this->preProcess(); | |
126 | return parent::run(); | |
127 | } | |
128 | ||
129 | /** | |
130 | * Browse all options | |
131 | * | |
132 | * | |
133 | * @return void | |
134 | * @access public | |
135 | * @static | |
136 | */ | |
137 | function browse() { | |
138 | $mapper = CRM_Extension_System::singleton()->getMapper(); | |
139 | $manager = CRM_Extension_System::singleton()->getManager(); | |
140 | ||
141 | // build announcements at the top of the page | |
142 | $this->assign('extAddNewEnabled', CRM_Extension_System::singleton()->getBrowser()->isEnabled()); | |
143 | $reqs = CRM_Extension_System::singleton()->getDownloader()->checkRequirements(); | |
144 | if (empty($reqs)) { | |
145 | $reqs = CRM_Extension_System::singleton()->getBrowser()->checkRequirements(); | |
146 | } | |
70d331a6 TO |
147 | if (empty($reqs)) { |
148 | $reqs = CRM_Extension_System::singleton()->getDefaultContainer()->checkRequirements(); | |
149 | } | |
6a488035 TO |
150 | $this->assign('extAddNewReqs', $reqs); |
151 | ||
152 | $this->assign('extDbUpgrades', CRM_Extension_Upgrades::hasPending()); | |
153 | $this->assign('extDbUpgradeUrl', CRM_Utils_System::url('civicrm/admin/extensions/upgrade', 'reset=1')); | |
154 | ||
155 | // TODO: Debate whether to immediately detect changes in underlying source tree | |
156 | // $manager->refresh(); | |
157 | ||
158 | // build list of local extensions | |
159 | $localExtensionRows = array(); // array($pseudo_id => extended_CRM_Extension_Info) | |
160 | $keys = array_keys($manager->getStatuses()); | |
161 | sort($keys); | |
162 | foreach($keys as $key) { | |
163 | try { | |
164 | $obj = $mapper->keyToInfo($key); | |
165 | } catch (CRM_Extension_Exception $ex) { | |
10a5be27 | 166 | CRM_Core_Session::setStatus(ts('Failed to read extension (%1). Please refresh the extension list.', array(1 => $key))); |
6a488035 TO |
167 | continue; |
168 | } | |
169 | ||
170 | $row = self::createExtendedInfo($obj); | |
171 | $row['id'] = $obj->key; | |
172 | ||
173 | // assign actions | |
174 | $action = 0; | |
175 | switch ($row['status']) { | |
176 | case CRM_Extension_Manager::STATUS_UNINSTALLED: | |
177 | $action += CRM_Core_Action::ADD; | |
178 | break; | |
179 | case CRM_Extension_Manager::STATUS_DISABLED: | |
180 | $action += CRM_Core_Action::ENABLE; | |
181 | $action += CRM_Core_Action::DELETE; | |
182 | break; | |
183 | case CRM_Extension_Manager::STATUS_DISABLED_MISSING: | |
184 | $action += CRM_Core_Action::DELETE; | |
185 | break; | |
186 | case CRM_Extension_Manager::STATUS_INSTALLED: | |
187 | case CRM_Extension_Manager::STATUS_INSTALLED_MISSING: | |
188 | $action += CRM_Core_Action::DISABLE; | |
189 | break; | |
190 | default: | |
191 | } | |
192 | // TODO if extbrowser is enabled and extbrowser has newer version than extcontainer, | |
193 | // then $action += CRM_Core_Action::UPDATE | |
194 | $row['action'] = CRM_Core_Action::formLink(self::links(), | |
195 | $action, | |
196 | array( | |
197 | 'id' => $row['id'], | |
198 | 'key' => $obj->key, | |
87dab4a4 AH |
199 | ), |
200 | ts('more'), | |
201 | FALSE, | |
202 | 'extension.local.action', | |
203 | 'Extension', | |
204 | $row['id'] | |
6a488035 | 205 | ); |
87dab4a4 AH |
206 | // Key would be better to send, but it's not an integer. Moreover, sending the |
207 | // values to hook_civicrm_links means that you can still get at the key | |
6a488035 TO |
208 | |
209 | $localExtensionRows[$row['id']] = $row; | |
210 | } | |
211 | $this->assign('localExtensionRows', $localExtensionRows); | |
212 | ||
213 | // build list of availabe downloads | |
214 | $remoteExtensionRows = array(); | |
215 | foreach (CRM_Extension_System::singleton()->getBrowser()->getExtensions() as $info) { | |
216 | $row = (array) $info; | |
217 | $row['id'] = $info->key; | |
218 | $action = CRM_Core_Action::UPDATE; | |
219 | $row['action'] = CRM_Core_Action::formLink(self::links(), | |
220 | $action, | |
221 | array( | |
222 | 'id' => $row['id'], | |
223 | 'key' => $row['key'], | |
87dab4a4 AH |
224 | ), |
225 | ts('more'), | |
226 | FALSE, | |
227 | 'extension.remote.action', | |
228 | 'Extension', | |
229 | $row['id'] | |
6a488035 | 230 | ); |
46693baf TO |
231 | if (isset($localExtensionRows[$info->key])) { |
232 | if (version_compare($localExtensionRows[$info->key]['version'], $info->version, '<')) { | |
233 | $row['is_upgradeable'] = TRUE; | |
234 | } | |
235 | } | |
6a488035 TO |
236 | $remoteExtensionRows[$row['id']] = $row; |
237 | } | |
238 | $this->assign('remoteExtensionRows', $remoteExtensionRows); | |
239 | } | |
240 | ||
241 | /** | |
242 | * Get name of edit form | |
243 | * | |
244 | * @return string Classname of edit form. | |
245 | */ | |
246 | function editForm() { | |
247 | return 'CRM_Admin_Form_Extensions'; | |
248 | } | |
249 | ||
250 | /** | |
251 | * Get edit form name | |
252 | * | |
253 | * @return string name of this page. | |
254 | */ | |
255 | function editName() { | |
256 | return 'CRM_Admin_Form_Extensions'; | |
257 | } | |
258 | ||
259 | /** | |
260 | * Get user context. | |
261 | * | |
fd31fa4c EM |
262 | * @param null $mode |
263 | * | |
6a488035 TO |
264 | * @return string user context. |
265 | */ | |
266 | function userContext($mode = NULL) { | |
267 | return 'civicrm/admin/extensions'; | |
268 | } | |
269 | ||
270 | /** | |
100fef9d | 271 | * Get userContext params |
6a488035 TO |
272 | * |
273 | * @param int $mode mode that we are in | |
274 | * | |
275 | * @return string | |
276 | * @access public | |
277 | */ | |
278 | function userContextParams($mode = NULL) { | |
279 | return 'reset=1&action=browse'; | |
280 | } | |
281 | ||
282 | /** | |
283 | * Take an extension's raw XML info and add information about the | |
284 | * extension's status on the local system. | |
285 | * | |
286 | * The result format resembles the old CRM_Core_Extensions_Extension. | |
287 | * | |
da6b46f4 EM |
288 | * @param CRM_Extension_Info $obj |
289 | * | |
6a488035 TO |
290 | * @return array |
291 | */ | |
292 | public static function createExtendedInfo(CRM_Extension_Info $obj) { | |
293 | $mapper = CRM_Extension_System::singleton()->getMapper(); | |
294 | $manager = CRM_Extension_System::singleton()->getManager(); | |
295 | ||
296 | $extensionRow = (array) $obj; | |
297 | try { | |
298 | $extensionRow['path'] = $mapper->keyToBasePath($obj->key); | |
299 | } catch (CRM_Extension_Exception $e) { | |
300 | $extensionRow['path'] = ''; | |
301 | } | |
302 | $extensionRow['status'] = $manager->getStatus($obj->key); | |
303 | ||
304 | switch ($extensionRow['status']) { | |
305 | case CRM_Extension_Manager::STATUS_UNINSTALLED: | |
306 | $extensionRow['statusLabel'] = ''; // ts('Uninstalled'); | |
307 | break; | |
308 | case CRM_Extension_Manager::STATUS_DISABLED: | |
309 | $extensionRow['statusLabel'] = ts('Disabled'); | |
310 | break; | |
311 | case CRM_Extension_Manager::STATUS_INSTALLED: | |
312 | $extensionRow['statusLabel'] = ts('Enabled'); // ts('Installed'); | |
313 | break; | |
314 | case CRM_Extension_Manager::STATUS_DISABLED_MISSING: | |
315 | $extensionRow['statusLabel'] = ts('Disabled (Missing)'); | |
316 | break; | |
317 | case CRM_Extension_Manager::STATUS_INSTALLED_MISSING: | |
318 | $extensionRow['statusLabel'] = ts('Enabled (Missing)'); // ts('Installed'); | |
319 | break; | |
320 | default: | |
321 | $extensionRow['statusLabel'] = '(' . $extensionRow['status'] . ')'; | |
322 | } | |
323 | return $extensionRow; | |
324 | } | |
325 | } | |
326 |