lib/BlockParser.php

   1 <?php rcs_id('$Id$');
   2 /* Copyright (C) 2002 Geoffrey T. Dairiki <dairiki@dairiki.org>
   3  * Copyright (C) 2004,2005 Reini Urban
   4  * Copyright (C) 2008-2009 Marc-Etienne Vargenau, Alcatel-Lucent
   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 require_once('lib/HtmlElement.php');
  23 require_once('lib/CachedMarkup.php');
  24 require_once('lib/InlineParser.php');
  25
  26 /**
  27  * Deal with paragraphs and proper, recursive block indents
  28  * for the new style markup (version 2)
  29  *
  30  * Everything which goes over more than line:
  31  * automatic lists, UL, OL, DL, table, blockquote, verbatim,
  32  * p, pre, plugin, ...
  33  *
  34  * FIXME:
  35  *  Still to do:
  36  *    (old-style) tables
  37  * FIXME: unify this with the RegexpSet in InlineParser.
  38  *
  39  * FIXME: This is very php5 sensitive: It was fixed for 1.3.9,
  40  *        but is again broken with the 1.3.11
  41  *        allow_call_time_pass_reference clean fixes
  42  *
  43  * @package Markup
  44  * @author: Geoffrey T. Dairiki
  45  */
  46
  47 /**
  48  * Return type from RegexpSet::match and RegexpSet::nextMatch.
  49  *
  50  * @see RegexpSet
  51  */
  52 class AnchoredRegexpSet_match {
  53     /**
  54      * The matched text.
  55      */
  56     var $match;
  57
  58     /**
  59      * The text following the matched text.
  60      */
  61     var $postmatch;
  62
  63     /**
  64      * Index of the regular expression which matched.
  65      */
  66     var $regexp_ind;
  67 }
  68
  69 /**
  70  * A set of regular expressions.
  71  *
  72  * This class is probably only useful for InlineTransformer.
  73  */
  74 class AnchoredRegexpSet
  75 {
  76     /** Constructor
  77      *
  78      * @param $regexps array A list of regular expressions.  The
  79      * regular expressions should not include any sub-pattern groups
  80      * "(...)".  (Anonymous groups, like "(?:...)", as well as
  81      * look-ahead and look-behind assertions are fine.)
  82      */
  83     function AnchoredRegexpSet ($regexps) {
  84         $this->_regexps = $regexps;
  85         $this->_re = "/((" . join(")|(", $regexps) . "))/Ax";
  86     }
  87
  88     /**
  89      * Search text for the next matching regexp from the Regexp Set.
  90      *
  91      * @param $text string The text to search.
  92      *
  93      * @return object  A RegexpSet_match object, or false if no match.
  94      */
  95     function match ($text) {
  96         if (!is_string($text)) return false;
  97         if (! preg_match($this->_re, $text, $m)) {
  98             return false;
  99         }
 100
 101         $match = new AnchoredRegexpSet_match;
 102         $match->postmatch = substr($text, strlen($m[0]));
 103         $match->match = $m[1];
 104         $match->regexp_ind = count($m) - 3;
 105         return $match;
 106     }
 107
 108     /**
 109      * Search for next matching regexp.
 110      *
 111      * Here, 'next' has two meanings:
 112      *
 113      * Match the next regexp(s) in the set, at the same position as the last match.
 114      *
 115      * If that fails, match the whole RegexpSet, starting after the position of the
 116      * previous match.
 117      *
 118      * @param $text string Text to search.
 119      *
 120      * @param $prevMatch A RegexpSet_match object
 121      *
 122      * $prevMatch should be a match object obtained by a previous
 123      * match upon the same value of $text.
 124      *
 125      * @return object  A RegexpSet_match object, or false if no match.
 126      */
 127     function nextMatch ($text, $prevMatch) {
 128         // Try to find match at same position.
 129         $regexps = array_slice($this->_regexps, $prevMatch->regexp_ind + 1);
 130         if (!$regexps) {
 131             return false;
 132         }
 133
 134         $pat= "/ ( (" . join(')|(', $regexps) . ") ) /Axs";
 135
 136         if (! preg_match($pat, $text, $m)) {
 137             return false;
 138         }
 139
 140         $match = new AnchoredRegexpSet_match;
 141         $match->postmatch = substr($text, strlen($m[0]));
 142         $match->match = $m[1];
 143         $match->regexp_ind = count($m) - 3 + $prevMatch->regexp_ind + 1;;
 144         return $match;
 145     }
 146 }
 147
 148
 149
 150 class BlockParser_Input {
 151
 152     function BlockParser_Input ($text) {
 153
 154         // Expand leading tabs.
 155         // FIXME: do this better.
 156         //
 157         // We want to ensure the only characters matching \s are ' ' and "\n".
 158         //
 159         $text = preg_replace('/(?![ \n])\s/', ' ', $text);
 160         assert(!preg_match('/(?![ \n])\s/', $text));
 161
 162         $this->_lines = preg_split('/[^\S\n]*\n/', $text);
 163         $this->_pos = 0;
 164
 165         // Strip leading blank lines.
 166         while ($this->_lines and ! $this->_lines[0])
 167             array_shift($this->_lines);
 168         $this->_atSpace = false;
 169     }
 170
 171     function skipSpace () {
 172         $nlines = count($this->_lines);
 173         while (1) {
 174             if ($this->_pos >= $nlines) {
 175                 $this->_atSpace = false;
 176                 break;
 177             }
 178             if ($this->_lines[$this->_pos] != '')
 179                 break;
 180             $this->_pos++;
 181             $this->_atSpace = true;
 182         }
 183         return $this->_atSpace;
 184     }
 185
 186     function currentLine () {
 187         if ($this->_pos >= count($this->_lines)) {
 188             return false;
 189         }
 190         return $this->_lines[$this->_pos];
 191     }
 192
 193     function nextLine () {
 194         $this->_atSpace = $this->_lines[$this->_pos++] === '';
 195         if ($this->_pos >= count($this->_lines)) {
 196             return false;
 197         }
 198         return $this->_lines[$this->_pos];
 199     }
 200
 201     function advance () {
 202         $this->_atSpace = ($this->_lines[$this->_pos] === '');
 203         $this->_pos++;
 204     }
 205
 206     function getPos () {
 207         return array($this->_pos, $this->_atSpace);
 208     }
 209
 210     function setPos ($pos) {
 211         list($this->_pos, $this->_atSpace) = $pos;
 212     }
 213
 214     function getPrefix () {
 215         return '';
 216     }
 217
 218     function getDepth () {
 219         return 0;
 220     }
 221
 222     function where () {
 223         if ($this->_pos < count($this->_lines))
 224             return $this->_lines[$this->_pos];
 225         else
 226             return "<EOF>";
 227     }
 228
 229     function _debug ($tab, $msg) {
 230         //return ;
 231         $where = $this->where();
 232         $tab = str_repeat('____', $this->getDepth() ) . $tab;
 233         printXML(HTML::div("$tab $msg: at: '",
 234                            HTML::tt($where),
 235                            "'"));
 236         flush();
 237     }
 238 }
 239
 240 class BlockParser_InputSubBlock extends BlockParser_Input
 241 {
 242     function BlockParser_InputSubBlock (&$input, $prefix_re, $initial_prefix = false) {
 243         $this->_input = &$input;
 244         $this->_prefix_pat = "/$prefix_re|\\s*\$/Ax";
 245         $this->_atSpace = false;
 246
 247         if (($line = $input->currentLine()) === false)
 248             $this->_line = false;
 249         elseif ($initial_prefix) {
 250             assert(substr($line, 0, strlen($initial_prefix)) == $initial_prefix);
 251             $this->_line = (string) substr($line, strlen($initial_prefix));
 252             $this->_atBlank = ! ltrim($line);
 253         }
 254         elseif (preg_match($this->_prefix_pat, $line, $m)) {
 255             $this->_line = (string) substr($line, strlen($m[0]));
 256             $this->_atBlank = ! ltrim($line);
 257         }
 258         else
 259             $this->_line = false;
 260     }
 261
 262     function skipSpace () {
 263         // In contrast to the case for top-level blocks,
 264         // for sub-blocks, there never appears to be any trailing space.
 265         // (The last block in the sub-block should always be of class tight-bottom.)
 266         while ($this->_line === '')
 267             $this->advance();
 268
 269         if ($this->_line === false)
 270             return $this->_atSpace == 'strong_space';
 271         else
 272             return $this->_atSpace;
 273     }
 274
 275     function currentLine () {
 276         return $this->_line;
 277     }
 278
 279     function nextLine () {
 280         if ($this->_line === '')
 281             $this->_atSpace = $this->_atBlank ? 'weak_space' : 'strong_space';
 282         else
 283             $this->_atSpace = false;
 284
 285         $line = $this->_input->nextLine();
 286         if ($line !== false && preg_match($this->_prefix_pat, $line, $m)) {
 287             $this->_line = (string) substr($line, strlen($m[0]));
 288             $this->_atBlank = ! ltrim($line);
 289         }
 290         else
 291             $this->_line = false;
 292
 293         return $this->_line;
 294     }
 295
 296     function advance () {
 297         $this->nextLine();
 298     }
 299
 300     function getPos () {
 301         return array($this->_line, $this->_atSpace, $this->_input->getPos());
 302     }
 303
 304     function setPos ($pos) {
 305         $this->_line = $pos[0];
 306         $this->_atSpace = $pos[1];
 307         $this->_input->setPos($pos[2]);
 308     }
 309
 310     function getPrefix () {
 311         assert ($this->_line !== false);
 312         $line = $this->_input->currentLine();
 313         assert ($line !== false && strlen($line) >= strlen($this->_line));
 314         return substr($line, 0, strlen($line) - strlen($this->_line));
 315     }
 316
 317     function getDepth () {
 318         return $this->_input->getDepth() + 1;
 319     }
 320
 321     function where () {
 322         return $this->_input->where();
 323     }
 324 }
 325
 326
 327 class Block_HtmlElement extends HtmlElement
 328 {
 329     function Block_HtmlElement($tag /*, ... */) {
 330         $this->_init(func_get_args());
 331     }
 332
 333     function setTightness($top, $bottom) {
 334     }
 335 }
 336
 337 class ParsedBlock extends Block_HtmlElement {
 338
 339     function ParsedBlock (&$input, $tag = 'div', $attr = false) {
 340         $this->Block_HtmlElement($tag, $attr);
 341         $this->_initBlockTypes();
 342         $this->_parse($input);
 343     }
 344
 345     function _parse (&$input) {
 346         // php5 failed to advance the block. php5 copies objects by ref.
 347         // nextBlock == block, both are the same objects. So we have to clone it.
 348         for ($block = $this->_getBlock($input);
 349              $block;
 350              $block = (is_object($nextBlock) ? clone($nextBlock) : $nextBlock))
 351         {
 352             while ($nextBlock = $this->_getBlock($input)) {
 353                 // Attempt to merge current with following block.
 354                 if (! ($merged = $block->merge($nextBlock)) ) {
 355                     break;      // can't merge
 356                 }
 357                 $block = $merged;
 358             }
 359             $this->pushContent($block->finish());
 360         }
 361     }
 362
 363     // FIXME: hackish. This should only be called once.
 364     function _initBlockTypes () {
 365         // better static or global?
 366         static $_regexpset, $_block_types;
 367
 368         if (!is_object($_regexpset)) {
 369             // nowiki_wikicreole must be before template_plugin
 370             $Block_types = array
 371                     ('nowiki_wikicreole', 'template_plugin', 'placeholder', 'oldlists', 'list', 'dl',
 372                      'table_dl', 'table_wikicreole', 'table_mediawiki',
 373                      'blockquote', 'heading', 'heading_wikicreole', 'hr', 'pre', 'email_blockquote',
 374                      'plugin', 'plugin_wikicreole', 'p');
 375             // insert it before p!
 376             if (ENABLE_MARKUP_DIVSPAN) {
 377                 array_pop($Block_types);
 378                 $Block_types[] = 'divspan';
 379                 $Block_types[] = 'p';
 380             }
 381             foreach ($Block_types as $type) {
 382                 $class = "Block_$type";
 383                 $proto = new $class;
 384                 $this->_block_types[] = $proto;
 385                 $this->_regexps[] = $proto->_re;
 386             }
 387             $this->_regexpset = new AnchoredRegexpSet($this->_regexps);
 388             $_regexpset = $this->_regexpset;
 389             $_block_types = $this->_block_types;
 390             unset($Block_types);
 391         } else {
 392              $this->_regexpset = $_regexpset;
 393              $this->_block_types = $_block_types;
 394         }
 395     }
 396
 397     function _getBlock (&$input) {
 398         $this->_atSpace = $input->skipSpace();
 399
 400         $line = $input->currentLine();
 401         if ($line === false or $line === '') { // allow $line === '0'
 402             return false;
 403         }
 404         $tight_top = !$this->_atSpace;
 405         $re_set = &$this->_regexpset;
 406         //FIXME: php5 fails to advance here!
 407         for ($m = $re_set->match($line); $m; $m = $re_set->nextMatch($line, $m)) {
 408             $block = clone($this->_block_types[$m->regexp_ind]);
 409             if (DEBUG & _DEBUG_PARSER)
 410                 $input->_debug('>', get_class($block));
 411
 412             if ($block->_match($input, $m)) {
 413                 //$block->_text = $line;
 414                 if (DEBUG & _DEBUG_PARSER)
 415                     $input->_debug('<', get_class($block));
 416                 $tight_bottom = ! $input->skipSpace();
 417                 $block->_setTightness($tight_top, $tight_bottom);
 418                 return $block;
 419             }
 420             if (DEBUG & _DEBUG_PARSER)
 421                 $input->_debug('[', "_match failed");
 422         }
 423         if ($line === false or $line === '') // allow $line === '0'
 424             return false;
 425
 426         trigger_error("Couldn't match block: '$line'", E_USER_NOTICE);
 427         return false;
 428     }
 429 }
 430
 431 class WikiText extends ParsedBlock {
 432     function WikiText ($text) {
 433         $input = new BlockParser_Input($text);
 434         $this->ParsedBlock($input);
 435     }
 436 }
 437
 438 class SubBlock extends ParsedBlock {
 439     function SubBlock (&$input, $indent_re, $initial_indent = false,
 440                        $tag = 'div', $attr = false) {
 441         $subinput = new BlockParser_InputSubBlock($input, $indent_re, $initial_indent);
 442         $this->ParsedBlock($subinput, $tag, $attr);
 443     }
 444 }
 445
 446 /**
 447  * TightSubBlock is for use in parsing lists item bodies.
 448  *
 449  * If the sub-block consists of a single paragraph, it omits
 450  * the paragraph element.
 451  *
 452  * We go to this trouble so that "tight" lists look somewhat reasonable
 453  * in older (non-CSS) browsers.  (If you don't do this, then, without
 454  * CSS, you only get "loose" lists.
 455  */
 456 class TightSubBlock extends SubBlock {
 457     function TightSubBlock (&$input, $indent_re, $initial_indent = false,
 458                             $tag = 'div', $attr = false) {
 459         $this->SubBlock($input, $indent_re, $initial_indent, $tag, $attr);
 460
 461         // If content is a single paragraph, eliminate the paragraph...
 462         if (count($this->_content) == 1) {
 463             $elem = $this->_content[0];
 464             if (isa($elem, 'XmlElement') and $elem->getTag() == 'p') {
 465                 $this->setContent($elem->getContent());
 466             }
 467         }
 468     }
 469 }
 470
 471 class BlockMarkup {
 472     var $_re;
 473
 474     function _match (&$input, $match) {
 475         trigger_error('pure virtual', E_USER_ERROR);
 476     }
 477
 478     function _setTightness ($top, $bot) {
 479         // $this->_element->setTightness($top, $bot);
 480     }
 481
 482     function merge ($followingBlock) {
 483         return false;
 484     }
 485
 486     function finish () {
 487         return $this->_element;
 488     }
 489 }
 490
 491 class Block_blockquote extends BlockMarkup
 492 {
 493     var $_depth;
 494     var $_re = '\ +(?=\S)';
 495
 496     function _match (&$input, $m) {
 497         $this->_depth = strlen($m->match);
 498         $indent = sprintf("\\ {%d}", $this->_depth);
 499         $this->_element = new SubBlock($input, $indent, $m->match,
 500                                        'blockquote');
 501         return true;
 502     }
 503
 504     function merge ($nextBlock) {
 505         if (get_class($nextBlock) == get_class($this)) {
 506             assert ($nextBlock->_depth < $this->_depth);
 507             $nextBlock->_element->unshiftContent($this->_element);
 508             if (!empty($this->_tight_top))
 509             $nextBlock->_tight_top = $this->_tight_top;
 510             return $nextBlock;
 511         }
 512         return false;
 513     }
 514 }
 515
 516 class Block_list extends BlockMarkup
 517 {
 518     //var $_tag = 'ol' or 'ul';
 519     var $_re = '\ {0,4}
 520                 (?: \+
 521                   | \\#\ (?!\[.*\])
 522                   | -(?!-)
 523                   | [o](?=\ )
 524                   | [*]\ (?!(?=\S)[^*]*(?<=\S)[*](?:\\s|[-)}>"\'\\/:.,;!?_*=]) )
 525                 )\ *(?=\S)';
 526     var $_content = array();
 527
 528     function _match (&$input, $m) {
 529         // A list as the first content in a list is not allowed.
 530         // E.g.:
 531         //   *  * Item
 532         // Should markup as <ul><li>* Item</li></ul>,
 533         // not <ul><li><ul><li>Item</li></ul>/li></ul>.
 534         //
 535         if (preg_match('/[*#+-o]/', $input->getPrefix())) {
 536             return false;
 537         }
 538
 539         $prefix = $m->match;
 540         $indent = sprintf("\\ {%d}", strlen($prefix));
 541
 542         $bullet = trim($m->match);
 543         $this->_tag = $bullet == '#' ? 'ol' : 'ul';
 544         $this->_content[] = new TightSubBlock($input, $indent, $m->match, 'li');
 545         return true;
 546     }
 547
 548     function _setTightness($top, $bot) {
 549         $li = &$this->_content[0];
 550         $li->setTightness($top, $bot);
 551     }
 552
 553     function merge ($nextBlock) {
 554         if (isa($nextBlock, 'Block_list') and $this->_tag == $nextBlock->_tag) {
 555             if ($nextBlock->_content === $this->_content) {
 556                 trigger_error("Internal Error: no block advance", E_USER_NOTICE);
 557                 return false;
 558             }
 559             array_splice($this->_content, count($this->_content), 0,
 560                          $nextBlock->_content);
 561             return $this;
 562         }
 563         return false;
 564     }
 565
 566     function finish () {
 567         return new Block_HtmlElement($this->_tag, false, $this->_content);
 568     }
 569 }
 570
 571 class Block_dl extends Block_list
 572 {
 573     var $_tag = 'dl';
 574
 575     function Block_dl () {
 576         $this->_re = '\ {0,4}\S.*(?<!'.ESCAPE_CHAR.'):\s*$';
 577     }
 578
 579     function _match (&$input, $m) {
 580         if (!($p = $this->_do_match($input, $m)))
 581             return false;
 582         list ($term, $defn, $loose) = $p;
 583
 584         $this->_content[] = new Block_HtmlElement('dt', false, $term);
 585         $this->_content[] = $defn;
 586         $this->_tight_defn = !$loose;
 587         return true;
 588     }
 589
 590     function _setTightness($top, $bot) {
 591         $dt = &$this->_content[0];
 592         $dd = &$this->_content[1];
 593
 594         $dt->setTightness($top, $this->_tight_defn);
 595         $dd->setTightness($this->_tight_defn, $bot);
 596     }
 597
 598     function _do_match (&$input, $m) {
 599         $pos = $input->getPos();
 600
 601         $firstIndent = strspn($m->match, ' ');
 602         $pat = sprintf('/\ {%d,%d}(?=\s*\S)/A', $firstIndent + 1, $firstIndent + 5);
 603
 604         $input->advance();
 605         $loose = $input->skipSpace();
 606         $line = $input->currentLine();
 607
 608         if (!$line || !preg_match($pat, $line, $mm)) {
 609             $input->setPos($pos);
 610             return false;       // No body found.
 611         }
 612
 613         $indent = strlen($mm[0]);
 614         $term = TransformInline(rtrim(substr(trim($m->match),0,-1)));
 615         $defn = new TightSubBlock($input, sprintf("\\ {%d}", $indent), false, 'dd');
 616         return array($term, $defn, $loose);
 617     }
 618 }
 619
 620
 621
 622 class Block_table_dl_defn extends XmlContent
 623 {
 624     var $nrows;
 625     var $ncols;
 626
 627     function Block_table_dl_defn ($term, $defn) {
 628         $this->XmlContent();
 629         if (!is_array($defn))
 630             $defn = $defn->getContent();
 631
 632         $this->_next_tight_top = false; // value irrelevant - gets fixed later
 633         $this->_ncols = $this->_ComputeNcols($defn);
 634         $this->_nrows = 0;
 635
 636         foreach ($defn as $item) {
 637             if ($this->_IsASubtable($item))
 638                 $this->_addSubtable($item);
 639             else
 640                 $this->_addToRow($item);
 641         }
 642         $this->_flushRow();
 643
 644         $th = HTML::th($term);
 645         if ($this->_nrows > 1)
 646             $th->setAttr('rowspan', $this->_nrows);
 647         $this->_setTerm($th);
 648     }
 649
 650     function setTightness($tight_top, $tight_bot) {
 651         $this->_tight_top = $tight_top;
 652         $this->_tight_bot = $tight_bot;
 653         $first = &$this->firstTR();
 654         $last  = &$this->lastTR();
 655         $first->setInClass('top', $tight_top);
 656         if (!empty($last)) {
 657             $last->setInClass('bottom', $tight_bot);
 658         } else {
 659             trigger_error(sprintf("no lastTR: %s",AsXML($this->_content[0])), E_USER_WARNING);
 660         }
 661     }
 662
 663     function _addToRow ($item) {
 664         if (empty($this->_accum)) {
 665             $this->_accum = HTML::td();
 666             if ($this->_ncols > 2)
 667                 $this->_accum->setAttr('colspan', $this->_ncols - 1);
 668         }
 669         $this->_accum->pushContent($item);
 670     }
 671
 672     function _flushRow ($tight_bottom=false) {
 673         if (!empty($this->_accum)) {
 674             $row = new Block_HtmlElement('tr', false, $this->_accum);
 675
 676             $row->setTightness($this->_next_tight_top, $tight_bottom);
 677             $this->_next_tight_top = $tight_bottom;
 678
 679             $this->pushContent($row);
 680             $this->_accum = false;
 681             $this->_nrows++;
 682         }
 683     }
 684
 685     function _addSubtable ($table) {
 686         if (!($table_rows = $table->getContent()))
 687             return;
 688
 689         $this->_flushRow($table_rows[0]->_tight_top);
 690
 691         foreach ($table_rows as $subdef) {
 692             $this->pushContent($subdef);
 693             $this->_nrows += $subdef->nrows();
 694             $this->_next_tight_top = $subdef->_tight_bot;
 695         }
 696     }
 697
 698     function _setTerm ($th) {
 699         $first_row = &$this->_content[0];
 700         if (isa($first_row, 'Block_table_dl_defn'))
 701             $first_row->_setTerm($th);
 702         else
 703             $first_row->unshiftContent($th);
 704     }
 705
 706     function _ComputeNcols ($defn) {
 707         $ncols = 2;
 708         foreach ($defn as $item) {
 709             if ($this->_IsASubtable($item)) {
 710                 $row = $this->_FirstDefn($item);
 711                 $ncols = max($ncols, $row->ncols() + 1);
 712             }
 713         }
 714         return $ncols;
 715     }
 716
 717     function _IsASubtable ($item) {
 718         return isa($item, 'HtmlElement')
 719             && $item->getTag() == 'table'
 720             && $item->getAttr('class') == 'wiki-dl-table';
 721     }
 722
 723     function _FirstDefn ($subtable) {
 724         $defs = $subtable->getContent();
 725         return $defs[0];
 726     }
 727
 728     function ncols () {
 729         return $this->_ncols;
 730     }
 731
 732     function nrows () {
 733         return $this->_nrows;
 734     }
 735
 736     function & firstTR() {
 737         $first = &$this->_content[0];
 738         if (isa($first, 'Block_table_dl_defn'))
 739             return $first->firstTR();
 740         return $first;
 741     }
 742
 743     function & lastTR() {
 744         $last = &$this->_content[$this->_nrows - 1];
 745         if (isa($last, 'Block_table_dl_defn'))
 746             return $last->lastTR();
 747         return $last;
 748     }
 749
 750     function setWidth ($ncols) {
 751         assert($ncols >= $this->_ncols);
 752         if ($ncols <= $this->_ncols)
 753             return;
 754         $rows = &$this->_content;
 755         for ($i = 0; $i < count($rows); $i++) {
 756             $row = &$rows[$i];
 757             if (isa($row, 'Block_table_dl_defn'))
 758                 $row->setWidth($ncols - 1);
 759             else {
 760                 $n = count($row->_content);
 761                 $lastcol = &$row->_content[$n - 1];
 762                 if (!empty($lastcol))
 763                   $lastcol->setAttr('colspan', $ncols - 1);
 764             }
 765         }
 766     }
 767 }
 768
 769 class Block_table_dl extends Block_dl
 770 {
 771     var $_tag = 'dl-table';     // phony.
 772
 773     function Block_table_dl() {
 774         $this->_re = '\ {0,4} (?:\S.*)? (?<!'.ESCAPE_CHAR.') \| \s* $';
 775     }
 776
 777     function _match (&$input, $m) {
 778         if (!($p = $this->_do_match($input, $m)))
 779             return false;
 780         list ($term, $defn, $loose) = $p;
 781
 782         $this->_content[] = new Block_table_dl_defn($term, $defn);
 783         return true;
 784     }
 785
 786     function _setTightness($top, $bot) {
 787         $this->_content[0]->setTightness($top, $bot);
 788     }
 789
 790     function finish () {
 791
 792         $defs = &$this->_content;
 793
 794         $ncols = 0;
 795         foreach ($defs as $defn)
 796             $ncols = max($ncols, $defn->ncols());
 797
 798         foreach ($defs as $key => $defn)
 799             $defs[$key]->setWidth($ncols);
 800
 801         return HTML::table(array('class' => 'wiki-dl-table',
 802                                  'border' => 1,
 803                                  'cellspacing' => 0,
 804                                  'cellpadding' => 6),
 805                            $defs);
 806     }
 807 }
 808
 809 class Block_oldlists extends Block_list
 810 {
 811     //var $_tag = 'ol', 'ul', or 'dl';
 812     var $_re = '(?: [*]\ (?!(?=\S)[^*]*(?<=\S)[*](?:\\s|[-)}>"\'\\/:.,;!?_*=]))
 813                   | [#]\ (?! \[ .*? \] )
 814                   | ; .*? :
 815                 ) .*? (?=\S)';
 816
 817     function _match (&$input, $m) {
 818         // FIXME:
 819         if (!preg_match('/[*#;]*$/A', $input->getPrefix())) {
 820             return false;
 821         }
 822
 823
 824         $prefix = $m->match;
 825         $oldindent = '[*#;](?=[#*]|;.*:.*\S)';
 826         $newindent = sprintf('\\ {%d}', strlen($prefix));
 827         $indent = "(?:$oldindent|$newindent)";
 828
 829         $bullet = $prefix[0];
 830         if ($bullet == '*') {
 831             $this->_tag = 'ul';
 832             $itemtag = 'li';
 833         }
 834         elseif ($bullet == '#') {
 835             $this->_tag = 'ol';
 836             $itemtag = 'li';
 837         }
 838         else {
 839             $this->_tag = 'dl';
 840             list ($term,) = explode(':', substr($prefix, 1), 2);
 841             $term = trim($term);
 842             if ($term)
 843                 $this->_content[] = new Block_HtmlElement('dt', false,
 844                                                           TransformInline($term));
 845             $itemtag = 'dd';
 846         }
 847
 848         $this->_content[] = new TightSubBlock($input, $indent, $m->match, $itemtag);
 849         return true;
 850     }
 851
 852     function _setTightness($top, $bot) {
 853         if (count($this->_content) == 1) {
 854             $li = &$this->_content[0];
 855             $li->setTightness($top, $bot);
 856         }
 857         else {
 858             // This is where php5 usually brakes.
 859             // wrong duplicated <li> contents
 860             if (DEBUG and DEBUG & _DEBUG_PARSER and check_php_version(5)) {
 861                 if (count($this->_content) != 2) {
 862                     echo "<pre>";
 863                     /*
 864                     $class = new Reflection_Class('XmlElement');
 865                     // Print out basic information
 866                     printf(
 867                            "===> The %s%s%s %s '%s' [extends %s]\n".
 868                            "     declared in %s\n".
 869                            "     lines %d to %d\n".
 870                            "     having the modifiers %d [%s]\n",
 871                            $class->isInternal() ? 'internal' : 'user-defined',
 872                            $class->isAbstract() ? ' abstract' : '',
 873                            $class->isFinal() ? ' final' : '',
 874                            $class->isInterface() ? 'interface' : 'class',
 875                            $class->getName(),
 876                            var_export($class->getParentClass(), 1),
 877                            $class->getFileName(),
 878                            $class->getStartLine(),
 879                            $class->getEndline(),
 880                            $class->getModifiers(),
 881                            implode(' ', Reflection::getModifierNames($class->getModifiers()))
 882                            );
 883                     // Print class properties
 884                     printf("---> Properties: %s\n", var_export($class->getProperties(), 1));
 885                     */
 886                     echo 'count($this->_content): ', count($this->_content),"\n";
 887                     echo "\$this->_content[0]: "; var_dump ($this->_content[0]);
 888
 889                     for ($i=1; $i < min(5, count($this->_content)); $i++) {
 890                         $c =& $this->_content[$i];
 891                         echo '$this->_content[',$i,"]: \n";
 892                         echo "_tag: "; var_dump ($c->_tag);
 893                         echo "_content: "; var_dump ($c->_content);
 894                         echo "_properties: "; var_dump ($c->_properties);
 895                     }
 896                     debug_print_backtrace();
 897                     if (DEBUG & _DEBUG_APD) {
 898                         if (function_exists("xdebug_get_function_stack")) {
 899                             var_dump (xdebug_get_function_stack());
 900                         }
 901                     }
 902                     echo "</pre>";
 903                 }
 904             }
 905             if (!check_php_version(5))
 906                 assert(count($this->_content) == 2);
 907             $dt = &$this->_content[0];
 908             $dd = &$this->_content[1];
 909             $dt->setTightness($top, false);
 910             $dd->setTightness(false, $bot);
 911         }
 912     }
 913 }
 914
 915 class Block_pre extends BlockMarkup
 916 {
 917     var $_re = '<(?:pre|verbatim|nowiki|noinclude)>';
 918
 919     function _match (&$input, $m) {
 920         $endtag = '</' . substr($m->match, 1);
 921         $text = array();
 922         $pos = $input->getPos();
 923
 924         $line = $m->postmatch;
 925         while (ltrim($line) != $endtag) {
 926             $text[] = $line;
 927             if (($line = $input->nextLine()) === false) {
 928                 $input->setPos($pos);
 929                 return false;
 930             }
 931         }
 932         $input->advance();
 933
 934         if ($m->match == '<nowiki>')
 935             $text = join("<br>\n", $text);
 936         else
 937             $text = join("\n", $text);
 938
 939         // FIXME: no <img>, <big>, <small>, <sup>, or <sub>'s allowed
 940         // in a <pre>.
 941         if ($m->match == '<pre>') {
 942             $text = TransformInline($text);
 943         }
 944         if ($m->match == '<noinclude>') {
 945             $text = TransformText($text);
 946             $this->_element = new Block_HtmlElement('div', false, $text);
 947         } else if ($m->match == '<nowiki>') {
 948             $text = TransformInlineNowiki($text);
 949             $this->_element = new Block_HtmlElement('p', false, $text);
 950         } else {
 951             $this->_element = new Block_HtmlElement('pre', false, $text);
 952         }
 953         return true;
 954     }
 955 }
 956
 957 // Wikicreole placeholder
 958 // <<<placeholder>>>
 959 class Block_placeholder extends BlockMarkup
 960 {
 961     var $_re = '<<<';
 962
 963     function _match (&$input, $m) {
 964         $endtag = '>>>';
 965         $text = array();
 966         $pos = $input->getPos();
 967
 968         $line = $m->postmatch;
 969         while (ltrim($line) != $endtag) {
 970             $text[] = $line;
 971             if (($line = $input->nextLine()) === false) {
 972                 $input->setPos($pos);
 973                 return false;
 974             }
 975         }
 976         $input->advance();
 977
 978         $text = join("\n", $text);
 979         $text = '<<<' . $text . '>>>';
 980         $this->_element = new Block_HtmlElement('div', false, $text);
 981         return true;
 982     }
 983 }
 984
 985 class Block_nowiki_wikicreole extends BlockMarkup
 986 {
 987     var $_re = '{{{';
 988
 989     function _match (&$input, $m) {
 990         $endtag = '}}}';
 991         $text = array();
 992         $pos = $input->getPos();
 993
 994         $line = $m->postmatch;
 995         while (ltrim($line) != $endtag) {
 996             $text[] = $line;
 997             if (($line = $input->nextLine()) === false) {
 998                 $input->setPos($pos);
 999                 return false;
1000             }
1001         }
1002         $input->advance();
1003
1004         $text = join("\n", $text);
1005         $this->_element = new Block_HtmlElement('pre', false, $text);
1006         return true;
1007     }
1008 }
1009
1010 class Block_plugin extends Block_pre
1011 {
1012     var $_re = '<\?plugin(?:-form)?(?!\S)';
1013
1014     // FIXME:
1015     /* <?plugin Backlinks
1016      *       page=ThisPage ?>
1017     /* <?plugin ListPages pages=<!plugin-list Backlinks!>
1018      *                    exclude=<!plugin-list TitleSearch s=T*!> ?>
1019      *
1020      * should all work.
1021      */
1022     function _match (&$input, $m) {
1023         $pos = $input->getPos();
1024         $pi = $m->match . $m->postmatch;
1025         while (!preg_match('/(?<!'.ESCAPE_CHAR.')\?>\s*$/', $pi)) {
1026             if (($line = $input->nextLine()) === false) {
1027                 $input->setPos($pos);
1028                 return false;
1029             }
1030             $pi .= "\n$line";
1031         }
1032         $input->advance();
1033
1034         $this->_element = new Cached_PluginInvocation($pi);
1035         return true;
1036     }
1037 }
1038
1039 class Block_plugin_wikicreole extends Block_pre
1040 {
1041     // var $_re = '<<(?!\S)';
1042     var $_re = '<<';
1043
1044     function _match (&$input, $m) {
1045         $pos = $input->getPos();
1046         $pi = $m->postmatch;
1047         if ($pi[0] == '<') {
1048             return false;
1049         }
1050         $pi = "<?plugin " . $pi;
1051         while (!preg_match('/(?<!'.ESCAPE_CHAR.')>>\s*$/', $pi)) {
1052             if (($line = $input->nextLine()) === false) {
1053                 $input->setPos($pos);
1054                 return false;
1055             }
1056             $pi .= "\n$line";
1057         }
1058         $input->advance();
1059
1060         $pi = str_replace(">>", "?>", $pi);
1061
1062         $this->_element = new Cached_PluginInvocation($pi);
1063         return true;
1064     }
1065 }
1066
1067 class Block_table_wikicreole extends Block_pre
1068 {
1069     var $_re = '\s*\|';
1070
1071     function _match (&$input, $m) {
1072         $pos = $input->getPos();
1073         $pi = "|" . $m->postmatch;
1074
1075         $intable = true;
1076         while ($intable) {
1077             if ((($line = $input->nextLine()) === false) && !$intable) {
1078                 $input->setPos($pos);
1079                 return false;
1080             }
1081             if (!$line) {
1082                 $intable = false;
1083                 $trimline = $line;
1084             } else {
1085                 $trimline = trim($line);
1086                 if ($trimline[0] != "|") {
1087                     $intable = false;
1088                 }
1089             }
1090             $pi .= "\n$trimline";
1091         }
1092
1093         $pi = '<'.'?plugin WikicreoleTable ' . $pi . '?'.'>';
1094
1095         $this->_element = new Cached_PluginInvocation($pi);
1096         return true;
1097     }
1098 }
1099
1100 /** ENABLE_MARKUP_MEDIAWIKI_TABLE
1101  *  Table syntax similar to Mediawiki
1102  *  {|
1103  * => <?plugin MediawikiTable
1104  *  |}
1105  * => ?>
1106  */
1107 class Block_table_mediawiki extends Block_pre
1108 {
1109     var $_re = '{\|';
1110
1111     function _match (&$input, $m) {
1112         $pos = $input->getPos();
1113         $pi = $m->postmatch;
1114         while (!preg_match('/(?<!'.ESCAPE_CHAR.')\|}\s*$/', $pi)) {
1115             if (($line = $input->nextLine()) === false) {
1116                 $input->setPos($pos);
1117                 return false;
1118             }
1119             $pi .= "\n$line";
1120         }
1121         $input->advance();
1122
1123         $pi = str_replace("\|}", "", $pi);
1124         $pi = '<'.'?plugin MediawikiTable ' . $pi . '?'.'>';
1125         $this->_element = new Cached_PluginInvocation($pi);
1126         return true;
1127     }
1128 }
1129
1130 class Block_template_plugin extends Block_pre
1131 {
1132     var $_re = '{{';
1133
1134     function _match (&$input, $m) {
1135         $pos = $input->getPos();
1136         $pi = $m->postmatch;
1137         if ($pi[0] == '{') {
1138             return false;
1139         }
1140         while (!preg_match('/(?<!'.ESCAPE_CHAR.')}}\s*$/', $pi)) {
1141             if (($line = $input->nextLine()) === false) {
1142                 $input->setPos($pos);
1143                 return false;
1144             }
1145             $pi .= "\n$line";
1146         }
1147         $input->advance();
1148
1149         $pi = trim($pi);
1150         $pi = trim($pi, "}}");
1151
1152         if (strpos($pi, "|") === false) {
1153             $imagename = $pi;
1154             $alt = "";
1155         } else {
1156             $imagename = substr($pi, 0, strpos($pi, "|"));
1157             $alt = ltrim(strstr($pi, "|"), "|");
1158         }
1159
1160         // It's not a Mediawiki template, it's a Wikicreole image
1161         if (is_image($imagename)) {
1162             $this->_element = LinkImage(UPLOAD_DATA_PATH . $imagename, $alt);
1163             return true;
1164         }
1165
1166         $pi = str_replace("\n", "", $pi);
1167         $vars = '';
1168
1169         if (preg_match('/^(\S+?)\|(.*)$/', $pi, $_m)) {
1170             $pi = $_m[1];
1171             $vars = '"' . preg_replace('/\|/', '" "', $_m[2]) . '"';
1172             $vars = preg_replace('/"(\S+)=([^"]*)"/', '\\1="\\2"', $vars);
1173         }
1174
1175         // pi may contain a version number
1176         // {{foo?version=5}}
1177         // in that case, output is "page=foo rev=5"
1178         if (strstr($pi, "?")) {
1179             $pi = str_replace("?version=", "\" rev=\"", $page);
1180         }
1181
1182         if ($vars)
1183             $pi = '<'.'?plugin Template page="'.$pi.'" '.$vars . ' ?>';
1184         else
1185             $pi = '<'.'?plugin Template page="' . $pi . '" ?>';
1186         $this->_element = new Cached_PluginInvocation($pi);
1187         return true;
1188     }
1189 }
1190
1191 class Block_email_blockquote extends BlockMarkup
1192 {
1193     var $_attr = array('class' => 'mail-style-quote');
1194     var $_re = '>\ ?';
1195
1196     function _match (&$input, $m) {
1197         //$indent = str_replace(' ', '\\ ', $m->match) . '|>$';
1198         $indent = $this->_re;
1199         $this->_element = new SubBlock($input, $indent, $m->match,
1200                                        'blockquote', $this->_attr);
1201         return true;
1202     }
1203 }
1204
1205 class Block_hr extends BlockMarkup
1206 {
1207     var $_re = '-{4,}\s*$';
1208
1209     function _match (&$input, $m) {
1210         $input->advance();
1211         $this->_element = new Block_HtmlElement('hr');
1212         return true;
1213     }
1214
1215     function _setTightness($top, $bot) {
1216         // Don't tighten <hr/>s
1217     }
1218 }
1219
1220 class Block_heading extends BlockMarkup
1221 {
1222     var $_re = '!{1,3}';
1223
1224     function _match (&$input, $m) {
1225         $tag = "h" . (5 - strlen($m->match));
1226         $text = TransformInline(trim($m->postmatch));
1227         $input->advance();
1228
1229         $this->_element = new Block_HtmlElement($tag, false, $text);
1230
1231         return true;
1232     }
1233
1234     function _setTightness($top, $bot) {
1235         // Don't tighten headers.
1236     }
1237 }
1238
1239 class Block_heading_wikicreole extends BlockMarkup
1240 {
1241     var $_re = '={2,6}';
1242
1243     function _match (&$input, $m) {
1244         $tag = "h" . strlen($m->match);
1245         // Remove spaces
1246         $header = trim($m->postmatch);
1247         // Remove '='s at the end so that Mediawiki syntax is recognized
1248         $header = trim($header, "=");
1249         $text = TransformInline(trim($header));
1250         $input->advance();
1251
1252         $this->_element = new Block_HtmlElement($tag, false, $text);
1253
1254         return true;
1255     }
1256
1257     function _setTightness($top, $bot) {
1258         // Don't tighten headers.
1259     }
1260 }
1261
1262 class Block_p extends BlockMarkup
1263 {
1264     var $_tag = 'p';
1265     var $_re = '\S.*';
1266     var $_text = '';
1267
1268     function _match (&$input, $m) {
1269         $this->_text = $m->match;
1270         $input->advance();
1271         return true;
1272     }
1273
1274     function _setTightness ($top, $bot) {
1275         $this->_tight_top = $top;
1276         $this->_tight_bot = $bot;
1277     }
1278
1279     function merge ($nextBlock) {
1280         $class = get_class($nextBlock);
1281         if (strtolower($class) == 'block_p' and $this->_tight_bot) {
1282             $this->_text .= "\n" . $nextBlock->_text;
1283             $this->_tight_bot = $nextBlock->_tight_bot;
1284             return $this;
1285         }
1286         return false;
1287     }
1288
1289     function finish () {
1290         $content = TransformInline(trim($this->_text));
1291         $p = new Block_HtmlElement('p', false, $content);
1292         $p->setTightness($this->_tight_top, $this->_tight_bot);
1293         return $p;
1294     }
1295 }
1296
1297 class Block_divspan extends BlockMarkup
1298 {
1299     var $_re = '<(?im)(?: div|span)(?:[^>]*)?>';
1300
1301     function _match (&$input, $m) {
1302         if (substr($m->match,1,4) == 'span') {
1303             $tag = 'span';
1304         } else {
1305             $tag = 'div';
1306         }
1307         // without last >
1308         $argstr = substr(trim(substr($m->match,strlen($tag)+1)),0,-1);
1309         $pos = $input->getPos();
1310         $pi  = $content = $m->postmatch;
1311         while (!preg_match('/^(.*)\<\/'.$tag.'\>(.*)$/i', $pi, $me)) {
1312             if ($pi != $content)
1313                 $content .= "\n$pi";
1314             if (($pi = $input->nextLine()) === false) {
1315                 $input->setPos($pos);
1316                 return false;
1317             }
1318         }
1319         if ($pi != $content)
1320             $content .= $me[1]; // prematch
1321         else
1322             $content = $me[1];
1323         $input->advance();
1324         if (strstr($content, "\n"))
1325             $content = TransformText($content);
1326         else
1327             $content = TransformInline($content);
1328         if (!$argstr)
1329             $args = false;
1330         else {
1331             $args = array();
1332             while (preg_match("/(\w+)=(.+)/", $argstr, $m)) {
1333                 $k = $m[1]; $v = $m[2];
1334                 if (preg_match("/^\"(.+?)\"(.*)$/", $v, $m)) {
1335                     $v = $m[1];
1336                     $argstr = $m[2];
1337                 } else {
1338                     preg_match("/^(\s+)(.*)$/", $v, $m);
1339                     $v = $m[1];
1340                     $argstr = $m[2];
1341                 }
1342                 if (trim($k) and trim($v)) $args[$k] = $v;
1343             }
1344         }
1345         $this->_element = new Block_HtmlElement($tag, $args, $content);
1346         //$this->_element->setTightness($tag == 'span', $tag == 'span');
1347         return true;
1348     }
1349     function _setTightness($top, $bot) {
1350         // Don't tighten user <div|span>
1351     }
1352 }
1353
1354
1355 ////////////////////////////////////////////////////////////////
1356 //
1357
1358 /**
1359  * Transform the text of a page, and return a parse tree.
1360  */
1361 function TransformTextPre ($text, $markup = 2.0, $basepage=false) {
1362     if (isa($text, 'WikiDB_PageRevision')) {
1363         $rev = $text;
1364         $text = $rev->getPackedContent();
1365         $markup = $rev->get('markup');
1366     }
1367     // NEW: default markup is new, to increase stability
1368     if (!empty($markup) && $markup < 2.0) {
1369         $text = ConvertOldMarkup($text);
1370     }
1371     // WikiCreole
1372     /*if (!empty($markup) && $markup == 3) {
1373         $text = ConvertFromCreole($text);
1374     }*/
1375     // Expand leading tabs.
1376     $text = expand_tabs($text);
1377     //set_time_limit(3);
1378     $output = new WikiText($text);
1379
1380     return $output;
1381 }
1382
1383 /**
1384  * Transform the text of a page, and return an XmlContent,
1385  * suitable for printXml()-ing.
1386  */
1387 function TransformText ($text, $markup = 2.0, $basepage = false) {
1388     $output = TransformTextPre($text, $markup, $basepage);
1389     if ($basepage) {
1390         // This is for immediate consumption.
1391         // We must bind the contents to a base pagename so that
1392         // relative page links can be properly linkified...
1393         return new CacheableMarkup($output->getContent(), $basepage);
1394     }
1395     return new XmlContent($output->getContent());
1396 }
1397
1398 // (c-file-style: "gnu")
1399 // Local Variables:
1400 // mode: php
1401 // tab-width: 8
1402 // c-basic-offset: 4
1403 // c-hanging-comment-ender-p: nil
1404 // indent-tabs-mode: nil
1405 // End:
1406 ?>