lib/plugin/WikiAdminSearchReplace.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: WikiAdminSearchReplace.php,v 1.9 2004-04-07 23:13:19 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.9 $");
  49     }
  50
  51     function getDefaultArguments() {
  52         return array(
  53                      /* Pages to exclude */
  54                      'exclude'  => '.',
  55                      /* Columns to include in listing */
  56                      'info'     => 'some',
  57                      /* How to sort */
  58                      'sortby'   => 'pagename',
  59                      'limit'    => 0,
  60                      );
  61     }
  62
  63     function replaceHelper(&$dbi, $pagename, $from, $to, $caseexact = true) {
  64         $page = $dbi->getPage($pagename);
  65         if ($page->exists()) {// don't replace default contents
  66             $current = $page->getCurrentRevision();
  67             $version = $current->getVersion();
  68             $text = $current->getPackedContent();
  69             if ($caseexact) {
  70                 $newtext = str_replace($from, $to, $text);
  71             } else {
  72                 //not all PHP have this enabled. use a workaround
  73                 if (function_exists('str_ireplace'))
  74                     $newtext = str_ireplace($from, $to, $text);
  75                 else { // see eof
  76                     $newtext = stri_replace($from, $to, $text);
  77                 }
  78             }
  79             if ($text != $newtext) {
  80                 $meta = $current->_data;
  81                 $meta['summary'] = sprintf(_("WikiAdminSearchReplace %s by %s"),$from,$to);
  82                 return $page->save($newtext, $version + 1, $meta);
  83             }
  84         }
  85         return false;
  86     }
  87
  88     function searchReplacePages(&$dbi, &$request, $pages, $from, $to) {
  89         if (empty($from)) return HTML::p(HTML::strong(fmt("Error: Empty search string.")));
  90         $ul = HTML::ul();
  91         $count = 0;
  92         $post_args = $request->getArg('admin_replace');
  93         $caseexact = !empty($post_args['caseexact']);
  94         foreach ($pages as $pagename) {
  95             if (($result = $this->replaceHelper(&$dbi,$pagename,$from,$to,$caseexact))) {
  96                 $ul->pushContent(HTML::li(fmt("Replaced '%s' with '%s' in page '%s'.", $from, $to, WikiLink($pagename))));
  97                 $count++;
  98             } else {
  99                 $ul->pushContent(HTML::li(fmt("Search string '%s' not found in page '%s'.", $from, $to, WikiLink($pagename))));
 100             }
 101         }
 102         if ($count) {
 103             $dbi->touch();
 104             return HTML($ul,
 105                         HTML::p(fmt("%s pages changed.",$count)));
 106         } else {
 107             return HTML($ul,
 108                         HTML::p(fmt("No pages changed.")));
 109         }
 110     }
 111
 112     function run($dbi, $argstr, &$request, $basepage) {
 113         if ($request->getArg('action') != 'browse')
 114             return $this->disabled("(action != 'browse')");
 115
 116         $args = $this->getArgs($argstr, $request);
 117         $this->_args = $args;
 118         if (!empty($args['exclude']))
 119             $exclude = explodePageList($args['exclude']);
 120         else
 121             $exclude = false;
 122
 123
 124         $p = $request->getArg('p');
 125         $post_args = $request->getArg('admin_replace');
 126         $next_action = 'select';
 127         $pages = array();
 128         if ($p && !$request->isPost())
 129             $pages = $p;
 130         if ($p && $request->isPost() &&
 131             empty($post_args['cancel'])) {
 132
 133             // FIXME: check individual PagePermissions
 134             if (!$request->_user->isAdmin()) {
 135                 $request->_notAuthorized(WIKIAUTH_ADMIN);
 136                 $this->disabled("! user->isAdmin");
 137             }
 138
 139             if ($post_args['action'] == 'verify' and !empty($post_args['from'])) {
 140                 // Real action
 141                 return $this->searchReplacePages($dbi, $request, array_keys($p), $post_args['from'], $post_args['to']);
 142             }
 143             if ($post_args['action'] == 'select') {
 144                 if (!empty($post_args['from']))
 145                     $next_action = 'verify';
 146                 foreach ($p as $name => $c) {
 147                     $pages[$name] = 1;
 148                 }
 149             }
 150         }
 151         if ($next_action == 'select' and empty($pages)) {
 152             // List all pages to select from.
 153             $pages = $this->collectPages($pages, $dbi, $args['sortby'], $args['limit']);
 154         }
 155
 156         if ($next_action == 'verify') {
 157             $args['info'] = "checkbox,pagename,hi_content";
 158         }
 159         $pagelist = new PageList_Selectable($args['info'], $exclude,
 160                                             array('types' => array(
 161                                                   'hi_content' // with highlighted search for SearchReplace
 162                                                    => new _PageList_Column_content('rev:hi_content', _("Content")))));
 163
 164         $pagelist->addPageList($pages);
 165
 166         $header = HTML::p();
 167         if (empty($post_args['from']))
 168             $header->pushContent(
 169               HTML::p(HTML::em(_("Warning: The search string cannot be empty!"))));
 170         if ($next_action == 'verify') {
 171             $button_label = _("Yes");
 172             $header->pushContent(
 173               HTML::p(HTML::strong(
 174                                    _("Are you sure you want to permanently search & replace text in the selected files?"))));
 175             $this->replaceForm(&$header, $post_args);
 176         }
 177         else {
 178             $button_label = _("Search & Replace");
 179             $this->replaceForm(&$header, $post_args);
 180             $header->pushContent(HTML::p(_("Select the pages to search:")));
 181         }
 182
 183
 184         $buttons = HTML::p(Button('submit:admin_replace[rename]', $button_label, 'wikiadmin'),
 185                            Button('submit:admin_replace[cancel]', _("Cancel"), 'button'));
 186
 187         return HTML::form(array('action' => $request->getPostURL(),
 188                                 'method' => 'post'),
 189                           $header,
 190                           $pagelist->getContent(),
 191                           HiddenInputs($request->getArgs(),
 192                                         false,
 193                                         array('admin_replace')),
 194                           HiddenInputs(array('admin_replace[action]' => $next_action,
 195                                              'require_authority_for_post' => WIKIAUTH_ADMIN)),
 196                           $buttons);
 197     }
 198
 199     function replaceForm(&$header, $post_args) {
 200         $header->pushContent(_("Replace: "));
 201         $header->pushContent(HTML::input(array('name' => 'admin_replace[from]',
 202                                                'value' => $post_args['from'])));
 203         $header->pushContent(' '._("by").': ');
 204         $header->pushContent(HTML::input(array('name' => 'admin_replace[to]',
 205                                                'value' => $post_args['to'])));
 206         $header->pushContent(' '._("(no regex) Case-exact: "));
 207         $checkbox = HTML::input(array('type' => 'checkbox',
 208                                       'name' => 'admin_replace[caseexact]',
 209                                       'value' => 1));
 210         if (!empty($post_args['caseexact']))
 211             $checkbox->setAttr('checked','checked');
 212         $header->pushContent($checkbox);
 213         $header->pushContent(HTML::br());
 214         return $header;
 215     }
 216 }
 217
 218 function stri_replace($find,$replace,$string) {
 219     if (!is_array($find)) $find = array($find);
 220     if (!is_array($replace))  {
 221         if (!is_array($find))
 222             $replace = array($replace);
 223         else {
 224             // this will duplicate the string into an array the size of $find
 225             $c = count($find);
 226             $rString = $replace;
 227             unset($replace);
 228             for ($i = 0; $i < $c; $i++) {
 229                 $replace[$i] = $rString;
 230             }
 231         }
 232     }
 233     foreach ($find as $fKey => $fItem) {
 234         $between = explode(strtolower($fItem),strtolower($string));
 235         $pos = 0;
 236         foreach($between as $bKey => $bItem) {
 237             $between[$bKey] = substr($string,$pos,strlen($bItem));
 238             $pos += strlen($bItem) + strlen($fItem);
 239         }
 240         $string = implode($replace[$fKey],$between);
 241     }
 242     return $string;
 243 }
 244
 245 // $Log: not supported by cvs2svn $
 246 // Revision 1.8  2004/03/17 20:23:44  rurban
 247 // fixed p[] pagehash passing from WikiAdminSelect, fixed problem removing pages with [] in the pagename
 248 //
 249 // Revision 1.7  2004/03/12 13:31:43  rurban
 250 // enforce PagePermissions, errormsg if not Admin
 251 //
 252 // Revision 1.6  2004/02/24 15:20:07  rurban
 253 // fixed minor warnings: unchecked args, POST => Get urls for sortby e.g.
 254 //
 255 // Revision 1.5  2004/02/17 12:11:36  rurban
 256 // 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, ...)
 257 //
 258 // Revision 1.4  2004/02/15 21:34:37  rurban
 259 // PageList enhanced and improved.
 260 // fixed new WikiAdmin... plugins
 261 // editpage, Theme with exp. htmlarea framework
 262 //   (htmlarea yet committed, this is really questionable)
 263 // WikiUser... code with better session handling for prefs
 264 // enhanced UserPreferences (again)
 265 // RecentChanges for show_deleted: how should pages be deleted then?
 266 //
 267 // Revision 1.3  2004/02/12 17:05:39  rurban
 268 // WikiAdminRename:
 269 //   added "Change pagename in all linked pages also"
 270 // PageList:
 271 //   added javascript toggle for Select
 272 // WikiAdminSearchReplace:
 273 //   fixed another typo
 274 //
 275 // Revision 1.2  2004/02/12 11:47:51  rurban
 276 // typo
 277 //
 278 // Revision 1.1  2004/02/12 11:25:53  rurban
 279 // new WikiAdminSearchReplace plugin (requires currently Admin)
 280 // removed dead comments from WikiDB
 281 //
 282 //
 283
 284 // Local Variables:
 285 // mode: php
 286 // tab-width: 8
 287 // c-basic-offset: 4
 288 // c-hanging-comment-ender-p: nil
 289 // indent-tabs-mode: nil
 290 // End:
 291 ?>