2 // PukiWiki - Yet another WikiWikiWeb clone.
3 // $Id: func.php,v 1.44 2005/06/04 12:20:58 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 search words
130 function get_search_words($words, $do_escape = FALSE)
135 if (SOURCE_ENCODING == 'EUC-JP') {
136 // Perl memo - Correct pattern-matching with EUC-JP
137 // http://www.din.or.jp/~ohzaki/perl.htm#JP_Match (Japanese)
139 $post = '(?=(?:[\xA1-\xFE][\xA1-\xFE])*' . // JIS X 0208
140 '(?:[\x00-\x7F\x8E\x8F]|\z))'; // ASCII, SS2, SS3, or the last
143 // function: just preg_quote()
144 $quote_func = create_function('$str', 'return preg_quote($str, \'/\');');
146 // function: mb_convert_kana() or nothing
147 $convert_kana = create_function('$str, $option',
148 (LANG == 'ja' && function_exists('mb_convert_kana')) ?
149 'return mb_convert_kana($str, $option);' : 'return $str;');
151 foreach ($words as $word) {
152 // 'a': Zenkaku-Alphabet to Hankaku-Alphabet
153 // 'K': Hankaku-Katakana to Zenkaku-Katakana
154 // 'C': Zenkaku-Hiragana to Zenkaku-Katakana
155 // 'V': Merge 'A character and A voiced sound symbol' to 'A character with the symbol'
156 $word_zk = $convert_kana($word, 'aKCV');
157 $len = mb_strlen($word_zk);
159 for ($pos = 0; $pos < $len; $pos++) {
160 $char = mb_substr($word_zk, $pos, 1);
161 $arr = array($quote_func($do_escape ? htmlspecialchars($char) : $char));
162 if (strlen($char) == 1) {
163 // Single-byte characters
164 foreach (array(strtoupper($char), strtolower($char)) as $_char) {
165 if ($char != '&') $arr[] = $quote_func($_char);
167 $arr[] = sprintf('&#(?:%d|x%x);', $ord, $ord); // Entity references
168 $arr[] = $quote_func($convert_kana($_char, 'A')); // Zenkaku-Alphabet
171 // Multi-byte characters
172 $arr[] = $quote_func($convert_kana($char, 'c')); // Zenkaku-Katakana to Zenkaku-Hiragana
173 $arr[] = $quote_func($convert_kana($char, 'k')); // Zenkaku-Katakana to Hankaku-Katakana
175 $chars[] = '(?:' . join('|', array_unique($arr)) . ')';
177 $retval[$word] = $pre . join('', $chars) . $post;
183 // 'Search' main function
184 function do_search($word, $type = 'AND', $non_format = FALSE)
186 global $script, $whatsnew, $non_list, $search_non_list;
187 global $_msg_andresult, $_msg_orresult, $_msg_notfoundresult;
192 $b_type = ($type == 'AND'); // AND:TRUE OR:FALSE
193 $keys = get_search_words(preg_split('/\s+/', $word, -1, PREG_SPLIT_NO_EMPTY));
195 $_pages = get_existpages();
198 $non_list_pattern = '/' . $non_list . '/';
199 foreach ($_pages as $page) {
200 if ($page == $whatsnew || (! $search_non_list && preg_match($non_list_pattern, $page)))
203 // ¸¡º÷Âоݥڡ¼¥¸¤ÎÀ©¸Â¤ò¤«¤±¤ë¤«¤É¤¦¤« (¥Ú¡¼¥¸Ì¾¤ÏÀ©¸Â³°)
204 if ($search_auth && ! check_readable($page, false, false)) {
205 $source = get_source(); // Empty
207 $source = get_source($page);
210 array_unshift($source, $page); // ¥Ú¡¼¥¸Ì¾¤â¸¡º÷ÂоݤË
213 foreach ($keys as $key) {
214 $tmp = preg_grep('/' . $key . '/', $source);
215 $b_match = ! empty($tmp);
216 if ($b_match xor $b_type) break;
218 if ($b_match) $pages[$page] = get_filetime($page);
220 if ($non_format) return array_keys($pages);
222 $r_word = rawurlencode($word);
223 $s_word = htmlspecialchars($word);
225 return str_replace('$1', $s_word, $_msg_notfoundresult);
228 $retval = '<ul>' . "\n";
229 foreach ($pages as $page=>$time) {
230 $r_page = rawurlencode($page);
231 $s_page = htmlspecialchars($page);
232 $passage = get_passage($time);
233 $retval .= ' <li><a href="' . $script . '?cmd=read&page=' .
234 $r_page . '&word=' . $r_word . '">' . $s_page .
235 '</a>' . $passage . '</li>' . "\n";
237 $retval .= '</ul>' . "\n";
239 $retval .= str_replace('$1', $s_word, str_replace('$2', count($pages),
240 str_replace('$3', count($_pages), $b_type ? $_msg_andresult : $_msg_orresult)));
245 // Argument check for program
246 function arg_check($str)
249 return isset($vars['cmd']) && (strpos($vars['cmd'], $str) === 0);
253 function encode($key)
255 return ($key == '') ? '' : strtoupper(bin2hex($key));
256 // Equal to strtoupper(join('', unpack('H*0', $key)));
257 // But PHP 4.3.10 says 'Warning: unpack(): Type H: outside of string in ...'
261 function decode($key)
263 return hex2bin($key);
266 // Inversion of bin2hex()
267 function hex2bin($hex_string)
269 // preg_match : Avoid warning : pack(): Type H: illegal hex digit ...
270 // (string) : Always treat as string (not int etc). See BugTrack2/31
271 return preg_match('/^[0-9a-f]+$/i', $hex_string) ?
272 pack('H*', (string)$hex_string) : $hex_string;
275 // Remove [[ ]] (brackets)
276 function strip_bracket($str)
279 if (preg_match('/^\[\[(.*)\]\]$/', $str, $match)) {
286 // Create list of pages
287 function page_list($pages, $cmd = 'read', $withfilename = FALSE)
289 global $script, $list_index;
290 global $_msg_symbol, $_msg_other;
291 global $pagereading_enable;
293 // ¥½¡¼¥È¥¡¼¤ò·èÄꤹ¤ë¡£ ' ' < '[a-zA-Z]' < 'zz'¤È¤¤¤¦Á°Äó¡£
299 if($pagereading_enable) {
300 mb_regex_encoding(SOURCE_ENCODING);
301 $readings = get_readings($pages);
304 $list = $matches = array();
305 foreach($pages as $file=>$page) {
306 $r_page = rawurlencode($page);
307 $s_page = htmlspecialchars($page, ENT_QUOTES);
308 $passage = get_pg_passage($page);
310 $str = ' <li><a href="' .
311 $script . '?cmd=' . $cmd . '&page=' . $r_page .
312 '">' . $s_page . '</a>' . $passage;
315 $s_file = htmlspecialchars($file);
316 $str .= "\n" . ' <ul><li>' . $s_file . '</li></ul>' .
321 // WARNING: Japanese code hard-wired
322 if($pagereading_enable) {
323 if(mb_ereg('^([A-Za-z])', mb_convert_kana($page, 'a'), $matches)) {
325 } elseif (isset($readings[$page]) && mb_ereg('^([¥¡-¥ö])', $readings[$page], $matches)) { // here
327 } elseif (mb_ereg('^[ -~]|[^¤¡-¤ó°¡-ô¦]', $page)) { // and here
333 $head = (preg_match('/^([A-Za-z])/', $page, $matches)) ? $matches[1] :
334 (preg_match('/^([ -~])/', $page, $matches) ? $symbol : $other);
337 $list[$head][$page] = $str;
342 $arr_index = array();
343 $retval .= '<ul>' . "\n";
344 foreach ($list as $head=>$pages) {
345 if ($head === $symbol) {
346 $head = $_msg_symbol;
347 } else if ($head === $other) {
353 $arr_index[] = '<a id="top_' . $cnt .
354 '" href="#head_' . $cnt . '"><strong>' .
355 $head . '</strong></a>';
356 $retval .= ' <li><a id="head_' . $cnt . '" href="#top_' . $cnt .
357 '"><strong>' . $head . '</strong></a>' . "\n" .
361 $retval .= join("\n", $pages);
363 $retval .= "\n </ul>\n </li>\n";
365 $retval .= '</ul>' . "\n";
366 if ($list_index && $cnt > 0) {
368 while (! empty($arr_index))
369 $top[] = join(' | ' . "\n", array_splice($arr_index, 0, 16)) . "\n";
371 $retval = '<div id="top" style="text-align:center">' . "\n" .
372 join('<br />', $top) . '</div>' . "\n" . $retval;
377 // Show text formatting rules
382 if (! is_page($rule_page)) {
383 return '<p>Sorry, page \'' . htmlspecialchars($rule_page) .
384 '\' unavailable.</p>';
386 return convert_html(get_source($rule_page));
390 // Show (critical) error message
391 function die_message($msg)
393 $title = $page = 'Runtime error';
395 <h3>Runtime error</h3>
396 <strong>Error message : $msg</strong>
399 pkwk_common_headers();
400 if(defined('SKIN_FILE') && file_exists(SKIN_FILE) && is_readable(SKIN_FILE)) {
401 catbody($title, $page, $body);
403 header('Content-Type: text/html; charset=euc-jp');
405 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
408 <title>$title</title>
409 <meta http-equiv="content-type" content="text/html; charset=euc-jp">
420 // Have the time (as microtime)
421 function getmicrotime()
423 list($usec, $sec) = explode(' ', microtime());
424 return ((float)$sec + (float)$usec);
428 function get_date($format, $timestamp = NULL)
430 $format = preg_replace('/(?<!\\\)T/',
431 preg_replace('/(.)/', '\\\$1', ZONE), $format);
433 $time = ZONETIME + (($timestamp !== NULL) ? $timestamp : UTIME);
435 return date($format, $time);
438 // Format date string
439 function format_date($val, $paren = FALSE)
441 global $date_format, $time_format, $weeklabels;
445 $date = date($date_format, $val) .
446 ' (' . $weeklabels[date('w', $val)] . ') ' .
447 date($time_format, $val);
449 return $paren ? '(' . $date . ')' : $date;
452 // Get short string of the passage, 'N seconds/minutes/hours/days/years ago'
453 function get_passage($time, $paren = TRUE)
455 static $units = array('m'=>60, 'h'=>24, 'd'=>1);
457 $time = max(0, (UTIME - $time) / 60); // minutes
459 foreach ($units as $unit=>$card) {
460 if ($time < $card) break;
463 $time = floor($time) . $unit;
465 return $paren ? '(' . $time . ')' : $time;
468 // Hide <input type="(submit|button|image)"...>
469 function drop_submit($str)
471 return preg_replace('/<input([^>]+)type="(submit|button|image)"/i',
472 '<input$1type="hidden"', $str);
475 // Generate AutoLink patterns (thx to hirofummy)
476 function get_autolink_pattern(& $pages)
478 global $WikiName, $autolink, $nowikiname;
480 $config = &new Config('AutoLink');
482 $ignorepages = $config->get('IgnoreList');
483 $forceignorepages = $config->get('ForceIgnoreList');
485 $auto_pages = array_merge($ignorepages, $forceignorepages);
487 foreach ($pages as $page)
488 if (preg_match('/^' . $WikiName . '$/', $page) ?
489 $nowikiname : strlen($page) >= $autolink)
490 $auto_pages[] = $page;
492 if (empty($auto_pages)) {
493 $result = $result_a = $nowikiname ? '(?!)' : $WikiName;
495 $auto_pages = array_unique($auto_pages);
496 sort($auto_pages, SORT_STRING);
498 $auto_pages_a = array_values(preg_grep('/^[A-Z]+$/i', $auto_pages));
499 $auto_pages = array_values(array_diff($auto_pages, $auto_pages_a));
501 $result = get_autolink_pattern_sub($auto_pages, 0, count($auto_pages), 0);
502 $result_a = get_autolink_pattern_sub($auto_pages_a, 0, count($auto_pages_a), 0);
504 return array($result, $result_a, $forceignorepages);
507 function get_autolink_pattern_sub(& $pages, $start, $end, $pos)
509 if ($end == 0) return '(?!)';
512 $count = $i = $j = 0;
513 $x = (mb_strlen($pages[$start]) <= $pos);
516 for ($i = $start; $i < $end; $i = $j) {
517 $char = mb_substr($pages[$i], $pos, 1);
518 for ($j = $i; $j < $end; $j++)
519 if (mb_substr($pages[$j], $pos, 1) != $char) break;
521 if ($i != $start) $result .= '|';
522 if ($i >= ($j - 1)) {
523 $result .= str_replace(' ', '\\ ', preg_quote(mb_substr($pages[$i], $pos), '/'));
525 $result .= str_replace(' ', '\\ ', preg_quote($char, '/')) .
526 get_autolink_pattern_sub($pages, $i, $j, $pos + 1);
530 if ($x || $count > 1) $result = '(?:' . $result . ')';
531 if ($x) $result .= '?';
536 // Get absolute-URI of this script
537 function get_script_uri($init_uri = '')
539 global $script_directory_index;
542 if ($init_uri == '') {
544 if (isset($script)) return $script;
547 $msg = 'get_script_uri() failed: Please set $script at INI_FILE manually';
549 $script = (SERVER_PORT == 443 ? 'https://' : 'http://'); // scheme
550 $script .= SERVER_NAME; // host
551 $script .= (SERVER_PORT == 80 ? '' : ':' . SERVER_PORT); // port
553 // SCRIPT_NAME ¤¬'/'¤Ç»Ï¤Þ¤Ã¤Æ¤¤¤Ê¤¤¾ì¹ç(cgi¤Ê¤É) REQUEST_URI¤ò»È¤Ã¤Æ¤ß¤ë
555 if ($path{0} != '/') {
556 if (! isset($_SERVER['REQUEST_URI']) || $_SERVER['REQUEST_URI']{0} != '/')
559 // REQUEST_URI¤ò¥Ñ¡¼¥¹¤·¡¢pathÉôʬ¤À¤±¤ò¼è¤ê½Ð¤¹
560 $parse_url = parse_url($script . $_SERVER['REQUEST_URI']);
561 if (! isset($parse_url['path']) || $parse_url['path']{0} != '/')
564 $path = $parse_url['path'];
568 if (! is_url($script, TRUE) && php_sapi_name() == 'cgi')
574 if (isset($script)) die_message('$script: Already init');
575 if (! is_url($init_uri, TRUE)) die_message('$script: Invalid URI');
579 // Cut filename or not
580 if (isset($script_directory_index)) {
581 if (! file_exists($script_directory_index))
582 die_message('Directory index file not found: ' .
583 htmlspecialchars($script_directory_index));
585 if (preg_match('#^(.+/)' . preg_quote($script_directory_index, '#') . '$#',
586 $script, $matches)) $script = $matches[1];
592 // Remove null(\0) bytes from variables
594 // NOTE: PHP had vulnerabilities that opens "hoge.php" via fopen("hoge.php\0.txt") etc.
595 // [PHP-users 12736] null byte attack
596 // http://ns1.php.gr.jp/pipermail/php-users/2003-January/012742.html
598 // 2003-05-16: magic quotes gpc¤ÎÉü¸µ½èÍý¤òÅý¹ç
599 // 2003-05-21: Ï¢ÁÛÇÛÎó¤Î¥¡¼¤Ïbinary safe
601 function input_filter($param)
603 static $magic_quotes_gpc = NULL;
604 if ($magic_quotes_gpc === NULL)
605 $magic_quotes_gpc = get_magic_quotes_gpc();
607 if (is_array($param)) {
608 return array_map('input_filter', $param);
610 $result = str_replace("\0", '', $param);
611 if ($magic_quotes_gpc) $result = stripslashes($result);
616 // Compat for 3rd party plugins. Remove this later
617 function sanitize($param) {
618 return input_filter($param);
621 // Explode Comma-Separated Values to an array
622 function csv_explode($separator, $string)
624 $retval = $matches = array();
626 $_separator = preg_quote($separator, '/');
627 if (! preg_match_all('/("[^"]*(?:""[^"]*)*"|[^' . $_separator . ']*)' .
628 $_separator . '/', $string . $separator, $matches))
631 foreach ($matches[1] as $str) {
633 if ($len > 1 && $str{0} == '"' && $str{$len - 1} == '"')
634 $str = str_replace('""', '"', substr($str, 1, -1));
640 // Implode an array with CSV data format (escape double quotes)
641 function csv_implode($glue, $pieces)
643 $_glue = ($glue != '') ? '\\' . $glue{0} : '';
645 foreach ($pieces as $str) {
646 if (ereg('[' . $_glue . '"' . "\n\r" . ']', $str))
647 $str = '"' . str_replace('"', '""', $str) . '"';
650 return join($glue, $arr);
655 // is_a -- Returns TRUE if the object is of this class or has this class as one of its parents
657 if (! function_exists('is_a')) {
659 function is_a($class, $match)
661 if (empty($class)) return FALSE;
663 $class = is_object($class) ? get_class($class) : $class;
664 if (strtolower($class) == strtolower($match)) {
667 return is_a(get_parent_class($class), $match); // Recurse
672 // array_fill -- Fill an array with values
674 if (! function_exists('array_fill')) {
676 function array_fill($start_index, $num, $value)
679 while ($num-- > 0) $ret[$start_index++] = $value;
684 // md5_file -- Calculates the md5 hash of a given filename
686 if (! function_exists('md5_file')) {
688 function md5_file($filename)
690 if (! file_exists($filename)) return FALSE;
692 $fd = fopen($filename, 'rb');
693 if ($fd === FALSE ) return FALSE;
694 $data = fread($fd, filesize($filename));
700 // sha1 -- Compute SHA-1 hash
701 // (PHP 4 >= 4.3.0, PHP5)
702 if (! function_exists('sha1')) {
703 if (extension_loaded('mhash')) {
704 function sha1($str, $raw_output = FALSE)
707 // PHP 5.0.0 or lator only :)
708 return mhash(MHASH_SHA1, $str);
710 return bin2hex(mhash(MHASH_SHA1, $str));
714 function sha1($str, $raw_output = FALSE)
716 die('Function sha1() not found or extension \'mhash\' not exists');