2 rcs_id('$Id: WikiAdminRename.php,v 1.9 2004-03-12 13:31:43 rurban Exp $');
4 Copyright 2004 $ThePhpWikiProgrammingTeam
6 This file is part of PhpWiki.
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.
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.
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
24 * Usage: <?plugin WikiAdminRename ?> or called via WikiAdminSelect
25 * Author: Reini Urban <rurban@x-ray.at>
28 * Currently we must be Admin.
29 * Future versions will support PagePermissions.
30 * requires PHP 4.2 so far.
32 require_once('lib/PageList.php');
33 require_once('lib/plugin/WikiAdminSelect.php');
35 class WikiPlugin_WikiAdminRename
36 extends WikiPlugin_WikiAdminSelect
39 return _("WikiAdminRename");
42 function getDescription() {
43 return _("Rename selected pages.");
46 function getVersion() {
47 return preg_replace("/[Revision: $]/", '',
51 function getDefaultArguments() {
53 /* Pages to exclude in listing */
55 /* Columns to include in listing */
56 'info' => 'pagename,mtime',
58 'sortby' => 'pagename',
64 function renameHelper($name, $from, $to) {
65 return str_replace($from,$to,$name);
68 function renamePages(&$dbi, &$request, $pages, $from, $to, $updatelinks=false) {
71 foreach ($pages as $name) {
72 if ( ($newname = $this->renameHelper($name,$from,$to)) and
74 $dbi->renamePage($name,$newname,$updatelinks) ) {
75 /* not yet implemented for all backends */
76 $ul->pushContent(HTML::li(fmt("Renamed page '%s' to '%s'.",$name,WikiLink($newname))));
79 $ul->pushContent(HTML::li(fmt("Couldn't rename page '%s' to '%s'.", $name, $newname)));
85 HTML::p(fmt("%s pages have been permanently renamed.",$count)));
88 HTML::p(fmt("No pages renamed.")));
92 function run($dbi, $argstr, &$request, $basepage) {
93 if ($request->getArg('action') != 'browse')
94 return $this->disabled("(action != 'browse')");
96 $args = $this->getArgs($argstr, $request);
98 if (!empty($args['exclude']))
99 $exclude = explodePageList($args['exclude']);
103 $p = $request->getArg('p');
104 $post_args = $request->getArg('admin_rename');
105 $next_action = 'select';
107 if ($p && !$request->isPost())
109 if ($p && $request->isPost() &&
110 !empty($post_args['rename']) && empty($post_args['cancel'])) {
112 // FIXME: check individual PagePermissions
113 if (!$request->_user->isAdmin()) {
114 $request->_notAuthorized(WIKIAUTH_ADMIN);
115 $this->disabled("! user->isAdmin");
118 // FIXME: error message if not admin.
119 if ($post_args['action'] == 'verify') {
121 return $this->renamePages($dbi, $request, array_keys($p),
122 $post_args['from'], $post_args['to'], !empty($post_args['updatelinks']));
124 if ($post_args['action'] == 'select') {
125 if (!empty($post_args['from']))
126 $next_action = 'verify';
127 foreach ($p as $name => $c) {
132 if ($next_action == 'select' and empty($pages)) {
133 // List all pages to select from.
134 $pages = $this->collectPages($pages, $dbi, $args['sortby'], $args['limit']);
136 if ($next_action == 'verify') {
137 $args['info'] = "checkbox,pagename,renamed_pagename";
139 $pagelist = new PageList_Selectable($args['info'], $exclude);
140 $pagelist->addPageList($pages);
143 if ($next_action == 'verify') {
144 $button_label = _("Yes");
145 $header->pushContent(
146 HTML::p(HTML::strong(
147 _("Are you sure you want to permanently rename the selected files?"))));
148 $header = $this->renameForm($header, $post_args);
151 $button_label = _("Rename selected pages");
152 $header->pushContent(HTML::p(_("Select the pages to rename:")));
153 $header = $this->renameForm($header, $post_args);
157 $buttons = HTML::p(Button('submit:admin_rename[rename]', $button_label, 'wikiadmin'),
158 Button('submit:admin_rename[cancel]', _("Cancel"), 'button'));
160 return HTML::form(array('action' => $request->getPostURL(),
163 $pagelist->getContent(),
164 HiddenInputs($request->getArgs(),
166 array('admin_rename')),
167 HiddenInputs(array('admin_rename[action]' => $next_action,
168 'require_authority_for_post' => WIKIAUTH_ADMIN)),
172 function renameForm(&$header, $post_args) {
173 $header->pushContent(_("Rename")." "._("from").': ');
174 $header->pushContent(HTML::input(array('name' => 'admin_rename[from]',
175 'value' => $post_args['from'])));
176 $header->pushContent(' '._("to").': ');
177 $header->pushContent(HTML::input(array('name' => 'admin_rename[to]',
178 'value' => $post_args['to'])));
179 $header->pushContent(' '._("(no regex, case-sensitive)"));
180 if (1) { // not yet tested
181 $header->pushContent(HTML::br());
182 $header->pushContent(_("Change pagename in all linked pages also?"));
183 $checkbox = HTML::input(array('type' => 'checkbox',
184 'name' => 'admin_rename[updatelinks]',
186 if (!empty($post_args['updatelinks']))
187 $checkbox->setAttr('checked','checked');
188 $header->pushContent($checkbox);
190 $header->pushContent(HTML::p());
196 // $Log: not supported by cvs2svn $
197 // Revision 1.8 2004/03/01 13:48:46 rurban
199 // p[] consistency fix
201 // Revision 1.7 2004/02/22 23:20:33 rurban
202 // fixed DumpHtmlToDir,
203 // enhanced sortby handling in PageList
204 // new button_heading th style (enabled),
205 // added sortby and limit support to the db backends and plugins
206 // for paging support (<<prev, next>> links on long lists)
208 // Revision 1.6 2004/02/17 12:11:36 rurban
209 // added missing 4th basepage arg at plugin->run() to almost all plugins. This caused no harm so far, because it was silently dropped on normal usage. However on plugin internal ->run invocations it failed. (InterWikiSearch, IncludeSiteMap, ...)
211 // Revision 1.5 2004/02/15 21:34:37 rurban
212 // PageList enhanced and improved.
213 // fixed new WikiAdmin... plugins
214 // editpage, Theme with exp. htmlarea framework
215 // (htmlarea yet committed, this is really questionable)
216 // WikiUser... code with better session handling for prefs
217 // enhanced UserPreferences (again)
218 // RecentChanges for show_deleted: how should pages be deleted then?
220 // Revision 1.4 2004/02/12 17:05:39 rurban
222 // added "Change pagename in all linked pages also"
224 // added javascript toggle for Select
225 // WikiAdminSearchReplace:
226 // fixed another typo
228 // Revision 1.3 2004/02/12 13:05:50 rurban
229 // Rename functional for PearDB backend
230 // some other minor changes
231 // SiteMap comes with a not yet functional feature request: includepages (tbd)
233 // Revision 1.2 2004/02/12 11:45:11 rurban
234 // only WikiDB method missing
236 // Revision 1.1 2004/02/11 20:00:16 rurban
237 // WikiAdmin... series overhaul. Rename misses the db backend methods yet. Chmod + Chwon still missing.
244 // c-hanging-comment-ender-p: nil
245 // indent-tabs-mode: nil