lib.moduleslist.php @ 2354:d388f7fdcb4e

Visit:

Revision 2354:d388f7fdcb4e, 36.8 KB checked in by Denis Jean-Chirstian <contact@…>, 12 years ago (diff)
Move addtionnal info on plugins list from js to php, addresses #1771

Line
1	<?php
2	# -- BEGIN LICENSE BLOCK ---------------------------------------
3	#
4	# This file is part of Dotclear 2.
5	#
6	# Copyright (c) 2003-2013 Olivier Meunier & Association Dotclear
7	# Licensed under the GPL version 2.0 license.
8	# See LICENSE file or
9	# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
10	#
11	# -- END LICENSE BLOCK -----------------------------------------
12	if (!defined('DC_ADMIN_CONTEXT')) { return; }
13
14	/**
15	* @ingroup DC_CORE
16	* @brief Helper for admin list of modules.
17	* @since 2.6
18
19	* Provides an object to parse XML feed of modules from a repository.
20	*/
21	class adminModulesList
22	{
23	public $core; /*< @var object dcCore instance /
24	public $modules; /*< @var object dcModules instance /
25	public $store; /*< @var object dcStore instance /
26
27	public static $allow_multi_install = false; /*< @var boolean Work with multiple root directories /
28	public static $distributed_modules = array(); /*< @var array List of modules distributed with Dotclear /
29
30	protected $list_id = 'unknow'; /*< @var string Current list ID /
31	protected $data = array(); /*< @var array Current modules /
32
33	protected $config_module = ''; /*< @var string Module ID to configure /
34	protected $config_file = ''; /*< @var string Module path to configure /
35	protected $config_content = ''; /*< @var string Module configuration page content /
36
37	protected $path = false; /*< @var string Modules root directory /
38	protected $path_writable = false; /*< @var boolean Indicate if modules root directory is writable /
39	protected $path_pattern = false; /*< @var string Directory pattern to work on /
40
41	protected $page_url = 'plugins.php'; /*< @var string Page URL /
42	protected $page_qs = '?'; /*< @var string Page query string /
43	protected $page_tab = ''; /*< @var string Page tab /
44	protected $page_redir = ''; /*< @var string Page redirection /
45
46	public static $nav_indexes = 'abcdefghijklmnopqrstuvwxyz0123456789'; /*< @var string Index list /
47	protected $nav_list = array(); /*< @var array Index list with special index /
48	protected $nav_special = 'other'; /*< @var string Text for other special index /
49
50	protected $sort_field = 'sname'; /*< @var string Field used to sort modules /
51	protected $sort_asc = true; /*< @var boolean Sort order asc /
52
53	/**
54	* Constructor.
55	*
56	* Note that this creates dcStore instance.
57	*
58	* @param object $modules dcModules instance
59	* @param string $modules_root Modules root directories
60	* @param string $xml_url URL of modules feed from repository
61	*/
62	public function __construct(dcModules $modules, $modules_root, $xml_url)
63	{
64	$this->core = $modules->core;
65	$this->modules = $modules;
66	$this->store = new dcStore($modules, $xml_url);
67
68	$this->setPath($modules_root);
69	$this->setIndex(__('other'));
70	}
71
72	/**
73	* Begin a new list.
74	*
75	* @param string $id New list ID
76	* @return adminModulesList self instance
77	*/
78	public function setList($id)
79	{
80	$this->data = array();
81	$this->page_tab = '';
82	$this->list_id = $id;
83
84	return $this;
85	}
86
87	/**
88	* Get list ID.
89	*
90	* @return List ID
91	*/
92	public function getList()
93	{
94	return $this->list_id;
95	}
96
97	/// @name Modules root directory methods
98	//@{
99	/**
100	* Set path info.
101	*
102	* @param string $root Modules root directories
103	* @return adminModulesList self instance
104	*/
105	protected function setPath($root)
106	{
107	$paths = explode(PATH_SEPARATOR, $root);
108	$path = array_pop($paths);
109	unset($paths);
110
111	$this->path = $path;
112	if (is_dir($path) && is_writeable($path)) {
113	$this->path_writable = true;
114	$this->path_pattern = preg_quote($path,'!');
115	}
116
117	return $this;
118	}
119
120	/**
121	* Get modules root directory.
122	*
123	* @return Path to work on
124	*/
125	public function getPath()
126	{
127	return $this->path;
128	}
129
130	/**
131	* Check if modules root directory is writable.
132	*
133	* @return True if directory is writable
134	*/
135	public function isWritablePath()
136	{
137	return $this->path_writable;
138	}
139
140	/**
141	* Check if root directory of a module is deletable.
142	*
143	* @param string $root Module root directory
144	* @return True if directory is delatable
145	*/
146	public function isDeletablePath($root)
147	{
148	return $this->path_writable
149	&& (preg_match('!^'.$this->path_pattern.'!', $root) \|\| defined('DC_DEV') && DC_DEV)
150	&& $this->core->auth->isSuperAdmin();
151	}
152	//@}
153
154	/// @name Page methods
155	//@{
156	/**
157	* Set page base URL.
158	*
159	* @param string $url Page base URL
160	* @return adminModulesList self instance
161	*/
162	public function setURL($url)
163	{
164	$this->page_qs = strpos('?', $url) ? '&' : '?';
165	$this->page_url = $url;
166
167	return $this;
168	}
169
170	/**
171	* Get page URL.
172	*
173	* @param string\|array $queries Additionnal query string
174	* @param booleany $with_tab Add current tab to URL end
175	* @return Clean page URL
176	*/
177	public function getURL($queries='', $with_tab=true)
178	{
179	return $this->page_url.
180	(!empty($queries) ? $this->page_qs : '').
181	(is_array($queries) ? http_build_query($queries) : $queries).
182	($with_tab && !empty($this->page_tab) ? '#'.$this->page_tab : '');
183	}
184
185	/**
186	* Set page tab.
187	*
188	* @param string $tab Page tab
189	* @return adminModulesList self instance
190	*/
191	public function setTab($tab)
192	{
193	$this->page_tab = $tab;
194
195	return $this;
196	}
197
198	/**
199	* Get page tab.
200	*
201	* @return Page tab
202	*/
203	public function getTab()
204	{
205	return $this->page_tab;
206	}
207
208	/**
209	* Set page redirection.
210	*
211	* @param string $default Default redirection
212	* @return adminModulesList self instance
213	*/
214	public function setRedir($default='')
215	{
216	$this->page_redir = empty($_REQUEST['redir']) ? $default : $_REQUEST['redir'];
217
218	return $this;
219	}
220
221	/**
222	* Get page redirection.
223	*
224	* @return Page redirection
225	*/
226	public function getRedir()
227	{
228	return empty($this->page_redir) ? $this->getURL() : $this->page_redir;
229	}
230	//@}
231
232	/// @name Search methods
233	//@{
234	/**
235	* Get search query.
236	*
237	* @return Search query
238	*/
239	public function getSearch()
240	{
241	$query = !empty($_REQUEST['m_search']) ? trim($_REQUEST['m_search']) : null;
242	return strlen($query) > 2 ? $query : null;
243	}
244
245	/**
246	* Display searh form.
247	*
248	* @return adminModulesList self instance
249	*/
250	public function displaySearch()
251	{
252	$query = $this->getSearch();
253
254	if (empty($this->data) && $query === null) {
255	return $this;
256	}
257
258	echo
259	'<div class="modules-search">'.
260	'<form action="'.$this->getURL().'" method="get">'.
261	'<p><label for="m_search" class="classic">'.__('Search in repository:').' </label><br />'.
262	form::field(array('m_search','m_search'), 30, 255, html::escapeHTML($query)).
263	'<input type="submit" value="'.__('OK').'" /> ';
264
265	if ($query) {
266	echo
267	' <a href="'.$this->getURL().'" class="button">'.__('Reset search').'</a>';
268	}
269
270	echo
271	'</p>'.
272	'<p class="form-note">'.
273	__('Search is allowed on multiple terms longer than 2 chars, terms must be separated by space.').
274	'</p>'.
275	'</form>';
276
277	if ($query) {
278	echo
279	'<p class="message">'.sprintf(
280	__('Found %d result for search "%s":', 'Found %d results for search "%s":', count($this->data)),
281	count($this->data), html::escapeHTML($query)
282	).
283	'</p>';
284	}
285	echo '</div>';
286
287	return $this;
288	}
289	//@}
290
291	/// @name Navigation menu methods
292	//@{
293	/**
294	* Set navigation special index.
295	*
296	* @return adminModulesList self instance
297	*/
298	public function setIndex($str)
299	{
300	$this->nav_special = (string) $str;
301	$this->nav_list = array_merge(str_split(self::$nav_indexes), array($this->nav_special));
302
303	return $this;
304	}
305
306	/**
307	* Get index from query.
308	*
309	* @return Query index or default one
310	*/
311	public function getIndex()
312	{
313	return isset($_REQUEST['m_nav']) && in_array($_REQUEST['m_nav'], $this->nav_list) ? $_REQUEST['m_nav'] : $this->nav_list[0];
314	}
315
316	/**
317	* Display navigation by index menu.
318	*
319	* @return adminModulesList self instance
320	*/
321	public function displayIndex()
322	{
323	if (empty($this->data) \|\| $this->getSearch() !== null) {
324	return $this;
325	}
326
327	# Fetch modules required field
328	$indexes = array();
329	foreach ($this->data as $id => $module) {
330	if (!isset($module[$this->sort_field])) {
331	continue;
332	}
333	$char = substr($module[$this->sort_field], 0, 1);
334	if (!in_array($char, $this->nav_list)) {
335	$char = $this->nav_special;
336	}
337	if (!isset($indexes[$char])) {
338	$indexes[$char] = 0;
339	}
340	$indexes[$char]++;
341	}
342
343	$buttons = array();
344	foreach($this->nav_list as $char) {
345	# Selected letter
346	if ($this->getIndex() == $char) {
347	$buttons[] = '<li class="active" title="'.__('current selection').'"><strong> '.$char.' </strong></li>';
348	}
349	# Letter having modules
350	elseif (!empty($indexes[$char])) {
351	$title = sprintf(__('%d module', '%d modules', $indexes[$char]), $indexes[$char]);
352	$buttons[] = '<li class="btn" title="'.$title.'"><a href="'.$this->getURL('m_nav='.$char).'" title="'.$title.'"> '.$char.' </a></li>';
353	}
354	# Letter without modules
355	else {
356	$buttons[] = '<li class="btn no-link" title="'.__('no module').'"> '.$char.' </li>';
357	}
358	}
359	# Parse navigation menu
360	echo '<div class="pager">'.__('Browse index:').' <ul class="index">'.implode('',$buttons).'</ul></div>';
361
362	return $this;
363	}
364	//@}
365
366	/// @name Sort methods
367	//@{
368	/**
369	* Set default sort field.
370	*
371	* @return adminModulesList self instance
372	*/
373	public function setSort($field, $asc=true)
374	{
375	$this->sort_field = $field;
376	$this->sort_asc = (boolean) $asc;
377
378	return $this;
379	}
380
381	/**
382	* Get sort field from query.
383	*
384	* @return Query sort field or default one
385	*/
386	public function getSort()
387	{
388	return !empty($_REQUEST['m_sort']) ? $_REQUEST['m_sort'] : $this->sort_field;
389	}
390
391	/**
392	* Display sort field form.
393	*
394	* @note This method is not implemented yet
395	* @return adminModulesList self instance
396	*/
397	public function displaySort()
398	{
399	//
400
401	return $this;
402	}
403	//@}
404
405	/// @name Modules methods
406	//@{
407	/**
408	* Set modules and sanitize them.
409	*
410	* @return adminModulesList self instance
411	*/
412	public function setModules($modules)
413	{
414	$this->data = array();
415	if (!empty($modules) && is_array($modules)) {
416	foreach($modules as $id => $module) {
417	$this->data[$id] = self::sanitizeModule($id, $module);
418	}
419	}
420	return $this;
421	}
422
423	/**
424	* Get modules currently set.
425	*
426	* @return Array of modules
427	*/
428	public function getModules()
429	{
430	return $this->data;
431	}
432
433	/**
434	* Sanitize a module.
435	*
436	* This clean infos of a module by adding default keys
437	* and clean some of them, sanitize module can safely
438	* be used in lists.
439	*
440	* @return Array of the module informations
441	*/
442	public static function sanitizeModule($id, $module)
443	{
444	$label = empty($module['label']) ? $id : $module['label'];
445	$name = __(empty($module['name']) ? $label : $module['name']);
446
447	return array_merge(
448	# Default values
449	array(
450	'desc' => '',
451	'author' => '',
452	'version' => 0,
453	'current_version' => 0,
454	'root' => '',
455	'root_writable' => false,
456	'permissions' => null,
457	'parent' => null,
458	'priority' => 1000,
459	'standalone_config' => false,
460	'support' => '',
461	'section' => '',
462	'tags' => '',
463	'details' => '',
464	'sshot' => '',
465	'score' => 0,
466	'type' => null
467	),
468	# Module's values
469	$module,
470	# Clean up values
471	array(
472	'id' => $id,
473	'sid' => self::sanitizeString($id),
474	'label' => $label,
475	'name' => $name,
476	'sname' => self::sanitizeString($name)
477	)
478	);
479	}
480
481	/**
482	* Check if a module is part of the distribution.
483	*
484	* @param string $id Module root directory
485	* @return True if module is part of the distribution
486	*/
487	public static function isDistributedModule($id)
488	{
489	$distributed_modules = self::$distributed_modules;
490
491	return is_array($distributed_modules) && in_array($id, $distributed_modules);
492	}
493
494	/**
495	* Sort modules list by specific field.
496	*
497	* @param string $module Array of modules
498	* @param string $field Field to sort from
499	* @param bollean $asc Sort asc if true, else decs
500	* @return Array of sorted modules
501	*/
502	public static function sortModules($modules, $field, $asc=true)
503	{
504	$sorter = array();
505	foreach($modules as $id => $module) {
506	$sorter[$id] = isset($module[$field]) ? $module[$field] : $field;
507	}
508	array_multisort($sorter, $asc ? SORT_ASC : SORT_DESC, $modules);
509
510	return $modules;
511	}
512
513	/**
514	* Display list of modules.
515	*
516	* @param array $cols List of colones (module field) to display
517	* @param array $actions List of predefined actions to show on form
518	* @param boolean $nav_limit Limit list to previously selected index
519	* @return adminModulesList self instance
520	*/
521	public function displayModules($cols=array('name', 'version', 'desc'), $actions=array(), $nav_limit=false)
522	{
523	echo
524	'<div class="table-outer">'.
525	'<table id="'.html::escapeHTML($this->list_id).'" class="modules'.(in_array('expander', $cols) ? ' expandable' : '').'">'.
526	'<caption class="hidden">'.html::escapeHTML(__('Modules list')).'</caption><tr>';
527
528	if (in_array('name', $cols)) {
529	echo
530	'<th class="first nowrap"'.(in_array('icon', $cols) ? ' colspan="2"' : '').'>'.__('Name').'</th>';
531	}
532
533	if (in_array('score', $cols) && $this->getSearch() !== null && defined('DC_DEBUG') && DC_DEBUG) {
534	echo
535	'<th class="nowrap">'.__('Score').'</th>';
536	}
537
538	if (in_array('version', $cols)) {
539	echo
540	'<th class="nowrap count" scope="col">'.__('Version').'</th>';
541	}
542
543	if (in_array('current_version', $cols)) {
544	echo
545	'<th class="nowrap count" scope="col">'.__('Current version').'</th>';
546	}
547
548	if (in_array('desc', $cols)) {
549	echo
550	'<th class="nowrap" scope="col">'.__('Details').'</th>';
551	}
552
553	if (in_array('distrib', $cols)) {
554	echo
555	'<th'.(in_array('desc', $cols) ? '' : ' class="maximal"').'></th>';
556	}
557
558	if (!empty($actions) && $this->core->auth->isSuperAdmin()) {
559	echo
560	'<th class="minimal nowrap">'.__('Action').'</th>';
561	}
562
563	echo
564	'</tr>';
565
566	$sort_field = $this->getSort();
567
568	# Sort modules by $sort_field (default sname)
569	$modules = $this->getSearch() === null ?
570	self::sortModules($this->data, $sort_field, $this->sort_asc) :
571	$this->data;
572
573	$count = 0;
574	foreach ($modules as $id => $module)
575	{
576	# Show only requested modules
577	if ($nav_limit && $this->getSearch() === null) {
578	$char = substr($module[$sort_field], 0, 1);
579	if (!in_array($char, $this->nav_list)) {
580	$char = $this->nav_special;
581	}
582	if ($this->getIndex() != $char) {
583	continue;
584	}
585	}
586
587	echo
588	'<tr class="line" id="'.html::escapeHTML($this->list_id).'_m_'.html::escapeHTML($id).'">';
589
590	$tds = 0;
591
592	if (in_array('icon', $cols)) {
593	$tds++;
594	echo
595	'<td class="module-icon nowrap">'.sprintf(
596	'<img alt="%1$s" title="%1$s" src="%2$s" />',
597	html::escapeHTML($id), file_exists($module['root'].'/icon.png') ? 'index.php?pf='.$id.'/icon.png' : 'images/module.png'
598	).'</td>';
599	}
600
601	$tds++;
602	echo
603	'<td class="module-name nowrap" scope="row">'.html::escapeHTML($module['name']).'</td>';
604
605	# Display score only for debug purpose
606	if (in_array('score', $cols) && $this->getSearch() !== null && defined('DC_DEBUG') && DC_DEBUG) {
607	$tds++;
608	echo
609	'<td class="module-version nowrap count"><span class="debug">'.$module['score'].'</span></td>';
610	}
611
612	if (in_array('version', $cols)) {
613	$tds++;
614	echo
615	'<td class="module-version nowrap count">'.html::escapeHTML($module['version']).'</td>';
616	}
617
618	if (in_array('current_version', $cols)) {
619	$tds++;
620	echo
621	'<td class="module-current-version nowrap count">'.html::escapeHTML($module['current_version']).'</td>';
622	}
623
624	if (in_array('desc', $cols)) {
625	$tds++;
626	echo
627	'<td class="module-desc maximal">'.html::escapeHTML($module['desc']).'</td>';
628	}
629
630	if (in_array('distrib', $cols)) {
631	$tds++;
632	echo
633	'<td class="module-distrib">'.(self::isDistributedModule($id) ?
634	'<img src="images/dotclear_pw.png" alt="'.
635	__('Module from official distribution').'" title="'.
636	__('module from official distribution').'" />'
637	: '').'</td>';
638	}
639
640	if (!empty($actions) && $this->core->auth->isSuperAdmin()) {
641	$buttons = $this->getActions($id, $module, $actions);
642
643	$tds++;
644	echo
645	'<td class="module-actions nowrap">'.
646
647	'<form action="'.$this->getURL().'" method="post">'.
648	'<div>'.
649	$this->core->formNonce().
650	form::hidden(array('module'), html::escapeHTML($id)).
651
652	implode(' ', $buttons).
653
654	'</div>'.
655	'</form>'.
656
657	'</td>';
658	}
659
660	echo
661	'</tr>';
662
663	# Other informations
664	if (in_array('expander', $cols)) {
665	echo
666	'<tr class="module-more"><td colspan="'.$tds.'" class="expand">';
667
668	if (!empty($module['author']) \|\| !empty($module['details']) \|\| !empty($module['support'])) {
669	echo
670	'<div><ul class="mod-more">';
671
672	if (!empty($module['author'])) {
673	echo
674	'<li class="module-author">'.__('Author:').' '.html::escapeHTML($module['author']).'</li>';
675	}
676
677	$more = array();
678	if (!empty($module['details'])) {
679	$more[] = '<a class="module-details" href="'.$module['details'].'">'.__('Details').'</a>';
680	}
681
682	if (!empty($module['support'])) {
683	$more[] = '<a class="module-support" href="'.$module['support'].'">'.__('Support').'</a>';
684	}
685
686	if (!empty($more)) {
687	echo
688	'<li>'.implode(' - ', $more).'</li>';
689	}
690
691	echo
692	'</ul></div>';
693	}
694
695	$config = !empty($module['root']) && file_exists(path::real($module['root'].'/_config.php'));
696
697	if ($config \|\| !empty($module['section']) \|\| !empty($module['section'])) {
698	echo
699	'<div><ul class="mod-more">';
700
701	if ($config) {
702	echo
703	'<li><a class="module-config" href="'.$this->getURL('module='.$id.'&conf=1').'">'.__('Configure plugin').'</a></li>';
704	}
705
706	if (!empty($module['section'])) {
707	echo
708	'<li class="module-section">'.__('Section:').' '.html::escapeHTML($module['section']).'</li>';
709	}
710
711	if (!empty($module['section'])) {
712	echo
713	'<li class="module-tags">'.__('Tags:').' '.html::escapeHTML($module['tags']).'</li>';
714	}
715
716	echo
717	'</ul></div>';
718	}
719
720	echo
721	'</td></tr>';
722	}
723
724	$count++;
725	}
726	echo
727	'</table></div>';
728
729	if(!$count && $this->getSearch() === null) {
730	echo
731	'<p class="message">'.__('No module matches your search.').'</p>';
732	}
733
734	return $this;
735	}
736
737	/**
738	* Get action buttons to add to modules list.
739	*
740	* @param string $id Module ID
741	* @param array $module Module info
742	* @param array $actions Actions keys
743	* @return Array of actions buttons
744	*/
745	protected function getActions($id, $module, $actions)
746	{
747	$submits = array();
748
749	# Use loop to keep requested order
750	foreach($actions as $action) {
751	switch($action) {
752
753	# Deactivate
754	case 'activate': if ($module['root_writable']) {
755	$submits[] =
756	'<input type="submit" name="activate" value="'.__('Activate').'" />';
757	} break;
758
759	# Activate
760	case 'deactivate': if ($module['root_writable']) {
761	$submits[] =
762	'<input type="submit" name="deactivate" value="'.__('Deactivate').'" class="reset" />';
763	} break;
764
765	# Delete
766	case 'delete': if ($this->isDeletablePath($module['root'])) {
767	$dev = !preg_match('!^'.$this->path_pattern.'!', $module['root']) && defined('DC_DEV') && DC_DEV ? ' debug' : '';
768	$submits[] =
769	'<input type="submit" class="delete '.$dev.'" name="delete" value="'.__('Delete').'" />';
770	} break;
771
772	# Install (from store)
773	case 'install': if ($this->path_writable) {
774	$submits[] =
775	'<input type="submit" name="install" value="'.__('Install').'" />';
776	} break;
777
778	# Update (from store)
779	case 'update': if ($this->path_writable) {
780	$submits[] =
781	'<input type="submit" name="update" value="'.__('Update').'" />';
782	} break;
783
784	# Behavior
785	case 'behavior':
786
787	# --BEHAVIOR-- adminModulesListGetActions
788	$tmp = $this->core->callBehavior('adminModulesListGetActions', $this, $id, $module);
789
790	if (!empty($tmp)) {
791	$submits[] = $tmp;
792	}
793	break;
794	}
795	}
796
797
798	return $submits;
799	}
800
801	/**
802	* Execute POST action.
803	*
804	* @note Set a notice on success through dcPage::addSuccessNotice
805	* @throw Exception Module not find or command failed
806	* @param string $prefix Prefix used on behaviors
807	* @return Null
808	*/
809	public function doActions($prefix)
810	{
811	if (empty($_POST) \|\| !empty($_REQUEST['conf'])
812	\|\| !$this->core->auth->isSuperAdmin() \|\| !$this->isWritablePath()) {
813	return null;
814	}
815
816	# List actions
817	if (!empty($_POST['module'])) {
818
819	$id = $_POST['module'];
820
821	if (!empty($_POST['activate'])) {
822
823	$enabled = $this->modules->getDisabledModules();
824	if (!isset($enabled[$id])) {
825	throw new Exception(__('No such module.'));
826	}
827
828	# --BEHAVIOR-- moduleBeforeActivate
829	$this->core->callBehavior($prefix.'BeforeActivate', $id);
830
831	$this->modules->activateModule($id);
832
833	# --BEHAVIOR-- moduleAfterActivate
834	$this->core->callBehavior($prefix.'AfterActivate', $id);
835
836	dcPage::addSuccessNotice(__('Module has been successfully activated.'));
837	http::redirect($this->getURL());
838	}
839
840	elseif (!empty($_POST['deactivate'])) {
841
842	if (!$this->modules->moduleExists($id)) {
843	throw new Exception(__('No such module.'));
844	}
845
846	$module = $this->modules->getModules($id);
847	$module['id'] = $id;
848
849	if (!$module['root_writable']) {
850	throw new Exception(__('You don\'t have permissions to deactivate this module.'));
851	}
852
853	# --BEHAVIOR-- moduleBeforeDeactivate
854	$this->core->callBehavior($prefix.'BeforeDeactivate', $module);
855
856	$this->modules->deactivateModule($id);
857
858	# --BEHAVIOR-- moduleAfterDeactivate
859	$this->core->callBehavior($prefix.'AfterDeactivate', $module);
860
861	dcPage::addSuccessNotice(__('Module has been successfully deactivated.'));
862	http::redirect($this->getURL());
863	}
864
865	elseif (!empty($_POST['delete'])) {
866
867	$disabled = $this->modules->getDisabledModules();
868	if (!isset($disabled[$id])) {
869
870	if (!$this->modules->moduleExists($id)) {
871	throw new Exception(__('No such module.'));
872	}
873
874	$module = $this->modules->getModules($id);
875	$module['id'] = $id;
876
877	if (!$this->isDeletablePath($module['root'])) {
878	throw new Exception(__("You don't have permissions to delete this module."));
879	}
880
881	# --BEHAVIOR-- moduleBeforeDelete
882	$this->core->callBehavior($prefix.'BeforeDelete', $module);
883
884	$this->modules->deleteModule($id);
885
886	# --BEHAVIOR-- moduleAfterDelete
887	$this->core->callBehavior($prefix.'AfterDelete', $module);
888	}
889	else {
890	$this->modules->deleteModule($id, true);
891	}
892
893	dcPage::addSuccessNotice(__('Module has been successfully deleted.'));
894	http::redirect($this->getURL());
895	}
896
897	elseif (!empty($_POST['install'])) {
898
899	$updated = $this->store->get();
900	if (!isset($updated[$id])) {
901	throw new Exception(__('No such module.'));
902	}
903
904	$module = $updated[$id];
905	$module['id'] = $id;
906
907	$dest = $this->getPath().'/'.basename($module['file']);
908
909	# --BEHAVIOR-- moduleBeforeAdd
910	$this->core->callBehavior($prefix.'BeforeAdd', $module);
911
912	$ret_code = $this->store->process($module['file'], $dest);
913
914	# --BEHAVIOR-- moduleAfterAdd
915	$this->core->callBehavior($prefix.'AfterAdd', $module);
916
917	dcPage::addSuccessNotice($ret_code == 2 ?
918	__('Module has been successfully updated.') :
919	__('Module has been successfully installed.')
920	);
921	http::redirect($this->getURL());
922	}
923
924	elseif (!empty($_POST['update'])) {
925
926	$updated = $this->store->get(true);
927	if (!isset($updated[$id])) {
928	throw new Exception(__('No such module.'));
929	}
930
931	if (!$this->modules->moduleExists($id)) {
932	throw new Exception(__('No such module.'));
933	}
934
935	$tab = count($updated) > 1 ? '' : '#'.$prefix;
936
937	$module = $updated[$id];
938	$module['id'] = $id;
939
940	if (!self::$allow_multi_install) {
941	$dest = $module['root'].'/../'.basename($module['file']);
942	}
943	else {
944	$dest = $this->getPath().'/'.basename($module['file']);
945	if ($module['root'] != $dest) {
946	@file_put_contents($module['root'].'/_disabled', '');
947	}
948	}
949
950	# --BEHAVIOR-- moduleBeforeUpdate
951	$this->core->callBehavior($prefix.'BeforeUpdate', $module);
952
953	$this->store->process($module['file'], $dest);
954
955	# --BEHAVIOR-- moduleAfterUpdate
956	$this->core->callBehavior($prefix.'AfterUpdate', $module);
957
958	dcPage::addSuccessNotice(__('Module has been successfully updated.'));
959	http::redirect($this->getURL().$tab);
960	}
961	else {
962
963	# --BEHAVIOR-- adminModulesListDoActions
964	$this->core->callBehavior('adminModulesListDoActions', $this, $id, $prefix);
965
966	}
967	}
968	# Manual actions
969	elseif (!empty($_POST['upload_pkg']) && !empty($_FILES['pkg_file'])
970	\|\| !empty($_POST['fetch_pkg']) && !empty($_POST['pkg_url']))
971	{
972	if (empty($_POST['your_pwd']) \|\| !$this->core->auth->checkPassword(crypt::hmac(DC_MASTER_KEY, $_POST['your_pwd']))) {
973	throw new Exception(__('Password verification failed'));
974	}
975
976	if (!empty($_POST['upload_pkg'])) {
977	files::uploadStatus($_FILES['pkg_file']);
978
979	$dest = $this->getPath().'/'.$_FILES['pkg_file']['name'];
980	if (!move_uploaded_file($_FILES['pkg_file']['tmp_name'], $dest)) {
981	throw new Exception(__('Unable to move uploaded file.'));
982	}
983	}
984	else {
985	$url = urldecode($_POST['pkg_url']);
986	$dest = $this->getPath().'/'.basename($url);
987	$this->store->download($url, $dest);
988	}
989
990	# --BEHAVIOR-- moduleBeforeAdd
991	$this->core->callBehavior($prefix.'BeforeAdd', null);
992
993	$ret_code = $this->store->install($dest);
994
995	# --BEHAVIOR-- moduleAfterAdd
996	$this->core->callBehavior($prefix.'AfterAdd', null);
997
998	dcPage::addSuccessNotice($ret_code == 2 ?
999	__('Module has been successfully updated.') :
1000	__('Module has been successfully installed.')
1001	);
1002	http::redirect($this->getURL().'#'.$prefix);
1003	}
1004
1005	return null;
1006	}
1007
1008	/**
1009	* Display tab for manual installation.
1010	*
1011	* @return adminModulesList self instance
1012	*/
1013	public function displayManualForm()
1014	{
1015	if (!$this->core->auth->isSuperAdmin() \|\| !$this->isWritablePath()) {
1016	return null;
1017	}
1018
1019	# 'Upload module' form
1020	echo
1021	'<form method="post" action="'.$this->getURL().'" id="uploadpkg" enctype="multipart/form-data" class="fieldset">'.
1022	'<h4>'.__('Upload a zip file').'</h4>'.
1023	'<p class="field"><label for="pkg_file" class="classic required"><abbr title="'.__('Required field').'">*</abbr> '.__('Zip file path:').'</label> '.
1024	'<input type="file" name="pkg_file" id="pkg_file" /></p>'.
1025	'<p class="field"><label for="your_pwd1" class="classic required"><abbr title="'.__('Required field').'">*</abbr> '.__('Your password:').'</label> '.
1026	form::password(array('your_pwd','your_pwd1'),20,255).'</p>'.
1027	'<p><input type="submit" name="upload_pkg" value="'.__('Upload').'" />'.
1028	$this->core->formNonce().'</p>'.
1029	'</form>';
1030
1031	# 'Fetch module' form
1032	echo
1033	'<form method="post" action="'.$this->getURL().'" id="fetchpkg" class="fieldset">'.
1034	'<h4>'.__('Download a zip file').'</h4>'.
1035	'<p class="field"><label for="pkg_url" class="classic required"><abbr title="'.__('Required field').'">*</abbr> '.__('Zip file URL:').'</label> '.
1036	form::field(array('pkg_url','pkg_url'),40,255).'</p>'.
1037	'<p class="field"><label for="your_pwd2" class="classic required"><abbr title="'.__('Required field').'">*</abbr> '.__('Your password:').'</label> '.
1038	form::password(array('your_pwd','your_pwd2'),20,255).'</p>'.
1039	'<p><input type="submit" name="fetch_pkg" value="'.__('Download').'" />'.
1040	$this->core->formNonce().'</p>'.
1041	'</form>';
1042
1043	return $this;
1044	}
1045	//@}
1046
1047	/// @name Module configuration methods
1048	//@{
1049	/**
1050	* Prepare module configuration.
1051	*
1052	* We need to get configuration content in three steps
1053	* and out of this class to keep backward compatibility.
1054	*
1055	* if ($xxx->setConfiguration()) {
1056	* include $xxx->includeConfiguration();
1057	* }
1058	* $xxx->getConfiguration();
1059	* ... [put here page headers and other stuff]
1060	* $xxx->displayConfiguration();
1061	*
1062	* @param string $id Module to work on or it gather through REQUEST
1063	* @return True if config set
1064	*/
1065	public function setConfiguration($id=null)
1066	{
1067	if (empty($_REQUEST['conf']) \|\| empty($_REQUEST['module']) && !$id) {
1068	return false;
1069	}
1070
1071	if (!empty($_REQUEST['module']) && empty($id)) {
1072	$id = $_REQUEST['module'];
1073	}
1074
1075	if (!$this->modules->moduleExists($id)) {
1076	$this->core->error->add(__('Unknow module ID'));
1077	return false;
1078	}
1079
1080	$module = $this->modules->getModules($id);
1081	$module = self::sanitizeModule($id, $module);
1082	$file = path::real($module['root'].'/_config.php');
1083
1084	if (!file_exists($file)) {
1085	$this->core->error->add(__('This module has no configuration file.'));
1086	return false;
1087	}
1088
1089	$this->config_module = $module;
1090	$this->config_file = $file;
1091	$this->config_content = '';
1092
1093	if (!defined('DC_CONTEXT_MODULE')) {
1094	define('DC_CONTEXT_MODULE', true);
1095	}
1096
1097	return true;
1098	}
1099
1100	/**
1101	* Get path of module configuration file.
1102	*
1103	* @note Required previously set file info
1104	* @return Full path of config file or null
1105	*/
1106	public function includeConfiguration()
1107	{
1108	if (!$this->config_file) {
1109	return null;
1110	}
1111	$this->setRedir($this->getURL().'#plugins');
1112
1113	ob_start();
1114
1115	return $this->config_file;
1116	}
1117
1118	/**
1119	* Gather module configuration file content.
1120	*
1121	* @note Required previously file inclusion
1122	* @return True if content has been captured
1123	*/
1124	public function getConfiguration()
1125	{
1126	if ($this->config_file) {
1127	$this->config_content = ob_get_contents();
1128	}
1129
1130	ob_end_clean();
1131
1132	return !empty($this->file_content);
1133	}
1134
1135	/**
1136	* Display module configuration form.
1137	*
1138	* @note Required previously gathered content
1139	* @return adminModulesList self instance
1140	*/
1141	public function displayConfiguration()
1142	{
1143	if ($this->config_file) {
1144
1145	if (!$this->config_module['standalone_config']) {
1146	echo
1147	'<form id="module_config" action="'.$this->getURL('conf=1').'" method="post" enctype="multipart/form-data">'.
1148	'<h3>'.sprintf(__('Configure plugin "%s"'), html::escapeHTML($this->config_module['name'])).'</h3>'.
1149	'<p><a class="back" href="'.$this->getRedir().'">'.__('Back').'</a></p>';
1150	}
1151
1152	echo $this->config_content;
1153
1154	if (!$this->config_module['standalone_config']) {
1155	echo
1156	'<p class="clear"><input type="submit" name="save" value="'.__('Save').'" />'.
1157	form::hidden('module', $this->config_module['id']).
1158	form::hidden('redir', $this->getRedir()).
1159	$this->core->formNonce().'</p>'.
1160	'</form>';
1161	}
1162	}
1163
1164	return $this;
1165	}
1166	//@}
1167
1168	/**
1169	* Helper to sanitize a string.
1170	*
1171	* Used for search or id.
1172	*
1173	* @param string $str String to sanitize
1174	* @return Sanitized string
1175	*/
1176	public static function sanitizeString($str)
1177	{
1178	return preg_replace('/[^A-Za-z0-9\@\#+_-]/', '', strtolower($str));
1179	}
1180	}
1181
1182	/**
1183	* @ingroup DC_CORE
1184	* @brief Helper to manage list of themes.
1185	* @since 2.6
1186	*/
1187	class adminThemesList extends adminModulesList
1188	{
1189	protected $page_url = 'blog_theme.php';
1190
1191	public function displayModules($cols=array('name', 'config', 'version', 'desc'), $actions=array(), $nav_limit=false)
1192	{
1193	echo
1194	'<div id="'.html::escapeHTML($this->list_id).'" class="modules'.(in_array('expander', $cols) ? ' expandable' : '').' one-box">';
1195
1196	$sort_field = $this->getSort();
1197
1198	# Sort modules by id
1199	$modules = $this->getSearch() === null ?
1200	self::sortModules($this->data, $sort_field, $this->sort_asc) :
1201	$this->data;
1202
1203	$res = '';
1204	$count = 0;
1205	foreach ($modules as $id => $module)
1206	{
1207	# Show only requested modules
1208	if ($nav_limit && $this->getSearch() === null) {
1209	$char = substr($module[$sort_field], 0, 1);
1210	if (!in_array($char, $this->nav_list)) {
1211	$char = $this->nav_special;
1212	}
1213	if ($this->getIndex() != $char) {
1214	continue;
1215	}
1216	}
1217
1218	$current = $this->core->blog->settings->system->theme == $id && $this->modules->moduleExists($id);
1219	$distrib = self::isDistributedModule($id) ? ' dc-box' : '';
1220
1221	$line =
1222	'<div class="box '.($current ? 'medium current-theme' : 'theme').$distrib.'">';
1223
1224	if (in_array('name', $cols) && !$current) {
1225	$line .=
1226	'<h4 class="module-name">'.html::escapeHTML($module['name']).'</h4>';
1227	}
1228
1229	# Display score only for debug purpose
1230	if (in_array('score', $cols) && $this->getSearch() !== null && defined('DC_DEBUG') && DC_DEBUG) {
1231	$line .=
1232	'<p class="module-score debug">'.sprintf(__('Score: %s'), $module['score']).'</p>';
1233	}
1234
1235	if (in_array('sshot', $cols)) {
1236	# Screenshot from url
1237	if (preg_match('#^http(s)?://#', $module['sshot'])) {
1238	$sshot = $module['sshot'];
1239	}
1240	# Screenshot from installed module
1241	elseif (file_exists($this->core->blog->themes_path.'/'.$id.'/screenshot.jpg')) {
1242	$sshot = $this->getURL('shot='.rawurlencode($id));
1243	}
1244	# Default screenshot
1245	else {
1246	$sshot = 'images/noscreenshot.png';
1247	}
1248
1249	$line .=
1250	'<div class="module-sshot"><img src="'.$sshot.'" alt="'.
1251	sprintf(__('%s screenshot.'), html::escapeHTML($module['name'])).'" /></div>';
1252	}
1253
1254	$line .=
1255	'<div class="module-infos toggle-bloc">';
1256
1257	if (in_array('name', $cols) && $current) {
1258	$line .=
1259	'<h4 class="module-name">'.html::escapeHTML($module['name']).'</h4>';
1260	}
1261
1262	$line .=
1263	'<p>';
1264
1265	if (in_array('desc', $cols)) {
1266	$line .=
1267	'<span class="module-desc">'.html::escapeHTML($module['desc']).'</span> ';
1268	}
1269
1270	if (in_array('author', $cols)) {
1271	$line .=
1272	'<span class="module-author">'.sprintf(__('by %s'),html::escapeHTML($module['author'])).'</span> ';
1273	}
1274
1275	if (in_array('version', $cols)) {
1276	$line .=
1277	'<span class="module-version">'.sprintf(__('version %s'),html::escapeHTML($module['version'])).'</span> ';
1278	}
1279
1280	if (in_array('current_version', $cols)) {
1281	$line .=
1282	'<span class="module-current-version">'.sprintf(__('(current version %s)'),html::escapeHTML($module['current_version'])).'</span> ';
1283	}
1284
1285	if (in_array('parent', $cols) && !empty($module['parent'])) {
1286	if ($this->modules->moduleExists($module['parent'])) {
1287	$line .=
1288	'<span class="module-parent-ok">'.sprintf(__('(built on "%s")'),html::escapeHTML($module['parent'])).'</span> ';
1289	}
1290	else {
1291	$line .=
1292	'<span class="module-parent-missing">'.sprintf(__('(requires "%s")'),html::escapeHTML($module['parent'])).'</span> ';
1293	}
1294	}
1295
1296	$has_details = in_array('details', $cols) && !empty($module['details']);
1297	$has_support = in_array('support', $cols) && !empty($module['support']);
1298	if ($has_details \|\| $has_support) {
1299	$line .=
1300	'<span class="mod-more">';
1301
1302	if ($has_details) {
1303	$line .=
1304	'<a class="module-details" href="'.$module['details'].'">'.__('Details').'</a>';
1305	}
1306
1307	if ($has_support) {
1308	$line .=
1309	' - <a class="module-support" href="'.$module['support'].'">'.__('Support').'</a>';
1310	}
1311
1312	$line .=
1313	'</span>';
1314	}
1315
1316	$line .=
1317	'</p>'.
1318	'</div>';
1319
1320	$line .=
1321	'<div class="module-actions toggle-bloc">';
1322
1323	# Plugins actions
1324	if ($current) {
1325
1326	# _GET actions
1327	if (file_exists(path::real($this->core->blog->themes_path.'/'.$id).'/style.css')) {
1328	$theme_url = preg_match('#^http(s)?://#', $this->core->blog->settings->system->themes_url) ?
1329	http::concatURL($this->core->blog->settings->system->themes_url, '/'.$id) :
1330	http::concatURL($this->core->blog->url, $this->core->blog->settings->system->themes_url.'/'.$id);
1331	$line .=
1332	'<p><a href="'.$theme_url.'/style.css">'.__('View stylesheet').'</a></p>';
1333	}
1334
1335	$line .= '<div class="current-actions">';
1336
1337	if (file_exists(path::real($this->core->blog->themes_path.'/'.$id).'/_config.php')) {
1338	$line .=
1339	'<p><a href="'.$this->getURL('module='.$id.'&conf=1', false).'" class="button submit">'.__('Configure theme').'</a></p>';
1340	}
1341
1342	# --BEHAVIOR-- adminCurrentThemeDetails
1343	$line .=
1344	$this->core->callBehavior('adminCurrentThemeDetails', $this->core, $id, $module);
1345
1346	$line .= '</div>';
1347	}
1348
1349	# _POST actions
1350	if (!empty($actions)) {
1351	$line .=
1352	'<form action="'.$this->getURL().'" method="post" class="actions-buttons">'.
1353	'<p>'.
1354	$this->core->formNonce().
1355	form::hidden(array('module'), html::escapeHTML($id)).
1356
1357	implode(' ', $this->getActions($id, $module, $actions)).
1358
1359	'</p>'.
1360	'</form>';
1361	}
1362
1363	$line .=
1364	'</div>';
1365
1366	$line .=
1367	'</div>';
1368
1369	$count++;
1370
1371	$res = $current ? $line.$res : $res.$line;
1372	}
1373	echo
1374	$res.
1375	'</div>';
1376
1377	if(!$count && $this->getSearch() === null) {
1378	echo
1379	'<p class="message">'.__('No module matches your search.').'</p>';
1380	}
1381	}
1382
1383	protected function getActions($id, $module, $actions)
1384	{
1385	$submits = array();
1386
1387	$this->core->blog->settings->addNamespace('system');
1388	if ($id != $this->core->blog->settings->system->theme) {
1389
1390	# Select theme to use on curent blog
1391	if (in_array('select', $actions) && $this->path_writable) {
1392	$submits[] =
1393	'<input type="submit" name="select" value="'.__('Use this one').'" />';
1394	}
1395	}
1396
1397	return array_merge(
1398	$submits,
1399	parent::getActions($id, $module, $actions)
1400	);
1401	}
1402
1403	public function doActions($prefix)
1404	{
1405	if (!empty($_POST) && empty($_REQUEST['conf']) && $this->isWritablePath()) {
1406
1407	# Select theme to use on curent blog
1408	if (!empty($_POST['module']) && !empty($_POST['select'])) {
1409	$id = $_POST['module'];
1410
1411	if (!$this->modules->moduleExists($id)) {
1412	throw new Exception(__('No such module.'));
1413	}
1414
1415	$this->core->blog->settings->addNamespace('system');
1416	$this->core->blog->settings->system->put('theme',$id);
1417	$this->core->blog->triggerBlog();
1418
1419	dcPage::addSuccessNotice(__('Module has been successfully selected.'));
1420	http::redirect($this->getURL().'#themes');
1421	}
1422	}
1423
1424	return parent::doActions($prefix);
1425	}
1426	}

Note: See TracBrowser for help on using the repository browser.

Dotclear

Context Navigation

source: inc/admin/lib.moduleslist.php @ 2354:d388f7fdcb4e

Download in other formats:

Sites map