lib/InlineParser.php

   1 <?php
   2 rcs_id('$Id: InlineParser.php,v 1.69 2005-09-14 05:57:19 rurban Exp $');
   3 /* Copyright (C) 2002 Geoffrey T. Dairiki <dairiki@dairiki.org>
   4  * Copyright (C) 2004,2005 Reini Urban
   5  *
   6  * This file is part of PhpWiki.
   7  *
   8  * PhpWiki is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * PhpWiki is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with PhpWiki; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22 /**
  23  * This is the code which deals with the inline part of the (new-style)
  24  * wiki-markup.
  25  *
  26  * @package Markup
  27  * @author Geoffrey T. Dairiki
  28  */
  29 /**
  30  */
  31
  32 /**
  33  * This is the character used in wiki markup to escape characters with
  34  * special meaning.
  35  */
  36 define('ESCAPE_CHAR', '~');
  37
  38 require_once(dirname(__FILE__).'/HtmlElement.php');
  39 require_once('lib/CachedMarkup.php');
  40 require_once(dirname(__FILE__).'/stdlib.php');
  41
  42
  43 function WikiEscape($text) {
  44     return str_replace('#', ESCAPE_CHAR . '#', $text);
  45 }
  46
  47 function UnWikiEscape($text) {
  48     return preg_replace('/' . ESCAPE_CHAR . '(.)/', '\1', $text);
  49 }
  50
  51 /**
  52  * Return type from RegexpSet::match and RegexpSet::nextMatch.
  53  *
  54  * @see RegexpSet
  55  */
  56 class RegexpSet_match {
  57     /**
  58      * The text leading up the the next match.
  59      */
  60     var $prematch;
  61     /**
  62      * The matched text.
  63      */
  64     var $match;
  65     /**
  66      * The text following the matched text.
  67      */
  68     var $postmatch;
  69     /**
  70      * Index of the regular expression which matched.
  71      */
  72     var $regexp_ind;
  73 }
  74
  75 /**
  76  * A set of regular expressions.
  77  *
  78  * This class is probably only useful for InlineTransformer.
  79  */
  80 class RegexpSet
  81 {
  82     /** Constructor
  83      *
  84      * @param array $regexps A list of regular expressions.  The
  85      * regular expressions should not include any sub-pattern groups
  86      * "(...)".  (Anonymous groups, like "(?:...)", as well as
  87      * look-ahead and look-behind assertions are okay.)
  88      */
  89     function RegexpSet ($regexps) {
  90         assert($regexps);
  91         $this->_regexps = array_unique($regexps);
  92         if (!defined('_INLINE_OPTIMIZATION')) define('_INLINE_OPTIMIZATION',0);
  93     }
  94
  95     /**
  96      * Search text for the next matching regexp from the Regexp Set.
  97      *
  98      * @param string $text The text to search.
  99      *
 100      * @return RegexpSet_match  A RegexpSet_match object, or false if no match.
 101      */
 102     function match ($text) {
 103         return $this->_match($text, $this->_regexps, '*?');
 104     }
 105
 106     /**
 107      * Search for next matching regexp.
 108      *
 109      * Here, 'next' has two meanings:
 110      *
 111      * Match the next regexp(s) in the set, at the same position as the last match.
 112      *
 113      * If that fails, match the whole RegexpSet, starting after the position of the
 114      * previous match.
 115      *
 116      * @param string $text Text to search.
 117      *
 118      * @param RegexpSet_match $prevMatch A RegexpSet_match object.
 119      * $prevMatch should be a match object obtained by a previous
 120      * match upon the same value of $text.
 121      *
 122      * @return RegexpSet_match A RegexpSet_match object, or false if no match.
 123      */
 124     function nextMatch ($text, $prevMatch) {
 125         // Try to find match at same position.
 126         $pos = strlen($prevMatch->prematch);
 127         $regexps = array_slice($this->_regexps, $prevMatch->regexp_ind + 1);
 128         if ($regexps) {
 129             $repeat = sprintf('{%d}', $pos);
 130             if ( ($match = $this->_match($text, $regexps, $repeat)) ) {
 131                 $match->regexp_ind += $prevMatch->regexp_ind + 1;
 132                 return $match;
 133             }
 134
 135         }
 136
 137         // Failed.  Look for match after current position.
 138         $repeat = sprintf('{%d,}?', $pos + 1);
 139         return $this->_match($text, $this->_regexps, $repeat);
 140     }
 141
 142     // Syntax: http://www.pcre.org/pcre.txt
 143     //   x - EXTENDED, ignore whitespace
 144     //   s - DOTALL
 145     //   A - ANCHORED
 146     //   S - STUDY
 147     function _match ($text, $regexps, $repeat) {
 148         // If one of the regexps is an empty string, php will crash here:
 149         // sf.net: Fatal error: Allowed memory size of 8388608 bytes exhausted
 150         //         (tried to allocate 634 bytes)
 151         if (_INLINE_OPTIMIZATION) { // disabled, wrong
 152         // So we try to minize memory usage, by looping explicitly,
 153         // and storing only those regexp which actually match.
 154         // There may be more than one, so we have to find the longest,
 155         // and match inside until the shortest is empty.
 156         $matched = array(); $matched_ind = array();
 157         for ($i=0; $i<count($regexps); $i++) {
 158             if (!trim($regexps[$i])) {
 159                 trigger_error("empty regexp $i", E_USER_WARNING);
 160                 continue;
 161             }
 162             $pat= "/ ( . $repeat ) ( " . $regexps[$i] . " ) /x";
 163             if (preg_match($pat, $text, $_m)) {
 164                 $m = $_m; // FIXME: prematch, postmatch is wrong
 165                 $matched[] = $regexps[$i];
 166                 $matched_ind[] = $i;
 167                 $regexp_ind = $i;
 168             }
 169         }
 170         // To overcome ANCHORED:
 171         // We could sort by longest match and iterate over these.
 172         if (empty($matched)) return false;
 173         }
 174         $match = new RegexpSet_match;
 175
 176         // Optimization: if the matches are only "$" and another, then omit "$"
 177         if (! _INLINE_OPTIMIZATION or count($matched) > 2) {
 178             assert(!empty($repeat));
 179             assert(!empty($regexps));
 180             for ($i=0; $i<count($regexps); $i++) {
 181                 if (!trim($regexps[$i])) {
 182                     trigger_error("empty regexp $i", E_USER_WARNING);
 183                     $regexps[$i] = '\Wxxxx\w\W\w\W\w\W\w\W\w\W\w'; // some placeholder
 184                 }
 185             }
 186             // We could do much better, if we would know the matching markup for the
 187             // longest regexp match:
 188             $hugepat= "/ ( . $repeat ) ( (" . join(')|(', $regexps) . ") ) /Asx";
 189             // Proposed premature optimization 1:
 190             //$hugepat= "/ ( . $repeat ) ( (" . join(')|(', array_values($matched)) . ") ) /Asx";
 191             if (! preg_match($hugepat, $text, $m)) {
 192                 return false;
 193             }
 194             // Proposed premature optimization 1:
 195             //$match->regexp_ind = $matched_ind[count($m) - 4];
 196             $match->regexp_ind = count($m) - 4;
 197         } else {
 198             $match->regexp_ind = $regexp_ind;
 199         }
 200
 201         $match->postmatch = substr($text, strlen($m[0]));
 202         $match->prematch = $m[1];
 203         $match->match = $m[2];
 204
 205         /* DEBUGGING */
 206         /*
 207         if (DEBUG & 4) {
 208           var_dump($regexps); var_dump($matched); var_dump($matched_inc);
 209         PrintXML(HTML::dl(HTML::dt("input"),
 210                           HTML::dd(HTML::pre($text)),
 211                           HTML::dt("regexp"),
 212                           HTML::dd(HTML::pre($match->regexp_ind, ":", $regexps[$match->regexp_ind])),
 213                           HTML::dt("prematch"),
 214                           HTML::dd(HTML::pre($match->prematch)),
 215                           HTML::dt("match"),
 216                           HTML::dd(HTML::pre($match->match)),
 217                           HTML::dt("postmatch"),
 218                           HTML::dd(HTML::pre($match->postmatch))
 219                           ));
 220         }
 221         */
 222         return $match;
 223     }
 224 }
 225
 226
 227
 228 /**
 229  * A simple markup rule (i.e. terminal token).
 230  *
 231  * These are defined by a regexp.
 232  *
 233  * When a match is found for the regexp, the matching text is replaced.
 234  * The replacement content is obtained by calling the SimpleMarkup::markup method.
 235  */
 236 class SimpleMarkup
 237 {
 238     var $_match_regexp;
 239
 240     /** Get regexp.
 241      *
 242      * @return string Regexp which matches this token.
 243      */
 244     function getMatchRegexp () {
 245         return $this->_match_regexp;
 246     }
 247
 248     /** Markup matching text.
 249      *
 250      * @param string $match The text which matched the regexp
 251      * (obtained from getMatchRegexp).
 252      *
 253      * @return mixed The expansion of the matched text.
 254      */
 255     function markup ($match /*, $body */) {
 256         trigger_error("pure virtual", E_USER_ERROR);
 257     }
 258 }
 259
 260 /**
 261  * A balanced markup rule.
 262  *
 263  * These are defined by a start regexp, and an end regexp.
 264  */
 265 class BalancedMarkup
 266 {
 267     var $_start_regexp;
 268
 269     /** Get the starting regexp for this rule.
 270      *
 271      * @return string The starting regexp.
 272      */
 273     function getStartRegexp () {
 274         return $this->_start_regexp;
 275     }
 276
 277     /** Get the ending regexp for this rule.
 278      *
 279      * @param string $match The text which matched the starting regexp.
 280      *
 281      * @return string The ending regexp.
 282      */
 283     function getEndRegexp ($match) {
 284         return $this->_end_regexp;
 285     }
 286
 287     /** Get expansion for matching input.
 288      *
 289      * @param string $match The text which matched the starting regexp.
 290      *
 291      * @param mixed $body Transformed text found between the starting
 292      * and ending regexps.
 293      *
 294      * @return mixed The expansion of the matched text.
 295      */
 296     function markup ($match, $body) {
 297         trigger_error("pure virtual", E_USER_ERROR);
 298     }
 299 }
 300
 301 class Markup_escape  extends SimpleMarkup
 302 {
 303     function getMatchRegexp () {
 304         return ESCAPE_CHAR . '(?: [[:alnum:]]+ | .)';
 305     }
 306
 307     function markup ($match) {
 308         assert(strlen($match) >= 2);
 309         return substr($match, 1);
 310     }
 311 }
 312
 313 /**
 314  * [image.jpg size=50% border=5], [image.jpg size=50x30]
 315  * Support for the following attributes: see stdlib.php:LinkImage()
 316  *   size=<precent>%, size=<width>x<height>
 317  *   border=n, align=\w+, hspace=n, vspace=n
 318  */
 319 function isImageLink($link) {
 320     if (!$link) return false;
 321     assert(defined('INLINE_IMAGES'));
 322     return preg_match("/\\.(" . INLINE_IMAGES . ")$/i", $link)
 323         or preg_match("/\\.(" . INLINE_IMAGES . ")\s+(size|border|align|hspace|vspace)=/i", $link);
 324 }
 325
 326 function LinkBracketLink($bracketlink) {
 327
 328     // $bracketlink will start and end with brackets; in between will
 329     // be either a page name, a URL or both separated by a pipe.
 330
 331     // strip brackets and leading space
 332     // FIXME: \n inside [] will lead to errors
 333     preg_match('/(\#?) \[\s* (?: (.*?) \s* (?<!' . ESCAPE_CHAR . ')(\|) )? \s* (.+?) \s*\]/x',
 334                $bracketlink, $matches);
 335     if (count($matches) < 4) {
 336         trigger_error(_("Invalid [] syntax ignored").": ".$bracketlink, E_USER_WARNING);
 337         return new Cached_Link;
 338     }
 339     list (, $hash, $label, $bar, $rawlink) = $matches;
 340
 341     $label = UnWikiEscape($label);
 342     /*
 343      * Check if the user has typed a explicit URL. This solves the
 344      * problem where the URLs have a ~ character, which would be stripped away.
 345      *   "[http:/server/~name/]" will work as expected
 346      *   "http:/server/~name/"   will NOT work as expected, will remove the ~
 347      */
 348     if (strstr($rawlink, "http://") or strstr($rawlink, "https://")) {
 349         $link = $rawlink;
 350         // Mozilla Browser URI Obfuscation Weakness 2004-06-14
 351         //   http://www.securityfocus.com/bid/10532/
 352         //   goodurl+"%2F%20%20%20."+badurl
 353         if (preg_match("/%2F(%20)+\./i", $rawlink)) {
 354             $rawlink = preg_replace("/%2F(%20)+\./i","%2F.",$rawlink);
 355         }
 356     } else
 357         $link  = UnWikiEscape($rawlink);
 358
 359     // [label|link]
 360     // if label looks like a url to an image, we want an image link.
 361     if (isImageLink($label)) {
 362         $imgurl = $label;
 363         $intermap = getInterwikiMap();
 364         if (preg_match("/^" . $intermap->getRegexp() . ":/", $label)) {
 365             $imgurl = $intermap->link($label);
 366             $imgurl = $imgurl->getAttr('href');
 367         } elseif (! preg_match("#^(" . ALLOWED_PROTOCOLS . "):#", $imgurl)) {
 368             // local theme linkname like 'images/next.gif'.
 369             global $WikiTheme;
 370             $imgurl = $WikiTheme->getImageURL($imgurl);
 371         }
 372         $label = LinkImage($imgurl, $link);
 373     }
 374
 375     if ($hash) {
 376         // It's an anchor, not a link...
 377         $id = MangleXmlIdentifier($link);
 378         return HTML::a(array('name' => $id, 'id' => $id),
 379                        $bar ? $label : $link);
 380     }
 381
 382     if (preg_match("#^(" . ALLOWED_PROTOCOLS . "):#", $link)) {
 383         // if it's an image, embed it; otherwise, it's a regular link
 384         if (isImageLink($link))
 385             return LinkImage($link, $label);
 386         else
 387             return new Cached_ExternalLink($link, $label);
 388     }
 389     elseif (preg_match("/^phpwiki:/", $link))
 390         return new Cached_PhpwikiURL($link, $label);
 391     /*
 392      * Inline images in Interwiki urls's:
 393      * [File:my_image.gif] inlines the image,
 394      * File:my_image.gif shows a plain inter-wiki link,
 395      * [what a pic|File:my_image.gif] shows a named inter-wiki link to the gif
 396      * [File:my_image.gif|what a pic] shows a inlimed image linked to the page "what a pic"
 397      *
 398      * Note that for simplicity we will accept embedded object tags (non-images)
 399      * here also, and seperate them later in LinkImage()
 400      */
 401     elseif (strstr($link,':')
 402             and ($intermap = getInterwikiMap())
 403             and preg_match("/^" . $intermap->getRegexp() . ":/", $link))
 404     {
 405         // trigger_error("label: $label link: $link", E_USER_WARNING);
 406         if (empty($label) and isImageLink($link)) {
 407             // if without label => inlined image [File:xx.gif]
 408             $imgurl = $intermap->link($link);
 409             return LinkImage($imgurl->getAttr('href'), $label);
 410         }
 411         return new Cached_InterwikiLink($link, $label);
 412     } else {
 413         // Split anchor off end of pagename.
 414         if (preg_match('/\A(.*)(?<!'.ESCAPE_CHAR.')#(.*?)\Z/', $rawlink, $m)) {
 415             list(,$rawlink,$anchor) = $m;
 416             $pagename = UnWikiEscape($rawlink);
 417             $anchor = UnWikiEscape($anchor);
 418             if (!$label)
 419                 $label = $link;
 420         }
 421         else {
 422             $pagename = $link;
 423             $anchor = false;
 424         }
 425         return new Cached_WikiLink($pagename, $label, $anchor);
 426     }
 427 }
 428
 429 class Markup_bracketlink  extends SimpleMarkup
 430 {
 431     var $_match_regexp = "\\#? \\[ .*? [^]\\s] .*? \\]";
 432
 433     function markup ($match) {
 434         $link = LinkBracketLink($match);
 435         assert($link->isInlineElement());
 436         return $link;
 437     }
 438 }
 439
 440 class Markup_url extends SimpleMarkup
 441 {
 442     function getMatchRegexp () {
 443         return "(?<![[:alnum:]]) (?:" . ALLOWED_PROTOCOLS . ") : [^\s<>\"']+ (?<![ ,.?; \] \) ])";
 444     }
 445
 446     function markup ($match) {
 447         return new Cached_ExternalLink(UnWikiEscape($match));
 448     }
 449 }
 450
 451
 452 class Markup_interwiki extends SimpleMarkup
 453 {
 454     function getMatchRegexp () {
 455         global $request;
 456         $map = getInterwikiMap();
 457         return "(?<! [[:alnum:]])" . $map->getRegexp(). ": \S+ (?<![ ,.?;! \] \) \" \' ])";
 458     }
 459
 460     function markup ($match) {
 461         //$map = getInterwikiMap();
 462         return new Cached_InterwikiLink(UnWikiEscape($match));
 463     }
 464 }
 465
 466 class Markup_wikiword extends SimpleMarkup
 467 {
 468     function getMatchRegexp () {
 469         global $WikiNameRegexp;
 470         if (!trim($WikiNameRegexp)) return " " . WIKI_NAME_REGEXP;
 471         return " $WikiNameRegexp";
 472     }
 473
 474     function markup ($match) {
 475         if (!$match) return false;
 476         if ($this->_isWikiUserPage($match))
 477             return new Cached_UserLink($match); //$this->_UserLink($match);
 478         else
 479             return new Cached_WikiLink($match);
 480     }
 481
 482     // FIXME: there's probably a more useful place to put these two functions
 483     function _isWikiUserPage ($page) {
 484         global $request;
 485         $dbi = $request->getDbh();
 486         $page_handle = $dbi->getPage($page);
 487         if ($page_handle and $page_handle->get('pref'))
 488             return true;
 489         else
 490             return false;
 491     }
 492
 493     function _UserLink($PageName) {
 494         $link = HTML::a(array('href' => $PageName));
 495         $link->pushContent(PossiblyGlueIconToText('wikiuser', $PageName));
 496         $link->setAttr('class', 'wikiuser');
 497         return $link;
 498     }
 499 }
 500
 501 class Markup_linebreak extends SimpleMarkup
 502 {
 503     //var $_match_regexp = "(?: (?<! %) %%% (?! %) | <(?:br|BR)> | <(?:br|BR) \/> )";
 504     var $_match_regexp = "(?: (?<! %) %%% (?! %) | <(?:br|BR)> )";
 505
 506     function markup ($match) {
 507         return HTML::br();
 508     }
 509 }
 510
 511 class Markup_old_emphasis  extends BalancedMarkup
 512 {
 513     var $_start_regexp = "''|__";
 514
 515     function getEndRegexp ($match) {
 516         return $match;
 517     }
 518
 519     function markup ($match, $body) {
 520         $tag = $match == "''" ? 'em' : 'strong';
 521         return new HtmlElement($tag, $body);
 522     }
 523 }
 524
 525 class Markup_nestled_emphasis extends BalancedMarkup
 526 {
 527     function getStartRegexp() {
 528         static $start_regexp = false;
 529
 530         if (!$start_regexp) {
 531             // The three possible delimiters
 532             // (none of which can be followed by itself.)
 533             $i = "_ (?! _)";
 534             $b = "\\* (?! \\*)";
 535             $tt = "= (?! =)";
 536
 537             $any = "(?: ${i}|${b}|${tt})"; // any of the three.
 538
 539             // Any of [_*=] is okay if preceded by space or one of [-"'/:]
 540             $start[] = "(?<= \\s|^|[-\"'\\/:]) ${any}";
 541
 542             // _ or * is okay after = as long as not immediately followed by =
 543             $start[] = "(?<= =) (?: ${i}|${b}) (?! =)";
 544             // etc...
 545             $start[] = "(?<= _) (?: ${b}|${tt}) (?! _)";
 546             $start[] = "(?<= \\*) (?: ${i}|${tt}) (?! \\*)";
 547
 548
 549             // any delimiter okay after an opening brace ( [{<(] )
 550             // as long as it's not immediately followed by the matching closing
 551             // brace.
 552             $start[] = "(?<= { ) ${any} (?! } )";
 553             $start[] = "(?<= < ) ${any} (?! > )";
 554             $start[] = "(?<= \\( ) ${any} (?! \\) )";
 555
 556             $start = "(?:" . join('|', $start) . ")";
 557
 558             // Any of the above must be immediately followed by non-whitespace.
 559             $start_regexp = $start . "(?= \S)";
 560         }
 561
 562         return $start_regexp;
 563     }
 564
 565     function getEndRegexp ($match) {
 566         $chr = preg_quote($match);
 567         return "(?<= \S | ^ ) (?<! $chr) $chr (?! $chr) (?= \s | [-)}>\"'\\/:.,;!? _*=] | $)";
 568     }
 569
 570     function markup ($match, $body) {
 571         switch ($match) {
 572         case '*': return new HtmlElement('b', $body);
 573         case '=': return new HtmlElement('tt', $body);
 574         case '_': return new HtmlElement('i', $body);
 575         }
 576     }
 577 }
 578
 579 class Markup_html_emphasis extends BalancedMarkup
 580 {
 581     var $_start_regexp =
 582         "<(?: b|big|i|small|tt|em|strong|cite|code|dfn|kbd|samp|var|sup|sub )>";
 583
 584     function getEndRegexp ($match) {
 585         return "<\\/" . substr($match, 1);
 586     }
 587
 588     function markup ($match, $body) {
 589         $tag = substr($match, 1, -1);
 590         return new HtmlElement($tag, $body);
 591     }
 592 }
 593
 594 class Markup_html_abbr extends BalancedMarkup
 595 {
 596     //rurban: abbr|acronym need an optional title tag.
 597     //sf.net bug #728595
 598     var $_start_regexp = "<(?: abbr|acronym )(?: \stitle=[^>]*)?>";
 599
 600     function getEndRegexp ($match) {
 601         if (substr($match,1,4) == 'abbr')
 602             $tag = 'abbr';
 603         else
 604             $tag = 'acronym';
 605         return "<\\/" . $tag . '>';
 606     }
 607
 608     function markup ($match, $body) {
 609         if (substr($match,1,4) == 'abbr')
 610             $tag = 'abbr';
 611         else
 612             $tag = 'acronym';
 613         $rest = substr($match,1+strlen($tag),-1);
 614         if (!empty($rest)) {
 615             list($key,$val) = explode("=",$rest);
 616             $args = array($key => $val);
 617         } else $args = array();
 618         return new HtmlElement($tag, $args, $body);
 619     }
 620 }
 621
 622 /** ENABLE_MARKUP_COLOR
 623  *  See http://www.pmwiki.org/wiki/PmWiki/WikiStyles and
 624  *      http://www.flexwiki.com/default.aspx/FlexWiki/FormattingRules.html
 625  */
 626 class Markup_color extends BalancedMarkup {
 627     // %color=blue% blue text %% and back to normal
 628     var $_start_regexp = "%color=(?: [^%]*)%";
 629     var $_end_regexp = "%%";
 630
 631     function markup ($match, $body) {
 632         $color = substr($match, 7, -1);
 633         if (strlen($color) != 7
 634             and in_array($color, array('red', 'blue', 'grey', 'black'))) {
 635             // must be a name
 636             return new HtmlElement('font', array('color' => $color), $body);
 637         } elseif ((substr($color,0,1) == '#')
 638                   and (strspn(substr($color,1),'0123456789ABCDEFabcdef') == strlen($color)-1)) {
 639             return new HtmlElement('font', array('color' => $color), $body);
 640         } else {
 641             trigger_error(sprintf(_("unknown color %s ignored"), $color), E_USER_WARNING);
 642         }
 643
 644     }
 645 }
 646
 647 // Special version for single-line plugins formatting,
 648 //  like: '<small>< ?plugin PopularNearby ? ></small>'
 649 class Markup_plugin extends SimpleMarkup
 650 {
 651     var $_match_regexp = '<\?plugin(?:-form)?\s[^\n]+?\?>';
 652
 653     function markup ($match) {
 654         //$xml = new Cached_PluginInvocation($match);
 655         //$xml->setTightness(true,true);
 656         return new Cached_PluginInvocation($match);
 657     }
 658 }
 659
 660 /** ENABLE_MARKUP_TEMPLATE
 661  *  Template syntax similar to mediawiki
 662  *  {{template}}
 663  * => <?plugin Template page=template?>
 664  *  {{template|var=value|...}}
 665  * => <?plugin Template page=template vars="var=value&..."?>
 666  */
 667 class Markup_template_plugin  extends SimpleMarkup
 668 {
 669     var $_match_regexp = '\{\{\w[^\n]+\}\}';
 670
 671     function markup ($match) {
 672         $page = substr($match,2,-2); $vars = '';
 673         if (preg_match('/^(\S+)\|(.*)$/', $page, $_m)) {
 674             $page = $_m[1];
 675             $vars = str_replace('|', '&', $_m[2]);
 676         }
 677         if ($vars)
 678             $s = '<?plugin Template page=' . $page . ' vars="' . $vars . '"?>';
 679         else
 680             $s = '<?plugin Template page=' . $page . '?>';
 681         return new Cached_PluginInvocation($s);
 682     }
 683 }
 684
 685 // TODO: "..." => "&#133;"  browser specific display (not cached?)
 686 // TODO: "--" => "&emdash;" browser specific display (not cached?)
 687 // TODO: Support more HTML::Entities: (C) for copy, --- for mdash, -- for ndash
 688
 689 class Markup_html_entities  extends SimpleMarkup {
 690     var $_match_regexp = '(: \.\.\.|\-\-|\-\-\-|\(C\) )';
 691
 692     function markup ($match) {
 693         static $entities = array('...'  => '&#133;',
 694                                  '--'   => '&ndash;',
 695                                  '---'  => '&mdash;',
 696                                  '(C)'  => '&copy;',
 697                                  );
 698         return HTML::Raw($entities[$match]);
 699     }
 700 }
 701
 702 class Markup_isonumchars  extends SimpleMarkup {
 703     var $_match_regexp = '\&\#\d{2,5};';
 704
 705     function markup ($match) {
 706         return HTML::Raw($match);
 707     }
 708 }
 709
 710 class Markup_isohexchars extends SimpleMarkup {
 711     // hexnums, like &#x00A4; <=> &curren;
 712     var $_match_regexp = '\&\#x[0-9a-fA-F]{2,4};';
 713
 714     function markup ($match) {
 715         return HTML::Raw($match);
 716     }
 717 }
 718
 719 // FIXME: Do away with magic phpwiki forms.  (Maybe phpwiki: links too?)
 720 // FIXME: Do away with plugin-links.  They seem not to be used.
 721 //Plugin link
 722
 723 class InlineTransformer
 724 {
 725     var $_regexps = array();
 726     var $_markup = array();
 727
 728     function InlineTransformer ($markup_types = false) {
 729         if (!$markup_types)
 730             $markup_types = array('escape', 'bracketlink', 'url',
 731                                   'interwiki', 'wikiword', 'linebreak',
 732                                   'old_emphasis', 'nestled_emphasis',
 733                                   'html_emphasis', 'html_abbr', 'plugin',
 734                                   'isonumchars', 'isohexchars', /*'html_entities',*/
 735                                   );
 736         foreach ($markup_types as $mtype) {
 737             $class = "Markup_$mtype";
 738             $this->_addMarkup(new $class);
 739         }
 740         if (ENABLE_MARKUP_COLOR)
 741             $this->_addMarkup(new Markup_color);
 742         if (defined("ENABLE_MARKUP_TEMPLATE") and ENABLE_MARKUP_TEMPLATE)
 743             $this->_addMarkup(new Markup_template_plugin);
 744     }
 745
 746     function _addMarkup ($markup) {
 747         if (isa($markup, 'SimpleMarkup'))
 748             $regexp = $markup->getMatchRegexp();
 749         else
 750             $regexp = $markup->getStartRegexp();
 751
 752         assert(!isset($this->_markup[$regexp]));
 753         $this->_regexps[] = $regexp;
 754         $this->_markup[] = $markup;
 755     }
 756
 757     function parse (&$text, $end_regexps = array('$')) {
 758         $regexps = $this->_regexps;
 759
 760         // $end_re takes precedence: "favor reduce over shift"
 761         array_unshift($regexps, $end_regexps[0]);
 762         //array_push($regexps, $end_regexps[0]);
 763         $regexps = new RegexpSet($regexps);
 764
 765         $input = $text;
 766         $output = new XmlContent;
 767
 768         $match = $regexps->match($input);
 769
 770         while ($match) {
 771             if ($match->regexp_ind == 0) {
 772                 // No start pattern found before end pattern.
 773                 // We're all done!
 774                 if (isset($markup) and is_object($markup) and isa($markup,'Markup_plugin')) {
 775                     $current =& $output->_content[count($output->_content)-1];
 776                     $current->setTightness(true,true);
 777                 }
 778                 $output->pushContent($match->prematch);
 779                 $text = $match->postmatch;
 780                 return $output;
 781             }
 782
 783             $markup = $this->_markup[$match->regexp_ind - 1];
 784             $body = $this->_parse_markup_body($markup, $match->match, $match->postmatch, $end_regexps);
 785             if (!$body) {
 786                 // Couldn't match balanced expression.
 787                 // Ignore and look for next matching start regexp.
 788                 $match = $regexps->nextMatch($input, $match);
 789                 continue;
 790             }
 791
 792             // Matched markup.  Eat input, push output.
 793             // FIXME: combine adjacent strings.
 794             if (isa($markup, 'SimpleMarkup'))
 795                 $current = $markup->markup($match->match);
 796             else
 797                 $current = $markup->markup($match->match, $body);
 798             $input = $match->postmatch;
 799             if (isset($markup) and is_object($markup) and isa($markup,'Markup_plugin')) {
 800                 $current->setTightness(true,true);
 801             }
 802             $output->pushContent($match->prematch, $current);
 803
 804             $match = $regexps->match($input);
 805         }
 806
 807         // No pattern matched, not even the end pattern.
 808         // Parse fails.
 809         return false;
 810     }
 811
 812     function _parse_markup_body ($markup, $match, &$text, $end_regexps) {
 813         if (isa($markup, 'SimpleMarkup'))
 814             return true;        // Done. SimpleMarkup is simple.
 815
 816         if (!is_object($markup)) return false; // Some error: Should assert
 817         array_unshift($end_regexps, $markup->getEndRegexp($match));
 818
 819         // Optimization: if no end pattern in text, we know the
 820         // parse will fail.  This is an important optimization,
 821         // e.g. when text is "*lots *of *start *delims *with
 822         // *no *matching *end *delims".
 823         $ends_pat = "/(?:" . join(").*(?:", $end_regexps) . ")/xs";
 824         if (!preg_match($ends_pat, $text))
 825             return false;
 826         return $this->parse($text, $end_regexps);
 827     }
 828 }
 829
 830 class LinkTransformer extends InlineTransformer
 831 {
 832     function LinkTransformer () {
 833         $this->InlineTransformer(array('escape', 'bracketlink', 'url',
 834                                        'interwiki', 'wikiword'));
 835     }
 836 }
 837
 838 function TransformInline($text, $markup = 2.0, $basepage=false) {
 839     static $trfm;
 840
 841     if (empty($trfm)) {
 842         $trfm = new InlineTransformer;
 843     }
 844
 845     if ($markup < 2.0) {
 846         $text = ConvertOldMarkup($text, 'inline');
 847     }
 848
 849     if ($basepage) {
 850         return new CacheableMarkup($trfm->parse($text), $basepage);
 851     }
 852     return $trfm->parse($text);
 853 }
 854
 855 function TransformLinks($text, $markup = 2.0, $basepage = false) {
 856     static $trfm;
 857
 858     if (empty($trfm)) {
 859         $trfm = new LinkTransformer;
 860     }
 861
 862     if ($markup < 2.0) {
 863         $text = ConvertOldMarkup($text, 'links');
 864     }
 865
 866     if ($basepage) {
 867         return new CacheableMarkup($trfm->parse($text), $basepage);
 868     }
 869     return $trfm->parse($text);
 870 }
 871
 872 // $Log: not supported by cvs2svn $
 873 // Revision 1.68  2005/09/10 21:24:32  rurban
 874 // optionally support {{Template|vars}} syntax
 875 //
 876 // Revision 1.67  2005/06/06 17:41:20  rurban
 877 // support new ENABLE_MARKUP_COLOR
 878 //
 879 // Revision 1.66  2005/04/23 11:15:49  rurban
 880 // handle allowed inlined objects within INLINE_IMAGES
 881 //
 882 // Revision 1.65  2005/03/27 18:24:17  rurban
 883 // add Log
 884 //
 885
 886 // (c-file-style: "gnu")
 887 // Local Variables:
 888 // mode: php
 889 // tab-width: 8
 890 // c-basic-offset: 4
 891 // c-hanging-comment-ender-p: nil
 892 // indent-tabs-mode: nil
 893 // End:
 894 ?>