Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.3 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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 | |
32 | * @copyright CiviCRM LLC (c) 2004-2013 | |
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%%', | |
100 | 'ref' => 'disable-action', | |
101 | 'title' => ts('Disable'), | |
102 | ), | |
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'), | |
108 | ), | |
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'), | |
114 | ), | |
115 | ); | |
116 | } | |
117 | return self::$_links; | |
118 | } | |
119 | ||
120 | /** | |
121 | * Run the basic page (run essentially starts execution for that page). | |
122 | * | |
123 | * @return void | |
124 | */ | |
125 | function run() { | |
126 | $this->preProcess(); | |
127 | return parent::run(); | |
128 | } | |
129 | ||
130 | /** | |
131 | * Browse all options | |
132 | * | |
133 | * | |
134 | * @return void | |
135 | * @access public | |
136 | * @static | |
137 | */ | |
138 | function browse() { | |
139 | $mapper = CRM_Extension_System::singleton()->getMapper(); | |
140 | $manager = CRM_Extension_System::singleton()->getManager(); | |
141 | ||
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(); | |
145 | if (empty($reqs)) { | |
146 | $reqs = CRM_Extension_System::singleton()->getBrowser()->checkRequirements(); | |
147 | } | |
70d331a6 TO |
148 | if (empty($reqs)) { |
149 | $reqs = CRM_Extension_System::singleton()->getDefaultContainer()->checkRequirements(); | |
150 | } | |
6a488035 TO |
151 | $this->assign('extAddNewReqs', $reqs); |
152 | ||
153 | $this->assign('extDbUpgrades', CRM_Extension_Upgrades::hasPending()); | |
154 | $this->assign('extDbUpgradeUrl', CRM_Utils_System::url('civicrm/admin/extensions/upgrade', 'reset=1')); | |
155 | ||
156 | // TODO: Debate whether to immediately detect changes in underlying source tree | |
157 | // $manager->refresh(); | |
158 | ||
159 | // build list of local extensions | |
160 | $localExtensionRows = array(); // array($pseudo_id => extended_CRM_Extension_Info) | |
161 | $keys = array_keys($manager->getStatuses()); | |
162 | sort($keys); | |
163 | foreach($keys as $key) { | |
164 | try { | |
165 | $obj = $mapper->keyToInfo($key); | |
166 | } catch (CRM_Extension_Exception $ex) { | |
10a5be27 | 167 | CRM_Core_Session::setStatus(ts('Failed to read extension (%1). Please refresh the extension list.', array(1 => $key))); |
6a488035 TO |
168 | continue; |
169 | } | |
170 | ||
171 | $row = self::createExtendedInfo($obj); | |
172 | $row['id'] = $obj->key; | |
173 | ||
174 | // assign actions | |
175 | $action = 0; | |
176 | switch ($row['status']) { | |
177 | case CRM_Extension_Manager::STATUS_UNINSTALLED: | |
178 | $action += CRM_Core_Action::ADD; | |
179 | break; | |
180 | case CRM_Extension_Manager::STATUS_DISABLED: | |
181 | $action += CRM_Core_Action::ENABLE; | |
182 | $action += CRM_Core_Action::DELETE; | |
183 | break; | |
184 | case CRM_Extension_Manager::STATUS_DISABLED_MISSING: | |
185 | $action += CRM_Core_Action::DELETE; | |
186 | break; | |
187 | case CRM_Extension_Manager::STATUS_INSTALLED: | |
188 | case CRM_Extension_Manager::STATUS_INSTALLED_MISSING: | |
189 | $action += CRM_Core_Action::DISABLE; | |
190 | break; | |
191 | default: | |
192 | } | |
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(), | |
196 | $action, | |
197 | array( | |
198 | 'id' => $row['id'], | |
199 | 'key' => $obj->key, | |
200 | ) | |
201 | ); | |
202 | ||
203 | $localExtensionRows[$row['id']] = $row; | |
204 | } | |
205 | $this->assign('localExtensionRows', $localExtensionRows); | |
206 | ||
207 | // build list of availabe downloads | |
208 | $remoteExtensionRows = array(); | |
209 | foreach (CRM_Extension_System::singleton()->getBrowser()->getExtensions() as $info) { | |
210 | $row = (array) $info; | |
211 | $row['id'] = $info->key; | |
212 | $action = CRM_Core_Action::UPDATE; | |
213 | $row['action'] = CRM_Core_Action::formLink(self::links(), | |
214 | $action, | |
215 | array( | |
216 | 'id' => $row['id'], | |
217 | 'key' => $row['key'], | |
218 | ) | |
219 | ); | |
220 | $remoteExtensionRows[$row['id']] = $row; | |
221 | } | |
222 | $this->assign('remoteExtensionRows', $remoteExtensionRows); | |
223 | } | |
224 | ||
225 | /** | |
226 | * Get name of edit form | |
227 | * | |
228 | * @return string Classname of edit form. | |
229 | */ | |
230 | function editForm() { | |
231 | return 'CRM_Admin_Form_Extensions'; | |
232 | } | |
233 | ||
234 | /** | |
235 | * Get edit form name | |
236 | * | |
237 | * @return string name of this page. | |
238 | */ | |
239 | function editName() { | |
240 | return 'CRM_Admin_Form_Extensions'; | |
241 | } | |
242 | ||
243 | /** | |
244 | * Get user context. | |
245 | * | |
246 | * @return string user context. | |
247 | */ | |
248 | function userContext($mode = NULL) { | |
249 | return 'civicrm/admin/extensions'; | |
250 | } | |
251 | ||
252 | /** | |
253 | * function to get userContext params | |
254 | * | |
255 | * @param int $mode mode that we are in | |
256 | * | |
257 | * @return string | |
258 | * @access public | |
259 | */ | |
260 | function userContextParams($mode = NULL) { | |
261 | return 'reset=1&action=browse'; | |
262 | } | |
263 | ||
264 | /** | |
265 | * Take an extension's raw XML info and add information about the | |
266 | * extension's status on the local system. | |
267 | * | |
268 | * The result format resembles the old CRM_Core_Extensions_Extension. | |
269 | * | |
270 | * @return array | |
271 | */ | |
272 | public static function createExtendedInfo(CRM_Extension_Info $obj) { | |
273 | $mapper = CRM_Extension_System::singleton()->getMapper(); | |
274 | $manager = CRM_Extension_System::singleton()->getManager(); | |
275 | ||
276 | $extensionRow = (array) $obj; | |
277 | try { | |
278 | $extensionRow['path'] = $mapper->keyToBasePath($obj->key); | |
279 | } catch (CRM_Extension_Exception $e) { | |
280 | $extensionRow['path'] = ''; | |
281 | } | |
282 | $extensionRow['status'] = $manager->getStatus($obj->key); | |
283 | ||
284 | switch ($extensionRow['status']) { | |
285 | case CRM_Extension_Manager::STATUS_UNINSTALLED: | |
286 | $extensionRow['statusLabel'] = ''; // ts('Uninstalled'); | |
287 | break; | |
288 | case CRM_Extension_Manager::STATUS_DISABLED: | |
289 | $extensionRow['statusLabel'] = ts('Disabled'); | |
290 | break; | |
291 | case CRM_Extension_Manager::STATUS_INSTALLED: | |
292 | $extensionRow['statusLabel'] = ts('Enabled'); // ts('Installed'); | |
293 | break; | |
294 | case CRM_Extension_Manager::STATUS_DISABLED_MISSING: | |
295 | $extensionRow['statusLabel'] = ts('Disabled (Missing)'); | |
296 | break; | |
297 | case CRM_Extension_Manager::STATUS_INSTALLED_MISSING: | |
298 | $extensionRow['statusLabel'] = ts('Enabled (Missing)'); // ts('Installed'); | |
299 | break; | |
300 | default: | |
301 | $extensionRow['statusLabel'] = '(' . $extensionRow['status'] . ')'; | |
302 | } | |
303 | return $extensionRow; | |
304 | } | |
305 | } | |
306 |