lib/file.php

   1 <?php
   2 // PukiWiki - Yet another WikiWikiWeb clone.
   3 // file.php
   4 // Copyright (C)
   5 //   2002-2016 PukiWiki Development Team
   6 //   2001-2002 Originally written by yu-ji
   7 // License: GPL v2 or (at your option) any later version
   8 //
   9 // File related functions
  10
  11 // RecentChanges
  12 define('PKWK_MAXSHOW_ALLOWANCE', 10);
  13 define('PKWK_MAXSHOW_CACHE', 'recent.dat');
  14
  15 // AutoLink
  16 define('PKWK_AUTOLINK_REGEX_CACHE', 'autolink.dat');
  17
  18 // Get source(wiki text) data of the page
  19 // Returns FALSE if error occurerd
  20 function get_source($page = NULL, $lock = TRUE, $join = FALSE)
  21 {
  22         //$result = NULL;       // File is not found
  23         $result = $join ? '' : array();
  24                 // Compat for "implode('', get_source($file))",
  25                 //      -- this is slower than "get_source($file, TRUE, TRUE)"
  26                 // Compat for foreach(get_source($file) as $line) {} not to warns
  27
  28         $path = get_filename($page);
  29         if (file_exists($path)) {
  30
  31                 if ($lock) {
  32                         $fp = @fopen($path, 'r');
  33                         if ($fp === FALSE) return FALSE;
  34                         flock($fp, LOCK_SH);
  35                 }
  36
  37                 if ($join) {
  38                         // Returns a value
  39                         $size = filesize($path);
  40                         if ($size === FALSE) {
  41                                 $result = FALSE;
  42                         } else if ($size == 0) {
  43                                 $result = '';
  44                         } else {
  45                                 $result = fread($fp, $size);
  46                                 if ($result !== FALSE) {
  47                                         // Removing Carriage-Return
  48                                         $result = str_replace("\r", '', $result);
  49                                 }
  50                         }
  51                 } else {
  52                         // Returns an array
  53                         $result = file($path);
  54                         if ($result !== FALSE) {
  55                                 // Removing Carriage-Return
  56                                 $result = str_replace("\r", '', $result);
  57                         }
  58                 }
  59
  60                 if ($lock) {
  61                         flock($fp, LOCK_UN);
  62                         @fclose($fp);
  63                 }
  64         }
  65
  66         return $result;
  67 }
  68
  69 // Get last-modified filetime of the page
  70 function get_filetime($page)
  71 {
  72         return is_page($page) ? filemtime(get_filename($page)) - LOCALZONE : 0;
  73 }
  74
  75 // Get physical file name of the page
  76 function get_filename($page)
  77 {
  78         return DATA_DIR . encode($page) . '.txt';
  79 }
  80
  81 // Put a data(wiki text) into a physical file(diff, backup, text)
  82 function page_write($page, $postdata, $notimestamp = FALSE)
  83 {
  84         if (PKWK_READONLY) return; // Do nothing
  85
  86         $postdata = make_str_rules($postdata);
  87         $timestamp_to_keep = null;
  88         if ($notimestamp) {
  89                 $timestamp_to_keep = get_filetime($page);
  90         }
  91         $text_without_author = remove_author_info($postdata);
  92         $postdata = add_author_info($text_without_author, $timestamp_to_keep);
  93         $is_delete = empty($text_without_author);
  94
  95         // Do nothing when it has no changes
  96         $oldpostdata = is_page($page) ? join('', get_source($page)) : '';
  97         $oldtext_without_author = remove_author_info($oldpostdata);
  98         if ($text_without_author === $oldtext_without_author) {
  99                 // Do nothing on updating with unchanged content
 100                 return;
 101         }
 102         // Create and write diff
 103         $diffdata    = do_diff($oldpostdata, $postdata);
 104         file_write(DIFF_DIR, $page, $diffdata);
 105
 106         // Create backup
 107         make_backup($page, $is_delete, $postdata); // Is $postdata null?
 108
 109         // Create wiki text
 110         file_write(DATA_DIR, $page, $postdata, $notimestamp, $is_delete);
 111
 112         links_update($page);
 113 }
 114
 115 // Modify original text with user-defined / system-defined rules
 116 function make_str_rules($source)
 117 {
 118         global $str_rules, $fixed_heading_anchor;
 119
 120         $lines = explode("\n", $source);
 121         $count = count($lines);
 122
 123         $modify    = TRUE;
 124         $multiline = 0;
 125         $matches   = array();
 126         for ($i = 0; $i < $count; $i++) {
 127                 $line = & $lines[$i]; // Modify directly
 128
 129                 // Ignore null string and preformatted texts
 130                 if ($line == '' || $line{0} == ' ' || $line{0} == "\t") continue;
 131
 132                 // Modify this line?
 133                 if ($modify) {
 134                         if (! PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK &&
 135                             $multiline == 0 &&
 136                             preg_match('/#[^{]*(\{\{+)\s*$/', $line, $matches)) {
 137                                 // Multiline convert plugin start
 138                                 $modify    = FALSE;
 139                                 $multiline = strlen($matches[1]); // Set specific number
 140                         }
 141                 } else {
 142                         if (! PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK &&
 143                             $multiline != 0 &&
 144                             preg_match('/^\}{' . $multiline . '}\s*$/', $line)) {
 145                                 // Multiline convert plugin end
 146                                 $modify    = TRUE;
 147                                 $multiline = 0;
 148                         }
 149                 }
 150                 if ($modify === FALSE) continue;
 151
 152                 // Replace with $str_rules
 153                 foreach ($str_rules as $pattern => $replacement)
 154                         $line = preg_replace('/' . $pattern . '/', $replacement, $line);
 155
 156                 // Adding fixed anchor into headings
 157                 if ($fixed_heading_anchor &&
 158                     preg_match('/^(\*{1,3}.*?)(?:\[#([A-Za-z][\w-]*)\]\s*)?$/', $line, $matches) &&
 159                     (! isset($matches[2]) || $matches[2] == '')) {
 160                         // Generate unique id
 161                         $anchor = generate_fixed_heading_anchor_id($matches[1]);
 162                         $line = rtrim($matches[1]) . ' [#' . $anchor . ']';
 163                 }
 164         }
 165
 166         // Multiline part has no stopper
 167         if (! PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK &&
 168             $modify === FALSE && $multiline != 0)
 169                 $lines[] = str_repeat('}', $multiline);
 170
 171         return implode("\n", $lines);
 172 }
 173
 174 /**
 175  * Add author plugin text for wiki text body
 176  *
 177  * @param string $wikitext
 178  * @param integer $timestamp_to_keep Set null when not to keep timestamp
 179  */
 180 function add_author_info($wikitext, $timestamp_to_keep)
 181 {
 182         global $auth_user, $auth_user_fullname;
 183         $author = preg_replace('/"/', '', $auth_user);
 184         $fullname = $auth_user_fullname;
 185         if (!$fullname && $author) {
 186                 // Fullname is empty, use $author as its fullname
 187                 $fullname = preg_replace('/^[^:]*:/', '', $author);
 188         }
 189         $datetime_to_keep = '';
 190         if (!is_null($timestamp_to_keep)) {
 191                 $datetime_to_keep .= ';' . get_date_atom($timestamp_to_keep + LOCALZONE);
 192         }
 193         $displayname = preg_replace('/"/', '', $fullname);
 194         $user_prefix = get_auth_user_prefix();
 195         $author_text = sprintf('#author("%s","%s","%s")',
 196                 get_date_atom(UTIME + LOCALZONE) . $datetime_to_keep,
 197                 ($author ? $user_prefix . $author : ''),
 198                 $displayname) . "\n";
 199         return $author_text . $wikitext;
 200 }
 201
 202 function remove_author_info($wikitext)
 203 {
 204         return preg_replace('/^\s*#author\([^\n]*(\n|$)/m', '', $wikitext);
 205 }
 206
 207 function get_date_atom($timestamp)
 208 {
 209         // Compatible with DATE_ATOM format
 210         // return date(DATE_ATOM, $timestamp);
 211         $zmin = abs(LOCALZONE / 60);
 212         return date('Y-m-d\TH:i:s', $timestamp) . sprintf('%s%02d:%02d',
 213                 (LOCALZONE < 0 ? '-' : '+') , $zmin / 60, $zmin % 60);
 214 }
 215
 216 // Generate ID
 217 function generate_fixed_heading_anchor_id($seed)
 218 {
 219         // A random alphabetic letter + 7 letters of random strings from md()
 220         return chr(mt_rand(ord('a'), ord('z'))) .
 221                 substr(md5(uniqid(substr($seed, 0, 100), TRUE)),
 222                 mt_rand(0, 24), 7);
 223 }
 224
 225 // Read top N lines as an array
 226 // (Use PHP file() function if you want to get ALL lines)
 227 function file_head($file, $count = 1, $lock = TRUE, $buffer = 8192)
 228 {
 229         $array = array();
 230
 231         $fp = @fopen($file, 'r');
 232         if ($fp === FALSE) return FALSE;
 233         set_file_buffer($fp, 0);
 234         if ($lock) flock($fp, LOCK_SH);
 235         rewind($fp);
 236         $index = 0;
 237         while (! feof($fp)) {
 238                 $line = fgets($fp, $buffer);
 239                 if ($line != FALSE) $array[] = $line;
 240                 if (++$index >= $count) break;
 241         }
 242         if ($lock) flock($fp, LOCK_UN);
 243         if (! fclose($fp)) return FALSE;
 244
 245         return $array;
 246 }
 247
 248 // Output to a file
 249 function file_write($dir, $page, $str, $notimestamp = FALSE, $is_delete = FALSE)
 250 {
 251         global $_msg_invalidiwn, $notify, $notify_diff_only, $notify_subject;
 252         global $whatsdeleted, $maxshow_deleted;
 253
 254         if (PKWK_READONLY) return; // Do nothing
 255         if ($dir != DATA_DIR && $dir != DIFF_DIR) die('file_write(): Invalid directory');
 256
 257         $page = strip_bracket($page);
 258         $file = $dir . encode($page) . '.txt';
 259         $file_exists = file_exists($file);
 260
 261         // ----
 262         // Delete?
 263
 264         if ($dir == DATA_DIR && $is_delete) {
 265                 // Page deletion
 266                 if (! $file_exists) return; // Ignore null posting for DATA_DIR
 267
 268                 // Update RecentDeleted (Add the $page)
 269                 add_recent($page, $whatsdeleted, '', $maxshow_deleted);
 270
 271                 // Remove the page
 272                 unlink($file);
 273
 274                 // Update RecentDeleted, and remove the page from RecentChanges
 275                 lastmodified_add($whatsdeleted, $page);
 276
 277                 // Clear is_page() cache
 278                 is_page($page, TRUE);
 279
 280                 return;
 281
 282         } else if ($dir == DIFF_DIR && $str === " \n") {
 283                 return; // Ignore null posting for DIFF_DIR
 284         }
 285
 286         // ----
 287         // File replacement (Edit)
 288
 289         if (! is_pagename($page))
 290                 die_message(str_replace('$1', htmlsc($page),
 291                             str_replace('$2', 'WikiName', $_msg_invalidiwn)));
 292
 293         $str = rtrim(preg_replace('/' . "\r" . '/', '', $str)) . "\n";
 294         $timestamp = ($file_exists && $notimestamp) ? filemtime($file) : FALSE;
 295
 296         $fp = fopen($file, 'a') or die('fopen() failed: ' .
 297                 htmlsc(basename($dir) . '/' . encode($page) . '.txt') .
 298                 '<br />' . "\n" .
 299                 'Maybe permission is not writable or filename is too long');
 300         set_file_buffer($fp, 0);
 301         flock($fp, LOCK_EX);
 302         ftruncate($fp, 0);
 303         rewind($fp);
 304         fputs($fp, $str);
 305         flock($fp, LOCK_UN);
 306         fclose($fp);
 307
 308         if ($timestamp) pkwk_touch_file($file, $timestamp);
 309
 310         // Optional actions
 311         if ($dir == DATA_DIR) {
 312                 // Update RecentChanges (Add or renew the $page)
 313                 if ($timestamp === FALSE) lastmodified_add($page);
 314
 315                 // Command execution per update
 316                 if (defined('PKWK_UPDATE_EXEC') && PKWK_UPDATE_EXEC)
 317                         system(PKWK_UPDATE_EXEC . ' > /dev/null &');
 318
 319         } else if ($dir == DIFF_DIR && $notify) {
 320                 if ($notify_diff_only) $str = preg_replace('/^[^-+].*\n/m', '', $str);
 321                 $footer['ACTION'] = 'Page update';
 322                 $footer['PAGE']   = & $page;
 323                 $footer['URI']    = get_script_uri() . '?' . pagename_urlencode($page);
 324                 $footer['USER_AGENT']  = TRUE;
 325                 $footer['REMOTE_ADDR'] = TRUE;
 326                 pkwk_mail_notify($notify_subject, $str, $footer) or
 327                         die('pkwk_mail_notify(): Failed');
 328         }
 329
 330         is_page($page, TRUE); // Clear is_page() cache
 331 }
 332
 333 // Update RecentDeleted
 334 function add_recent($page, $recentpage, $subject = '', $limit = 0)
 335 {
 336         if (PKWK_READONLY || $limit == 0 || $page == '' || $recentpage == '' ||
 337             check_non_list($page)) return;
 338
 339         // Load
 340         $lines = $matches = array();
 341         foreach (get_source($recentpage) as $line)
 342                 if (preg_match('/^-(.+) - (\[\[.+\]\])$/', $line, $matches))
 343                         $lines[$matches[2]] = $line;
 344
 345         $_page = '[[' . $page . ']]';
 346
 347         // Remove a report about the same page
 348         if (isset($lines[$_page])) unset($lines[$_page]);
 349
 350         // Add
 351         array_unshift($lines, '-' . format_date(UTIME) . ' - ' . $_page .
 352                 htmlsc($subject) . "\n");
 353
 354         // Get latest $limit reports
 355         $lines = array_splice($lines, 0, $limit);
 356
 357         // Update
 358         $fp = fopen(get_filename($recentpage), 'w') or
 359                 die_message('Cannot write page file ' .
 360                 htmlsc($recentpage) .
 361                 '<br />Maybe permission is not writable or filename is too long');
 362         set_file_buffer($fp, 0);
 363         flock($fp, LOCK_EX);
 364         rewind($fp);
 365         fputs($fp, '#freeze'    . "\n");
 366         fputs($fp, '#norelated' . "\n"); // :)
 367         fputs($fp, join('', $lines));
 368         flock($fp, LOCK_UN);
 369         fclose($fp);
 370 }
 371
 372 // Update PKWK_MAXSHOW_CACHE itself (Add or renew about the $page) (Light)
 373 // Use without $autolink
 374 function lastmodified_add($update = '', $remove = '')
 375 {
 376         global $maxshow, $whatsnew, $autolink;
 377
 378         // AutoLink implimentation needs everything, for now
 379         if ($autolink) {
 380                 put_lastmodified(); // Try to (re)create ALL
 381                 return;
 382         }
 383
 384         if (($update == '' || check_non_list($update)) && $remove == '')
 385                 return; // No need
 386
 387         $file = CACHE_DIR . PKWK_MAXSHOW_CACHE;
 388         if (! file_exists($file)) {
 389                 put_lastmodified(); // Try to (re)create ALL
 390                 return;
 391         }
 392
 393         // Open
 394         pkwk_touch_file($file);
 395         $fp = fopen($file, 'r+') or
 396                 die_message('Cannot open ' . 'CACHE_DIR/' . PKWK_MAXSHOW_CACHE);
 397         set_file_buffer($fp, 0);
 398         flock($fp, LOCK_EX);
 399
 400         // Read (keep the order of the lines)
 401         $recent_pages = $matches = array();
 402         foreach(file_head($file, $maxshow + PKWK_MAXSHOW_ALLOWANCE, FALSE) as $line)
 403                 if (preg_match('/^([0-9]+)\t(.+)/', $line, $matches))
 404                         $recent_pages[$matches[2]] = $matches[1];
 405
 406         // Remove if it exists inside
 407         if (isset($recent_pages[$update])) unset($recent_pages[$update]);
 408         if (isset($recent_pages[$remove])) unset($recent_pages[$remove]);
 409
 410         // Add to the top: like array_unshift()
 411         if ($update != '')
 412                 $recent_pages = array($update => get_filetime($update)) + $recent_pages;
 413
 414         // Check
 415         $abort = count($recent_pages) < $maxshow;
 416
 417         if (! $abort) {
 418                 // Write
 419                 ftruncate($fp, 0);
 420                 rewind($fp);
 421                 foreach ($recent_pages as $_page=>$time)
 422                         fputs($fp, $time . "\t" . $_page . "\n");
 423         }
 424
 425         flock($fp, LOCK_UN);
 426         fclose($fp);
 427
 428         if ($abort) {
 429                 put_lastmodified(); // Try to (re)create ALL
 430                 return;
 431         }
 432
 433
 434
 435         // ----
 436         // Update the page 'RecentChanges'
 437
 438         $recent_pages = array_splice($recent_pages, 0, $maxshow);
 439         $file = get_filename($whatsnew);
 440
 441         // Open
 442         pkwk_touch_file($file);
 443         $fp = fopen($file, 'r+') or
 444                 die_message('Cannot open ' . htmlsc($whatsnew));
 445         set_file_buffer($fp, 0);
 446         flock($fp, LOCK_EX);
 447
 448         // Recreate
 449         ftruncate($fp, 0);
 450         rewind($fp);
 451         foreach ($recent_pages as $_page=>$time)
 452                 fputs($fp, '-' . htmlsc(format_date($time)) .
 453                         ' - ' . '[[' . htmlsc($_page) . ']]' . "\n");
 454         fputs($fp, '#norelated' . "\n"); // :)
 455
 456         flock($fp, LOCK_UN);
 457         fclose($fp);
 458 }
 459
 460 // Re-create PKWK_MAXSHOW_CACHE (Heavy)
 461 function put_lastmodified()
 462 {
 463         global $maxshow, $whatsnew, $autolink;
 464
 465         if (PKWK_READONLY) return; // Do nothing
 466
 467         // Get WHOLE page list
 468         $pages = get_existpages();
 469
 470         // Check ALL filetime
 471         $recent_pages = array();
 472         foreach($pages as $page)
 473                 if ($page !== $whatsnew && ! check_non_list($page))
 474                         $recent_pages[$page] = get_filetime($page);
 475
 476         // Sort decending order of last-modification date
 477         arsort($recent_pages, SORT_NUMERIC);
 478
 479         // Cut unused lines
 480         // BugTrack2/179: array_splice() will break integer keys in hashtable
 481         $count   = $maxshow + PKWK_MAXSHOW_ALLOWANCE;
 482         $_recent = array();
 483         foreach($recent_pages as $key=>$value) {
 484                 unset($recent_pages[$key]);
 485                 $_recent[$key] = $value;
 486                 if (--$count < 1) break;
 487         }
 488         $recent_pages = & $_recent;
 489
 490         // Re-create PKWK_MAXSHOW_CACHE
 491         $file = CACHE_DIR . PKWK_MAXSHOW_CACHE;
 492         pkwk_touch_file($file);
 493         $fp = fopen($file, 'r+') or
 494                 die_message('Cannot open' . 'CACHE_DIR/' . PKWK_MAXSHOW_CACHE);
 495         set_file_buffer($fp, 0);
 496         flock($fp, LOCK_EX);
 497         ftruncate($fp, 0);
 498         rewind($fp);
 499         foreach ($recent_pages as $page=>$time)
 500                 fputs($fp, $time . "\t" . $page . "\n");
 501         flock($fp, LOCK_UN);
 502         fclose($fp);
 503
 504         // Create RecentChanges
 505         $file = get_filename($whatsnew);
 506         pkwk_touch_file($file);
 507         $fp = fopen($file, 'r+') or
 508                 die_message('Cannot open ' . htmlsc($whatsnew));
 509         set_file_buffer($fp, 0);
 510         flock($fp, LOCK_EX);
 511         ftruncate($fp, 0);
 512         rewind($fp);
 513         foreach (array_keys($recent_pages) as $page) {
 514                 $time      = $recent_pages[$page];
 515                 $s_lastmod = htmlsc(format_date($time));
 516                 $s_page    = htmlsc($page);
 517                 fputs($fp, '-' . $s_lastmod . ' - [[' . $s_page . ']]' . "\n");
 518         }
 519         fputs($fp, '#norelated' . "\n"); // :)
 520         flock($fp, LOCK_UN);
 521         fclose($fp);
 522
 523         // For AutoLink
 524         if ($autolink) {
 525                 list($pattern, $pattern_a, $forceignorelist) =
 526                         get_autolink_pattern($pages);
 527
 528                 $file = CACHE_DIR . PKWK_AUTOLINK_REGEX_CACHE;
 529                 pkwk_touch_file($file);
 530                 $fp = fopen($file, 'r+') or
 531                         die_message('Cannot open ' . 'CACHE_DIR/' . PKWK_AUTOLINK_REGEX_CACHE);
 532                 set_file_buffer($fp, 0);
 533                 flock($fp, LOCK_EX);
 534                 ftruncate($fp, 0);
 535                 rewind($fp);
 536                 fputs($fp, $pattern   . "\n");
 537                 fputs($fp, $pattern_a . "\n");
 538                 fputs($fp, join("\t", $forceignorelist) . "\n");
 539                 flock($fp, LOCK_UN);
 540                 fclose($fp);
 541         }
 542 }
 543
 544 // Get elapsed date of the page
 545 function get_pg_passage($page, $sw = TRUE)
 546 {
 547         global $show_passage;
 548         if (! $show_passage) return '';
 549
 550         $time = get_filetime($page);
 551         $pg_passage = ($time != 0) ? get_passage($time) : '';
 552
 553         return $sw ? '<small>' . $pg_passage . '</small>' : ' ' . $pg_passage;
 554 }
 555
 556 // Last-Modified header
 557 function header_lastmod($page = NULL)
 558 {
 559         global $lastmod;
 560
 561         if ($lastmod && is_page($page)) {
 562                 pkwk_headers_sent();
 563                 header('Last-Modified: ' .
 564                         date('D, d M Y H:i:s', get_filetime($page)) . ' GMT');
 565         }
 566 }
 567
 568 // Get a list of encoded files (must specify a directory and a suffix)
 569 function get_existfiles($dir = DATA_DIR, $ext = '.txt')
 570 {
 571         $aryret = array();
 572         $pattern = '/^(?:[0-9A-F]{2})+' . preg_quote($ext, '/') . '$/';
 573
 574         $dp = @opendir($dir) or die_message($dir . ' is not found or not readable.');
 575         while (($file = readdir($dp)) !== FALSE) {
 576                 if (preg_match($pattern, $file)) {
 577                         $aryret[] = $dir . $file;
 578                 }
 579         }
 580         closedir($dp);
 581
 582         return $aryret;
 583 }
 584
 585 // Get a page list of this wiki
 586 function get_existpages($dir = DATA_DIR, $ext = '.txt')
 587 {
 588         $aryret = array();
 589         $pattern = '/^((?:[0-9A-F]{2})+)' . preg_quote($ext, '/') . '$/';
 590
 591         $dp = @opendir($dir) or die_message($dir . ' is not found or not readable.');
 592         $matches = array();
 593         while (($file = readdir($dp)) !== FALSE) {
 594                 if (preg_match($pattern, $file, $matches)) {
 595                         $aryret[$file] = decode($matches[1]);
 596                 }
 597         }
 598         closedir($dp);
 599
 600         return $aryret;
 601 }
 602
 603 // Get PageReading(pronounce-annotated) data in an array()
 604 function get_readings()
 605 {
 606         global $pagereading_enable, $pagereading_kanji2kana_converter;
 607         global $pagereading_kanji2kana_encoding, $pagereading_chasen_path;
 608         global $pagereading_kakasi_path, $pagereading_config_page;
 609         global $pagereading_config_dict;
 610
 611         $pages = get_existpages();
 612
 613         $readings = array();
 614         foreach ($pages as $page)
 615                 $readings[$page] = '';
 616
 617         $deletedPage = FALSE;
 618         $matches = array();
 619         foreach (get_source($pagereading_config_page) as $line) {
 620                 $line = chop($line);
 621                 if(preg_match('/^-\[\[([^]]+)\]\]\s+(.+)$/', $line, $matches)) {
 622                         if(isset($readings[$matches[1]])) {
 623                                 // This page is not clear how to be pronounced
 624                                 $readings[$matches[1]] = $matches[2];
 625                         } else {
 626                                 // This page seems deleted
 627                                 $deletedPage = TRUE;
 628                         }
 629                 }
 630         }
 631
 632         // If enabled ChaSen/KAKASI execution
 633         if($pagereading_enable) {
 634
 635                 // Check there's non-clear-pronouncing page
 636                 $unknownPage = FALSE;
 637                 foreach ($readings as $page => $reading) {
 638                         if($reading == '') {
 639                                 $unknownPage = TRUE;
 640                                 break;
 641                         }
 642                 }
 643
 644                 // Execute ChaSen/KAKASI, and get annotation
 645                 if($unknownPage) {
 646                         switch(strtolower($pagereading_kanji2kana_converter)) {
 647                         case 'chasen':
 648                                 if(! file_exists($pagereading_chasen_path))
 649                                         die_message('ChaSen not found: ' . $pagereading_chasen_path);
 650
 651                                 $tmpfname = tempnam(realpath(CACHE_DIR), 'PageReading');
 652                                 $fp = fopen($tmpfname, 'w') or
 653                                         die_message('Cannot write temporary file "' . $tmpfname . '".' . "\n");
 654                                 foreach ($readings as $page => $reading) {
 655                                         if($reading != '') continue;
 656                                         fputs($fp, mb_convert_encoding($page . "\n",
 657                                                 $pagereading_kanji2kana_encoding, SOURCE_ENCODING));
 658                                 }
 659                                 fclose($fp);
 660
 661                                 $chasen = "$pagereading_chasen_path -F %y $tmpfname";
 662                                 $fp     = popen($chasen, 'r');
 663                                 if($fp === FALSE) {
 664                                         unlink($tmpfname);
 665                                         die_message('ChaSen execution failed: ' . $chasen);
 666                                 }
 667                                 foreach ($readings as $page => $reading) {
 668                                         if($reading != '') continue;
 669
 670                                         $line = fgets($fp);
 671                                         $line = mb_convert_encoding($line, SOURCE_ENCODING,
 672                                                 $pagereading_kanji2kana_encoding);
 673                                         $line = chop($line);
 674                                         $readings[$page] = $line;
 675                                 }
 676                                 pclose($fp);
 677
 678                                 unlink($tmpfname) or
 679                                         die_message('Temporary file can not be removed: ' . $tmpfname);
 680                                 break;
 681
 682                         case 'kakasi':  /*FALLTHROUGH*/
 683                         case 'kakashi':
 684                                 if(! file_exists($pagereading_kakasi_path))
 685                                         die_message('KAKASI not found: ' . $pagereading_kakasi_path);
 686
 687                                 $tmpfname = tempnam(realpath(CACHE_DIR), 'PageReading');
 688                                 $fp       = fopen($tmpfname, 'w') or
 689                                         die_message('Cannot write temporary file "' . $tmpfname . '".' . "\n");
 690                                 foreach ($readings as $page => $reading) {
 691                                         if($reading != '') continue;
 692                                         fputs($fp, mb_convert_encoding($page . "\n",
 693                                                 $pagereading_kanji2kana_encoding, SOURCE_ENCODING));
 694                                 }
 695                                 fclose($fp);
 696
 697                                 $kakasi = "$pagereading_kakasi_path -kK -HK -JK < $tmpfname";
 698                                 $fp     = popen($kakasi, 'r');
 699                                 if($fp === FALSE) {
 700                                         unlink($tmpfname);
 701                                         die_message('KAKASI execution failed: ' . $kakasi);
 702                                 }
 703
 704                                 foreach ($readings as $page => $reading) {
 705                                         if($reading != '') continue;
 706
 707                                         $line = fgets($fp);
 708                                         $line = mb_convert_encoding($line, SOURCE_ENCODING,
 709                                                 $pagereading_kanji2kana_encoding);
 710                                         $line = chop($line);
 711                                         $readings[$page] = $line;
 712                                 }
 713                                 pclose($fp);
 714
 715                                 unlink($tmpfname) or
 716                                         die_message('Temporary file can not be removed: ' . $tmpfname);
 717                                 break;
 718
 719                         case 'none':
 720                                 $patterns = $replacements = $matches = array();
 721                                 foreach (get_source($pagereading_config_dict) as $line) {
 722                                         $line = chop($line);
 723                                         if(preg_match('|^ /([^/]+)/,\s*(.+)$|', $line, $matches)) {
 724                                                 $patterns[]     = $matches[1];
 725                                                 $replacements[] = $matches[2];
 726                                         }
 727                                 }
 728                                 foreach ($readings as $page => $reading) {
 729                                         if($reading != '') continue;
 730
 731                                         $readings[$page] = $page;
 732                                         foreach ($patterns as $no => $pattern)
 733                                                 $readings[$page] = mb_convert_kana(mb_ereg_replace($pattern,
 734                                                         $replacements[$no], $readings[$page]), 'aKCV');
 735                                 }
 736                                 break;
 737
 738                         default:
 739                                 die_message('Unknown kanji-kana converter: ' . $pagereading_kanji2kana_converter . '.');
 740                                 break;
 741                         }
 742                 }
 743
 744                 if($unknownPage || $deletedPage) {
 745
 746                         asort($readings, SORT_STRING); // Sort by pronouncing(alphabetical/reading) order
 747                         $body = '';
 748                         foreach ($readings as $page => $reading)
 749                                 $body .= '-[[' . $page . ']] ' . $reading . "\n";
 750
 751                         page_write($pagereading_config_page, $body);
 752                 }
 753         }
 754
 755         // Pages that are not prounouncing-clear, return pagenames of themselves
 756         foreach ($pages as $page) {
 757                 if($readings[$page] == '')
 758                         $readings[$page] = $page;
 759         }
 760
 761         return $readings;
 762 }
 763
 764 // Get a list of related pages of the page
 765 function links_get_related($page)
 766 {
 767         global $vars, $related;
 768         static $links = array();
 769
 770         if (isset($links[$page])) return $links[$page];
 771
 772         // If possible, merge related pages generated by make_link()
 773         $links[$page] = ($page === $vars['page']) ? $related : array();
 774
 775         // Get repated pages from DB
 776         $links[$page] += links_get_related_db($vars['page']);
 777
 778         return $links[$page];
 779 }
 780
 781 // _If needed_, re-create the file to change/correct ownership into PHP's
 782 // NOTE: Not works for Windows
 783 function pkwk_chown($filename, $preserve_time = TRUE)
 784 {
 785         static $php_uid; // PHP's UID
 786
 787         if (! isset($php_uid)) {
 788                 if (extension_loaded('posix')) {
 789                         $php_uid = posix_getuid(); // Unix
 790                 } else {
 791                         $php_uid = 0; // Windows
 792                 }
 793         }
 794
 795         // Lock for pkwk_chown()
 796         $lockfile = CACHE_DIR . 'pkwk_chown.lock';
 797         $flock = fopen($lockfile, 'a') or
 798                 die('pkwk_chown(): fopen() failed for: CACHEDIR/' .
 799                         basename(htmlsc($lockfile)));
 800         flock($flock, LOCK_EX) or die('pkwk_chown(): flock() failed for lock');
 801
 802         // Check owner
 803         $stat = stat($filename) or
 804                 die('pkwk_chown(): stat() failed for: '  . basename(htmlsc($filename)));
 805         if ($stat[4] === $php_uid) {
 806                 // NOTE: Windows always here
 807                 $result = TRUE; // Seems the same UID. Nothing to do
 808         } else {
 809                 $tmp = $filename . '.' . getmypid() . '.tmp';
 810
 811                 // Lock source $filename to avoid file corruption
 812                 // NOTE: Not 'r+'. Don't check write permission here
 813                 $ffile = fopen($filename, 'r') or
 814                         die('pkwk_chown(): fopen() failed for: ' .
 815                                 basename(htmlsc($filename)));
 816
 817                 // Try to chown by re-creating files
 818                 // NOTE:
 819                 //   * touch() before copy() is for 'rw-r--r--' instead of 'rwxr-xr-x' (with umask 022).
 820                 //   * (PHP 4 < PHP 4.2.0) touch() with the third argument is not implemented and retuns NULL and Warn.
 821                 //   * @unlink() before rename() is for Windows but here's for Unix only
 822                 flock($ffile, LOCK_EX) or die('pkwk_chown(): flock() failed');
 823                 $result = touch($tmp) && copy($filename, $tmp) &&
 824                         ($preserve_time ? (touch($tmp, $stat[9], $stat[8]) || touch($tmp, $stat[9])) : TRUE) &&
 825                         rename($tmp, $filename);
 826                 flock($ffile, LOCK_UN) or die('pkwk_chown(): flock() failed');
 827
 828                 fclose($ffile) or die('pkwk_chown(): fclose() failed');
 829
 830                 if ($result === FALSE) @unlink($tmp);
 831         }
 832
 833         // Unlock for pkwk_chown()
 834         flock($flock, LOCK_UN) or die('pkwk_chown(): flock() failed for lock');
 835         fclose($flock) or die('pkwk_chown(): fclose() failed for lock');
 836
 837         return $result;
 838 }
 839
 840 // touch() with trying pkwk_chown()
 841 function pkwk_touch_file($filename, $time = FALSE, $atime = FALSE)
 842 {
 843         // Is the owner incorrected and unable to correct?
 844         if (! file_exists($filename) || pkwk_chown($filename)) {
 845                 if ($time === FALSE) {
 846                         $result = touch($filename);
 847                 } else if ($atime === FALSE) {
 848                         $result = touch($filename, $time);
 849                 } else {
 850                         $result = touch($filename, $time, $atime);
 851                 }
 852                 return $result;
 853         } else {
 854                 die('pkwk_touch_file(): Invalid UID and (not writable for the directory or not a flie): ' .
 855                         htmlsc(basename($filename)));
 856         }
 857 }
 858
 859 /**
 860  * Lock-enabled file_get_contents
 861  *
 862  * Require: PHP5+
 863  */
 864 function pkwk_file_get_contents($filename) {
 865         if (! file_exists($filename)) {
 866                 return false;
 867         }
 868         $fp   = fopen($filename, 'rb');
 869         flock($fp, LOCK_SH);
 870         $file = file_get_contents($filename);
 871         flock($fp, LOCK_UN);
 872         return $file;
 873 }
 874
 875 /**
 876  * Prepare some cache files for convert_html()
 877  *
 878  * * Make cache/autolink.dat if needed
 879  */
 880 function prepare_display_materials() {
 881         global $autolink;
 882         if ($autolink) {
 883                 // Make sure 'cache/autolink.dat'
 884                 $file = CACHE_DIR . PKWK_AUTOLINK_REGEX_CACHE;
 885                 if (!file_exists($file)) {
 886                         // Re-create autolink.dat
 887                         put_lastmodified();
 888                 }
 889         }
 890 }
 891
 892 /**
 893  * Prepare page related links and references for links_get_related()
 894  */
 895 function prepare_links_related($page) {
 896         $enc_name = encode($page);
 897         $rel_file = CACHE_DIR . encode($page) . '.rel';
 898         $ref_file = CACHE_DIR . encode($page) . '.ref';
 899         if (file_exists($rel_file)) return;
 900         if (file_exists($ref_file)) return;
 901         $pattern = '/^((?:[0-9A-F]{2})+)' . '(\.ref|\.rel)' . '$/';
 902
 903         $dir = CACHE_DIR;
 904         $dp = @opendir($dir) or die_message('CACHE_DIR/'. ' is not found or not readable.');
 905         $rel_ref_ready = false;
 906         $count = 0;
 907         while (($file = readdir($dp)) !== FALSE) {
 908                 if (preg_match($pattern, $file, $matches)) {
 909                         if ($count++ > 5) {
 910                                 $rel_ref_ready = true;
 911                                 break;
 912                         }
 913                 }
 914         }
 915         closedir($dp);
 916         if (!$rel_ref_ready) {
 917                 if (count(get_existpages()) < 50) {
 918                         // Make link files automatically only if page count < 50.
 919                         // Because large number of update links will cause PHP timeout.
 920                         links_init();
 921                 }
 922         }
 923 }