lib/plugin/WikiAdminSelect.php

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