4 Copyright 2004,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 WikiAdminSearchReplace ?> or called via WikiAdminSelect
25 * Author: Reini Urban <rurban@x-ray.at>
28 * Requires PHP 4.2 so far.
30 require_once('lib/PageList.php');
31 require_once('lib/plugin/WikiAdminSelect.php');
33 class WikiPlugin_WikiAdminSearchReplace
34 extends WikiPlugin_WikiAdminSelect
37 return _("WikiAdminSearchReplace");
40 function getDescription() {
41 return _("Search and replace text in selected wiki pages.");
44 function getVersion() {
45 return preg_replace("/[Revision: $]/", '',
46 "\$Revision: 1.20 $");
49 function getDefaultArguments() {
52 PageList::supportedArgs(),
55 /* Columns to include in listing */
60 function replaceHelper(&$dbi, $pagename, $from, $to, $case_exact=true, $regex=false) {
61 $page = $dbi->getPage($pagename);
62 if ($page->exists()) {// don't replace default contents
63 $current = $page->getCurrentRevision();
64 $version = $current->getVersion();
65 $text = $current->getPackedContent();
67 $newtext = preg_replace("/".$from."/".($case_exact?'':'i'), $to, $text);
70 $newtext = str_replace($from, $to, $text);
72 //not all PHP have this enabled. use a workaround
73 if (function_exists('str_ireplace'))
74 $newtext = str_ireplace($from, $to, $text);
76 $newtext = stri_replace($from, $to, $text);
80 if ($text != $newtext) {
81 $meta = $current->_data;
82 $meta['summary'] = sprintf(_("WikiAdminSearchReplace %s by %s"),$from,$to);
83 return $page->save($newtext, $version + 1, $meta);
89 function searchReplacePages(&$dbi, &$request, $pages, $from, $to) {
90 if (empty($from)) return HTML::p(HTML::strong(fmt("Error: Empty search string.")));
93 $post_args = $request->getArg('admin_replace');
94 $case_exact = !empty($post_args['case_exact']);
95 $regex = !empty($post_args['regex']);
96 foreach ($pages as $pagename) {
97 if (!mayAccessPage('edit', $pagename)) {
98 $ul->pushContent(HTML::li(fmt("Access denied to change page '%s'.",$pagename)));
99 } elseif (($result = $this->replaceHelper($dbi, $pagename, $from, $to,
100 $case_exact, $regex)))
102 $ul->pushContent(HTML::li(fmt("Replaced '%s' with '%s' in page '%s'.",
103 $from, $to, WikiLink($pagename))));
106 $ul->pushContent(HTML::li(fmt("Search string '%s' not found in content of page '%s'.",
107 $from, WikiLink($pagename))));
113 HTML::p(fmt("%s pages changed.",$count)));
116 HTML::p(fmt("No pages changed.")));
120 function run($dbi, $argstr, &$request, $basepage) {
121 // no action=replace support yet
122 if ($request->getArg('action') != 'browse')
123 return $this->disabled("(action != 'browse')");
125 $args = $this->getArgs($argstr, $request);
126 $this->_args = $args;
128 //TODO: support p from <!plugin-list !>
129 $this->preSelectS($args, $request);
131 $p = $request->getArg('p');
132 if (!$p) $p = $this->_list;
133 $post_args = $request->getArg('admin_replace');
134 $next_action = 'select';
136 if ($p && !$request->isPost())
138 if ($p && $request->isPost() &&
139 empty($post_args['cancel'])) {
140 // without individual PagePermissions:
141 if (!ENABLE_PAGEPERM and !$request->_user->isAdmin()) {
142 $request->_notAuthorized(WIKIAUTH_ADMIN);
143 $this->disabled("! user->isAdmin");
146 if ($post_args['action'] == 'verify' and !empty($post_args['from'])) {
148 return $this->searchReplacePages($dbi, $request, array_keys($p),
149 $post_args['from'], $post_args['to']);
151 if ($post_args['action'] == 'select') {
152 if (!empty($post_args['from']))
153 $next_action = 'verify';
154 foreach ($p as $name => $c) {
159 if ($next_action == 'select' and empty($pages)) {
160 // List all pages to select from.
161 //TODO: check for permissions and list only the allowed
162 $pages = $this->collectPages($pages, $dbi, $args['sortby'],
163 $args['limit'], $args['exclude']);
166 if ($next_action == 'verify') {
167 $args['info'] = "checkbox,pagename,hi_content";
169 $pagelist = new PageList_Selectable
170 ($args['info'], $args['exclude'],
174 array('types' => array
176 'hi_content' // with highlighted search for SearchReplace
177 => new _PageList_Column_content('rev:hi_content', _("Content"))))));
179 $pagelist->addPageList($pages);
182 if (empty($post_args['from']))
183 $header->pushContent(
184 HTML::p(HTML::em(_("Warning: The search string cannot be empty!"))));
185 if ($next_action == 'verify') {
186 $button_label = _("Yes");
187 $header->pushContent(
188 HTML::p(HTML::strong(
189 _("Are you sure you want to permanently search & replace text in the selected files?"))));
190 $this->replaceForm($header, $post_args);
193 $button_label = _("Search & Replace");
194 $this->replaceForm($header, $post_args);
195 $header->pushContent(HTML::p(_("Select the pages to search:")));
199 $buttons = HTML::p(Button('submit:admin_replace[rename]', $button_label, 'wikiadmin'),
200 Button('submit:admin_replace[cancel]', _("Cancel"), 'button'));
202 return HTML::form(array('action' => $request->getPostURL(),
205 $pagelist->getContent(),
206 HiddenInputs($request->getArgs(),
208 array('admin_replace')),
209 HiddenInputs(array('admin_replace[action]' => $next_action)),
212 : HiddenInputs(array('require_authority_for_post' => WIKIAUTH_ADMIN)),
216 function checkBox (&$post_args, $name, $msg) {
217 $id = 'admin_replace-'.$name;
218 $checkbox = HTML::input(array('type' => 'checkbox',
219 'name' => 'admin_replace['.$name.']',
222 if (!empty($post_args[$name]))
223 $checkbox->setAttr('checked', 'checked');
224 return HTML::div($checkbox, ' ', HTML::label(array('for' => $id), $msg));
227 function replaceForm(&$header, $post_args) {
228 $header->pushContent(HTML::div(array('class'=>'hint'),
229 _("Replace all occurences of the given string in the content of all pages.")),
231 $table = HTML::table();
232 $this->_tablePush($table, _("Replace").": ",
233 HTML::input(array('name' => 'admin_replace[from]',
235 'value' => $post_args['from'])));
236 $this->_tablePush($table, _("by").': ',
237 HTML::input(array('name' => 'admin_replace[to]',
239 'value' => $post_args['to'])));
240 $this->_tablePush($table, '', $this->checkBox($post_args, 'case_exact', _("Case exact?")));
241 $this->_tablePush($table, '', $this->checkBox($post_args, 'regex', _("Regex?")));
242 $header->pushContent($table);
243 $header->pushContent(HTML::br());
248 function stri_replace($find,$replace,$string) {
249 if (!is_array($find)) $find = array($find);
250 if (!is_array($replace)) {
251 if (!is_array($find))
252 $replace = array($replace);
254 // this will duplicate the string into an array the size of $find
258 for ($i = 0; $i < $c; $i++) {
259 $replace[$i] = $rString;
263 foreach ($find as $fKey => $fItem) {
264 $between = explode(strtolower($fItem),strtolower($string));
266 foreach($between as $bKey => $bItem) {
267 $between[$bKey] = substr($string,$pos,strlen($bItem));
268 $pos += strlen($bItem) + strlen($fItem);
270 $string = implode($replace[$fKey],$between);
275 // $Log: not supported by cvs2svn $
276 // Revision 1.19 2004/11/26 18:39:02 rurban
277 // new regex search parser and SQL backends (90% complete, glob and pcre backends missing)
279 // Revision 1.18 2004/11/23 15:17:20 rurban
280 // better support for case_exact search (not caseexact for consistency),
281 // plugin args simplification:
282 // handle and explode exclude and pages argument in WikiPlugin::getArgs
283 // and exclude in advance (at the sql level if possible)
284 // handle sortby and limit from request override in WikiPlugin::getArgs
285 // ListSubpages: renamed pages to maxpages
287 // Revision 1.17 2004/09/17 14:24:06 rurban
288 // support exclude=<!plugin-list !>, p not yet
290 // Revision 1.16 2004/06/16 10:38:59 rurban
291 // Disallow refernces in calls if the declaration is a reference
292 // ("allow_call_time_pass_reference clean").
293 // PhpWiki is now allow_call_time_pass_reference = Off clean,
294 // but several external libraries may not.
295 // In detail these libs look to be affected (not tested):
299 // Revision 1.15 2004/06/14 11:31:39 rurban
300 // renamed global $Theme to $WikiTheme (gforge nameclash)
301 // inherit PageList default options from PageList
302 // default sortby=pagename
303 // use options in PageList_Selectable (limit, sortby, ...)
304 // added action revert, with button at action=diff
305 // added option regex to WikiAdminSearchReplace
307 // Revision 1.14 2004/06/13 15:33:20 rurban
308 // new support for arguments owner, author, creator in most relevant
309 // PageList plugins. in WikiAdmin* via preSelectS()
311 // Revision 1.13 2004/06/13 14:30:26 rurban
312 // security fix: check permissions in SearchReplace
314 // Revision 1.12 2004/06/08 10:05:12 rurban
315 // simplified admin action shortcuts
317 // Revision 1.11 2004/06/04 20:32:54 rurban
318 // Several locale related improvements suggested by Pierrick Meignen
319 // LDAP fix by John Cole
320 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
322 // Revision 1.10 2004/06/03 22:24:48 rurban
323 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
325 // Revision 1.9 2004/04/07 23:13:19 rurban
326 // fixed pear/File_Passwd for Windows
327 // fixed FilePassUser sessions (filehandle revive) and password update
329 // Revision 1.8 2004/03/17 20:23:44 rurban
330 // fixed p[] pagehash passing from WikiAdminSelect, fixed problem removing pages with [] in the pagename
332 // Revision 1.7 2004/03/12 13:31:43 rurban
333 // enforce PagePermissions, errormsg if not Admin
335 // Revision 1.6 2004/02/24 15:20:07 rurban
336 // fixed minor warnings: unchecked args, POST => Get urls for sortby e.g.
338 // Revision 1.5 2004/02/17 12:11:36 rurban
339 // 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, ...)
341 // Revision 1.4 2004/02/15 21:34:37 rurban
342 // PageList enhanced and improved.
343 // fixed new WikiAdmin... plugins
344 // editpage, Theme with exp. htmlarea framework
345 // (htmlarea yet committed, this is really questionable)
346 // WikiUser... code with better session handling for prefs
347 // enhanced UserPreferences (again)
348 // RecentChanges for show_deleted: how should pages be deleted then?
350 // Revision 1.3 2004/02/12 17:05:39 rurban
352 // added "Change pagename in all linked pages also"
354 // added javascript toggle for Select
355 // WikiAdminSearchReplace:
356 // fixed another typo
358 // Revision 1.2 2004/02/12 11:47:51 rurban
361 // Revision 1.1 2004/02/12 11:25:53 rurban
362 // new WikiAdminSearchReplace plugin (requires currently Admin)
363 // removed dead comments from WikiDB
371 // c-hanging-comment-ender-p: nil
372 // indent-tabs-mode: nil