lib/InlineParser.php

   1 <?php
   2 rcs_id('$Id: InlineParser.php,v 1.77 2006-08-25 19:02:02 rurban Exp $');
   3 /* Copyright (C) 2002 Geoffrey T. Dairiki <dairiki@dairiki.org>
   4  * Copyright (C) 2004,2005,2006 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     /* Relatives links by Joel Schaubert.
 360      * Recognize [../bla] or [/bla] as relative links, without needing http://
 361      * but [ /link ] only if SUBPAGE_SEPERATOR is not "/".
 362      * Normally /Page links to the subpage /Page.
 363      */
 364     if (SUBPAGE_SEPARATOR == '/') {
 365         if (preg_match('/^\.\.\//', $link)) {
 366             return new Cached_ExternalLink($link, $label);
 367         }
 368     } else if (preg_match('/^(\.\.\/|\/)/', $link)) {
 369         return new Cached_ExternalLink($link, $label);
 370     }
 371     // [label|link]
 372     // if label looks like a url to an image, we want an image link.
 373     if (isImageLink($label)) {
 374         $imgurl = $label;
 375         $intermap = getInterwikiMap();
 376         if (preg_match("/^" . $intermap->getRegexp() . ":/", $label)) {
 377             $imgurl = $intermap->link($label);
 378             $imgurl = $imgurl->getAttr('href');
 379         } elseif (! preg_match("#^(" . ALLOWED_PROTOCOLS . "):#", $imgurl)) {
 380             // local theme linkname like 'images/next.gif'.
 381             global $WikiTheme;
 382             $imgurl = $WikiTheme->getImageURL($imgurl);
 383         }
 384         $label = LinkImage($imgurl, $link);
 385     }
 386
 387     if ($hash) {
 388         // It's an anchor, not a link...
 389         $id = MangleXmlIdentifier($link);
 390         return HTML::a(array('name' => $id, 'id' => $id),
 391                        $bar ? $label : $link);
 392     }
 393
 394     if (preg_match("#^(" . ALLOWED_PROTOCOLS . "):#", $link)) {
 395         // if it's an image, embed it; otherwise, it's a regular link
 396         if (isImageLink($link) and empty($label)) // patch #1348996 by Robert Litwiniec
 397             return LinkImage($link, $label);
 398         else
 399             return new Cached_ExternalLink($link, $label);
 400     }
 401     elseif (preg_match("/^phpwiki:/", $link))
 402         return new Cached_PhpwikiURL($link, $label);
 403     /* Semantic relations and attributes */
 404     elseif (preg_match("/:[:-]/", $link) and !isImageLink($link))
 405         return new Cached_SemanticLink($link, $label);
 406     /*
 407      * Inline images in Interwiki urls's:
 408      * [File:my_image.gif] inlines the image,
 409      * File:my_image.gif shows a plain inter-wiki link,
 410      * [what a pic|File:my_image.gif] shows a named inter-wiki link to the gif
 411      * [File:my_image.gif|what a pic] shows a inlimed image linked to the page "what a pic"
 412      *
 413      * Note that for simplicity we will accept embedded object tags (non-images)
 414      * here also, and seperate them later in LinkImage()
 415      */
 416     elseif (strstr($link,':')
 417             and ($intermap = getInterwikiMap())
 418             and preg_match("/^" . $intermap->getRegexp() . ":/", $link))
 419     {
 420         // trigger_error("label: $label link: $link", E_USER_WARNING);
 421         if (empty($label) and isImageLink($link)) {
 422             // if without label => inlined image [File:xx.gif]
 423             $imgurl = $intermap->link($link);
 424             return LinkImage($imgurl->getAttr('href'), $label);
 425         }
 426         return new Cached_InterwikiLink($link, $label);
 427     } else {
 428         // Split anchor off end of pagename.
 429         if (preg_match('/\A(.*)(?<!'.ESCAPE_CHAR.')#(.*?)\Z/', $rawlink, $m)) {
 430             list(,$rawlink,$anchor) = $m;
 431             $pagename = UnWikiEscape($rawlink);
 432             $anchor = UnWikiEscape($anchor);
 433             if (!$label)
 434                 $label = $link;
 435         }
 436         else {
 437             $pagename = $link;
 438             $anchor = false;
 439         }
 440         return new Cached_WikiLink($pagename, $label, $anchor);
 441     }
 442 }
 443
 444 class Markup_bracketlink  extends SimpleMarkup
 445 {
 446     var $_match_regexp = "\\#? \\[ .*? [^]\\s] .*? \\]";
 447
 448     function markup ($match) {
 449         $link = LinkBracketLink($match);
 450         assert($link->isInlineElement());
 451         return $link;
 452     }
 453 }
 454
 455 class Markup_url extends SimpleMarkup
 456 {
 457     function getMatchRegexp () {
 458         return "(?<![[:alnum:]]) (?:" . ALLOWED_PROTOCOLS . ") : [^\s<>\"']+ (?<![ ,.?; \] \) ])";
 459     }
 460
 461     function markup ($match) {
 462         return new Cached_ExternalLink(UnWikiEscape($match));
 463     }
 464 }
 465
 466
 467 class Markup_interwiki extends SimpleMarkup
 468 {
 469     function getMatchRegexp () {
 470         global $request;
 471         $map = getInterwikiMap();
 472         return "(?<! [[:alnum:]])" . $map->getRegexp(). ": \S+ (?<![ ,.?;! \] \) \" \' ])";
 473     }
 474
 475     function markup ($match) {
 476         //$map = getInterwikiMap();
 477         return new Cached_InterwikiLink(UnWikiEscape($match));
 478     }
 479 }
 480
 481 class Markup_wikiword extends SimpleMarkup
 482 {
 483     function getMatchRegexp () {
 484         global $WikiNameRegexp;
 485         if (!trim($WikiNameRegexp)) return " " . WIKI_NAME_REGEXP;
 486         return " $WikiNameRegexp";
 487     }
 488
 489     function markup ($match) {
 490         if (!$match) return false;
 491         if ($this->_isWikiUserPage($match))
 492             return new Cached_UserLink($match); //$this->_UserLink($match);
 493         else
 494             return new Cached_WikiLink($match);
 495     }
 496
 497     // FIXME: there's probably a more useful place to put these two functions
 498     function _isWikiUserPage ($page) {
 499         global $request;
 500         $dbi = $request->getDbh();
 501         $page_handle = $dbi->getPage($page);
 502         if ($page_handle and $page_handle->get('pref'))
 503             return true;
 504         else
 505             return false;
 506     }
 507
 508     function _UserLink($PageName) {
 509         $link = HTML::a(array('href' => $PageName));
 510         $link->pushContent(PossiblyGlueIconToText('wikiuser', $PageName));
 511         $link->setAttr('class', 'wikiuser');
 512         return $link;
 513     }
 514 }
 515
 516 class Markup_linebreak extends SimpleMarkup
 517 {
 518     //var $_match_regexp = "(?: (?<! %) %%% (?! %) | <(?:br|BR)> | <(?:br|BR) \/> )";
 519     var $_match_regexp = "(?: (?<! %) %%% (?! %) | <(?:br|BR)> )";
 520
 521     function markup ($match) {
 522         return HTML::br();
 523     }
 524 }
 525
 526 class Markup_old_emphasis  extends BalancedMarkup
 527 {
 528     var $_start_regexp = "''|__";
 529
 530     function getEndRegexp ($match) {
 531         return $match;
 532     }
 533
 534     function markup ($match, $body) {
 535         $tag = $match == "''" ? 'em' : 'strong';
 536         return new HtmlElement($tag, $body);
 537     }
 538 }
 539
 540 class Markup_nestled_emphasis extends BalancedMarkup
 541 {
 542     function getStartRegexp() {
 543         static $start_regexp = false;
 544
 545         if (!$start_regexp) {
 546             // The three possible delimiters
 547             // (none of which can be followed by itself.)
 548             $i = "_ (?! _)";
 549             $b = "\\* (?! \\*)";
 550             $tt = "= (?! =)";
 551
 552             $any = "(?: ${i}|${b}|${tt})"; // any of the three.
 553
 554             // Any of [_*=] is okay if preceded by space or one of [-"'/:]
 555             $start[] = "(?<= \\s|^|[-\"'\\/:]) ${any}";
 556
 557             // _ or * is okay after = as long as not immediately followed by =
 558             $start[] = "(?<= =) (?: ${i}|${b}) (?! =)";
 559             // etc...
 560             $start[] = "(?<= _) (?: ${b}|${tt}) (?! _)";
 561             $start[] = "(?<= \\*) (?: ${i}|${tt}) (?! \\*)";
 562
 563
 564             // any delimiter okay after an opening brace ( [{<(] )
 565             // as long as it's not immediately followed by the matching closing
 566             // brace.
 567             $start[] = "(?<= { ) ${any} (?! } )";
 568             $start[] = "(?<= < ) ${any} (?! > )";
 569             $start[] = "(?<= \\( ) ${any} (?! \\) )";
 570
 571             $start = "(?:" . join('|', $start) . ")";
 572
 573             // Any of the above must be immediately followed by non-whitespace.
 574             $start_regexp = $start . "(?= \S)";
 575         }
 576
 577         return $start_regexp;
 578     }
 579
 580     function getEndRegexp ($match) {
 581         $chr = preg_quote($match);
 582         return "(?<= \S | ^ ) (?<! $chr) $chr (?! $chr) (?= \s | [-)}>\"'\\/:.,;!? _*=] | $)";
 583     }
 584
 585     function markup ($match, $body) {
 586         switch ($match) {
 587         case '*': return new HtmlElement('b', $body);
 588         case '=': return new HtmlElement('tt', $body);
 589         case '_': return new HtmlElement('i', $body);
 590         }
 591     }
 592 }
 593
 594 class Markup_html_emphasis extends BalancedMarkup
 595 {
 596     var $_start_regexp =
 597         "<(?: b|big|i|small|tt|em|strong|cite|code|dfn|kbd|samp|strike|del|var|sup|sub )>";
 598
 599     function getEndRegexp ($match) {
 600         return "<\\/" . substr($match, 1);
 601     }
 602
 603     function markup ($match, $body) {
 604         $tag = substr($match, 1, -1);
 605         return new HtmlElement($tag, $body);
 606     }
 607 }
 608
 609 class Markup_html_abbr extends BalancedMarkup
 610 {
 611     //rurban: abbr|acronym need an optional title tag.
 612     //sf.net bug #728595
 613     var $_start_regexp = "<(?: abbr|acronym )(?: \stitle=[^>]*)?>";
 614
 615     function getEndRegexp ($match) {
 616         if (substr($match,1,4) == 'abbr')
 617             $tag = 'abbr';
 618         else
 619             $tag = 'acronym';
 620         return "<\\/" . $tag . '>';
 621     }
 622
 623     function markup ($match, $body) {
 624         if (substr($match,1,4) == 'abbr')
 625             $tag = 'abbr';
 626         else
 627             $tag = 'acronym';
 628         $rest = substr($match,1+strlen($tag),-1);
 629         if (!empty($rest)) {
 630             list($key,$val) = explode("=",$rest);
 631             $args = array($key => $val);
 632         } else $args = array();
 633         return new HtmlElement($tag, $args, $body);
 634     }
 635 }
 636
 637 /** ENABLE_MARKUP_COLOR
 638  *  See http://www.pmwiki.org/wiki/PmWiki/WikiStyles and
 639  *      http://www.flexwiki.com/default.aspx/FlexWiki/FormattingRules.html
 640  */
 641 class Markup_color extends BalancedMarkup {
 642     // %color=blue% blue text %% and back to normal
 643     var $_start_regexp = "%color=(?: [^%]*)%";
 644     var $_end_regexp = "%%";
 645
 646     function markup ($match, $body) {
 647         $color = substr($match, 7, -1);
 648         if (strlen($color) != 7
 649             and in_array($color, array('red', 'blue', 'grey', 'black'))) {
 650             // must be a name
 651             return new HtmlElement('font', array('color' => $color), $body);
 652         } elseif ((substr($color,0,1) == '#')
 653                   and (strspn(substr($color,1),'0123456789ABCDEFabcdef') == strlen($color)-1)) {
 654             return new HtmlElement('font', array('color' => $color), $body);
 655         } else {
 656             trigger_error(sprintf(_("unknown color %s ignored"), $color), E_USER_WARNING);
 657         }
 658
 659     }
 660 }
 661
 662 // Special version for single-line plugins formatting,
 663 //  like: '<small>< ?plugin PopularNearby ? ></small>'
 664 class Markup_plugin extends SimpleMarkup
 665 {
 666     var $_match_regexp = '<\?plugin(?:-form)?\s[^\n]+?\?>';
 667
 668     function markup ($match) {
 669         //$xml = new Cached_PluginInvocation($match);
 670         //$xml->setTightness(true,true);
 671         return new Cached_PluginInvocation($match);
 672     }
 673 }
 674
 675 // Special version for plugins in xml syntax
 676 // <name arg=value>body</name> or <name /> => < ? plugin pluginname arg=value body ? >
 677 // PLUGIN_MARKUP_MAP = "html:RawHtml dot:GraphViz toc:CreateToc amath:AsciiMath richtable:RichTable include:IncludePage tex:TexToPng"
 678 class Markup_xml_plugin extends BalancedMarkup
 679 {
 680     //var $_start_regexp = "<(?: ".join('|',PLUGIN_MARKUP_MAP)." )(?: \s[^>]*)>";
 681
 682     function getStartRegexp ($match) {
 683         static $_start_regexp;
 684         if ($_start_regexp) return $_start_regexp;
 685         if (!defined('PLUGIN_MARKUP_MAP'))
 686             return '';
 687         $pairs = split(' ', PLUGIN_MARKUP_MAP);
 688         $this->_map = array();
 689         foreach ($pairs as $pair) {
 690             list($xml,$plugin) = split(':',$pair);
 691             $this->_map[$xml] = $plugin;
 692         }
 693         //"<(?: html|dot|toc|amath|richtable|include|tex )(?: \s[^>]*)>"
 694         return "<(?: ".join('|',array_keys($this->_map))." )(?:(?:\s[^>]*|/))>";;
 695     }
 696     function getEndRegexp ($match) {
 697         return "<\\/" . $match . '>';
 698     }
 699     function markup ($match, $body) {
 700         $name = substr($match,2,-2); $vars = '';
 701         if (preg_match('/^(\S+)\|(.*)$/', $name, $_m)) {
 702             $name = $_m[1];
 703             $vars = $_m[2]; //str_replace(' ', '&', $_m[2]);
 704         }
 705         if (!isset($this->_map[$name])) {
 706             trigger_error("No plugin for $ name $ vars defined.", E_USER_WARNING);
 707             return "";
 708         }
 709         $plugin = $this->_map[$name];
 710         return new Cached_PluginInvocation("<"."?plugin $plugin $vars $body ?".">");
 711     }
 712 }
 713
 714 /** ENABLE_MARKUP_TEMPLATE
 715  *  Template syntax similar to mediawiki
 716  *  {{template}}
 717  * => < ? plugin Template page=template ? >
 718  *  {{template|var=value|...}}
 719  * => < ? plugin Template page=template vars="var=value&..." ? >
 720  */
 721 class Markup_template_plugin  extends SimpleMarkup
 722 {
 723     var $_match_regexp = '\{\{\w[^\n]+\}\}';
 724
 725     function markup ($match) {
 726         $page = substr($match,2,-2); $vars = '';
 727         if (preg_match('/^(\S+)\|(.*)$/', $page, $_m)) {
 728             $page = $_m[1];
 729             $vars = str_replace('|', '&', $_m[2]);
 730         }
 731         if ($vars)
 732             $s = '<'.'?plugin Template page=' . $page . ' vars="' . $vars . '"?'.'>';
 733         else
 734             $s = '<'.'?plugin Template page=' . $page . '?'.'>';
 735         return new Cached_PluginInvocation($s);
 736     }
 737 }
 738
 739 // "..." => "&#133;"  browser specific display (not cached?)
 740 // Support some HTML::Entities: (C) for copy, --- for mdash, -- for ndash
 741 // TODO: "--" => "&emdash;" browser specific display (not cached?)
 742
 743 class Markup_html_entities  extends SimpleMarkup {
 744     //var $_match_regexp = '(: \.\.\.|\-\-|\-\-\-|\(C\) )';
 745
 746     function Markup_html_entities() {
 747         $this->_entities = array('...'  => '&#133;',
 748                                  '--'   => '&ndash;',
 749                                  '---'  => '&mdash;',
 750                                  '(C)'  => '&copy;',
 751                                  '&copy;' => '&copy;',
 752                                  '&trade;'  => '&trade;',
 753                                  );
 754         $this->_match_regexp =
 755             '(: ' .
 756             join('|', array_map('preg_quote', array_keys($this->_entities))) .
 757             ' )';
 758     }
 759
 760     function markup ($match) {
 761         return HTML::Raw($this->_entities[$match]);
 762     }
 763 }
 764
 765 class Markup_isonumchars  extends SimpleMarkup {
 766     var $_match_regexp = '\&\#\d{2,5};';
 767
 768     function markup ($match) {
 769         return HTML::Raw($match);
 770     }
 771 }
 772
 773 class Markup_isohexchars extends SimpleMarkup {
 774     // hexnums, like &#x00A4; <=> &curren;
 775     var $_match_regexp = '\&\#x[0-9a-fA-F]{2,4};';
 776
 777     function markup ($match) {
 778         return HTML::Raw($match);
 779     }
 780 }
 781
 782 // FIXME: Do away with magic phpwiki forms.  (Maybe phpwiki: links too?)
 783 // FIXME: Do away with plugin-links.  They seem not to be used.
 784 //Plugin link
 785
 786 class InlineTransformer
 787 {
 788     var $_regexps = array();
 789     var $_markup = array();
 790
 791     function InlineTransformer ($markup_types = false) {
 792         if (!$markup_types) {
 793             $non_default = false;
 794             if (DISABLE_MARKUP_WIKIWORD)
 795                 $markup_types = array
 796                     ('escape', 'bracketlink', 'url',
 797                      'interwiki', /* 'wikiword', */ 'linebreak',
 798                      'old_emphasis', 'nestled_emphasis',
 799                      'html_emphasis', 'html_abbr', 'plugin',
 800                      'isonumchars', 'isohexchars', 'html_entities'
 801                      );
 802             else
 803                 $markup_types = array
 804                     ('escape', 'bracketlink', 'url',
 805                      'interwiki', 'wikiword', 'linebreak',
 806                      'old_emphasis', 'nestled_emphasis',
 807                      'html_emphasis', 'html_abbr', 'plugin',
 808                      'isonumchars', 'isohexchars', /*'html_entities'*/
 809                      );
 810         } else {
 811             $non_default = true;
 812         }
 813         foreach ($markup_types as $mtype) {
 814             $class = "Markup_$mtype";
 815             $this->_addMarkup(new $class);
 816         }
 817         if (ENABLE_MARKUP_COLOR and !$non_default)
 818             $this->_addMarkup(new Markup_color);
 819         if (ENABLE_MARKUP_TEMPLATE and !$non_default)
 820             $this->_addMarkup(new Markup_template_plugin);
 821     }
 822
 823     function _addMarkup ($markup) {
 824         if (isa($markup, 'SimpleMarkup'))
 825             $regexp = $markup->getMatchRegexp();
 826         else
 827             $regexp = $markup->getStartRegexp();
 828
 829         assert(!isset($this->_markup[$regexp]));
 830         $this->_regexps[] = $regexp;
 831         $this->_markup[] = $markup;
 832     }
 833
 834     function parse (&$text, $end_regexps = array('$')) {
 835         $regexps = $this->_regexps;
 836
 837         // $end_re takes precedence: "favor reduce over shift"
 838         array_unshift($regexps, $end_regexps[0]);
 839         //array_push($regexps, $end_regexps[0]);
 840         $regexps = new RegexpSet($regexps);
 841
 842         $input = $text;
 843         $output = new XmlContent;
 844
 845         $match = $regexps->match($input);
 846
 847         while ($match) {
 848             if ($match->regexp_ind == 0) {
 849                 // No start pattern found before end pattern.
 850                 // We're all done!
 851                 if (isset($markup) and is_object($markup)
 852                     and isa($markup,'Markup_plugin'))
 853                 {
 854                     $current =& $output->_content[count($output->_content)-1];
 855                     $current->setTightness(true,true);
 856                 }
 857                 $output->pushContent($match->prematch);
 858                 $text = $match->postmatch;
 859                 return $output;
 860             }
 861
 862             $markup = $this->_markup[$match->regexp_ind - 1];
 863             $body = $this->_parse_markup_body($markup, $match->match,
 864                                               $match->postmatch, $end_regexps);
 865             if (!$body) {
 866                 // Couldn't match balanced expression.
 867                 // Ignore and look for next matching start regexp.
 868                 $match = $regexps->nextMatch($input, $match);
 869                 continue;
 870             }
 871
 872             // Matched markup.  Eat input, push output.
 873             // FIXME: combine adjacent strings.
 874             if (isa($markup, 'SimpleMarkup'))
 875                 $current = $markup->markup($match->match);
 876             else
 877                 $current = $markup->markup($match->match, $body);
 878             $input = $match->postmatch;
 879             if (isset($markup) and is_object($markup)
 880                 and isa($markup,'Markup_plugin'))
 881             {
 882                 $current->setTightness(true,true);
 883             }
 884             $output->pushContent($match->prematch, $current);
 885
 886             $match = $regexps->match($input);
 887         }
 888
 889         // No pattern matched, not even the end pattern.
 890         // Parse fails.
 891         return false;
 892     }
 893
 894     function _parse_markup_body ($markup, $match, &$text, $end_regexps) {
 895         if (isa($markup, 'SimpleMarkup'))
 896             return true;        // Done. SimpleMarkup is simple.
 897
 898         if (!is_object($markup)) return false; // Some error: Should assert
 899         array_unshift($end_regexps, $markup->getEndRegexp($match));
 900
 901         // Optimization: if no end pattern in text, we know the
 902         // parse will fail.  This is an important optimization,
 903         // e.g. when text is "*lots *of *start *delims *with
 904         // *no *matching *end *delims".
 905         $ends_pat = "/(?:" . join(").*(?:", $end_regexps) . ")/xs";
 906         if (!preg_match($ends_pat, $text))
 907             return false;
 908         return $this->parse($text, $end_regexps);
 909     }
 910 }
 911
 912 class LinkTransformer extends InlineTransformer
 913 {
 914     function LinkTransformer () {
 915         $this->InlineTransformer(array('escape', 'bracketlink', 'url',
 916                                        'interwiki', 'wikiword'));
 917     }
 918 }
 919
 920 class NowikiTransformer extends InlineTransformer
 921 {
 922     function NowikiTransformer () {
 923         $this->InlineTransformer
 924             (array('linebreak',
 925                    'html_emphasis', 'html_abbr', 'plugin',
 926                    'isonumchars', 'isohexchars', /*'html_entities',*/
 927                    ));
 928     }
 929 }
 930
 931 function TransformInline($text, $markup = 2.0, $basepage=false) {
 932     static $trfm;
 933
 934     if (empty($trfm)) {
 935         $trfm = new InlineTransformer;
 936     }
 937
 938     if ($markup < 2.0) {
 939         $text = ConvertOldMarkup($text, 'inline');
 940     }
 941
 942     if ($basepage) {
 943         return new CacheableMarkup($trfm->parse($text), $basepage);
 944     }
 945     return $trfm->parse($text);
 946 }
 947
 948 function TransformLinks($text, $markup = 2.0, $basepage = false) {
 949     static $trfm;
 950
 951     if (empty($trfm)) {
 952         $trfm = new LinkTransformer;
 953     }
 954
 955     if ($markup < 2.0) {
 956         $text = ConvertOldMarkup($text, 'links');
 957     }
 958
 959     if ($basepage) {
 960         return new CacheableMarkup($trfm->parse($text), $basepage);
 961     }
 962     return $trfm->parse($text);
 963 }
 964
 965 /**
 966  * Transform only html markup and entities.
 967  */
 968 function TransformInlineNowiki($text, $markup = 2.0, $basepage=false) {
 969     static $trfm;
 970
 971     if (empty($trfm)) {
 972         $trfm = new NowikiTransformer;
 973     }
 974     if ($basepage) {
 975         return new CacheableMarkup($trfm->parse($text), $basepage);
 976     }
 977     return $trfm->parse($text);
 978 }
 979
 980
 981 // $Log: not supported by cvs2svn $
 982 // Revision 1.76  2006/08/19 11:02:35  rurban
 983 // add strike and del to html emphasis: Patch #1542894 by Kai Krakow
 984 //
 985 // Revision 1.75  2006/08/15 13:43:10  rurban
 986 // add Markup_xml_plugin (untested) and fix Markup_template_plugin
 987 //
 988 // Revision 1.74  2006/07/23 14:03:18  rurban
 989 // add new feature: DISABLE_MARKUP_WIKIWORD
 990 //
 991 // Revision 1.73  2006/04/15 12:20:36  rurban
 992 // fix relatives links patch by Joel Schaubert for [/
 993 //
 994 // Revision 1.72  2006/03/07 20:43:29  rurban
 995 // relative external link, if no internal subpage. by joel Schaubert
 996 //
 997 // Revision 1.71  2005/11/14 22:31:12  rurban
 998 // add SemanticWeb support
 999 //
1000 // Revision 1.70  2005/10/31 16:45:23  rurban
1001 // added cfg-able markups only for default TextTransformation, not for links and others
1002 //
1003 // Revision 1.69  2005/09/14 05:57:19  rurban
1004 // make ENABLE_MARKUP_TEMPLATE optional
1005 //
1006 // Revision 1.68  2005/09/10 21:24:32  rurban
1007 // optionally support {{Template|vars}} syntax
1008 //
1009 // Revision 1.67  2005/06/06 17:41:20  rurban
1010 // support new ENABLE_MARKUP_COLOR
1011 //
1012 // Revision 1.66  2005/04/23 11:15:49  rurban
1013 // handle allowed inlined objects within INLINE_IMAGES
1014 //
1015 // Revision 1.65  2005/03/27 18:24:17  rurban
1016 // add Log
1017 //
1018
1019 // (c-file-style: "gnu")
1020 // Local Variables:
1021 // mode: php
1022 // tab-width: 8
1023 // c-basic-offset: 4
1024 // c-hanging-comment-ender-p: nil
1025 // indent-tabs-mode: nil
1026 // End:
1027 ?>