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 along
20 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 * Usage: <<WikiAdminSearchReplace >> or called via WikiAdminSelect
26 * Author: Reini Urban <rurban@x-ray.at>
29 require_once 'lib/PageList.php';
30 require_once 'lib/plugin/WikiAdminSelect.php';
32 class WikiPlugin_WikiAdminSearchReplace
33 extends WikiPlugin_WikiAdminSelect
37 return _("WikiAdminSearchReplace");
40 function getDescription()
42 return _("Search and replace text in selected wiki pages.");
45 function getDefaultArguments()
49 WikiPlugin_WikiAdminSelect::getDefaultArguments(),
51 /* Columns to include in listing */
56 function replaceHelper(&$dbi, &$request, $pagename, $from, $to, $case_exact = true, $regex = false)
58 $page = $dbi->getPage($pagename);
59 if ($page->exists()) { // don't replace default contents
60 $current = $page->getCurrentRevision();
61 $version = $current->getVersion();
62 $text = $current->getPackedContent();
64 $newtext = preg_replace("/" . $from . "/" . ($case_exact ? '' : 'i'), $to, $text);
67 $newtext = str_replace($from, $to, $text);
69 //not all PHP have this enabled. use a workaround
70 if (function_exists('str_ireplace'))
71 $newtext = str_ireplace($from, $to, $text);
73 $newtext = stri_replace($from, $to, $text);
77 if ($text != $newtext) {
78 $meta = $current->_data;
79 $meta['summary'] = sprintf(_("Replace '%s' by '%s'"), $from, $to);
80 $meta['is_minor_edit'] = 0;
81 $meta['author'] = $request->_user->UserName();
82 unset($meta['mtime']); // force new date
83 return $page->save($newtext, $version + 1, $meta);
89 function searchReplacePages(&$dbi, &$request, $pages, $from, $to)
91 if (empty($from)) return HTML::p(HTML::strong(fmt("Error: Empty search string.")));
92 $result = HTML::div();
95 $post_args = $request->getArg('admin_replace');
96 $case_exact = !empty($post_args['case_exact']);
97 $regex = !empty($post_args['regex']);
98 foreach ($pages as $pagename) {
99 if (!mayAccessPage('edit', $pagename)) {
100 $ul->pushContent(HTML::li(fmt("Access denied to change page '%s'.", $pagename)));
101 } elseif ($this->replaceHelper($dbi, $request, $pagename, $from, $to, $case_exact, $regex)) {
102 $ul->pushContent(HTML::li(fmt("Replaced '%s' with '%s' in page '%s'.",
103 $from, $to, WikiLink($pagename))));
109 $result->setAttr('class', 'feedback');
111 $result->pushContent(HTML::p(_("One page has been changed:")));
113 $result->pushContent(HTML::p(fmt("%d pages have been changed:", $count)));
115 $result->pushContent($ul);
117 $result->setAttr('class', 'error');
118 $result->pushContent(HTML::p(_("No pages changed.")));
123 function run($dbi, $argstr, &$request, $basepage)
125 // no action=replace support yet
126 if ($request->getArg('action') != 'browse') {
127 return $this->disabled(_("Plugin not run: not in browse mode"));
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'])
146 // without individual PagePermissions:
147 if (!ENABLE_PAGEPERM and !$request->_user->isAdmin()) {
148 $request->_notAuthorized(WIKIAUTH_ADMIN);
149 $this->disabled("! user->isAdmin");
152 if ($post_args['action'] == 'verify' and !empty($post_args['from'])) {
154 return $this->searchReplacePages($dbi, $request, array_keys($p),
155 $post_args['from'], $post_args['to']);
157 if ($post_args['action'] == 'select') {
158 if (!empty($post_args['from']))
159 $next_action = 'verify';
160 foreach ($p as $name => $c) {
165 if ($next_action == 'select' and empty($pages)) {
166 // List all pages to select from.
167 //TODO: check for permissions and list only the allowed
168 $pages = $this->collectPages($pages, $dbi, $args['sortby'],
169 $args['limit'], $args['exclude']);
172 if ($next_action == 'verify') {
173 $args['info'] = "checkbox,pagename";
175 $args['info'] = "checkbox,pagename,hi_content,mtime,author";
177 $pagelist = new PageList_Selectable
178 ($args['info'], $args['exclude'],
182 array('types' => array
184 'hi_content' // with highlighted search for SearchReplace
185 => new _PageList_Column_content('rev:hi_content', _("Content"))))));
187 $pagelist->addPageList($pages);
189 $header = HTML::fieldset();
190 if (empty($post_args['from']))
191 $header->pushContent(
192 HTML::p(HTML::em(_("Warning: The search string cannot be empty!"))));
193 if ($next_action == 'verify') {
194 $button_label = _("Yes");
195 $header->pushContent(
196 HTML::p(HTML::strong(
197 _("Are you sure you want to replace text in the selected files?"))));
198 $this->replaceForm($header, $post_args);
200 $button_label = _("Search & Replace");
201 $this->replaceForm($header, $post_args);
202 $header->pushContent(HTML::legend(_("Select the pages to search and replace")));
205 $buttons = HTML::p(Button('submit:admin_replace[replace]', $button_label, 'wikiadmin'),
206 Button('submit:admin_replace[cancel]', _("Cancel"), 'button'));
207 $header->pushContent($buttons);
209 return HTML::form(array('action' => $request->getPostURL(),
212 $pagelist->getContent(),
213 HiddenInputs($request->getArgs(),
215 array('admin_replace')),
216 HiddenInputs(array('admin_replace[action]' => $next_action)),
219 : HiddenInputs(array('require_authority_for_post' => WIKIAUTH_ADMIN)));
222 function checkBox(&$post_args, $name, $msg)
224 $id = 'admin_replace-' . $name;
225 $checkbox = HTML::input(array('type' => 'checkbox',
226 'name' => 'admin_replace[' . $name . ']',
229 if (!empty($post_args[$name]))
230 $checkbox->setAttr('checked', 'checked');
231 return HTML::div($checkbox, ' ', HTML::label(array('for' => $id), $msg));
234 function replaceForm(&$header, $post_args)
236 $header->pushContent(HTML::div(array('class' => 'hint'),
237 _("Replace all occurences of the given string in the content of all pages.")),
239 $table = HTML::table();
240 $this->_tablePush($table, _("Replace") . _(": "),
241 HTML::input(array('name' => 'admin_replace[from]',
243 'value' => $post_args['from'])));
244 $this->_tablePush($table, _("by") . _(": "),
245 HTML::input(array('name' => 'admin_replace[to]',
247 'value' => $post_args['to'])));
248 $this->_tablePush($table, '', $this->checkBox($post_args, 'case_exact', _("Case exact?")));
249 $this->_tablePush($table, '', $this->checkBox($post_args, 'regex', _("Regex?")));
250 $header->pushContent($table);
255 function stri_replace($find, $replace, $string)
257 if (!is_array($find)) $find = array($find);
258 if (!is_array($replace)) {
259 if (!is_array($find))
260 $replace = array($replace);
262 // this will duplicate the string into an array the size of $find
266 for ($i = 0; $i < $c; $i++) {
267 $replace[$i] = $rString;
271 foreach ($find as $fKey => $fItem) {
272 $between = explode(strtolower($fItem), strtolower($string));
274 foreach ($between as $bKey => $bItem) {
275 $between[$bKey] = substr($string, $pos, strlen($bItem));
276 $pos += strlen($bItem) + strlen($fItem);
278 $string = implode($replace[$fKey], $between);
287 // c-hanging-comment-ender-p: nil
288 // indent-tabs-mode: nil