OSDN Git Service

BugTrack/2514 Support PHP 8
[pukiwiki/pukiwiki.git] / lib / file.php
index ea9cad3..9600cd6 100644 (file)
@@ -1,8 +1,8 @@
 <?php
 // PukiWiki - Yet another WikiWikiWeb clone.
-// $Id: file.php,v 1.95 2011/01/25 15:01:01 henoheno Exp $
-// Copyright (C)
-//   2002-2006 PukiWiki Developers Team
+// file.php
+// Copyright
+//   2002-2021 PukiWiki Development Team
 //   2001-2002 Originally written by yu-ji
 // License: GPL v2 or (at your option) any later version
 //
@@ -15,27 +15,59 @@ define('PKWK_MAXSHOW_CACHE', 'recent.dat');
 // AutoLink
 define('PKWK_AUTOLINK_REGEX_CACHE', 'autolink.dat');
 
-// Get source(wiki text) data of the page
-function get_source($page = NULL, $lock = TRUE, $join = FALSE)
+// AutoAlias
+define('PKWK_AUTOALIAS_REGEX_CACHE', 'autoalias.dat');
+
+/**
+ * Get source(wiki text) data of the page
+ *
+ * @param $page page name
+ * @param $lock lock
+ * @param $join true: return string, false: return array of string
+ * @param $raw true: return file content as-is
+ * @return FALSE if error occurerd
+ */
+function get_source($page = NULL, $lock = TRUE, $join = FALSE, $raw = FALSE)
 {
+       //$result = NULL;       // File is not found
        $result = $join ? '' : array();
+               // Compat for "implode('', get_source($file))",
+               //      -- this is slower than "get_source($file, TRUE, TRUE)"
+               // Compat for foreach(get_source($file) as $line) {} not to warns
 
-       if (is_page($page)) {
-               $path  = get_filename($page);
+       $path = get_filename($page);
+       if (file_exists($path)) {
 
                if ($lock) {
                        $fp = @fopen($path, 'r');
-                       if ($fp == FALSE) return $result;
+                       if ($fp === FALSE) return FALSE;
                        flock($fp, LOCK_SH);
                }
 
                if ($join) {
                        // Returns a value
-                       $result = str_replace("\r", '', fread($fp, filesize($path)));
+                       $size = filesize($path);
+                       if ($size === FALSE) {
+                               $result = FALSE;
+                       } else if ($size == 0) {
+                               $result = '';
+                       } else {
+                               $result = fread($fp, $size);
+                               if ($result !== FALSE) {
+                                       if ($raw) {
+                                               return $result;
+                                       }
+                                       // Removing Carriage-Return
+                                       $result = str_replace("\r", '', $result);
+                               }
+                       }
                } else {
                        // Returns an array
-                       // Removing line-feeds: Because file() doesn't remove them.
-                       $result = str_replace("\r", '', file($path));
+                       $result = file($path);
+                       if ($result !== FALSE) {
+                               // Removing Carriage-Return
+                               $result = str_replace("\r", '', $result);
+                       }
                }
 
                if ($lock) {
@@ -53,6 +85,19 @@ function get_filetime($page)
        return is_page($page) ? filemtime(get_filename($page)) - LOCALZONE : 0;
 }
 
+/**
+ * Get last-modified filemtime (plain value) of the page.
+ *
+ * @param $page
+ */
+function get_page_date_atom($page)
+{
+       if (is_page($page)) {
+               return get_date_atom(filemtime(get_filename($page)));
+       }
+       return null;
+}
+
 // Get physical file name of the page
 function get_filename($page)
 {
@@ -62,32 +107,42 @@ function get_filename($page)
 // Put a data(wiki text) into a physical file(diff, backup, text)
 function page_write($page, $postdata, $notimestamp = FALSE)
 {
-       global $trackback;
+       global $autoalias, $aliaspage;
 
        if (PKWK_READONLY) return; // Do nothing
 
        $postdata = make_str_rules($postdata);
+       $timestamp_to_keep = null;
+       if ($notimestamp) {
+               $timestamp_to_keep = get_filetime($page);
+       }
+       $text_without_author = remove_author_info($postdata);
+       $postdata = add_author_info($text_without_author, $timestamp_to_keep);
+       $is_delete = empty($text_without_author);
 
-       // Create and write diff
+       // Do nothing when it has no changes
        $oldpostdata = is_page($page) ? join('', get_source($page)) : '';
+       $oldtext_without_author = remove_author_info($oldpostdata);
+       if (!$is_delete && $text_without_author === $oldtext_without_author) {
+               // Do nothing on updating with unchanged content
+               return;
+       }
+       // Create and write diff
        $diffdata    = do_diff($oldpostdata, $postdata);
        file_write(DIFF_DIR, $page, $diffdata);
 
        // Create backup
-       make_backup($page, $postdata == ''); // Is $postdata null?
+       make_backup($page, $is_delete, $postdata); // Is $postdata null?
 
        // Create wiki text
-       file_write(DATA_DIR, $page, $postdata, $notimestamp);
-
-       if ($trackback) {
-               // TrackBack Ping
-               $_diff = explode("\n", $diffdata);
-               $plus  = join("\n", preg_replace('/^\+/', '', preg_grep('/^\+/', $_diff)));
-               $minus = join("\n", preg_replace('/^-/',  '', preg_grep('/^-/',  $_diff)));
-               tb_send($page, $plus, $minus);
-       }
+       file_write(DATA_DIR, $page, $postdata, $notimestamp, $is_delete);
 
        links_update($page);
+
+       // Update autoalias.dat (AutoAliasName)
+       if ($autoalias && $page === $aliaspage) {
+               update_autoalias_cache_file();
+       }
 }
 
 // Modify original text with user-defined / system-defined rules
@@ -105,7 +160,7 @@ function make_str_rules($source)
                $line = & $lines[$i]; // Modify directly
 
                // Ignore null string and preformatted texts
-               if ($line == '' || $line{0} == ' ' || $line{0} == "\t") continue;
+               if ($line == '' || $line[0] == ' ' || $line[0] == "\t") continue;
 
                // Modify this line?
                if ($modify) {
@@ -149,10 +204,108 @@ function make_str_rules($source)
        return implode("\n", $lines);
 }
 
+/**
+ * Add author plugin text for wiki text body
+ *
+ * @param string $wikitext
+ * @param integer $timestamp_to_keep Set null when not to keep timestamp
+ */
+function add_author_info($wikitext, $timestamp_to_keep)
+{
+       global $auth_user, $auth_user_fullname;
+       $author = preg_replace('/"/', '', $auth_user);
+       $fullname = $auth_user_fullname;
+       if (!$fullname && $author) {
+               // Fullname is empty, use $author as its fullname
+               $fullname = preg_replace('/^[^:]*:/', '', $author);
+       }
+       $datetime_to_keep = '';
+       if (!is_null($timestamp_to_keep)) {
+               $datetime_to_keep .= ';' . get_date_atom($timestamp_to_keep + LOCALZONE);
+       }
+       $displayname = preg_replace('/"/', '', $fullname);
+       $user_prefix = get_auth_user_prefix();
+       $author_text = sprintf('#author("%s","%s","%s")',
+               get_date_atom(UTIME + LOCALZONE) . $datetime_to_keep,
+               ($author ? $user_prefix . $author : ''),
+               $displayname) . "\n";
+       return $author_text . $wikitext;
+}
+
+function remove_author_info($wikitext)
+{
+       return preg_replace('/^\s*#author\([^\n]*(\n|$)/m', '', $wikitext);
+}
+
+/**
+ * Remove author line from wikitext
+ */
+function remove_author_header($wikitext)
+{
+       $start = 0;
+       while (($pos = strpos($wikitext, "\n", $start)) != false) {
+               $line = substr($wikitext, $start, $pos);
+               $m = null;
+               if (preg_match('/^#author\(/', $line, $m)) {
+                       // fond #author line, Remove this line only
+                       if ($start === 0) {
+                               return substr($wikitext, $pos + 1);
+                       } else {
+                               return substr($wikitext, 0, $start - 1) .
+                                       substr($wikitext, $pos + 1);
+                       }
+               } else if (preg_match('/^#freeze(\W|$)/', $line, $m)) {
+                       // Found #freeze still in header
+               } else {
+                       // other line, #author not found
+                       return $wikitext;
+               }
+               $start = $pos + 1;
+       }
+       return $wikitext;
+}
+
+/**
+ * Get author info from wikitext
+ */
+function get_author_info($wikitext)
+{
+       $start = 0;
+       while (($pos = strpos($wikitext, "\n", $start)) != false) {
+               $line = substr($wikitext, $start, $pos);
+               $m = null;
+               if (preg_match('/^#author\(/', $line, $m)) {
+                       return $line;
+               } else if (preg_match('/^#freeze(\W|$)/', $line, $m)) {
+                       // Found #freeze still in header
+               } else {
+                       // other line, #author not found
+                       return null;
+               }
+               $start = $pos + 1;
+       }
+       return null;
+}
+
+/**
+ * Get updated datetime from author
+ */
+function get_update_datetime_from_author($author_line) {
+       $m = null;
+       if (preg_match('/^#author\(\"([^\";]+)(?:;([^\";]+))?/', $author_line, $m)) {
+               if ($m[2]) {
+                       return $m[2];
+               } else if ($m[1]) {
+                       return $m[1];
+               }
+       }
+       return null;
+}
+
 // Generate ID
 function generate_fixed_heading_anchor_id($seed)
 {
-       // A random alphabetic letter + 7 letters of random strings from md()
+       // A random alphabetic letter + 7 letters of random strings from md5()
        return chr(mt_rand(ord('a'), ord('z'))) .
                substr(md5(uniqid(substr($seed, 0, 100), TRUE)),
                mt_rand(0, 24), 7);
@@ -182,7 +335,7 @@ function file_head($file, $count = 1, $lock = TRUE, $buffer = 8192)
 }
 
 // Output to a file
-function file_write($dir, $page, $str, $notimestamp = FALSE)
+function file_write($dir, $page, $str, $notimestamp = FALSE, $is_delete = FALSE)
 {
        global $_msg_invalidiwn, $notify, $notify_diff_only, $notify_subject;
        global $whatsdeleted, $maxshow_deleted;
@@ -197,7 +350,7 @@ function file_write($dir, $page, $str, $notimestamp = FALSE)
        // ----
        // Delete?
 
-       if ($dir == DATA_DIR && $str === '') {
+       if ($dir == DATA_DIR && $is_delete) {
                // Page deletion
                if (! $file_exists) return; // Ignore null posting for DATA_DIR
 
@@ -255,14 +408,16 @@ function file_write($dir, $page, $str, $notimestamp = FALSE)
        } else if ($dir == DIFF_DIR && $notify) {
                if ($notify_diff_only) $str = preg_replace('/^[^-+].*\n/m', '', $str);
                $footer['ACTION'] = 'Page update';
-               $footer['PAGE']   = $page;
-               $footer['URI']    = get_script_uri() . '?' . rawurlencode($page);
+               $footer['PAGE']   = $page;
+               $footer['URI']    = get_page_uri($page, PKWK_URI_ABSOLUTE);
                $footer['USER_AGENT']  = TRUE;
                $footer['REMOTE_ADDR'] = TRUE;
                pkwk_mail_notify($notify_subject, $str, $footer) or
                        die('pkwk_mail_notify(): Failed');
        }
-
+       if ($dir === DIFF_DIR) {
+               pkwk_log_updates($page, $str);
+       }
        is_page($page, TRUE); // Clear is_page() cache
 }
 
@@ -406,7 +561,7 @@ function put_lastmodified()
        // Check ALL filetime
        $recent_pages = array();
        foreach($pages as $page)
-               if ($page != $whatsnew && ! check_non_list($page))
+               if ($page !== $whatsnew && ! check_non_list($page))
                        $recent_pages[$page] = get_filetime($page);
 
        // Sort decending order of last-modification date
@@ -458,22 +613,66 @@ function put_lastmodified()
 
        // For AutoLink
        if ($autolink) {
-               list($pattern, $pattern_a, $forceignorelist) =
-                       get_autolink_pattern($pages);
+               autolink_pattern_write(CACHE_DIR . PKWK_AUTOLINK_REGEX_CACHE,
+                       get_autolink_pattern($pages, $autolink));
+       }
+}
 
-               $file = CACHE_DIR . PKWK_AUTOLINK_REGEX_CACHE;
-               pkwk_touch_file($file);
-               $fp = fopen($file, 'r+') or
-                       die_message('Cannot open ' . 'CACHE_DIR/' . PKWK_AUTOLINK_REGEX_CACHE);
-               set_file_buffer($fp, 0);
-               flock($fp, LOCK_EX);
-               ftruncate($fp, 0);
-               rewind($fp);
-               fputs($fp, $pattern   . "\n");
-               fputs($fp, $pattern_a . "\n");
-               fputs($fp, join("\t", $forceignorelist) . "\n");
-               flock($fp, LOCK_UN);
-               fclose($fp);
+/**
+ * Get recent files
+ *
+ * @return Array of (file => time)
+ */
+function get_recent_files()
+{
+       $recentfile = CACHE_DIR . PKWK_MAXSHOW_CACHE;
+       $lines = file($recentfile);
+       if (!$lines) return array();
+       $files = array();
+       foreach ($lines as $line) {
+               list ($time, $file) = explode("\t", rtrim($line));
+               $files[$file] = $time;
+       }
+       return $files;
+}
+
+/**
+ * Update RecentChanges page / Invalidate recent.dat
+ */
+function delete_recent_changes_cache() {
+       $file = CACHE_DIR . PKWK_MAXSHOW_CACHE;
+       unlink($file);
+}
+
+// update autolink data
+function autolink_pattern_write($filename, $autolink_pattern)
+{
+       list($pattern, $pattern_a, $forceignorelist) = $autolink_pattern;
+
+       $fp = fopen($filename, 'w') or
+               die_message('Cannot open ' . $filename);
+       set_file_buffer($fp, 0);
+       flock($fp, LOCK_EX);
+       rewind($fp);
+       fputs($fp, $pattern   . "\n");
+       fputs($fp, $pattern_a . "\n");
+       fputs($fp, join("\t", $forceignorelist) . "\n");
+       flock($fp, LOCK_UN);
+       fclose($fp);
+}
+
+// Update AutoAlias regex cache
+function update_autoalias_cache_file()
+{
+       global $autoalias; // Disable (0), Enable (min-length)
+       $aliases = get_autoaliases();
+       if (empty($aliases)) {
+               // Remove
+               @unlink(CACHE_DIR . PKWK_AUTOALIAS_REGEX_CACHE);
+       } else {
+               // Create or Update
+               autolink_pattern_write(CACHE_DIR . PKWK_AUTOALIAS_REGEX_CACHE,
+                       get_autolink_pattern(array_keys($aliases), $autoalias));
        }
 }
 
@@ -501,23 +700,69 @@ function header_lastmod($page = NULL)
        }
 }
 
-// Get a page list of this wiki
-function get_existpages($dir = DATA_DIR, $ext = '.txt')
+// Get a list of encoded files (must specify a directory and a suffix)
+function get_existfiles($dir = DATA_DIR, $ext = '.txt')
 {
        $aryret = array();
+       $pattern = '/^(?:[0-9A-F]{2})+' . preg_quote($ext, '/') . '$/';
 
-       $pattern = '((?:[0-9A-F]{2})+)';
-       if ($ext != '') $ext = preg_quote($ext, '/');
-       $pattern = '/^' . $pattern . $ext . '$/';
+       $dp = @opendir($dir) or die_message($dir . ' is not found or not readable.');
+       while (($file = readdir($dp)) !== FALSE) {
+               if (preg_match($pattern, $file)) {
+                       $aryret[] = $dir . $file;
+               }
+       }
+       closedir($dp);
 
-       $dp = @opendir($dir) or
-               die_message($dir . ' is not found or not readable.');
+       return $aryret;
+}
+
+/**
+ * Get/Set pagelist cache enabled for get_existpages()
+ *
+ * @param $newvalue Set true when the system can cache the page list
+ * @return true if can use page list cache
+ */
+function is_pagelist_cache_enabled($newvalue = null)
+{
+       static $cache_enabled = null;
+
+       if (!is_null($newvalue)) {
+               $cache_enabled = $newvalue;
+               return; // Return nothing on setting newvalue call
+       }
+       if (is_null($cache_enabled)) {
+               return false;
+       }
+       return $cache_enabled;
+}
+
+// Get a page list of this wiki
+function get_existpages($dir = DATA_DIR, $ext = '.txt')
+{
+       static $cached_list = null; // Cached wikitext page list
+       $use_cache = false;
+
+       if ($dir === DATA_DIR && $ext === '.txt' && is_pagelist_cache_enabled()) {
+               // Use pagelist cache for "wiki/*.txt" files
+               if (!is_null($cached_list)) {
+                       return $cached_list;
+               }
+               $use_cache = true;
+       }
+       $aryret = array();
+       $pattern = '/^((?:[0-9A-F]{2})+)' . preg_quote($ext, '/') . '$/';
+       $dp = @opendir($dir) or die_message($dir . ' is not found or not readable.');
        $matches = array();
-       while ($file = readdir($dp))
-               if (preg_match($pattern, $file, $matches))
+       while (($file = readdir($dp)) !== FALSE) {
+               if (preg_match($pattern, $file, $matches)) {
                        $aryret[$file] = decode($matches[1]);
+               }
+       }
        closedir($dp);
-
+       if ($use_cache) {
+               $cached_list = $aryret;
+       }
        return $aryret;
 }
 
@@ -664,7 +909,7 @@ function get_readings()
 
                if($unknownPage || $deletedPage) {
 
-                       asort($readings); // Sort by pronouncing(alphabetical/reading) order
+                       asort($readings, SORT_STRING); // Sort by pronouncing(alphabetical/reading) order
                        $body = '';
                        foreach ($readings as $page => $reading)
                                $body .= '-[[' . $page . ']] ' . $reading . "\n";
@@ -682,19 +927,6 @@ function get_readings()
        return $readings;
 }
 
-// Get a list of encoded files (must specify a directory and a suffix)
-function get_existfiles($dir, $ext)
-{
-       $pattern = '/^(?:[0-9A-F]{2})+' . preg_quote($ext, '/') . '$/';
-       $aryret = array();
-       $dp = @opendir($dir) or die_message($dir . ' is not found or not readable.');
-       while ($file = readdir($dp))
-               if (preg_match($pattern, $file))
-                       $aryret[] = $dir . $file;
-       closedir($dp);
-       return $aryret;
-}
-
 // Get a list of related pages of the page
 function links_get_related($page)
 {
@@ -704,7 +936,7 @@ function links_get_related($page)
        if (isset($links[$page])) return $links[$page];
 
        // If possible, merge related pages generated by make_link()
-       $links[$page] = ($page == $vars['page']) ? $related : array();
+       $links[$page] = ($page === $vars['page']) ? $related : array();
 
        // Get repated pages from DB
        $links[$page] += links_get_related_db($vars['page']);
@@ -789,4 +1021,72 @@ function pkwk_touch_file($filename, $time = FALSE, $atime = FALSE)
                        htmlsc(basename($filename)));
        }
 }
-?>
+
+/**
+ * Lock-enabled file_get_contents
+ *
+ * Require: PHP5+
+ */
+function pkwk_file_get_contents($filename) {
+       if (! file_exists($filename)) {
+               return false;
+       }
+       $fp   = fopen($filename, 'rb');
+       flock($fp, LOCK_SH);
+       $file = file_get_contents($filename);
+       flock($fp, LOCK_UN);
+       return $file;
+}
+
+/**
+ * Prepare some cache files for convert_html()
+ *
+ * * Make cache/autolink.dat if needed
+ */
+function prepare_display_materials() {
+       global $autolink;
+       if ($autolink) {
+               // Make sure 'cache/autolink.dat'
+               $file = CACHE_DIR . PKWK_AUTOLINK_REGEX_CACHE;
+               if (!file_exists($file)) {
+                       // Re-create autolink.dat
+                       put_lastmodified();
+               }
+       }
+}
+
+/**
+ * Prepare page related links and references for links_get_related()
+ */
+function prepare_links_related($page) {
+       global $defaultpage;
+
+       $enc_defaultpage = encode($defaultpage);
+       if (file_exists(CACHE_DIR . $enc_defaultpage . '.rel')) return;
+       if (file_exists(CACHE_DIR . $enc_defaultpage . '.ref')) return;
+       $enc_name = encode($page);
+       if (file_exists(CACHE_DIR . $enc_name . '.rel')) return;
+       if (file_exists(CACHE_DIR . $enc_name . '.ref')) return;
+
+       $pattern = '/^((?:[0-9A-F]{2})+)' . '(\.ref|\.rel)' . '$/';
+       $dir = CACHE_DIR;
+       $dp = @opendir($dir) or die_message('CACHE_DIR/'. ' is not found or not readable.');
+       $rel_ref_ready = false;
+       $count = 0;
+       while (($file = readdir($dp)) !== FALSE) {
+               if (preg_match($pattern, $file, $matches)) {
+                       if ($count++ > 5) {
+                               $rel_ref_ready = true;
+                               break;
+                       }
+               }
+       }
+       closedir($dp);
+       if (!$rel_ref_ready) {
+               if (count(get_existpages()) < 50) {
+                       // Make link files automatically only if page count < 50.
+                       // Because large number of update links will cause PHP timeout.
+                       links_init();
+               }
+       }
+}