lib/InlineParser.php

   1 <?php rcs_id('$Id: InlineParser.php,v 1.30 2004-02-15 21:34:37 rurban Exp $');
   2 /* Copyright (C) 2002, Geoffrey T. Dairiki <dairiki@dairiki.org>
   3  *
   4  * This file is part of PhpWiki.
   5  *
   6  * PhpWiki is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * PhpWiki is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with PhpWiki; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20 /**
  21  * This is the code which deals with the inline part of the (new-style)
  22  * wiki-markup.
  23  *
  24  * @package Markup
  25  * @author Geoffrey T. Dairiki
  26  */
  27 /**
  28  */
  29
  30 /**
  31  * This is the character used in wiki markup to escape characters with
  32  * special meaning.
  33  */
  34 define('ESCAPE_CHAR', '~');
  35
  36 require_once('lib/HtmlElement.php');
  37 require_once('lib/CachedMarkup.php');
  38 require_once('lib/interwiki.php');
  39 require_once('lib/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     /**
  62      * The matched text.
  63      */
  64     var $match;
  65
  66     /**
  67      * The text following the matched text.
  68      */
  69     var $postmatch;
  70
  71     /**
  72      * Index of the regular expression which matched.
  73      */
  74     var $regexp_ind;
  75 }
  76
  77 /**
  78  * A set of regular expressions.
  79  *
  80  * This class is probably only useful for InlineTransformer.
  81  */
  82 class RegexpSet
  83 {
  84     /** Constructor
  85      *
  86      * @param array $regexps A list of regular expressions.  The
  87      * regular expressions should not include any sub-pattern groups
  88      * "(...)".  (Anonymous groups, like "(?:...)", as well as
  89      * look-ahead and look-behind assertions are okay.)
  90      */
  91     function RegexpSet ($regexps) {
  92         $this->_regexps = $regexps;
  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
 143     function _match ($text, $regexps, $repeat) {
 144         $pat= "/ ( . $repeat ) ( (" . join(')|(', $regexps) . ") ) /Axs";
 145
 146         if (! preg_match($pat, $text, $m)) {
 147             return false;
 148         }
 149
 150         $match = new RegexpSet_match;
 151         $match->postmatch = substr($text, strlen($m[0]));
 152         $match->prematch = $m[1];
 153         $match->match = $m[2];
 154         $match->regexp_ind = count($m) - 4;
 155
 156         /* DEBUGGING
 157         PrintXML(HTML::dl(HTML::dt("input"),
 158                           HTML::dd(HTML::pre($text)),
 159                           HTML::dt("match"),
 160                           HTML::dd(HTML::pre($match->match)),
 161                           HTML::dt("regexp"),
 162                           HTML::dd(HTML::pre($regexps[$match->regexp_ind])),
 163                           HTML::dt("prematch"),
 164                           HTML::dd(HTML::pre($match->prematch))));
 165         */
 166         return $match;
 167     }
 168 }
 169
 170
 171
 172 /**
 173  * A simple markup rule (i.e. terminal token).
 174  *
 175  * These are defined by a regexp.
 176  *
 177  * When a match is found for the regexp, the matching text is replaced.
 178  * The replacement content is obtained by calling the SimpleMarkup::markup method.
 179  */
 180 class SimpleMarkup
 181 {
 182     var $_match_regexp;
 183
 184     /** Get regexp.
 185      *
 186      * @return string Regexp which matches this token.
 187      */
 188     function getMatchRegexp () {
 189         return $this->_match_regexp;
 190     }
 191
 192     /** Markup matching text.
 193      *
 194      * @param string $match The text which matched the regexp
 195      * (obtained from getMatchRegexp).
 196      *
 197      * @return mixed The expansion of the matched text.
 198      */
 199     function markup ($match /*, $body */) {
 200         trigger_error("pure virtual", E_USER_ERROR);
 201     }
 202 }
 203
 204 /**
 205  * A balanced markup rule.
 206  *
 207  * These are defined by a start regexp, and and end regexp.
 208  */
 209 class BalancedMarkup
 210 {
 211     var $_start_regexp;
 212
 213     /** Get the starting regexp for this rule.
 214      *
 215      * @return string The starting regexp.
 216      */
 217     function getStartRegexp () {
 218         return $this->_start_regexp;
 219     }
 220
 221     /** Get the ending regexp for this rule.
 222      *
 223      * @param string $match The text which matched the starting regexp.
 224      *
 225      * @return string The ending regexp.
 226      */
 227     function getEndRegexp ($match) {
 228         return $this->_end_regexp;
 229     }
 230
 231     /** Get expansion for matching input.
 232      *
 233      * @param string $match The text which matched the starting regexp.
 234      *
 235      * @param mixed $body Transformed text found between the starting
 236      * and ending regexps.
 237      *
 238      * @return mixed The expansion of the matched text.
 239      */
 240     function markup ($match, $body) {
 241         trigger_error("pure virtual", E_USER_ERROR);
 242     }
 243 }
 244
 245 class Markup_escape  extends SimpleMarkup
 246 {
 247     function getMatchRegexp () {
 248         return ESCAPE_CHAR . '(?: [[:alnum:]]+ | .)';
 249     }
 250
 251     function markup ($match) {
 252         assert(strlen($match) >= 2);
 253         return substr($match, 1);
 254     }
 255 }
 256
 257 function LinkBracketLink($bracketlink) {
 258     global $request, $AllowedProtocols, $InlineImages;
 259
 260     include_once("lib/interwiki.php");
 261     $intermap = InterWikiMap::GetMap($request);
 262
 263     // $bracketlink will start and end with brackets; in between will
 264     // be either a page name, a URL or both separated by a pipe.
 265
 266     // strip brackets and leading space
 267     preg_match('/(\#?) \[\s* (?: (.*?) \s* (?<!' . ESCAPE_CHAR . ')(\|) )? \s* (.+?) \s*\]/x',
 268                $bracketlink, $matches);
 269     list (, $hash, $label, $bar, $rawlink) = $matches;
 270
 271     $label = UnWikiEscape($label);
 272     $link = UnWikiEscape($rawlink);
 273
 274     // if label looks like a url to an image, we want an image link.
 275     if (preg_match("/\\.($InlineImages)$/i", $label)) {
 276         $imgurl = $label;
 277         if (! preg_match("#^($AllowedProtocols):#", $imgurl)) {
 278             // linkname like 'images/next.gif'.
 279             global $Theme;
 280             $imgurl = $Theme->getImageURL($linkname);
 281         }
 282         $label = LinkImage($imgurl, $link);
 283     }
 284
 285     if ($hash) {
 286         // It's an anchor, not a link...
 287         $id = MangleXmlIdentifier($link);
 288         return HTML::a(array('name' => $id, 'id' => $id),
 289                        $bar ? $label : $link);
 290     }
 291
 292     if (preg_match("#^($AllowedProtocols):#", $link)) {
 293         // if it's an image, embed it; otherwise, it's a regular link
 294         if (preg_match("/\\.($InlineImages)$/i", $link))
 295             // no image link, just the src. see [img|link] above
 296             return LinkImage($link, $label);
 297         else
 298             return new Cached_ExternalLink($link, $label);
 299     }
 300     elseif (preg_match("/^phpwiki:/", $link))
 301         return new Cached_PhpwikiURL($link, $label);
 302     elseif (preg_match("/^" . $intermap->getRegexp() . ":/", $link))
 303         return new Cached_InterwikiLink($link, $label);
 304     else {
 305         // Split anchor off end of pagename.
 306         if (preg_match('/\A(.*)(?<!'.ESCAPE_CHAR.')#(.*?)\Z/', $rawlink, $m)) {
 307             list(,$rawlink,$anchor) = $m;
 308             $pagename = UnWikiEscape($rawlink);
 309             $anchor = UnWikiEscape($anchor);
 310             if (!$label)
 311                 $label = $link;
 312         }
 313         else {
 314             $pagename = $link;
 315             $anchor = false;
 316         }
 317         return new Cached_WikiLink($pagename, $label, $anchor);
 318     }
 319 }
 320
 321 class Markup_bracketlink  extends SimpleMarkup
 322 {
 323     var $_match_regexp = "\\#? \\[ .*? [^]\\s] .*? \\]";
 324
 325     function markup ($match) {
 326         $link = LinkBracketLink($match);
 327         assert($link->isInlineElement());
 328         return $link;
 329     }
 330 }
 331
 332 class Markup_url extends SimpleMarkup
 333 {
 334     function getMatchRegexp () {
 335         global $AllowedProtocols;
 336         return "(?<![[:alnum:]]) (?:$AllowedProtocols) : [^\s<>\"']+ (?<![ ,.?; \] \) ])";
 337     }
 338
 339     function markup ($match) {
 340         return new Cached_ExternalLink(UnWikiEscape($match));
 341     }
 342 }
 343
 344
 345 class Markup_interwiki extends SimpleMarkup
 346 {
 347     function getMatchRegexp () {
 348         global $request;
 349         $map = InterWikiMap::GetMap($request);
 350         return "(?<! [[:alnum:]])" . $map->getRegexp(). ": \S+ (?<![ ,.?;! \] \) \" \' ])";
 351     }
 352
 353     function markup ($match) {
 354         global $request;
 355         $map = InterWikiMap::GetMap($request);
 356         return new Cached_InterwikiLink(UnWikiEscape($match));
 357     }
 358 }
 359
 360 class Markup_wikiword extends SimpleMarkup
 361 {
 362     function getMatchRegexp () {
 363         global $WikiNameRegexp;
 364         return " $WikiNameRegexp";
 365     }
 366
 367     function markup ($match) {
 368         if ($this->_isWikiUserPage($match))
 369             return $this->_UserLink($match);
 370         else
 371             return new Cached_WikiLink($match);
 372     }
 373
 374     // FIXME: there's probably a more useful place to put these two functions
 375     function _isWikiUserPage ($page) {
 376         global $request;
 377         $dbi = $request->getDbh();
 378         $page_handle = $dbi->getPage($page);
 379         if ($page_handle->get('pref'))
 380             return true;
 381         else
 382             return false;
 383     }
 384
 385     function _UserLink($PageName) {
 386         $link = HTML::a(array('href' => $PageName));
 387         $link->pushContent(PossiblyGlueIconToText('wikiuser', $PageName));
 388         $link->setAttr('class', 'wikiuser');
 389         return $link;
 390     }
 391 }
 392
 393 class Markup_linebreak extends SimpleMarkup
 394 {
 395     var $_match_regexp = "(?: (?<! %) %%% (?! %) | <(?:br|BR)> )";
 396
 397     function markup ($match) {
 398         return HTML::br();
 399     }
 400 }
 401
 402 class Markup_old_emphasis  extends BalancedMarkup
 403 {
 404     var $_start_regexp = "''|__";
 405
 406     function getEndRegexp ($match) {
 407         return $match;
 408     }
 409
 410     function markup ($match, $body) {
 411         $tag = $match == "''" ? 'em' : 'strong';
 412         return new HtmlElement($tag, $body);
 413     }
 414 }
 415
 416 class Markup_nestled_emphasis extends BalancedMarkup
 417 {
 418     function getStartRegexp() {
 419         static $start_regexp = false;
 420
 421         if (!$start_regexp) {
 422             // The three possible delimiters
 423             // (none of which can be followed by itself.)
 424             $i = "_ (?! _)";
 425             $b = "\\* (?! \\*)";
 426             $tt = "= (?! =)";
 427
 428             $any = "(?: ${i}|${b}|${tt})"; // any of the three.
 429
 430             // Any of [_*=] is okay if preceded by space or one of [-"'/:]
 431             $start[] = "(?<= \\s|^|[-\"'\\/:]) ${any}";
 432
 433             // _ or * is okay after = as long as not immediately followed by =
 434             $start[] = "(?<= =) (?: ${i}|${b}) (?! =)";
 435             // etc...
 436             $start[] = "(?<= _) (?: ${b}|${tt}) (?! _)";
 437             $start[] = "(?<= \\*) (?: ${i}|${tt}) (?! \\*)";
 438
 439
 440             // any delimiter okay after an opening brace ( [{<(] )
 441             // as long as it's not immediately followed by the matching closing
 442             // brace.
 443             $start[] = "(?<= { ) ${any} (?! } )";
 444             $start[] = "(?<= < ) ${any} (?! > )";
 445             $start[] = "(?<= \\( ) ${any} (?! \\) )";
 446
 447             $start = "(?:" . join('|', $start) . ")";
 448
 449             // Any of the above must be immediately followed by non-whitespace.
 450             $start_regexp = $start . "(?= \S)";
 451         }
 452
 453         return $start_regexp;
 454     }
 455
 456     function getEndRegexp ($match) {
 457         $chr = preg_quote($match);
 458         return "(?<= \S | ^ ) (?<! $chr) $chr (?! $chr) (?= \s | [-)}>\"'\\/:.,;!? _*=] | $)";
 459     }
 460
 461     function markup ($match, $body) {
 462         switch ($match) {
 463         case '*': return new HtmlElement('b', $body);
 464         case '=': return new HtmlElement('tt', $body);
 465         case '_':  return new HtmlElement('i', $body);
 466         }
 467     }
 468 }
 469
 470 class Markup_html_emphasis extends BalancedMarkup
 471 {
 472     var $_start_regexp = "<(?: b|big|i|small|tt|
 473                                em|strong|
 474                                abbr|acronym|cite|code|dfn|kbd|samp|var|
 475                                sup|sub )>";
 476
 477     function getEndRegexp ($match) {
 478         return "<\\/" . substr($match, 1);
 479     }
 480
 481     function markup ($match, $body) {
 482         $tag = substr($match, 1, -1);
 483         return new HtmlElement($tag, $body);
 484     }
 485 }
 486
 487 // FIXME: Do away with magic phpwiki forms.  (Maybe phpwiki: links too?)
 488 // FIXME: Do away with plugin-links.  They seem not to be used.
 489 //Plugin link
 490
 491
 492 class InlineTransformer
 493 {
 494     var $_regexps = array();
 495     var $_markup = array();
 496
 497     function InlineTransformer ($markup_types = false) {
 498         if (!$markup_types)
 499             $markup_types = array('escape', 'bracketlink', 'url',
 500                                   'interwiki', 'wikiword', 'linebreak',
 501                                   'old_emphasis', 'nestled_emphasis',
 502                                   'html_emphasis');
 503
 504         foreach ($markup_types as $mtype) {
 505             $class = "Markup_$mtype";
 506             $this->_addMarkup(new $class);
 507         }
 508     }
 509
 510     function _addMarkup ($markup) {
 511         if (isa($markup, 'SimpleMarkup'))
 512             $regexp = $markup->getMatchRegexp();
 513         else
 514             $regexp = $markup->getStartRegexp();
 515
 516         assert(!isset($this->_markup[$regexp]));
 517         $this->_regexps[] = $regexp;
 518         $this->_markup[] = $markup;
 519     }
 520
 521     function parse (&$text, $end_regexps = array('$')) {
 522         $regexps = $this->_regexps;
 523
 524         // $end_re takes precedence: "favor reduce over shift"
 525         array_unshift($regexps, $end_regexps[0]);
 526         $regexps = new RegexpSet($regexps);
 527
 528         $input = $text;
 529         $output = new XmlContent;
 530
 531         $match = $regexps->match($input);
 532
 533         while ($match) {
 534             if ($match->regexp_ind == 0) {
 535                 // No start pattern found before end pattern.
 536                 // We're all done!
 537                 $output->pushContent($match->prematch);
 538                 $text = $match->postmatch;
 539                 return $output;
 540             }
 541
 542             $markup = $this->_markup[$match->regexp_ind - 1];
 543             $body = $this->_parse_markup_body($markup, $match->match, $match->postmatch, $end_regexps);
 544             if (!$body) {
 545                 // Couldn't match balanced expression.
 546                 // Ignore and look for next matching start regexp.
 547                 $match = $regexps->nextMatch($input, $match);
 548                 continue;
 549             }
 550
 551             // Matched markup.  Eat input, push output.
 552             // FIXME: combine adjacent strings.
 553             $input = $match->postmatch;
 554             $output->pushContent($match->prematch,
 555                                  $markup->markup($match->match, $body));
 556
 557             $match = $regexps->match($input);
 558         }
 559
 560         // No pattern matched, not even the end pattern.
 561         // Parse fails.
 562         return false;
 563     }
 564
 565     function _parse_markup_body ($markup, $match, &$text, $end_regexps) {
 566         if (isa($markup, 'SimpleMarkup'))
 567             return true;        // Done. SimpleMarkup is simple.
 568
 569         array_unshift($end_regexps, $markup->getEndRegexp($match));
 570         // Optimization: if no end pattern in text, we know the
 571         // parse will fail.  This is an important optimization,
 572         // e.g. when text is "*lots *of *start *delims *with
 573         // *no *matching *end *delims".
 574         $ends_pat = "/(?:" . join(").*(?:", $end_regexps) . ")/xs";
 575         if (!preg_match($ends_pat, $text))
 576             return false;
 577         return $this->parse($text, $end_regexps);
 578     }
 579 }
 580
 581 class LinkTransformer extends InlineTransformer
 582 {
 583     function LinkTransformer () {
 584         $this->InlineTransformer(array('escape', 'bracketlink', 'url',
 585                                        'interwiki', 'wikiword'));
 586     }
 587 }
 588
 589 function TransformInline($text, $markup = 2.0, $basepage=false) {
 590     static $trfm;
 591
 592     if (empty($trfm)) {
 593         $trfm = new InlineTransformer;
 594     }
 595
 596     if ($markup < 2.0) {
 597         $text = ConvertOldMarkup($text, 'inline');
 598     }
 599
 600     if ($basepage) {
 601         return new CacheableMarkup($trfm->parse($text), $basepage);
 602     }
 603     return $trfm->parse($text);
 604 }
 605
 606 function TransformLinks($text, $markup = 2.0, $basepage = false) {
 607     static $trfm;
 608
 609     if (empty($trfm)) {
 610         $trfm = new LinkTransformer;
 611     }
 612
 613     if ($markup < 2.0) {
 614         $text = ConvertOldMarkup($text, 'links');
 615     }
 616
 617     if ($basepage) {
 618         return new CacheableMarkup($trfm->parse($text), $basepage);
 619     }
 620     return $trfm->parse($text);
 621 }
 622
 623 // (c-file-style: "gnu")
 624 // Local Variables:
 625 // mode: php
 626 // tab-width: 8
 627 // c-basic-offset: 4
 628 // c-hanging-comment-ender-p: nil
 629 // indent-tabs-mode: nil
 630 // End:
 631 ?>