OSDN Git Service

BugTrack/2430 Remove author line from text-search target
[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                         $lines = remove_author_lines(get_source($page, TRUE, FALSE));
349                         $b_match = preg_match($key, join('', $lines));
350                         if ($b_type xor $b_match) break; // OR
351                 }
352                 if ($b_match) continue;
353
354                 unset($pages[$page]); // Miss
355         }
356         if ($non_format) return array_keys($pages);
357
358         $r_word = rawurlencode($word);
359         $s_word = htmlsc($word);
360         if (empty($pages))
361                 return str_replace('$1', $s_word, $_msg_notfoundresult);
362
363         ksort($pages, SORT_STRING);
364
365         $retval = '<ul>' . "\n";
366         foreach (array_keys($pages) as $page) {
367                 $r_page  = rawurlencode($page);
368                 $s_page  = htmlsc($page);
369                 $passage = $show_passage ? ' ' . get_passage(get_filetime($page)) : '';
370                 $retval .= ' <li><a href="' . get_base_uri() . '?cmd=read&amp;page=' .
371                         $r_page . '&amp;word=' . $r_word . '">' . $s_page .
372                         '</a>' . $passage . '</li>' . "\n";
373         }
374         $retval .= '</ul>' . "\n";
375
376         $retval .= str_replace('$1', $s_word, str_replace('$2', count($pages),
377                 str_replace('$3', $count, $b_type ? $_msg_andresult : $_msg_orresult)));
378
379         return $retval;
380 }
381
382 // Argument check for program
383 function arg_check($str)
384 {
385         global $vars;
386         return isset($vars['cmd']) && (strpos($vars['cmd'], $str) === 0);
387 }
388
389 function _pagename_urlencode_callback($matches)
390 {
391         return rawurlencode($matches[0]);
392 }
393
394 function pagename_urlencode($page)
395 {
396         return preg_replace_callback('|[^/:]+|', '_pagename_urlencode_callback', $page);
397 }
398
399 // Encode page-name
400 function encode($str)
401 {
402         $str = strval($str);
403         return ($str == '') ? '' : strtoupper(bin2hex($str));
404         // Equal to strtoupper(join('', unpack('H*0', $key)));
405         // But PHP 4.3.10 says 'Warning: unpack(): Type H: outside of string in ...'
406 }
407
408 // Decode page name
409 function decode($str)
410 {
411         return pkwk_hex2bin($str);
412 }
413
414 // Inversion of bin2hex()
415 function pkwk_hex2bin($hex_string)
416 {
417         // preg_match : Avoid warning : pack(): Type H: illegal hex digit ...
418         // (string)   : Always treat as string (not int etc). See BugTrack2/31
419         return preg_match('/^[0-9a-f]+$/i', $hex_string) ?
420                 pack('H*', (string)$hex_string) : $hex_string;
421 }
422
423 // Remove [[ ]] (brackets)
424 function strip_bracket($str)
425 {
426         $match = array();
427         if (preg_match('/^\[\[(.*)\]\]$/', $str, $match)) {
428                 return $match[1];
429         } else {
430                 return $str;
431         }
432 }
433
434 // Create list of pages
435 function page_list($pages, $cmd = 'read', $withfilename = FALSE)
436 {
437         global $list_index;
438         global $_msg_symbol, $_msg_other;
439         global $pagereading_enable;
440
441         $script = get_base_uri();
442
443         // ソートキーを決定する。 ' ' < '[a-zA-Z]' < 'zz'という前提。
444         $symbol = ' ';
445         $other = 'zz';
446
447         $retval = '';
448
449         if($pagereading_enable) {
450                 mb_regex_encoding(SOURCE_ENCODING);
451                 $readings = get_readings($pages);
452         }
453
454         $list = $matches = array();
455
456         // Shrink URI for read
457         if ($cmd == 'read') {
458                 $href = $script . '?';
459         } else {
460                 $href = $script . '?cmd=' . $cmd . '&amp;page=';
461         }
462
463         foreach($pages as $file=>$page) {
464                 $r_page  = pagename_urlencode($page);
465                 $s_page  = htmlsc($page, ENT_QUOTES);
466                 $passage = get_pg_passage($page);
467
468                 $str = '   <li><a href="' . $href . $r_page . '">' .
469                         $s_page . '</a>' . $passage;
470
471                 if ($withfilename) {
472                         $s_file = htmlsc($file);
473                         $str .= "\n" . '    <ul><li>' . $s_file . '</li></ul>' .
474                                 "\n" . '   ';
475                 }
476                 $str .= '</li>';
477
478                 // WARNING: Japanese code hard-wired
479                 if($pagereading_enable) {
480                         if(mb_ereg('^([A-Za-z])', mb_convert_kana($page, 'a'), $matches)) {
481                                 $head = strtoupper($matches[1]);
482                         } elseif (isset($readings[$page]) && mb_ereg('^([ァ-ヶ])', $readings[$page], $matches)) { // here
483                                 $head = $matches[1];
484                         } elseif (mb_ereg('^[ -~]|[^ぁ-ん亜-熙]', $page)) { // and here
485                                 $head = $symbol;
486                         } else {
487                                 $head = $other;
488                         }
489                 } else {
490                         $head = (preg_match('/^([A-Za-z])/', $page, $matches)) ? strtoupper($matches[1]) :
491                                 (preg_match('/^([ -~])/', $page) ? $symbol : $other);
492                 }
493
494                 $list[$head][$page] = $str;
495         }
496         uksort($pages, 'strnatcmp');
497
498         $cnt = 0;
499         $arr_index = array();
500         $retval .= '<ul>' . "\n";
501         foreach ($list as $head=>$pages) {
502                 if ($head === $symbol) {
503                         $head = $_msg_symbol;
504                 } else if ($head === $other) {
505                         $head = $_msg_other;
506                 }
507
508                 if ($list_index) {
509                         ++$cnt;
510                         $arr_index[] = '<a id="top_' . $cnt .
511                                 '" href="#head_' . $cnt . '"><strong>' .
512                                 $head . '</strong></a>';
513                         $retval .= ' <li><a id="head_' . $cnt . '" href="#top_' . $cnt .
514                                 '"><strong>' . $head . '</strong></a>' . "\n" .
515                                 '  <ul>' . "\n";
516                 }
517                 ksort($pages, SORT_STRING);
518                 $retval .= join("\n", $pages);
519                 if ($list_index)
520                         $retval .= "\n  </ul>\n </li>\n";
521         }
522         $retval .= '</ul>' . "\n";
523         if ($list_index && $cnt > 0) {
524                 $top = array();
525                 while (! empty($arr_index))
526                         $top[] = join(' | ' . "\n", array_splice($arr_index, 0, 16)) . "\n";
527
528                 $retval = '<div id="top" style="text-align:center">' . "\n" .
529                         join('<br />', $top) . '</div>' . "\n" . $retval;
530         }
531         return $retval;
532 }
533
534 // Show text formatting rules
535 function catrule()
536 {
537         global $rule_page;
538
539         if (! is_page($rule_page)) {
540                 return '<p>Sorry, page \'' . htmlsc($rule_page) .
541                         '\' unavailable.</p>';
542         } else {
543                 return convert_html(get_source($rule_page));
544         }
545 }
546
547 // Show (critical) error message
548 function die_message($msg)
549 {
550         $title = $page = 'Runtime error';
551         $body = <<<EOD
552 <h3>Runtime error</h3>
553 <strong>Error message : $msg</strong>
554 EOD;
555
556         pkwk_common_headers();
557         if(defined('SKIN_FILE') && file_exists(SKIN_FILE) && is_readable(SKIN_FILE)) {
558                 catbody($title, $page, $body);
559         } else {
560                 $charset = 'utf-8';
561                 if(defined('CONTENT_CHARSET')) {
562                         $charset = CONTENT_CHARSET;
563                 }
564                 header("Content-Type: text/html; charset=$charset");
565                 print <<<EOD
566 <!DOCTYPE html>
567 <html>
568  <head>
569   <meta http-equiv="content-type" content="text/html; charset=$charset">
570   <title>$title</title>
571  </head>
572  <body>
573  $body
574  </body>
575 </html>
576 EOD;
577         }
578         exit;
579 }
580
581 // Have the time (as microtime)
582 function getmicrotime()
583 {
584         list($usec, $sec) = explode(' ', microtime());
585         return ((float)$sec + (float)$usec);
586 }
587
588 // Elapsed time by second
589 //define('MUTIME', getmicrotime());
590 function elapsedtime()
591 {
592         $at_the_microtime = MUTIME;
593         return sprintf('%01.03f', getmicrotime() - $at_the_microtime);
594 }
595
596 // Get the date
597 function get_date($format, $timestamp = NULL)
598 {
599         $format = preg_replace('/(?<!\\\)T/',
600                 preg_replace('/(.)/', '\\\$1', ZONE), $format);
601
602         $time = ZONETIME + (($timestamp !== NULL) ? $timestamp : UTIME);
603
604         return date($format, $time);
605 }
606
607 // Format date string
608 function format_date($val, $paren = FALSE)
609 {
610         global $date_format, $time_format, $weeklabels;
611
612         $val += ZONETIME;
613
614         $date = date($date_format, $val) .
615                 ' (' . $weeklabels[date('w', $val)] . ') ' .
616                 date($time_format, $val);
617
618         return $paren ? '(' . $date . ')' : $date;
619 }
620
621 // Get short string of the passage, 'N seconds/minutes/hours/days/years ago'
622 function get_passage($time, $paren = TRUE)
623 {
624         static $units = array('m'=>60, 'h'=>24, 'd'=>1);
625
626         $time = max(0, (UTIME - $time) / 60); // minutes
627
628         foreach ($units as $unit=>$card) {
629                 if ($time < $card) break;
630                 $time /= $card;
631         }
632         $time = floor($time) . $unit;
633
634         return $paren ? '(' . $time . ')' : $time;
635 }
636
637 // Hide <input type="(submit|button|image)"...>
638 function drop_submit($str)
639 {
640         return preg_replace('/<input([^>]+)type="(submit|button|image)"/i',
641                 '<input$1type="hidden"', $str);
642 }
643
644 // Generate AutoLink patterns (thx to hirofummy)
645 function get_autolink_pattern(& $pages)
646 {
647         global $WikiName, $autolink, $nowikiname;
648
649         $config = new Config('AutoLink');
650         $config->read();
651         $ignorepages      = $config->get('IgnoreList');
652         $forceignorepages = $config->get('ForceIgnoreList');
653         unset($config);
654         $auto_pages = array_merge($ignorepages, $forceignorepages);
655
656         foreach ($pages as $page)
657                 if (preg_match('/^' . $WikiName . '$/', $page) ?
658                     $nowikiname : strlen($page) >= $autolink)
659                         $auto_pages[] = $page;
660
661         if (empty($auto_pages)) {
662                 $result = $result_a = $nowikiname ? '(?!)' : $WikiName;
663         } else {
664                 $auto_pages = array_unique($auto_pages);
665                 sort($auto_pages, SORT_STRING);
666
667                 $auto_pages_a = array_values(preg_grep('/^[A-Z]+$/i', $auto_pages));
668                 $auto_pages   = array_values(array_diff($auto_pages,  $auto_pages_a));
669
670                 $result   = get_autolink_pattern_sub($auto_pages,   0, count($auto_pages),   0);
671                 $result_a = get_autolink_pattern_sub($auto_pages_a, 0, count($auto_pages_a), 0);
672         }
673         return array($result, $result_a, $forceignorepages);
674 }
675
676 function get_autolink_pattern_sub(& $pages, $start, $end, $pos)
677 {
678         if ($end == 0) return '(?!)';
679
680         $result = '';
681         $count = $i = $j = 0;
682         $x = (mb_strlen($pages[$start]) <= $pos);
683         if ($x) ++$start;
684
685         for ($i = $start; $i < $end; $i = $j) {
686                 $char = mb_substr($pages[$i], $pos, 1);
687                 for ($j = $i; $j < $end; $j++)
688                         if (mb_substr($pages[$j], $pos, 1) != $char) break;
689
690                 if ($i != $start) $result .= '|';
691                 if ($i >= ($j - 1)) {
692                         $result .= str_replace(' ', '\\ ', preg_quote(mb_substr($pages[$i], $pos), '/'));
693                 } else {
694                         $result .= str_replace(' ', '\\ ', preg_quote($char, '/')) .
695                                 get_autolink_pattern_sub($pages, $i, $j, $pos + 1);
696                 }
697                 ++$count;
698         }
699         if ($x || $count > 1) $result = '(?:' . $result . ')';
700         if ($x)               $result .= '?';
701
702         return $result;
703 }
704
705 /**
706  * Get propery URI of this script
707  *
708  * @param $uri_type relative or absolute option
709  *        PKWK_URI_RELATIVE, PKWK_URI_ROOT or PKWK_URI_ABSOLUTE
710  */
711 function get_base_uri($uri_type = PKWK_URI_RELATIVE)
712 {
713         $base_type = pkwk_base_uri_type_stack_peek();
714         $type = max($base_type, $uri_type);
715         switch ($type) {
716         case PKWK_URI_RELATIVE:
717                 return pkwk_script_uri_base(PKWK_URI_RELATIVE);
718         case PKWK_URI_ROOT:
719                 return pkwk_script_uri_base(PKWK_URI_ROOT);
720         case PKWK_URI_ABSOLUTE:
721                 return pkwk_script_uri_base(PKWK_URI_ABSOLUTE);
722         default:
723                 die_message('Invalid uri_type in get_base_uri()');
724         }
725 }
726
727 /**
728  * Get URI of the page
729  *
730  * @param page page name
731  * @param $uri_type relative or absolute option
732  *        PKWK_URI_RELATIVE, PKWK_URI_ROOT or PKWK_URI_ABSOLUTE
733  */
734 function get_page_uri($page, $uri_type = PKWK_URI_RELATIVE)
735 {
736         return get_base_uri($uri_type) . '?' . pagename_urlencode($page);
737 }
738
739 // Get absolute-URI of this script
740 function get_script_uri()
741 {
742         return get_base_uri(PKWK_URI_ABSOLUTE);
743 }
744
745 /**
746  * Get or initialize Script URI
747  *
748  * @param $uri_type relative or absolute potion
749  *        PKWK_URI_RELATIVE, PKWK_URI_ROOT or PKWK_URI_ABSOLUTE
750  * @param $initialize true if you initialize URI
751  * @param $uri_set URI set manually
752  */
753 function pkwk_script_uri_base($uri_type, $initialize, $uri_set)
754 {
755         global $script_directory_index;
756         static $initialized = false;
757         static $uri_absolute, $uri_root, $uri_relative;
758         if (! $initialized) {
759                 if (isset($initialize) && $initialize) {
760                         if (isset($uri_set)) {
761                                 $uri_absolute = $uri_set;
762                         } else {
763                                 $uri_absolute = guess_script_absolute_uri();
764                         }
765                         // Support $script_directory_index (cut 'index.php')
766                         if (isset($script_directory_index)) {
767                                 $slash_index = '/' . $script_directory_index;
768                                 $len = strlen($slash_index);
769                                 if (substr($uri_absolute,  -1 * $len) === $slash_index) {
770                                         $uri_absolute = substr($uri_absolute, 0, strlen($uri_absolute) - $len + 1);
771                                 }
772                         }
773                         $elements = parse_url($uri_absolute);
774                         $uri_root = $elements['path'];
775                         if (substr($uri_root, -1) === '/') {
776                                 $uri_relative = './';
777                         } else {
778                                 $pos = mb_strrpos($uri_root, '/');
779                                 if ($pos >= 0) {
780                                         $uri_relative = substr($uri_root, $pos + 1);
781                                 } else {
782                                         $uri_relative = $uri_root;
783                                 }
784                         }
785                         $initialized = true;
786                 } else {
787                         die_message('Script URI must be initialized in pkwk_script_uri_base()');
788                 }
789         }
790         switch ($uri_type) {
791         case PKWK_URI_RELATIVE:
792                 return $uri_relative;
793         case PKWK_URI_ROOT:
794                 return $uri_root;
795         case PKWK_URI_ABSOLUTE:
796                 return $uri_absolute;
797         default:
798                 die_message('Invalid uri_type in pkwk_script_uri_base()');
799         }
800 }
801
802 /**
803  * Create uri_type context
804  *
805  * @param $uri_type relative or absolute option
806  *        PKWK_URI_RELATIVE, PKWK_URI_ROOT or PKWK_URI_ABSOLUTE
807  */
808 function pkwk_base_uri_type_stack_push($uri_type)
809 {
810         _pkwk_base_uri_type_stack(false, true, $uri_type);
811 }
812
813 /**
814  * Stop current active uri_type context
815  */
816 function pkwk_base_uri_type_stack_pop()
817 {
818         _pkwk_base_uri_type_stack(false, false);
819 }
820
821 /**
822  * Get current active uri_type status
823  */
824 function pkwk_base_uri_type_stack_peek()
825 {
826         $type = _pkwk_base_uri_type_stack(true, false);
827         if (is_null($type)) {
828                 return PKWK_URI_RELATIVE;
829         } elseif ($type === PKWK_URI_ABSOLUTE) {
830                 return PKWK_URI_ABSOLUTE;
831         } elseif ($type === PKWK_URI_ROOT) {
832                 return PKWK_URI_ROOT;
833         } else {
834                 return PKWK_URI_RELATIVE;
835         }
836 }
837
838 /**
839  * uri_type context internal function
840  *
841  * @param $peek is peek action or not
842  * @param $push push(true) or pop(false) on not peeking
843  * @param $uri_type uri_type on push and non-peeking
844  * @return $uri_type uri_type for peeking
845  */
846 function _pkwk_base_uri_type_stack($peek, $push, $uri_type)
847 {
848         static $uri_types = array();
849         if ($peek) {
850                 // Peek: get latest value
851                 if (count($uri_types) === 0) {
852                         return null;
853                 } else {
854                         return $uri_types[0];
855                 }
856         } else {
857                 if ($push) {
858                         // Push $uri_type
859                         if (count($uri_types) === 0) {
860                                 array_unshift($uri_types, $uri_type);
861                         } else {
862                                 $prev_type = $uri_types[0];
863                                 if ($uri_type >= $prev_type) {
864                                         array_unshift($uri_types, $uri_type);
865                                 } else {
866                                         array_unshift($uri_types, $prev_type);
867                                 }
868                         }
869                 } else {
870                         // Pop $uri_type
871                         return array_shift($uri_types);
872                 }
873         }
874 }
875
876 /**
877  * Guess Script Absolute URI.
878  *
879  * SERVER_PORT: $_SERVER['SERVER_PORT'] converted in init.php
880  * SERVER_NAME: $_SERVER['SERVER_NAME'] converted in init.php
881  */
882 function guess_script_absolute_uri()
883 {
884         $port = SERVER_PORT;
885         $is_ssl = (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 }