lib/plugin/WikiAdminSearchReplace.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: WikiAdminSearchReplace.php,v 1.13 2004-06-13 14:30:26 rurban Exp $');
   3 /*
   4  Copyright 2004 $ThePhpWikiProgrammingTeam
   5
   6  This file is part of PhpWiki.
   7
   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.
  12
  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.
  17
  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
  21  */
  22
  23 /**
  24  * Usage:   <?plugin WikiAdminSearchReplace ?> or called via WikiAdminSelect
  25  * Author:  Reini Urban <rurban@x-ray.at>
  26  *
  27  * KNOWN ISSUES:
  28  * Currently we must be Admin.
  29  * Future versions will support PagePermissions.
  30  * requires PHP 4.2 so far.
  31  */
  32 require_once('lib/PageList.php');
  33 require_once('lib/plugin/WikiAdminSelect.php');
  34
  35 class WikiPlugin_WikiAdminSearchReplace
  36 extends WikiPlugin_WikiAdminSelect
  37 {
  38     function getName() {
  39         return _("WikiAdminSearchReplace");
  40     }
  41
  42     function getDescription() {
  43         return _("Search and replace text in selected wiki pages.");
  44     }
  45
  46     function getVersion() {
  47         return preg_replace("/[Revision: $]/", '',
  48                             "\$Revision: 1.13 $");
  49     }
  50
  51     function getDefaultArguments() {
  52         return array(
  53                      's'        => false,
  54                      /* Pages to exclude */
  55                      'exclude'  => '.',
  56                      /* Columns to include in listing */
  57                      'info'     => 'some',
  58                      /* How to sort */
  59                      'sortby'   => 'pagename',
  60                      'limit'    => 0,
  61                      );
  62     }
  63
  64     function replaceHelper(&$dbi, $pagename, $from, $to, $caseexact = true) {
  65         $page = $dbi->getPage($pagename);
  66         if ($page->exists()) {// don't replace default contents
  67             $current = $page->getCurrentRevision();
  68             $version = $current->getVersion();
  69             $text = $current->getPackedContent();
  70             if ($caseexact) {
  71                 $newtext = str_replace($from, $to, $text);
  72             } else {
  73                 //not all PHP have this enabled. use a workaround
  74                 if (function_exists('str_ireplace'))
  75                     $newtext = str_ireplace($from, $to, $text);
  76                 else { // see eof
  77                     $newtext = stri_replace($from, $to, $text);
  78                 }
  79             }
  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);
  84             }
  85         }
  86         return false;
  87     }
  88
  89     function searchReplacePages(&$dbi, &$request, $pages, $from, $to) {
  90         if (empty($from)) return HTML::p(HTML::strong(fmt("Error: Empty search string.")));
  91         $ul = HTML::ul();
  92         $count = 0;
  93         $post_args = $request->getArg('admin_replace');
  94         $caseexact = !empty($post_args['caseexact']);
  95         foreach ($pages as $pagename) {
  96             if (!mayAccessPage('edit',$pagename)) {
  97                 $ul->pushContent(HTML::li(fmt("Access denied to change page '%s'.",$pagename)));
  98             } elseif (($result = $this->replaceHelper(&$dbi,$pagename,$from,$to,$caseexact))) {
  99                 $ul->pushContent(HTML::li(fmt("Replaced '%s' with '%s' in page '%s'.", $from, $to, WikiLink($pagename))));
 100                 $count++;
 101             } else {
 102                 $ul->pushContent(HTML::li(fmt("Search string '%s' not found in content of page '%s'.", $from, WikiLink($pagename))));
 103             }
 104         }
 105         if ($count) {
 106             $dbi->touch();
 107             return HTML($ul,
 108                         HTML::p(fmt("%s pages changed.",$count)));
 109         } else {
 110             return HTML($ul,
 111                         HTML::p(fmt("No pages changed.")));
 112         }
 113     }
 114
 115     function run($dbi, $argstr, &$request, $basepage) {
 116         // no action=replace support yet
 117         if ($request->getArg('action') != 'browse')
 118             return $this->disabled("(action != 'browse')");
 119
 120         $args = $this->getArgs($argstr, $request);
 121         $this->_args = $args;
 122         if (!empty($args['exclude']))
 123             $exclude = explodePageList($args['exclude']);
 124         else
 125             $exclude = false;
 126         $this->preSelectS(&$args, &$request);
 127
 128         $p = $request->getArg('p');
 129         if (!$p) $p = $this->_list;
 130         $post_args = $request->getArg('admin_replace');
 131         $next_action = 'select';
 132         $pages = array();
 133         if ($p && !$request->isPost())
 134             $pages = $p;
 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");
 141             }
 142
 143             if ($post_args['action'] == 'verify' and !empty($post_args['from'])) {
 144                 // Real action
 145                 return $this->searchReplacePages($dbi, $request, array_keys($p), $post_args['from'], $post_args['to']);
 146             }
 147             if ($post_args['action'] == 'select') {
 148                 if (!empty($post_args['from']))
 149                     $next_action = 'verify';
 150                 foreach ($p as $name => $c) {
 151                     $pages[$name] = 1;
 152                 }
 153             }
 154         }
 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']);
 159         }
 160
 161         if ($next_action == 'verify') {
 162             $args['info'] = "checkbox,pagename,hi_content";
 163         }
 164         $pagelist = new PageList_Selectable($args['info'], $exclude,
 165                                             array('types' => array(
 166                                                   'hi_content' // with highlighted search for SearchReplace
 167                                                    => new _PageList_Column_content('rev:hi_content', _("Content")))));
 168
 169         $pagelist->addPageList($pages);
 170
 171         $header = HTML::p();
 172         if (empty($post_args['from']))
 173             $header->pushContent(
 174               HTML::p(HTML::em(_("Warning: The search string cannot be empty!"))));
 175         if ($next_action == 'verify') {
 176             $button_label = _("Yes");
 177             $header->pushContent(
 178               HTML::p(HTML::strong(
 179                                    _("Are you sure you want to permanently search & replace text in the selected files?"))));
 180             $this->replaceForm(&$header, $post_args);
 181         }
 182         else {
 183             $button_label = _("Search & Replace");
 184             $this->replaceForm(&$header, $post_args);
 185             $header->pushContent(HTML::p(_("Select the pages to search:")));
 186         }
 187
 188
 189         $buttons = HTML::p(Button('submit:admin_replace[rename]', $button_label, 'wikiadmin'),
 190                            Button('submit:admin_replace[cancel]', _("Cancel"), 'button'));
 191
 192         return HTML::form(array('action' => $request->getPostURL(),
 193                                 'method' => 'post'),
 194                           $header,
 195                           $pagelist->getContent(),
 196                           HiddenInputs($request->getArgs(),
 197                                         false,
 198                                         array('admin_replace')),
 199                           HiddenInputs(array('admin_replace[action]' => $next_action)),
 200                           ENABLE_PAGEPERM
 201                           ? ''
 202                           : HiddenInputs(array('require_authority_for_post' => WIKIAUTH_ADMIN)),
 203                           $buttons);
 204     }
 205
 206     function replaceForm(&$header, $post_args) {
 207         $header->pushContent(_("Replace: "));
 208         $header->pushContent(HTML::input(array('name' => 'admin_replace[from]',
 209                                                'value' => $post_args['from'])));
 210         $header->pushContent(' '._("by").': ');
 211         $header->pushContent(HTML::input(array('name' => 'admin_replace[to]',
 212                                                'value' => $post_args['to'])));
 213         $header->pushContent(' '._("(no regex) Case-exact: "));
 214         $checkbox = HTML::input(array('type' => 'checkbox',
 215                                       'name' => 'admin_replace[caseexact]',
 216                                       'value' => 1));
 217         if (!empty($post_args['caseexact']))
 218             $checkbox->setAttr('checked','checked');
 219         $header->pushContent($checkbox);
 220         $header->pushContent(HTML::br());
 221         return $header;
 222     }
 223 }
 224
 225 function stri_replace($find,$replace,$string) {
 226     if (!is_array($find)) $find = array($find);
 227     if (!is_array($replace))  {
 228         if (!is_array($find))
 229             $replace = array($replace);
 230         else {
 231             // this will duplicate the string into an array the size of $find
 232             $c = count($find);
 233             $rString = $replace;
 234             unset($replace);
 235             for ($i = 0; $i < $c; $i++) {
 236                 $replace[$i] = $rString;
 237             }
 238         }
 239     }
 240     foreach ($find as $fKey => $fItem) {
 241         $between = explode(strtolower($fItem),strtolower($string));
 242         $pos = 0;
 243         foreach($between as $bKey => $bItem) {
 244             $between[$bKey] = substr($string,$pos,strlen($bItem));
 245             $pos += strlen($bItem) + strlen($fItem);
 246         }
 247         $string = implode($replace[$fKey],$between);
 248     }
 249     return $string;
 250 }
 251
 252 // $Log: not supported by cvs2svn $
 253 // Revision 1.12  2004/06/08 10:05:12  rurban
 254 // simplified admin action shortcuts
 255 //
 256 // Revision 1.11  2004/06/04 20:32:54  rurban
 257 // Several locale related improvements suggested by Pierrick Meignen
 258 // LDAP fix by John Cole
 259 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
 260 //
 261 // Revision 1.10  2004/06/03 22:24:48  rurban
 262 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
 263 //
 264 // Revision 1.9  2004/04/07 23:13:19  rurban
 265 // fixed pear/File_Passwd for Windows
 266 // fixed FilePassUser sessions (filehandle revive) and password update
 267 //
 268 // Revision 1.8  2004/03/17 20:23:44  rurban
 269 // fixed p[] pagehash passing from WikiAdminSelect, fixed problem removing pages with [] in the pagename
 270 //
 271 // Revision 1.7  2004/03/12 13:31:43  rurban
 272 // enforce PagePermissions, errormsg if not Admin
 273 //
 274 // Revision 1.6  2004/02/24 15:20:07  rurban
 275 // fixed minor warnings: unchecked args, POST => Get urls for sortby e.g.
 276 //
 277 // Revision 1.5  2004/02/17 12:11:36  rurban
 278 // 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, ...)
 279 //
 280 // Revision 1.4  2004/02/15 21:34:37  rurban
 281 // PageList enhanced and improved.
 282 // fixed new WikiAdmin... plugins
 283 // editpage, Theme with exp. htmlarea framework
 284 //   (htmlarea yet committed, this is really questionable)
 285 // WikiUser... code with better session handling for prefs
 286 // enhanced UserPreferences (again)
 287 // RecentChanges for show_deleted: how should pages be deleted then?
 288 //
 289 // Revision 1.3  2004/02/12 17:05:39  rurban
 290 // WikiAdminRename:
 291 //   added "Change pagename in all linked pages also"
 292 // PageList:
 293 //   added javascript toggle for Select
 294 // WikiAdminSearchReplace:
 295 //   fixed another typo
 296 //
 297 // Revision 1.2  2004/02/12 11:47:51  rurban
 298 // typo
 299 //
 300 // Revision 1.1  2004/02/12 11:25:53  rurban
 301 // new WikiAdminSearchReplace plugin (requires currently Admin)
 302 // removed dead comments from WikiDB
 303 //
 304 //
 305
 306 // Local Variables:
 307 // mode: php
 308 // tab-width: 8
 309 // c-basic-offset: 4
 310 // c-hanging-comment-ender-p: nil
 311 // indent-tabs-mode: nil
 312 // End:
 313 ?>