lib/plugin/WikiAdminSetExternal.php

   1 <?php
   2
   3 /*
   4  * Copyright 2005 $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  * Usage:   <<WikiAdminSetExternal s||=* >> or called via WikiAdminSelect
  26  * @author:  Marc-Etienne Vargenau, Alcatel-Lucent
  27  */
  28 require_once 'lib/PageList.php';
  29 require_once 'lib/plugin/WikiAdminSelect.php';
  30
  31 class WikiPlugin_WikiAdminSetExternal
  32     extends WikiPlugin_WikiAdminSelect
  33 {
  34     function getName()
  35     {
  36         return _("WikiAdminSetExternal");
  37     }
  38
  39     function getDescription()
  40     {
  41         return _("Mark selected pages as external.");
  42     }
  43
  44     function getDefaultArguments()
  45     {
  46         return array_merge
  47         (
  48             WikiPlugin_WikiAdminSelect::getDefaultArguments(),
  49             array(
  50                 'external' => 1,
  51                 /* Columns to include in listing */
  52                 'info' => 'pagename,external,mtime',
  53             ));
  54     }
  55
  56     function setExternalPages(&$dbi, &$request, $pages)
  57     {
  58         $result = HTML::div();
  59         $ul = HTML::ul();
  60         $count = 0;
  61         foreach ($pages as $name) {
  62             $page = $dbi->getPage($name);
  63             $current = $page->getCurrentRevision();
  64             $external = $current->get('external');
  65             if (!$external) $external = 0;
  66             $external = (bool)$external;
  67             if (!$external) {
  68                 if (!mayAccessPage('change', $name)) {
  69                     $result->setAttr('class', 'error');
  70                     $result->pushContent(HTML::p(fmt("Access denied to change page “%s”.",
  71                         WikiLink($name))));
  72                 } else {
  73                     $version = $current->getVersion();
  74                     $page->set('external', (bool)1);
  75                     $ul->pushContent(HTML::li(fmt("change page “%s” to external.", WikiLink($name))));
  76                     $count++;
  77                 }
  78             }
  79         }
  80         if ($count) {
  81             $dbi->touch();
  82             $result->setAttr('class', 'feedback');
  83             if ($count == 1) {
  84                 $result->pushContent(HTML::p(_("One page has been changed:")));
  85             } else {
  86                 $result->pushContent(HTML::p(fmt("%d pages have been changed:", $count)));
  87             }
  88             $result->pushContent($ul);
  89             return $result;
  90         } else {
  91             $result->setAttr('class', 'error');
  92             $result->pushContent(HTML::p(_("No pages changed.")));
  93             return $result;
  94         }
  95     }
  96
  97     function run($dbi, $argstr, &$request, $basepage)
  98     {
  99         if ($request->getArg('action') != 'browse') {
 100             if (!$request->getArg('action') == _("PhpWikiAdministration/SetExternal")) {
 101                 return $this->disabled(_("Plugin not run: not in browse mode"));
 102             }
 103         }
 104
 105         $args = $this->getArgs($argstr, $request);
 106         $this->_args = $args;
 107         $this->preSelectS($args, $request);
 108
 109         $p = $request->getArg('p');
 110         if (!$p) $p = $this->_list;
 111         $post_args = $request->getArg('admin_external');
 112         if (!$request->isPost() and empty($post_args['external']))
 113             $post_args['external'] = $args['external'];
 114         $pages = array();
 115         if ($p && !$request->isPost())
 116             $pages = $p;
 117         if ($p && $request->isPost() &&
 118             !empty($post_args['button']) && empty($post_args['cancel'])
 119         ) {
 120             // without individual PagePermissions:
 121             if (!ENABLE_PAGEPERM and !$request->_user->isAdmin()) {
 122                 $request->_notAuthorized(WIKIAUTH_ADMIN);
 123                 $this->disabled("! user->isAdmin");
 124             }
 125             // Real action
 126             return $this->setExternalPages($dbi, $request, array_keys($p));
 127         }
 128         $pages = $this->collectPages($pages, $dbi, $args['sortby'], $args['limit'], $args['exclude']);
 129         $pagelist = new PageList_Selectable($args['info'], $args['exclude'], $args);
 130         $pagelist->addPageList($pages);
 131
 132         $header = HTML::fieldset();
 133         $button_label = _("Set pages to external");
 134         $header->pushContent(HTML::legend(_("Select the pages to set as external")));
 135
 136         $buttons = HTML::p(Button('submit:admin_external[button]', $button_label, 'wikiadmin'),
 137             Button('submit:admin_external[cancel]', _("Cancel"), 'button'));
 138         $header->pushContent($buttons);
 139
 140         return HTML::form(array('action' => $request->getPostURL(),
 141                 'method' => 'post'),
 142             $header,
 143             $pagelist->getContent(),
 144             HiddenInputs($request->getArgs(),
 145                 false,
 146                 array('admin_external')),
 147             ENABLE_PAGEPERM
 148                 ? ''
 149                 : HiddenInputs(array('require_authority_for_post' => WIKIAUTH_ADMIN)));
 150     }
 151
 152 }
 153
 154 // Local Variables:
 155 // mode: php
 156 // tab-width: 8
 157 // c-basic-offset: 4
 158 // c-hanging-comment-ender-p: nil
 159 // indent-tabs-mode: nil
 160 // End: