2 rcs_id('$Id: WikiAdminRename.php,v 1.27 2007-08-25 18:08:24 rurban Exp $');
4 Copyright 2004,2005,2007 $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>
30 require_once('lib/PageList.php');
31 require_once('lib/plugin/WikiAdminSelect.php');
33 class WikiPlugin_WikiAdminRename
34 extends WikiPlugin_WikiAdminSelect
37 return _("WikiAdminRename");
40 function getDescription() {
41 return _("Rename selected pages");
44 function getVersion() {
45 return preg_replace("/[Revision: $]/", '',
46 "\$Revision: 1.27 $");
49 function getDefaultArguments() {
52 PageList::supportedArgs(),
55 /* Columns to include in listing */
56 'info' => 'pagename,mtime',
61 function renameHelper($name, $from, $to, $options = false) {
62 if ($options['regex'])
63 return preg_replace('/'.$from.'/'.($options['icase']?'i':''), $to, $name);
64 elseif ($options['icase'])
65 return str_ireplace($from, $to, $name);
67 return str_replace($from, $to, $name);
70 function renamePages(&$dbi, &$request, $pages, $from, $to, $updatelinks=false) {
73 $post_args = $request->getArg('admin_rename');
74 $options = array('regex' => @$post_args['regex'],
75 'icase' => @$post_args['icase']);
76 foreach ($pages as $name) {
77 if ( ($newname = $this->renameHelper($name, $from, $to, $options))
78 and $newname != $name )
80 if ($dbi->isWikiPage($newname))
81 $ul->pushContent(HTML::li(fmt("Page %s already exists. Ignored.",
82 WikiLink($newname))));
83 elseif (! mayAccessPage('edit', $name))
84 $ul->pushContent(HTML::li(fmt("Access denied to rename page '%s'.",
86 elseif ( $dbi->renamePage($name, $newname, $updatelinks)) {
87 /* not yet implemented for all backends */
88 $ul->pushContent(HTML::li(fmt("Renamed page '%s' to '%s'.",
89 $name, WikiLink($newname))));
92 $ul->pushContent(HTML::li(fmt("Couldn't rename page '%s' to '%s'.",
96 $ul->pushContent(HTML::li(fmt("Couldn't rename page '%s' to '%s'.",
102 return HTML($ul, HTML::p(fmt("%s pages have been permanently renamed.",
105 return HTML($ul, HTML::p(fmt("No pages renamed.")));
109 function run($dbi, $argstr, &$request, $basepage) {
110 $action = $request->getArg('action');
111 if ($action != 'browse' and $action != 'rename'
112 and $action != _("PhpWikiAdministration")."/"._("Rename"))
113 return $this->disabled("(action != 'browse')");
115 $args = $this->getArgs($argstr, $request);
116 $this->_args = $args;
117 $this->preSelectS($args, $request);
119 $p = $request->getArg('p');
120 if (!$p) $p = $this->_list;
121 $post_args = $request->getArg('admin_rename');
122 $next_action = 'select';
124 if ($p && !$request->isPost())
126 if ($p && $request->isPost() &&
127 !empty($post_args['rename']) && empty($post_args['cancel'])) {
128 // without individual PagePermissions:
129 if (!ENABLE_PAGEPERM and !$request->_user->isAdmin()) {
130 $request->_notAuthorized(WIKIAUTH_ADMIN);
131 $this->disabled("! user->isAdmin");
133 // DONE: error message if not allowed.
134 if ($post_args['action'] == 'verify') {
136 return $this->renamePages($dbi, $request, array_keys($p),
137 $post_args['from'], $post_args['to'],
138 !empty($post_args['updatelinks']));
140 if ($post_args['action'] == 'select') {
141 if (!empty($post_args['from']))
142 $next_action = 'verify';
143 foreach ($p as $name => $c) {
148 if ($next_action == 'select' and empty($pages)) {
149 // List all pages to select from.
150 $pages = $this->collectPages($pages, $dbi, $args['sortby'], $args['limit'], $args['exclude']);
152 /*if ($next_action == 'verify') {
153 $args['info'] = "checkbox,pagename,renamed_pagename";
155 $pagelist = new PageList_Selectable
157 $args['info'], $args['exclude'],
159 array('renamed_pagename'
160 => new _PageList_Column_renamed_pagename('rename', _("Rename to")),
162 $pagelist->addPageList($pages);
165 if ($next_action == 'verify') {
166 $button_label = _("Yes");
167 $header->pushContent(
168 HTML::p(HTML::strong(
169 _("Are you sure you want to permanently rename the selected pages?"))));
170 $header = $this->renameForm($header, $post_args);
173 $button_label = _("Rename selected pages");
174 if (!$post_args and count($pages) == 1) {
175 list($post_args['from'],) = array_keys($pages);
176 $post_args['to'] = $post_args['from'];
178 $header = $this->renameForm($header, $post_args);
179 $header->pushContent(HTML::p(_("Select the pages to rename:")));
182 $buttons = HTML::p(Button('submit:admin_rename[rename]', $button_label, 'wikiadmin'),
183 HTML::Raw(' '),
184 Button('submit:admin_rename[cancel]', _("Cancel"), 'button'));
186 return HTML::form(array('action' => $request->getPostURL(),
189 $pagelist->getContent(),
190 HiddenInputs($request->getArgs(),
192 array('admin_rename')),
193 HiddenInputs(array('admin_rename[action]' => $next_action)),
196 : HiddenInputs(array('require_authority_for_post' => WIKIAUTH_ADMIN)),
200 function checkBox (&$post_args, $name, $msg) {
201 $id = 'admin_rename-'.$name;
202 $checkbox = HTML::input(array('type' => 'checkbox',
203 'name' => 'admin_rename['.$name.']',
206 if (!empty($post_args[$name]))
207 $checkbox->setAttr('checked', 'checked');
208 return HTML::div($checkbox, ' ', HTML::label(array('for' => $id), $msg));
211 function renameForm(&$header, $post_args) {
212 $table = HTML::table();
213 $this->_tablePush($table, _("Rename"). " ". _("from").': ',
214 HTML::input(array('name' => 'admin_rename[from]',
216 'value' => $post_args['from'])));
217 $this->_tablePush($table, _("to").': ',
218 HTML::input(array('name' => 'admin_rename[to]',
220 'value' => $post_args['to'])));
221 $this->_tablePush($table, '', $this->checkBox($post_args, 'regex', _("Regex?")));
222 $this->_tablePush($table, '', $this->checkBox($post_args, 'icase', _("Case insensitive?")));
223 $this->_tablePush($table, '', HTML::td());
224 $this->_tablePush($table, '', $this->checkBox($post_args, 'updatelinks',
225 _("Change pagename in all linked pages also?")));
226 $header->pushContent($table);
227 $header->pushContent(HTML::p());
232 // TODO: grey out unchangeble pages, even in the initial list also?
233 // TODO: autoselect by matching name javascript in admin_rename[from]
234 // TODO: update rename[] fields when case-sensitive and regex is changed
236 // moved from lib/PageList.php
237 class _PageList_Column_renamed_pagename extends _PageList_Column {
238 function _getValue ($page_handle, &$revision_handle) {
240 $post_args = $request->getArg('admin_rename');
241 $options = array('regex' => @$post_args['regex'],
242 'icase' => @$post_args['icase']);
244 $value = $post_args ? WikiPlugin_WikiAdminRename::renameHelper($page_handle->getName(),
245 $post_args['from'], $post_args['to'],
247 : $page_handle->getName();
248 $div = HTML::div(" => ",HTML::input(array('type' => 'text',
249 'name' => 'rename[]',
250 'value' => $value)));
251 $new_page = $request->getPage($value);
252 if ($new_page->exists()) {
253 $div->setAttr('class','error');
254 $div->setAttr('title',_("This page already exists"));
260 // $Log: not supported by cvs2svn $
261 // Revision 1.26 2005/04/01 16:06:41 rurban
262 // do not trim spaces
264 // Revision 1.25 2005/04/01 15:22:20 rurban
265 // Implement icase and regex options.
266 // Change checkbox case message from "Case-Sensitive" to "Case-Insensitive"
268 // Revision 1.24 2005/04/01 15:03:01 rurban
269 // Optimize rename UI with one selected pagename
271 // Revision 1.23 2005/02/12 17:24:24 rurban
272 // locale update: missing . : fixed. unified strings
275 // Revision 1.22 2004/11/23 15:17:20 rurban
276 // better support for case_exact search (not caseexact for consistency),
277 // plugin args simplification:
278 // handle and explode exclude and pages argument in WikiPlugin::getArgs
279 // and exclude in advance (at the sql level if possible)
280 // handle sortby and limit from request override in WikiPlugin::getArgs
281 // ListSubpages: renamed pages to maxpages
283 // Revision 1.21 2004/11/01 10:43:59 rurban
284 // seperate PassUser methods into seperate dir (memory usage)
285 // fix WikiUser (old) overlarge data session
286 // remove wikidb arg from various page class methods, use global ->_dbi instead
289 // Revision 1.20 2004/06/16 10:38:59 rurban
290 // Disallow refernces in calls if the declaration is a reference
291 // ("allow_call_time_pass_reference clean").
292 // PhpWiki is now allow_call_time_pass_reference = Off clean,
293 // but several external libraries may not.
294 // In detail these libs look to be affected (not tested):
298 // Revision 1.19 2004/06/14 11:31:39 rurban
299 // renamed global $Theme to $WikiTheme (gforge nameclash)
300 // inherit PageList default options from PageList
301 // default sortby=pagename
302 // use options in PageList_Selectable (limit, sortby, ...)
303 // added action revert, with button at action=diff
304 // added option regex to WikiAdminSearchReplace
306 // Revision 1.18 2004/06/13 15:33:20 rurban
307 // new support for arguments owner, author, creator in most relevant
308 // PageList plugins. in WikiAdmin* via preSelectS()
310 // Revision 1.17 2004/06/08 10:05:12 rurban
311 // simplified admin action shortcuts
313 // Revision 1.16 2004/06/07 18:57:31 rurban
314 // fix rename: Change pagename in all linked pages
316 // Revision 1.15 2004/06/04 20:32:54 rurban
317 // Several locale related improvements suggested by Pierrick Meignen
318 // LDAP fix by John Cole
319 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
321 // Revision 1.14 2004/06/03 22:24:48 rurban
322 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
324 // Revision 1.13 2004/06/03 12:59:41 rurban
325 // simplify translation
326 // NS4 wrap=virtual only
328 // Revision 1.12 2004/06/01 15:28:01 rurban
329 // AdminUser only ADMIN_USER not member of Administrators
330 // some RateIt improvements by dfrankow
331 // edit_toolbar buttons
333 // Revision 1.11 2004/05/24 17:34:53 rurban
336 // Revision 1.10 2004/04/06 20:00:11 rurban
337 // Cleanup of special PageList column types
338 // Added support of plugin and theme specific Pagelist Types
339 // Added support for theme specific UserPreferences
340 // Added session support for ip-based throttling
341 // sql table schema change: ALTER TABLE session ADD sess_ip CHAR(15);
342 // Enhanced postgres schema
343 // Added DB_Session_dba support
345 // Revision 1.9 2004/03/12 13:31:43 rurban
346 // enforce PagePermissions, errormsg if not Admin
348 // Revision 1.8 2004/03/01 13:48:46 rurban
350 // p[] consistency fix
352 // Revision 1.7 2004/02/22 23:20:33 rurban
353 // fixed DumpHtmlToDir,
354 // enhanced sortby handling in PageList
355 // new button_heading th style (enabled),
356 // added sortby and limit support to the db backends and plugins
357 // for paging support (<<prev, next>> links on long lists)
359 // Revision 1.6 2004/02/17 12:11:36 rurban
360 // 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, ...)
362 // Revision 1.5 2004/02/15 21:34:37 rurban
363 // PageList enhanced and improved.
364 // fixed new WikiAdmin... plugins
365 // editpage, Theme with exp. htmlarea framework
366 // (htmlarea yet committed, this is really questionable)
367 // WikiUser... code with better session handling for prefs
368 // enhanced UserPreferences (again)
369 // RecentChanges for show_deleted: how should pages be deleted then?
371 // Revision 1.4 2004/02/12 17:05:39 rurban
373 // added "Change pagename in all linked pages also"
375 // added javascript toggle for Select
376 // WikiAdminSearchReplace:
377 // fixed another typo
379 // Revision 1.3 2004/02/12 13:05:50 rurban
380 // Rename functional for PearDB backend
381 // some other minor changes
382 // SiteMap comes with a not yet functional feature request: includepages (tbd)
384 // Revision 1.2 2004/02/12 11:45:11 rurban
385 // only WikiDB method missing
387 // Revision 1.1 2004/02/11 20:00:16 rurban
388 // WikiAdmin... series overhaul. Rename misses the db backend methods yet. Chmod + Chwon still missing.
395 // c-hanging-comment-ender-p: nil
396 // indent-tabs-mode: nil