2 rcs_id('$Id: WikiAdminSearchReplace.php,v 1.15 2004-06-14 11:31:39 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.15 $");
49 function getDefaultArguments() {
52 PageList::supportedArgs(),
55 /* Columns to include in listing */
60 function replaceHelper(&$dbi, $pagename, $from, $to, $caseexact = 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."/".($caseexact?'':'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 $caseexact = !empty($post_args['caseexact']);
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, $caseexact, $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;
124 if (!empty($args['exclude']))
125 $exclude = explodePageList($args['exclude']);
128 $this->preSelectS(&$args, &$request);
130 $p = $request->getArg('p');
131 if (!$p) $p = $this->_list;
132 $post_args = $request->getArg('admin_replace');
133 $next_action = 'select';
135 if ($p && !$request->isPost())
137 if ($p && $request->isPost() &&
138 empty($post_args['cancel'])) {
139 // without individual PagePermissions:
140 if (!ENABLE_PAGEPERM and !$request->_user->isAdmin()) {
141 $request->_notAuthorized(WIKIAUTH_ADMIN);
142 $this->disabled("! user->isAdmin");
145 if ($post_args['action'] == 'verify' and !empty($post_args['from'])) {
147 return $this->searchReplacePages($dbi, $request, array_keys($p), $post_args['from'], $post_args['to']);
149 if ($post_args['action'] == 'select') {
150 if (!empty($post_args['from']))
151 $next_action = 'verify';
152 foreach ($p as $name => $c) {
157 if ($next_action == 'select' and empty($pages)) {
158 // List all pages to select from.
159 //TODO: check for permissions and list only the allowed
160 $pages = $this->collectPages($pages, $dbi, $args['sortby'], $args['limit']);
163 if ($next_action == 'verify') {
164 $args['info'] = "checkbox,pagename,hi_content";
166 $pagelist = new PageList_Selectable($args['info'], $exclude,
170 array('types' => array
172 'hi_content' // with highlighted search for SearchReplace
173 => new _PageList_Column_content('rev:hi_content', _("Content"))))));
175 $pagelist->addPageList($pages);
178 if (empty($post_args['from']))
179 $header->pushContent(
180 HTML::p(HTML::em(_("Warning: The search string cannot be empty!"))));
181 if ($next_action == 'verify') {
182 $button_label = _("Yes");
183 $header->pushContent(
184 HTML::p(HTML::strong(
185 _("Are you sure you want to permanently search & replace text in the selected files?"))));
186 $this->replaceForm(&$header, $post_args);
189 $button_label = _("Search & Replace");
190 $this->replaceForm(&$header, $post_args);
191 $header->pushContent(HTML::p(_("Select the pages to search:")));
195 $buttons = HTML::p(Button('submit:admin_replace[rename]', $button_label, 'wikiadmin'),
196 Button('submit:admin_replace[cancel]', _("Cancel"), 'button'));
198 return HTML::form(array('action' => $request->getPostURL(),
201 $pagelist->getContent(),
202 HiddenInputs($request->getArgs(),
204 array('admin_replace')),
205 HiddenInputs(array('admin_replace[action]' => $next_action)),
208 : HiddenInputs(array('require_authority_for_post' => WIKIAUTH_ADMIN)),
212 function replaceForm(&$header, $post_args) {
213 $header->pushContent(HTML::div(array('class'=>'hint'),
214 _("Replace all occurences of the given string in the content of all pages.")),
216 $header->pushContent(_("Replace: "));
217 $header->pushContent(HTML::input(array('name' => 'admin_replace[from]',
218 'value' => $post_args['from'])));
219 $header->pushContent(' '._("by").': ');
220 $header->pushContent(HTML::input(array('name' => 'admin_replace[to]',
221 'value' => $post_args['to'])));
222 $checkbox = HTML::input(array('type' => 'checkbox',
223 'name' => 'admin_replace[caseexact]',
225 if (!empty($post_args['caseexact']))
226 $checkbox->setAttr('checked','checked');
227 $header->pushContent(HTML::br(),$checkbox," ",_("case-exact"));
228 $checkbox_re = HTML::input(array('type' => 'checkbox',
229 'name' => 'admin_replace[regex]',
230 //'disabled' => 'disabled',
232 if (!empty($post_args['regex']))
233 $checkbox_re->setAttr('checked','checked');
234 $header->pushContent(HTML::br(),HTML::span(//array('style'=>'color: #aaa'),
235 $checkbox_re," ",_("regex")));
236 $header->pushContent(HTML::br());
241 function stri_replace($find,$replace,$string) {
242 if (!is_array($find)) $find = array($find);
243 if (!is_array($replace)) {
244 if (!is_array($find))
245 $replace = array($replace);
247 // this will duplicate the string into an array the size of $find
251 for ($i = 0; $i < $c; $i++) {
252 $replace[$i] = $rString;
256 foreach ($find as $fKey => $fItem) {
257 $between = explode(strtolower($fItem),strtolower($string));
259 foreach($between as $bKey => $bItem) {
260 $between[$bKey] = substr($string,$pos,strlen($bItem));
261 $pos += strlen($bItem) + strlen($fItem);
263 $string = implode($replace[$fKey],$between);
268 // $Log: not supported by cvs2svn $
269 // Revision 1.14 2004/06/13 15:33:20 rurban
270 // new support for arguments owner, author, creator in most relevant
271 // PageList plugins. in WikiAdmin* via preSelectS()
273 // Revision 1.13 2004/06/13 14:30:26 rurban
274 // security fix: check permissions in SearchReplace
276 // Revision 1.12 2004/06/08 10:05:12 rurban
277 // simplified admin action shortcuts
279 // Revision 1.11 2004/06/04 20:32:54 rurban
280 // Several locale related improvements suggested by Pierrick Meignen
281 // LDAP fix by John Cole
282 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
284 // Revision 1.10 2004/06/03 22:24:48 rurban
285 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
287 // Revision 1.9 2004/04/07 23:13:19 rurban
288 // fixed pear/File_Passwd for Windows
289 // fixed FilePassUser sessions (filehandle revive) and password update
291 // Revision 1.8 2004/03/17 20:23:44 rurban
292 // fixed p[] pagehash passing from WikiAdminSelect, fixed problem removing pages with [] in the pagename
294 // Revision 1.7 2004/03/12 13:31:43 rurban
295 // enforce PagePermissions, errormsg if not Admin
297 // Revision 1.6 2004/02/24 15:20:07 rurban
298 // fixed minor warnings: unchecked args, POST => Get urls for sortby e.g.
300 // Revision 1.5 2004/02/17 12:11:36 rurban
301 // 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, ...)
303 // Revision 1.4 2004/02/15 21:34:37 rurban
304 // PageList enhanced and improved.
305 // fixed new WikiAdmin... plugins
306 // editpage, Theme with exp. htmlarea framework
307 // (htmlarea yet committed, this is really questionable)
308 // WikiUser... code with better session handling for prefs
309 // enhanced UserPreferences (again)
310 // RecentChanges for show_deleted: how should pages be deleted then?
312 // Revision 1.3 2004/02/12 17:05:39 rurban
314 // added "Change pagename in all linked pages also"
316 // added javascript toggle for Select
317 // WikiAdminSearchReplace:
318 // fixed another typo
320 // Revision 1.2 2004/02/12 11:47:51 rurban
323 // Revision 1.1 2004/02/12 11:25:53 rurban
324 // new WikiAdminSearchReplace plugin (requires currently Admin)
325 // removed dead comments from WikiDB
333 // c-hanging-comment-ender-p: nil
334 // indent-tabs-mode: nil