4 Copyright 2004,2007 $ThePhpWikiProgrammingTeam
5 Copyright 2008-2009 Marc-Etienne Vargenau, Alcatel-Lucent
7 This file is part of PhpWiki.
9 PhpWiki is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 PhpWiki is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with PhpWiki; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 * Usage: <?plugin WikiAdminSearchReplace ?> or called via WikiAdminSelect
26 * Author: Reini Urban <rurban@x-ray.at>
29 * Requires PHP 4.2 so far.
31 require_once('lib/PageList.php');
32 require_once('lib/plugin/WikiAdminSelect.php');
34 class WikiPlugin_WikiAdminSearchReplace
35 extends WikiPlugin_WikiAdminSelect
38 return _("WikiAdminSearchReplace");
41 function getDescription() {
42 return _("Search and replace text in selected wiki pages.");
45 function getVersion() {
46 return preg_replace("/[Revision: $]/", '',
50 function getDefaultArguments() {
53 WikiPlugin_WikiAdminSelect::getDefaultArguments(),
55 /* Columns to include in listing */
60 function replaceHelper(&$dbi, &$request, $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(_("Replace '%s' by '%s'"), $from, $to);
83 $meta['is_minor_edit'] = 0;
84 $meta['author'] = $request->_user->UserName();
85 unset($meta['mtime']); // force new date
86 return $page->save($newtext, $version + 1, $meta);
92 function searchReplacePages(&$dbi, &$request, $pages, $from, $to) {
93 if (empty($from)) return HTML::p(HTML::strong(fmt("Error: Empty search string.")));
94 $result = HTML::div();
97 $post_args = $request->getArg('admin_replace');
98 $case_exact = !empty($post_args['case_exact']);
99 $regex = !empty($post_args['regex']);
100 foreach ($pages as $pagename) {
101 if (!mayAccessPage('edit', $pagename)) {
102 $ul->pushContent(HTML::li(fmt("Access denied to change page '%s'.",$pagename)));
103 } elseif ($this->replaceHelper($dbi, $request, $pagename, $from, $to, $case_exact, $regex)) {
104 $ul->pushContent(HTML::li(fmt("Replaced '%s' with '%s' in page '%s'.",
105 $from, $to, WikiLink($pagename))));
111 $result->setAttr('class', 'feedback');
113 $result->pushContent(HTML::p("One page has been permanently changed:"));
115 $result->pushContent(HTML::p(fmt("%s pages have been permanently changed:", $count)));
117 $result->pushContent($ul);
119 $result->setAttr('class', 'error');
120 $result->pushContent(HTML::p("No pages changed."));
125 function run($dbi, $argstr, &$request, $basepage) {
126 // no action=replace support yet
127 if ($request->getArg('action') != 'browse')
128 return $this->disabled("(action != 'browse')");
130 $args = $this->getArgs($argstr, $request);
131 $this->_args = $args;
133 //TODO: support p from <!plugin-list !>
134 $this->preSelectS($args, $request);
136 $p = $request->getArg('p');
137 if (!$p) $p = $this->_list;
138 $post_args = $request->getArg('admin_replace');
139 $next_action = 'select';
141 if ($p && !$request->isPost())
143 if ($p && $request->isPost() &&
144 empty($post_args['cancel'])) {
145 // without individual PagePermissions:
146 if (!ENABLE_PAGEPERM and !$request->_user->isAdmin()) {
147 $request->_notAuthorized(WIKIAUTH_ADMIN);
148 $this->disabled("! user->isAdmin");
151 if ($post_args['action'] == 'verify' and !empty($post_args['from'])) {
153 return $this->searchReplacePages($dbi, $request, array_keys($p),
154 $post_args['from'], $post_args['to']);
156 if ($post_args['action'] == 'select') {
157 if (!empty($post_args['from']))
158 $next_action = 'verify';
159 foreach ($p as $name => $c) {
164 if ($next_action == 'select' and empty($pages)) {
165 // List all pages to select from.
166 //TODO: check for permissions and list only the allowed
167 $pages = $this->collectPages($pages, $dbi, $args['sortby'],
168 $args['limit'], $args['exclude']);
171 if ($next_action == 'verify') {
172 $args['info'] = "checkbox,pagename,hi_content";
174 $pagelist = new PageList_Selectable
175 ($args['info'], $args['exclude'],
179 array('types' => array
181 'hi_content' // with highlighted search for SearchReplace
182 => new _PageList_Column_content('rev:hi_content', _("Content"))))));
184 $pagelist->addPageList($pages);
186 $header = HTML::fieldset();
187 if (empty($post_args['from']))
188 $header->pushContent(
189 HTML::p(HTML::em(_("Warning: The search string cannot be empty!"))));
190 if ($next_action == 'verify') {
191 $button_label = _("Yes");
192 $header->pushContent(
193 HTML::p(HTML::strong(
194 _("Are you sure you want to permanently search & replace text in the selected files?"))));
195 $this->replaceForm($header, $post_args);
198 $button_label = _("Search & Replace");
199 $this->replaceForm($header, $post_args);
200 $header->pushContent(HTML::legend(_("Select the pages to search and replace")));
204 $buttons = HTML::p(Button('submit:admin_replace[rename]', $button_label, 'wikiadmin'),
205 Button('submit:admin_replace[cancel]', _("Cancel"), 'button'));
207 return HTML::form(array('action' => $request->getPostURL(),
211 $pagelist->getContent(),
212 HiddenInputs($request->getArgs(),
214 array('admin_replace')),
215 HiddenInputs(array('admin_replace[action]' => $next_action)),
218 : HiddenInputs(array('require_authority_for_post' => WIKIAUTH_ADMIN)));
221 function checkBox (&$post_args, $name, $msg) {
222 $id = 'admin_replace-'.$name;
223 $checkbox = HTML::input(array('type' => 'checkbox',
224 'name' => 'admin_replace['.$name.']',
227 if (!empty($post_args[$name]))
228 $checkbox->setAttr('checked', 'checked');
229 return HTML::div($checkbox, ' ', HTML::label(array('for' => $id), $msg));
232 function replaceForm(&$header, $post_args) {
233 $header->pushContent(HTML::div(array('class'=>'hint'),
234 _("Replace all occurences of the given string in the content of all pages.")),
236 $table = HTML::table();
237 $this->_tablePush($table, _("Replace").": ",
238 HTML::input(array('name' => 'admin_replace[from]',
240 'value' => $post_args['from'])));
241 $this->_tablePush($table, _("by").': ',
242 HTML::input(array('name' => 'admin_replace[to]',
244 'value' => $post_args['to'])));
245 $this->_tablePush($table, '', $this->checkBox($post_args, 'case_exact', _("Case exact?")));
246 $this->_tablePush($table, '', $this->checkBox($post_args, 'regex', _("Regex?")));
247 $header->pushContent($table);
248 $header->pushContent(HTML::br());
253 function stri_replace($find,$replace,$string) {
254 if (!is_array($find)) $find = array($find);
255 if (!is_array($replace)) {
256 if (!is_array($find))
257 $replace = array($replace);
259 // this will duplicate the string into an array the size of $find
263 for ($i = 0; $i < $c; $i++) {
264 $replace[$i] = $rString;
268 foreach ($find as $fKey => $fItem) {
269 $between = explode(strtolower($fItem),strtolower($string));
271 foreach($between as $bKey => $bItem) {
272 $between[$bKey] = substr($string,$pos,strlen($bItem));
273 $pos += strlen($bItem) + strlen($fItem);
275 $string = implode($replace[$fKey],$between);
284 // c-hanging-comment-ender-p: nil
285 // indent-tabs-mode: nil