lib/plugin/WikiAdminRename.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: WikiAdminRename.php,v 1.6 2004-02-17 12:11:36 rurban Exp $');
   3 /*
   4  Copyright 2004 $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  * Usage:   <?plugin WikiAdminRename ?> or called via WikiAdminSelect
  25  * Author:  Reini Urban <rurban@x-ray.at>
  26  *
  27  * KNOWN ISSUES:
  28  * Currently we must be Admin.
  29  * Future versions will support PagePermissions.
  30  * requires PHP 4.2 so far.
  31  */
  32 require_once('lib/PageList.php');
  33 require_once('lib/plugin/WikiAdminSelect.php');
  34
  35 class WikiPlugin_WikiAdminRename
  36 extends WikiPlugin_WikiAdminSelect
  37 {
  38     function getName() {
  39         return _("WikiAdminRename");
  40     }
  41
  42     function getDescription() {
  43         return _("Rename selected pages.");
  44     }
  45
  46     function getVersion() {
  47         return preg_replace("/[Revision: $]/", '',
  48                             "\$Revision: 1.6 $");
  49     }
  50
  51     function getDefaultArguments() {
  52         return array(
  53                      /* Pages to exclude in listing */
  54                      'exclude'  => '',
  55                      /* Columns to include in listing */
  56                      'info'     => 'pagename,mtime',
  57                      /* How to sort */
  58                      'sortby'   => 'pagename',
  59                      );
  60     }
  61
  62     function renameHelper($name, $from, $to) {
  63         return str_replace($from,$to,$name);
  64     }
  65
  66     function renamePages(&$dbi, &$request, $pages, $from, $to, $updatelinks=false) {
  67         $ul = HTML::ul();
  68         $count = 0;
  69         foreach ($pages as $name) {
  70             if ( ($newname = $this->renameHelper($name,$from,$to)) and
  71                   $newname != $name and
  72                  $dbi->renamePage($name,$newname,$updatelinks) ) {
  73                 /* not yet implemented for all backends */
  74                 $ul->pushContent(HTML::li(fmt("Renamed page '%s' to '%s'.",$name,WikiLink($newname))));
  75                 $count++;
  76             } else {
  77                 $ul->pushContent(HTML::li(fmt("Couldn't rename page '%s' to '%s'.", $name, $newname)));
  78             }
  79         }
  80         if ($count) {
  81             $dbi->touch();
  82             return HTML($ul,
  83                         HTML::p(fmt("%s pages have been permanently renamed.",$count)));
  84         } else {
  85             return HTML($ul,
  86                         HTML::p(fmt("No pages renamed.")));
  87         }
  88     }
  89
  90     function run($dbi, $argstr, &$request, $basepage) {
  91         if ($request->getArg('action') != 'browse')
  92             return $this->disabled("(action != 'browse')");
  93
  94         $args = $this->getArgs($argstr, $request);
  95         $this->_args = $args;
  96         if (!empty($args['exclude']))
  97             $exclude = explodePageList($args['exclude']);
  98         else
  99             $exclude = false;
 100
 101         $p = $request->getArg('p');
 102         $post_args = $request->getArg('admin_rename');
 103         $next_action = 'select';
 104         $pages = array();
 105         if ($p && !$request->isPost())
 106             $pages = $p;
 107         if ($p && $request->isPost() && $request->_user->isAdmin()
 108             && !empty($post_args['rename']) && empty($post_args['cancel'])) {
 109             // FIXME: error message if not admin.
 110             if ($post_args['action'] == 'verify') {
 111                 // Real action
 112                 return $this->renamePages($dbi, $request, $p,
 113                                           $post_args['from'], $post_args['to'], $post_args['updatelinks']);
 114             }
 115             if ($post_args['action'] == 'select') {
 116                 if (!empty($post_args['from']))
 117                     $next_action = 'verify';
 118                 foreach ($p as $name) {
 119                     $pages[$name] = 1;
 120                 }
 121             }
 122         }
 123         if ($next_action == 'select' and empty($pages)) {
 124             // List all pages to select from.
 125             $pages = $this->collectPages($pages, $dbi, $args['sortby']);
 126         }
 127         if ($next_action == 'verify') {
 128             $args['info'] = "checkbox,pagename,renamed_pagename";
 129         }
 130         $pagelist = new PageList_Selectable($args['info'], $exclude);
 131         $pagelist->addPageList($pages);
 132
 133         $header = HTML::p();
 134         if ($next_action == 'verify') {
 135             $button_label = _("Yes");
 136             $header->pushContent(
 137               HTML::p(HTML::strong(
 138                                    _("Are you sure you want to permanently rename the selected files?"))));
 139             $header = $this->renameForm($header, $post_args);
 140         }
 141         else {
 142             $button_label = _("Rename selected pages");
 143             $header->pushContent(HTML::p(_("Select the pages to rename:")));
 144             $header = $this->renameForm($header, $post_args);
 145         }
 146
 147
 148         $buttons = HTML::p(Button('submit:admin_rename[rename]', $button_label, 'wikiadmin'),
 149                            Button('submit:admin_rename[cancel]', _("Cancel"), 'button'));
 150
 151         return HTML::form(array('action' => $request->getPostURL(),
 152                                 'method' => 'post'),
 153                           $header,
 154                           $pagelist->getContent(),
 155                           HiddenInputs($request->getArgs(),
 156                                         false,
 157                                         array('admin_rename')),
 158                           HiddenInputs(array('admin_rename[action]' => $next_action,
 159                                              'require_authority_for_post' => WIKIAUTH_ADMIN)),
 160                           $buttons);
 161     }
 162
 163     function renameForm(&$header, $post_args) {
 164         $header->pushContent(_("Rename")." "._("from").': ');
 165         $header->pushContent(HTML::input(array('name' => 'admin_rename[from]',
 166                                                'value' => $post_args['from'])));
 167         $header->pushContent(' '._("to").': ');
 168         $header->pushContent(HTML::input(array('name' => 'admin_rename[to]',
 169                                                'value' => $post_args['to'])));
 170         $header->pushContent(' '._("(no regex, case-sensitive)"));
 171         if (0) { // not yet tested
 172             $header->pushContent(HTML::br());
 173             $header->pushContent(_("Change pagename in all linked pages also?"));
 174             $checkbox = HTML::input(array('type' => 'checkbox',
 175                                           'name' => 'admin_rename[updatelinks]',
 176                                           'value' => 1));
 177             if ($post_args['updatelinks'])
 178                 $checkbox->setAttr('checked','checked');
 179             $header->pushContent($checkbox);
 180         }
 181         $header->pushContent(HTML::p());
 182         return $header;
 183     }
 184
 185 }
 186
 187 // $Log: not supported by cvs2svn $
 188 // Revision 1.5  2004/02/15 21:34:37  rurban
 189 // PageList enhanced and improved.
 190 // fixed new WikiAdmin... plugins
 191 // editpage, Theme with exp. htmlarea framework
 192 //   (htmlarea yet committed, this is really questionable)
 193 // WikiUser... code with better session handling for prefs
 194 // enhanced UserPreferences (again)
 195 // RecentChanges for show_deleted: how should pages be deleted then?
 196 //
 197 // Revision 1.4  2004/02/12 17:05:39  rurban
 198 // WikiAdminRename:
 199 //   added "Change pagename in all linked pages also"
 200 // PageList:
 201 //   added javascript toggle for Select
 202 // WikiAdminSearchReplace:
 203 //   fixed another typo
 204 //
 205 // Revision 1.3  2004/02/12 13:05:50  rurban
 206 // Rename functional for PearDB backend
 207 // some other minor changes
 208 // SiteMap comes with a not yet functional feature request: includepages (tbd)
 209 //
 210 // Revision 1.2  2004/02/12 11:45:11  rurban
 211 // only WikiDB method missing
 212 //
 213 // Revision 1.1  2004/02/11 20:00:16  rurban
 214 // WikiAdmin... series overhaul. Rename misses the db backend methods yet. Chmod + Chwon still missing.
 215 //
 216
 217 // Local Variables:
 218 // mode: php
 219 // tab-width: 8
 220 // c-basic-offset: 4
 221 // c-hanging-comment-ender-p: nil
 222 // indent-tabs-mode: nil
 223 // End:
 224 ?>