2 rcs_id('$Id: WikiAdminSearchReplace.php,v 1.19 2004-11-26 18:39:02 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 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.19 $");
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, $case_exact, $regex))) {
100 $ul->pushContent(HTML::li(fmt("Replaced '%s' with '%s' in page '%s'.", $from, $to, WikiLink($pagename))));
103 $ul->pushContent(HTML::li(fmt("Search string '%s' not found in content of page '%s'.",
104 $from, WikiLink($pagename))));
110 HTML::p(fmt("%s pages changed.",$count)));
113 HTML::p(fmt("No pages changed.")));
117 function run($dbi, $argstr, &$request, $basepage) {
118 // no action=replace support yet
119 if ($request->getArg('action') != 'browse')
120 return $this->disabled("(action != 'browse')");
122 $args = $this->getArgs($argstr, $request);
123 $this->_args = $args;
125 //TODO: support p from <!plugin-list !>
126 $this->preSelectS($args, $request);
128 $p = $request->getArg('p');
129 if (!$p) $p = $this->_list;
130 $post_args = $request->getArg('admin_replace');
131 $next_action = 'select';
133 if ($p && !$request->isPost())
135 if ($p && $request->isPost() &&
136 empty($post_args['cancel'])) {
137 // without individual PagePermissions:
138 if (!ENABLE_PAGEPERM and !$request->_user->isAdmin()) {
139 $request->_notAuthorized(WIKIAUTH_ADMIN);
140 $this->disabled("! user->isAdmin");
143 if ($post_args['action'] == 'verify' and !empty($post_args['from'])) {
145 return $this->searchReplacePages($dbi, $request, array_keys($p), $post_args['from'], $post_args['to']);
147 if ($post_args['action'] == 'select') {
148 if (!empty($post_args['from']))
149 $next_action = 'verify';
150 foreach ($p as $name => $c) {
155 if ($next_action == 'select' and empty($pages)) {
156 // List all pages to select from.
157 //TODO: check for permissions and list only the allowed
158 $pages = $this->collectPages($pages, $dbi, $args['sortby'], $args['limit'], $args['exclude']);
161 if ($next_action == 'verify') {
162 $args['info'] = "checkbox,pagename,hi_content";
164 $pagelist = new PageList_Selectable($args['info'], $args['exclude'],
168 array('types' => array
170 'hi_content' // with highlighted search for SearchReplace
171 => new _PageList_Column_content('rev:hi_content', _("Content"))))));
173 $pagelist->addPageList($pages);
176 if (empty($post_args['from']))
177 $header->pushContent(
178 HTML::p(HTML::em(_("Warning: The search string cannot be empty!"))));
179 if ($next_action == 'verify') {
180 $button_label = _("Yes");
181 $header->pushContent(
182 HTML::p(HTML::strong(
183 _("Are you sure you want to permanently search & replace text in the selected files?"))));
184 $this->replaceForm($header, $post_args);
187 $button_label = _("Search & Replace");
188 $this->replaceForm($header, $post_args);
189 $header->pushContent(HTML::p(_("Select the pages to search:")));
193 $buttons = HTML::p(Button('submit:admin_replace[rename]', $button_label, 'wikiadmin'),
194 Button('submit:admin_replace[cancel]', _("Cancel"), 'button'));
196 return HTML::form(array('action' => $request->getPostURL(),
199 $pagelist->getContent(),
200 HiddenInputs($request->getArgs(),
202 array('admin_replace')),
203 HiddenInputs(array('admin_replace[action]' => $next_action)),
206 : HiddenInputs(array('require_authority_for_post' => WIKIAUTH_ADMIN)),
210 function replaceForm(&$header, $post_args) {
211 $header->pushContent(HTML::div(array('class'=>'hint'),
212 _("Replace all occurences of the given string in the content of all pages.")),
214 $header->pushContent(_("Replace: "));
215 $header->pushContent(HTML::input(array('name' => 'admin_replace[from]',
216 'value' => $post_args['from'])));
217 $header->pushContent(' '._("by").': ');
218 $header->pushContent(HTML::input(array('name' => 'admin_replace[to]',
219 'value' => $post_args['to'])));
220 $checkbox = HTML::input(array('type' => 'checkbox',
221 'name' => 'admin_replace[case_exact]',
223 if (!empty($post_args['case_exact']))
224 $checkbox->setAttr('checked','checked');
225 $header->pushContent(HTML::br(),$checkbox," ",_("case-exact"));
226 $checkbox_re = HTML::input(array('type' => 'checkbox',
227 'name' => 'admin_replace[regex]',
228 //'disabled' => 'disabled',
230 if (!empty($post_args['regex']))
231 $checkbox_re->setAttr('checked','checked');
232 $header->pushContent(HTML::br(),HTML::span(//array('style'=>'color: #aaa'),
233 $checkbox_re," ",_("regex")));
234 $header->pushContent(HTML::br());
239 function stri_replace($find,$replace,$string) {
240 if (!is_array($find)) $find = array($find);
241 if (!is_array($replace)) {
242 if (!is_array($find))
243 $replace = array($replace);
245 // this will duplicate the string into an array the size of $find
249 for ($i = 0; $i < $c; $i++) {
250 $replace[$i] = $rString;
254 foreach ($find as $fKey => $fItem) {
255 $between = explode(strtolower($fItem),strtolower($string));
257 foreach($between as $bKey => $bItem) {
258 $between[$bKey] = substr($string,$pos,strlen($bItem));
259 $pos += strlen($bItem) + strlen($fItem);
261 $string = implode($replace[$fKey],$between);
266 // $Log: not supported by cvs2svn $
267 // Revision 1.18 2004/11/23 15:17:20 rurban
268 // better support for case_exact search (not caseexact for consistency),
269 // plugin args simplification:
270 // handle and explode exclude and pages argument in WikiPlugin::getArgs
271 // and exclude in advance (at the sql level if possible)
272 // handle sortby and limit from request override in WikiPlugin::getArgs
273 // ListSubpages: renamed pages to maxpages
275 // Revision 1.17 2004/09/17 14:24:06 rurban
276 // support exclude=<!plugin-list !>, p not yet
278 // Revision 1.16 2004/06/16 10:38:59 rurban
279 // Disallow refernces in calls if the declaration is a reference
280 // ("allow_call_time_pass_reference clean").
281 // PhpWiki is now allow_call_time_pass_reference = Off clean,
282 // but several external libraries may not.
283 // In detail these libs look to be affected (not tested):
287 // Revision 1.15 2004/06/14 11:31:39 rurban
288 // renamed global $Theme to $WikiTheme (gforge nameclash)
289 // inherit PageList default options from PageList
290 // default sortby=pagename
291 // use options in PageList_Selectable (limit, sortby, ...)
292 // added action revert, with button at action=diff
293 // added option regex to WikiAdminSearchReplace
295 // Revision 1.14 2004/06/13 15:33:20 rurban
296 // new support for arguments owner, author, creator in most relevant
297 // PageList plugins. in WikiAdmin* via preSelectS()
299 // Revision 1.13 2004/06/13 14:30:26 rurban
300 // security fix: check permissions in SearchReplace
302 // Revision 1.12 2004/06/08 10:05:12 rurban
303 // simplified admin action shortcuts
305 // Revision 1.11 2004/06/04 20:32:54 rurban
306 // Several locale related improvements suggested by Pierrick Meignen
307 // LDAP fix by John Cole
308 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
310 // Revision 1.10 2004/06/03 22:24:48 rurban
311 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
313 // Revision 1.9 2004/04/07 23:13:19 rurban
314 // fixed pear/File_Passwd for Windows
315 // fixed FilePassUser sessions (filehandle revive) and password update
317 // Revision 1.8 2004/03/17 20:23:44 rurban
318 // fixed p[] pagehash passing from WikiAdminSelect, fixed problem removing pages with [] in the pagename
320 // Revision 1.7 2004/03/12 13:31:43 rurban
321 // enforce PagePermissions, errormsg if not Admin
323 // Revision 1.6 2004/02/24 15:20:07 rurban
324 // fixed minor warnings: unchecked args, POST => Get urls for sortby e.g.
326 // Revision 1.5 2004/02/17 12:11:36 rurban
327 // 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, ...)
329 // Revision 1.4 2004/02/15 21:34:37 rurban
330 // PageList enhanced and improved.
331 // fixed new WikiAdmin... plugins
332 // editpage, Theme with exp. htmlarea framework
333 // (htmlarea yet committed, this is really questionable)
334 // WikiUser... code with better session handling for prefs
335 // enhanced UserPreferences (again)
336 // RecentChanges for show_deleted: how should pages be deleted then?
338 // Revision 1.3 2004/02/12 17:05:39 rurban
340 // added "Change pagename in all linked pages also"
342 // added javascript toggle for Select
343 // WikiAdminSearchReplace:
344 // fixed another typo
346 // Revision 1.2 2004/02/12 11:47:51 rurban
349 // Revision 1.1 2004/02/12 11:25:53 rurban
350 // new WikiAdminSearchReplace plugin (requires currently Admin)
351 // removed dead comments from WikiDB
359 // c-hanging-comment-ender-p: nil
360 // indent-tabs-mode: nil