2 // PukiWiki - Yet another WikiWikiWeb clone.
3 // $Id: func.php,v 1.104 2011/01/25 15:01:01 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: ' . htmlsc($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: ' . htmlsc($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 ? htmlsc($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, $non_list, $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';
223 $pages = get_existpages();
227 $pages = preg_grep('/^' . preg_quote($base, '/') . '/S', $pages);
229 if (! $search_non_list) {
230 $pages = array_diff($pages, preg_grep('/' . $non_list . '/S', $pages));
232 $pages = array_flip($pages);
233 unset($pages[$whatsnew]);
235 $count = count($pages);
236 foreach (array_keys($pages) as $page) {
239 // Search for page name
241 foreach ($keys as $key) {
242 $b_match = preg_match($key, $page);
243 if ($b_type xor $b_match) break; // OR
245 if ($b_match) continue;
248 // Search auth for page contents
249 if ($search_auth && ! check_readable($page, false, false)) {
250 unset($pages[$page]);
254 // Search for page contents
255 foreach ($keys as $key) {
256 $b_match = preg_match($key, get_source($page, TRUE, TRUE));
257 if ($b_type xor $b_match) break; // OR
259 if ($b_match) continue;
261 unset($pages[$page]); // Miss
263 if ($non_format) return array_keys($pages);
265 $r_word = rawurlencode($word);
266 $s_word = htmlsc($word);
268 return str_replace('$1', $s_word, $_msg_notfoundresult);
270 ksort($pages, SORT_STRING);
272 $retval = '<ul>' . "\n";
273 foreach (array_keys($pages) as $page) {
274 $r_page = rawurlencode($page);
275 $s_page = htmlsc($page);
276 $passage = $show_passage ? ' ' . get_passage(get_filetime($page)) : '';
277 $retval .= ' <li><a href="' . $script . '?cmd=read&page=' .
278 $r_page . '&word=' . $r_word . '">' . $s_page .
279 '</a>' . $passage . '</li>' . "\n";
281 $retval .= '</ul>' . "\n";
283 $retval .= str_replace('$1', $s_word, str_replace('$2', count($pages),
284 str_replace('$3', $count, $b_type ? $_msg_andresult : $_msg_orresult)));
289 // Argument check for program
290 function arg_check($str)
293 return isset($vars['cmd']) && (strpos($vars['cmd'], $str) === 0);
296 function _pagename_urlencode_callback($matches)
298 return rawurlencode($matches[0]);
301 function pagename_urlencode($page)
303 return preg_replace_callback('|[^/:]+|', '_pagename_urlencode_callback', $page);
307 function encode($str)
310 return ($str == '') ? '' : strtoupper(bin2hex($str));
311 // Equal to strtoupper(join('', unpack('H*0', $key)));
312 // But PHP 4.3.10 says 'Warning: unpack(): Type H: outside of string in ...'
316 function decode($str)
318 return pkwk_hex2bin($str);
321 // Inversion of bin2hex()
322 function pkwk_hex2bin($hex_string)
324 // preg_match : Avoid warning : pack(): Type H: illegal hex digit ...
325 // (string) : Always treat as string (not int etc). See BugTrack2/31
326 return preg_match('/^[0-9a-f]+$/i', $hex_string) ?
327 pack('H*', (string)$hex_string) : $hex_string;
330 // Remove [[ ]] (brackets)
331 function strip_bracket($str)
334 if (preg_match('/^\[\[(.*)\]\]$/', $str, $match)) {
341 // Create list of pages
342 function page_list($pages, $cmd = 'read', $withfilename = FALSE)
344 global $script, $list_index;
345 global $_msg_symbol, $_msg_other;
346 global $pagereading_enable;
348 // ソートキーを決定する。 ' ' < '[a-zA-Z]' < 'zz'という前提。
354 if($pagereading_enable) {
355 mb_regex_encoding(SOURCE_ENCODING);
356 $readings = get_readings($pages);
359 $list = $matches = array();
361 // Shrink URI for read
362 if ($cmd == 'read') {
363 $href = $script . '?';
365 $href = $script . '?cmd=' . $cmd . '&page=';
368 foreach($pages as $file=>$page) {
369 $r_page = pagename_urlencode($page);
370 $s_page = htmlsc($page, ENT_QUOTES);
371 $passage = get_pg_passage($page);
373 $str = ' <li><a href="' . $href . $r_page . '">' .
374 $s_page . '</a>' . $passage;
377 $s_file = htmlsc($file);
378 $str .= "\n" . ' <ul><li>' . $s_file . '</li></ul>' .
383 // WARNING: Japanese code hard-wired
384 if($pagereading_enable) {
385 if(mb_ereg('^([A-Za-z])', mb_convert_kana($page, 'a'), $matches)) {
387 } elseif (isset($readings[$page]) && mb_ereg('^([ァ-ヶ])', $readings[$page], $matches)) { // here
389 } elseif (mb_ereg('^[ -~]|[^ぁ-ん亜-熙]', $page)) { // and here
395 $head = (preg_match('/^([A-Za-z])/', $page, $matches)) ? $matches[1] :
396 (preg_match('/^([ -~])/', $page) ? $symbol : $other);
399 $list[$head][$page] = $str;
401 ksort($list, SORT_STRING);
404 $arr_index = array();
405 $retval .= '<ul>' . "\n";
406 foreach ($list as $head=>$pages) {
407 if ($head === $symbol) {
408 $head = $_msg_symbol;
409 } else if ($head === $other) {
415 $arr_index[] = '<a id="top_' . $cnt .
416 '" href="#head_' . $cnt . '"><strong>' .
417 $head . '</strong></a>';
418 $retval .= ' <li><a id="head_' . $cnt . '" href="#top_' . $cnt .
419 '"><strong>' . $head . '</strong></a>' . "\n" .
422 ksort($pages, SORT_STRING);
423 $retval .= join("\n", $pages);
425 $retval .= "\n </ul>\n </li>\n";
427 $retval .= '</ul>' . "\n";
428 if ($list_index && $cnt > 0) {
430 while (! empty($arr_index))
431 $top[] = join(' | ' . "\n", array_splice($arr_index, 0, 16)) . "\n";
433 $retval = '<div id="top" style="text-align:center">' . "\n" .
434 join('<br />', $top) . '</div>' . "\n" . $retval;
439 // Show text formatting rules
444 if (! is_page($rule_page)) {
445 return '<p>Sorry, page \'' . htmlsc($rule_page) .
446 '\' unavailable.</p>';
448 return convert_html(get_source($rule_page));
452 // Show (critical) error message
453 function die_message($msg)
455 $title = $page = 'Runtime error';
457 <h3>Runtime error</h3>
458 <strong>Error message : $msg</strong>
461 pkwk_common_headers();
462 if(defined('SKIN_FILE') && file_exists(SKIN_FILE) && is_readable(SKIN_FILE)) {
463 catbody($title, $page, $body);
465 header('Content-Type: text/html; charset=euc-jp');
467 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
470 <title>$title</title>
471 <meta http-equiv="content-type" content="text/html; charset=euc-jp">
482 // Have the time (as microtime)
483 function getmicrotime()
485 list($usec, $sec) = explode(' ', microtime());
486 return ((float)$sec + (float)$usec);
489 // Elapsed time by second
490 //define('MUTIME', getmicrotime());
491 function elapsedtime()
493 $at_the_microtime = MUTIME;
494 return sprintf('%01.03f', getmicrotime() - $at_the_microtime);
498 function get_date($format, $timestamp = NULL)
500 $format = preg_replace('/(?<!\\\)T/',
501 preg_replace('/(.)/', '\\\$1', ZONE), $format);
503 $time = ZONETIME + (($timestamp !== NULL) ? $timestamp : UTIME);
505 return date($format, $time);
508 // Format date string
509 function format_date($val, $paren = FALSE)
511 global $date_format, $time_format, $weeklabels;
515 $date = date($date_format, $val) .
516 ' (' . $weeklabels[date('w', $val)] . ') ' .
517 date($time_format, $val);
519 return $paren ? '(' . $date . ')' : $date;
522 // Get short string of the passage, 'N seconds/minutes/hours/days/years ago'
523 function get_passage($time, $paren = TRUE)
525 static $units = array('m'=>60, 'h'=>24, 'd'=>1);
527 $time = max(0, (UTIME - $time) / 60); // minutes
529 foreach ($units as $unit=>$card) {
530 if ($time < $card) break;
533 $time = floor($time) . $unit;
535 return $paren ? '(' . $time . ')' : $time;
538 // Hide <input type="(submit|button|image)"...>
539 function drop_submit($str)
541 return preg_replace('/<input([^>]+)type="(submit|button|image)"/i',
542 '<input$1type="hidden"', $str);
545 // Generate AutoLink patterns (thx to hirofummy)
546 function get_autolink_pattern(& $pages)
548 global $WikiName, $autolink, $nowikiname;
550 $config = new Config('AutoLink');
552 $ignorepages = $config->get('IgnoreList');
553 $forceignorepages = $config->get('ForceIgnoreList');
555 $auto_pages = array_merge($ignorepages, $forceignorepages);
557 foreach ($pages as $page)
558 if (preg_match('/^' . $WikiName . '$/', $page) ?
559 $nowikiname : strlen($page) >= $autolink)
560 $auto_pages[] = $page;
562 if (empty($auto_pages)) {
563 $result = $result_a = $nowikiname ? '(?!)' : $WikiName;
565 $auto_pages = array_unique($auto_pages);
566 sort($auto_pages, SORT_STRING);
568 $auto_pages_a = array_values(preg_grep('/^[A-Z]+$/i', $auto_pages));
569 $auto_pages = array_values(array_diff($auto_pages, $auto_pages_a));
571 $result = get_autolink_pattern_sub($auto_pages, 0, count($auto_pages), 0);
572 $result_a = get_autolink_pattern_sub($auto_pages_a, 0, count($auto_pages_a), 0);
574 return array($result, $result_a, $forceignorepages);
577 function get_autolink_pattern_sub(& $pages, $start, $end, $pos)
579 if ($end == 0) return '(?!)';
582 $count = $i = $j = 0;
583 $x = (mb_strlen($pages[$start]) <= $pos);
586 for ($i = $start; $i < $end; $i = $j) {
587 $char = mb_substr($pages[$i], $pos, 1);
588 for ($j = $i; $j < $end; $j++)
589 if (mb_substr($pages[$j], $pos, 1) != $char) break;
591 if ($i != $start) $result .= '|';
592 if ($i >= ($j - 1)) {
593 $result .= str_replace(' ', '\\ ', preg_quote(mb_substr($pages[$i], $pos), '/'));
595 $result .= str_replace(' ', '\\ ', preg_quote($char, '/')) .
596 get_autolink_pattern_sub($pages, $i, $j, $pos + 1);
600 if ($x || $count > 1) $result = '(?:' . $result . ')';
601 if ($x) $result .= '?';
606 // Get absolute-URI of this script
607 function get_script_uri($init_uri = '')
609 global $script_directory_index;
612 if ($init_uri == '') {
614 if (isset($script)) return $script;
617 $msg = 'get_script_uri() failed: Please set $script at INI_FILE manually';
619 $script = (SERVER_PORT == 443 ? 'https://' : 'http://'); // scheme
620 $script .= SERVER_NAME; // host
621 $script .= (SERVER_PORT == 80 ? '' : ':' . SERVER_PORT); // port
623 // SCRIPT_NAME が'/'で始まっていない場合(cgiなど) REQUEST_URIを使ってみる
625 if ($path{0} != '/') {
626 if (! isset($_SERVER['REQUEST_URI']) || $_SERVER['REQUEST_URI']{0} != '/')
629 // REQUEST_URIをパースし、path部分だけを取り出す
630 $parse_url = parse_url($script . $_SERVER['REQUEST_URI']);
631 if (! isset($parse_url['path']) || $parse_url['path']{0} != '/')
634 $path = $parse_url['path'];
638 if (! is_url($script, TRUE) && php_sapi_name() == 'cgi')
644 if (isset($script)) die_message('$script: Already init');
645 if (! is_url($init_uri, TRUE)) die_message('$script: Invalid URI');
649 // Cut filename or not
650 if (isset($script_directory_index)) {
651 if (! file_exists($script_directory_index))
652 die_message('Directory index file not found: ' .
653 htmlsc($script_directory_index));
655 if (preg_match('#^(.+/)' . preg_quote($script_directory_index, '#') . '$#',
656 $script, $matches)) $script = $matches[1];
662 // Remove null(\0) bytes from variables
664 // NOTE: PHP had vulnerabilities that opens "hoge.php" via fopen("hoge.php\0.txt") etc.
665 // [PHP-users 12736] null byte attack
666 // http://ns1.php.gr.jp/pipermail/php-users/2003-January/012742.html
668 // 2003-05-16: magic quotes gpcの復元処理を統合
669 // 2003-05-21: 連想配列のキーはbinary safe
671 function input_filter($param)
673 static $magic_quotes_gpc = NULL;
674 if ($magic_quotes_gpc === NULL)
675 $magic_quotes_gpc = get_magic_quotes_gpc();
677 if (is_array($param)) {
678 return array_map('input_filter', $param);
680 $result = str_replace("\0", '', $param);
681 if ($magic_quotes_gpc) $result = stripslashes($result);
686 // Compat for 3rd party plugins. Remove this later
687 function sanitize($param) {
688 return input_filter($param);
691 // Explode Comma-Separated Values to an array
692 function csv_explode($separator, $string)
694 $retval = $matches = array();
696 $_separator = preg_quote($separator, '/');
697 if (! preg_match_all('/("[^"]*(?:""[^"]*)*"|[^' . $_separator . ']*)' .
698 $_separator . '/', $string . $separator, $matches))
701 foreach ($matches[1] as $str) {
703 if ($len > 1 && $str{0} == '"' && $str{$len - 1} == '"')
704 $str = str_replace('""', '"', substr($str, 1, -1));
710 // Implode an array with CSV data format (escape double quotes)
711 function csv_implode($glue, $pieces)
713 $_glue = ($glue != '') ? '\\' . $glue{0} : '';
715 foreach ($pieces as $str) {
716 if (preg_match('/[' . '"' . "\n\r" . $_glue . ']/', $str))
717 $str = '"' . str_replace('"', '""', $str) . '"';
720 return join($glue, $arr);
723 // Sugar with default settings
724 function htmlsc($string = '', $flags = ENT_COMPAT, $charset = CONTENT_CHARSET)
726 return htmlspecialchars($string, $flags, $charset); // htmlsc()
732 // is_a -- Returns TRUE if the object is of this class or has this class as one of its parents
734 if (! function_exists('is_a')) {
736 function is_a($class, $match)
738 if (empty($class)) return FALSE;
740 $class = is_object($class) ? get_class($class) : $class;
741 if (strtolower($class) == strtolower($match)) {
744 return is_a(get_parent_class($class), $match); // Recurse
749 // array_fill -- Fill an array with values
751 if (! function_exists('array_fill')) {
753 function array_fill($start_index, $num, $value)
756 while ($num-- > 0) $ret[$start_index++] = $value;
761 // md5_file -- Calculates the md5 hash of a given filename
763 if (! function_exists('md5_file')) {
765 function md5_file($filename)
767 if (! file_exists($filename)) return FALSE;
769 $fd = fopen($filename, 'rb');
770 if ($fd === FALSE ) return FALSE;
771 $data = fread($fd, filesize($filename));
777 // sha1 -- Compute SHA-1 hash
778 // (PHP 4 >= 4.3.0, PHP5)
779 if (! function_exists('sha1')) {
780 if (extension_loaded('mhash')) {
783 return bin2hex(mhash(MHASH_SHA1, $str));