2 // PukiWiki - Yet another WikiWikiWeb clone.
3 // $Id: func.php,v 1.47 2005/11/20 05:31:17 henoheno Exp $
5 // 2002-2005 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 function auto_template($page)
98 global $auto_template_func, $auto_template_rules;
100 if (! $auto_template_func) return '';
104 foreach ($auto_template_rules as $rule => $template) {
105 $rule_pattrn = '/' . $rule . '/';
107 if (! preg_match($rule_pattrn, $page, $matches)) continue;
109 $template_page = preg_replace($rule_pattrn, $template, $page);
110 if (! is_page($template_page)) continue;
112 $body = join('', get_source($template_page));
114 // Remove fixed-heading anchors
115 $body = preg_replace('/^(\*{1,3}.*)\[#[A-Za-z][\w-]+\](.*)$/m', '$1$2', $body);
118 $body = preg_replace('/^#freeze\s*$/m', '', $body);
120 $count = count($matches);
121 for ($i = 0; $i < $count; $i++)
122 $body = str_replace('$' . $i, $matches[$i], $body);
129 // Expand all search-words to regexes and push them into an array
130 function get_search_words($words = array(), $do_escape = FALSE)
132 static $init, $mb_convert_kana, $pre, $post, $quote = '/';
134 if (! is_array($words)) $words = array($words);
136 if (! isset($init)) {
137 // function: mb_convert_kana() is for Japanese code only
138 if (LANG == 'ja' && function_exists('mb_convert_kana')) {
139 $mb_convert_kana = create_function('$str, $option',
140 'return mb_convert_kana($str, $option);');
142 $mb_convert_kana = create_function('$str, $option',
145 if (SOURCE_ENCODING == 'EUC-JP') {
146 // Perl memo - Correct pattern-matching with EUC-JP
147 // http://www.din.or.jp/~ohzaki/perl.htm#JP_Match (Japanese)
149 $post = '(?=(?:[\xA1-\xFE][\xA1-\xFE])*' . // JIS X 0208
150 '(?:[\x00-\x7F\x8E\x8F]|\z))'; // ASCII, SS2, SS3, or the last
157 // Generate regex for the words
159 foreach ($words as $word) {
161 if ($word == '') continue;
163 // Normalize: ASCII letters = to single-byte. Others = to Zenkaku and Katakana
164 $word_nm = $mb_convert_kana($word, 'aKCV');
165 $nmlen = mb_strlen($word_nm);
167 // Each chars may be served ...
169 for ($pos = 0; $pos < $nmlen; $pos++) {
170 $char = mb_substr($word_nm, $pos, 1);
172 // Just normalized one? (ASCII char or Zenkaku-Katakana?)
173 $or = array(preg_quote($do_escape ? htmlspecialchars($char) : $char, $quote));
174 if (strlen($char) == 1) {
175 // An ASCII (single-byte) character
176 foreach (array(strtoupper($char), strtolower($char)) as $_char) {
177 if ($char != '&') $or[] = preg_quote($_char, $quote); // As-is?
178 $ascii = ord($_char);
179 $or[] = sprintf('&#(?:%d|x%x);', $ascii, $ascii); // As an entity reference?
180 $or[] = preg_quote($mb_convert_kana($_char, 'A'), $quote); // As Zenkaku?
183 // A multi-byte character
184 $or[] = preg_quote($mb_convert_kana($char, 'c'), $quote); // As Hiragana?
185 $or[] = preg_quote($mb_convert_kana($char, 'k'), $quote); // As Hankaku-Katakana?
187 $chars[] = '(?:' . join('|', array_unique($or)) . ')'; // Regex for the character
190 $regex[$word] = $pre . join('', $chars) . $post; // For the word
193 return $regex; // For all words
196 // 'Search' main function
197 function do_search($word, $type = 'AND', $non_format = FALSE)
199 global $script, $whatsnew, $non_list, $search_non_list;
200 global $_msg_andresult, $_msg_orresult, $_msg_notfoundresult;
205 $b_type = ($type == 'AND'); // AND:TRUE OR:FALSE
206 $keys = get_search_words(preg_split('/\s+/', $word, -1, PREG_SPLIT_NO_EMPTY));
208 $_pages = get_existpages();
211 $non_list_pattern = '/' . $non_list . '/';
212 foreach ($_pages as $page) {
213 if ($page == $whatsnew || (! $search_non_list && preg_match($non_list_pattern, $page)))
216 // ¸¡º÷Âоݥڡ¼¥¸¤ÎÀ©¸Â¤ò¤«¤±¤ë¤«¤É¤¦¤« (¥Ú¡¼¥¸Ì¾¤ÏÀ©¸Â³°)
217 if ($search_auth && ! check_readable($page, false, false)) {
218 $source = get_source(); // Empty
220 $source = get_source($page);
223 array_unshift($source, $page); // ¥Ú¡¼¥¸Ì¾¤â¸¡º÷ÂоݤË
226 foreach ($keys as $key) {
227 $tmp = preg_grep('/' . $key . '/', $source);
228 $b_match = ! empty($tmp);
229 if ($b_match xor $b_type) break;
231 if ($b_match) $pages[$page] = get_filetime($page);
233 if ($non_format) return array_keys($pages);
235 $r_word = rawurlencode($word);
236 $s_word = htmlspecialchars($word);
238 return str_replace('$1', $s_word, $_msg_notfoundresult);
241 $retval = '<ul>' . "\n";
242 foreach ($pages as $page=>$time) {
243 $r_page = rawurlencode($page);
244 $s_page = htmlspecialchars($page);
245 $passage = get_passage($time);
246 $retval .= ' <li><a href="' . $script . '?cmd=read&page=' .
247 $r_page . '&word=' . $r_word . '">' . $s_page .
248 '</a>' . $passage . '</li>' . "\n";
250 $retval .= '</ul>' . "\n";
252 $retval .= str_replace('$1', $s_word, str_replace('$2', count($pages),
253 str_replace('$3', count($_pages), $b_type ? $_msg_andresult : $_msg_orresult)));
258 // Argument check for program
259 function arg_check($str)
262 return isset($vars['cmd']) && (strpos($vars['cmd'], $str) === 0);
266 function encode($key)
268 return ($key == '') ? '' : strtoupper(bin2hex($key));
269 // Equal to strtoupper(join('', unpack('H*0', $key)));
270 // But PHP 4.3.10 says 'Warning: unpack(): Type H: outside of string in ...'
274 function decode($key)
276 return hex2bin($key);
279 // Inversion of bin2hex()
280 function hex2bin($hex_string)
282 // preg_match : Avoid warning : pack(): Type H: illegal hex digit ...
283 // (string) : Always treat as string (not int etc). See BugTrack2/31
284 return preg_match('/^[0-9a-f]+$/i', $hex_string) ?
285 pack('H*', (string)$hex_string) : $hex_string;
288 // Remove [[ ]] (brackets)
289 function strip_bracket($str)
292 if (preg_match('/^\[\[(.*)\]\]$/', $str, $match)) {
299 // Create list of pages
300 function page_list($pages, $cmd = 'read', $withfilename = FALSE)
302 global $script, $list_index;
303 global $_msg_symbol, $_msg_other;
304 global $pagereading_enable;
306 // ¥½¡¼¥È¥¡¼¤ò·èÄꤹ¤ë¡£ ' ' < '[a-zA-Z]' < 'zz'¤È¤¤¤¦Á°Äó¡£
312 if($pagereading_enable) {
313 mb_regex_encoding(SOURCE_ENCODING);
314 $readings = get_readings($pages);
317 $list = $matches = array();
319 // Shrink URI for read
320 if ($cmd == 'read') {
321 $href = $script . '?';
323 $href = $script . '?cmd=' . $cmd . '&page=';
326 foreach($pages as $file=>$page) {
327 $r_page = rawurlencode($page);
328 $s_page = htmlspecialchars($page, ENT_QUOTES);
329 $passage = get_pg_passage($page);
331 $str = ' <li><a href="' . $href . $r_page . '">' .
332 $s_page . '</a>' . $passage;
335 $s_file = htmlspecialchars($file);
336 $str .= "\n" . ' <ul><li>' . $s_file . '</li></ul>' .
341 // WARNING: Japanese code hard-wired
342 if($pagereading_enable) {
343 if(mb_ereg('^([A-Za-z])', mb_convert_kana($page, 'a'), $matches)) {
345 } elseif (isset($readings[$page]) && mb_ereg('^([¥¡-¥ö])', $readings[$page], $matches)) { // here
347 } elseif (mb_ereg('^[ -~]|[^¤¡-¤ó°¡-ô¦]', $page)) { // and here
353 $head = (preg_match('/^([A-Za-z])/', $page, $matches)) ? $matches[1] :
354 (preg_match('/^([ -~])/', $page, $matches) ? $symbol : $other);
357 $list[$head][$page] = $str;
362 $arr_index = array();
363 $retval .= '<ul>' . "\n";
364 foreach ($list as $head=>$pages) {
365 if ($head === $symbol) {
366 $head = $_msg_symbol;
367 } else if ($head === $other) {
373 $arr_index[] = '<a id="top_' . $cnt .
374 '" href="#head_' . $cnt . '"><strong>' .
375 $head . '</strong></a>';
376 $retval .= ' <li><a id="head_' . $cnt . '" href="#top_' . $cnt .
377 '"><strong>' . $head . '</strong></a>' . "\n" .
381 $retval .= join("\n", $pages);
383 $retval .= "\n </ul>\n </li>\n";
385 $retval .= '</ul>' . "\n";
386 if ($list_index && $cnt > 0) {
388 while (! empty($arr_index))
389 $top[] = join(' | ' . "\n", array_splice($arr_index, 0, 16)) . "\n";
391 $retval = '<div id="top" style="text-align:center">' . "\n" .
392 join('<br />', $top) . '</div>' . "\n" . $retval;
397 // Show text formatting rules
402 if (! is_page($rule_page)) {
403 return '<p>Sorry, page \'' . htmlspecialchars($rule_page) .
404 '\' unavailable.</p>';
406 return convert_html(get_source($rule_page));
410 // Show (critical) error message
411 function die_message($msg)
413 $title = $page = 'Runtime error';
415 <h3>Runtime error</h3>
416 <strong>Error message : $msg</strong>
419 pkwk_common_headers();
420 if(defined('SKIN_FILE') && file_exists(SKIN_FILE) && is_readable(SKIN_FILE)) {
421 catbody($title, $page, $body);
423 header('Content-Type: text/html; charset=euc-jp');
425 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
428 <title>$title</title>
429 <meta http-equiv="content-type" content="text/html; charset=euc-jp">
440 // Have the time (as microtime)
441 function getmicrotime()
443 list($usec, $sec) = explode(' ', microtime());
444 return ((float)$sec + (float)$usec);
448 function get_date($format, $timestamp = NULL)
450 $format = preg_replace('/(?<!\\\)T/',
451 preg_replace('/(.)/', '\\\$1', ZONE), $format);
453 $time = ZONETIME + (($timestamp !== NULL) ? $timestamp : UTIME);
455 return date($format, $time);
458 // Format date string
459 function format_date($val, $paren = FALSE)
461 global $date_format, $time_format, $weeklabels;
465 $date = date($date_format, $val) .
466 ' (' . $weeklabels[date('w', $val)] . ') ' .
467 date($time_format, $val);
469 return $paren ? '(' . $date . ')' : $date;
472 // Get short string of the passage, 'N seconds/minutes/hours/days/years ago'
473 function get_passage($time, $paren = TRUE)
475 static $units = array('m'=>60, 'h'=>24, 'd'=>1);
477 $time = max(0, (UTIME - $time) / 60); // minutes
479 foreach ($units as $unit=>$card) {
480 if ($time < $card) break;
483 $time = floor($time) . $unit;
485 return $paren ? '(' . $time . ')' : $time;
488 // Hide <input type="(submit|button|image)"...>
489 function drop_submit($str)
491 return preg_replace('/<input([^>]+)type="(submit|button|image)"/i',
492 '<input$1type="hidden"', $str);
495 // Generate AutoLink patterns (thx to hirofummy)
496 function get_autolink_pattern(& $pages)
498 global $WikiName, $autolink, $nowikiname;
500 $config = &new Config('AutoLink');
502 $ignorepages = $config->get('IgnoreList');
503 $forceignorepages = $config->get('ForceIgnoreList');
505 $auto_pages = array_merge($ignorepages, $forceignorepages);
507 foreach ($pages as $page)
508 if (preg_match('/^' . $WikiName . '$/', $page) ?
509 $nowikiname : strlen($page) >= $autolink)
510 $auto_pages[] = $page;
512 if (empty($auto_pages)) {
513 $result = $result_a = $nowikiname ? '(?!)' : $WikiName;
515 $auto_pages = array_unique($auto_pages);
516 sort($auto_pages, SORT_STRING);
518 $auto_pages_a = array_values(preg_grep('/^[A-Z]+$/i', $auto_pages));
519 $auto_pages = array_values(array_diff($auto_pages, $auto_pages_a));
521 $result = get_autolink_pattern_sub($auto_pages, 0, count($auto_pages), 0);
522 $result_a = get_autolink_pattern_sub($auto_pages_a, 0, count($auto_pages_a), 0);
524 return array($result, $result_a, $forceignorepages);
527 function get_autolink_pattern_sub(& $pages, $start, $end, $pos)
529 if ($end == 0) return '(?!)';
532 $count = $i = $j = 0;
533 $x = (mb_strlen($pages[$start]) <= $pos);
536 for ($i = $start; $i < $end; $i = $j) {
537 $char = mb_substr($pages[$i], $pos, 1);
538 for ($j = $i; $j < $end; $j++)
539 if (mb_substr($pages[$j], $pos, 1) != $char) break;
541 if ($i != $start) $result .= '|';
542 if ($i >= ($j - 1)) {
543 $result .= str_replace(' ', '\\ ', preg_quote(mb_substr($pages[$i], $pos), '/'));
545 $result .= str_replace(' ', '\\ ', preg_quote($char, '/')) .
546 get_autolink_pattern_sub($pages, $i, $j, $pos + 1);
550 if ($x || $count > 1) $result = '(?:' . $result . ')';
551 if ($x) $result .= '?';
556 // Get absolute-URI of this script
557 function get_script_uri($init_uri = '')
559 global $script_directory_index;
562 if ($init_uri == '') {
564 if (isset($script)) return $script;
567 $msg = 'get_script_uri() failed: Please set $script at INI_FILE manually';
569 $script = (SERVER_PORT == 443 ? 'https://' : 'http://'); // scheme
570 $script .= SERVER_NAME; // host
571 $script .= (SERVER_PORT == 80 ? '' : ':' . SERVER_PORT); // port
573 // SCRIPT_NAME ¤¬'/'¤Ç»Ï¤Þ¤Ã¤Æ¤¤¤Ê¤¤¾ì¹ç(cgi¤Ê¤É) REQUEST_URI¤ò»È¤Ã¤Æ¤ß¤ë
575 if ($path{0} != '/') {
576 if (! isset($_SERVER['REQUEST_URI']) || $_SERVER['REQUEST_URI']{0} != '/')
579 // REQUEST_URI¤ò¥Ñ¡¼¥¹¤·¡¢pathÉôʬ¤À¤±¤ò¼è¤ê½Ð¤¹
580 $parse_url = parse_url($script . $_SERVER['REQUEST_URI']);
581 if (! isset($parse_url['path']) || $parse_url['path']{0} != '/')
584 $path = $parse_url['path'];
588 if (! is_url($script, TRUE) && php_sapi_name() == 'cgi')
594 if (isset($script)) die_message('$script: Already init');
595 if (! is_url($init_uri, TRUE)) die_message('$script: Invalid URI');
599 // Cut filename or not
600 if (isset($script_directory_index)) {
601 if (! file_exists($script_directory_index))
602 die_message('Directory index file not found: ' .
603 htmlspecialchars($script_directory_index));
605 if (preg_match('#^(.+/)' . preg_quote($script_directory_index, '#') . '$#',
606 $script, $matches)) $script = $matches[1];
612 // Remove null(\0) bytes from variables
614 // NOTE: PHP had vulnerabilities that opens "hoge.php" via fopen("hoge.php\0.txt") etc.
615 // [PHP-users 12736] null byte attack
616 // http://ns1.php.gr.jp/pipermail/php-users/2003-January/012742.html
618 // 2003-05-16: magic quotes gpc¤ÎÉü¸µ½èÍý¤òÅý¹ç
619 // 2003-05-21: Ï¢ÁÛÇÛÎó¤Î¥¡¼¤Ïbinary safe
621 function input_filter($param)
623 static $magic_quotes_gpc = NULL;
624 if ($magic_quotes_gpc === NULL)
625 $magic_quotes_gpc = get_magic_quotes_gpc();
627 if (is_array($param)) {
628 return array_map('input_filter', $param);
630 $result = str_replace("\0", '', $param);
631 if ($magic_quotes_gpc) $result = stripslashes($result);
636 // Compat for 3rd party plugins. Remove this later
637 function sanitize($param) {
638 return input_filter($param);
641 // Explode Comma-Separated Values to an array
642 function csv_explode($separator, $string)
644 $retval = $matches = array();
646 $_separator = preg_quote($separator, '/');
647 if (! preg_match_all('/("[^"]*(?:""[^"]*)*"|[^' . $_separator . ']*)' .
648 $_separator . '/', $string . $separator, $matches))
651 foreach ($matches[1] as $str) {
653 if ($len > 1 && $str{0} == '"' && $str{$len - 1} == '"')
654 $str = str_replace('""', '"', substr($str, 1, -1));
660 // Implode an array with CSV data format (escape double quotes)
661 function csv_implode($glue, $pieces)
663 $_glue = ($glue != '') ? '\\' . $glue{0} : '';
665 foreach ($pieces as $str) {
666 if (ereg('[' . $_glue . '"' . "\n\r" . ']', $str))
667 $str = '"' . str_replace('"', '""', $str) . '"';
670 return join($glue, $arr);
675 // is_a -- Returns TRUE if the object is of this class or has this class as one of its parents
677 if (! function_exists('is_a')) {
679 function is_a($class, $match)
681 if (empty($class)) return FALSE;
683 $class = is_object($class) ? get_class($class) : $class;
684 if (strtolower($class) == strtolower($match)) {
687 return is_a(get_parent_class($class), $match); // Recurse
692 // array_fill -- Fill an array with values
694 if (! function_exists('array_fill')) {
696 function array_fill($start_index, $num, $value)
699 while ($num-- > 0) $ret[$start_index++] = $value;
704 // md5_file -- Calculates the md5 hash of a given filename
706 if (! function_exists('md5_file')) {
708 function md5_file($filename)
710 if (! file_exists($filename)) return FALSE;
712 $fd = fopen($filename, 'rb');
713 if ($fd === FALSE ) return FALSE;
714 $data = fread($fd, filesize($filename));
720 // sha1 -- Compute SHA-1 hash
721 // (PHP 4 >= 4.3.0, PHP5)
722 if (! function_exists('sha1')) {
723 if (extension_loaded('mhash')) {
724 function sha1($str, $raw_output = FALSE)
727 // PHP 5.0.0 or lator only :)
728 return mhash(MHASH_SHA1, $str);
730 return bin2hex(mhash(MHASH_SHA1, $str));
734 function sha1($str, $raw_output = FALSE)
736 die('Function sha1() not found and extension \'mhash\' not exists');