lib/InlineParser.php

   1 <?php
   2 rcs_id('$Id$');
   3 /* Copyright (C) 2002 Geoffrey T. Dairiki <dairiki@dairiki.org>
   4  * Copyright (C) 2004-2008 Reini Urban
   5  * Copyright (C) 2008-2009 Marc-Etienne Vargenau, Alcatel-Lucent
   6  *
   7  * This file is part of PhpWiki.
   8  *
   9  * PhpWiki is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * PhpWiki is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with PhpWiki; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23 /**
  24  * This is the code which deals with the inline part of the (new-style)
  25  * wiki-markup.
  26  *
  27  * @package Markup
  28  * @author Geoffrey T. Dairiki, Reini Urban
  29  */
  30
  31 /**
  32  * This is the character used in wiki markup to escape characters with
  33  * special meaning.
  34  */
  35 define('ESCAPE_CHAR', '~');
  36
  37 require_once(dirname(__FILE__).'/HtmlElement.php');
  38 require_once('lib/CachedMarkup.php');
  39 require_once(dirname(__FILE__).'/stdlib.php');
  40
  41
  42 function WikiEscape($text) {
  43     return str_replace('#', ESCAPE_CHAR . '#', $text);
  44 }
  45
  46 function UnWikiEscape($text) {
  47     return preg_replace('/' . ESCAPE_CHAR . '(.)/', '\1', $text);
  48 }
  49
  50 /**
  51  * Return type from RegexpSet::match and RegexpSet::nextMatch.
  52  *
  53  * @see RegexpSet
  54  */
  55 class RegexpSet_match {
  56     /**
  57      * The text leading up the the next match.
  58      */
  59     var $prematch;
  60     /**
  61      * The matched text.
  62      */
  63     var $match;
  64     /**
  65      * The text following the matched text.
  66      */
  67     var $postmatch;
  68     /**
  69      * Index of the regular expression which matched.
  70      */
  71     var $regexp_ind;
  72 }
  73
  74 /**
  75  * A set of regular expressions.
  76  *
  77  * This class is probably only useful for InlineTransformer.
  78  */
  79 class RegexpSet
  80 {
  81     /** Constructor
  82      *
  83      * @param array $regexps A list of regular expressions.  The
  84      * regular expressions should not include any sub-pattern groups
  85      * "(...)".  (Anonymous groups, like "(?:...)", as well as
  86      * look-ahead and look-behind assertions are okay.)
  87      */
  88     function RegexpSet ($regexps) {
  89         assert($regexps);
  90         $this->_regexps = array_unique($regexps);
  91         if (!defined('_INLINE_OPTIMIZATION')) define('_INLINE_OPTIMIZATION',0);
  92     }
  93
  94     /**
  95      * Search text for the next matching regexp from the Regexp Set.
  96      *
  97      * @param string $text The text to search.
  98      *
  99      * @return RegexpSet_match  A RegexpSet_match object, or false if no match.
 100      */
 101     function match ($text) {
 102         return $this->_match($text, $this->_regexps, '*?');
 103     }
 104
 105     /**
 106      * Search for next matching regexp.
 107      *
 108      * Here, 'next' has two meanings:
 109      *
 110      * Match the next regexp(s) in the set, at the same position as the last match.
 111      *
 112      * If that fails, match the whole RegexpSet, starting after the position of the
 113      * previous match.
 114      *
 115      * @param string $text Text to search.
 116      *
 117      * @param RegexpSet_match $prevMatch A RegexpSet_match object.
 118      * $prevMatch should be a match object obtained by a previous
 119      * match upon the same value of $text.
 120      *
 121      * @return RegexpSet_match A RegexpSet_match object, or false if no match.
 122      */
 123     function nextMatch ($text, $prevMatch) {
 124         // Try to find match at same position.
 125         $pos = strlen($prevMatch->prematch);
 126         $regexps = array_slice($this->_regexps, $prevMatch->regexp_ind + 1);
 127         if ($regexps) {
 128             $repeat = sprintf('{%d}', $pos);
 129             if ( ($match = $this->_match($text, $regexps, $repeat)) ) {
 130                 $match->regexp_ind += $prevMatch->regexp_ind + 1;
 131                 return $match;
 132             }
 133
 134         }
 135
 136         // Failed.  Look for match after current position.
 137         $repeat = sprintf('{%d,}?', $pos + 1);
 138         return $this->_match($text, $this->_regexps, $repeat);
 139     }
 140
 141     // Syntax: http://www.pcre.org/pcre.txt
 142     //   x - EXTENDED, ignore whitespace
 143     //   s - DOTALL
 144     //   A - ANCHORED
 145     //   S - STUDY
 146     function _match ($text, $regexps, $repeat) {
 147         // If one of the regexps is an empty string, php will crash here:
 148         // sf.net: Fatal error: Allowed memory size of 8388608 bytes exhausted
 149         //         (tried to allocate 634 bytes)
 150         if (_INLINE_OPTIMIZATION) { // disabled, wrong
 151             // So we try to minize memory usage, by looping explicitly,
 152             // and storing only those regexp which actually match.
 153             // There may be more than one, so we have to find the longest,
 154             // and match inside until the shortest is empty.
 155             $matched = array(); $matched_ind = array();
 156             for ($i=0; $i<count($regexps); $i++) {
 157                 if (!trim($regexps[$i])) {
 158                     trigger_error("empty regexp $i", E_USER_WARNING);
 159                     continue;
 160                 }
 161                 $pat= "/ ( . $repeat ) ( " . $regexps[$i] . " ) /x";
 162                 if (preg_match($pat, $text, $_m)) {
 163                     $m = $_m; // FIXME: prematch, postmatch is wrong
 164                     $matched[] = $regexps[$i];
 165                     $matched_ind[] = $i;
 166                     $regexp_ind = $i;
 167                 }
 168             }
 169             // To overcome ANCHORED:
 170             // We could sort by longest match and iterate over these.
 171             if (empty($matched)) return false;
 172         }
 173         $match = new RegexpSet_match;
 174
 175         // Optimization: if the matches are only "$" and another, then omit "$"
 176         if (! _INLINE_OPTIMIZATION or count($matched) > 2) {
 177             assert(!empty($repeat));
 178             assert(!empty($regexps));
 179             // We could do much better, if we would know the matching markup for the
 180             // longest regexp match:
 181             $hugepat= "/ ( . $repeat ) ( (" . join(')|(', $regexps) . ") ) /Asx";
 182             // Proposed premature optimization 1:
 183             //$hugepat= "/ ( . $repeat ) ( (" . join(')|(', array_values($matched)) . ") ) /Asx";
 184             if (! preg_match($hugepat, $text, $m)) {
 185                 return false;
 186             }
 187             // Proposed premature optimization 1:
 188             //$match->regexp_ind = $matched_ind[count($m) - 4];
 189             $match->regexp_ind = count($m) - 4;
 190         } else {
 191             $match->regexp_ind = $regexp_ind;
 192         }
 193
 194         $match->postmatch = substr($text, strlen($m[0]));
 195         $match->prematch = $m[1];
 196         $match->match = $m[2];
 197
 198         /* DEBUGGING */
 199         if (DEBUG & _DEBUG_PARSER) {
 200           static $_already_dumped = 0;
 201           if (!$_already_dumped) {
 202             var_dump($regexps);
 203             if (_INLINE_OPTIMIZATION)
 204                 var_dump($matched);
 205             var_dump($matched_inc);
 206           }
 207           $_already_dumped = 1;
 208           PrintXML(HTML::dl(HTML::dt("input"),
 209                           HTML::dd(HTML::pre($text)),
 210                           HTML::dt("regexp"),
 211                           HTML::dd(HTML::pre($match->regexp_ind, ":", $regexps[$match->regexp_ind])),
 212                           HTML::dt("prematch"),
 213                           HTML::dd(HTML::pre($match->prematch)),
 214                           HTML::dt("match"),
 215                           HTML::dd(HTML::pre($match->match)),
 216                           HTML::dt("postmatch"),
 217                           HTML::dd(HTML::pre($match->postmatch))
 218                           ));
 219         }
 220         return $match;
 221     }
 222 }
 223
 224
 225
 226 /**
 227  * A simple markup rule (i.e. terminal token).
 228  *
 229  * These are defined by a regexp.
 230  *
 231  * When a match is found for the regexp, the matching text is replaced.
 232  * The replacement content is obtained by calling the SimpleMarkup::markup method.
 233  */
 234 class SimpleMarkup
 235 {
 236     var $_match_regexp;
 237
 238     /** Get regexp.
 239      *
 240      * @return string Regexp which matches this token.
 241      */
 242     function getMatchRegexp () {
 243         return $this->_match_regexp;
 244     }
 245
 246     /** Markup matching text.
 247      *
 248      * @param string $match The text which matched the regexp
 249      * (obtained from getMatchRegexp).
 250      *
 251      * @return mixed The expansion of the matched text.
 252      */
 253     function markup ($match /*, $body */) {
 254         trigger_error("pure virtual", E_USER_ERROR);
 255     }
 256 }
 257
 258 /**
 259  * A balanced markup rule.
 260  *
 261  * These are defined by a start regexp, and an end regexp.
 262  */
 263 class BalancedMarkup
 264 {
 265     var $_start_regexp;
 266
 267     /** Get the starting regexp for this rule.
 268      *
 269      * @return string The starting regexp.
 270      */
 271     function getStartRegexp () {
 272         return $this->_start_regexp;
 273     }
 274
 275     /** Get the ending regexp for this rule.
 276      *
 277      * @param string $match The text which matched the starting regexp.
 278      *
 279      * @return string The ending regexp.
 280      */
 281     function getEndRegexp ($match) {
 282         return $this->_end_regexp;
 283     }
 284
 285     /** Get expansion for matching input.
 286      *
 287      * @param string $match The text which matched the starting regexp.
 288      *
 289      * @param mixed $body Transformed text found between the starting
 290      * and ending regexps.
 291      *
 292      * @return mixed The expansion of the matched text.
 293      */
 294     function markup ($match, $body) {
 295         trigger_error("pure virtual", E_USER_ERROR);
 296     }
 297 }
 298
 299 class Markup_escape  extends SimpleMarkup
 300 {
 301     function getMatchRegexp () {
 302         return ESCAPE_CHAR . '(?: [[:alnum:]]+ | .)';
 303     }
 304
 305     function markup ($match) {
 306         assert(strlen($match) >= 2);
 307         return substr($match, 1);
 308     }
 309 }
 310
 311 /**
 312  * [image.jpg size=50% border=5], [image.jpg size=50x30]
 313  * Support for the following attributes: see stdlib.php:LinkImage()
 314  *   size=<precent>%, size=<width>x<height>
 315  *   border=n, align=\w+, hspace=n, vspace=n
 316  *   width=n, height=n
 317  */
 318 function isImageLink($link) {
 319     if (!$link) return false;
 320     assert(defined('INLINE_IMAGES'));
 321     return preg_match("/\\.(" . INLINE_IMAGES . ")$/i", $link)
 322         or preg_match("/\\.(" . INLINE_IMAGES . ")\s+(size|border|align|hspace|vspace|type|data|width|height)=/i", $link);
 323 }
 324
 325 function LinkBracketLink($bracketlink) {
 326
 327     // $bracketlink will start and end with brackets; in between will
 328     // be either a page name, a URL or both separated by a pipe.
 329
 330    $wikicreolesyntax = false;
 331
 332    if (string_starts_with($bracketlink, "[[")) {
 333        $wikicreolesyntax = true;
 334        $bracketlink = str_replace("[[", "[", $bracketlink);
 335        $bracketlink = str_replace("]]", "]", $bracketlink);
 336    }
 337
 338     // Strip brackets and leading space
 339     // bug#1904088  Some brackets links on 2 lines cause the parser to crash
 340     preg_match('/(\#?) \[\s* (?: (.*?) \s* (?<!' . ESCAPE_CHAR . ')(\|) )? \s* (.+?) \s*\]/x',
 341                str_replace("\n", " ", $bracketlink), $matches);
 342     if (count($matches) < 4) {
 343         // "[ personal\ninformation manager | PhpWiki:PersonalWiki ]"
 344         trigger_error(_("Invalid [] syntax ignored").": ".$bracketlink, E_USER_WARNING);
 345         return new Cached_Link;
 346     }
 347     list (, $hash, $label, $bar, $rawlink) = $matches;
 348
 349     if ($wikicreolesyntax and $label) {
 350         $temp = $label;
 351         $label = $rawlink;
 352         $rawlink = $temp;
 353     }
 354
 355     // Mediawiki compatibility: allow "Image:" and "File:"
 356     // as synonyms of "Upload:"
 357     if (string_starts_with($rawlink, "Image:")) {
 358         $rawlink = str_replace("Image:", "Upload:", $rawlink);
 359     }
 360     if (string_starts_with($rawlink, "File:")) {
 361         $rawlink = str_replace("File:", "Upload:", $rawlink);
 362     }
 363
 364     $label = UnWikiEscape($label);
 365     /*
 366      * Check if the user has typed a explicit URL. This solves the
 367      * problem where the URLs have a ~ character, which would be stripped away.
 368      *   "[http:/server/~name/]" will work as expected
 369      *   "http:/server/~name/"   will NOT work as expected, will remove the ~
 370      */
 371     if (   string_starts_with ($rawlink, "http://")
 372         or string_starts_with ($rawlink, "https://") )
 373     {
 374         $link = $rawlink;
 375         // Mozilla Browser URI Obfuscation Weakness 2004-06-14
 376         //   http://www.securityfocus.com/bid/10532/
 377         //   goodurl+"%2F%20%20%20."+badurl
 378         if (preg_match("/%2F(%20)+\./i", $rawlink)) {
 379             $rawlink = preg_replace("/%2F(%20)+\./i","%2F.",$rawlink);
 380         }
 381     } else
 382         $link  = UnWikiEscape($rawlink);
 383
 384     /* Relatives links by Joel Schaubert.
 385      * Recognize [../bla] or [/bla] as relative links, without needing http://
 386      * but [ /link ] only if SUBPAGE_SEPERATOR is not "/".
 387      * Normally /Page links to the subpage /Page.
 388      */
 389     if (SUBPAGE_SEPARATOR == '/') {
 390         if (preg_match('/^\.\.\//', $link)) {
 391             return new Cached_ExternalLink($link, $label);
 392         }
 393     } else if (preg_match('/^(\.\.\/|\/)/', $link)) {
 394         return new Cached_ExternalLink($link, $label);
 395     }
 396
 397     // Handle "[[SandBox|{{image.jpg}}]]" and "[[SandBox|{{image.jpg|alt text}}]]"
 398     if (string_starts_with($label, "{{")) {
 399         $imgurl = substr($label, 2, -2); // Remove "{{" and "}}"
 400         $pipe = strpos($imgurl, '|');
 401         if ($pipe === false) {
 402             $label = LinkImage(getUploadDataPath() . $imgurl, $link);
 403         } else {
 404             list($img, $alt) = explode("|", $imgurl);
 405             $label = LinkImage(getUploadDataPath() . $img, $alt);
 406         }
 407     } else
 408
 409     // [label|link]
 410     // If label looks like a url to an image or object, we want an image link.
 411     if (isImageLink($label)) {
 412         $imgurl = $label;
 413         $intermap = getInterwikiMap();
 414         if (preg_match("/^" . $intermap->getRegexp() . ":/", $label)) {
 415             $imgurl = $intermap->link($label);
 416             $imgurl = $imgurl->getAttr('href');
 417         } elseif (! preg_match("#^(" . ALLOWED_PROTOCOLS . "):#", $imgurl)) {
 418             // local theme linkname like 'images/next.gif'.
 419             global $WikiTheme;
 420             $imgurl = $WikiTheme->getImageURL($imgurl);
 421         }
 422         // for objects (non-images) the link is taken as alt tag,
 423         // which is in return taken as alternative img
 424         $label = LinkImage($imgurl, $link);
 425     }
 426
 427     if ($hash) {
 428         // It's an anchor, not a link...
 429         $id = MangleXmlIdentifier($link);
 430         return HTML::a(array('name' => $id, 'id' => $id),
 431                        $bar ? $label : $link);
 432     }
 433
 434     if (preg_match("#^(" . ALLOWED_PROTOCOLS . "):#", $link)) {
 435         // if it's an image, embed it; otherwise, it's a regular link
 436         if (isImageLink($link) and empty($label)) // patch #1348996 by Robert Litwiniec
 437             return LinkImage($link, $label);
 438         else
 439             return new Cached_ExternalLink($link, $label);
 440     }
 441     elseif (substr($link,0,8) == 'phpwiki:')
 442         return new Cached_PhpwikiURL($link, $label);
 443
 444     /* Semantic relations and attributes.
 445      * Relation and attribute names must be word chars only, no space.
 446      * Links and Attributes may contain everything. word, nums, units, space, groupsep, numsep, ...
 447      */
 448     elseif (preg_match("/^ (\w+) (:[:=]) (.*) $/x", $link) and !isImageLink($link))
 449         return new Cached_SemanticLink($link, $label);
 450
 451     /* Do not store the link */
 452     elseif (substr($link,0,1) == ':')
 453         return new Cached_WikiLink($link, $label);
 454
 455     /*
 456      * Inline images in Interwiki urls's:
 457      * [File:my_image.gif] inlines the image,
 458      * File:my_image.gif shows a plain inter-wiki link,
 459      * [what a pic|File:my_image.gif] shows a named inter-wiki link to the gif
 460      * [File:my_image.gif|what a pic] shows a inlimed image linked to the page "what a pic"
 461      *
 462      * Note that for simplicity we will accept embedded object tags (non-images)
 463      * here also, and seperate them later in LinkImage()
 464      */
 465     elseif (strstr($link,':')
 466             and ($intermap = getInterwikiMap())
 467             and preg_match("/^" . $intermap->getRegexp() . ":/", $link))
 468     {
 469         // trigger_error("label: $label link: $link", E_USER_WARNING);
 470         if (empty($label) and isImageLink($link)) {
 471             // if without label => inlined image [File:xx.gif]
 472             $imgurl = $intermap->link($link);
 473             return LinkImage($imgurl->getAttr('href'), $link);
 474         }
 475         return new Cached_InterwikiLink($link, $label);
 476     } else {
 477         // Split anchor off end of pagename.
 478         if (preg_match('/\A(.*)(?<!'.ESCAPE_CHAR.')#(.*?)\Z/', $rawlink, $m)) {
 479             list(,$rawlink,$anchor) = $m;
 480             $pagename = UnWikiEscape($rawlink);
 481             $anchor = UnWikiEscape($anchor);
 482             if (!$label)
 483                 $label = $link;
 484         }
 485         else {
 486             $pagename = $link;
 487             $anchor = false;
 488         }
 489         return new Cached_WikiLink($pagename, $label, $anchor);
 490     }
 491 }
 492
 493 class Markup_wikicreolebracketlink  extends SimpleMarkup
 494 {
 495     var $_match_regexp = "\\#? \\[\\[ .*? [^]\\s] .*? \\]\\]";
 496
 497     function markup ($match) {
 498         $link = LinkBracketLink($match);
 499         assert($link->isInlineElement());
 500         return $link;
 501     }
 502 }
 503
 504 class Markup_bracketlink  extends SimpleMarkup
 505 {
 506     var $_match_regexp = "\\#? \\[ .*? [^]\\s] .*? \\]";
 507
 508     function markup ($match) {
 509         $link = LinkBracketLink($match);
 510         assert($link->isInlineElement());
 511         return $link;
 512     }
 513 }
 514
 515 class Markup_spellcheck extends SimpleMarkup
 516 {
 517     function Markup_spellcheck () {
 518         $this->suggestions = $GLOBALS['request']->getArg('suggestions');
 519     }
 520     function getMatchRegexp () {
 521         if (empty($this->suggestions))
 522             return "(?# false )";
 523         $words = array_keys($this->suggestions);
 524         return "(?<= \W ) (?:" . join('|', $words) . ") (?= \W )";
 525     }
 526
 527     function markup ($match) {
 528         if (empty($this->suggestions) or empty($this->suggestions[$match]))
 529             return $match;
 530         return new Cached_SpellCheck(UnWikiEscape($match), $this->suggestions[$match]);
 531     }
 532 }
 533
 534 class Markup_searchhighlight extends SimpleMarkup
 535 {
 536     function Markup_searchhighlight () {
 537         $result = $GLOBALS['request']->_searchhighlight;
 538         require_once("lib/TextSearchQuery.php");
 539         $query = new TextSearchQuery($result['query']);
 540         $this->hilight_re = $query->getHighlightRegexp();
 541         $this->engine = $result['engine'];
 542     }
 543     function getMatchRegexp () {
 544         return $this->hilight_re;
 545     }
 546     function markup ($match) {
 547         return new Cached_SearchHighlight(UnWikiEscape($match), $this->engine);
 548     }
 549 }
 550
 551 class Markup_url extends SimpleMarkup
 552 {
 553     function getMatchRegexp () {
 554         return "(?<![[:alnum:]]) (?:" . ALLOWED_PROTOCOLS . ") : [^\s<>\"']+ (?<![ ,.?; \] \) ])";
 555     }
 556
 557     function markup ($match) {
 558         return new Cached_ExternalLink(UnWikiEscape($match));
 559     }
 560 }
 561
 562 class Markup_interwiki extends SimpleMarkup
 563 {
 564     function getMatchRegexp () {
 565         $map = getInterwikiMap();
 566         return "(?<! [[:alnum:]])" . $map->getRegexp(). ": [^:=]\S+ (?<![ ,.?;! \] \) \" \' ])";
 567     }
 568
 569     function markup ($match) {
 570         return new Cached_InterwikiLink(UnWikiEscape($match));
 571     }
 572 }
 573
 574 class Markup_semanticlink extends SimpleMarkup
 575 {
 576     // No units seperated by space allowed here
 577     // For :: (relations) only words, no comma,
 578     // but for := (attributes) comma and dots are allowed. Units with groupsep.
 579     // Ending dots or comma are not part of the link.
 580     var $_match_regexp = "(?: \w+:=\S+(?<![\.,]))|(?: \w+::[\w\.]+(?<!\.))";
 581
 582     function markup ($match) {
 583         return new Cached_SemanticLink(UnWikiEscape($match));
 584     }
 585 }
 586
 587 class Markup_wikiword extends SimpleMarkup
 588 {
 589     function getMatchRegexp () {
 590         global $WikiNameRegexp;
 591         if (!trim($WikiNameRegexp)) return " " . WIKI_NAME_REGEXP;
 592         return " $WikiNameRegexp";
 593     }
 594
 595     function markup ($match) {
 596         if (!$match) return false;
 597         if ($this->_isWikiUserPage($match))
 598             return new Cached_UserLink($match); //$this->_UserLink($match);
 599         else
 600             return new Cached_WikiLink($match);
 601     }
 602
 603     // FIXME: there's probably a more useful place to put these two functions
 604     function _isWikiUserPage ($page) {
 605         global $request;
 606         $dbi = $request->getDbh();
 607         $page_handle = $dbi->getPage($page);
 608         if ($page_handle and $page_handle->get('pref'))
 609             return true;
 610         else
 611             return false;
 612     }
 613
 614     function _UserLink($PageName) {
 615         $link = HTML::a(array('href' => $PageName));
 616         $link->pushContent(PossiblyGlueIconToText('wikiuser', $PageName));
 617         $link->setAttr('class', 'wikiuser');
 618         return $link;
 619     }
 620 }
 621
 622 class Markup_linebreak extends SimpleMarkup
 623 {
 624     //var $_match_regexp = "(?: (?<! %) %%% (?! %) | <(?:br|BR)> | <(?:br|BR) \/> )";
 625     var $_match_regexp = "(?: (?<! %) %%% (?! %) | \\\\\\\\ | <(?:br|BR)> )";
 626
 627     function markup ($match) {
 628         return HTML::br();
 629     }
 630 }
 631
 632 class Markup_wikicreole_italics extends BalancedMarkup
 633 {
 634     var $_start_regexp = "\\/\\/";
 635
 636     function getEndRegexp ($match) {
 637         return "\\/\\/";
 638     }
 639
 640     function markup ($match, $body) {
 641         $tag = 'em';
 642         return new HtmlElement($tag, $body);
 643     }
 644 }
 645
 646 class Markup_wikicreole_bold extends BalancedMarkup
 647 {
 648     var $_start_regexp = "\\*\\*";
 649
 650     function getEndRegexp ($match) {
 651         return "\\*\\*";
 652     }
 653
 654     function markup ($match, $body) {
 655         $tag = 'strong';
 656         return new HtmlElement($tag, $body);
 657     }
 658 }
 659
 660 class Markup_wikicreole_monospace extends BalancedMarkup
 661 {
 662     var $_start_regexp = "\\#\\#";
 663
 664     function getEndRegexp ($match) {
 665         return "\\#\\#";
 666     }
 667
 668     function markup ($match, $body) {
 669         $tag = 'tt';
 670         return new HtmlElement($tag, $body);
 671     }
 672 }
 673
 674 class Markup_wikicreole_superscript extends BalancedMarkup
 675 {
 676     var $_start_regexp = "\\^\\^";
 677
 678     function getEndRegexp ($match) {
 679         return "\\^\\^";
 680     }
 681
 682     function markup ($match, $body) {
 683         $tag = 'sup';
 684         return new HtmlElement($tag, $body);
 685     }
 686 }
 687
 688 class Markup_wikicreole_subscript extends BalancedMarkup
 689 {
 690     var $_start_regexp = ",,";
 691
 692     function getEndRegexp ($match) {
 693         return $match;
 694     }
 695
 696     function markup ($match, $body) {
 697         $tag = 'sub';
 698         return new HtmlElement($tag, $body);
 699     }
 700 }
 701
 702 class Markup_old_emphasis  extends BalancedMarkup
 703 {
 704     var $_start_regexp = "''|__";
 705
 706     function getEndRegexp ($match) {
 707         return $match;
 708     }
 709
 710     function markup ($match, $body) {
 711         $tag = $match == "''" ? 'em' : 'strong';
 712         return new HtmlElement($tag, $body);
 713     }
 714 }
 715
 716 class Markup_nestled_emphasis extends BalancedMarkup
 717 {
 718     function getStartRegexp() {
 719         static $start_regexp = false;
 720
 721         if (!$start_regexp) {
 722             // The three possible delimiters
 723             // (none of which can be followed by itself.)
 724             $i = "_ (?! _)";
 725             $b = "\\* (?! \\*)";
 726             $tt = "= (?! =)";
 727
 728             $any = "(?: ${i}|${b}|${tt})"; // any of the three.
 729
 730             // Any of [_*=] is okay if preceded by space or one of [-"'/:]
 731             $start[] = "(?<= \\s|^|[-\"'\\/:]) ${any}";
 732
 733             // _ or * is okay after = as long as not immediately followed by =
 734             $start[] = "(?<= =) (?: ${i}|${b}) (?! =)";
 735             // etc...
 736             $start[] = "(?<= _) (?: ${b}|${tt}) (?! _)";
 737             $start[] = "(?<= \\*) (?: ${i}|${tt}) (?! \\*)";
 738
 739
 740             // any delimiter okay after an opening brace ( [{<(] )
 741             // as long as it's not immediately followed by the matching closing
 742             // brace.
 743             $start[] = "(?<= { ) ${any} (?! } )";
 744             $start[] = "(?<= < ) ${any} (?! > )";
 745             $start[] = "(?<= \\( ) ${any} (?! \\) )";
 746
 747             $start = "(?:" . join('|', $start) . ")";
 748
 749             // Any of the above must be immediately followed by non-whitespace.
 750             $start_regexp = $start . "(?= \S)";
 751         }
 752
 753         return $start_regexp;
 754     }
 755
 756     function getEndRegexp ($match) {
 757         $chr = preg_quote($match);
 758         return "(?<= \S | ^ ) (?<! $chr) $chr (?! $chr) (?= \s | [-)}>\"'\\/:.,;!? _*=] | $)";
 759     }
 760
 761     function markup ($match, $body) {
 762         switch ($match) {
 763         case '*': return new HtmlElement('b', $body);
 764         case '=': return new HtmlElement('tt', $body);
 765         case '_': return new HtmlElement('i', $body);
 766         }
 767     }
 768 }
 769
 770 class Markup_html_emphasis extends BalancedMarkup
 771 {
 772     var $_start_regexp =
 773         "<(?: b|big|i|small|tt|em|strong|cite|code|dfn|kbd|samp|s|strike|del|var|sup|sub )>";
 774
 775     function getEndRegexp ($match) {
 776         return "<\\/" . substr($match, 1);
 777     }
 778
 779     function markup ($match, $body) {
 780         $tag = substr($match, 1, -1);
 781         return new HtmlElement($tag, $body);
 782     }
 783 }
 784
 785 class Markup_html_divspan extends BalancedMarkup
 786 {
 787     var $_start_regexp =
 788         "<(?: div|span )(?: \s[^>]*)?>";
 789
 790     function getEndRegexp ($match) {
 791         if (substr($match,1,4) == 'span')
 792             $tag = 'span';
 793         else
 794             $tag = 'div';
 795         return "<\\/" . $tag . '>';
 796     }
 797
 798     function markup ($match, $body) {
 799         if (substr($match,1,4) == 'span')
 800             $tag = 'span';
 801         else
 802             $tag = 'div';
 803         $rest = substr($match,1+strlen($tag),-1);
 804         if (!empty($rest)) {
 805             $args = parse_attributes($rest);
 806         } else {
 807             $args = array();
 808         }
 809         return new HtmlElement($tag, $args, $body);
 810     }
 811 }
 812
 813
 814 class Markup_html_abbr extends BalancedMarkup
 815 {
 816     //rurban: abbr|acronym need an optional title tag.
 817     //sf.net bug #728595
 818     // allowed attributes: title and lang
 819     var $_start_regexp = "<(?: abbr|acronym )(?: [^>]*)?>";
 820
 821     function getEndRegexp ($match) {
 822         if (substr($match,1,4) == 'abbr')
 823             $tag = 'abbr';
 824         else
 825             $tag = 'acronym';
 826         return "<\\/" . $tag . '>';
 827     }
 828
 829     function markup ($match, $body) {
 830         if (substr($match,1,4) == 'abbr')
 831             $tag = 'abbr';
 832         else
 833             $tag = 'acronym';
 834         $rest = substr($match,1+strlen($tag),-1);
 835         $attrs = parse_attributes($rest);
 836         // Remove attributes other than title and lang
 837         $allowedargs = array();
 838         foreach ($attrs as $key => $value) {
 839             if (in_array ($key, array("title", "lang"))) {
 840                 $allowedargs[$key] = $value;
 841             }
 842         }
 843         return new HtmlElement($tag, $allowedargs, $body);
 844     }
 845 }
 846
 847 /** ENABLE_MARKUP_COLOR
 848  *  See http://www.pmwiki.org/wiki/PmWiki/WikiStyles and
 849  *      http://www.flexwiki.com/default.aspx/FlexWiki/FormattingRules.html
 850  */
 851 class Markup_color extends BalancedMarkup {
 852     // %color=blue% blue text %% and back to normal
 853     var $_start_regexp = "%color=(?: [^%]*)%";
 854     var $_end_regexp = "%%";
 855
 856     function markup ($match, $body) {
 857         $color = strtoupper(substr($match, 7, -1));
 858         if (strlen($color) != 7
 859             and in_array($color, array('RED', 'BLUE', 'GRAY', 'YELLOW', 'GREEN', 'CYAN', 'BLACK')))
 860         {   // must be a valid color name
 861             return new HtmlElement('font', array('color' => $color), $body);
 862         } elseif ((substr($color,0,1) == '#')
 863                   and (strspn(substr($color,1),'0123456789ABCDEF') == strlen($color)-1)) {
 864             return new HtmlElement('font', array('color' => $color), $body);
 865         } else {
 866             trigger_error(sprintf(_("unknown color %s ignored"), substr($match, 7, -1)), E_USER_WARNING);
 867         }
 868
 869     }
 870 }
 871
 872 // Wikicreole placeholder
 873 // <<<placeholder>>>
 874 class Markup_placeholder extends SimpleMarkup
 875 {
 876     var $_match_regexp = '<<<.*?>>>';
 877
 878     function markup ($match) {
 879         return HTML::span($match);
 880     }
 881 }
 882
 883 // Single-line HTML comment
 884 // <!-- This is a comment -->
 885 class Markup_html_comment extends SimpleMarkup
 886 {
 887     var $_match_regexp = '<!--.*?-->';
 888
 889     function markup ($match) {
 890         return HTML::raw('');
 891     }
 892 }
 893
 894 // Special version for single-line plugins formatting,
 895 //  like: '<small>< ?plugin PopularNearby ? ></small>'
 896 class Markup_plugin extends SimpleMarkup
 897 {
 898     var $_match_regexp = '<\?plugin(?:-form)?\s[^\n]+?\?>';
 899
 900     function markup ($match) {
 901         return new Cached_PluginInvocation($match);
 902     }
 903 }
 904
 905 // Special version for single-line Wikicreole plugins formatting.
 906 class Markup_plugin_wikicreole extends SimpleMarkup
 907 {
 908     var $_match_regexp = '<<[^\n]+?>>';
 909
 910     function markup ($match) {
 911         $pi = str_replace("<<", "<?plugin ", $match);
 912         $pi = str_replace(">>", " ?>", $pi);
 913         return new Cached_PluginInvocation($pi);
 914     }
 915 }
 916
 917 // Special version for plugins in xml syntax
 918 // <name arg=value>body</name> or <name /> => < ? plugin pluginname arg=value body ? >
 919 // PLUGIN_MARKUP_MAP = "html:RawHtml dot:GraphViz toc:CreateToc amath:AsciiMath richtable:RichTable include:IncludePage tex:TexToPng"
 920 class Markup_xml_plugin extends BalancedMarkup
 921 {
 922     //var $_start_regexp = "<(?: ".join('|',PLUGIN_MARKUP_MAP)." )(?: \s[^>]*)>";
 923
 924     function getStartRegexp () {
 925         global $PLUGIN_MARKUP_MAP;
 926         static $_start_regexp;
 927         if ($_start_regexp) return $_start_regexp;
 928         if (empty($PLUGIN_MARKUP_MAP))
 929             return '';
 930         //"<(?: html|dot|toc|amath|richtable|include|tex )(?: \s[^>]*)>"
 931         $_start_regexp = "<(?: ".join('|',array_keys($PLUGIN_MARKUP_MAP))." )(?: \s[^>]* | / )>";
 932         return $_start_regexp;
 933     }
 934     function getEndRegexp ($match) {
 935         return "<\\/" . $match . '>';
 936     }
 937     function markup ($match, $body) {
 938         global $PLUGIN_MARKUP_MAP;
 939         $name = substr($match,2,-2);
 940         $vars = '';
 941         if (preg_match('/^(\S+)\|(.*)$/', $name, $_m)) {
 942             $name = $_m[1];
 943             $vars = $_m[2]; //str_replace(' ', '&', $_m[2]);
 944         }
 945         if (!isset($PLUGIN_MARKUP_MAP[$name])) {
 946             trigger_error("No plugin for $name $vars defined.", E_USER_WARNING);
 947             return "";
 948         }
 949         $plugin = $PLUGIN_MARKUP_MAP[$name];
 950         return new Cached_PluginInvocation("<"."?plugin $plugin $vars $body ?".">");
 951     }
 952 }
 953
 954 /**
 955  *  Wikicreole preformatted
 956  *  {{{
 957  *  }}}
 958  */
 959 class Markup_wikicreole_preformatted extends SimpleMarkup
 960 {
 961     var $_match_regexp = '\{\{\{.*?\}\}\}';
 962
 963     function markup ($match) {
 964         // Remove {{{ and }}}
 965         return new HtmlElement('tt', substr($match, 3, -3));
 966     }
 967 }
 968
 969 /** ENABLE_MARKUP_TEMPLATE
 970  *  Template syntax similar to Mediawiki
 971  *  {{template}}
 972  * => < ? plugin Template page=template ? >
 973  *  {{template|var1=value1|var2=value|...}}
 974  * => < ? plugin Template page=template var=value ... ? >
 975  */
 976 class Markup_template_plugin  extends SimpleMarkup
 977 {
 978     // patch #1732793: allow \n, mult. {{ }} in one line, and single letters
 979     var $_match_regexp = '\{\{.*?\}\}';
 980
 981     function markup ($match) {
 982
 983         $page = substr($match,2,-2);
 984         if (strpos($page, "|") === false) {
 985             $imagename = $page;
 986             $alt = "";
 987         } else {
 988             $imagename = substr($page, 0, strpos($page, "|"));
 989             $alt = ltrim(strstr($page, "|"), "|");
 990         }
 991
 992         // It's not a Mediawiki template, it's a Wikicreole image
 993         if (is_image($imagename)) {
 994             if ($imagename[0] == '/') {
 995                 // We should not hardcode "/phpwiki"
 996                 return LinkImage(SERVER_URL . "/phpwiki" . $imagename, $alt);
 997             } else {
 998                 return LinkImage(getUploadDataPath() . $imagename, $alt);
 999             }
1000         }
1001
1002         $page = str_replace("\n", "", $page);
1003         $vars = '';
1004
1005         if (preg_match('/^(\S+?)\|(.*)$/', $page, $_m)) {
1006             $page = $_m[1];
1007             $vars = '"' . preg_replace('/\|/', '" "', $_m[2]) . '"';
1008             $vars = preg_replace('/"(\S+)=([^"]*)"/', '\\1="\\2"', $vars);
1009         }
1010
1011         // page may contain a version number
1012         // {{foo?version=5}}
1013         // in that case, output is "page=foo rev=5"
1014         if (strstr($page, "?")) {
1015             $page = str_replace("?version=", "\" rev=\"", $page);
1016         }
1017
1018         if ($vars)
1019             $s = '<'.'?plugin Template page="'.$page.'" '.$vars.' ?'.'>';
1020         else
1021             $s = '<'.'?plugin Template page="' . $page . '" ?'.'>';
1022         return new Cached_PluginInvocation($s);
1023     }
1024 }
1025
1026 // "..." => "&#133;"  browser specific display (not cached?)
1027 // Support some HTML::Entities: (C) for copy, --- for mdash, -- for ndash
1028 // TODO: "--" => "&emdash;" browser specific display (not cached?)
1029
1030 class Markup_html_entities  extends SimpleMarkup {
1031     //var $_match_regexp = '(: \.\.\.|\-\-|\-\-\-|\(C\) )';
1032
1033     function Markup_html_entities() {
1034         $this->_entities = array('...'  => '&#133;',
1035                                  '--'   => '&ndash;',
1036                                  '---'  => '&mdash;',
1037                                  '(C)'  => '&copy;',
1038                                  '&copy;' => '&copy;',
1039                                  '&trade;'  => '&trade;',
1040                                  );
1041         $this->_match_regexp =
1042             '(: ' .
1043             join('|', array_map('preg_quote', array_keys($this->_entities))) .
1044             ' )';
1045     }
1046
1047     function markup ($match) {
1048         return HTML::Raw($this->_entities[$match]);
1049     }
1050 }
1051
1052 class Markup_isonumchars  extends SimpleMarkup {
1053     var $_match_regexp = '\&\#\d{2,5};';
1054
1055     function markup ($match) {
1056         return HTML::Raw($match);
1057     }
1058 }
1059
1060 class Markup_isohexchars extends SimpleMarkup {
1061     // hexnums, like &#x00A4; <=> &curren;
1062     var $_match_regexp = '\&\#x[0-9a-fA-F]{2,4};';
1063
1064     function markup ($match) {
1065         return HTML::Raw($match);
1066     }
1067 }
1068
1069 // FIXME: Do away with magic phpwiki forms.  (Maybe phpwiki: links too?)
1070 // FIXME: Do away with plugin-links.  They seem not to be used.
1071 //Plugin link
1072
1073 class InlineTransformer
1074 {
1075     var $_regexps = array();
1076     var $_markup = array();
1077
1078     function InlineTransformer ($markup_types = false) {
1079         global $request;
1080         // We need to extend the inline parsers by certain actions, like SearchHighlight,
1081         // SpellCheck and maybe CreateToc.
1082         if (!$markup_types) {
1083             $non_default = false;
1084             $markup_types = array
1085                 ('escape', 'wikicreolebracketlink', 'bracketlink', 'url',
1086                  'html_comment', 'placeholder',
1087                  'interwiki',  'semanticlink', 'wikiword', 'linebreak',
1088                  'wikicreole_superscript',
1089                  'wikicreole_subscript',
1090                  'wikicreole_italics', 'wikicreole_bold',
1091                  'wikicreole_monospace',
1092                  'old_emphasis', 'nestled_emphasis',
1093                  'html_emphasis', 'html_abbr', 'plugin', 'plugin_wikicreole',
1094                  'isonumchars', 'isohexchars', /*'html_entities'*/
1095                  );
1096             if (DISABLE_MARKUP_WIKIWORD)
1097                 $markup_types = array_remove($markup_types, 'wikiword');
1098
1099             $action = $request->getArg('action');
1100             if ($action == 'SpellCheck' and $request->getArg('suggestions'))
1101             {   // insert it after url
1102                 array_splice($markup_types, 2, 1, array('url','spellcheck'));
1103             }
1104             if (isset($request->_searchhighlight))
1105             {   // insert it after url
1106                 array_splice($markup_types, 2, 1, array('url','searchhighlight'));
1107                 //$request->setArg('searchhighlight', false);
1108             }
1109         } else {
1110             $non_default = true;
1111         }
1112         foreach ($markup_types as $mtype) {
1113             $class = "Markup_$mtype";
1114             $this->_addMarkup(new $class);
1115         }
1116         if (ENABLE_MARKUP_DIVSPAN and !$non_default)
1117             $this->_addMarkup(new Markup_html_divspan);
1118         if (ENABLE_MARKUP_COLOR and !$non_default)
1119             $this->_addMarkup(new Markup_color);
1120         // Markup_wikicreole_preformatted must be before Markup_template_plugin
1121         $this->_addMarkup(new Markup_wikicreole_preformatted);
1122         if (ENABLE_MARKUP_TEMPLATE and !$non_default)
1123             $this->_addMarkup(new Markup_template_plugin);
1124         // This does not work yet
1125         if (0 and PLUGIN_MARKUP_MAP and !$non_default)
1126             $this->_addMarkup(new Markup_xml_plugin);
1127     }
1128
1129     function _addMarkup ($markup) {
1130         if (isa($markup, 'SimpleMarkup'))
1131             $regexp = $markup->getMatchRegexp();
1132         else
1133             $regexp = $markup->getStartRegexp();
1134
1135         assert( !isset($this->_markup[$regexp]) );
1136         assert( strlen(trim($regexp)) > 0 );
1137         $this->_regexps[] = $regexp;
1138         $this->_markup[] = $markup;
1139     }
1140
1141     function parse (&$text, $end_regexps = array('$')) {
1142         $regexps = $this->_regexps;
1143
1144         // $end_re takes precedence: "favor reduce over shift"
1145         array_unshift($regexps, $end_regexps[0]);
1146         //array_push($regexps, $end_regexps[0]);
1147         $regexps = new RegexpSet($regexps);
1148
1149         $input = $text;
1150         $output = new XmlContent;
1151
1152         $match = $regexps->match($input);
1153
1154         while ($match) {
1155             if ($match->regexp_ind == 0) {
1156                 // No start pattern found before end pattern.
1157                 // We're all done!
1158                 if (isset($markup) and is_object($markup)
1159                     and isa($markup,'Markup_plugin'))
1160                 {
1161                     $current =& $output->_content[count($output->_content)-1];
1162                     $current->setTightness(true,true);
1163                 }
1164                 $output->pushContent($match->prematch);
1165                 $text = $match->postmatch;
1166                 return $output;
1167             }
1168
1169             $markup = $this->_markup[$match->regexp_ind - 1];
1170             $body = $this->_parse_markup_body($markup, $match->match,
1171                                               $match->postmatch, $end_regexps);
1172             if (!$body) {
1173                 // Couldn't match balanced expression.
1174                 // Ignore and look for next matching start regexp.
1175                 $match = $regexps->nextMatch($input, $match);
1176                 continue;
1177             }
1178
1179             // Matched markup.  Eat input, push output.
1180             // FIXME: combine adjacent strings.
1181             if (isa($markup, 'SimpleMarkup'))
1182                 $current = $markup->markup($match->match);
1183             else
1184                 $current = $markup->markup($match->match, $body);
1185             $input = $match->postmatch;
1186             if (isset($markup) and is_object($markup)
1187                 and isa($markup,'Markup_plugin'))
1188             {
1189                 $current->setTightness(true,true);
1190             }
1191             $output->pushContent($match->prematch, $current);
1192
1193             $match = $regexps->match($input);
1194         }
1195
1196         // No pattern matched, not even the end pattern.
1197         // Parse fails.
1198         return false;
1199     }
1200
1201     function _parse_markup_body ($markup, $match, &$text, $end_regexps) {
1202         if (isa($markup, 'SimpleMarkup'))
1203             return true;        // Done. SimpleMarkup is simple.
1204
1205         if (!is_object($markup)) return false; // Some error: Should assert
1206         array_unshift($end_regexps, $markup->getEndRegexp($match));
1207
1208         // Optimization: if no end pattern in text, we know the
1209         // parse will fail.  This is an important optimization,
1210         // e.g. when text is "*lots *of *start *delims *with
1211         // *no *matching *end *delims".
1212         $ends_pat = "/(?:" . join(").*(?:", $end_regexps) . ")/xs";
1213         if (!preg_match($ends_pat, $text))
1214             return false;
1215         return $this->parse($text, $end_regexps);
1216     }
1217 }
1218
1219 class LinkTransformer extends InlineTransformer
1220 {
1221     function LinkTransformer () {
1222         $this->InlineTransformer(array('escape', 'wikicreolebracketlink', 'bracketlink', 'url',
1223                                        'semanticlink', 'interwiki', 'wikiword',
1224                                        ));
1225     }
1226 }
1227
1228 class NowikiTransformer extends InlineTransformer
1229 {
1230     function NowikiTransformer () {
1231         $this->InlineTransformer
1232             (array('linebreak',
1233                    'html_emphasis', 'html_abbr', 'plugin', 'plugin_wikicreole',
1234                    'isonumchars', 'isohexchars', /*'html_entities',*/
1235                    ));
1236     }
1237 }
1238
1239 function TransformInline($text, $markup = 2.0, $basepage=false) {
1240     static $trfm;
1241     $action = $GLOBALS['request']->getArg('action');
1242     if (empty($trfm) or $action == 'SpellCheck') {
1243         $trfm = new InlineTransformer;
1244     }
1245
1246     if ($markup < 2.0) {
1247         $text = ConvertOldMarkup($text, 'inline');
1248     }
1249
1250     if ($basepage) {
1251         return new CacheableMarkup($trfm->parse($text), $basepage);
1252     }
1253     return $trfm->parse($text);
1254 }
1255
1256 function TransformLinks($text, $markup = 2.0, $basepage = false) {
1257     static $trfm;
1258
1259     if (empty($trfm)) {
1260         $trfm = new LinkTransformer;
1261     }
1262
1263     if ($markup < 2.0) {
1264         $text = ConvertOldMarkup($text, 'links');
1265     }
1266
1267     if ($basepage) {
1268         return new CacheableMarkup($trfm->parse($text), $basepage);
1269     }
1270     return $trfm->parse($text);
1271 }
1272
1273 /**
1274  * Transform only html markup and entities.
1275  */
1276 function TransformInlineNowiki($text, $markup = 2.0, $basepage=false) {
1277     static $trfm;
1278
1279     if (empty($trfm)) {
1280         $trfm = new NowikiTransformer;
1281     }
1282     if ($basepage) {
1283         return new CacheableMarkup($trfm->parse($text), $basepage);
1284     }
1285     return $trfm->parse($text);
1286 }
1287
1288 // (c-file-style: "gnu")
1289 // Local Variables:
1290 // mode: php
1291 // tab-width: 8
1292 // c-basic-offset: 4
1293 // c-hanging-comment-ender-p: nil
1294 // indent-tabs-mode: nil
1295 // End:
1296 ?>