2 // PukiWiki - Yet another WikiWikiWeb clone.
3 // $Id: func.php,v 1.69 2006/04/16 14:43:35 henoheno Exp $
5 // 2002-2006 PukiWiki Developers Team
6 // 2001-2002 Originally written by yu-ji
7 // License: GPL v2 or (at your option) any later version
11 function is_interwiki($str)
13 global $InterWikiName;
14 return preg_match('/^' . $InterWikiName . '$/', $str);
17 function is_pagename($str)
21 $is_pagename = (! is_interwiki($str) &&
22 preg_match('/^(?!\/)' . $BracketName . '$(?<!\/$)/', $str) &&
23 ! preg_match('#(^|/)\.{1,2}(/|$)#', $str));
25 if (defined('SOURCE_ENCODING')) {
26 switch(SOURCE_ENCODING){
27 case 'UTF-8': $pattern =
28 '/^(?:[\x00-\x7F]|(?:[\xC0-\xDF][\x80-\xBF])|(?:[\xE0-\xEF][\x80-\xBF][\x80-\xBF]))+$/';
30 case 'EUC-JP': $pattern =
31 '/^(?:[\x00-\x7F]|(?:[\x8E\xA1-\xFE][\xA1-\xFE])|(?:\x8F[\xA1-\xFE][\xA1-\xFE]))+$/';
34 if (isset($pattern) && $pattern != '')
35 $is_pagename = ($is_pagename && preg_match($pattern, $str));
41 function is_url($str, $only_http = FALSE)
43 $scheme = $only_http ? 'https?' : 'https?|ftp|news';
44 return preg_match('/^(' . $scheme . ')(:\/\/[-_.!~*\'()a-zA-Z0-9;\/?:\@&=+\$,%#]*)$/', $str);
48 function is_page($page, $clearcache = FALSE)
50 if ($clearcache) clearstatcache();
51 return file_exists(get_filename($page));
54 function is_editable($page)
57 static $is_editable = array();
59 if (! isset($is_editable[$page])) {
60 $is_editable[$page] = (
63 ! in_array($page, $cantedit)
67 return $is_editable[$page];
70 function is_freeze($page, $clearcache = FALSE)
72 global $function_freeze;
73 static $is_freeze = array();
75 if ($clearcache === TRUE) $is_freeze = array();
76 if (isset($is_freeze[$page])) return $is_freeze[$page];
78 if (! $function_freeze || ! is_page($page)) {
79 $is_freeze[$page] = FALSE;
82 $fp = fopen(get_filename($page), 'rb') or
83 die('is_freeze(): fopen() failed: ' . htmlspecialchars($page));
84 flock($fp, LOCK_SH) or die('is_freeze(): flock() failed');
86 $buffer = fgets($fp, 9);
87 flock($fp, LOCK_UN) or die('is_freeze(): flock() failed');
88 fclose($fp) or die('is_freeze(): fclose() failed: ' . htmlspecialchars($page));
90 $is_freeze[$page] = ($buffer != FALSE && rtrim($buffer, "\r\n") == '#freeze');
91 return $is_freeze[$page];
96 // $non_list will be preg_quote($str, '/') later.
97 function check_non_list($page = '')
102 if (! isset($regex)) $regex = '/' . $non_list . '/';
104 return preg_match($regex, $page);
108 function auto_template($page)
110 global $auto_template_func, $auto_template_rules;
112 if (! $auto_template_func) return '';
116 foreach ($auto_template_rules as $rule => $template) {
117 $rule_pattrn = '/' . $rule . '/';
119 if (! preg_match($rule_pattrn, $page, $matches)) continue;
121 $template_page = preg_replace($rule_pattrn, $template, $page);
122 if (! is_page($template_page)) continue;
124 $body = join('', get_source($template_page));
126 // Remove fixed-heading anchors
127 $body = preg_replace('/^(\*{1,3}.*)\[#[A-Za-z][\w-]+\](.*)$/m', '$1$2', $body);
130 $body = preg_replace('/^#freeze\s*$/m', '', $body);
132 $count = count($matches);
133 for ($i = 0; $i < $count; $i++)
134 $body = str_replace('$' . $i, $matches[$i], $body);
141 // Expand all search-words to regexes and push them into an array
142 function get_search_words($words = array(), $do_escape = FALSE)
144 static $init, $mb_convert_kana, $pre, $post, $quote = '/';
146 if (! isset($init)) {
147 // function: mb_convert_kana() is for Japanese code only
148 if (LANG == 'ja' && function_exists('mb_convert_kana')) {
149 $mb_convert_kana = create_function('$str, $option',
150 'return mb_convert_kana($str, $option, SOURCE_ENCODING);');
152 $mb_convert_kana = create_function('$str, $option',
155 if (SOURCE_ENCODING == 'EUC-JP') {
156 // Perl memo - Correct pattern-matching with EUC-JP
157 // http://www.din.or.jp/~ohzaki/perl.htm#JP_Match (Japanese)
159 $post = '(?=(?:[\xA1-\xFE][\xA1-\xFE])*' . // JIS X 0208
160 '(?:[\x00-\x7F\x8E\x8F]|\z))'; // ASCII, SS2, SS3, or the last
167 if (! is_array($words)) $words = array($words);
169 // Generate regex for the words
171 foreach ($words as $word) {
173 if ($word == '') continue;
175 // Normalize: ASCII letters = to single-byte. Others = to Zenkaku and Katakana
176 $word_nm = $mb_convert_kana($word, 'aKCV');
177 $nmlen = mb_strlen($word_nm, SOURCE_ENCODING);
179 // Each chars may be served ...
181 for ($pos = 0; $pos < $nmlen; $pos++) {
182 $char = mb_substr($word_nm, $pos, 1, SOURCE_ENCODING);
184 // Just normalized one? (ASCII char or Zenkaku-Katakana?)
185 $or = array(preg_quote($do_escape ? htmlspecialchars($char) : $char, $quote));
186 if (strlen($char) == 1) {
187 // An ASCII (single-byte) character
188 foreach (array(strtoupper($char), strtolower($char)) as $_char) {
189 if ($char != '&') $or[] = preg_quote($_char, $quote); // As-is?
190 $ascii = ord($_char);
191 $or[] = sprintf('&#(?:%d|x%x);', $ascii, $ascii); // As an entity reference?
192 $or[] = preg_quote($mb_convert_kana($_char, 'A'), $quote); // As Zenkaku?
195 // NEVER COME HERE with mb_substr(string, start, length, 'ASCII')
196 // A multi-byte character
197 $or[] = preg_quote($mb_convert_kana($char, 'c'), $quote); // As Hiragana?
198 $or[] = preg_quote($mb_convert_kana($char, 'k'), $quote); // As Hankaku-Katakana?
200 $chars[] = '(?:' . join('|', array_unique($or)) . ')'; // Regex for the character
203 $regex[$word] = $pre . join('', $chars) . $post; // For the word
206 return $regex; // For all words
209 // 'Search' main function
210 function do_search($word, $type = 'AND', $non_format = FALSE, $base = '')
212 global $script, $whatsnew, $search_non_list;
213 global $_msg_andresult, $_msg_orresult, $_msg_notfoundresult;
214 global $search_auth, $show_passage;
218 $b_type = ($type == 'AND'); // AND:TRUE OR:FALSE
219 $keys = get_search_words(preg_split('/\s+/', $word, -1, PREG_SPLIT_NO_EMPTY));
220 foreach ($keys as $key=>$value) {
221 $keys[$key] = '/' . $value . '/S';
224 $pages = get_existpages();
228 $pages = preg_grep('/^' . preg_quote('/', $base) . '/S', $pages);
230 $pages = array_flip($pages);
231 unset($pages[$whatsnew]);
233 $count = count($pages);
234 foreach (array_keys($pages) as $page) {
235 if (! $search_non_list && check_non_list($page)) {
236 unset($pages[$page]);
242 // Search for page name
244 foreach ($keys as $key) {
245 $b_match = preg_match($key, $page);
246 if ($b_type xor $b_match) break; // OR
248 if ($b_match) continue;
251 // Search auth for page contents
252 if ($search_auth && ! check_readable($page, false, false)) {
253 unset($pages[$page]);
257 // Search for page contents
258 foreach ($keys as $key) {
259 $b_match = preg_match($key, get_source($page, TRUE, TRUE));
260 if ($b_type xor $b_match) break; // OR
262 if ($b_match) continue;
264 unset($pages[$page]); // Miss
266 if ($non_format) return array_keys($pages);
268 $r_word = rawurlencode($word);
269 $s_word = htmlspecialchars($word);
271 return str_replace('$1', $s_word, $_msg_notfoundresult);
275 $retval = '<ul>' . "\n";
276 foreach (array_keys($pages) as $page) {
277 $r_page = rawurlencode($page);
278 $s_page = htmlspecialchars($page);
279 $passage = $show_passage ? ' ' . get_passage(get_filetime($page)) : '';
280 $retval .= ' <li><a href="' . $script . '?cmd=read&page=' .
281 $r_page . '&word=' . $r_word . '">' . $s_page .
282 '</a>' . $passage . '</li>' . "\n";
284 $retval .= '</ul>' . "\n";
286 $retval .= str_replace('$1', $s_word, str_replace('$2', $count,
287 str_replace('$3', $count, $b_type ? $_msg_andresult : $_msg_orresult)));
292 // Argument check for program
293 function arg_check($str)
296 return isset($vars['cmd']) && (strpos($vars['cmd'], $str) === 0);
300 function encode($key)
302 return ($key == '') ? '' : strtoupper(bin2hex($key));
303 // Equal to strtoupper(join('', unpack('H*0', $key)));
304 // But PHP 4.3.10 says 'Warning: unpack(): Type H: outside of string in ...'
308 function decode($key)
310 return hex2bin($key);
313 // Inversion of bin2hex()
314 function hex2bin($hex_string)
316 // preg_match : Avoid warning : pack(): Type H: illegal hex digit ...
317 // (string) : Always treat as string (not int etc). See BugTrack2/31
318 return preg_match('/^[0-9a-f]+$/i', $hex_string) ?
319 pack('H*', (string)$hex_string) : $hex_string;
322 // Remove [[ ]] (brackets)
323 function strip_bracket($str)
326 if (preg_match('/^\[\[(.*)\]\]$/', $str, $match)) {
333 // Create list of pages
334 function page_list($pages, $cmd = 'read', $withfilename = FALSE)
336 global $script, $list_index;
337 global $_msg_symbol, $_msg_other;
338 global $pagereading_enable;
340 // ¥½¡¼¥È¥¡¼¤ò·èÄꤹ¤ë¡£ ' ' < '[a-zA-Z]' < 'zz'¤È¤¤¤¦Á°Äó¡£
346 if($pagereading_enable) {
347 mb_regex_encoding(SOURCE_ENCODING);
348 $readings = get_readings($pages);
351 $list = $matches = array();
353 // Shrink URI for read
354 if ($cmd == 'read') {
355 $href = $script . '?';
357 $href = $script . '?cmd=' . $cmd . '&page=';
360 foreach($pages as $file=>$page) {
361 $r_page = rawurlencode($page);
362 $s_page = htmlspecialchars($page, ENT_QUOTES);
363 $passage = get_pg_passage($page);
365 $str = ' <li><a href="' . $href . $r_page . '">' .
366 $s_page . '</a>' . $passage;
369 $s_file = htmlspecialchars($file);
370 $str .= "\n" . ' <ul><li>' . $s_file . '</li></ul>' .
375 // WARNING: Japanese code hard-wired
376 if($pagereading_enable) {
377 if(mb_ereg('^([A-Za-z])', mb_convert_kana($page, 'a'), $matches)) {
379 } elseif (isset($readings[$page]) && mb_ereg('^([¥¡-¥ö])', $readings[$page], $matches)) { // here
381 } elseif (mb_ereg('^[ -~]|[^¤¡-¤ó°¡-ô¦]', $page)) { // and here
387 $head = (preg_match('/^([A-Za-z])/', $page, $matches)) ? $matches[1] :
388 (preg_match('/^([ -~])/', $page, $matches) ? $symbol : $other);
391 $list[$head][$page] = $str;
396 $arr_index = array();
397 $retval .= '<ul>' . "\n";
398 foreach ($list as $head=>$pages) {
399 if ($head === $symbol) {
400 $head = $_msg_symbol;
401 } else if ($head === $other) {
407 $arr_index[] = '<a id="top_' . $cnt .
408 '" href="#head_' . $cnt . '"><strong>' .
409 $head . '</strong></a>';
410 $retval .= ' <li><a id="head_' . $cnt . '" href="#top_' . $cnt .
411 '"><strong>' . $head . '</strong></a>' . "\n" .
415 $retval .= join("\n", $pages);
417 $retval .= "\n </ul>\n </li>\n";
419 $retval .= '</ul>' . "\n";
420 if ($list_index && $cnt > 0) {
422 while (! empty($arr_index))
423 $top[] = join(' | ' . "\n", array_splice($arr_index, 0, 16)) . "\n";
425 $retval = '<div id="top" style="text-align:center">' . "\n" .
426 join('<br />', $top) . '</div>' . "\n" . $retval;
431 // Show text formatting rules
436 if (! is_page($rule_page)) {
437 return '<p>Sorry, page \'' . htmlspecialchars($rule_page) .
438 '\' unavailable.</p>';
440 return convert_html(get_source($rule_page));
444 // Show (critical) error message
445 function die_message($msg)
447 $title = $page = 'Runtime error';
449 <h3>Runtime error</h3>
450 <strong>Error message : $msg</strong>
453 pkwk_common_headers();
454 if(defined('SKIN_FILE') && file_exists(SKIN_FILE) && is_readable(SKIN_FILE)) {
455 catbody($title, $page, $body);
457 header('Content-Type: text/html; charset=euc-jp');
459 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
462 <title>$title</title>
463 <meta http-equiv="content-type" content="text/html; charset=euc-jp">
474 // Have the time (as microtime)
475 function getmicrotime()
477 list($usec, $sec) = explode(' ', microtime());
478 return ((float)$sec + (float)$usec);
482 function get_date($format, $timestamp = NULL)
484 $format = preg_replace('/(?<!\\\)T/',
485 preg_replace('/(.)/', '\\\$1', ZONE), $format);
487 $time = ZONETIME + (($timestamp !== NULL) ? $timestamp : UTIME);
489 return date($format, $time);
492 // Format date string
493 function format_date($val, $paren = FALSE)
495 global $date_format, $time_format, $weeklabels;
499 $date = date($date_format, $val) .
500 ' (' . $weeklabels[date('w', $val)] . ') ' .
501 date($time_format, $val);
503 return $paren ? '(' . $date . ')' : $date;
506 // Get short string of the passage, 'N seconds/minutes/hours/days/years ago'
507 function get_passage($time, $paren = TRUE)
509 static $units = array('m'=>60, 'h'=>24, 'd'=>1);
511 $time = max(0, (UTIME - $time) / 60); // minutes
513 foreach ($units as $unit=>$card) {
514 if ($time < $card) break;
517 $time = floor($time) . $unit;
519 return $paren ? '(' . $time . ')' : $time;
522 // Hide <input type="(submit|button|image)"...>
523 function drop_submit($str)
525 return preg_replace('/<input([^>]+)type="(submit|button|image)"/i',
526 '<input$1type="hidden"', $str);
529 // Generate AutoLink patterns (thx to hirofummy)
530 function get_autolink_pattern(& $pages)
532 global $WikiName, $autolink, $nowikiname;
534 $config = &new Config('AutoLink');
536 $ignorepages = $config->get('IgnoreList');
537 $forceignorepages = $config->get('ForceIgnoreList');
539 $auto_pages = array_merge($ignorepages, $forceignorepages);
541 foreach ($pages as $page)
542 if (preg_match('/^' . $WikiName . '$/', $page) ?
543 $nowikiname : strlen($page) >= $autolink)
544 $auto_pages[] = $page;
546 if (empty($auto_pages)) {
547 $result = $result_a = $nowikiname ? '(?!)' : $WikiName;
549 $auto_pages = array_unique($auto_pages);
550 sort($auto_pages, SORT_STRING);
552 $auto_pages_a = array_values(preg_grep('/^[A-Z]+$/i', $auto_pages));
553 $auto_pages = array_values(array_diff($auto_pages, $auto_pages_a));
555 $result = get_autolink_pattern_sub($auto_pages, 0, count($auto_pages), 0);
556 $result_a = get_autolink_pattern_sub($auto_pages_a, 0, count($auto_pages_a), 0);
558 return array($result, $result_a, $forceignorepages);
561 function get_autolink_pattern_sub(& $pages, $start, $end, $pos)
563 if ($end == 0) return '(?!)';
566 $count = $i = $j = 0;
567 $x = (mb_strlen($pages[$start]) <= $pos);
570 for ($i = $start; $i < $end; $i = $j) {
571 $char = mb_substr($pages[$i], $pos, 1);
572 for ($j = $i; $j < $end; $j++)
573 if (mb_substr($pages[$j], $pos, 1) != $char) break;
575 if ($i != $start) $result .= '|';
576 if ($i >= ($j - 1)) {
577 $result .= str_replace(' ', '\\ ', preg_quote(mb_substr($pages[$i], $pos), '/'));
579 $result .= str_replace(' ', '\\ ', preg_quote($char, '/')) .
580 get_autolink_pattern_sub($pages, $i, $j, $pos + 1);
584 if ($x || $count > 1) $result = '(?:' . $result . ')';
585 if ($x) $result .= '?';
590 // Get absolute-URI of this script
591 function get_script_uri($init_uri = '')
593 global $script_directory_index;
596 if ($init_uri == '') {
598 if (isset($script)) return $script;
601 $msg = 'get_script_uri() failed: Please set $script at INI_FILE manually';
603 $script = (SERVER_PORT == 443 ? 'https://' : 'http://'); // scheme
604 $script .= SERVER_NAME; // host
605 $script .= (SERVER_PORT == 80 ? '' : ':' . SERVER_PORT); // port
607 // SCRIPT_NAME ¤¬'/'¤Ç»Ï¤Þ¤Ã¤Æ¤¤¤Ê¤¤¾ì¹ç(cgi¤Ê¤É) REQUEST_URI¤ò»È¤Ã¤Æ¤ß¤ë
609 if ($path{0} != '/') {
610 if (! isset($_SERVER['REQUEST_URI']) || $_SERVER['REQUEST_URI']{0} != '/')
613 // REQUEST_URI¤ò¥Ñ¡¼¥¹¤·¡¢pathÉôʬ¤À¤±¤ò¼è¤ê½Ð¤¹
614 $parse_url = parse_url($script . $_SERVER['REQUEST_URI']);
615 if (! isset($parse_url['path']) || $parse_url['path']{0} != '/')
618 $path = $parse_url['path'];
622 if (! is_url($script, TRUE) && php_sapi_name() == 'cgi')
628 if (isset($script)) die_message('$script: Already init');
629 if (! is_url($init_uri, TRUE)) die_message('$script: Invalid URI');
633 // Cut filename or not
634 if (isset($script_directory_index)) {
635 if (! file_exists($script_directory_index))
636 die_message('Directory index file not found: ' .
637 htmlspecialchars($script_directory_index));
639 if (preg_match('#^(.+/)' . preg_quote($script_directory_index, '#') . '$#',
640 $script, $matches)) $script = $matches[1];
646 // Remove null(\0) bytes from variables
648 // NOTE: PHP had vulnerabilities that opens "hoge.php" via fopen("hoge.php\0.txt") etc.
649 // [PHP-users 12736] null byte attack
650 // http://ns1.php.gr.jp/pipermail/php-users/2003-January/012742.html
652 // 2003-05-16: magic quotes gpc¤ÎÉü¸µ½èÍý¤òÅý¹ç
653 // 2003-05-21: Ï¢ÁÛÇÛÎó¤Î¥¡¼¤Ïbinary safe
655 function input_filter($param)
657 static $magic_quotes_gpc = NULL;
658 if ($magic_quotes_gpc === NULL)
659 $magic_quotes_gpc = get_magic_quotes_gpc();
661 if (is_array($param)) {
662 return array_map('input_filter', $param);
664 $result = str_replace("\0", '', $param);
665 if ($magic_quotes_gpc) $result = stripslashes($result);
670 // Compat for 3rd party plugins. Remove this later
671 function sanitize($param) {
672 return input_filter($param);
675 // Explode Comma-Separated Values to an array
676 function csv_explode($separator, $string)
678 $retval = $matches = array();
680 $_separator = preg_quote($separator, '/');
681 if (! preg_match_all('/("[^"]*(?:""[^"]*)*"|[^' . $_separator . ']*)' .
682 $_separator . '/', $string . $separator, $matches))
685 foreach ($matches[1] as $str) {
687 if ($len > 1 && $str{0} == '"' && $str{$len - 1} == '"')
688 $str = str_replace('""', '"', substr($str, 1, -1));
694 // Implode an array with CSV data format (escape double quotes)
695 function csv_implode($glue, $pieces)
697 $_glue = ($glue != '') ? '\\' . $glue{0} : '';
699 foreach ($pieces as $str) {
700 if (ereg('[' . $_glue . '"' . "\n\r" . ']', $str))
701 $str = '"' . str_replace('"', '""', $str) . '"';
704 return join($glue, $arr);
709 // is_a -- Returns TRUE if the object is of this class or has this class as one of its parents
711 if (! function_exists('is_a')) {
713 function is_a($class, $match)
715 if (empty($class)) return FALSE;
717 $class = is_object($class) ? get_class($class) : $class;
718 if (strtolower($class) == strtolower($match)) {
721 return is_a(get_parent_class($class), $match); // Recurse
726 // array_fill -- Fill an array with values
728 if (! function_exists('array_fill')) {
730 function array_fill($start_index, $num, $value)
733 while ($num-- > 0) $ret[$start_index++] = $value;
738 // md5_file -- Calculates the md5 hash of a given filename
740 if (! function_exists('md5_file')) {
742 function md5_file($filename)
744 if (! file_exists($filename)) return FALSE;
746 $fd = fopen($filename, 'rb');
747 if ($fd === FALSE ) return FALSE;
748 $data = fread($fd, filesize($filename));
754 // sha1 -- Compute SHA-1 hash
755 // (PHP 4 >= 4.3.0, PHP5)
756 if (! function_exists('sha1')) {
757 if (extension_loaded('mhash')) {
760 return bin2hex(mhash(MHASH_SHA1, $str));
763 function sha1($str, $raw_output = FALSE)
765 die('Function sha1() not found and extension \'mhash\' not exists');