]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - lib/plugin/WikiAdminSelect.php
Buttons at top of page
[SourceForge/phpwiki.git] / lib / plugin / WikiAdminSelect.php
1 <?php // -*-php-*-
2 rcs_id('$Id$');
3 /*
4  Copyright 2002 $ThePhpWikiProgrammingTeam
5
6  This file is part of PhpWiki.
7
8  PhpWiki is free software; you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation; either version 2 of the License, or
11  (at your option) any later version.
12
13  PhpWiki is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  GNU General Public License for more details.
17
18  You should have received a copy of the GNU General Public License
19  along with PhpWiki; if not, write to the Free Software
20  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 /**
24  * Allows selection of multiple pages which get passed to other
25  * WikiAdmin plugins then. Then do Rename, Remove, Chmod, Chown, ...
26  *
27  * Usage:   <?plugin WikiAdminSelect?>
28  * Author:  Reini Urban <rurban@x-ray.at>
29  *
30  * This is the base class for most WikiAdmin* classes, using
31  * collectPages() and preSelectS().
32  * "list" PagePermissions supported implicitly by PageList.
33  */
34 require_once('lib/PageList.php');
35
36 class WikiPlugin_WikiAdminSelect
37 extends WikiPlugin
38 {
39     function getName() {
40         return _("WikiAdminSelect");
41     }
42
43     function getDescription() {
44         return _("Allows selection of multiple pages which get passed to other WikiAdmin plugins.");
45     }
46
47     function getVersion() {
48         return preg_replace("/[Revision: $]/", '',
49                             "\$Revision$");
50     }
51
52     function getDefaultArguments() {
53         return array('s'       => '', // preselect pages
54                      /* select pages by meta-data: */
55                      'author'   => false,
56                      'owner'    => false,
57                      'creator'  => false,
58
59                      'only'    => '',
60                      'exclude' => '',
61                      'info'    => 'most',
62                      'sortby'  => 'pagename',
63                      'limit'    => 150,
64                      'debug'   => false);
65     }
66
67     /**
68      * Default collector for all WikiAdmin* plugins.
69      * preSelectS() is similar, but fills $this->_list
70      */
71     function collectPages(&$list, &$dbi, $sortby, $limit=0, $exclude='') {
72         $allPages = $dbi->getAllPages(0, $sortby, $limit, $exclude);
73         while ($pagehandle = $allPages->next()) {
74             $pagename = $pagehandle->getName();
75             if (empty($list[$pagename]))
76                 $list[$pagename] = 0;
77         }
78         return $list;
79     }
80
81     /**
82      * Preselect a list of pagenames by the supporting the following args:
83      * 's': comma-seperated list of pagename wildcards
84      * 'author', 'owner', 'creator': from WikiDB_Page
85      * 'only: forgot what the difference to 's' was.
86      * Sets $this->_list, which is picked up by collectPages() and is a default for p[]
87      */
88     function preSelectS (&$args, &$request) {
89         // override plugin argument by GET: probably not needed if s||="" is used
90         // anyway, we force it for unique interface.
91         if (!empty($request->getArg['s']))
92             $args['s'] = $request->getArg['s'];
93         if ( !empty($args['owner']) )
94             $sl = PageList::allPagesByOwner($args['owner'],false,$args['sortby'],$args['limit'],$args['exclude']);
95         elseif ( !empty($args['author']) )
96             $sl = PageList::allPagesByAuthor($args['author'],false,$args['sortby'],$args['limit'],$args['exclude']);
97         elseif ( !empty($args['creator']) )
98             $sl = PageList::allPagesByCreator($args['creator'],false,$args['sortby'],$args['limit'],$args['exclude']);
99         elseif ( !empty($args['s']) or !empty($args['only']) ) {
100             // all pages by name
101             $sl = explodePageList(empty($args['only']) ? $args['s'] : $args['only']);
102         }
103         $this->_list = array();
104         if (!empty($sl)) {
105             $request->setArg('verify', 1);
106             foreach ($sl as $name) {
107                 if (!empty($args['exclude'])) {
108                     if (!in_array($name, $args['exclude']))
109                         $this->_list[$name] = 1;
110                 } else {
111                     $this->_list[$name] = 1;
112                 }
113             }
114         }
115         return $this->_list;
116     }
117
118     function run($dbi, $argstr, &$request, $basepage) {
119         //if ($request->getArg('action') != 'browse')
120         //    return $this->disabled("(action != 'browse')");
121         $args = $this->getArgs($argstr, $request);
122         $this->_args = $args;
123         extract($args);
124         $this->preSelectS($args, $request);
125
126         $info = $args['info'];
127         $this->debug = $args['debug'];
128
129         // array_multisort($this->_list, SORT_NUMERIC, SORT_DESC);
130         $pagename = $request->getArg('pagename');
131         // GetUrlToSelf() with all given params
132         //$uri = $GLOBALS['HTTP_SERVER_VARS']['REQUEST_URI']; // without s would be better.
133         //$uri = $request->getURLtoSelf();//false, array('verify'));
134         $form = HTML::form(array('action' => $request->getPostURL(), 'method' => 'post'));
135         if ($request->getArg('WikiAdminSelect') == _("Go"))
136             $p = false;
137         else
138             $p = $request->getArg('p');
139         //$p = @$GLOBALS['HTTP_POST_VARS']['p'];
140         $form->pushContent(HTML::p(array('class' => 'wikitext'), _("Select: "),
141                                    HTML::input(array('type' => 'text',
142                                                      'name' => 's',
143                                                      'value' => $args['s'])),
144                                    HTML::input(array('type' => 'submit',
145                                                      'name' => 'WikiAdminSelect',
146                                                      'value' => _("Go")))));
147         if (! $request->getArg('verify')) {
148             $form->pushContent(HTML::input(array('type' => 'hidden',
149                                                  'name' => 'action',
150                                                  'value' => 'verify')));
151             $form->pushContent(Button('submit:verify', _("Select pages"),
152                                       'wikiadmin'),
153                                Button('submit:cancel', _("Cancel"), 'button'));
154         } else {
155             global $WikiTheme;
156             $form->pushContent(HTML::input(array('type' => 'hidden',
157                                                  'name' => 'action',
158                                                  'value' => 'WikiAdminSelect'))
159                                );
160             // Add the Buttons for all registered WikiAdmin plugins
161             $plugin_dir = 'lib/plugin';
162             if (defined('PHPWIKI_DIR'))
163                 $plugin_dir = PHPWIKI_DIR . "/$plugin_dir";
164             $fs = new fileSet($plugin_dir, 'WikiAdmin*.php');
165             $actions = $fs->getFiles();
166             foreach ($actions as $f) {
167                 $f = preg_replace('/.php$/','', $f);
168                 $s = preg_replace('/^WikiAdmin/','', $f);
169                 if (!in_array($s,array("Select","Utils"))) { // disable Select and Utils
170                     $form->pushContent(Button("submit:wikiadmin[$f]", _($s), "wikiadmin"));
171                     $form->pushContent($WikiTheme->getButtonSeparator());
172                 }
173             }
174             // $form->pushContent(Button('submit:cancel', _("Cancel"), 'button'));
175         }
176
177         if ($request->isPost() 
178             && ! $request->getArg('wikiadmin')
179             && !empty($p)) {
180             $this->_list = array();
181             // List all selected pages again.
182             foreach ($p as $page => $name) {
183                 $this->_list[$name] = 1;
184             }
185         }
186         elseif ($request->isPost()
187                 and $request->_user->isAdmin()
188                 and !empty($p)
189                 //and $request->getArg('verify')
190                 and ($request->getArg('action') == 'WikiAdminSelect')
191                 and $request->getArg('wikiadmin')
192                )
193         {
194             // handle external plugin
195             $loader = new WikiPluginLoader();
196             $a = array_keys($request->getArg('wikiadmin'));
197             $plugin_action = $a[0];
198             $single_arg_plugins = array("Remove");
199             if (in_array($plugin_action, $single_arg_plugins)) {
200                 $plugin = $loader->getPlugin($plugin_action);
201                 $ul = HTML::ul();
202                 foreach ($p as $page => $name) {
203                     $plugin_args = "run_page=$name";
204                     $request->setArg($plugin_action, 1);
205                     $request->setArg('p', array($page => $name));
206                     // if the plugin requires more args than the pagename,
207                     // then this plugin will not return. (Rename, SearchReplace, ...)
208                     $action_result = $plugin->run($dbi, $plugin_args, $request, $basepage);
209                     $ul->pushContent(HTML::li(fmt("Selected page '%s' passed to '%s'.",
210                                                   $name, $select)));
211                     $ul->pushContent(HTML::ul(HTML::li($action_result)));
212                 }
213             } else {
214                 // redirect to the plugin page.
215                 // in which page is this plugin?
216                 $plugin_action = preg_replace("/^WikiAdmin/","",$plugin_action);
217                 $args = array();
218                 foreach ($p as $page => $x) {
219                   $args["p[$page]"] = 1;
220                 }
221                 header("Location: ".
222                   WikiURL(_("PhpWikiAdministration")."/"._($plugin_action),$args,1));
223                 exit();
224             }
225         } elseif (empty($args['s'])) {
226             // List all pages to select from.
227             $this->_list = $this->collectPages($this->_list, $dbi, $args['sortby'], $args['limit']);
228         }
229         $pagelist = new PageList_Selectable($info, $args['exclude'], $args);
230         $pagelist->addPageList($this->_list);
231         $form->pushContent($pagelist->getContent());
232         foreach ($args as $k => $v) {
233             if (!in_array($k,array('s','WikiAdminSelect','action','verify')))
234                 $form->pushContent(HiddenInputs(array($k => $v))); // plugin params
235         }
236         /*
237         foreach ($_GET as $k => $v) {
238             if (!in_array($k,array('s','WikiAdminSelect','action')))
239                 $form->pushContent(HiddenInputs(array($k => $v))); // debugging params, ...
240         }
241         */
242         if (! $request->getArg('select')) {
243             return $form;
244         } else {
245             ; //return $action_result;
246         }
247     }
248
249     function _tablePush(&$table, $first, $second) {
250         $table->pushContent(
251                             HTML::tr(
252                                      HTML::td($first),
253                                      HTML::td($second)));
254     }
255
256 }
257
258 // Local Variables:
259 // mode: php
260 // tab-width: 8
261 // c-basic-offset: 4
262 // c-hanging-comment-ender-p: nil
263 // indent-tabs-mode: nil
264 // End:
265 ?>