2 // PukiWiki - Yet another WikiWikiWeb clone.
3 // $Id: make_link.php,v 1.30 2005/12/10 07:57:30 henoheno Exp $
5 // 2003-2005 PukiWiki Developers Team
6 // 2001-2002 Originally written by yu-ji
7 // License: GPL v2 or (at your option) any later version
9 // Hyperlink-related functions
11 // Hyperlink decoration
12 function make_link($string, $page = '')
17 if (! isset($converter)) $converter = new InlineConverter();
19 $clone = $converter->get_clone($converter);
21 return $clone->convert($string, ($page != '') ? $page : $vars['page']);
24 // Converters of inline element
27 var $converters; // as array()
32 function get_clone($obj) {
35 if (! isset($clone_func)) {
36 if (version_compare(PHP_VERSION, '5.0.0', '<')) {
37 $clone_func = create_function('$a', 'return $a;');
39 $clone_func = create_function('$a', 'return clone $a;');
42 return $clone_func($obj);
46 $converters = array();
47 foreach ($this->converters as $key=>$converter) {
48 $converters[$key] = $this->get_clone($converter);
50 $this->converters = $converters;
53 function InlineConverter($converters = NULL, $excludes = NULL)
55 if ($converters === NULL) {
57 'plugin', // Inline plugins
60 'url_interwiki', // URLs (interwiki definition)
61 'mailto', // mailto: URL schemes
62 'interwikiname', // InterWikiNames
63 'autolink', // AutoLinks
64 'bracketname', // BracketNames
65 'wikiname', // WikiNames
66 'autolink_a', // AutoLinks(alphabet)
70 if ($excludes !== NULL)
71 $converters = array_diff($converters, $excludes);
73 $this->converters = $patterns = array();
76 foreach ($converters as $name) {
77 $classname = 'Link_' . $name;
78 $converter = new $classname($start);
79 $pattern = $converter->get_pattern();
80 if ($pattern === FALSE) continue;
82 $patterns[] = '(' . "\n" . $pattern . "\n" . ')';
83 $this->converters[$start] = $converter;
84 $start += $converter->get_count();
87 $this->pattern = join('|', $patterns);
90 function convert($string, $page)
93 $this->result = array();
95 $string = preg_replace_callback('/' . $this->pattern . '/x',
96 array(& $this, 'replace'), $string);
98 $arr = explode("\x08", make_line_rules(htmlspecialchars($string)));
100 while (! empty($arr)) {
101 $retval .= array_shift($arr) . array_shift($this->result);
106 function replace($arr)
108 $obj = $this->get_converter($arr);
110 $this->result[] = ($obj !== NULL && $obj->set($arr, $this->page) !== FALSE) ?
111 $obj->toString() : make_line_rules(htmlspecialchars($arr[0]));
113 return "\x08"; // Add a mark into latest processed part
116 function get_objects($string, $page)
118 $matches = $arr = array();
119 preg_match_all('/' . $this->pattern . '/x', $string, $matches, PREG_SET_ORDER);
120 foreach ($matches as $match) {
121 $obj = $this->get_converter($match);
122 if ($obj->set($match, $page) !== FALSE) {
123 $arr[] = $this->get_clone($obj);
124 if ($obj->body != '')
125 $arr = array_merge($arr, $this->get_objects($obj->body, $page));
131 function & get_converter(& $arr)
133 foreach (array_keys($this->converters) as $start) {
134 if ($arr[$start] == $arr[0])
135 return $this->converters[$start];
141 // Base class of inline elements
144 var $start; // Origin number of parentheses (0 origin)
145 var $text; // Matched string
154 function Link($start)
156 $this->start = $start;
159 // Return a regex pattern to match
160 function get_pattern() {}
162 // Return number of parentheses (except (?:...) )
163 function get_count() {}
165 // Set pattern that matches
166 function set($arr, $page) {}
168 function toString() {}
170 // Private: Get needed parts from a matched array()
171 function splice($arr)
173 $count = $this->get_count() + 1;
174 $arr = array_pad(array_splice($arr, $this->start, $count), $count, '');
175 $this->text = $arr[0];
179 // Set basic parameters
180 function setParam($page, $name, $body, $type = '', $alias = '')
182 static $converter = NULL;
188 if (! PKWK_DISABLE_INLINE_IMAGE_FROM_URI &&
189 is_url($alias) && preg_match('/\.(gif|png|jpe?g)$/i', $alias)) {
190 $alias = '<img src="' . htmlspecialchars($alias) . '" alt="' . $name . '" />';
191 } else if ($alias != '') {
192 if ($converter === NULL)
193 $converter = new InlineConverter(array('plugin'));
195 $alias = make_line_rules($converter->convert($alias, $page));
197 // BugTrack/669: A hack removing anchor tags added by AutoLink
198 $alias = preg_replace('#</?a[^>]*>#i', '', $alias);
200 $this->alias = $alias;
207 class Link_plugin extends Link
212 function Link_plugin($start)
214 parent::Link($start);
217 function get_pattern()
219 $this->pattern = <<<EOD
222 (\w+) # (2) plugin name
225 ((?:(?!\)[;{]).)*) # (3) parameter
234 ((?:(?R)|(?!};).)*) # (4) body
246 function set($arr, $page)
248 list($all, $this->plain, $name, $this->param, $body) = $this->splice($arr);
250 // Re-get true plugin name and patameters (for PHP 4.1.2)
252 if (preg_match('/^' . $this->pattern . '/x', $all, $matches)
253 && $matches[1] != $this->plain)
254 list(, $this->plain, $name, $this->param) = $matches;
256 return parent::setParam($page, $name, $body, 'plugin');
261 $body = ($this->body == '') ? '' : make_link($this->body);
264 // Try to call the plugin
265 if (exist_plugin_inline($this->name))
266 $str = do_plugin_inline($this->name, $this->param, $body);
268 if ($str !== FALSE) {
269 return $str; // Succeed
271 // No such plugin, or Failed
272 $body = (($body == '') ? '' : '{' . $body . '}') . ';';
273 return make_line_rules(htmlspecialchars('&' . $this->plain) . $body);
279 class Link_note extends Link
281 function Link_note($start)
283 parent::Link($start);
286 function get_pattern()
290 ((?:(?R)|(?!\)\)).)*) # (1) note body
300 function set($arr, $page)
302 global $foot_explain, $vars;
305 list(, $body) = $this->splice($arr);
307 if (PKWK_ALLOW_RELATIVE_FOOTNOTE_ANCHOR) {
310 $script = get_script_uri() . '?' . rawurlencode($page);
314 $note = make_link($body);
315 $page = isset($vars['page']) ? rawurlencode($vars['page']) : '';
318 $foot_explain[$id] = '<a id="notefoot_' . $id . '" href="' .
319 $script . '#notetext_' . $id . '" class="note_super">*' .
320 $id . '</a>' . "\n" .
321 '<span class="small">' . $note . '</span><br />';
323 // A hyperlink, content-body to footnote
324 if (! is_numeric(PKWK_FOOTNOTE_TITLE_MAX) || PKWK_FOOTNOTE_TITLE_MAX <= 0) {
327 $title = strip_tags($note);
328 $count = mb_strlen($title, SOURCE_ENCODING);
329 $title = mb_substr($title, 0, PKWK_FOOTNOTE_TITLE_MAX, SOURCE_ENCODING);
330 $abbr = (mb_strlen($title) < $count) ? '...' : '';
331 $title = ' title="' . $title . $abbr . '"';
333 $name = '<a id="notetext_' . $id . '" href="' . $script .
334 '#notefoot_' . $id . '" class="note_super"' . $title .
337 return parent::setParam($page, $name, $body);
347 class Link_url extends Link
349 function Link_url($start)
351 parent::Link($start);
354 function get_pattern()
356 $s1 = $this->start + 1;
358 (\[\[ # (1) open bracket
359 ((?:(?!\]\]).)+) # (2) alias
363 (?:(?:https?|ftp|news):\/\/|mailto:)[\w\/\@\$()!?&%#:;.,~'=*+-]+
365 (?($s1)\]\]) # close bracket
374 function set($arr, $page)
376 list(, , $alias, $name) = $this->splice($arr);
377 return parent::setParam($page, htmlspecialchars($name),
378 '', 'url', $alias == '' ? $name : $alias);
386 $rel = ' rel="nofollow"';
388 return '<a href="' . $this->name . '"' . $rel . '>' . $this->alias . '</a>';
392 // URLs (InterWiki definition on "InterWikiName")
393 class Link_url_interwiki extends Link
395 function Link_url_interwiki($start)
397 parent::Link($start);
400 function get_pattern()
405 (?:(?:https?|ftp|news):\/\/|\.\.?\/)[!~*'();\/?:\@&=+\$,%#\w.-]*
418 function set($arr, $page)
420 list(, $name, $alias) = $this->splice($arr);
421 return parent::setParam($page, htmlspecialchars($name), '', 'url', $alias);
426 return '<a href="' . $this->name . '" rel="nofollow">' . $this->alias . '</a>';
430 // mailto: URL schemes
431 class Link_mailto extends Link
433 var $is_image, $image;
435 function Link_mailto($start)
437 parent::Link($start);
440 function get_pattern()
442 $s1 = $this->start + 1;
446 ((?:(?!\]\]).)+)(?:>|:) # (1) alias
448 ([\w.-]+@[\w-]+\.[\w.-]+) # (2) mailto
449 (?($s1)\]\]) # close bracket if (1)
458 function set($arr, $page)
460 list(, $alias, $name) = $this->splice($arr);
461 return parent::setParam($page, $name, '', 'mailto', $alias == '' ? $name : $alias);
466 return '<a href="mailto:' . $this->name . '" rel="nofollow">' . $this->alias . '</a>';
470 // InterWikiName-rendered URLs
471 class Link_interwikiname extends Link
477 function Link_interwikiname($start)
479 parent::Link($start);
482 function get_pattern()
484 $s2 = $this->start + 2;
485 $s5 = $this->start + 5;
489 ((?:(?!\]\]).)+)> # (1) alias
491 (\[\[)? # (2) open bracket
492 ((?:(?!\s|:|\]\]).)+) # (3) InterWiki
493 (?<! > | >\[\[ ) # not '>' or '>[['
496 (\[\[)? # (5) open bracket
498 (?($s5)\]\]) # close bracket if (5)
500 (?($s2)\]\]) # close bracket if (2)
510 function set($arr, $page)
514 list(, $alias, , $name, $this->param) = $this->splice($arr);
517 if (preg_match('/^([^#]+)(#[A-Za-z][\w-]*)$/', $this->param, $matches))
518 list(, $this->param, $this->anchor) = $matches;
520 $url = get_interwiki_url($name, $this->param);
521 $this->url = ($url === FALSE) ?
522 $script . '?' . rawurlencode('[[' . $name . ':' . $this->param . ']]') :
523 htmlspecialchars($url);
525 return parent::setParam(
527 htmlspecialchars($name . ':' . $this->param),
530 $alias == '' ? $name . ':' . $this->param : $alias
536 return '<a href="' . $this->url . $this->anchor . '" title="' .
537 $this->name . '" rel="nofollow">' . $this->alias . '</a>';
542 class Link_bracketname extends Link
546 function Link_bracketname($start)
548 parent::Link($start);
551 function get_pattern()
553 global $WikiName, $BracketName;
555 $s2 = $this->start + 2;
558 (?:((?:(?!\]\]).)+)>)? # (1) Alias
559 (\[\[)? # (2) Open bracket
565 (\#(?:[a-zA-Z][\w-]*)?)? # (4) Anchor
566 (?($s2)\]\]) # Close bracket if (2)
576 function set($arr, $page)
580 list(, $alias, , $name, $this->anchor) = $this->splice($arr);
581 if ($name == '' && $this->anchor == '') return FALSE;
583 if ($name == '' || ! preg_match('/^' . $WikiName . '$/', $name)) {
584 if ($alias == '') $alias = $name . $this->anchor;
586 $name = get_fullname($name, $page);
587 if (! is_pagename($name)) return FALSE;
591 return parent::setParam($page, $name, '', 'pagename', $alias);
596 return make_pagelink(
606 class Link_wikiname extends Link
608 function Link_wikiname($start)
610 parent::Link($start);
613 function get_pattern()
615 global $WikiName, $nowikiname;
617 return $nowikiname ? FALSE : '(' . $WikiName . ')';
625 function set($arr, $page)
627 list($name) = $this->splice($arr);
628 return parent::setParam($page, $name, '', 'pagename', $name);
633 return make_pagelink(
643 class Link_autolink extends Link
645 var $forceignorepages = array();
647 var $auto_a; // alphabet only
649 function Link_autolink($start)
653 parent::Link($start);
655 if (! $autolink || ! file_exists(CACHE_DIR . 'autolink.dat'))
658 @list($auto, $auto_a, $forceignorepages) = file(CACHE_DIR . 'autolink.dat');
660 $this->auto_a = $auto_a;
661 $this->forceignorepages = explode("\t", trim($forceignorepages));
664 function get_pattern()
666 return isset($this->auto) ? '(' . $this->auto . ')' : FALSE;
674 function set($arr, $page)
678 list($name) = $this->splice($arr);
680 // Ignore pages listed, or Expire ones not found
681 if (in_array($name, $this->forceignorepages) || ! is_page($name))
684 return parent::setParam($page, $name, '', 'pagename', $name);
689 return make_pagelink($this->name, $this->alias, '', $this->page, TRUE);
693 class Link_autolink_a extends Link_autolink
695 function Link_autolink_a($start)
697 parent::Link_autolink($start);
700 function get_pattern()
702 return isset($this->auto_a) ? '(' . $this->auto_a . ')' : FALSE;
706 // Make hyperlink for the page
707 function make_pagelink($page, $alias = '', $anchor = '', $refer = '', $isautolink = FALSE)
709 global $script, $vars, $link_compact, $related, $_symbol_noexists;
711 $s_page = htmlspecialchars(strip_bracket($page));
712 $s_alias = ($alias == '') ? $s_page : $alias;
714 if ($page == '') return '<a href="' . $anchor . '">' . $s_alias . '</a>';
716 $r_page = rawurlencode($page);
717 $r_refer = ($refer == '') ? '' : '&refer=' . rawurlencode($refer);
719 if (! isset($related[$page]) && $page != $vars['page'] && is_page($page))
720 $related[$page] = get_filetime($page);
722 if ($isautolink || is_page($page)) {
723 // Hyperlink to the page
727 $title = ' title="' . $s_page . get_pg_passage($page, FALSE) . '"';
732 $al_left = '<!--autolink-->';
733 $al_right = '<!--/autolink-->';
735 $al_left = $al_right = '';
738 return $al_left . '<a ' . 'href="' . $script . '?' . $r_page . $anchor .
739 '"' . $title . '>' . $s_alias . '</a>' . $al_right;
742 if (PKWK_READONLY) return $s_alias; // No dacorations
744 $retval = $s_alias . '<a href="' .
745 $script . '?cmd=edit&page=' . $r_page . $r_refer . '">' .
746 $_symbol_noexists . '</a>';
751 return '<span class="noexists">' . $retval . '</span>';
756 // Resolve relative / (Unix-like)absolute path of the page
757 function get_fullname($name, $refer)
762 if ($name == '' || $name == './') return $refer;
765 if ($name{0} == '/') {
766 $name = substr($name, 1);
767 return ($name == '') ? $defaultpage : $name;
770 // Relative path from 'Here'
771 if (substr($name, 0, 2) == './') {
772 $arrn = preg_split('#/#', $name, -1, PREG_SPLIT_NO_EMPTY);
774 return join('/', $arrn);
777 // Relative path from dirname()
778 if (substr($name, 0, 3) == '../') {
779 $arrn = preg_split('#/#', $name, -1, PREG_SPLIT_NO_EMPTY);
780 $arrp = preg_split('#/#', $refer, -1, PREG_SPLIT_NO_EMPTY);
782 while (! empty($arrn) && $arrn[0] == '..') {
786 $name = ! empty($arrp) ? join('/', array_merge($arrp, $arrn)) :
787 (! empty($arrn) ? $defaultpage . '/' . join('/', $arrn) : $defaultpage);
793 // Render an InterWiki into a URL
794 function get_interwiki_url($name, $param)
796 global $WikiName, $interwiki;
797 static $interwikinames;
798 static $encode_aliases = array('sjis'=>'SJIS', 'euc'=>'EUC-JP', 'utf8'=>'UTF-8');
800 if (! isset($interwikinames)) {
801 $interwikinames = $matches = array();
802 foreach (get_source($interwiki) as $line)
803 if (preg_match('/\[(' . '(?:(?:https?|ftp|news):\/\/|\.\.?\/)' .
804 '[!~*\'();\/?:\@&=+\$,%#\w.-]*)\s([^\]]+)\]\s?([^\s]*)/',
806 $interwikinames[$matches[2]] = array($matches[1], $matches[3]);
809 if (! isset($interwikinames[$name])) return FALSE;
811 list($url, $opt) = $interwikinames[$name];
816 case '': /* FALLTHROUGH */
817 case 'std': // Simply URL-encode the string, whose base encoding is the internal-encoding
818 $param = rawurlencode($param);
821 case 'asis': /* FALLTHROUGH */
822 case 'raw' : // Truly as-is
825 case 'yw': // YukiWiki
826 if (! preg_match('/' . $WikiName . '/', $param))
827 $param = '[[' . mb_convert_encoding($param, 'SJIS', SOURCE_ENCODING) . ']]';
830 case 'moin': // MoinMoin
831 $param = str_replace('%', '_', rawurlencode($param));
835 // Alias conversion of $opt
836 if (isset($encode_aliases[$opt])) $opt = & $encode_aliases[$opt];
838 // Encoding conversion into specified encode, and URLencode
839 $param = rawurlencode(mb_convert_encoding($param, $opt, SOURCE_ENCODING));
842 // Replace or Add the parameter
843 if (strpos($url, '$1') !== FALSE) {
844 $url = str_replace('$1', $param, $url);
850 if ($len > 512) die_message('InterWiki URL too long: ' . $len . ' characters');