plugin/rename.inc.php

   1 <?php
   2 // PukiWiki - Yet another WikiWikiWeb clone
   3 // $Id: rename.inc.php,v 1.38 2011/01/25 15:01:01 henoheno Exp $
   4 // Copyright (C) 2002-2005, 2007 PukiWiki Developers Team
   5 // License: GPL v2 or (at your option) any later version
   6 //
   7 // Rename plugin: Rename page-name and related data
   8 //
   9 // Usage: http://path/to/pukiwikiphp?plugin=rename[&refer=page_name]
  10
  11 define('PLUGIN_RENAME_LOGPAGE', ':RenameLog');
  12
  13 function plugin_rename_action()
  14 {
  15         global $whatsnew;
  16
  17         if (PKWK_READONLY) die_message('PKWK_READONLY prohibits this');
  18
  19         $method = plugin_rename_getvar('method');
  20         if ($method == 'regex') {
  21                 $src = plugin_rename_getvar('src');
  22                 if ($src == '') return plugin_rename_phase1();
  23
  24                 $src_pattern = '/' . preg_quote($src, '/') . '/';
  25                 $arr0 = preg_grep($src_pattern, get_existpages());
  26                 if (! is_array($arr0) || empty($arr0))
  27                         return plugin_rename_phase1('nomatch');
  28
  29                 $dst = plugin_rename_getvar('dst');
  30                 $arr1 = preg_replace($src_pattern, $dst, $arr0);
  31                 foreach ($arr1 as $page)
  32                         if (! is_pagename($page))
  33                                 return plugin_rename_phase1('notvalid');
  34
  35                 return plugin_rename_regex($arr0, $arr1);
  36
  37         } else {
  38                 // $method == 'page'
  39                 $page  = plugin_rename_getvar('page');
  40                 $refer = plugin_rename_getvar('refer');
  41
  42                 if ($refer == '') {
  43                         return plugin_rename_phase1();
  44
  45                 } else if (! is_page($refer)) {
  46                         return plugin_rename_phase1('notpage', $refer);
  47
  48                 } else if ($refer === $whatsnew) {
  49                         return plugin_rename_phase1('norename', $refer);
  50
  51                 } else if ($page == '' || $page === $refer) {
  52                         return plugin_rename_phase2();
  53
  54                 } else if (! is_pagename($page)) {
  55                         return plugin_rename_phase2('notvalid');
  56
  57                 } else {
  58                         return plugin_rename_refer();
  59                 }
  60         }
  61 }
  62
  63 // 変数を取得する
  64 function plugin_rename_getvar($key)
  65 {
  66         global $vars;
  67         return isset($vars[$key]) ? $vars[$key] : '';
  68 }
  69
  70 // エラーメッセージを作る
  71 function plugin_rename_err($err, $page = '')
  72 {
  73         global $_rename_messages;
  74
  75         if ($err == '') return '';
  76
  77         $body = $_rename_messages['err_' . $err];
  78         if (is_array($page)) {
  79                 $tmp = '';
  80                 foreach ($page as $_page) $tmp .= '<br />' . $_page;
  81                 $page = $tmp;
  82         }
  83         if ($page != '') $body = sprintf($body, htmlsc($page));
  84
  85         $msg = sprintf($_rename_messages['err'], $body);
  86         return $msg;
  87 }
  88
  89 //第一段階:ページ名または正規表現の入力
  90 function plugin_rename_phase1($err = '', $page = '')
  91 {
  92         global $script, $_rename_messages;
  93
  94         $msg    = plugin_rename_err($err, $page);
  95         $refer  = plugin_rename_getvar('refer');
  96         $method = plugin_rename_getvar('method');
  97
  98         $radio_regex = $radio_page = '';
  99         if ($method == 'regex') {
 100                 $radio_regex = ' checked="checked"';
 101         } else {
 102                 $radio_page  = ' checked="checked"';
 103         }
 104         $select_refer = plugin_rename_getselecttag($refer);
 105
 106         $s_src = htmlsc(plugin_rename_getvar('src'));
 107         $s_dst = htmlsc(plugin_rename_getvar('dst'));
 108
 109         $ret = array();
 110         $ret['msg']  = $_rename_messages['msg_title'];
 111         $ret['body'] = <<<EOD
 112 $msg
 113 <form action="$script" method="post">
 114  <div>
 115   <input type="hidden" name="plugin" value="rename" />
 116   <input type="radio"  name="method" id="_p_rename_page" value="page"$radio_page />
 117   <label for="_p_rename_page">{$_rename_messages['msg_page']}:</label>$select_refer<br />
 118   <input type="radio"  name="method" id="_p_rename_regex" value="regex"$radio_regex />
 119   <label for="_p_rename_regex">{$_rename_messages['msg_regex']}:</label><br />
 120   <label for="_p_rename_from">From:</label><br />
 121   <input type="text" name="src" id="_p_rename_from" size="80" value="$s_src" /><br />
 122   <label for="_p_rename_to">To:</label><br />
 123   <input type="text" name="dst" id="_p_rename_to"   size="80" value="$s_dst" /><br />
 124   <input type="submit" value="{$_rename_messages['btn_next']}" /><br />
 125  </div>
 126 </form>
 127 EOD;
 128         return $ret;
 129 }
 130
 131 //第二段階:新しい名前の入力
 132 function plugin_rename_phase2($err = '')
 133 {
 134         global $script, $_rename_messages;
 135
 136         $msg   = plugin_rename_err($err);
 137         $page  = plugin_rename_getvar('page');
 138         $refer = plugin_rename_getvar('refer');
 139         if ($page == '') $page = $refer;
 140
 141         $msg_related = '';
 142         $related = plugin_rename_getrelated($refer);
 143         if (! empty($related))
 144                 $msg_related = '<label for="_p_rename_related">' . $_rename_messages['msg_do_related'] . '</label>' .
 145                 '<input type="checkbox" name="related" id="_p_rename_related" value="1" checked="checked" /><br />';
 146
 147         $msg_rename = sprintf($_rename_messages['msg_rename'], make_pagelink($refer));
 148         $s_page  = htmlsc($page);
 149         $s_refer = htmlsc($refer);
 150
 151         $ret = array();
 152         $ret['msg']  = $_rename_messages['msg_title'];
 153         $ret['body'] = <<<EOD
 154 $msg
 155 <form action="$script" method="post">
 156  <div>
 157   <input type="hidden" name="plugin" value="rename" />
 158   <input type="hidden" name="refer"  value="$s_refer" />
 159   $msg_rename<br />
 160   <label for="_p_rename_newname">{$_rename_messages['msg_newname']}:</label>
 161   <input type="text" name="page" id="_p_rename_newname" size="80" value="$s_page" /><br />
 162   $msg_related
 163   <input type="submit" value="{$_rename_messages['btn_next']}" /><br />
 164  </div>
 165 </form>
 166 EOD;
 167         if (! empty($related)) {
 168                 $ret['body'] .= '<hr /><p>' . $_rename_messages['msg_related'] . '</p><ul>';
 169                 sort($related, SORT_STRING);
 170                 foreach ($related as $name)
 171                         $ret['body'] .= '<li>' . make_pagelink($name) . '</li>';
 172                 $ret['body'] .= '</ul>';
 173         }
 174         return $ret;
 175 }
 176
 177 //ページ名と関連するページを列挙し、phase3へ
 178 function plugin_rename_refer()
 179 {
 180         $page  = plugin_rename_getvar('page');
 181         $refer = plugin_rename_getvar('refer');
 182
 183         $pages[encode($refer)] = encode($page);
 184         if (plugin_rename_getvar('related') != '') {
 185                 $from = strip_bracket($refer);
 186                 $to   = strip_bracket($page);
 187                 foreach (plugin_rename_getrelated($refer) as $_page)
 188                         $pages[encode($_page)] = encode(str_replace($from, $to, $_page));
 189         }
 190         return plugin_rename_phase3($pages);
 191 }
 192
 193 //正規表現でページを置換
 194 function plugin_rename_regex($arr_from, $arr_to)
 195 {
 196         $exists = array();
 197         foreach ($arr_to as $page)
 198                 if (is_page($page))
 199                         $exists[] = $page;
 200
 201         if (! empty($exists)) {
 202                 return plugin_rename_phase1('already', $exists);
 203         } else {
 204                 $pages = array();
 205                 foreach ($arr_from as $refer)
 206                         $pages[encode($refer)] = encode(array_shift($arr_to));
 207                 return plugin_rename_phase3($pages);
 208         }
 209 }
 210
 211 function plugin_rename_phase3($pages)
 212 {
 213         global $script, $_rename_messages;
 214
 215         $msg = $input = '';
 216         $files = plugin_rename_get_files($pages);
 217
 218         $exists = array();
 219         foreach ($files as $_page=>$arr)
 220                 foreach ($arr as $old=>$new)
 221                         if (file_exists($new))
 222                                 $exists[$_page][$old] = $new;
 223
 224         $pass = plugin_rename_getvar('pass');
 225         if ($pass != '' && pkwk_login($pass)) {
 226                 return plugin_rename_proceed($pages, $files, $exists);
 227         } else if ($pass != '') {
 228                 $msg = plugin_rename_err('adminpass');
 229         }
 230
 231         $method = plugin_rename_getvar('method');
 232         if ($method == 'regex') {
 233                 $s_src = htmlsc(plugin_rename_getvar('src'));
 234                 $s_dst = htmlsc(plugin_rename_getvar('dst'));
 235                 $msg   .= $_rename_messages['msg_regex'] . '<br />';
 236                 $input .= '<input type="hidden" name="method" value="regex" />';
 237                 $input .= '<input type="hidden" name="src"    value="' . $s_src . '" />';
 238                 $input .= '<input type="hidden" name="dst"    value="' . $s_dst . '" />';
 239         } else {
 240                 $s_refer   = htmlsc(plugin_rename_getvar('refer'));
 241                 $s_page    = htmlsc(plugin_rename_getvar('page'));
 242                 $s_related = htmlsc(plugin_rename_getvar('related'));
 243                 $msg   .= $_rename_messages['msg_page'] . '<br />';
 244                 $input .= '<input type="hidden" name="method"  value="page" />';
 245                 $input .= '<input type="hidden" name="refer"   value="' . $s_refer   . '" />';
 246                 $input .= '<input type="hidden" name="page"    value="' . $s_page    . '" />';
 247                 $input .= '<input type="hidden" name="related" value="' . $s_related . '" />';
 248         }
 249
 250         if (! empty($exists)) {
 251                 $msg .= $_rename_messages['err_already_below'] . '<ul>';
 252                 foreach ($exists as $page=>$arr) {
 253                         $msg .= '<li>' . make_pagelink(decode($page));
 254                         $msg .= $_rename_messages['msg_arrow'];
 255                         $msg .= htmlsc(decode($pages[$page]));
 256                         if (! empty($arr)) {
 257                                 $msg .= '<ul>' . "\n";
 258                                 foreach ($arr as $ofile=>$nfile)
 259                                         $msg .= '<li>' . $ofile .
 260                                         $_rename_messages['msg_arrow'] . $nfile . '</li>' . "\n";
 261                                 $msg .= '</ul>';
 262                         }
 263                         $msg .= '</li>' . "\n";
 264                 }
 265                 $msg .= '</ul><hr />' . "\n";
 266
 267                 $input .= '<input type="radio" name="exist" value="0" checked="checked" />' .
 268                         $_rename_messages['msg_exist_none'] . '<br />';
 269                 $input .= '<input type="radio" name="exist" value="1" />' .
 270                         $_rename_messages['msg_exist_overwrite'] . '<br />';
 271         }
 272
 273         $ret = array();
 274         $ret['msg'] = $_rename_messages['msg_title'];
 275         $ret['body'] = <<<EOD
 276 <p>$msg</p>
 277 <form action="$script" method="post">
 278  <div>
 279   <input type="hidden" name="plugin" value="rename" />
 280   $input
 281   <label for="_p_rename_adminpass">{$_rename_messages['msg_adminpass']}</label>
 282   <input type="password" name="pass" id="_p_rename_adminpass" value="" />
 283   <input type="submit" value="{$_rename_messages['btn_submit']}" />
 284  </div>
 285 </form>
 286 <p>{$_rename_messages['msg_confirm']}</p>
 287 EOD;
 288
 289         ksort($pages, SORT_STRING);
 290         $ret['body'] .= '<ul>' . "\n";
 291         foreach ($pages as $old=>$new)
 292                 $ret['body'] .= '<li>' .  make_pagelink(decode($old)) .
 293                         $_rename_messages['msg_arrow'] .
 294                         htmlsc(decode($new)) .  '</li>' . "\n";
 295         $ret['body'] .= '</ul>' . "\n";
 296         return $ret;
 297 }
 298
 299 function plugin_rename_get_files($pages)
 300 {
 301         $files = array();
 302         $dirs  = array(BACKUP_DIR, DIFF_DIR, DATA_DIR);
 303         if (exist_plugin_convert('attach'))  $dirs[] = UPLOAD_DIR;
 304         if (exist_plugin_convert('counter')) $dirs[] = COUNTER_DIR;
 305         // and more ...
 306
 307         $matches = array();
 308         foreach ($dirs as $path) {
 309                 $dir = opendir($path);
 310                 if (! $dir) continue;   // TODO: !== FALSE or die()?
 311                 while (($file = readdir($dir)) !== FALSE) {
 312                         if ($file == '.' || $file == '..') continue;
 313                         foreach ($pages as $from => $to) {
 314                                 // TODO: preg_quote()?
 315                                 $pattern = '/^' . str_replace('/', '\/', $from) . '([._].+)$/';
 316                                 if (preg_match($pattern, $file, $matches)) {
 317                                         $newfile = $to . $matches[1];
 318                                         $files[$from][$path . $file] = $path . $newfile;
 319                                 }
 320                         }
 321                 }
 322         }
 323
 324         return $files;
 325 }
 326
 327 function plugin_rename_proceed($pages, $files, $exists)
 328 {
 329         global $now, $_rename_messages;
 330
 331         if (plugin_rename_getvar('exist') == '')
 332                 foreach ($exists as $key=>$arr)
 333                         unset($files[$key]);
 334
 335         set_time_limit(0);
 336         foreach ($files as $page=>$arr) {
 337                 foreach ($arr as $old=>$new) {
 338                         if (isset($exists[$page][$old]) && $exists[$page][$old])
 339                                 unlink($new);
 340                         rename($old, $new);
 341
 342                         // linkデータベースを更新する BugTrack/327 arino
 343                         links_update($old);
 344                         links_update($new);
 345                 }
 346         }
 347
 348         $postdata = get_source(PLUGIN_RENAME_LOGPAGE);
 349         $postdata[] = '*' . $now . "\n";
 350         if (plugin_rename_getvar('method') == 'regex') {
 351                 $postdata[] = '-' . $_rename_messages['msg_regex'] . "\n";
 352                 $postdata[] = '--From:[[' . plugin_rename_getvar('src') . ']]' . "\n";
 353                 $postdata[] = '--To:[['   . plugin_rename_getvar('dst') . ']]' . "\n";
 354         } else {
 355                 $postdata[] = '-' . $_rename_messages['msg_page'] . "\n";
 356                 $postdata[] = '--From:[[' . plugin_rename_getvar('refer') . ']]' . "\n";
 357                 $postdata[] = '--To:[['   . plugin_rename_getvar('page')  . ']]' . "\n";
 358         }
 359
 360         if (! empty($exists)) {
 361                 $postdata[] = "\n" . $_rename_messages['msg_result'] . "\n";
 362                 foreach ($exists as $page=>$arr) {
 363                         $postdata[] = '-' . decode($page) .
 364                                 $_rename_messages['msg_arrow'] . decode($pages[$page]) . "\n";
 365                         foreach ($arr as $ofile=>$nfile)
 366                                 $postdata[] = '--' . $ofile .
 367                                         $_rename_messages['msg_arrow'] . $nfile . "\n";
 368                 }
 369                 $postdata[] = '----' . "\n";
 370         }
 371
 372         foreach ($pages as $old=>$new)
 373                 $postdata[] = '-' . decode($old) .
 374                         $_rename_messages['msg_arrow'] . decode($new) . "\n";
 375
 376         // 更新の衝突はチェックしない。
 377
 378         // ファイルの書き込み
 379         page_write(PLUGIN_RENAME_LOGPAGE, join('', $postdata));
 380
 381         //リダイレクト
 382         $page = plugin_rename_getvar('page');
 383         if ($page == '') $page = PLUGIN_RENAME_LOGPAGE;
 384
 385         pkwk_headers_sent();
 386         header('Location: ' . get_script_uri() . '?' . rawurlencode($page));
 387         exit;
 388 }
 389
 390 function plugin_rename_getrelated($page)
 391 {
 392         $related = array();
 393         $pages = get_existpages();
 394         $pattern = '/(?:^|\/)' . preg_quote(strip_bracket($page), '/') . '(?:\/|$)/';
 395         foreach ($pages as $name) {
 396                 if ($name === $page) continue;
 397                 if (preg_match($pattern, $name)) $related[] = $name;
 398         }
 399         return $related;
 400 }
 401
 402 function plugin_rename_getselecttag($page)
 403 {
 404         global $whatsnew;
 405
 406         $pages = array();
 407         foreach (get_existpages() as $_page) {
 408                 if ($_page === $whatsnew) continue;
 409
 410                 $selected = ($_page === $page) ? ' selected' : '';
 411                 $s_page = htmlsc($_page);
 412                 $pages[$_page] = '<option value="' . $s_page . '"' . $selected . '>' .
 413                         $s_page . '</option>';
 414         }
 415         ksort($pages, SORT_STRING);
 416         $list = join("\n" . ' ', $pages);
 417
 418         return <<<EOD
 419 <select name="refer">
 420  <option value=""></option>
 421  $list
 422 </select>
 423 EOD;
 424
 425 }
 426 ?>