<?php
// PukiWiki - Yet another WikiWikiWeb clone.
-// $Id: file.php,v 1.57 2006/04/11 14:26:03 henoheno Exp $
+// file.php
// Copyright (C)
-// 2002-2006 PukiWiki Developers Team
+// 2002-2016 PukiWiki Development Team
// 2001-2002 Originally written by yu-ji
// License: GPL v2 or (at your option) any later version
//
// File related functions
+// RecentChanges
+define('PKWK_MAXSHOW_ALLOWANCE', 10);
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)
+// Returns FALSE if error occurerd
+function get_source($page = NULL, $lock = TRUE, $join = FALSE)
{
- $array = array();
+ //$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 $array;
+ if ($fp === FALSE) return FALSE;
flock($fp, LOCK_SH);
}
- // Removing line-feeds: Because file() doesn't remove them.
- $array = str_replace("\r", '', file($path));
+ if ($join) {
+ // Returns a value
+ $size = filesize($path);
+ if ($size === FALSE) {
+ $result = FALSE;
+ } else if ($size == 0) {
+ $result = '';
+ } else {
+ $result = fread($fp, $size);
+ if ($result !== FALSE) {
+ // Removing line-feeds
+ $result = str_replace("\r", '', $result);
+ }
+ }
+ } else {
+ // Returns an array
+ $result = file($path);
+ if ($result !== FALSE) {
+ // Removing line-feeds
+ $result = str_replace("\r", '', $result);
+ }
+ }
if ($lock) {
flock($fp, LOCK_UN);
}
}
- return $array;
+ return $result;
}
// Get last-modified filetime of the page
// Put a data(wiki text) into a physical file(diff, backup, text)
function page_write($page, $postdata, $notimestamp = FALSE)
{
- global $trackback;
-
if (PKWK_READONLY) return; // Do nothing
$postdata = make_str_rules($postdata);
+ $text_without_author = remove_author_info($postdata);
+ $postdata = add_author_info($text_without_author);
+ $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 ($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);
}
return implode("\n", $lines);
}
+function add_author_info($wikitext)
+{
+ global $auth_user, $auth_user_fullname, $auth_type, $ldap_user_account;
+ global $auth_provider_user_prefix_default;
+ global $auth_provider_user_prefix_ldap;
+ global $auth_provider_user_prefix_external;
+ $author = preg_replace('/"/', '', $auth_user);
+ $fullname = $auth_user_fullname;
+ if (!$fullname && $author) {
+ // Fullname is empty, use $author as its fullname
+ $fullname = preg_replace('/^[^:]*:/', '', $author);
+ }
+ $displayname = preg_replace('/"/', '', $fullname);
+ $user_prefix = '';
+ switch ($auth_type) {
+ case AUTH_TYPE_BASIC:
+ $user_prefix = $auth_provider_user_prefix_default;
+ break;
+ case AUTH_TYPE_EXTERNAL:
+ case AUTH_TYPE_EXTERNAL_REMOTE_USER:
+ case AUTH_TYPE_EXTERNAL_X_FORWARDED_USER:
+ $user_prefix = $auth_provider_user_prefix_external;
+ break;
+ case AUTH_TYPE_FORM:
+ if ($ldap_user_account) {
+ $user_prefix = $auth_provider_user_prefix_ldap;
+ } else {
+ $user_prefix = $auth_provider_user_prefix_default;
+ }
+ break;
+ }
+ $author_text = sprintf('#author("%s","%s","%s")',
+ get_date_atom(UTIME + LOCALZONE),
+ ($author ? $user_prefix . $author : ''),
+ $displayname) . "\n";
+ return $author_text . $wikitext;
+}
+
+function remove_author_info($wikitext)
+{
+ return preg_replace('/^\s*#author\([^\n]*(\n|$)/m', '', $wikitext);
+}
+
+function get_date_atom($timestamp)
+{
+ // Compatible with DATE_ATOM format
+ // return date(DATE_ATOM, $timestamp);
+ $zmin = abs(LOCALZONE / 60);
+ return date('Y-m-d\TH:i:s', $timestamp) . sprintf('%s%02d:%02d',
+ (LOCALZONE < 0 ? '-' : '+') , $zmin / 60, $zmin % 60);
+}
+
// Generate ID
function generate_fixed_heading_anchor_id($seed)
{
// (Use PHP file() function if you want to get ALL lines)
function file_head($file, $count = 1, $lock = TRUE, $buffer = 8192)
{
- $index = 0;
- $array = array();
+ $array = array();
$fp = @fopen($file, 'r');
if ($fp === FALSE) return FALSE;
set_file_buffer($fp, 0);
-
if ($lock) flock($fp, LOCK_SH);
+ rewind($fp);
+ $index = 0;
while (! feof($fp)) {
$line = fgets($fp, $buffer);
if ($line != FALSE) $array[] = $line;
if (++$index >= $count) break;
}
if ($lock) flock($fp, LOCK_UN);
-
- if(! fclose($fp)) return FALSE;
+ if (! fclose($fp)) return FALSE;
return $array;
}
// Output to a file
-function file_write($dir, $page, $str, $notimestamp = FALSE)
+function file_write($dir, $page, $str, $notimestamp = FALSE, $is_delete = FALSE)
{
- global $update_exec, $_msg_invalidiwn, $notify, $notify_diff_only, $notify_subject;
+ global $_msg_invalidiwn, $notify, $notify_diff_only, $notify_subject;
global $whatsdeleted, $maxshow_deleted;
if (PKWK_READONLY) return; // Do nothing
// ----
// Delete?
- if ($dir == DATA_DIR && $str === '') {
+ if ($dir == DATA_DIR && $is_delete) {
// Page deletion
if (! $file_exists) return; // Ignore null posting for DATA_DIR
// Update RecentDeleted (Add the $page)
add_recent($page, $whatsdeleted, '', $maxshow_deleted);
+ // Remove the page
unlink($file);
- // Update RecentChanges (Remove the $page from RecentChanges)
- put_lastmodified();
+ // Update RecentDeleted, and remove the page from RecentChanges
+ lastmodified_add($whatsdeleted, $page);
// Clear is_page() cache
is_page($page, TRUE);
// File replacement (Edit)
if (! is_pagename($page))
- die_message(str_replace('$1', htmlspecialchars($page),
+ die_message(str_replace('$1', htmlsc($page),
str_replace('$2', 'WikiName', $_msg_invalidiwn)));
$str = rtrim(preg_replace('/' . "\r" . '/', '', $str)) . "\n";
$timestamp = ($file_exists && $notimestamp) ? filemtime($file) : FALSE;
$fp = fopen($file, 'a') or die('fopen() failed: ' .
- htmlspecialchars(basename($dir) . '/' . encode($page) . '.txt') .
+ htmlsc(basename($dir) . '/' . encode($page) . '.txt') .
'<br />' . "\n" .
'Maybe permission is not writable or filename is too long');
set_file_buffer($fp, 0);
// Optional actions
if ($dir == DATA_DIR) {
// Update RecentChanges (Add or renew the $page)
- if ($timestamp === FALSE) put_lastmodified();
+ if ($timestamp === FALSE) lastmodified_add($page);
- // Execute $update_exec here
- if ($update_exec) system($update_exec . ' > /dev/null &');
+ // Command execution per update
+ if (defined('PKWK_UPDATE_EXEC') && PKWK_UPDATE_EXEC)
+ system(PKWK_UPDATE_EXEC . ' > /dev/null &');
} 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['URI'] = get_script_uri() . '?' . pagename_urlencode($page);
$footer['USER_AGENT'] = TRUE;
$footer['REMOTE_ADDR'] = TRUE;
pkwk_mail_notify($notify_subject, $str, $footer) or
// Add
array_unshift($lines, '-' . format_date(UTIME) . ' - ' . $_page .
- htmlspecialchars($subject) . "\n");
+ htmlsc($subject) . "\n");
// Get latest $limit reports
$lines = array_splice($lines, 0, $limit);
// Update
$fp = fopen(get_filename($recentpage), 'w') or
die_message('Cannot write page file ' .
- htmlspecialchars($recentpage) .
+ htmlsc($recentpage) .
'<br />Maybe permission is not writable or filename is too long');
set_file_buffer($fp, 0);
flock($fp, LOCK_EX);
fclose($fp);
}
-// Re-create PKWK_MAXSHOW_CACHE
+// Update PKWK_MAXSHOW_CACHE itself (Add or renew about the $page) (Light)
+// Use without $autolink
+function lastmodified_add($update = '', $remove = '')
+{
+ global $maxshow, $whatsnew, $autolink;
+
+ // AutoLink implimentation needs everything, for now
+ if ($autolink) {
+ put_lastmodified(); // Try to (re)create ALL
+ return;
+ }
+ if (($update == '' || check_non_list($update)) && $remove == '')
+ return; // No need
+
+ $file = CACHE_DIR . PKWK_MAXSHOW_CACHE;
+ if (! file_exists($file)) {
+ put_lastmodified(); // Try to (re)create ALL
+ return;
+ }
+
+ // Open
+ pkwk_touch_file($file);
+ $fp = fopen($file, 'r+') or
+ die_message('Cannot open ' . 'CACHE_DIR/' . PKWK_MAXSHOW_CACHE);
+ set_file_buffer($fp, 0);
+ flock($fp, LOCK_EX);
+
+ // Read (keep the order of the lines)
+ $recent_pages = $matches = array();
+ foreach(file_head($file, $maxshow + PKWK_MAXSHOW_ALLOWANCE, FALSE) as $line)
+ if (preg_match('/^([0-9]+)\t(.+)/', $line, $matches))
+ $recent_pages[$matches[2]] = $matches[1];
+
+ // Remove if it exists inside
+ if (isset($recent_pages[$update])) unset($recent_pages[$update]);
+ if (isset($recent_pages[$remove])) unset($recent_pages[$remove]);
+
+ // Add to the top: like array_unshift()
+ if ($update != '')
+ $recent_pages = array($update => get_filetime($update)) + $recent_pages;
+
+ // Check
+ $abort = count($recent_pages) < $maxshow;
+
+ if (! $abort) {
+ // Write
+ ftruncate($fp, 0);
+ rewind($fp);
+ foreach ($recent_pages as $_page=>$time)
+ fputs($fp, $time . "\t" . $_page . "\n");
+ }
+
+ flock($fp, LOCK_UN);
+ fclose($fp);
+
+ if ($abort) {
+ put_lastmodified(); // Try to (re)create ALL
+ return;
+ }
+
+
+
+ // ----
+ // Update the page 'RecentChanges'
+
+ $recent_pages = array_splice($recent_pages, 0, $maxshow);
+ $file = get_filename($whatsnew);
+
+ // Open
+ pkwk_touch_file($file);
+ $fp = fopen($file, 'r+') or
+ die_message('Cannot open ' . htmlsc($whatsnew));
+ set_file_buffer($fp, 0);
+ flock($fp, LOCK_EX);
+
+ // Recreate
+ ftruncate($fp, 0);
+ rewind($fp);
+ foreach ($recent_pages as $_page=>$time)
+ fputs($fp, '-' . htmlsc(format_date($time)) .
+ ' - ' . '[[' . htmlsc($_page) . ']]' . "\n");
+ fputs($fp, '#norelated' . "\n"); // :)
+
+ flock($fp, LOCK_UN);
+ fclose($fp);
+}
+
+// Re-create PKWK_MAXSHOW_CACHE (Heavy)
function put_lastmodified()
{
global $maxshow, $whatsnew, $autolink;
if (PKWK_READONLY) return; // Do nothing
- // Get whole page list
+ // Get WHOLE page list
$pages = get_existpages();
// 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
arsort($recent_pages, SORT_NUMERIC);
// Cut unused lines
- $recent_pages = array_splice($recent_pages, 0, $maxshow);
+ // BugTrack2/179: array_splice() will break integer keys in hashtable
+ $count = $maxshow + PKWK_MAXSHOW_ALLOWANCE;
+ $_recent = array();
+ foreach($recent_pages as $key=>$value) {
+ unset($recent_pages[$key]);
+ $_recent[$key] = $value;
+ if (--$count < 1) break;
+ }
+ $recent_pages = & $_recent;
// Re-create PKWK_MAXSHOW_CACHE
- $fp = fopen(CACHE_DIR . PKWK_MAXSHOW_CACHE, 'w') or
- die_message('Cannot write file ' .
- 'CACHE_DIR/' . PKWK_MAXSHOW_CACHE . '<br />' . "\n" .
- 'Maybe permission is not writable');
+ $file = CACHE_DIR . PKWK_MAXSHOW_CACHE;
+ pkwk_touch_file($file);
+ $fp = fopen($file, 'r+') or
+ die_message('Cannot open' . 'CACHE_DIR/' . PKWK_MAXSHOW_CACHE);
set_file_buffer($fp, 0);
flock($fp, LOCK_EX);
+ ftruncate($fp, 0);
rewind($fp);
foreach ($recent_pages as $page=>$time)
fputs($fp, $time . "\t" . $page . "\n");
fclose($fp);
// Create RecentChanges
- $fp = fopen(get_filename($whatsnew), 'w') or
- die_message('Cannot write file ' .
- htmlspecialchars($whatsnew) . '<br />' . "\n" .
- 'Maybe permission is not writable or filename is too long');
+ $file = get_filename($whatsnew);
+ pkwk_touch_file($file);
+ $fp = fopen($file, 'r+') or
+ die_message('Cannot open ' . htmlsc($whatsnew));
set_file_buffer($fp, 0);
flock($fp, LOCK_EX);
+ ftruncate($fp, 0);
rewind($fp);
foreach (array_keys($recent_pages) as $page) {
$time = $recent_pages[$page];
- $s_lastmod = htmlspecialchars(format_date($time));
- $s_page = htmlspecialchars($page);
+ $s_lastmod = htmlsc(format_date($time));
+ $s_page = htmlsc($page);
fputs($fp, '-' . $s_lastmod . ' - [[' . $s_page . ']]' . "\n");
}
fputs($fp, '#norelated' . "\n"); // :)
list($pattern, $pattern_a, $forceignorelist) =
get_autolink_pattern($pages);
- $fp = fopen(CACHE_DIR . PKWK_AUTOLINK_REGEX_CACHE, 'w') or
- die_message('Cannot write file ' .
- 'CACHE_DIR/' . PKWK_AUTOLINK_REGEX_CACHE . '<br />' . "\n" .
- 'Maybe permission is not writable');
+ $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");
}
}
+// 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, '/') . '$/';
+
+ $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);
+
+ return $aryret;
+}
+
// Get a page list of this wiki
function get_existpages($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.');
+ $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);
return $aryret;
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";
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)
{
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']);
$lockfile = CACHE_DIR . 'pkwk_chown.lock';
$flock = fopen($lockfile, 'a') or
die('pkwk_chown(): fopen() failed for: CACHEDIR/' .
- basename(htmlspecialchars($lockfile)));
+ basename(htmlsc($lockfile)));
flock($flock, LOCK_EX) or die('pkwk_chown(): flock() failed for lock');
// Check owner
$stat = stat($filename) or
- die('pkwk_chown(): stat() failed for: ' . basename(htmlspecialchars($filename)));
+ die('pkwk_chown(): stat() failed for: ' . basename(htmlsc($filename)));
if ($stat[4] === $php_uid) {
// NOTE: Windows always here
$result = TRUE; // Seems the same UID. Nothing to do
// NOTE: Not 'r+'. Don't check write permission here
$ffile = fopen($filename, 'r') or
die('pkwk_chown(): fopen() failed for: ' .
- basename(htmlspecialchars($filename)));
+ basename(htmlsc($filename)));
// Try to chown by re-creating files
// NOTE:
return $result;
} else {
die('pkwk_touch_file(): Invalid UID and (not writable for the directory or not a flie): ' .
- htmlspecialchars(basename($filename)));
+ htmlsc(basename($filename)));
}
}
-?>