2 rcs_id('$Id: WikiAdminRename.php,v 1.17 2004-06-08 10:05:12 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>
27 * TODO: support case-insensitive checkbox
28 * support regex checkbox and renaming
32 * Enabled now PagePermissions.
33 * Requires PHP 4.2 so far.
35 require_once('lib/PageList.php');
36 require_once('lib/plugin/WikiAdminSelect.php');
38 class WikiPlugin_WikiAdminRename
39 extends WikiPlugin_WikiAdminSelect
42 return _("WikiAdminRename");
45 function getDescription() {
46 return _("Rename selected pages.");
49 function getVersion() {
50 return preg_replace("/[Revision: $]/", '',
51 "\$Revision: 1.17 $");
54 function getDefaultArguments() {
57 /* Pages to exclude in listing */
59 /* Columns to include in listing */
60 'info' => 'pagename,mtime',
62 'sortby' => 'pagename',
64 'updatelinks' => 0 // not yet working
68 //TODO: regex and case-inexact option
69 function renameHelper($name, $from, $to, $options=false) {
70 return str_replace($from, $to, $name);
73 function renamePages(&$dbi, &$request, $pages, $from, $to, $updatelinks=false) {
76 foreach ($pages as $name) {
78 $oldpage = $dbi->getPage($from);
79 require_once('lib/plugin/WikiAdminSearchReplace.php');
80 //$newpage = $dbi->getPage($to);
81 $links = $oldpage->getBackLinks();
82 while ($linked_page = $links->next()) {
83 if (WikiPlugin_WikiAdminSearchReplace::replaceHelper($dbi,$linked_page->getName(),$from,$to))
84 $ul->pushContent(HTML::li(fmt("Replaced link in %s.",
85 WikiLink($linked_page->getName()))));
87 $links = $oldpage->getPageLinks();
88 while ($linked_page = $links->next()) {
89 WikiPlugin_WikiAdminSearchReplace::replaceHelper($dbi,$linked_page->getName(),$from,$to);
90 $ul->pushContent(HTML::li(fmt("Replaced link in %s.",
91 WikiLink($linked_page->getName()))));
94 if ( ($newname = $this->renameHelper($name, $from, $to)) and
96 if ($dbi->isWikiPage($newname))
97 $ul->pushContent(HTML::li(fmt("Page %s already exists. Ignored.",
98 WikiLink($newname))));
99 elseif (!mayAccessPage('change', $name))
100 $ul->pushContent(HTML::li(fmt("Access denied to change page '%s'.",
102 elseif ( $dbi->renamePage($name, $newname, $updatelinks)) {
103 /* not yet implemented for all backends */
104 $ul->pushContent(HTML::li(fmt("Renamed page '%s' to '%s'.",
105 $name, WikiLink($newname))));
108 $ul->pushContent(HTML::li(fmt("Couldn't rename page '%s' to '%s'.",
112 $ul->pushContent(HTML::li(fmt("Couldn't rename page '%s' to '%s'.",
118 return HTML($ul, HTML::p(fmt("%s pages have been permanently renamed.",
121 return HTML($ul, HTML::p(fmt("No pages renamed.")));
125 function run($dbi, $argstr, &$request, $basepage) {
126 if ($request->getArg('action') != 'browse')
127 if ($request->getArg('action') != _("PhpWikiAdministration/Rename"))
128 return $this->disabled("(action != 'browse')");
130 $args = $this->getArgs($argstr, $request);
131 $this->_args = $args;
132 if (!empty($args['exclude']))
133 $exclude = explodePageList($args['exclude']);
136 $this->preSelectS(&$args, &$request);
138 $p = $request->getArg('p');
139 if (!$p) $p = $this->_list;
140 $post_args = $request->getArg('admin_rename');
141 $next_action = 'select';
143 if ($p && !$request->isPost())
145 if ($p && $request->isPost() &&
146 !empty($post_args['rename']) && empty($post_args['cancel'])) {
147 // without individual PagePermissions:
148 if (!ENABLE_PAGEPERM and !$request->_user->isAdmin()) {
149 $request->_notAuthorized(WIKIAUTH_ADMIN);
150 $this->disabled("! user->isAdmin");
152 // DONE: error message if not allowed.
153 if ($post_args['action'] == 'verify') {
155 return $this->renamePages($dbi, $request, array_keys($p),
156 trim($post_args['from']), trim($post_args['to']),
157 !empty($post_args['updatelinks']));
159 if ($post_args['action'] == 'select') {
160 if (!empty($post_args['from']))
161 $next_action = 'verify';
162 foreach ($p as $name => $c) {
167 if ($next_action == 'select' and empty($pages)) {
168 // List all pages to select from.
169 $pages = $this->collectPages($pages, $dbi, $args['sortby'], $args['limit']);
171 if ($next_action == 'verify') {
172 $args['info'] = "checkbox,pagename,renamed_pagename";
174 $pagelist = new PageList_Selectable
176 $args['info'], $exclude,
178 array('renamed_pagename'
179 => new _PageList_Column_renamed_pagename('rename', _("Rename to")),
181 $pagelist->addPageList($pages);
184 if ($next_action == 'verify') {
185 $button_label = _("Yes");
186 $header->pushContent(
187 HTML::p(HTML::strong(
188 _("Are you sure you want to permanently rename the selected files?"))));
189 $header = $this->renameForm($header, $post_args);
192 $button_label = _("Rename selected pages");
193 $header->pushContent(HTML::p(_("Select the pages to rename:")));
194 $header = $this->renameForm($header, $post_args);
197 $buttons = HTML::p(Button('submit:admin_rename[rename]', $button_label, 'wikiadmin'),
198 Button('submit:admin_rename[cancel]', _("Cancel"), 'button'));
200 return HTML::form(array('action' => $request->getPostURL(),
203 $pagelist->getContent(),
204 HiddenInputs($request->getArgs(),
206 array('admin_rename')),
207 HiddenInputs(array('admin_rename[action]' => $next_action)),
210 : HiddenInputs(array('require_authority_for_post' => WIKIAUTH_ADMIN)),
214 function renameForm(&$header, $post_args) {
215 $header->pushContent(_("Rename")." "._("from").': ');
216 $header->pushContent(HTML::input(array('name' => 'admin_rename[from]',
217 'value' => trim($post_args['from']))));
218 $header->pushContent(' '._("to").': ');
219 $header->pushContent(HTML::input(array('name' => 'admin_rename[to]',
220 'value' => trim($post_args['to']))));
221 $header->pushContent(' '._("(no regex, case-sensitive)"));
222 //if (DEBUG) { // not yet tested
223 $header->pushContent(HTML::br());
224 $checkbox = HTML::input(array('type' => 'checkbox',
225 'name' => 'admin_rename[updatelinks]',
227 if (!empty($post_args['updatelinks']))
228 $checkbox->setAttr('checked','checked');
229 $header->pushContent($checkbox);
230 $header->pushContent(_("Change pagename in all linked pages also?"));
231 //$header->pushContent(HTML::em(_("(Currently not working)")));
233 $header->pushContent(HTML::p());
238 // moved from lib/PageList.php
239 class _PageList_Column_renamed_pagename extends _PageList_Column {
240 function _getValue ($page_handle, &$revision_handle) {
241 $post_args = $GLOBALS['request']->getArg('admin_rename');
242 $value = str_replace($post_args['from'], $post_args['to'], $page_handle->getName());
243 $div = HTML::div(" => ",HTML::input(array('type' => 'text',
244 'name' => 'rename[]',
245 'value' => $value)));
246 $new_page = $GLOBALS['request']->getPage($value);
247 if ($new_page->exists()) {
248 $div->setAttr('class','error');
249 $div->setAttr('title',_("This page already exists"));
255 // $Log: not supported by cvs2svn $
256 // Revision 1.16 2004/06/07 18:57:31 rurban
257 // fix rename: Change pagename in all linked pages
259 // Revision 1.15 2004/06/04 20:32:54 rurban
260 // Several locale related improvements suggested by Pierrick Meignen
261 // LDAP fix by John Cole
262 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
264 // Revision 1.14 2004/06/03 22:24:48 rurban
265 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
267 // Revision 1.13 2004/06/03 12:59:41 rurban
268 // simplify translation
269 // NS4 wrap=virtual only
271 // Revision 1.12 2004/06/01 15:28:01 rurban
272 // AdminUser only ADMIN_USER not member of Administrators
273 // some RateIt improvements by dfrankow
274 // edit_toolbar buttons
276 // Revision 1.11 2004/05/24 17:34:53 rurban
279 // Revision 1.10 2004/04/06 20:00:11 rurban
280 // Cleanup of special PageList column types
281 // Added support of plugin and theme specific Pagelist Types
282 // Added support for theme specific UserPreferences
283 // Added session support for ip-based throttling
284 // sql table schema change: ALTER TABLE session ADD sess_ip CHAR(15);
285 // Enhanced postgres schema
286 // Added DB_Session_dba support
288 // Revision 1.9 2004/03/12 13:31:43 rurban
289 // enforce PagePermissions, errormsg if not Admin
291 // Revision 1.8 2004/03/01 13:48:46 rurban
293 // p[] consistency fix
295 // Revision 1.7 2004/02/22 23:20:33 rurban
296 // fixed DumpHtmlToDir,
297 // enhanced sortby handling in PageList
298 // new button_heading th style (enabled),
299 // added sortby and limit support to the db backends and plugins
300 // for paging support (<<prev, next>> links on long lists)
302 // Revision 1.6 2004/02/17 12:11:36 rurban
303 // 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, ...)
305 // Revision 1.5 2004/02/15 21:34:37 rurban
306 // PageList enhanced and improved.
307 // fixed new WikiAdmin... plugins
308 // editpage, Theme with exp. htmlarea framework
309 // (htmlarea yet committed, this is really questionable)
310 // WikiUser... code with better session handling for prefs
311 // enhanced UserPreferences (again)
312 // RecentChanges for show_deleted: how should pages be deleted then?
314 // Revision 1.4 2004/02/12 17:05:39 rurban
316 // added "Change pagename in all linked pages also"
318 // added javascript toggle for Select
319 // WikiAdminSearchReplace:
320 // fixed another typo
322 // Revision 1.3 2004/02/12 13:05:50 rurban
323 // Rename functional for PearDB backend
324 // some other minor changes
325 // SiteMap comes with a not yet functional feature request: includepages (tbd)
327 // Revision 1.2 2004/02/12 11:45:11 rurban
328 // only WikiDB method missing
330 // Revision 1.1 2004/02/11 20:00:16 rurban
331 // WikiAdmin... series overhaul. Rename misses the db backend methods yet. Chmod + Chwon still missing.
338 // c-hanging-comment-ender-p: nil
339 // indent-tabs-mode: nil