2 // PukiWiki - Yet another WikiWikiWeb clone.
3 // $Id: make_link.php,v 1.17 2005/02/05 03:40:13 henoheno Exp $
5 // Hyperlink-related functions
7 // Hyperlink decoration
8 function make_link($string, $page = '')
13 if (! isset($converter)) $converter = new InlineConverter();
15 $clone = $converter->get_clone($converter);
17 return $clone->convert($string, ($page != '') ? $page : $vars['page']);
20 // Converters of inline element
23 var $converters; // as array()
28 function get_clone($obj) {
31 if (! isset($clone_func)) {
32 if (version_compare(PHP_VERSION, '5.0.0', '<')) {
33 $clone_func = create_function('$a', 'return $a;');
35 $clone_func = create_function('$a', 'return clone $a;');
38 return $clone_func($obj);
42 $converters = array();
43 foreach ($this->converters as $key=>$converter) {
44 $converters[$key] = $this->get_clone($converter);
46 $this->converters = $converters;
49 function InlineConverter($converters = NULL, $excludes = NULL)
51 if ($converters === NULL) {
53 'plugin', // Inline plugins
56 'url_interwiki', // URLs (interwiki definition)
57 'mailto', // mailto: URL schemes
58 'interwikiname', // InterWikiNames
59 'autolink', // AutoLinks
60 'bracketname', // BracketNames
61 'wikiname', // WikiNames
62 'autolink_a', // AutoLinks(alphabet)
66 if ($excludes !== NULL)
67 $converters = array_diff($converters, $excludes);
69 $this->converters = $patterns = array();
72 foreach ($converters as $name) {
73 $classname = 'Link_' . $name;
74 $converter = new $classname($start);
75 $pattern = $converter->get_pattern();
76 if ($pattern === FALSE) continue;
78 $patterns[] = '(' . "\n" . $pattern . "\n" . ')';
79 $this->converters[$start] = $converter;
80 $start += $converter->get_count();
83 $this->pattern = join('|', $patterns);
86 function convert($string, $page)
89 $this->result = array();
91 $string = preg_replace_callback('/' . $this->pattern . '/x',
92 array(& $this, 'replace'), $string);
94 $arr = explode("\x08", make_line_rules(htmlspecialchars($string)));
96 while (! empty($arr)) {
97 $retval .= array_shift($arr) . array_shift($this->result);
102 function replace($arr)
104 $obj = $this->get_converter($arr);
106 $this->result[] = ($obj !== NULL && $obj->set($arr, $this->page) !== FALSE) ?
107 $obj->toString() : make_line_rules(htmlspecialchars($arr[0]));
109 return "\x08"; // Add a mark into latest processed part
112 function get_objects($string, $page)
114 $matches = $arr = array();
115 preg_match_all('/' . $this->pattern . '/x', $string, $matches, PREG_SET_ORDER);
116 foreach ($matches as $match) {
117 $obj = $this->get_converter($match);
118 if ($obj->set($match, $page) !== FALSE) {
119 $arr[] = $this->get_clone($obj);
120 if ($obj->body != '')
121 $arr = array_merge($arr, $this->get_objects($obj->body, $page));
127 function & get_converter(& $arr)
129 foreach (array_keys($this->converters) as $start) {
130 if ($arr[$start] == $arr[0])
131 return $this->converters[$start];
137 // Base class of inline elements
140 var $start; // Origin number of parentheses (0 origin)
141 var $text; // Matched string
150 function Link($start)
152 $this->start = $start;
155 // Return a regex pattern to match
156 function get_pattern() {}
158 // Return number of parentheses (except (?:...) )
159 function get_count() {}
161 // Set pattern that matches
162 function set($arr, $page) {}
164 function toString() {}
166 // Private: Get needed parts from a matched array()
167 function splice($arr) {
168 $count = $this->get_count() + 1;
169 $arr = array_pad(array_splice($arr, $this->start, $count), $count, '');
170 $this->text = $arr[0];
174 // Set basic parameters
175 function setParam($page, $name, $body, $type = '', $alias = '')
177 static $converter = NULL;
183 if (is_url($alias) && preg_match('/\.(gif|png|jpe?g)$/i', $alias)) {
184 $alias = htmlspecialchars($alias);
185 $alias = '<img src="' . $alias . '" alt="' . $name . '" />';
186 } else if ($alias != '') {
187 if ($converter === NULL)
188 $converter = new InlineConverter(array('plugin'));
190 $alias = make_line_rules($converter->convert($alias, $page));
192 // BugTrack/669: A hack removing anchor tags added by AutoLink
193 $alias = preg_replace('#</?a[^>]*>#i', '', $alias);
195 $this->alias = $alias;
202 class Link_plugin extends Link
207 function Link_plugin($start)
209 parent::Link($start);
212 function get_pattern()
214 $this->pattern = <<<EOD
217 (\w+) # (2) plugin name
220 ((?:(?!\)[;{]).)*) # (3) parameter
229 ((?:(?R)|(?!};).)*) # (4) body
241 function set($arr, $page)
243 list($all, $this->plain, $name, $this->param, $body) = $this->splice($arr);
245 // Re-get true plugin name and patameters (for PHP 4.1.2)
247 if (preg_match('/^' . $this->pattern . '/x', $all, $matches)
248 && $matches[1] != $this->plain)
249 list(, $this->plain, $name, $this->param) = $matches;
251 return parent::setParam($page, $name, $body, 'plugin');
256 $body = ($this->body == '') ? '' : make_link($this->body);
259 // Try to call the plugin
260 if (exist_plugin_inline($this->name))
261 $str = do_plugin_inline($this->name, $this->param, $body);
263 if ($str !== FALSE) {
264 return $str; // Succeed
266 // No such plugin, or Failed
267 $body = (($body == '') ? '' : '{' . $body . '}') . ';';
268 return make_line_rules(htmlspecialchars('&' . $this->plain) . $body);
274 class Link_note extends Link
276 function Link_note($start)
278 parent::Link($start);
281 function get_pattern()
285 ((?:(?R)|(?!\)\)).)*) # (1) note body
295 function set($arr, $page)
297 global $foot_explain, $script, $vars;
300 list(, $body) = $this->splice($arr);
303 $note = make_link($body);
304 $page = isset($vars['page']) ? rawurlencode($vars['page']) : '';
307 $foot_explain[$id] = '<a id="notefoot_' . $id . '" href="' .
308 $script . '?' . $page . '#notetext_' . $id .
309 '" class="note_super">*' . $id . '</a>' . "\n" .
310 '<span class="small">' . $note . '</span><br />';
312 // A hyperlink, content-body to footnote
313 $name = '<a id="notetext_' . $id . '" href="' . $script . '?' . $page .
314 '#notefoot_' . $id . '" class="note_super" title="' .
315 htmlspecialchars(strip_tags($note)) . '">*' . $id . '</a>';
317 return parent::setParam($page, $name, $body);
327 class Link_url extends Link
329 function Link_url($start)
331 parent::Link($start);
334 function get_pattern()
336 $s1 = $this->start + 1;
338 (\[\[ # (1) open bracket
339 ((?:(?!\]\]).)+) # (2) alias
343 (?:(?:https?|ftp|news):\/\/|mailto:)[\w\/\@\$()!?&%#:;.,~'=*+-]+
345 (?($s1)\]\]) # close bracket
354 function set($arr, $page)
356 list(, , $alias, $name) = $this->splice($arr);
357 return parent::setParam($page, htmlspecialchars($name),
358 '', 'url', $alias == '' ? $name : $alias);
366 $rel = ' rel="nofollow"';
368 return '<a href="' . $this->name . '"' . $rel . '>' . $this->alias . '</a>';
372 // URLs (InterWiki definition on "InterWikiName")
373 class Link_url_interwiki extends Link
375 function Link_url_interwiki($start)
377 parent::Link($start);
380 function get_pattern()
385 (?:(?:https?|ftp|news):\/\/|\.\.?\/)[!~*'();\/?:\@&=+\$,%#\w.-]*
398 function set($arr, $page)
400 list(, $name, $alias) = $this->splice($arr);
401 return parent::setParam($page, htmlspecialchars($name), '', 'url', $alias);
406 return '<a href="' . $this->name . '" rel="nofollow">' . $this->alias . '</a>';
410 // mailto: URL schemes
411 class Link_mailto extends Link
413 var $is_image, $image;
415 function Link_mailto($start)
417 parent::Link($start);
420 function get_pattern()
422 $s1 = $this->start + 1;
426 ((?:(?!\]\]).)+)(?:>|:) # (1) alias
428 ([\w.-]+@[\w-]+\.[\w.-]+) # (2) mailto
429 (?($s1)\]\]) # close bracket if (1)
438 function set($arr, $page)
440 list(, $alias, $name) = $this->splice($arr);
441 return parent::setParam($page, $name, '', 'mailto', $alias == '' ? $name : $alias);
446 return '<a href="mailto:' . $this->name . '" rel="nofollow">' . $this->alias . '</a>';
450 // InterWikiName-rendered URLs
451 class Link_interwikiname extends Link
457 function Link_interwikiname($start)
459 parent::Link($start);
462 function get_pattern()
464 $s2 = $this->start + 2;
465 $s5 = $this->start + 5;
469 ((?:(?!\]\]).)+)> # (1) alias
471 (\[\[)? # (2) open bracket
472 ((?:(?!\s|:|\]\]).)+) # (3) InterWiki
473 (?<! > | >\[\[ ) # not '>' or '>[['
476 (\[\[)? # (5) open bracket
478 (?($s5)\]\]) # close bracket if (5)
480 (?($s2)\]\]) # close bracket if (2)
490 function set($arr, $page)
494 list(, $alias, , $name, $this->param) = $this->splice($arr);
497 if (preg_match('/^([^#]+)(#[A-Za-z][\w-]*)$/', $this->param, $matches))
498 list(, $this->param, $this->anchor) = $matches;
500 $url = get_interwiki_url($name, $this->param);
501 $this->url = ($url === FALSE) ?
502 $script . '?' . rawurlencode('[[' . $name . ':' . $this->param . ']]') :
503 htmlspecialchars($url);
505 return parent::setParam(
507 htmlspecialchars($name . ':' . $this->param),
510 $alias == '' ? $name . ':' . $this->param : $alias
516 return '<a href="' . $this->url . $this->anchor . '" title="' .
517 $this->name . '" rel="nofollow">' . $this->alias . '</a>';
522 class Link_bracketname extends Link
526 function Link_bracketname($start)
528 parent::Link($start);
531 function get_pattern()
533 global $WikiName, $BracketName;
535 $s2 = $this->start + 2;
538 (?:((?:(?!\]\]).)+)>)? # (1) Alias
539 (\[\[)? # (2) Open bracket
545 (\#(?:[a-zA-Z][\w-]*)?)? # (4) Anchor
546 (?($s2)\]\]) # Close bracket if (2)
556 function set($arr, $page)
560 list(, $alias, , $name, $this->anchor) = $this->splice($arr);
561 if ($name == '' && $this->anchor == '') return FALSE;
563 if ($name == '' || ! preg_match('/^' . $WikiName . '$/', $name)) {
564 if ($alias == '') $alias = $name . $this->anchor;
566 $name = get_fullname($name, $page);
567 if (! is_pagename($name)) return FALSE;
571 return parent::setParam($page, $name, '', 'pagename', $alias);
576 return make_pagelink(
586 class Link_wikiname extends Link
588 function Link_wikiname($start)
590 parent::Link($start);
593 function get_pattern()
595 global $WikiName, $nowikiname;
597 return $nowikiname ? FALSE : '(' . $WikiName . ')';
605 function set($arr, $page)
607 list($name) = $this->splice($arr);
608 return parent::setParam($page, $name, '', 'pagename', $name);
613 return make_pagelink(
623 class Link_autolink extends Link
625 var $forceignorepages = array();
627 var $auto_a; // alphabet only
629 function Link_autolink($start)
633 parent::Link($start);
635 if (! $autolink || ! file_exists(CACHE_DIR . 'autolink.dat'))
638 @list($auto, $auto_a, $forceignorepages) = file(CACHE_DIR . 'autolink.dat');
640 $this->auto_a = $auto_a;
641 $this->forceignorepages = explode("\t", trim($forceignorepages));
644 function get_pattern()
646 return isset($this->auto) ? '(' . $this->auto . ')' : FALSE;
654 function set($arr, $page)
658 list($name) = $this->splice($arr);
660 // Ignore pages listed, or Expire ones not found
661 if (in_array($name, $this->forceignorepages) || ! is_page($name))
664 return parent::setParam($page, $name, '', 'pagename', $name);
669 return make_pagelink($this->name, $this->alias, '', $this->page);
673 class Link_autolink_a extends Link_autolink
675 function Link_autolink_a($start)
677 parent::Link_autolink($start);
680 function get_pattern()
682 return isset($this->auto_a) ? '(' . $this->auto_a . ')' : FALSE;
686 // Make hyperlink for the page
687 function make_pagelink($page, $alias = '', $anchor = '', $refer = '')
689 global $script, $vars, $link_compact, $related, $_symbol_noexists;
691 $s_page = htmlspecialchars(strip_bracket($page));
692 $s_alias = ($alias == '') ? $s_page : $alias;
694 if ($page == '') return '<a href="' . $anchor . '">' . $s_alias . '</a>';
696 $r_page = rawurlencode($page);
697 $r_refer = ($refer == '') ? '' : '&refer=' . rawurlencode($refer);
699 if (! isset($related[$page]) && $page != $vars['page'] && is_page($page))
700 $related[$page] = get_filetime($page);
702 if (is_page($page)) {
704 $passage = get_pg_passage($page, FALSE);
705 $title = $link_compact ? '' : ' title="' . $s_page . $passage . '"';
706 return '<a href="' . $script . '?' . $r_page . $anchor . '"' . $title . '>' .
708 } else if (PKWK_READONLY) {
709 // Without hyperlink (= Suppress dangling link)
713 $retval = $s_alias . '<a href="' .
714 $script . '?cmd=edit&page=' . $r_page . $r_refer . '">' .
715 $_symbol_noexists . '</a>';
717 $retval = '<span class="noexists">' . $retval . '</span>';
722 // Resolve relative / (Unix-like)absolute path of the page
723 function get_fullname($name, $refer)
728 if ($name == '' || $name == './') return $refer;
731 if ($name{0} == '/') {
732 $name = substr($name, 1);
733 return ($name == '') ? $defaultpage : $name;
736 // Relative path from 'Here'
737 if (substr($name, 0, 2) == './') {
738 $arrn = preg_split('#/#', $name, -1, PREG_SPLIT_NO_EMPTY);
740 return join('/', $arrn);
743 // Relative path from dirname()
744 if (substr($name, 0, 3) == '../') {
745 $arrn = preg_split('#/#', $name, -1, PREG_SPLIT_NO_EMPTY);
746 $arrp = preg_split('#/#', $refer, -1, PREG_SPLIT_NO_EMPTY);
748 while (! empty($arrn) && $arrn[0] == '..') {
752 $name = ! empty($arrp) ? join('/', array_merge($arrp, $arrn)) :
753 (! empty($arrn) ? $defaultpage . '/' . join('/', $arrn) : $defaultpage);
759 // Render an InterWiki into a URL
760 function get_interwiki_url($name, $param)
762 global $WikiName, $interwiki;
763 static $interwikinames;
764 static $encode_aliases = array('sjis'=>'SJIS', 'euc'=>'EUC-JP', 'utf8'=>'UTF-8');
766 if (! isset($interwikinames)) {
767 $interwikinames = $matches = array();
768 foreach (get_source($interwiki) as $line)
769 if (preg_match('/\[(' . '(?:(?:https?|ftp|news):\/\/|\.\.?\/)' .
770 '[!~*\'();\/?:\@&=+\$,%#\w.-]*)\s([^\]]+)\]\s?([^\s]*)/',
772 $interwikinames[$matches[2]] = array($matches[1], $matches[3]);
775 if (! isset($interwikinames[$name])) return FALSE;
777 list($url, $opt) = $interwikinames[$name];
783 case 'std': // As-Is (Internal encoding of this PukiWiki will be used)
784 $param = rawurlencode($param);
787 case 'asis': // As-Is
789 // $param = htmlspecialchars($param);
792 case 'yw': // YukiWiki
793 if (! preg_match('/' . $WikiName . '/', $param))
794 $param = '[[' . mb_convert_encoding($param, 'SJIS', SOURCE_ENCODING) . ']]';
795 // $param = htmlspecialchars($param);
798 case 'moin': // MoinMoin
799 $param = str_replace('%', '_', rawurlencode($param));
804 if (isset($encode_aliases[$opt])) $opt = $encode_aliases[$opt];
805 // Encoding conversion into specified encode, and URLencode
806 $param = rawurlencode(mb_convert_encoding($param, $opt, 'auto'));
809 // Replace parameters
810 if (strpos($url, '$1') !== FALSE) {
811 $url = str_replace('$1', $param, $url);
817 if ($len > 512) die_message('InterWiki URL too long: ' . $len . ' characters');