lib/plugin/WikiAdminMarkup.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:   <<WikiAdminMarkup s||=* >> or called via WikiAdminSelect
  26  * @author:  Reini Urban <rurban@x-ray.at>
  27  *
  28  */
  29 require_once 'lib/PageList.php';
  30 require_once 'lib/plugin/WikiAdminSelect.php';
  31
  32 class WikiPlugin_WikiAdminMarkup
  33     extends WikiPlugin_WikiAdminSelect
  34 {
  35     function getName()
  36     {
  37         return _("WikiAdminMarkup");
  38     }
  39
  40     function getDescription()
  41     {
  42         return _("Change the markup type of selected pages.");
  43     }
  44
  45     function getDefaultArguments()
  46     {
  47         return array_merge
  48         (
  49             WikiPlugin_WikiAdminSelect::getDefaultArguments(),
  50             array(
  51                 'markup' => 2,
  52                 /* Columns to include in listing */
  53                 'info' => 'pagename,markup,mtime',
  54             ));
  55     }
  56
  57     function chmarkupPages(&$dbi, &$request, $pages, $newmarkup)
  58     {
  59         $result = HTML::div();
  60         $ul = HTML::ul();
  61         $count = 0;
  62         foreach ($pages as $name) {
  63             $page = $dbi->getPage($name);
  64             $current = $page->getCurrentRevision();
  65             $markup = $current->get('markup');
  66             if (!$markup or $newmarkup != $markup) {
  67                 if (!mayAccessPage('change', $name)) {
  68                     $result->setAttr('class', 'error');
  69                     $result->pushContent(HTML::p(fmt("Access denied to change page “%s”.",
  70                         WikiLink($name))));
  71                 } else {
  72                     $version = $current->getVersion();
  73                     $meta = $current->_data;
  74                     $meta['markup'] = $newmarkup;
  75                     // convert text?
  76                     $text = $current->getPackedContent();
  77                     $meta['summary'] = sprintf(_("Change markup type from %s to %s"), $markup, $newmarkup);
  78                     $meta['is_minor_edit'] = 1;
  79                     $meta['author'] = $request->_user->UserName();
  80                     unset($meta['mtime']); // force new date
  81                     $page->save($text, $version + 1, $meta);
  82                     $current = $page->getCurrentRevision();
  83                     if ($current->get('markup') === $newmarkup) {
  84                         $ul->pushContent(HTML::li(fmt("change page “%s” to markup type “%s”.",
  85                             WikiLink($name), $newmarkup)));
  86                         $count++;
  87                     } else {
  88                         $ul->pushContent(HTML::li(fmt("Couldn't change page “%s” to markup type “%s”.",
  89                             WikiLink($name), $newmarkup)));
  90                     }
  91                 }
  92             }
  93         }
  94         if ($count) {
  95             $dbi->touch();
  96             $result->setAttr('class', 'feedback');
  97             if ($count == 1) {
  98                 $result->pushContent(HTML::p(_("One page has been changed:")));
  99             } else {
 100                 $result->pushContent(HTML::p(fmt("%d pages have been changed:", $count)));
 101             }
 102             $result->pushContent($ul);
 103             return $result;
 104         } else {
 105             $result->setAttr('class', 'error');
 106             $result->pushContent(HTML::p(_("No pages changed.")));
 107             return $result;
 108         }
 109     }
 110
 111     function run($dbi, $argstr, &$request, $basepage)
 112     {
 113         if ($request->getArg('action') != 'browse') {
 114             if (!$request->getArg('action') == _("PhpWikiAdministration/Markup")) {
 115                 return $this->disabled(_("Plugin not run: not in browse mode"));
 116             }
 117         }
 118
 119         $args = $this->getArgs($argstr, $request);
 120         $this->_args = $args;
 121         $this->preSelectS($args, $request);
 122
 123         $p = $request->getArg('p');
 124         if (!$p) $p = $this->_list;
 125         $post_args = $request->getArg('admin_markup');
 126         if (!$request->isPost() and empty($post_args['markup']))
 127             $post_args['markup'] = $args['markup'];
 128         $next_action = 'select';
 129         $pages = array();
 130         if ($p && !$request->isPost())
 131             $pages = $p;
 132         if ($p && $request->isPost() &&
 133             !empty($post_args['button']) && empty($post_args['cancel'])
 134         ) {
 135             // without individual PagePermissions:
 136             if (!ENABLE_PAGEPERM and !$request->_user->isAdmin()) {
 137                 $request->_notAuthorized(WIKIAUTH_ADMIN);
 138                 $this->disabled("! user->isAdmin");
 139             }
 140             // DONE: error message if not allowed.
 141             if ($post_args['action'] == 'verify') {
 142                 // Real action
 143                 return $this->chmarkupPages($dbi, $request, array_keys($p),
 144                     $post_args['markup']);
 145             }
 146             if ($post_args['action'] == 'select') {
 147                 if (!empty($post_args['markup']))
 148                     $next_action = 'verify';
 149                 foreach ($p as $name => $c) {
 150                     $pages[$name] = 1;
 151                 }
 152             }
 153         }
 154         if ($next_action == 'select' and empty($pages)) {
 155             $pages = $this->collectPages($pages, $dbi, $args['sortby'], $args['limit'],
 156                 $args['exclude']);
 157         }
 158
 159         if ($next_action == 'select') {
 160             $pagelist = new PageList_Selectable($args['info'], $args['exclude'], $args);
 161         } else {
 162             $pagelist = new PageList_Unselectable($args['info'], $args['exclude'], $args);
 163         }
 164         $pagelist->addPageList($pages);
 165
 166         $header = HTML::fieldset();
 167         if ($next_action == 'verify') {
 168             $button_label = _("Yes");
 169             $header->pushContent(HTML::legend(_("Confirm markup change")));
 170             $header->pushContent(
 171                 HTML::p(HTML::strong(
 172                     _("Are you sure you want to change the markup type of the selected files?"))));
 173             $header = $this->chmarkupForm($header, $post_args);
 174         } else {
 175             $button_label = _("Change markup type");
 176             $header->pushContent(HTML::legend(_("Select the pages to change the markup type")));
 177             $header = $this->chmarkupForm($header, $post_args);
 178         }
 179
 180         $buttons = HTML::p(Button('submit:admin_markup[button]', $button_label, 'wikiadmin'),
 181             Button('submit:admin_markup[cancel]', _("Cancel"), 'button'));
 182         $header->pushContent($buttons);
 183
 184         return HTML::form(array('action' => $request->getPostURL(),
 185                 'method' => 'post'),
 186             $header,
 187             $pagelist->getContent(),
 188             HiddenInputs($request->getArgs(),
 189                 false,
 190                 array('admin_markup')),
 191             HiddenInputs(array('admin_markup[action]' => $next_action)),
 192             ENABLE_PAGEPERM
 193                 ? ''
 194                 : HiddenInputs(array('require_authority_for_post' => WIKIAUTH_ADMIN)));
 195     }
 196
 197     function chmarkupForm(&$header, $post_args)
 198     {
 199         $header->pushContent(_("Change markup to: "));
 200         $header->pushContent(HTML::input(array('name' => 'admin_markup[markup]',
 201             'value' => $post_args['markup'])));
 202         return $header;
 203     }
 204 }
 205
 206 // Local Variables:
 207 // mode: php
 208 // tab-width: 8
 209 // c-basic-offset: 4
 210 // c-hanging-comment-ender-p: nil
 211 // indent-tabs-mode: nil
 212 // End: