lib/plugin/WikiAdminSetExternal.php

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