3 * Preprocessor using PHP arrays
10 * Differences from DOM schema:
11 * * attribute nodes are children
12 * * <h> nodes that aren't at the top are replaced with <possible-h>
15 class Preprocessor_Hash
implements Preprocessor
{
21 const CACHE_VERSION
= 1;
23 function __construct( $parser ) {
24 $this->parser
= $parser;
28 return new PPFrame_Hash( $this );
31 function newCustomFrame( $args ) {
32 return new PPCustomFrame_Hash( $this, $args );
35 function newPartNodeArray( $values ) {
38 foreach ( $values as $k => $val ) {
39 $partNode = new PPNode_Hash_Tree( 'part' );
40 $nameNode = new PPNode_Hash_Tree( 'name' );
43 $nameNode->addChild( new PPNode_Hash_Attr( 'index', $k ) );
44 $partNode->addChild( $nameNode );
46 $nameNode->addChild( new PPNode_Hash_Text( $k ) );
47 $partNode->addChild( $nameNode );
48 $partNode->addChild( new PPNode_Hash_Text( '=' ) );
51 $valueNode = new PPNode_Hash_Tree( 'value' );
52 $valueNode->addChild( new PPNode_Hash_Text( $val ) );
53 $partNode->addChild( $valueNode );
58 $node = new PPNode_Hash_Array( $list );
63 * Preprocess some wikitext and return the document tree.
64 * This is the ghost of Parser::replace_variables().
66 * @param $text String: the text to parse
67 * @param $flags Integer: bitwise combination of:
68 * Parser::PTD_FOR_INCLUSION Handle <noinclude>/<includeonly> as if the text is being
69 * included. Default is to assume a direct page view.
71 * The generated DOM tree must depend only on the input text and the flags.
72 * The DOM tree must be the same in OT_HTML and OT_WIKI mode, to avoid a regression of bug 4899.
74 * Any flag added to the $flags parameter here, or any other parameter liable to cause a
75 * change in the DOM tree for a given text, must be passed through the section identifier
76 * in the section edit link and thus back to extractSections().
78 * The output of this function is currently only cached in process memory, but a persistent
79 * cache may be implemented at a later date which takes further advantage of these strict
80 * dependency requirements.
84 function preprocessToObj( $text, $flags = 0 ) {
85 wfProfileIn( __METHOD__
);
88 global $wgMemc, $wgPreprocessorCacheThreshold;
90 $cacheable = $wgPreprocessorCacheThreshold !== false && strlen( $text ) > $wgPreprocessorCacheThreshold;
92 wfProfileIn( __METHOD__
.'-cacheable' );
94 $cacheKey = wfMemcKey( 'preprocess-hash', md5($text), $flags );
95 $cacheValue = $wgMemc->get( $cacheKey );
97 $version = substr( $cacheValue, 0, 8 );
98 if ( intval( $version ) == self
::CACHE_VERSION
) {
99 $hash = unserialize( substr( $cacheValue, 8 ) );
101 wfDebugLog( "Preprocessor",
102 "Loaded preprocessor hash from memcached (key $cacheKey)" );
103 wfProfileOut( __METHOD__
.'-cacheable' );
104 wfProfileOut( __METHOD__
);
108 wfProfileIn( __METHOD__
.'-cache-miss' );
123 'names' => array( 2 => null ),
129 $forInclusion = $flags & Parser
::PTD_FOR_INCLUSION
;
131 $xmlishElements = $this->parser
->getStripList();
132 $enableOnlyinclude = false;
133 if ( $forInclusion ) {
134 $ignoredTags = array( 'includeonly', '/includeonly' );
135 $ignoredElements = array( 'noinclude' );
136 $xmlishElements[] = 'noinclude';
137 if ( strpos( $text, '<onlyinclude>' ) !== false && strpos( $text, '</onlyinclude>' ) !== false ) {
138 $enableOnlyinclude = true;
141 $ignoredTags = array( 'noinclude', '/noinclude', 'onlyinclude', '/onlyinclude' );
142 $ignoredElements = array( 'includeonly' );
143 $xmlishElements[] = 'includeonly';
145 $xmlishRegex = implode( '|', array_merge( $xmlishElements, $ignoredTags ) );
147 // Use "A" modifier (anchored) instead of "^", because ^ doesn't work with an offset
148 $elementsRegex = "~($xmlishRegex)(?:\s|\/>|>)|(!--)~iA";
150 $stack = new PPDStack_Hash
;
152 $searchBase = "[{<\n";
153 $revText = strrev( $text ); // For fast reverse searches
155 $i = 0; # Input pointer, starts out pointing to a pseudo-newline before the start
156 $accum =& $stack->getAccum(); # Current accumulator
157 $findEquals = false; # True to find equals signs in arguments
158 $findPipe = false; # True to take notice of pipe characters
160 $inHeading = false; # True if $i is inside a possible heading
161 $noMoreGT = false; # True if there are no more greater-than (>) signs right of $i
162 $findOnlyinclude = $enableOnlyinclude; # True to ignore all input up to the next <onlyinclude>
163 $fakeLineStart = true; # Do a line-start run without outputting an LF character
168 if ( $findOnlyinclude ) {
169 // Ignore all input up to the next <onlyinclude>
170 $startPos = strpos( $text, '<onlyinclude>', $i );
171 if ( $startPos === false ) {
172 // Ignored section runs to the end
173 $accum->addNodeWithText( 'ignore', substr( $text, $i ) );
176 $tagEndPos = $startPos +
strlen( '<onlyinclude>' ); // past-the-end
177 $accum->addNodeWithText( 'ignore', substr( $text, $i, $tagEndPos - $i ) );
179 $findOnlyinclude = false;
182 if ( $fakeLineStart ) {
183 $found = 'line-start';
186 # Find next opening brace, closing brace or pipe
187 $search = $searchBase;
188 if ( $stack->top
=== false ) {
189 $currentClosing = '';
191 $currentClosing = $stack->top
->close
;
192 $search .= $currentClosing;
198 // First equals will be for the template
202 # Output literal section, advance input counter
203 $literalLength = strcspn( $text, $search, $i );
204 if ( $literalLength > 0 ) {
205 $accum->addLiteral( substr( $text, $i, $literalLength ) );
206 $i +
= $literalLength;
208 if ( $i >= strlen( $text ) ) {
209 if ( $currentClosing == "\n" ) {
210 // Do a past-the-end run to finish off the heading
218 $curChar = $text[$i];
219 if ( $curChar == '|' ) {
221 } elseif ( $curChar == '=' ) {
223 } elseif ( $curChar == '<' ) {
225 } elseif ( $curChar == "\n" ) {
229 $found = 'line-start';
231 } elseif ( $curChar == $currentClosing ) {
233 } elseif ( isset( $rules[$curChar] ) ) {
235 $rule = $rules[$curChar];
237 # Some versions of PHP have a strcspn which stops on null characters
238 # Ignore and continue
245 if ( $found == 'angle' ) {
247 // Handle </onlyinclude>
248 if ( $enableOnlyinclude && substr( $text, $i, strlen( '</onlyinclude>' ) ) == '</onlyinclude>' ) {
249 $findOnlyinclude = true;
253 // Determine element name
254 if ( !preg_match( $elementsRegex, $text, $matches, 0, $i +
1 ) ) {
255 // Element name missing or not listed
256 $accum->addLiteral( '<' );
261 if ( isset( $matches[2] ) && $matches[2] == '!--' ) {
262 // To avoid leaving blank lines, when a comment is both preceded
263 // and followed by a newline (ignoring spaces), trim leading and
264 // trailing spaces and one of the newlines.
267 $endPos = strpos( $text, '-->', $i +
4 );
268 if ( $endPos === false ) {
269 // Unclosed comment in input, runs to end
270 $inner = substr( $text, $i );
271 $accum->addNodeWithText( 'comment', $inner );
272 $i = strlen( $text );
274 // Search backwards for leading whitespace
275 $wsStart = $i ?
( $i - strspn( $revText, ' ', strlen( $text ) - $i ) ) : 0;
276 // Search forwards for trailing whitespace
277 // $wsEnd will be the position of the last space (or the '>' if there's none)
278 $wsEnd = $endPos +
2 +
strspn( $text, ' ', $endPos +
3 );
279 // Eat the line if possible
280 // TODO: This could theoretically be done if $wsStart == 0, i.e. for comments at
281 // the overall start. That's not how Sanitizer::removeHTMLcomments() did it, but
282 // it's a possible beneficial b/c break.
283 if ( $wsStart > 0 && substr( $text, $wsStart - 1, 1 ) == "\n"
284 && substr( $text, $wsEnd +
1, 1 ) == "\n" )
286 $startPos = $wsStart;
287 $endPos = $wsEnd +
1;
288 // Remove leading whitespace from the end of the accumulator
289 // Sanity check first though
290 $wsLength = $i - $wsStart;
292 && $accum->lastNode
instanceof PPNode_Hash_Text
293 && substr( $accum->lastNode
->value
, -$wsLength ) === str_repeat( ' ', $wsLength ) )
295 $accum->lastNode
->value
= substr( $accum->lastNode
->value
, 0, -$wsLength );
297 // Do a line-start run next time to look for headings after the comment
298 $fakeLineStart = true;
300 // No line to eat, just take the comment itself
306 $part = $stack->top
->getCurrentPart();
307 if ( isset( $part->commentEnd
) && $part->commentEnd
== $wsStart - 1 ) {
308 // Comments abutting, no change in visual end
309 $part->commentEnd
= $wsEnd;
311 $part->visualEnd
= $wsStart;
312 $part->commentEnd
= $endPos;
316 $inner = substr( $text, $startPos, $endPos - $startPos +
1 );
317 $accum->addNodeWithText( 'comment', $inner );
322 $lowerName = strtolower( $name );
323 $attrStart = $i +
strlen( $name ) +
1;
326 $tagEndPos = $noMoreGT ?
false : strpos( $text, '>', $attrStart );
327 if ( $tagEndPos === false ) {
328 // Infinite backtrack
329 // Disable tag search to prevent worst-case O(N^2) performance
331 $accum->addLiteral( '<' );
336 // Handle ignored tags
337 if ( in_array( $lowerName, $ignoredTags ) ) {
338 $accum->addNodeWithText( 'ignore', substr( $text, $i, $tagEndPos - $i +
1 ) );
344 if ( $text[$tagEndPos-1] == '/' ) {
346 $attrEnd = $tagEndPos - 1;
351 $attrEnd = $tagEndPos;
353 if ( preg_match( "/<\/" . preg_quote( $name, '/' ) . "\s*>/i",
354 $text, $matches, PREG_OFFSET_CAPTURE
, $tagEndPos +
1 ) )
356 $inner = substr( $text, $tagEndPos +
1, $matches[0][1] - $tagEndPos - 1 );
357 $i = $matches[0][1] +
strlen( $matches[0][0] );
358 $close = $matches[0][0];
360 // No end tag -- let it run out to the end of the text.
361 $inner = substr( $text, $tagEndPos +
1 );
362 $i = strlen( $text );
366 // <includeonly> and <noinclude> just become <ignore> tags
367 if ( in_array( $lowerName, $ignoredElements ) ) {
368 $accum->addNodeWithText( 'ignore', substr( $text, $tagStartPos, $i - $tagStartPos ) );
372 if ( $attrEnd <= $attrStart ) {
375 // Note that the attr element contains the whitespace between name and attribute,
376 // this is necessary for precise reconstruction during pre-save transform.
377 $attr = substr( $text, $attrStart, $attrEnd - $attrStart );
380 $extNode = new PPNode_Hash_Tree( 'ext' );
381 $extNode->addChild( PPNode_Hash_Tree
::newWithText( 'name', $name ) );
382 $extNode->addChild( PPNode_Hash_Tree
::newWithText( 'attr', $attr ) );
383 if ( $inner !== null ) {
384 $extNode->addChild( PPNode_Hash_Tree
::newWithText( 'inner', $inner ) );
386 if ( $close !== null ) {
387 $extNode->addChild( PPNode_Hash_Tree
::newWithText( 'close', $close ) );
389 $accum->addNode( $extNode );
392 elseif ( $found == 'line-start' ) {
393 // Is this the start of a heading?
394 // Line break belongs before the heading element in any case
395 if ( $fakeLineStart ) {
396 $fakeLineStart = false;
398 $accum->addLiteral( $curChar );
402 $count = strspn( $text, '=', $i, 6 );
403 if ( $count == 1 && $findEquals ) {
404 // DWIM: This looks kind of like a name/value separator
405 // Let's let the equals handler have it and break the potential heading
406 // This is heuristic, but AFAICT the methods for completely correct disambiguation are very complex.
407 } elseif ( $count > 0 ) {
411 'parts' => array( new PPDPart_Hash( str_repeat( '=', $count ) ) ),
414 $stack->push( $piece );
415 $accum =& $stack->getAccum();
416 extract( $stack->getFlags() );
421 elseif ( $found == 'line-end' ) {
422 $piece = $stack->top
;
423 // A heading must be open, otherwise \n wouldn't have been in the search list
424 assert( $piece->open
== "\n" );
425 $part = $piece->getCurrentPart();
426 // Search back through the input to see if it has a proper close
427 // Do this using the reversed string since the other solutions (end anchor, etc.) are inefficient
428 $wsLength = strspn( $revText, " \t", strlen( $text ) - $i );
429 $searchStart = $i - $wsLength;
430 if ( isset( $part->commentEnd
) && $searchStart - 1 == $part->commentEnd
) {
431 // Comment found at line end
432 // Search for equals signs before the comment
433 $searchStart = $part->visualEnd
;
434 $searchStart -= strspn( $revText, " \t", strlen( $text ) - $searchStart );
436 $count = $piece->count
;
437 $equalsLength = strspn( $revText, '=', strlen( $text ) - $searchStart );
438 if ( $equalsLength > 0 ) {
439 if ( $searchStart - $equalsLength == $piece->startPos
) {
440 // This is just a single string of equals signs on its own line
441 // Replicate the doHeadings behaviour /={count}(.+)={count}/
442 // First find out how many equals signs there really are (don't stop at 6)
443 $count = $equalsLength;
447 $count = min( 6, intval( ( $count - 1 ) / 2 ) );
450 $count = min( $equalsLength, $count );
453 // Normal match, output <h>
454 $element = new PPNode_Hash_Tree( 'possible-h' );
455 $element->addChild( new PPNode_Hash_Attr( 'level', $count ) );
456 $element->addChild( new PPNode_Hash_Attr( 'i', $headingIndex++
) );
457 $element->lastChild
->nextSibling
= $accum->firstNode
;
458 $element->lastChild
= $accum->lastNode
;
460 // Single equals sign on its own line, count=0
464 // No match, no <h>, just pass down the inner text
469 $accum =& $stack->getAccum();
470 extract( $stack->getFlags() );
472 // Append the result to the enclosing accumulator
473 if ( $element instanceof PPNode
) {
474 $accum->addNode( $element );
476 $accum->addAccum( $element );
478 // Note that we do NOT increment the input pointer.
479 // This is because the closing linebreak could be the opening linebreak of
480 // another heading. Infinite loops are avoided because the next iteration MUST
481 // hit the heading open case above, which unconditionally increments the
485 elseif ( $found == 'open' ) {
486 # count opening brace characters
487 $count = strspn( $text, $curChar, $i );
489 # we need to add to stack only if opening brace count is enough for one of the rules
490 if ( $count >= $rule['min'] ) {
491 # Add it to the stack
494 'close' => $rule['end'],
496 'lineStart' => ($i > 0 && $text[$i-1] == "\n"),
499 $stack->push( $piece );
500 $accum =& $stack->getAccum();
501 extract( $stack->getFlags() );
503 # Add literal brace(s)
504 $accum->addLiteral( str_repeat( $curChar, $count ) );
509 elseif ( $found == 'close' ) {
510 $piece = $stack->top
;
511 # lets check if there are enough characters for closing brace
512 $maxCount = $piece->count
;
513 $count = strspn( $text, $curChar, $i, $maxCount );
515 # check for maximum matching characters (if there are 5 closing
516 # characters, we will probably need only 3 - depending on the rules)
517 $rule = $rules[$piece->open
];
518 if ( $count > $rule['max'] ) {
519 # The specified maximum exists in the callback array, unless the caller
521 $matchingCount = $rule['max'];
523 # Count is less than the maximum
524 # Skip any gaps in the callback array to find the true largest match
525 # Need to use array_key_exists not isset because the callback can be null
526 $matchingCount = $count;
527 while ( $matchingCount > 0 && !array_key_exists( $matchingCount, $rule['names'] ) ) {
532 if ($matchingCount <= 0) {
533 # No matching element found in callback array
534 # Output a literal closing brace and continue
535 $accum->addLiteral( str_repeat( $curChar, $count ) );
539 $name = $rule['names'][$matchingCount];
540 if ( $name === null ) {
541 // No element, just literal text
542 $element = $piece->breakSyntax( $matchingCount );
543 $element->addLiteral( str_repeat( $rule['end'], $matchingCount ) );
546 # Note: $parts is already XML, does not need to be encoded further
547 $parts = $piece->parts
;
548 $titleAccum = $parts[0]->out
;
551 $element = new PPNode_Hash_Tree( $name );
553 # The invocation is at the start of the line if lineStart is set in
554 # the stack, and all opening brackets are used up.
555 if ( $maxCount == $matchingCount && !empty( $piece->lineStart
) ) {
556 $element->addChild( new PPNode_Hash_Attr( 'lineStart', 1 ) );
558 $titleNode = new PPNode_Hash_Tree( 'title' );
559 $titleNode->firstChild
= $titleAccum->firstNode
;
560 $titleNode->lastChild
= $titleAccum->lastNode
;
561 $element->addChild( $titleNode );
563 foreach ( $parts as $part ) {
564 if ( isset( $part->eqpos
) ) {
567 for ( $node = $part->out
->firstNode
; $node; $node = $node->nextSibling
) {
568 if ( $node === $part->eqpos
) {
574 throw new MWException( __METHOD__
. ': eqpos not found' );
576 if ( $node->name
!== 'equals' ) {
577 throw new MWException( __METHOD__
.': eqpos is not equals' );
581 // Construct name node
582 $nameNode = new PPNode_Hash_Tree( 'name' );
583 if ( $lastNode !== false ) {
584 $lastNode->nextSibling
= false;
585 $nameNode->firstChild
= $part->out
->firstNode
;
586 $nameNode->lastChild
= $lastNode;
589 // Construct value node
590 $valueNode = new PPNode_Hash_Tree( 'value' );
591 if ( $equalsNode->nextSibling
!== false ) {
592 $valueNode->firstChild
= $equalsNode->nextSibling
;
593 $valueNode->lastChild
= $part->out
->lastNode
;
595 $partNode = new PPNode_Hash_Tree( 'part' );
596 $partNode->addChild( $nameNode );
597 $partNode->addChild( $equalsNode->firstChild
);
598 $partNode->addChild( $valueNode );
599 $element->addChild( $partNode );
601 $partNode = new PPNode_Hash_Tree( 'part' );
602 $nameNode = new PPNode_Hash_Tree( 'name' );
603 $nameNode->addChild( new PPNode_Hash_Attr( 'index', $argIndex++
) );
604 $valueNode = new PPNode_Hash_Tree( 'value' );
605 $valueNode->firstChild
= $part->out
->firstNode
;
606 $valueNode->lastChild
= $part->out
->lastNode
;
607 $partNode->addChild( $nameNode );
608 $partNode->addChild( $valueNode );
609 $element->addChild( $partNode );
614 # Advance input pointer
615 $i +
= $matchingCount;
619 $accum =& $stack->getAccum();
621 # Re-add the old stack element if it still has unmatched opening characters remaining
622 if ($matchingCount < $piece->count
) {
623 $piece->parts
= array( new PPDPart_Hash
);
624 $piece->count
-= $matchingCount;
625 # do we still qualify for any callback with remaining count?
626 $names = $rules[$piece->open
]['names'];
628 $enclosingAccum =& $accum;
629 while ( $piece->count
) {
630 if ( array_key_exists( $piece->count
, $names ) ) {
631 $stack->push( $piece );
632 $accum =& $stack->getAccum();
638 $enclosingAccum->addLiteral( str_repeat( $piece->open
, $skippedBraces ) );
641 extract( $stack->getFlags() );
643 # Add XML element to the enclosing accumulator
644 if ( $element instanceof PPNode
) {
645 $accum->addNode( $element );
647 $accum->addAccum( $element );
651 elseif ( $found == 'pipe' ) {
652 $findEquals = true; // shortcut for getFlags()
654 $accum =& $stack->getAccum();
658 elseif ( $found == 'equals' ) {
659 $findEquals = false; // shortcut for getFlags()
660 $accum->addNodeWithText( 'equals', '=' );
661 $stack->getCurrentPart()->eqpos
= $accum->lastNode
;
666 # Output any remaining unclosed brackets
667 foreach ( $stack->stack
as $piece ) {
668 $stack->rootAccum
->addAccum( $piece->breakSyntax() );
671 # Enable top-level headings
672 for ( $node = $stack->rootAccum
->firstNode
; $node; $node = $node->nextSibling
) {
673 if ( isset( $node->name
) && $node->name
=== 'possible-h' ) {
678 $rootNode = new PPNode_Hash_Tree( 'root' );
679 $rootNode->firstChild
= $stack->rootAccum
->firstNode
;
680 $rootNode->lastChild
= $stack->rootAccum
->lastNode
;
684 $cacheValue = sprintf( "%08d", self
::CACHE_VERSION
) . serialize( $rootNode );
685 $wgMemc->set( $cacheKey, $cacheValue, 86400 );
686 wfProfileOut( __METHOD__
.'-cache-miss' );
687 wfProfileOut( __METHOD__
.'-cacheable' );
688 wfDebugLog( "Preprocessor", "Saved preprocessor Hash to memcached (key $cacheKey)" );
691 wfProfileOut( __METHOD__
);
697 * Stack class to help Preprocessor::preprocessToObj()
700 class PPDStack_Hash
extends PPDStack
{
701 function __construct() {
702 $this->elementClass
= 'PPDStackElement_Hash';
703 parent
::__construct();
704 $this->rootAccum
= new PPDAccum_Hash
;
711 class PPDStackElement_Hash
extends PPDStackElement
{
712 function __construct( $data = array() ) {
713 $this->partClass
= 'PPDPart_Hash';
714 parent
::__construct( $data );
718 * Get the accumulator that would result if the close is not found.
720 function breakSyntax( $openingCount = false ) {
721 if ( $this->open
== "\n" ) {
722 $accum = $this->parts
[0]->out
;
724 if ( $openingCount === false ) {
725 $openingCount = $this->count
;
727 $accum = new PPDAccum_Hash
;
728 $accum->addLiteral( str_repeat( $this->open
, $openingCount ) );
730 foreach ( $this->parts
as $part ) {
734 $accum->addLiteral( '|' );
736 $accum->addAccum( $part->out
);
746 class PPDPart_Hash
extends PPDPart
{
747 function __construct( $out = '' ) {
748 $accum = new PPDAccum_Hash
;
750 $accum->addLiteral( $out );
752 parent
::__construct( $accum );
759 class PPDAccum_Hash
{
760 var $firstNode, $lastNode;
762 function __construct() {
763 $this->firstNode
= $this->lastNode
= false;
767 * Append a string literal
769 function addLiteral( $s ) {
770 if ( $this->lastNode
=== false ) {
771 $this->firstNode
= $this->lastNode
= new PPNode_Hash_Text( $s );
772 } elseif ( $this->lastNode
instanceof PPNode_Hash_Text
) {
773 $this->lastNode
->value
.= $s;
775 $this->lastNode
->nextSibling
= new PPNode_Hash_Text( $s );
776 $this->lastNode
= $this->lastNode
->nextSibling
;
783 function addNode( PPNode
$node ) {
784 if ( $this->lastNode
=== false ) {
785 $this->firstNode
= $this->lastNode
= $node;
787 $this->lastNode
->nextSibling
= $node;
788 $this->lastNode
= $node;
793 * Append a tree node with text contents
795 function addNodeWithText( $name, $value ) {
796 $node = PPNode_Hash_Tree
::newWithText( $name, $value );
797 $this->addNode( $node );
801 * Append a PPAccum_Hash
802 * Takes over ownership of the nodes in the source argument. These nodes may
803 * subsequently be modified, especially nextSibling.
805 function addAccum( $accum ) {
806 if ( $accum->lastNode
=== false ) {
808 } elseif ( $this->lastNode
=== false ) {
809 $this->firstNode
= $accum->firstNode
;
810 $this->lastNode
= $accum->lastNode
;
812 $this->lastNode
->nextSibling
= $accum->firstNode
;
813 $this->lastNode
= $accum->lastNode
;
819 * An expansion frame, used as a context to expand the result of preprocessToObj()
822 class PPFrame_Hash
implements PPFrame
{
841 * Hashtable listing templates which are disallowed for expansion in this frame,
842 * having been encountered previously in parent frames.
847 * Recursion depth of this frame, top = 0
848 * Note that this is NOT the same as expansion depth in expand()
854 * Construct a new preprocessor frame.
855 * @param $preprocessor Preprocessor: the parent preprocessor
857 function __construct( $preprocessor ) {
858 $this->preprocessor
= $preprocessor;
859 $this->parser
= $preprocessor->parser
;
860 $this->title
= $this->parser
->mTitle
;
861 $this->titleCache
= array( $this->title ?
$this->title
->getPrefixedDBkey() : false );
862 $this->loopCheckHash
= array();
867 * Create a new child frame
868 * $args is optionally a multi-root PPNode or array containing the template arguments
870 function newChild( $args = false, $title = false ) {
871 $namedArgs = array();
872 $numberedArgs = array();
873 if ( $title === false ) {
874 $title = $this->title
;
876 if ( $args !== false ) {
877 if ( $args instanceof PPNode_Hash_Array
) {
878 $args = $args->value
;
879 } elseif ( !is_array( $args ) ) {
880 throw new MWException( __METHOD__
. ': $args must be array or PPNode_Hash_Array' );
882 foreach ( $args as $arg ) {
883 $bits = $arg->splitArg();
884 if ( $bits['index'] !== '' ) {
885 // Numbered parameter
886 $numberedArgs[$bits['index']] = $bits['value'];
887 unset( $namedArgs[$bits['index']] );
890 $name = trim( $this->expand( $bits['name'], PPFrame
::STRIP_COMMENTS
) );
891 $namedArgs[$name] = $bits['value'];
892 unset( $numberedArgs[$name] );
896 return new PPTemplateFrame_Hash( $this->preprocessor
, $this, $numberedArgs, $namedArgs, $title );
899 function expand( $root, $flags = 0 ) {
900 static $expansionDepth = 0;
901 if ( is_string( $root ) ) {
905 if ( ++
$this->parser
->mPPNodeCount
> $this->parser
->mOptions
->getMaxPPNodeCount() ) {
906 return '<span class="error">Node-count limit exceeded</span>';
908 if ( $expansionDepth > $this->parser
->mOptions
->getMaxPPExpandDepth() ) {
909 return '<span class="error">Expansion depth limit exceeded</span>';
913 $outStack = array( '', '' );
914 $iteratorStack = array( false, $root );
915 $indexStack = array( 0, 0 );
917 while ( count( $iteratorStack ) > 1 ) {
918 $level = count( $outStack ) - 1;
919 $iteratorNode =& $iteratorStack[ $level ];
920 $out =& $outStack[$level];
921 $index =& $indexStack[$level];
923 if ( is_array( $iteratorNode ) ) {
924 if ( $index >= count( $iteratorNode ) ) {
925 // All done with this iterator
926 $iteratorStack[$level] = false;
927 $contextNode = false;
929 $contextNode = $iteratorNode[$index];
932 } elseif ( $iteratorNode instanceof PPNode_Hash_Array
) {
933 if ( $index >= $iteratorNode->getLength() ) {
934 // All done with this iterator
935 $iteratorStack[$level] = false;
936 $contextNode = false;
938 $contextNode = $iteratorNode->item( $index );
942 // Copy to $contextNode and then delete from iterator stack,
943 // because this is not an iterator but we do have to execute it once
944 $contextNode = $iteratorStack[$level];
945 $iteratorStack[$level] = false;
948 $newIterator = false;
950 if ( $contextNode === false ) {
952 } elseif ( is_string( $contextNode ) ) {
953 $out .= $contextNode;
954 } elseif ( is_array( $contextNode ) ||
$contextNode instanceof PPNode_Hash_Array
) {
955 $newIterator = $contextNode;
956 } elseif ( $contextNode instanceof PPNode_Hash_Attr
) {
958 } elseif ( $contextNode instanceof PPNode_Hash_Text
) {
959 $out .= $contextNode->value
;
960 } elseif ( $contextNode instanceof PPNode_Hash_Tree
) {
961 if ( $contextNode->name
== 'template' ) {
962 # Double-brace expansion
963 $bits = $contextNode->splitTemplate();
964 if ( $flags & PPFrame
::NO_TEMPLATES
) {
965 $newIterator = $this->virtualBracketedImplode( '{{', '|', '}}', $bits['title'], $bits['parts'] );
967 $ret = $this->parser
->braceSubstitution( $bits, $this );
968 if ( isset( $ret['object'] ) ) {
969 $newIterator = $ret['object'];
971 $out .= $ret['text'];
974 } elseif ( $contextNode->name
== 'tplarg' ) {
975 # Triple-brace expansion
976 $bits = $contextNode->splitTemplate();
977 if ( $flags & PPFrame
::NO_ARGS
) {
978 $newIterator = $this->virtualBracketedImplode( '{{{', '|', '}}}', $bits['title'], $bits['parts'] );
980 $ret = $this->parser
->argSubstitution( $bits, $this );
981 if ( isset( $ret['object'] ) ) {
982 $newIterator = $ret['object'];
984 $out .= $ret['text'];
987 } elseif ( $contextNode->name
== 'comment' ) {
989 # Remove it in HTML, pre+remove and STRIP_COMMENTS modes
990 if ( $this->parser
->ot
['html']
991 ||
( $this->parser
->ot
['pre'] && $this->parser
->mOptions
->getRemoveComments() )
992 ||
( $flags & PPFrame
::STRIP_COMMENTS
) )
996 # Add a strip marker in PST mode so that pstPass2() can run some old-fashioned regexes on the result
997 # Not in RECOVER_COMMENTS mode (extractSections) though
998 elseif ( $this->parser
->ot
['wiki'] && ! ( $flags & PPFrame
::RECOVER_COMMENTS
) ) {
999 $out .= $this->parser
->insertStripItem( $contextNode->firstChild
->value
);
1001 # Recover the literal comment in RECOVER_COMMENTS and pre+no-remove
1003 $out .= $contextNode->firstChild
->value
;
1005 } elseif ( $contextNode->name
== 'ignore' ) {
1006 # Output suppression used by <includeonly> etc.
1007 # OT_WIKI will only respect <ignore> in substed templates.
1008 # The other output types respect it unless NO_IGNORE is set.
1009 # extractSections() sets NO_IGNORE and so never respects it.
1010 if ( ( !isset( $this->parent
) && $this->parser
->ot
['wiki'] ) ||
( $flags & PPFrame
::NO_IGNORE
) ) {
1011 $out .= $contextNode->firstChild
->value
;
1015 } elseif ( $contextNode->name
== 'ext' ) {
1017 $bits = $contextNode->splitExt() +
array( 'attr' => null, 'inner' => null, 'close' => null );
1018 $out .= $this->parser
->extensionSubstitution( $bits, $this );
1019 } elseif ( $contextNode->name
== 'h' ) {
1021 if ( $this->parser
->ot
['html'] ) {
1022 # Expand immediately and insert heading index marker
1024 for ( $node = $contextNode->firstChild
; $node; $node = $node->nextSibling
) {
1025 $s .= $this->expand( $node, $flags );
1028 $bits = $contextNode->splitHeading();
1029 $titleText = $this->title
->getPrefixedDBkey();
1030 $this->parser
->mHeadings
[] = array( $titleText, $bits['i'] );
1031 $serial = count( $this->parser
->mHeadings
) - 1;
1032 $marker = "{$this->parser->mUniqPrefix}-h-$serial-" . Parser
::MARKER_SUFFIX
;
1033 $s = substr( $s, 0, $bits['level'] ) . $marker . substr( $s, $bits['level'] );
1034 $this->parser
->mStripState
->setGeneral( $marker, '' );
1037 # Expand in virtual stack
1038 $newIterator = $contextNode->getChildren();
1041 # Generic recursive expansion
1042 $newIterator = $contextNode->getChildren();
1045 throw new MWException( __METHOD__
.': Invalid parameter type' );
1048 if ( $newIterator !== false ) {
1050 $iteratorStack[] = $newIterator;
1052 } elseif ( $iteratorStack[$level] === false ) {
1053 // Return accumulated value to parent
1054 // With tail recursion
1055 while ( $iteratorStack[$level] === false && $level > 0 ) {
1056 $outStack[$level - 1] .= $out;
1057 array_pop( $outStack );
1058 array_pop( $iteratorStack );
1059 array_pop( $indexStack );
1065 return $outStack[0];
1068 function implodeWithFlags( $sep, $flags /*, ... */ ) {
1069 $args = array_slice( func_get_args(), 2 );
1073 foreach ( $args as $root ) {
1074 if ( $root instanceof PPNode_Hash_Array
) {
1075 $root = $root->value
;
1077 if ( !is_array( $root ) ) {
1078 $root = array( $root );
1080 foreach ( $root as $node ) {
1086 $s .= $this->expand( $node, $flags );
1093 * Implode with no flags specified
1094 * This previously called implodeWithFlags but has now been inlined to reduce stack depth
1096 function implode( $sep /*, ... */ ) {
1097 $args = array_slice( func_get_args(), 1 );
1101 foreach ( $args as $root ) {
1102 if ( $root instanceof PPNode_Hash_Array
) {
1103 $root = $root->value
;
1105 if ( !is_array( $root ) ) {
1106 $root = array( $root );
1108 foreach ( $root as $node ) {
1114 $s .= $this->expand( $node );
1121 * Makes an object that, when expand()ed, will be the same as one obtained
1124 function virtualImplode( $sep /*, ... */ ) {
1125 $args = array_slice( func_get_args(), 1 );
1129 foreach ( $args as $root ) {
1130 if ( $root instanceof PPNode_Hash_Array
) {
1131 $root = $root->value
;
1133 if ( !is_array( $root ) ) {
1134 $root = array( $root );
1136 foreach ( $root as $node ) {
1145 return new PPNode_Hash_Array( $out );
1149 * Virtual implode with brackets
1151 function virtualBracketedImplode( $start, $sep, $end /*, ... */ ) {
1152 $args = array_slice( func_get_args(), 3 );
1153 $out = array( $start );
1156 foreach ( $args as $root ) {
1157 if ( $root instanceof PPNode_Hash_Array
) {
1158 $root = $root->value
;
1160 if ( !is_array( $root ) ) {
1161 $root = array( $root );
1163 foreach ( $root as $node ) {
1173 return new PPNode_Hash_Array( $out );
1176 function __toString() {
1180 function getPDBK( $level = false ) {
1181 if ( $level === false ) {
1182 return $this->title
->getPrefixedDBkey();
1184 return isset( $this->titleCache
[$level] ) ?
$this->titleCache
[$level] : false;
1188 function getArguments() {
1192 function getNumberedArguments() {
1196 function getNamedArguments() {
1201 * Returns true if there are no arguments in this frame
1203 function isEmpty() {
1207 function getArgument( $name ) {
1212 * Returns true if the infinite loop check is OK, false if a loop is detected
1214 * @param $title Title
1216 function loopCheck( $title ) {
1217 return !isset( $this->loopCheckHash
[$title->getPrefixedDBkey()] );
1221 * Return true if the frame is a template frame
1223 function isTemplate() {
1229 * Expansion frame with template arguments
1232 class PPTemplateFrame_Hash
extends PPFrame_Hash
{
1233 var $numberedArgs, $namedArgs, $parent;
1234 var $numberedExpansionCache, $namedExpansionCache;
1236 function __construct( $preprocessor, $parent = false, $numberedArgs = array(), $namedArgs = array(), $title = false ) {
1237 parent
::__construct( $preprocessor );
1239 $this->parent
= $parent;
1240 $this->numberedArgs
= $numberedArgs;
1241 $this->namedArgs
= $namedArgs;
1242 $this->title
= $title;
1243 $pdbk = $title ?
$title->getPrefixedDBkey() : false;
1244 $this->titleCache
= $parent->titleCache
;
1245 $this->titleCache
[] = $pdbk;
1246 $this->loopCheckHash
= /*clone*/ $parent->loopCheckHash
;
1247 if ( $pdbk !== false ) {
1248 $this->loopCheckHash
[$pdbk] = true;
1250 $this->depth
= $parent->depth +
1;
1251 $this->numberedExpansionCache
= $this->namedExpansionCache
= array();
1254 function __toString() {
1257 $args = $this->numberedArgs +
$this->namedArgs
;
1258 foreach ( $args as $name => $value ) {
1264 $s .= "\"$name\":\"" .
1265 str_replace( '"', '\\"', $value->__toString() ) . '"';
1271 * Returns true if there are no arguments in this frame
1273 function isEmpty() {
1274 return !count( $this->numberedArgs
) && !count( $this->namedArgs
);
1277 function getArguments() {
1278 $arguments = array();
1279 foreach ( array_merge(
1280 array_keys($this->numberedArgs
),
1281 array_keys($this->namedArgs
)) as $key ) {
1282 $arguments[$key] = $this->getArgument($key);
1287 function getNumberedArguments() {
1288 $arguments = array();
1289 foreach ( array_keys($this->numberedArgs
) as $key ) {
1290 $arguments[$key] = $this->getArgument($key);
1295 function getNamedArguments() {
1296 $arguments = array();
1297 foreach ( array_keys($this->namedArgs
) as $key ) {
1298 $arguments[$key] = $this->getArgument($key);
1303 function getNumberedArgument( $index ) {
1304 if ( !isset( $this->numberedArgs
[$index] ) ) {
1307 if ( !isset( $this->numberedExpansionCache
[$index] ) ) {
1308 # No trimming for unnamed arguments
1309 $this->numberedExpansionCache
[$index] = $this->parent
->expand( $this->numberedArgs
[$index], PPFrame
::STRIP_COMMENTS
);
1311 return $this->numberedExpansionCache
[$index];
1314 function getNamedArgument( $name ) {
1315 if ( !isset( $this->namedArgs
[$name] ) ) {
1318 if ( !isset( $this->namedExpansionCache
[$name] ) ) {
1319 # Trim named arguments post-expand, for backwards compatibility
1320 $this->namedExpansionCache
[$name] = trim(
1321 $this->parent
->expand( $this->namedArgs
[$name], PPFrame
::STRIP_COMMENTS
) );
1323 return $this->namedExpansionCache
[$name];
1326 function getArgument( $name ) {
1327 $text = $this->getNumberedArgument( $name );
1328 if ( $text === false ) {
1329 $text = $this->getNamedArgument( $name );
1335 * Return true if the frame is a template frame
1337 function isTemplate() {
1343 * Expansion frame with custom arguments
1346 class PPCustomFrame_Hash
extends PPFrame_Hash
{
1349 function __construct( $preprocessor, $args ) {
1350 parent
::__construct( $preprocessor );
1351 $this->args
= $args;
1354 function __toString() {
1357 foreach ( $this->args
as $name => $value ) {
1363 $s .= "\"$name\":\"" .
1364 str_replace( '"', '\\"', $value->__toString() ) . '"';
1370 function isEmpty() {
1371 return !count( $this->args
);
1374 function getArgument( $index ) {
1375 if ( !isset( $this->args
[$index] ) ) {
1378 return $this->args
[$index];
1385 class PPNode_Hash_Tree
implements PPNode
{
1386 var $name, $firstChild, $lastChild, $nextSibling;
1388 function __construct( $name ) {
1389 $this->name
= $name;
1390 $this->firstChild
= $this->lastChild
= $this->nextSibling
= false;
1393 function __toString() {
1396 for ( $node = $this->firstChild
; $node; $node = $node->nextSibling
) {
1397 if ( $node instanceof PPNode_Hash_Attr
) {
1398 $attribs .= ' ' . $node->name
. '="' . htmlspecialchars( $node->value
) . '"';
1400 $inner .= $node->__toString();
1403 if ( $inner === '' ) {
1404 return "<{$this->name}$attribs/>";
1406 return "<{$this->name}$attribs>$inner</{$this->name}>";
1410 static function newWithText( $name, $text ) {
1411 $obj = new self( $name );
1412 $obj->addChild( new PPNode_Hash_Text( $text ) );
1416 function addChild( $node ) {
1417 if ( $this->lastChild
=== false ) {
1418 $this->firstChild
= $this->lastChild
= $node;
1420 $this->lastChild
->nextSibling
= $node;
1421 $this->lastChild
= $node;
1425 function getChildren() {
1426 $children = array();
1427 for ( $child = $this->firstChild
; $child; $child = $child->nextSibling
) {
1428 $children[] = $child;
1430 return new PPNode_Hash_Array( $children );
1433 function getFirstChild() {
1434 return $this->firstChild
;
1437 function getNextSibling() {
1438 return $this->nextSibling
;
1441 function getChildrenOfType( $name ) {
1442 $children = array();
1443 for ( $child = $this->firstChild
; $child; $child = $child->nextSibling
) {
1444 if ( isset( $child->name
) && $child->name
=== $name ) {
1445 $children[] = $name;
1451 function getLength() { return false; }
1452 function item( $i ) { return false; }
1454 function getName() {
1459 * Split a <part> node into an associative array containing:
1461 * index String index
1462 * value PPNode value
1464 function splitArg() {
1466 for ( $child = $this->firstChild
; $child; $child = $child->nextSibling
) {
1467 if ( !isset( $child->name
) ) {
1470 if ( $child->name
=== 'name' ) {
1471 $bits['name'] = $child;
1472 if ( $child->firstChild
instanceof PPNode_Hash_Attr
1473 && $child->firstChild
->name
=== 'index' )
1475 $bits['index'] = $child->firstChild
->value
;
1477 } elseif ( $child->name
=== 'value' ) {
1478 $bits['value'] = $child;
1482 if ( !isset( $bits['name'] ) ) {
1483 throw new MWException( 'Invalid brace node passed to ' . __METHOD__
);
1485 if ( !isset( $bits['index'] ) ) {
1486 $bits['index'] = '';
1492 * Split an <ext> node into an associative array containing name, attr, inner and close
1493 * All values in the resulting array are PPNodes. Inner and close are optional.
1495 function splitExt() {
1497 for ( $child = $this->firstChild
; $child; $child = $child->nextSibling
) {
1498 if ( !isset( $child->name
) ) {
1501 if ( $child->name
== 'name' ) {
1502 $bits['name'] = $child;
1503 } elseif ( $child->name
== 'attr' ) {
1504 $bits['attr'] = $child;
1505 } elseif ( $child->name
== 'inner' ) {
1506 $bits['inner'] = $child;
1507 } elseif ( $child->name
== 'close' ) {
1508 $bits['close'] = $child;
1511 if ( !isset( $bits['name'] ) ) {
1512 throw new MWException( 'Invalid ext node passed to ' . __METHOD__
);
1520 function splitHeading() {
1521 if ( $this->name
!== 'h' ) {
1522 throw new MWException( 'Invalid h node passed to ' . __METHOD__
);
1525 for ( $child = $this->firstChild
; $child; $child = $child->nextSibling
) {
1526 if ( !isset( $child->name
) ) {
1529 if ( $child->name
== 'i' ) {
1530 $bits['i'] = $child->value
;
1531 } elseif ( $child->name
== 'level' ) {
1532 $bits['level'] = $child->value
;
1535 if ( !isset( $bits['i'] ) ) {
1536 throw new MWException( 'Invalid h node passed to ' . __METHOD__
);
1542 * Split a <template> or <tplarg> node
1544 function splitTemplate() {
1546 $bits = array( 'lineStart' => '' );
1547 for ( $child = $this->firstChild
; $child; $child = $child->nextSibling
) {
1548 if ( !isset( $child->name
) ) {
1551 if ( $child->name
== 'title' ) {
1552 $bits['title'] = $child;
1554 if ( $child->name
== 'part' ) {
1557 if ( $child->name
== 'lineStart' ) {
1558 $bits['lineStart'] = '1';
1561 if ( !isset( $bits['title'] ) ) {
1562 throw new MWException( 'Invalid node passed to ' . __METHOD__
);
1564 $bits['parts'] = new PPNode_Hash_Array( $parts );
1572 class PPNode_Hash_Text
implements PPNode
{
1573 var $value, $nextSibling;
1575 function __construct( $value ) {
1576 if ( is_object( $value ) ) {
1577 throw new MWException( __CLASS__
. ' given object instead of string' );
1579 $this->value
= $value;
1582 function __toString() {
1583 return htmlspecialchars( $this->value
);
1586 function getNextSibling() {
1587 return $this->nextSibling
;
1590 function getChildren() { return false; }
1591 function getFirstChild() { return false; }
1592 function getChildrenOfType( $name ) { return false; }
1593 function getLength() { return false; }
1594 function item( $i ) { return false; }
1595 function getName() { return '#text'; }
1596 function splitArg() { throw new MWException( __METHOD__
. ': not supported' ); }
1597 function splitExt() { throw new MWException( __METHOD__
. ': not supported' ); }
1598 function splitHeading() { throw new MWException( __METHOD__
. ': not supported' ); }
1604 class PPNode_Hash_Array
implements PPNode
{
1605 var $value, $nextSibling;
1607 function __construct( $value ) {
1608 $this->value
= $value;
1611 function __toString() {
1612 return var_export( $this, true );
1615 function getLength() {
1616 return count( $this->value
);
1619 function item( $i ) {
1620 return $this->value
[$i];
1623 function getName() { return '#nodelist'; }
1625 function getNextSibling() {
1626 return $this->nextSibling
;
1629 function getChildren() { return false; }
1630 function getFirstChild() { return false; }
1631 function getChildrenOfType( $name ) { return false; }
1632 function splitArg() { throw new MWException( __METHOD__
. ': not supported' ); }
1633 function splitExt() { throw new MWException( __METHOD__
. ': not supported' ); }
1634 function splitHeading() { throw new MWException( __METHOD__
. ': not supported' ); }
1640 class PPNode_Hash_Attr
implements PPNode
{
1641 var $name, $value, $nextSibling;
1643 function __construct( $name, $value ) {
1644 $this->name
= $name;
1645 $this->value
= $value;
1648 function __toString() {
1649 return "<@{$this->name}>" . htmlspecialchars( $this->value
) . "</@{$this->name}>";
1652 function getName() {
1656 function getNextSibling() {
1657 return $this->nextSibling
;
1660 function getChildren() { return false; }
1661 function getFirstChild() { return false; }
1662 function getChildrenOfType( $name ) { return false; }
1663 function getLength() { return false; }
1664 function item( $i ) { return false; }
1665 function splitArg() { throw new MWException( __METHOD__
. ': not supported' ); }
1666 function splitExt() { throw new MWException( __METHOD__
. ': not supported' ); }
1667 function splitHeading() { throw new MWException( __METHOD__
. ': not supported' ); }