2 // PukiWiki - Yet another WikiWikiWeb clone.
3 // $Id: make_link.php,v 1.19 2005/04/29 09:10:11 henoheno Exp $
4 // Copywrite (C) 2003-2005 PukiWiki Developers Team
5 // License: GPL v2 or (at your option) any later version
7 // Hyperlink-related functions
9 // Hyperlink decoration
10 function make_link($string, $page = '')
15 if (! isset($converter)) $converter = new InlineConverter();
17 $clone = $converter->get_clone($converter);
19 return $clone->convert($string, ($page != '') ? $page : $vars['page']);
22 // Converters of inline element
25 var $converters; // as array()
30 function get_clone($obj) {
33 if (! isset($clone_func)) {
34 if (version_compare(PHP_VERSION, '5.0.0', '<')) {
35 $clone_func = create_function('$a', 'return $a;');
37 $clone_func = create_function('$a', 'return clone $a;');
40 return $clone_func($obj);
44 $converters = array();
45 foreach ($this->converters as $key=>$converter) {
46 $converters[$key] = $this->get_clone($converter);
48 $this->converters = $converters;
51 function InlineConverter($converters = NULL, $excludes = NULL)
53 if ($converters === NULL) {
55 'plugin', // Inline plugins
58 'url_interwiki', // URLs (interwiki definition)
59 'mailto', // mailto: URL schemes
60 'interwikiname', // InterWikiNames
61 'autolink', // AutoLinks
62 'bracketname', // BracketNames
63 'wikiname', // WikiNames
64 'autolink_a', // AutoLinks(alphabet)
68 if ($excludes !== NULL)
69 $converters = array_diff($converters, $excludes);
71 $this->converters = $patterns = array();
74 foreach ($converters as $name) {
75 $classname = 'Link_' . $name;
76 $converter = new $classname($start);
77 $pattern = $converter->get_pattern();
78 if ($pattern === FALSE) continue;
80 $patterns[] = '(' . "\n" . $pattern . "\n" . ')';
81 $this->converters[$start] = $converter;
82 $start += $converter->get_count();
85 $this->pattern = join('|', $patterns);
88 function convert($string, $page)
91 $this->result = array();
93 $string = preg_replace_callback('/' . $this->pattern . '/x',
94 array(& $this, 'replace'), $string);
96 $arr = explode("\x08", make_line_rules(htmlspecialchars($string)));
98 while (! empty($arr)) {
99 $retval .= array_shift($arr) . array_shift($this->result);
104 function replace($arr)
106 $obj = $this->get_converter($arr);
108 $this->result[] = ($obj !== NULL && $obj->set($arr, $this->page) !== FALSE) ?
109 $obj->toString() : make_line_rules(htmlspecialchars($arr[0]));
111 return "\x08"; // Add a mark into latest processed part
114 function get_objects($string, $page)
116 $matches = $arr = array();
117 preg_match_all('/' . $this->pattern . '/x', $string, $matches, PREG_SET_ORDER);
118 foreach ($matches as $match) {
119 $obj = $this->get_converter($match);
120 if ($obj->set($match, $page) !== FALSE) {
121 $arr[] = $this->get_clone($obj);
122 if ($obj->body != '')
123 $arr = array_merge($arr, $this->get_objects($obj->body, $page));
129 function & get_converter(& $arr)
131 foreach (array_keys($this->converters) as $start) {
132 if ($arr[$start] == $arr[0])
133 return $this->converters[$start];
139 // Base class of inline elements
142 var $start; // Origin number of parentheses (0 origin)
143 var $text; // Matched string
152 function Link($start)
154 $this->start = $start;
157 // Return a regex pattern to match
158 function get_pattern() {}
160 // Return number of parentheses (except (?:...) )
161 function get_count() {}
163 // Set pattern that matches
164 function set($arr, $page) {}
166 function toString() {}
168 // Private: Get needed parts from a matched array()
169 function splice($arr) {
170 $count = $this->get_count() + 1;
171 $arr = array_pad(array_splice($arr, $this->start, $count), $count, '');
172 $this->text = $arr[0];
176 // Set basic parameters
177 function setParam($page, $name, $body, $type = '', $alias = '')
179 static $converter = NULL;
185 if (is_url($alias) && preg_match('/\.(gif|png|jpe?g)$/i', $alias)) {
186 $alias = htmlspecialchars($alias);
187 $alias = '<img src="' . $alias . '" alt="' . $name . '" />';
188 } else if ($alias != '') {
189 if ($converter === NULL)
190 $converter = new InlineConverter(array('plugin'));
192 $alias = make_line_rules($converter->convert($alias, $page));
194 // BugTrack/669: A hack removing anchor tags added by AutoLink
195 $alias = preg_replace('#</?a[^>]*>#i', '', $alias);
197 $this->alias = $alias;
204 class Link_plugin extends Link
209 function Link_plugin($start)
211 parent::Link($start);
214 function get_pattern()
216 $this->pattern = <<<EOD
219 (\w+) # (2) plugin name
222 ((?:(?!\)[;{]).)*) # (3) parameter
231 ((?:(?R)|(?!};).)*) # (4) body
243 function set($arr, $page)
245 list($all, $this->plain, $name, $this->param, $body) = $this->splice($arr);
247 // Re-get true plugin name and patameters (for PHP 4.1.2)
249 if (preg_match('/^' . $this->pattern . '/x', $all, $matches)
250 && $matches[1] != $this->plain)
251 list(, $this->plain, $name, $this->param) = $matches;
253 return parent::setParam($page, $name, $body, 'plugin');
258 $body = ($this->body == '') ? '' : make_link($this->body);
261 // Try to call the plugin
262 if (exist_plugin_inline($this->name))
263 $str = do_plugin_inline($this->name, $this->param, $body);
265 if ($str !== FALSE) {
266 return $str; // Succeed
268 // No such plugin, or Failed
269 $body = (($body == '') ? '' : '{' . $body . '}') . ';';
270 return make_line_rules(htmlspecialchars('&' . $this->plain) . $body);
276 class Link_note extends Link
278 function Link_note($start)
280 parent::Link($start);
283 function get_pattern()
287 ((?:(?R)|(?!\)\)).)*) # (1) note body
297 function set($arr, $page)
299 global $foot_explain, $vars;
302 list(, $body) = $this->splice($arr);
305 if (! PKWK_ALLOW_RELATIVE_FOOTNOTE_ANCHOR)
306 $script = get_script_uri() . '?' . $page;
309 $note = make_link($body);
310 $page = isset($vars['page']) ? rawurlencode($vars['page']) : '';
313 $foot_explain[$id] = '<a id="notefoot_' . $id . '" href="' .
314 $script . '#notetext_' . $id . '" class="note_super">*' .
315 $id . '</a>' . "\n" .
316 '<span class="small">' . $note . '</span><br />';
318 // A hyperlink, content-body to footnote
319 $name = '<a id="notetext_' . $id . '" href="' . $script .
320 '#notefoot_' . $id . '" class="note_super" title="' .
321 htmlspecialchars(strip_tags($note)) . '">*' . $id . '</a>';
323 return parent::setParam($page, $name, $body);
333 class Link_url extends Link
335 function Link_url($start)
337 parent::Link($start);
340 function get_pattern()
342 $s1 = $this->start + 1;
344 (\[\[ # (1) open bracket
345 ((?:(?!\]\]).)+) # (2) alias
349 (?:(?:https?|ftp|news):\/\/|mailto:)[\w\/\@\$()!?&%#:;.,~'=*+-]+
351 (?($s1)\]\]) # close bracket
360 function set($arr, $page)
362 list(, , $alias, $name) = $this->splice($arr);
363 return parent::setParam($page, htmlspecialchars($name),
364 '', 'url', $alias == '' ? $name : $alias);
372 $rel = ' rel="nofollow"';
374 return '<a href="' . $this->name . '"' . $rel . '>' . $this->alias . '</a>';
378 // URLs (InterWiki definition on "InterWikiName")
379 class Link_url_interwiki extends Link
381 function Link_url_interwiki($start)
383 parent::Link($start);
386 function get_pattern()
391 (?:(?:https?|ftp|news):\/\/|\.\.?\/)[!~*'();\/?:\@&=+\$,%#\w.-]*
404 function set($arr, $page)
406 list(, $name, $alias) = $this->splice($arr);
407 return parent::setParam($page, htmlspecialchars($name), '', 'url', $alias);
412 return '<a href="' . $this->name . '" rel="nofollow">' . $this->alias . '</a>';
416 // mailto: URL schemes
417 class Link_mailto extends Link
419 var $is_image, $image;
421 function Link_mailto($start)
423 parent::Link($start);
426 function get_pattern()
428 $s1 = $this->start + 1;
432 ((?:(?!\]\]).)+)(?:>|:) # (1) alias
434 ([\w.-]+@[\w-]+\.[\w.-]+) # (2) mailto
435 (?($s1)\]\]) # close bracket if (1)
444 function set($arr, $page)
446 list(, $alias, $name) = $this->splice($arr);
447 return parent::setParam($page, $name, '', 'mailto', $alias == '' ? $name : $alias);
452 return '<a href="mailto:' . $this->name . '" rel="nofollow">' . $this->alias . '</a>';
456 // InterWikiName-rendered URLs
457 class Link_interwikiname extends Link
463 function Link_interwikiname($start)
465 parent::Link($start);
468 function get_pattern()
470 $s2 = $this->start + 2;
471 $s5 = $this->start + 5;
475 ((?:(?!\]\]).)+)> # (1) alias
477 (\[\[)? # (2) open bracket
478 ((?:(?!\s|:|\]\]).)+) # (3) InterWiki
479 (?<! > | >\[\[ ) # not '>' or '>[['
482 (\[\[)? # (5) open bracket
484 (?($s5)\]\]) # close bracket if (5)
486 (?($s2)\]\]) # close bracket if (2)
496 function set($arr, $page)
500 list(, $alias, , $name, $this->param) = $this->splice($arr);
503 if (preg_match('/^([^#]+)(#[A-Za-z][\w-]*)$/', $this->param, $matches))
504 list(, $this->param, $this->anchor) = $matches;
506 $url = get_interwiki_url($name, $this->param);
507 $this->url = ($url === FALSE) ?
508 $script . '?' . rawurlencode('[[' . $name . ':' . $this->param . ']]') :
509 htmlspecialchars($url);
511 return parent::setParam(
513 htmlspecialchars($name . ':' . $this->param),
516 $alias == '' ? $name . ':' . $this->param : $alias
522 return '<a href="' . $this->url . $this->anchor . '" title="' .
523 $this->name . '" rel="nofollow">' . $this->alias . '</a>';
528 class Link_bracketname extends Link
532 function Link_bracketname($start)
534 parent::Link($start);
537 function get_pattern()
539 global $WikiName, $BracketName;
541 $s2 = $this->start + 2;
544 (?:((?:(?!\]\]).)+)>)? # (1) Alias
545 (\[\[)? # (2) Open bracket
551 (\#(?:[a-zA-Z][\w-]*)?)? # (4) Anchor
552 (?($s2)\]\]) # Close bracket if (2)
562 function set($arr, $page)
566 list(, $alias, , $name, $this->anchor) = $this->splice($arr);
567 if ($name == '' && $this->anchor == '') return FALSE;
569 if ($name == '' || ! preg_match('/^' . $WikiName . '$/', $name)) {
570 if ($alias == '') $alias = $name . $this->anchor;
572 $name = get_fullname($name, $page);
573 if (! is_pagename($name)) return FALSE;
577 return parent::setParam($page, $name, '', 'pagename', $alias);
582 return make_pagelink(
592 class Link_wikiname extends Link
594 function Link_wikiname($start)
596 parent::Link($start);
599 function get_pattern()
601 global $WikiName, $nowikiname;
603 return $nowikiname ? FALSE : '(' . $WikiName . ')';
611 function set($arr, $page)
613 list($name) = $this->splice($arr);
614 return parent::setParam($page, $name, '', 'pagename', $name);
619 return make_pagelink(
629 class Link_autolink extends Link
631 var $forceignorepages = array();
633 var $auto_a; // alphabet only
635 function Link_autolink($start)
639 parent::Link($start);
641 if (! $autolink || ! file_exists(CACHE_DIR . 'autolink.dat'))
644 @list($auto, $auto_a, $forceignorepages) = file(CACHE_DIR . 'autolink.dat');
646 $this->auto_a = $auto_a;
647 $this->forceignorepages = explode("\t", trim($forceignorepages));
650 function get_pattern()
652 return isset($this->auto) ? '(' . $this->auto . ')' : FALSE;
660 function set($arr, $page)
664 list($name) = $this->splice($arr);
666 // Ignore pages listed, or Expire ones not found
667 if (in_array($name, $this->forceignorepages) || ! is_page($name))
670 return parent::setParam($page, $name, '', 'pagename', $name);
675 return make_pagelink($this->name, $this->alias, '', $this->page);
679 class Link_autolink_a extends Link_autolink
681 function Link_autolink_a($start)
683 parent::Link_autolink($start);
686 function get_pattern()
688 return isset($this->auto_a) ? '(' . $this->auto_a . ')' : FALSE;
692 // Make hyperlink for the page
693 function make_pagelink($page, $alias = '', $anchor = '', $refer = '')
695 global $script, $vars, $link_compact, $related, $_symbol_noexists;
697 $s_page = htmlspecialchars(strip_bracket($page));
698 $s_alias = ($alias == '') ? $s_page : $alias;
700 if ($page == '') return '<a href="' . $anchor . '">' . $s_alias . '</a>';
702 $r_page = rawurlencode($page);
703 $r_refer = ($refer == '') ? '' : '&refer=' . rawurlencode($refer);
705 if (! isset($related[$page]) && $page != $vars['page'] && is_page($page))
706 $related[$page] = get_filetime($page);
708 if (is_page($page)) {
710 $passage = get_pg_passage($page, FALSE);
711 $title = $link_compact ? '' : ' title="' . $s_page . $passage . '"';
712 return '<a href="' . $script . '?' . $r_page . $anchor . '"' . $title . '>' .
714 } else if (PKWK_READONLY) {
715 // Without hyperlink (= Suppress dangling link)
719 $retval = $s_alias . '<a href="' .
720 $script . '?cmd=edit&page=' . $r_page . $r_refer . '">' .
721 $_symbol_noexists . '</a>';
723 $retval = '<span class="noexists">' . $retval . '</span>';
728 // Resolve relative / (Unix-like)absolute path of the page
729 function get_fullname($name, $refer)
734 if ($name == '' || $name == './') return $refer;
737 if ($name{0} == '/') {
738 $name = substr($name, 1);
739 return ($name == '') ? $defaultpage : $name;
742 // Relative path from 'Here'
743 if (substr($name, 0, 2) == './') {
744 $arrn = preg_split('#/#', $name, -1, PREG_SPLIT_NO_EMPTY);
746 return join('/', $arrn);
749 // Relative path from dirname()
750 if (substr($name, 0, 3) == '../') {
751 $arrn = preg_split('#/#', $name, -1, PREG_SPLIT_NO_EMPTY);
752 $arrp = preg_split('#/#', $refer, -1, PREG_SPLIT_NO_EMPTY);
754 while (! empty($arrn) && $arrn[0] == '..') {
758 $name = ! empty($arrp) ? join('/', array_merge($arrp, $arrn)) :
759 (! empty($arrn) ? $defaultpage . '/' . join('/', $arrn) : $defaultpage);
765 // Render an InterWiki into a URL
766 function get_interwiki_url($name, $param)
768 global $WikiName, $interwiki;
769 static $interwikinames;
770 static $encode_aliases = array('sjis'=>'SJIS', 'euc'=>'EUC-JP', 'utf8'=>'UTF-8');
772 if (! isset($interwikinames)) {
773 $interwikinames = $matches = array();
774 foreach (get_source($interwiki) as $line)
775 if (preg_match('/\[(' . '(?:(?:https?|ftp|news):\/\/|\.\.?\/)' .
776 '[!~*\'();\/?:\@&=+\$,%#\w.-]*)\s([^\]]+)\]\s?([^\s]*)/',
778 $interwikinames[$matches[2]] = array($matches[1], $matches[3]);
781 if (! isset($interwikinames[$name])) return FALSE;
783 list($url, $opt) = $interwikinames[$name];
789 case 'std': // As-Is (Internal encoding of this PukiWiki will be used)
790 $param = rawurlencode($param);
793 case 'asis': // As-Is
795 // $param = htmlspecialchars($param);
798 case 'yw': // YukiWiki
799 if (! preg_match('/' . $WikiName . '/', $param))
800 $param = '[[' . mb_convert_encoding($param, 'SJIS', SOURCE_ENCODING) . ']]';
801 // $param = htmlspecialchars($param);
804 case 'moin': // MoinMoin
805 $param = str_replace('%', '_', rawurlencode($param));
810 if (isset($encode_aliases[$opt])) $opt = $encode_aliases[$opt];
811 // Encoding conversion into specified encode, and URLencode
812 $param = rawurlencode(mb_convert_encoding($param, $opt, 'auto'));
815 // Replace parameters
816 if (strpos($url, '$1') !== FALSE) {
817 $url = str_replace('$1', $param, $url);
823 if ($len > 512) die_message('InterWiki URL too long: ' . $len . ' characters');