OSDN Git Service

BugTrack/2213 Support Absolute/Relative URI type context
[pukiwiki/pukiwiki.git] / lib / func.php
1 <?php
2 // PukiWiki - Yet another WikiWikiWeb clone.
3 // func.php
4 // Copyright
5 //   2002-2017 PukiWiki Development Team
6 //   2001-2002 Originally written by yu-ji
7 // License: GPL v2 or (at your option) any later version
8 //
9 // General functions
10
11 // URI type enum
12 /** Relative path. */
13 define('PKWK_URI_RELATIVE', 0);
14 /** Root relative URI. */
15 define('PKWK_URI_ROOT', 1);
16 /** Absolute URI. */
17 define('PKWK_URI_ABSOLUTE', 2);
18
19 function pkwk_log($message)
20 {
21         $log_filepath = 'log/error.log.php';
22         static $dateTimeExists;
23         if (!isset($dateTimeExists)) {
24                 $dateTimeExists = class_exists('DateTime');
25                 error_log("<?php\n", 3, $log_filepath);
26         }
27         if ($dateTimeExists) {
28                 // for PHP5.2+
29                 $d = \DateTime::createFromFormat('U.u', sprintf('%6F', microtime(true)));
30                 $timestamp = substr($d->format('Y-m-d H:i:s.u'), 0, 23);
31         } else {
32                 $timestamp = date('Y-m-d H:i:s');
33         }
34         error_log($timestamp . ' ' . $message . "\n", 3, $log_filepath);
35 }
36
37 /*
38  * Get LTSV safe string - Remove tab and newline chars.
39  *
40  * @param $s target string
41  */
42 function get_ltsv_value($s) {
43         if (!$s) {
44                 return '';
45         }
46         return preg_replace('#[\t\r\n]#', '', $s);
47 }
48
49 /**
50  * Write update_log on updating contents.
51  *
52  * @param $page page name
53  * @param $diff_content diff expression
54  */
55 function pkwk_log_updates($page, $diff_content) {
56         global $auth_user, $logging_updates, $logging_updates_log_dir;
57         $log_dir = $logging_updates_log_dir;
58         $timestamp = time();
59         $ymd = gmdate('Ymd', $timestamp);
60         $difflog_file = $log_dir . '/diff.' . $ymd . '.log';
61         $ltsv_file = $log_dir . '/update.' . $ymd . '.log';
62         $d = array(
63                 'time' => gmdate('Y-m-d H:i:s', $timestamp),
64                 'uri' => $_SERVER['REQUEST_URI'],
65                 'method' => $_SERVER['REQUEST_METHOD'],
66                 'remote_addr' => $_SERVER['REMOTE_ADDR'],
67                 'user_agent' => $_SERVER['HTTP_USER_AGENT'],
68                 'page' => $page,
69                 'user' => $auth_user,
70                 'diff' => $diff_content
71         );
72         if (file_exists($log_dir) && defined('JSON_UNESCAPED_UNICODE')) {
73                 // require: PHP5.4+
74                 $line = json_encode($d, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES) . "\n";
75                 file_put_contents($difflog_file, $line, FILE_APPEND | LOCK_EX);
76                 $keys = array('time', 'uri', 'method', 'remote_addr', 'user_agent',
77                         'page', 'user');
78                 $ar2 = array();
79                 foreach ($keys as $k) {
80                         $ar2[] = $k . ':' . get_ltsv_value($d[$k]);
81                 }
82                 $ltsv = join($ar2, "\t") . "\n";
83                 file_put_contents($ltsv_file, $ltsv, FILE_APPEND | LOCK_EX);
84         }
85 }
86
87 /**
88  * ctype_digit that supports PHP4+.
89  *
90  * PHP official document says PHP4 has ctype_digit() function.
91  * But sometimes it doen't exists on PHP 4.1.
92  */
93 function pkwk_ctype_digit($s) {
94         static $ctype_digit_exists;
95         if (!isset($ctype_digit_exists)) {
96                 $ctype_digit_exists = function_exists('ctype_digit');
97         }
98         if ($ctype_digit_exists) {
99                 return ctype_digit($s);
100         }
101         return preg_match('/^[0-9]+$/', $s) ? true : false;
102 }
103
104 function is_interwiki($str)
105 {
106         global $InterWikiName;
107         return preg_match('/^' . $InterWikiName . '$/', $str);
108 }
109
110 function is_pagename($str)
111 {
112         global $BracketName;
113
114         $is_pagename = (! is_interwiki($str) &&
115                   preg_match('/^(?!\/)' . $BracketName . '$(?<!\/$)/', $str) &&
116                 ! preg_match('#(^|/)\.{1,2}(/|$)#', $str));
117
118         if (defined('SOURCE_ENCODING')) {
119                 switch(SOURCE_ENCODING){
120                 case 'UTF-8': $pattern =
121                         '/^(?:[\x00-\x7F]|(?:[\xC0-\xDF][\x80-\xBF])|(?:[\xE0-\xEF][\x80-\xBF][\x80-\xBF]))+$/';
122                         break;
123                 case 'EUC-JP': $pattern =
124                         '/^(?:[\x00-\x7F]|(?:[\x8E\xA1-\xFE][\xA1-\xFE])|(?:\x8F[\xA1-\xFE][\xA1-\xFE]))+$/';
125                         break;
126                 }
127                 if (isset($pattern) && $pattern != '')
128                         $is_pagename = ($is_pagename && preg_match($pattern, $str));
129         }
130
131         return $is_pagename;
132 }
133
134 function is_url($str, $only_http = FALSE)
135 {
136         $scheme = $only_http ? 'https?' : 'https?|ftp|news';
137         return preg_match('/^(' . $scheme . ')(:\/\/[-_.!~*\'()a-zA-Z0-9;\/?:\@&=+\$,%#]*)$/', $str);
138 }
139
140 // If the page exists
141 function is_page($page, $clearcache = FALSE)
142 {
143         if ($clearcache) clearstatcache();
144         return file_exists(get_filename($page));
145 }
146
147 function is_editable($page)
148 {
149         global $cantedit;
150         static $is_editable = array();
151
152         if (! isset($is_editable[$page])) {
153                 $is_editable[$page] = (
154                         is_pagename($page) &&
155                         ! is_freeze($page) &&
156                         ! in_array($page, $cantedit)
157                 );
158         }
159
160         return $is_editable[$page];
161 }
162
163 function is_freeze($page, $clearcache = FALSE)
164 {
165         global $function_freeze;
166         static $is_freeze = array();
167
168         if ($clearcache === TRUE) $is_freeze = array();
169         if (isset($is_freeze[$page])) return $is_freeze[$page];
170
171         if (! $function_freeze || ! is_page($page)) {
172                 $is_freeze[$page] = FALSE;
173                 return FALSE;
174         } else {
175                 $fp = fopen(get_filename($page), 'rb') or
176                         die('is_freeze(): fopen() failed: ' . htmlsc($page));
177                 flock($fp, LOCK_SH) or die('is_freeze(): flock() failed');
178                 rewind($fp);
179                 $buffer = fread($fp, 1000);
180                 flock($fp, LOCK_UN) or die('is_freeze(): flock() failed');
181                 fclose($fp) or die('is_freeze(): fclose() failed: ' . htmlsc($page));
182                 $is_freeze[$page] = (bool) preg_match('/^#freeze$/m', $buffer);
183                 return $is_freeze[$page];
184         }
185 }
186
187 // Handling $non_list
188 // $non_list will be preg_quote($str, '/') later.
189 function check_non_list($page = '')
190 {
191         global $non_list;
192         static $regex;
193
194         if (! isset($regex)) $regex = '/' . $non_list . '/';
195
196         return preg_match($regex, $page);
197 }
198
199 // Auto template
200 function auto_template($page)
201 {
202         global $auto_template_func, $auto_template_rules;
203
204         if (! $auto_template_func) return '';
205
206         $body = '';
207         $matches = array();
208         foreach ($auto_template_rules as $rule => $template) {
209                 $rule_pattrn = '/' . $rule . '/';
210
211                 if (! preg_match($rule_pattrn, $page, $matches)) continue;
212
213                 $template_page = preg_replace($rule_pattrn, $template, $page);
214                 if (! is_page($template_page)) continue;
215
216                 $body = join('', get_source($template_page));
217
218                 // Remove fixed-heading anchors
219                 $body = preg_replace('/^(\*{1,3}.*)\[#[A-Za-z][\w-]+\](.*)$/m', '$1$2', $body);
220
221                 // Remove '#freeze'
222                 $body = preg_replace('/^#freeze\s*$/m', '', $body);
223
224                 $count = count($matches);
225                 for ($i = 0; $i < $count; $i++)
226                         $body = str_replace('$' . $i, $matches[$i], $body);
227
228                 break;
229         }
230         return $body;
231 }
232
233 // Expand all search-words to regexes and push them into an array
234 function get_search_words($words = array(), $do_escape = FALSE)
235 {
236         static $init, $mb_convert_kana, $pre, $post, $quote = '/';
237
238         if (! isset($init)) {
239                 // function: mb_convert_kana() is for Japanese code only
240                 if (LANG == 'ja' && function_exists('mb_convert_kana')) {
241                         $mb_convert_kana = create_function('$str, $option',
242                                 'return mb_convert_kana($str, $option, SOURCE_ENCODING);');
243                 } else {
244                         $mb_convert_kana = create_function('$str, $option',
245                                 'return $str;');
246                 }
247                 if (SOURCE_ENCODING == 'EUC-JP') {
248                         // Perl memo - Correct pattern-matching with EUC-JP
249                         // http://www.din.or.jp/~ohzaki/perl.htm#JP_Match (Japanese)
250                         $pre  = '(?<!\x8F)';
251                         $post = '(?=(?:[\xA1-\xFE][\xA1-\xFE])*' . // JIS X 0208
252                                 '(?:[\x00-\x7F\x8E\x8F]|\z))';     // ASCII, SS2, SS3, or the last
253                 } else {
254                         $pre = $post = '';
255                 }
256                 $init = TRUE;
257         }
258
259         if (! is_array($words)) $words = array($words);
260
261         // Generate regex for the words
262         $regex = array();
263         foreach ($words as $word) {
264                 $word = trim($word);
265                 if ($word == '') continue;
266
267                 // Normalize: ASCII letters = to single-byte. Others = to Zenkaku and Katakana
268                 $word_nm = $mb_convert_kana($word, 'aKCV');
269                 $nmlen   = mb_strlen($word_nm, SOURCE_ENCODING);
270
271                 // Each chars may be served ...
272                 $chars = array();
273                 for ($pos = 0; $pos < $nmlen; $pos++) {
274                         $char = mb_substr($word_nm, $pos, 1, SOURCE_ENCODING);
275
276                         // Just normalized one? (ASCII char or Zenkaku-Katakana?)
277                         $or = array(preg_quote($do_escape ? htmlsc($char) : $char, $quote));
278                         if (strlen($char) == 1) {
279                                 // An ASCII (single-byte) character
280                                 foreach (array(strtoupper($char), strtolower($char)) as $_char) {
281                                         if ($char != '&') $or[] = preg_quote($_char, $quote); // As-is?
282                                         $ascii = ord($_char);
283                                         $or[] = sprintf('&#(?:%d|x%x);', $ascii, $ascii); // As an entity reference?
284                                         $or[] = preg_quote($mb_convert_kana($_char, 'A'), $quote); // As Zenkaku?
285                                 }
286                         } else {
287                                 // NEVER COME HERE with mb_substr(string, start, length, 'ASCII')
288                                 // A multi-byte character
289                                 $or[] = preg_quote($mb_convert_kana($char, 'c'), $quote); // As Hiragana?
290                                 $or[] = preg_quote($mb_convert_kana($char, 'k'), $quote); // As Hankaku-Katakana?
291                         }
292                         $chars[] = '(?:' . join('|', array_unique($or)) . ')'; // Regex for the character
293                 }
294
295                 $regex[$word] = $pre . join('', $chars) . $post; // For the word
296         }
297
298         return $regex; // For all words
299 }
300
301 // 'Search' main function
302 function do_search($word, $type = 'AND', $non_format = FALSE, $base = '')
303 {
304         global $whatsnew, $non_list, $search_non_list;
305         global $_msg_andresult, $_msg_orresult, $_msg_notfoundresult;
306         global $search_auth, $show_passage;
307
308         $retval = array();
309
310         $b_type = ($type == 'AND'); // AND:TRUE OR:FALSE
311         $keys = get_search_words(preg_split('/\s+/', $word, -1, PREG_SPLIT_NO_EMPTY));
312         foreach ($keys as $key=>$value)
313                 $keys[$key] = '/' . $value . '/S';
314
315         $pages = get_existpages();
316
317         // Avoid
318         if ($base != '') {
319                 $pages = preg_grep('/^' . preg_quote($base, '/') . '/S', $pages);
320         }
321         if (! $search_non_list) {
322                 $pages = array_diff($pages, preg_grep('/' . $non_list . '/S', $pages));
323         }
324         $pages = array_flip($pages);
325         unset($pages[$whatsnew]);
326
327         $count = count($pages);
328         foreach (array_keys($pages) as $page) {
329                 $b_match = FALSE;
330
331                 // Search for page name
332                 if (! $non_format) {
333                         foreach ($keys as $key) {
334                                 $b_match = preg_match($key, $page);
335                                 if ($b_type xor $b_match) break; // OR
336                         }
337                         if ($b_match) continue;
338                 }
339
340                 // Search auth for page contents
341                 if ($search_auth && ! check_readable($page, false, false)) {
342                         unset($pages[$page]);
343                         --$count;
344                 }
345
346                 // Search for page contents
347                 foreach ($keys as $key) {
348                         $b_match = preg_match($key, get_source($page, TRUE, TRUE));
349                         if ($b_type xor $b_match) break; // OR
350                 }
351                 if ($b_match) continue;
352
353                 unset($pages[$page]); // Miss
354         }
355         if ($non_format) return array_keys($pages);
356
357         $r_word = rawurlencode($word);
358         $s_word = htmlsc($word);
359         if (empty($pages))
360                 return str_replace('$1', $s_word, $_msg_notfoundresult);
361
362         ksort($pages, SORT_STRING);
363
364         $retval = '<ul>' . "\n";
365         foreach (array_keys($pages) as $page) {
366                 $r_page  = rawurlencode($page);
367                 $s_page  = htmlsc($page);
368                 $passage = $show_passage ? ' ' . get_passage(get_filetime($page)) : '';
369                 $retval .= ' <li><a href="' . get_base_uri() . '?cmd=read&amp;page=' .
370                         $r_page . '&amp;word=' . $r_word . '">' . $s_page .
371                         '</a>' . $passage . '</li>' . "\n";
372         }
373         $retval .= '</ul>' . "\n";
374
375         $retval .= str_replace('$1', $s_word, str_replace('$2', count($pages),
376                 str_replace('$3', $count, $b_type ? $_msg_andresult : $_msg_orresult)));
377
378         return $retval;
379 }
380
381 // Argument check for program
382 function arg_check($str)
383 {
384         global $vars;
385         return isset($vars['cmd']) && (strpos($vars['cmd'], $str) === 0);
386 }
387
388 function _pagename_urlencode_callback($matches)
389 {
390         return rawurlencode($matches[0]);
391 }
392
393 function pagename_urlencode($page)
394 {
395         return preg_replace_callback('|[^/:]+|', '_pagename_urlencode_callback', $page);
396 }
397
398 // Encode page-name
399 function encode($str)
400 {
401         $str = strval($str);
402         return ($str == '') ? '' : strtoupper(bin2hex($str));
403         // Equal to strtoupper(join('', unpack('H*0', $key)));
404         // But PHP 4.3.10 says 'Warning: unpack(): Type H: outside of string in ...'
405 }
406
407 // Decode page name
408 function decode($str)
409 {
410         return pkwk_hex2bin($str);
411 }
412
413 // Inversion of bin2hex()
414 function pkwk_hex2bin($hex_string)
415 {
416         // preg_match : Avoid warning : pack(): Type H: illegal hex digit ...
417         // (string)   : Always treat as string (not int etc). See BugTrack2/31
418         return preg_match('/^[0-9a-f]+$/i', $hex_string) ?
419                 pack('H*', (string)$hex_string) : $hex_string;
420 }
421
422 // Remove [[ ]] (brackets)
423 function strip_bracket($str)
424 {
425         $match = array();
426         if (preg_match('/^\[\[(.*)\]\]$/', $str, $match)) {
427                 return $match[1];
428         } else {
429                 return $str;
430         }
431 }
432
433 // Create list of pages
434 function page_list($pages, $cmd = 'read', $withfilename = FALSE)
435 {
436         global $list_index;
437         global $_msg_symbol, $_msg_other;
438         global $pagereading_enable;
439
440         $script = get_base_uri();
441
442         // ソートキーを決定する。 ' ' < '[a-zA-Z]' < 'zz'という前提。
443         $symbol = ' ';
444         $other = 'zz';
445
446         $retval = '';
447
448         if($pagereading_enable) {
449                 mb_regex_encoding(SOURCE_ENCODING);
450                 $readings = get_readings($pages);
451         }
452
453         $list = $matches = array();
454
455         // Shrink URI for read
456         if ($cmd == 'read') {
457                 $href = $script . '?';
458         } else {
459                 $href = $script . '?cmd=' . $cmd . '&amp;page=';
460         }
461
462         foreach($pages as $file=>$page) {
463                 $r_page  = pagename_urlencode($page);
464                 $s_page  = htmlsc($page, ENT_QUOTES);
465                 $passage = get_pg_passage($page);
466
467                 $str = '   <li><a href="' . $href . $r_page . '">' .
468                         $s_page . '</a>' . $passage;
469
470                 if ($withfilename) {
471                         $s_file = htmlsc($file);
472                         $str .= "\n" . '    <ul><li>' . $s_file . '</li></ul>' .
473                                 "\n" . '   ';
474                 }
475                 $str .= '</li>';
476
477                 // WARNING: Japanese code hard-wired
478                 if($pagereading_enable) {
479                         if(mb_ereg('^([A-Za-z])', mb_convert_kana($page, 'a'), $matches)) {
480                                 $head = strtoupper($matches[1]);
481                         } elseif (isset($readings[$page]) && mb_ereg('^([ァ-ヶ])', $readings[$page], $matches)) { // here
482                                 $head = $matches[1];
483                         } elseif (mb_ereg('^[ -~]|[^ぁ-ん亜-熙]', $page)) { // and here
484                                 $head = $symbol;
485                         } else {
486                                 $head = $other;
487                         }
488                 } else {
489                         $head = (preg_match('/^([A-Za-z])/', $page, $matches)) ? strtoupper($matches[1]) :
490                                 (preg_match('/^([ -~])/', $page) ? $symbol : $other);
491                 }
492
493                 $list[$head][$page] = $str;
494         }
495         uksort($pages, 'strnatcmp');
496
497         $cnt = 0;
498         $arr_index = array();
499         $retval .= '<ul>' . "\n";
500         foreach ($list as $head=>$pages) {
501                 if ($head === $symbol) {
502                         $head = $_msg_symbol;
503                 } else if ($head === $other) {
504                         $head = $_msg_other;
505                 }
506
507                 if ($list_index) {
508                         ++$cnt;
509                         $arr_index[] = '<a id="top_' . $cnt .
510                                 '" href="#head_' . $cnt . '"><strong>' .
511                                 $head . '</strong></a>';
512                         $retval .= ' <li><a id="head_' . $cnt . '" href="#top_' . $cnt .
513                                 '"><strong>' . $head . '</strong></a>' . "\n" .
514                                 '  <ul>' . "\n";
515                 }
516                 ksort($pages, SORT_STRING);
517                 $retval .= join("\n", $pages);
518                 if ($list_index)
519                         $retval .= "\n  </ul>\n </li>\n";
520         }
521         $retval .= '</ul>' . "\n";
522         if ($list_index && $cnt > 0) {
523                 $top = array();
524                 while (! empty($arr_index))
525                         $top[] = join(' | ' . "\n", array_splice($arr_index, 0, 16)) . "\n";
526
527                 $retval = '<div id="top" style="text-align:center">' . "\n" .
528                         join('<br />', $top) . '</div>' . "\n" . $retval;
529         }
530         return $retval;
531 }
532
533 // Show text formatting rules
534 function catrule()
535 {
536         global $rule_page;
537
538         if (! is_page($rule_page)) {
539                 return '<p>Sorry, page \'' . htmlsc($rule_page) .
540                         '\' unavailable.</p>';
541         } else {
542                 return convert_html(get_source($rule_page));
543         }
544 }
545
546 // Show (critical) error message
547 function die_message($msg)
548 {
549         $title = $page = 'Runtime error';
550         $body = <<<EOD
551 <h3>Runtime error</h3>
552 <strong>Error message : $msg</strong>
553 EOD;
554
555         pkwk_common_headers();
556         if(defined('SKIN_FILE') && file_exists(SKIN_FILE) && is_readable(SKIN_FILE)) {
557                 catbody($title, $page, $body);
558         } else {
559                 $charset = 'utf-8';
560                 if(defined('CONTENT_CHARSET')) {
561                         $charset = CONTENT_CHARSET;
562                 }
563                 header("Content-Type: text/html; charset=$charset");
564                 print <<<EOD
565 <!DOCTYPE html>
566 <html>
567  <head>
568   <meta http-equiv="content-type" content="text/html; charset=$charset">
569   <title>$title</title>
570  </head>
571  <body>
572  $body
573  </body>
574 </html>
575 EOD;
576         }
577         exit;
578 }
579
580 // Have the time (as microtime)
581 function getmicrotime()
582 {
583         list($usec, $sec) = explode(' ', microtime());
584         return ((float)$sec + (float)$usec);
585 }
586
587 // Elapsed time by second
588 //define('MUTIME', getmicrotime());
589 function elapsedtime()
590 {
591         $at_the_microtime = MUTIME;
592         return sprintf('%01.03f', getmicrotime() - $at_the_microtime);
593 }
594
595 // Get the date
596 function get_date($format, $timestamp = NULL)
597 {
598         $format = preg_replace('/(?<!\\\)T/',
599                 preg_replace('/(.)/', '\\\$1', ZONE), $format);
600
601         $time = ZONETIME + (($timestamp !== NULL) ? $timestamp : UTIME);
602
603         return date($format, $time);
604 }
605
606 // Format date string
607 function format_date($val, $paren = FALSE)
608 {
609         global $date_format, $time_format, $weeklabels;
610
611         $val += ZONETIME;
612
613         $date = date($date_format, $val) .
614                 ' (' . $weeklabels[date('w', $val)] . ') ' .
615                 date($time_format, $val);
616
617         return $paren ? '(' . $date . ')' : $date;
618 }
619
620 // Get short string of the passage, 'N seconds/minutes/hours/days/years ago'
621 function get_passage($time, $paren = TRUE)
622 {
623         static $units = array('m'=>60, 'h'=>24, 'd'=>1);
624
625         $time = max(0, (UTIME - $time) / 60); // minutes
626
627         foreach ($units as $unit=>$card) {
628                 if ($time < $card) break;
629                 $time /= $card;
630         }
631         $time = floor($time) . $unit;
632
633         return $paren ? '(' . $time . ')' : $time;
634 }
635
636 // Hide <input type="(submit|button|image)"...>
637 function drop_submit($str)
638 {
639         return preg_replace('/<input([^>]+)type="(submit|button|image)"/i',
640                 '<input$1type="hidden"', $str);
641 }
642
643 // Generate AutoLink patterns (thx to hirofummy)
644 function get_autolink_pattern(& $pages)
645 {
646         global $WikiName, $autolink, $nowikiname;
647
648         $config = new Config('AutoLink');
649         $config->read();
650         $ignorepages      = $config->get('IgnoreList');
651         $forceignorepages = $config->get('ForceIgnoreList');
652         unset($config);
653         $auto_pages = array_merge($ignorepages, $forceignorepages);
654
655         foreach ($pages as $page)
656                 if (preg_match('/^' . $WikiName . '$/', $page) ?
657                     $nowikiname : strlen($page) >= $autolink)
658                         $auto_pages[] = $page;
659
660         if (empty($auto_pages)) {
661                 $result = $result_a = $nowikiname ? '(?!)' : $WikiName;
662         } else {
663                 $auto_pages = array_unique($auto_pages);
664                 sort($auto_pages, SORT_STRING);
665
666                 $auto_pages_a = array_values(preg_grep('/^[A-Z]+$/i', $auto_pages));
667                 $auto_pages   = array_values(array_diff($auto_pages,  $auto_pages_a));
668
669                 $result   = get_autolink_pattern_sub($auto_pages,   0, count($auto_pages),   0);
670                 $result_a = get_autolink_pattern_sub($auto_pages_a, 0, count($auto_pages_a), 0);
671         }
672         return array($result, $result_a, $forceignorepages);
673 }
674
675 function get_autolink_pattern_sub(& $pages, $start, $end, $pos)
676 {
677         if ($end == 0) return '(?!)';
678
679         $result = '';
680         $count = $i = $j = 0;
681         $x = (mb_strlen($pages[$start]) <= $pos);
682         if ($x) ++$start;
683
684         for ($i = $start; $i < $end; $i = $j) {
685                 $char = mb_substr($pages[$i], $pos, 1);
686                 for ($j = $i; $j < $end; $j++)
687                         if (mb_substr($pages[$j], $pos, 1) != $char) break;
688
689                 if ($i != $start) $result .= '|';
690                 if ($i >= ($j - 1)) {
691                         $result .= str_replace(' ', '\\ ', preg_quote(mb_substr($pages[$i], $pos), '/'));
692                 } else {
693                         $result .= str_replace(' ', '\\ ', preg_quote($char, '/')) .
694                                 get_autolink_pattern_sub($pages, $i, $j, $pos + 1);
695                 }
696                 ++$count;
697         }
698         if ($x || $count > 1) $result = '(?:' . $result . ')';
699         if ($x)               $result .= '?';
700
701         return $result;
702 }
703
704 /**
705  * Get propery URI of this script
706  *
707  * @param $uri_type relative or absolute option
708  *        PKWK_URI_RELATIVE, PKWK_URI_ROOT or PKWK_URI_ABSOLUTE
709  */
710 function get_base_uri($uri_type = PKWK_URI_RELATIVE)
711 {
712         $base_type = pkwk_base_uri_type_stack_peek();
713         $type = max($base_type, $uri_type);
714         switch ($type) {
715         case PKWK_URI_RELATIVE:
716                 return pkwk_script_uri_base(PKWK_URI_RELATIVE);
717         case PKWK_URI_ROOT:
718                 return pkwk_script_uri_base(PKWK_URI_ROOT);
719         case PKWK_URI_ABSOLUTE:
720                 return pkwk_script_uri_base(PKWK_URI_ABSOLUTE);
721         default:
722                 die_message('Invalid uri_type in get_base_uri()');
723         }
724 }
725
726 /**
727  * Get URI of the page
728  *
729  * @param page page name
730  * @param $uri_type relative or absolute option
731  *        PKWK_URI_RELATIVE, PKWK_URI_ROOT or PKWK_URI_ABSOLUTE
732  */
733 function get_page_uri($page, $uri_type = PKWK_URI_RELATIVE)
734 {
735         return get_base_uri($uri_type) . '?' . pagename_urlencode($page);
736 }
737
738 // Get absolute-URI of this script
739 function get_script_uri()
740 {
741         return get_base_uri(PKWK_URI_ABSOLUTE);
742 }
743
744 /**
745  * Get or initialize Script URI
746  *
747  * @param $uri_type relative or absolute potion
748  *        PKWK_URI_RELATIVE, PKWK_URI_ROOT or PKWK_URI_ABSOLUTE
749  * @param $initialize true if you initialize URI
750  * @param $uri_set URI set manually
751  */
752 function pkwk_script_uri_base($uri_type, $initialize, $uri_set)
753 {
754         global $script_directory_index;
755         static $initialized = false;
756         static $uri_absolute, $uri_root, $uri_relative;
757         if (! $initialized) {
758                 if (isset($initialize) && $initialize) {
759                         if (isset($uri_set)) {
760                                 $uri_absolute = $uri_set;
761                         } else {
762                                 $uri_absolute = guess_script_absolute_uri();
763                         }
764                         // Support $script_directory_index (cut 'index.php')
765                         if (isset($script_directory_index)) {
766                                 $slash_index = '/' . $script_directory_index;
767                                 $len = strlen($slash_index);
768                                 if (substr($uri_absolute,  -1 * $len) === $slash_index) {
769                                         $uri_absolute = substr($uri_absolute, 0, strlen($uri_absolute) - $len + 1);
770                                 }
771                         }
772                         $elements = parse_url($uri_absolute);
773                         $uri_root = $elements['path'];
774                         if (substr($uri_root, -1) === '/') {
775                                 $uri_relative = './';
776                         } else {
777                                 $pos = mb_strrpos($uri_root, '/');
778                                 if ($pos >= 0) {
779                                         $uri_relative = substr($uri_root, $pos + 1);
780                                 } else {
781                                         $uri_relative = $uri_root;
782                                 }
783                         }
784                         $initialized = true;
785                 } else {
786                         die_message('Script URI must be initialized in pkwk_script_uri_base()');
787                 }
788         }
789         switch ($uri_type) {
790         case PKWK_URI_RELATIVE:
791                 return $uri_relative;
792         case PKWK_URI_ROOT:
793                 return $uri_root;
794         case PKWK_URI_ABSOLUTE:
795                 return $uri_absolute;
796         default:
797                 die_message('Invalid uri_type in pkwk_script_uri_base()');
798         }
799 }
800
801 /**
802  * Create uri_type context
803  *
804  * @param $uri_type relative or absolute option
805  *        PKWK_URI_RELATIVE, PKWK_URI_ROOT or PKWK_URI_ABSOLUTE
806  */
807 function pkwk_base_uri_type_stack_push($uri_type)
808 {
809         _pkwk_base_uri_type_stack(false, true, $uri_type);
810 }
811
812 /**
813  * Stop current active uri_type context
814  */
815 function pkwk_base_uri_type_stack_pop()
816 {
817         _pkwk_base_uri_type_stack(false, false);
818 }
819
820 /**
821  * Get current active uri_type status
822  */
823 function pkwk_base_uri_type_stack_peek()
824 {
825         $type = _pkwk_base_uri_type_stack(true, false);
826         if (is_null($type)) {
827                 return PKWK_URI_RELATIVE;
828         } elseif ($type === PKWK_URI_ABSOLUTE) {
829                 return PKWK_URI_ABSOLUTE;
830         } elseif ($type === PKWK_URI_ROOT) {
831                 return PKWK_URI_ROOT;
832         } else {
833                 return PKWK_URI_RELATIVE;
834         }
835 }
836
837 /**
838  * uri_type context internal function
839  *
840  * @param $peek is peek action or not
841  * @param $push push(true) or pop(false) on not peeking
842  * @param $uri_type uri_type on push and non-peeking
843  * @return $uri_type uri_type for peeking
844  */
845 function _pkwk_base_uri_type_stack($peek, $push, $uri_type)
846 {
847         static $uri_types = array();
848         if ($peek) {
849                 // Peek: get latest value
850                 if (count($uri_types) === 0) {
851                         return null;
852                 } else {
853                         return $uri_types[0];
854                 }
855         } else {
856                 if ($push) {
857                         // Push $uri_type
858                         if (count($uri_types) === 0) {
859                                 array_unshift($uri_types, $uri_type);
860                         } else {
861                                 $prev_type = $uri_types[0];
862                                 if ($uri_type >= $prev_type) {
863                                         array_unshift($uri_types, $uri_type);
864                                 } else {
865                                         array_unshift($uri_types, $prev_type);
866                                 }
867                         }
868                 } else {
869                         // Pop $uri_type
870                         return array_shift($uri_types);
871                 }
872         }
873 }
874
875 /**
876  * Guess Script Absolute URI.
877  *
878  * SERVER_PORT: $_SERVER['SERVER_PORT'] converted in init.php
879  * SERVER_NAME: $_SERVER['SERVER_NAME'] converted in init.php
880  */
881 function guess_script_absolute_uri()
882 {
883         $port = SERVER_PORT;
884         $is_ssl = (SERVER_PORT == 443) ||
885                 (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'on') ||
886                 (isset($_SERVER['REQUEST_SCHEME']) && $_SERVER['REQUEST_SCHEME'] === 'https');
887         if ($is_ssl) {
888                 $host = 'https://' . SERVER_NAME .
889                         ($port == 443 ? '' : ':' . $port);
890         } else {
891                 $host = 'http://' . SERVER_NAME .
892                         ($port == 80 ? '' : ':' . $port);
893         }
894         $uri_elements = parse_url($host . $_SERVER['REQUEST_URI']);
895         return $host . $uri_elements['path'];
896 }
897
898 // Remove null(\0) bytes from variables
899 //
900 // NOTE: PHP had vulnerabilities that opens "hoge.php" via fopen("hoge.php\0.txt") etc.
901 // [PHP-users 12736] null byte attack
902 // http://ns1.php.gr.jp/pipermail/php-users/2003-January/012742.html
903 //
904 // 2003-05-16: magic quotes gpcの復元処理を統合
905 // 2003-05-21: 連想配列のキーはbinary safe
906 //
907 function input_filter($param)
908 {
909         static $magic_quotes_gpc = NULL;
910         if ($magic_quotes_gpc === NULL)
911             $magic_quotes_gpc = get_magic_quotes_gpc();
912
913         if (is_array($param)) {
914                 return array_map('input_filter', $param);
915         } else {
916                 $result = str_replace("\0", '', $param);
917                 if ($magic_quotes_gpc) $result = stripslashes($result);
918                 return $result;
919         }
920 }
921
922 // Compat for 3rd party plugins. Remove this later
923 function sanitize($param) {
924         return input_filter($param);
925 }
926
927 // Explode Comma-Separated Values to an array
928 function csv_explode($separator, $string)
929 {
930         $retval = $matches = array();
931
932         $_separator = preg_quote($separator, '/');
933         if (! preg_match_all('/("[^"]*(?:""[^"]*)*"|[^' . $_separator . ']*)' .
934             $_separator . '/', $string . $separator, $matches))
935                 return array();
936
937         foreach ($matches[1] as $str) {
938                 $len = strlen($str);
939                 if ($len > 1 && $str{0} == '"' && $str{$len - 1} == '"')
940                         $str = str_replace('""', '"', substr($str, 1, -1));
941                 $retval[] = $str;
942         }
943         return $retval;
944 }
945
946 // Implode an array with CSV data format (escape double quotes)
947 function csv_implode($glue, $pieces)
948 {
949         $_glue = ($glue != '') ? '\\' . $glue{0} : '';
950         $arr = array();
951         foreach ($pieces as $str) {
952                 if (preg_match('/[' . '"' . "\n\r" . $_glue . ']/', $str))
953                         $str = '"' . str_replace('"', '""', $str) . '"';
954                 $arr[] = $str;
955         }
956         return join($glue, $arr);
957 }
958
959 // Sugar with default settings
960 function htmlsc($string = '', $flags = ENT_COMPAT, $charset = CONTENT_CHARSET)
961 {
962         return htmlspecialchars($string, $flags, $charset);     // htmlsc()
963 }
964
965 /**
966  * Get redirect page name on Page Redirect Rules
967  *
968  * This function returns exactly false if it doesn't need redirection.
969  * So callers need check return value is false or not.
970  *
971  * @param $page page name
972  * @return new page name or false
973  */
974 function get_pagename_on_redirect($page) {
975         global $page_redirect_rules;
976         foreach ($page_redirect_rules as $rule=>$replace) {
977                 if (preg_match($rule, $page)) {
978                         if (is_string($replace)) {
979                                 $new_page = preg_replace($rule, $replace, $page);
980                         } elseif (is_object($replace) && is_callable($replace)) {
981                                 $new_page = preg_replace_callback($rule, $replace, $page);
982                         } else {
983                                 die_message('Invalid redirect rule: ' . $rule . '=>' . $replace);
984                         }
985                         if ($page !== $new_page) {
986                                 return $new_page;
987                         }
988                 }
989         }
990         return false;
991 }
992
993 /**
994  * Redirect from an old page to new page
995  *
996  * This function returns true when a redirection occurs.
997  * So callers need check return value is false or true.
998  * And if it is true, then you have to exit PHP script.
999  *
1000  * @return bool Inticates a redirection occurred or not
1001  */
1002 function manage_page_redirect() {
1003         global $vars;
1004         if (isset($vars['page'])) {
1005                 $page = $vars['page'];
1006         }
1007         $new_page = get_pagename_on_redirect($page);
1008         if ($new_page != false) {
1009                 header('Location: ' . get_page_uri($new_page, PKWK_URI_ROOT));
1010                 return TRUE;
1011         }
1012         return FALSE;
1013 }
1014
1015 //// Compat ////
1016
1017 // is_a --  Returns TRUE if the object is of this class or has this class as one of its parents
1018 // (PHP 4 >= 4.2.0)
1019 if (! function_exists('is_a')) {
1020
1021         function is_a($class, $match)
1022         {
1023                 if (empty($class)) return FALSE; 
1024
1025                 $class = is_object($class) ? get_class($class) : $class;
1026                 if (strtolower($class) == strtolower($match)) {
1027                         return TRUE;
1028                 } else {
1029                         return is_a(get_parent_class($class), $match);  // Recurse
1030                 }
1031         }
1032 }
1033
1034 // array_fill -- Fill an array with values
1035 // (PHP 4 >= 4.2.0)
1036 if (! function_exists('array_fill')) {
1037
1038         function array_fill($start_index, $num, $value)
1039         {
1040                 $ret = array();
1041                 while ($num-- > 0) $ret[$start_index++] = $value;
1042                 return $ret;
1043         }
1044 }
1045
1046 // md5_file -- Calculates the md5 hash of a given filename
1047 // (PHP 4 >= 4.2.0)
1048 if (! function_exists('md5_file')) {
1049
1050         function md5_file($filename)
1051         {
1052                 if (! file_exists($filename)) return FALSE;
1053
1054                 $fd = fopen($filename, 'rb');
1055                 if ($fd === FALSE ) return FALSE;
1056                 $data = fread($fd, filesize($filename));
1057                 fclose($fd);
1058                 return md5($data);
1059         }
1060 }
1061
1062 // sha1 -- Compute SHA-1 hash
1063 // (PHP 4 >= 4.3.0, PHP5)
1064 if (! function_exists('sha1')) {
1065         if (extension_loaded('mhash')) {
1066                 function sha1($str)
1067                 {
1068                         return bin2hex(mhash(MHASH_SHA1, $str));
1069                 }
1070         }
1071 }