3 * Preprocessor using PHP arrays
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * Differences from DOM schema:
26 * * attribute nodes are children
27 * * "<h>" nodes that aren't at the top are replaced with <possible-h>
29 * @codingStandardsIgnoreStart
31 class Preprocessor_Hash
implements Preprocessor
{
32 // @codingStandardsIgnoreEnd
39 const CACHE_VERSION
= 1;
41 public function __construct( $parser ) {
42 $this->parser
= $parser;
46 * @return PPFrame_Hash
48 public function newFrame() {
49 return new PPFrame_Hash( $this );
54 * @return PPCustomFrame_Hash
56 public function newCustomFrame( $args ) {
57 return new PPCustomFrame_Hash( $this, $args );
61 * @param array $values
62 * @return PPNode_Hash_Array
64 public function newPartNodeArray( $values ) {
67 foreach ( $values as $k => $val ) {
68 $partNode = new PPNode_Hash_Tree( 'part' );
69 $nameNode = new PPNode_Hash_Tree( 'name' );
72 $nameNode->addChild( new PPNode_Hash_Attr( 'index', $k ) );
73 $partNode->addChild( $nameNode );
75 $nameNode->addChild( new PPNode_Hash_Text( $k ) );
76 $partNode->addChild( $nameNode );
77 $partNode->addChild( new PPNode_Hash_Text( '=' ) );
80 $valueNode = new PPNode_Hash_Tree( 'value' );
81 $valueNode->addChild( new PPNode_Hash_Text( $val ) );
82 $partNode->addChild( $valueNode );
87 $node = new PPNode_Hash_Array( $list );
92 * Preprocess some wikitext and return the document tree.
93 * This is the ghost of Parser::replace_variables().
95 * @param string $text The text to parse
96 * @param int $flags Bitwise combination of:
97 * Parser::PTD_FOR_INCLUSION Handle "<noinclude>" and "<includeonly>" as if the text is being
98 * included. Default is to assume a direct page view.
100 * The generated DOM tree must depend only on the input text and the flags.
101 * The DOM tree must be the same in OT_HTML and OT_WIKI mode, to avoid a regression of bug 4899.
103 * Any flag added to the $flags parameter here, or any other parameter liable to cause a
104 * change in the DOM tree for a given text, must be passed through the section identifier
105 * in the section edit link and thus back to extractSections().
107 * The output of this function is currently only cached in process memory, but a persistent
108 * cache may be implemented at a later date which takes further advantage of these strict
109 * dependency requirements.
111 * @throws MWException
112 * @return PPNode_Hash_Tree
114 public function preprocessToObj( $text, $flags = 0 ) {
116 global $wgMemc, $wgPreprocessorCacheThreshold;
118 $cacheable = $wgPreprocessorCacheThreshold !== false
119 && strlen( $text ) > $wgPreprocessorCacheThreshold;
122 $cacheKey = wfMemcKey( 'preprocess-hash', md5( $text ), $flags );
123 $cacheValue = $wgMemc->get( $cacheKey );
125 $version = substr( $cacheValue, 0, 8 );
126 if ( intval( $version ) == self
::CACHE_VERSION
) {
127 $hash = unserialize( substr( $cacheValue, 8 ) );
129 wfDebugLog( "Preprocessor",
130 "Loaded preprocessor hash from memcached (key $cacheKey)" );
148 'names' => array( 2 => null ),
154 $forInclusion = $flags & Parser
::PTD_FOR_INCLUSION
;
156 $xmlishElements = $this->parser
->getStripList();
157 $enableOnlyinclude = false;
158 if ( $forInclusion ) {
159 $ignoredTags = array( 'includeonly', '/includeonly' );
160 $ignoredElements = array( 'noinclude' );
161 $xmlishElements[] = 'noinclude';
162 if ( strpos( $text, '<onlyinclude>' ) !== false
163 && strpos( $text, '</onlyinclude>' ) !== false
165 $enableOnlyinclude = true;
168 $ignoredTags = array( 'noinclude', '/noinclude', 'onlyinclude', '/onlyinclude' );
169 $ignoredElements = array( 'includeonly' );
170 $xmlishElements[] = 'includeonly';
172 $xmlishRegex = implode( '|', array_merge( $xmlishElements, $ignoredTags ) );
174 // Use "A" modifier (anchored) instead of "^", because ^ doesn't work with an offset
175 $elementsRegex = "~($xmlishRegex)(?:\s|\/>|>)|(!--)~iA";
177 $stack = new PPDStack_Hash
;
179 $searchBase = "[{<\n";
180 // For fast reverse searches
181 $revText = strrev( $text );
182 $lengthText = strlen( $text );
184 // Input pointer, starts out pointing to a pseudo-newline before the start
186 // Current accumulator
187 $accum =& $stack->getAccum();
188 // True to find equals signs in arguments
190 // True to take notice of pipe characters
193 // True if $i is inside a possible heading
195 // True if there are no more greater-than (>) signs right of $i
197 // True to ignore all input up to the next <onlyinclude>
198 $findOnlyinclude = $enableOnlyinclude;
199 // Do a line-start run without outputting an LF character
200 $fakeLineStart = true;
205 if ( $findOnlyinclude ) {
206 // Ignore all input up to the next <onlyinclude>
207 $startPos = strpos( $text, '<onlyinclude>', $i );
208 if ( $startPos === false ) {
209 // Ignored section runs to the end
210 $accum->addNodeWithText( 'ignore', substr( $text, $i ) );
213 $tagEndPos = $startPos +
strlen( '<onlyinclude>' ); // past-the-end
214 $accum->addNodeWithText( 'ignore', substr( $text, $i, $tagEndPos - $i ) );
216 $findOnlyinclude = false;
219 if ( $fakeLineStart ) {
220 $found = 'line-start';
223 # Find next opening brace, closing brace or pipe
224 $search = $searchBase;
225 if ( $stack->top
=== false ) {
226 $currentClosing = '';
228 $currentClosing = $stack->top
->close
;
229 $search .= $currentClosing;
235 // First equals will be for the template
239 # Output literal section, advance input counter
240 $literalLength = strcspn( $text, $search, $i );
241 if ( $literalLength > 0 ) {
242 $accum->addLiteral( substr( $text, $i, $literalLength ) );
243 $i +
= $literalLength;
245 if ( $i >= $lengthText ) {
246 if ( $currentClosing == "\n" ) {
247 // Do a past-the-end run to finish off the heading
255 $curChar = $text[$i];
256 if ( $curChar == '|' ) {
258 } elseif ( $curChar == '=' ) {
260 } elseif ( $curChar == '<' ) {
262 } elseif ( $curChar == "\n" ) {
266 $found = 'line-start';
268 } elseif ( $curChar == $currentClosing ) {
270 } elseif ( isset( $rules[$curChar] ) ) {
272 $rule = $rules[$curChar];
274 # Some versions of PHP have a strcspn which stops on null characters
275 # Ignore and continue
282 if ( $found == 'angle' ) {
284 // Handle </onlyinclude>
285 if ( $enableOnlyinclude
286 && substr( $text, $i, strlen( '</onlyinclude>' ) ) == '</onlyinclude>'
288 $findOnlyinclude = true;
292 // Determine element name
293 if ( !preg_match( $elementsRegex, $text, $matches, 0, $i +
1 ) ) {
294 // Element name missing or not listed
295 $accum->addLiteral( '<' );
300 if ( isset( $matches[2] ) && $matches[2] == '!--' ) {
302 // To avoid leaving blank lines, when a sequence of
303 // space-separated comments is both preceded and followed by
304 // a newline (ignoring spaces), then
305 // trim leading and trailing spaces and the trailing newline.
308 $endPos = strpos( $text, '-->', $i +
4 );
309 if ( $endPos === false ) {
310 // Unclosed comment in input, runs to end
311 $inner = substr( $text, $i );
312 $accum->addNodeWithText( 'comment', $inner );
315 // Search backwards for leading whitespace
316 $wsStart = $i ?
( $i - strspn( $revText, " \t", $lengthText - $i ) ) : 0;
318 // Search forwards for trailing whitespace
319 // $wsEnd will be the position of the last space (or the '>' if there's none)
320 $wsEnd = $endPos +
2 +
strspn( $text, " \t", $endPos +
3 );
322 // Keep looking forward as long as we're finding more
324 $comments = array( array( $wsStart, $wsEnd ) );
325 while ( substr( $text, $wsEnd +
1, 4 ) == '<!--' ) {
326 $c = strpos( $text, '-->', $wsEnd +
4 );
327 if ( $c === false ) {
330 $c = $c +
2 +
strspn( $text, " \t", $c +
3 );
331 $comments[] = array( $wsEnd +
1, $c );
335 // Eat the line if possible
336 // TODO: This could theoretically be done if $wsStart == 0, i.e. for comments at
337 // the overall start. That's not how Sanitizer::removeHTMLcomments() did it, but
338 // it's a possible beneficial b/c break.
339 if ( $wsStart > 0 && substr( $text, $wsStart - 1, 1 ) == "\n"
340 && substr( $text, $wsEnd +
1, 1 ) == "\n"
342 // Remove leading whitespace from the end of the accumulator
343 // Sanity check first though
344 $wsLength = $i - $wsStart;
346 && $accum->lastNode
instanceof PPNode_Hash_Text
347 && strspn( $accum->lastNode
->value
, " \t", -$wsLength ) === $wsLength
349 $accum->lastNode
->value
= substr( $accum->lastNode
->value
, 0, -$wsLength );
352 // Dump all but the last comment to the accumulator
353 foreach ( $comments as $j => $com ) {
355 $endPos = $com[1] +
1;
356 if ( $j == ( count( $comments ) - 1 ) ) {
359 $inner = substr( $text, $startPos, $endPos - $startPos );
360 $accum->addNodeWithText( 'comment', $inner );
363 // Do a line-start run next time to look for headings after the comment
364 $fakeLineStart = true;
366 // No line to eat, just take the comment itself
372 $part = $stack->top
->getCurrentPart();
373 if ( !( isset( $part->commentEnd
) && $part->commentEnd
== $wsStart - 1 ) ) {
374 $part->visualEnd
= $wsStart;
376 // Else comments abutting, no change in visual end
377 $part->commentEnd
= $endPos;
380 $inner = substr( $text, $startPos, $endPos - $startPos +
1 );
381 $accum->addNodeWithText( 'comment', $inner );
386 $lowerName = strtolower( $name );
387 $attrStart = $i +
strlen( $name ) +
1;
390 $tagEndPos = $noMoreGT ?
false : strpos( $text, '>', $attrStart );
391 if ( $tagEndPos === false ) {
392 // Infinite backtrack
393 // Disable tag search to prevent worst-case O(N^2) performance
395 $accum->addLiteral( '<' );
400 // Handle ignored tags
401 if ( in_array( $lowerName, $ignoredTags ) ) {
402 $accum->addNodeWithText( 'ignore', substr( $text, $i, $tagEndPos - $i +
1 ) );
408 if ( $text[$tagEndPos - 1] == '/' ) {
410 $attrEnd = $tagEndPos - 1;
415 $attrEnd = $tagEndPos;
417 if ( preg_match( "/<\/" . preg_quote( $name, '/' ) . "\s*>/i",
418 $text, $matches, PREG_OFFSET_CAPTURE
, $tagEndPos +
1 )
420 $inner = substr( $text, $tagEndPos +
1, $matches[0][1] - $tagEndPos - 1 );
421 $i = $matches[0][1] +
strlen( $matches[0][0] );
422 $close = $matches[0][0];
424 // No end tag -- let it run out to the end of the text.
425 $inner = substr( $text, $tagEndPos +
1 );
430 // <includeonly> and <noinclude> just become <ignore> tags
431 if ( in_array( $lowerName, $ignoredElements ) ) {
432 $accum->addNodeWithText( 'ignore', substr( $text, $tagStartPos, $i - $tagStartPos ) );
436 if ( $attrEnd <= $attrStart ) {
439 // Note that the attr element contains the whitespace between name and attribute,
440 // this is necessary for precise reconstruction during pre-save transform.
441 $attr = substr( $text, $attrStart, $attrEnd - $attrStart );
444 $extNode = new PPNode_Hash_Tree( 'ext' );
445 $extNode->addChild( PPNode_Hash_Tree
::newWithText( 'name', $name ) );
446 $extNode->addChild( PPNode_Hash_Tree
::newWithText( 'attr', $attr ) );
447 if ( $inner !== null ) {
448 $extNode->addChild( PPNode_Hash_Tree
::newWithText( 'inner', $inner ) );
450 if ( $close !== null ) {
451 $extNode->addChild( PPNode_Hash_Tree
::newWithText( 'close', $close ) );
453 $accum->addNode( $extNode );
454 } elseif ( $found == 'line-start' ) {
455 // Is this the start of a heading?
456 // Line break belongs before the heading element in any case
457 if ( $fakeLineStart ) {
458 $fakeLineStart = false;
460 $accum->addLiteral( $curChar );
464 $count = strspn( $text, '=', $i, 6 );
465 if ( $count == 1 && $findEquals ) {
466 // DWIM: This looks kind of like a name/value separator.
467 // Let's let the equals handler have it and break the potential
468 // heading. This is heuristic, but AFAICT the methods for
469 // completely correct disambiguation are very complex.
470 } elseif ( $count > 0 ) {
474 'parts' => array( new PPDPart_Hash( str_repeat( '=', $count ) ) ),
477 $stack->push( $piece );
478 $accum =& $stack->getAccum();
479 extract( $stack->getFlags() );
482 } elseif ( $found == 'line-end' ) {
483 $piece = $stack->top
;
484 // A heading must be open, otherwise \n wouldn't have been in the search list
485 assert( '$piece->open == "\n"' );
486 $part = $piece->getCurrentPart();
487 // Search back through the input to see if it has a proper close.
488 // Do this using the reversed string since the other solutions
489 // (end anchor, etc.) are inefficient.
490 $wsLength = strspn( $revText, " \t", $lengthText - $i );
491 $searchStart = $i - $wsLength;
492 if ( isset( $part->commentEnd
) && $searchStart - 1 == $part->commentEnd
) {
493 // Comment found at line end
494 // Search for equals signs before the comment
495 $searchStart = $part->visualEnd
;
496 $searchStart -= strspn( $revText, " \t", $lengthText - $searchStart );
498 $count = $piece->count
;
499 $equalsLength = strspn( $revText, '=', $lengthText - $searchStart );
500 if ( $equalsLength > 0 ) {
501 if ( $searchStart - $equalsLength == $piece->startPos
) {
502 // This is just a single string of equals signs on its own line
503 // Replicate the doHeadings behavior /={count}(.+)={count}/
504 // First find out how many equals signs there really are (don't stop at 6)
505 $count = $equalsLength;
509 $count = min( 6, intval( ( $count - 1 ) / 2 ) );
512 $count = min( $equalsLength, $count );
515 // Normal match, output <h>
516 $element = new PPNode_Hash_Tree( 'possible-h' );
517 $element->addChild( new PPNode_Hash_Attr( 'level', $count ) );
518 $element->addChild( new PPNode_Hash_Attr( 'i', $headingIndex++
) );
519 $element->lastChild
->nextSibling
= $accum->firstNode
;
520 $element->lastChild
= $accum->lastNode
;
522 // Single equals sign on its own line, count=0
526 // No match, no <h>, just pass down the inner text
531 $accum =& $stack->getAccum();
532 extract( $stack->getFlags() );
534 // Append the result to the enclosing accumulator
535 if ( $element instanceof PPNode
) {
536 $accum->addNode( $element );
538 $accum->addAccum( $element );
540 // Note that we do NOT increment the input pointer.
541 // This is because the closing linebreak could be the opening linebreak of
542 // another heading. Infinite loops are avoided because the next iteration MUST
543 // hit the heading open case above, which unconditionally increments the
545 } elseif ( $found == 'open' ) {
546 # count opening brace characters
547 $count = strspn( $text, $curChar, $i );
549 # we need to add to stack only if opening brace count is enough for one of the rules
550 if ( $count >= $rule['min'] ) {
551 # Add it to the stack
554 'close' => $rule['end'],
556 'lineStart' => ( $i > 0 && $text[$i - 1] == "\n" ),
559 $stack->push( $piece );
560 $accum =& $stack->getAccum();
561 extract( $stack->getFlags() );
563 # Add literal brace(s)
564 $accum->addLiteral( str_repeat( $curChar, $count ) );
567 } elseif ( $found == 'close' ) {
568 $piece = $stack->top
;
569 # lets check if there are enough characters for closing brace
570 $maxCount = $piece->count
;
571 $count = strspn( $text, $curChar, $i, $maxCount );
573 # check for maximum matching characters (if there are 5 closing
574 # characters, we will probably need only 3 - depending on the rules)
575 $rule = $rules[$piece->open
];
576 if ( $count > $rule['max'] ) {
577 # The specified maximum exists in the callback array, unless the caller
579 $matchingCount = $rule['max'];
581 # Count is less than the maximum
582 # Skip any gaps in the callback array to find the true largest match
583 # Need to use array_key_exists not isset because the callback can be null
584 $matchingCount = $count;
585 while ( $matchingCount > 0 && !array_key_exists( $matchingCount, $rule['names'] ) ) {
590 if ( $matchingCount <= 0 ) {
591 # No matching element found in callback array
592 # Output a literal closing brace and continue
593 $accum->addLiteral( str_repeat( $curChar, $count ) );
597 $name = $rule['names'][$matchingCount];
598 if ( $name === null ) {
599 // No element, just literal text
600 $element = $piece->breakSyntax( $matchingCount );
601 $element->addLiteral( str_repeat( $rule['end'], $matchingCount ) );
604 # Note: $parts is already XML, does not need to be encoded further
605 $parts = $piece->parts
;
606 $titleAccum = $parts[0]->out
;
609 $element = new PPNode_Hash_Tree( $name );
611 # The invocation is at the start of the line if lineStart is set in
612 # the stack, and all opening brackets are used up.
613 if ( $maxCount == $matchingCount && !empty( $piece->lineStart
) ) {
614 $element->addChild( new PPNode_Hash_Attr( 'lineStart', 1 ) );
616 $titleNode = new PPNode_Hash_Tree( 'title' );
617 $titleNode->firstChild
= $titleAccum->firstNode
;
618 $titleNode->lastChild
= $titleAccum->lastNode
;
619 $element->addChild( $titleNode );
621 foreach ( $parts as $part ) {
622 if ( isset( $part->eqpos
) ) {
625 for ( $node = $part->out
->firstNode
; $node; $node = $node->nextSibling
) {
626 if ( $node === $part->eqpos
) {
634 throw new MWException( __METHOD__
. ': eqpos not found' );
636 if ( $node->name
!== 'equals' ) {
639 throw new MWException( __METHOD__
. ': eqpos is not equals' );
643 // Construct name node
644 $nameNode = new PPNode_Hash_Tree( 'name' );
645 if ( $lastNode !== false ) {
646 $lastNode->nextSibling
= false;
647 $nameNode->firstChild
= $part->out
->firstNode
;
648 $nameNode->lastChild
= $lastNode;
651 // Construct value node
652 $valueNode = new PPNode_Hash_Tree( 'value' );
653 if ( $equalsNode->nextSibling
!== false ) {
654 $valueNode->firstChild
= $equalsNode->nextSibling
;
655 $valueNode->lastChild
= $part->out
->lastNode
;
657 $partNode = new PPNode_Hash_Tree( 'part' );
658 $partNode->addChild( $nameNode );
659 $partNode->addChild( $equalsNode->firstChild
);
660 $partNode->addChild( $valueNode );
661 $element->addChild( $partNode );
663 $partNode = new PPNode_Hash_Tree( 'part' );
664 $nameNode = new PPNode_Hash_Tree( 'name' );
665 $nameNode->addChild( new PPNode_Hash_Attr( 'index', $argIndex++
) );
666 $valueNode = new PPNode_Hash_Tree( 'value' );
667 $valueNode->firstChild
= $part->out
->firstNode
;
668 $valueNode->lastChild
= $part->out
->lastNode
;
669 $partNode->addChild( $nameNode );
670 $partNode->addChild( $valueNode );
671 $element->addChild( $partNode );
676 # Advance input pointer
677 $i +
= $matchingCount;
681 $accum =& $stack->getAccum();
683 # Re-add the old stack element if it still has unmatched opening characters remaining
684 if ( $matchingCount < $piece->count
) {
685 $piece->parts
= array( new PPDPart_Hash
);
686 $piece->count
-= $matchingCount;
687 # do we still qualify for any callback with remaining count?
688 $min = $rules[$piece->open
]['min'];
689 if ( $piece->count
>= $min ) {
690 $stack->push( $piece );
691 $accum =& $stack->getAccum();
693 $accum->addLiteral( str_repeat( $piece->open
, $piece->count
) );
697 extract( $stack->getFlags() );
699 # Add XML element to the enclosing accumulator
700 if ( $element instanceof PPNode
) {
701 $accum->addNode( $element );
703 $accum->addAccum( $element );
705 } elseif ( $found == 'pipe' ) {
706 $findEquals = true; // shortcut for getFlags()
708 $accum =& $stack->getAccum();
710 } elseif ( $found == 'equals' ) {
711 $findEquals = false; // shortcut for getFlags()
712 $accum->addNodeWithText( 'equals', '=' );
713 $stack->getCurrentPart()->eqpos
= $accum->lastNode
;
718 # Output any remaining unclosed brackets
719 foreach ( $stack->stack
as $piece ) {
720 $stack->rootAccum
->addAccum( $piece->breakSyntax() );
723 # Enable top-level headings
724 for ( $node = $stack->rootAccum
->firstNode
; $node; $node = $node->nextSibling
) {
725 if ( isset( $node->name
) && $node->name
=== 'possible-h' ) {
730 $rootNode = new PPNode_Hash_Tree( 'root' );
731 $rootNode->firstChild
= $stack->rootAccum
->firstNode
;
732 $rootNode->lastChild
= $stack->rootAccum
->lastNode
;
736 $cacheValue = sprintf( "%08d", self
::CACHE_VERSION
) . serialize( $rootNode );
738 // T111289: Cache values should not exceed 1 Mb, but they do.
739 if ( strlen( $cacheValue ) <= 1e6
) {
740 $wgMemc->set( $cacheKey, $cacheValue, 86400 );
741 wfDebugLog( "Preprocessor", "Saved preprocessor Hash to memcached (key $cacheKey)" );
750 * Stack class to help Preprocessor::preprocessToObj()
752 * @codingStandardsIgnoreStart
754 class PPDStack_Hash
extends PPDStack
{
755 // @codingStandardsIgnoreEnd
757 public function __construct() {
758 $this->elementClass
= 'PPDStackElement_Hash';
759 parent
::__construct();
760 $this->rootAccum
= new PPDAccum_Hash
;
766 * @codingStandardsIgnoreStart
768 class PPDStackElement_Hash
extends PPDStackElement
{
769 // @codingStandardsIgnoreENd
771 public function __construct( $data = array() ) {
772 $this->partClass
= 'PPDPart_Hash';
773 parent
::__construct( $data );
777 * Get the accumulator that would result if the close is not found.
779 * @param int|bool $openingCount
780 * @return PPDAccum_Hash
782 public function breakSyntax( $openingCount = false ) {
783 if ( $this->open
== "\n" ) {
784 $accum = $this->parts
[0]->out
;
786 if ( $openingCount === false ) {
787 $openingCount = $this->count
;
789 $accum = new PPDAccum_Hash
;
790 $accum->addLiteral( str_repeat( $this->open
, $openingCount ) );
792 foreach ( $this->parts
as $part ) {
796 $accum->addLiteral( '|' );
798 $accum->addAccum( $part->out
);
807 * @codingStandardsIgnoreStart
809 class PPDPart_Hash
extends PPDPart
{
810 // @codingStandardsIgnoreEnd
812 public function __construct( $out = '' ) {
813 $accum = new PPDAccum_Hash
;
815 $accum->addLiteral( $out );
817 parent
::__construct( $accum );
823 * @codingStandardsIgnoreStart
825 class PPDAccum_Hash
{
826 // @codingStandardsIgnoreEnd
828 public $firstNode, $lastNode;
830 public function __construct() {
831 $this->firstNode
= $this->lastNode
= false;
835 * Append a string literal
838 public function addLiteral( $s ) {
839 if ( $this->lastNode
=== false ) {
840 $this->firstNode
= $this->lastNode
= new PPNode_Hash_Text( $s );
841 } elseif ( $this->lastNode
instanceof PPNode_Hash_Text
) {
842 $this->lastNode
->value
.= $s;
844 $this->lastNode
->nextSibling
= new PPNode_Hash_Text( $s );
845 $this->lastNode
= $this->lastNode
->nextSibling
;
851 * @param PPNode $node
853 public function addNode( PPNode
$node ) {
854 if ( $this->lastNode
=== false ) {
855 $this->firstNode
= $this->lastNode
= $node;
857 $this->lastNode
->nextSibling
= $node;
858 $this->lastNode
= $node;
863 * Append a tree node with text contents
864 * @param string $name
865 * @param string $value
867 public function addNodeWithText( $name, $value ) {
868 $node = PPNode_Hash_Tree
::newWithText( $name, $value );
869 $this->addNode( $node );
873 * Append a PPDAccum_Hash
874 * Takes over ownership of the nodes in the source argument. These nodes may
875 * subsequently be modified, especially nextSibling.
876 * @param PPDAccum_Hash $accum
878 public function addAccum( $accum ) {
879 if ( $accum->lastNode
=== false ) {
881 } elseif ( $this->lastNode
=== false ) {
882 $this->firstNode
= $accum->firstNode
;
883 $this->lastNode
= $accum->lastNode
;
885 $this->lastNode
->nextSibling
= $accum->firstNode
;
886 $this->lastNode
= $accum->lastNode
;
892 * An expansion frame, used as a context to expand the result of preprocessToObj()
894 * @codingStandardsIgnoreStart
896 class PPFrame_Hash
implements PPFrame
{
897 // @codingStandardsIgnoreEnd
907 public $preprocessor;
916 * Hashtable listing templates which are disallowed for expansion in this frame,
917 * having been encountered previously in parent frames.
919 public $loopCheckHash;
922 * Recursion depth of this frame, top = 0
923 * Note that this is NOT the same as expansion depth in expand()
927 private $volatile = false;
933 protected $childExpansionCache;
936 * Construct a new preprocessor frame.
937 * @param Preprocessor $preprocessor The parent preprocessor
939 public function __construct( $preprocessor ) {
940 $this->preprocessor
= $preprocessor;
941 $this->parser
= $preprocessor->parser
;
942 $this->title
= $this->parser
->mTitle
;
943 $this->titleCache
= array( $this->title ?
$this->title
->getPrefixedDBkey() : false );
944 $this->loopCheckHash
= array();
946 $this->childExpansionCache
= array();
950 * Create a new child frame
951 * $args is optionally a multi-root PPNode or array containing the template arguments
953 * @param array|bool|PPNode_Hash_Array $args
954 * @param Title|bool $title
955 * @param int $indexOffset
956 * @throws MWException
957 * @return PPTemplateFrame_Hash
959 public function newChild( $args = false, $title = false, $indexOffset = 0 ) {
960 $namedArgs = array();
961 $numberedArgs = array();
962 if ( $title === false ) {
963 $title = $this->title
;
965 if ( $args !== false ) {
966 if ( $args instanceof PPNode_Hash_Array
) {
967 $args = $args->value
;
968 } elseif ( !is_array( $args ) ) {
969 throw new MWException( __METHOD__
. ': $args must be array or PPNode_Hash_Array' );
971 foreach ( $args as $arg ) {
972 $bits = $arg->splitArg();
973 if ( $bits['index'] !== '' ) {
974 // Numbered parameter
975 $index = $bits['index'] - $indexOffset;
976 if ( isset( $namedArgs[$index] ) ||
isset( $numberedArgs[$index] ) ) {
977 $this->parser
->getOutput()->addWarning( wfMessage( 'duplicate-args-warning',
978 wfEscapeWikiText( $this->title
),
979 wfEscapeWikiText( $title ),
980 wfEscapeWikiText( $index ) )->text() );
981 $this->parser
->addTrackingCategory( 'duplicate-args-category' );
983 $numberedArgs[$index] = $bits['value'];
984 unset( $namedArgs[$index] );
987 $name = trim( $this->expand( $bits['name'], PPFrame
::STRIP_COMMENTS
) );
988 if ( isset( $namedArgs[$name] ) ||
isset( $numberedArgs[$name] ) ) {
989 $this->parser
->getOutput()->addWarning( wfMessage( 'duplicate-args-warning',
990 wfEscapeWikiText( $this->title
),
991 wfEscapeWikiText( $title ),
992 wfEscapeWikiText( $name ) )->text() );
993 $this->parser
->addTrackingCategory( 'duplicate-args-category' );
995 $namedArgs[$name] = $bits['value'];
996 unset( $numberedArgs[$name] );
1000 return new PPTemplateFrame_Hash( $this->preprocessor
, $this, $numberedArgs, $namedArgs, $title );
1004 * @throws MWException
1005 * @param string|int $key
1006 * @param string|PPNode $root
1010 public function cachedExpand( $key, $root, $flags = 0 ) {
1011 // we don't have a parent, so we don't have a cache
1012 return $this->expand( $root, $flags );
1016 * @throws MWException
1017 * @param string|PPNode $root
1021 public function expand( $root, $flags = 0 ) {
1022 static $expansionDepth = 0;
1023 if ( is_string( $root ) ) {
1027 if ( ++
$this->parser
->mPPNodeCount
> $this->parser
->mOptions
->getMaxPPNodeCount() ) {
1028 $this->parser
->limitationWarn( 'node-count-exceeded',
1029 $this->parser
->mPPNodeCount
,
1030 $this->parser
->mOptions
->getMaxPPNodeCount()
1032 return '<span class="error">Node-count limit exceeded</span>';
1034 if ( $expansionDepth > $this->parser
->mOptions
->getMaxPPExpandDepth() ) {
1035 $this->parser
->limitationWarn( 'expansion-depth-exceeded',
1037 $this->parser
->mOptions
->getMaxPPExpandDepth()
1039 return '<span class="error">Expansion depth limit exceeded</span>';
1042 if ( $expansionDepth > $this->parser
->mHighestExpansionDepth
) {
1043 $this->parser
->mHighestExpansionDepth
= $expansionDepth;
1046 $outStack = array( '', '' );
1047 $iteratorStack = array( false, $root );
1048 $indexStack = array( 0, 0 );
1050 while ( count( $iteratorStack ) > 1 ) {
1051 $level = count( $outStack ) - 1;
1052 $iteratorNode =& $iteratorStack[$level];
1053 $out =& $outStack[$level];
1054 $index =& $indexStack[$level];
1056 if ( is_array( $iteratorNode ) ) {
1057 if ( $index >= count( $iteratorNode ) ) {
1058 // All done with this iterator
1059 $iteratorStack[$level] = false;
1060 $contextNode = false;
1062 $contextNode = $iteratorNode[$index];
1065 } elseif ( $iteratorNode instanceof PPNode_Hash_Array
) {
1066 if ( $index >= $iteratorNode->getLength() ) {
1067 // All done with this iterator
1068 $iteratorStack[$level] = false;
1069 $contextNode = false;
1071 $contextNode = $iteratorNode->item( $index );
1075 // Copy to $contextNode and then delete from iterator stack,
1076 // because this is not an iterator but we do have to execute it once
1077 $contextNode = $iteratorStack[$level];
1078 $iteratorStack[$level] = false;
1081 $newIterator = false;
1083 if ( $contextNode === false ) {
1085 } elseif ( is_string( $contextNode ) ) {
1086 $out .= $contextNode;
1087 } elseif ( is_array( $contextNode ) ||
$contextNode instanceof PPNode_Hash_Array
) {
1088 $newIterator = $contextNode;
1089 } elseif ( $contextNode instanceof PPNode_Hash_Attr
) {
1091 } elseif ( $contextNode instanceof PPNode_Hash_Text
) {
1092 $out .= $contextNode->value
;
1093 } elseif ( $contextNode instanceof PPNode_Hash_Tree
) {
1094 if ( $contextNode->name
== 'template' ) {
1095 # Double-brace expansion
1096 $bits = $contextNode->splitTemplate();
1097 if ( $flags & PPFrame
::NO_TEMPLATES
) {
1098 $newIterator = $this->virtualBracketedImplode(
1104 $ret = $this->parser
->braceSubstitution( $bits, $this );
1105 if ( isset( $ret['object'] ) ) {
1106 $newIterator = $ret['object'];
1108 $out .= $ret['text'];
1111 } elseif ( $contextNode->name
== 'tplarg' ) {
1112 # Triple-brace expansion
1113 $bits = $contextNode->splitTemplate();
1114 if ( $flags & PPFrame
::NO_ARGS
) {
1115 $newIterator = $this->virtualBracketedImplode(
1121 $ret = $this->parser
->argSubstitution( $bits, $this );
1122 if ( isset( $ret['object'] ) ) {
1123 $newIterator = $ret['object'];
1125 $out .= $ret['text'];
1128 } elseif ( $contextNode->name
== 'comment' ) {
1129 # HTML-style comment
1130 # Remove it in HTML, pre+remove and STRIP_COMMENTS modes
1131 # Not in RECOVER_COMMENTS mode (msgnw) though.
1132 if ( ( $this->parser
->ot
['html']
1133 ||
( $this->parser
->ot
['pre'] && $this->parser
->mOptions
->getRemoveComments() )
1134 ||
( $flags & PPFrame
::STRIP_COMMENTS
)
1135 ) && !( $flags & PPFrame
::RECOVER_COMMENTS
)
1138 } elseif ( $this->parser
->ot
['wiki'] && !( $flags & PPFrame
::RECOVER_COMMENTS
) ) {
1139 # Add a strip marker in PST mode so that pstPass2() can
1140 # run some old-fashioned regexes on the result.
1141 # Not in RECOVER_COMMENTS mode (extractSections) though.
1142 $out .= $this->parser
->insertStripItem( $contextNode->firstChild
->value
);
1144 # Recover the literal comment in RECOVER_COMMENTS and pre+no-remove
1145 $out .= $contextNode->firstChild
->value
;
1147 } elseif ( $contextNode->name
== 'ignore' ) {
1148 # Output suppression used by <includeonly> etc.
1149 # OT_WIKI will only respect <ignore> in substed templates.
1150 # The other output types respect it unless NO_IGNORE is set.
1151 # extractSections() sets NO_IGNORE and so never respects it.
1152 if ( ( !isset( $this->parent
) && $this->parser
->ot
['wiki'] )
1153 ||
( $flags & PPFrame
::NO_IGNORE
)
1155 $out .= $contextNode->firstChild
->value
;
1159 } elseif ( $contextNode->name
== 'ext' ) {
1161 $bits = $contextNode->splitExt() +
array( 'attr' => null, 'inner' => null, 'close' => null );
1162 if ( $flags & PPFrame
::NO_TAGS
) {
1163 $s = '<' . $bits['name']->firstChild
->value
;
1164 if ( $bits['attr'] ) {
1165 $s .= $bits['attr']->firstChild
->value
;
1167 if ( $bits['inner'] ) {
1168 $s .= '>' . $bits['inner']->firstChild
->value
;
1169 if ( $bits['close'] ) {
1170 $s .= $bits['close']->firstChild
->value
;
1177 $out .= $this->parser
->extensionSubstitution( $bits, $this );
1179 } elseif ( $contextNode->name
== 'h' ) {
1181 if ( $this->parser
->ot
['html'] ) {
1182 # Expand immediately and insert heading index marker
1184 for ( $node = $contextNode->firstChild
; $node; $node = $node->nextSibling
) {
1185 $s .= $this->expand( $node, $flags );
1188 $bits = $contextNode->splitHeading();
1189 $titleText = $this->title
->getPrefixedDBkey();
1190 $this->parser
->mHeadings
[] = array( $titleText, $bits['i'] );
1191 $serial = count( $this->parser
->mHeadings
) - 1;
1192 $marker = Parser
::MARKER_PREFIX
. "-h-$serial-" . Parser
::MARKER_SUFFIX
;
1193 $s = substr( $s, 0, $bits['level'] ) . $marker . substr( $s, $bits['level'] );
1194 $this->parser
->mStripState
->addGeneral( $marker, '' );
1197 # Expand in virtual stack
1198 $newIterator = $contextNode->getChildren();
1201 # Generic recursive expansion
1202 $newIterator = $contextNode->getChildren();
1205 throw new MWException( __METHOD__
. ': Invalid parameter type' );
1208 if ( $newIterator !== false ) {
1210 $iteratorStack[] = $newIterator;
1212 } elseif ( $iteratorStack[$level] === false ) {
1213 // Return accumulated value to parent
1214 // With tail recursion
1215 while ( $iteratorStack[$level] === false && $level > 0 ) {
1216 $outStack[$level - 1] .= $out;
1217 array_pop( $outStack );
1218 array_pop( $iteratorStack );
1219 array_pop( $indexStack );
1225 return $outStack[0];
1229 * @param string $sep
1231 * @param string|PPNode $args,...
1234 public function implodeWithFlags( $sep, $flags /*, ... */ ) {
1235 $args = array_slice( func_get_args(), 2 );
1239 foreach ( $args as $root ) {
1240 if ( $root instanceof PPNode_Hash_Array
) {
1241 $root = $root->value
;
1243 if ( !is_array( $root ) ) {
1244 $root = array( $root );
1246 foreach ( $root as $node ) {
1252 $s .= $this->expand( $node, $flags );
1259 * Implode with no flags specified
1260 * This previously called implodeWithFlags but has now been inlined to reduce stack depth
1261 * @param string $sep
1262 * @param string|PPNode $args,...
1265 public function implode( $sep /*, ... */ ) {
1266 $args = array_slice( func_get_args(), 1 );
1270 foreach ( $args as $root ) {
1271 if ( $root instanceof PPNode_Hash_Array
) {
1272 $root = $root->value
;
1274 if ( !is_array( $root ) ) {
1275 $root = array( $root );
1277 foreach ( $root as $node ) {
1283 $s .= $this->expand( $node );
1290 * Makes an object that, when expand()ed, will be the same as one obtained
1293 * @param string $sep
1294 * @param string|PPNode $args,...
1295 * @return PPNode_Hash_Array
1297 public function virtualImplode( $sep /*, ... */ ) {
1298 $args = array_slice( func_get_args(), 1 );
1302 foreach ( $args as $root ) {
1303 if ( $root instanceof PPNode_Hash_Array
) {
1304 $root = $root->value
;
1306 if ( !is_array( $root ) ) {
1307 $root = array( $root );
1309 foreach ( $root as $node ) {
1318 return new PPNode_Hash_Array( $out );
1322 * Virtual implode with brackets
1324 * @param string $start
1325 * @param string $sep
1326 * @param string $end
1327 * @param string|PPNode $args,...
1328 * @return PPNode_Hash_Array
1330 public function virtualBracketedImplode( $start, $sep, $end /*, ... */ ) {
1331 $args = array_slice( func_get_args(), 3 );
1332 $out = array( $start );
1335 foreach ( $args as $root ) {
1336 if ( $root instanceof PPNode_Hash_Array
) {
1337 $root = $root->value
;
1339 if ( !is_array( $root ) ) {
1340 $root = array( $root );
1342 foreach ( $root as $node ) {
1352 return new PPNode_Hash_Array( $out );
1355 public function __toString() {
1360 * @param bool $level
1361 * @return array|bool|string
1363 public function getPDBK( $level = false ) {
1364 if ( $level === false ) {
1365 return $this->title
->getPrefixedDBkey();
1367 return isset( $this->titleCache
[$level] ) ?
$this->titleCache
[$level] : false;
1374 public function getArguments() {
1381 public function getNumberedArguments() {
1388 public function getNamedArguments() {
1393 * Returns true if there are no arguments in this frame
1397 public function isEmpty() {
1402 * @param string $name
1405 public function getArgument( $name ) {
1410 * Returns true if the infinite loop check is OK, false if a loop is detected
1412 * @param Title $title
1416 public function loopCheck( $title ) {
1417 return !isset( $this->loopCheckHash
[$title->getPrefixedDBkey()] );
1421 * Return true if the frame is a template frame
1425 public function isTemplate() {
1430 * Get a title of frame
1434 public function getTitle() {
1435 return $this->title
;
1439 * Set the volatile flag
1443 public function setVolatile( $flag = true ) {
1444 $this->volatile
= $flag;
1448 * Get the volatile flag
1452 public function isVolatile() {
1453 return $this->volatile
;
1461 public function setTTL( $ttl ) {
1462 if ( $ttl !== null && ( $this->ttl
=== null ||
$ttl < $this->ttl
) ) {
1472 public function getTTL() {
1478 * Expansion frame with template arguments
1480 * @codingStandardsIgnoreStart
1482 class PPTemplateFrame_Hash
extends PPFrame_Hash
{
1483 // @codingStandardsIgnoreEnd
1485 public $numberedArgs, $namedArgs, $parent;
1486 public $numberedExpansionCache, $namedExpansionCache;
1489 * @param Preprocessor $preprocessor
1490 * @param bool|PPFrame $parent
1491 * @param array $numberedArgs
1492 * @param array $namedArgs
1493 * @param bool|Title $title
1495 public function __construct( $preprocessor, $parent = false, $numberedArgs = array(),
1496 $namedArgs = array(), $title = false
1498 parent
::__construct( $preprocessor );
1500 $this->parent
= $parent;
1501 $this->numberedArgs
= $numberedArgs;
1502 $this->namedArgs
= $namedArgs;
1503 $this->title
= $title;
1504 $pdbk = $title ?
$title->getPrefixedDBkey() : false;
1505 $this->titleCache
= $parent->titleCache
;
1506 $this->titleCache
[] = $pdbk;
1507 $this->loopCheckHash
= /*clone*/ $parent->loopCheckHash
;
1508 if ( $pdbk !== false ) {
1509 $this->loopCheckHash
[$pdbk] = true;
1511 $this->depth
= $parent->depth +
1;
1512 $this->numberedExpansionCache
= $this->namedExpansionCache
= array();
1515 public function __toString() {
1518 $args = $this->numberedArgs +
$this->namedArgs
;
1519 foreach ( $args as $name => $value ) {
1525 $s .= "\"$name\":\"" .
1526 str_replace( '"', '\\"', $value->__toString() ) . '"';
1533 * @throws MWException
1534 * @param string|int $key
1535 * @param string|PPNode $root
1539 public function cachedExpand( $key, $root, $flags = 0 ) {
1540 if ( isset( $this->parent
->childExpansionCache
[$key] ) ) {
1541 return $this->parent
->childExpansionCache
[$key];
1543 $retval = $this->expand( $root, $flags );
1544 if ( !$this->isVolatile() ) {
1545 $this->parent
->childExpansionCache
[$key] = $retval;
1551 * Returns true if there are no arguments in this frame
1555 public function isEmpty() {
1556 return !count( $this->numberedArgs
) && !count( $this->namedArgs
);
1562 public function getArguments() {
1563 $arguments = array();
1564 foreach ( array_merge(
1565 array_keys( $this->numberedArgs
),
1566 array_keys( $this->namedArgs
) ) as $key ) {
1567 $arguments[$key] = $this->getArgument( $key );
1575 public function getNumberedArguments() {
1576 $arguments = array();
1577 foreach ( array_keys( $this->numberedArgs
) as $key ) {
1578 $arguments[$key] = $this->getArgument( $key );
1586 public function getNamedArguments() {
1587 $arguments = array();
1588 foreach ( array_keys( $this->namedArgs
) as $key ) {
1589 $arguments[$key] = $this->getArgument( $key );
1596 * @return array|bool
1598 public function getNumberedArgument( $index ) {
1599 if ( !isset( $this->numberedArgs
[$index] ) ) {
1602 if ( !isset( $this->numberedExpansionCache
[$index] ) ) {
1603 # No trimming for unnamed arguments
1604 $this->numberedExpansionCache
[$index] = $this->parent
->expand(
1605 $this->numberedArgs
[$index],
1606 PPFrame
::STRIP_COMMENTS
1609 return $this->numberedExpansionCache
[$index];
1613 * @param string $name
1616 public function getNamedArgument( $name ) {
1617 if ( !isset( $this->namedArgs
[$name] ) ) {
1620 if ( !isset( $this->namedExpansionCache
[$name] ) ) {
1621 # Trim named arguments post-expand, for backwards compatibility
1622 $this->namedExpansionCache
[$name] = trim(
1623 $this->parent
->expand( $this->namedArgs
[$name], PPFrame
::STRIP_COMMENTS
) );
1625 return $this->namedExpansionCache
[$name];
1629 * @param string $name
1630 * @return array|bool
1632 public function getArgument( $name ) {
1633 $text = $this->getNumberedArgument( $name );
1634 if ( $text === false ) {
1635 $text = $this->getNamedArgument( $name );
1641 * Return true if the frame is a template frame
1645 public function isTemplate() {
1649 public function setVolatile( $flag = true ) {
1650 parent
::setVolatile( $flag );
1651 $this->parent
->setVolatile( $flag );
1654 public function setTTL( $ttl ) {
1655 parent
::setTTL( $ttl );
1656 $this->parent
->setTTL( $ttl );
1661 * Expansion frame with custom arguments
1663 * @codingStandardsIgnoreStart
1665 class PPCustomFrame_Hash
extends PPFrame_Hash
{
1666 // @codingStandardsIgnoreEnd
1670 public function __construct( $preprocessor, $args ) {
1671 parent
::__construct( $preprocessor );
1672 $this->args
= $args;
1675 public function __toString() {
1678 foreach ( $this->args
as $name => $value ) {
1684 $s .= "\"$name\":\"" .
1685 str_replace( '"', '\\"', $value->__toString() ) . '"';
1694 public function isEmpty() {
1695 return !count( $this->args
);
1702 public function getArgument( $index ) {
1703 if ( !isset( $this->args
[$index] ) ) {
1706 return $this->args
[$index];
1709 public function getArguments() {
1716 * @codingStandardsIgnoreStart
1718 class PPNode_Hash_Tree
implements PPNode
{
1719 // @codingStandardsIgnoreEnd
1721 public $name, $firstChild, $lastChild, $nextSibling;
1723 public function __construct( $name ) {
1724 $this->name
= $name;
1725 $this->firstChild
= $this->lastChild
= $this->nextSibling
= false;
1728 public function __toString() {
1731 for ( $node = $this->firstChild
; $node; $node = $node->nextSibling
) {
1732 if ( $node instanceof PPNode_Hash_Attr
) {
1733 $attribs .= ' ' . $node->name
. '="' . htmlspecialchars( $node->value
) . '"';
1735 $inner .= $node->__toString();
1738 if ( $inner === '' ) {
1739 return "<{$this->name}$attribs/>";
1741 return "<{$this->name}$attribs>$inner</{$this->name}>";
1746 * @param string $name
1747 * @param string $text
1748 * @return PPNode_Hash_Tree
1750 public static function newWithText( $name, $text ) {
1751 $obj = new self( $name );
1752 $obj->addChild( new PPNode_Hash_Text( $text ) );
1756 public function addChild( $node ) {
1757 if ( $this->lastChild
=== false ) {
1758 $this->firstChild
= $this->lastChild
= $node;
1760 $this->lastChild
->nextSibling
= $node;
1761 $this->lastChild
= $node;
1766 * @return PPNode_Hash_Array
1768 public function getChildren() {
1769 $children = array();
1770 for ( $child = $this->firstChild
; $child; $child = $child->nextSibling
) {
1771 $children[] = $child;
1773 return new PPNode_Hash_Array( $children );
1776 public function getFirstChild() {
1777 return $this->firstChild
;
1780 public function getNextSibling() {
1781 return $this->nextSibling
;
1784 public function getChildrenOfType( $name ) {
1785 $children = array();
1786 for ( $child = $this->firstChild
; $child; $child = $child->nextSibling
) {
1787 if ( isset( $child->name
) && $child->name
=== $name ) {
1788 $children[] = $child;
1797 public function getLength() {
1805 public function item( $i ) {
1812 public function getName() {
1817 * Split a "<part>" node into an associative array containing:
1818 * - name PPNode name
1819 * - index String index
1820 * - value PPNode value
1822 * @throws MWException
1825 public function splitArg() {
1827 for ( $child = $this->firstChild
; $child; $child = $child->nextSibling
) {
1828 if ( !isset( $child->name
) ) {
1831 if ( $child->name
=== 'name' ) {
1832 $bits['name'] = $child;
1833 if ( $child->firstChild
instanceof PPNode_Hash_Attr
1834 && $child->firstChild
->name
=== 'index'
1836 $bits['index'] = $child->firstChild
->value
;
1838 } elseif ( $child->name
=== 'value' ) {
1839 $bits['value'] = $child;
1843 if ( !isset( $bits['name'] ) ) {
1844 throw new MWException( 'Invalid brace node passed to ' . __METHOD__
);
1846 if ( !isset( $bits['index'] ) ) {
1847 $bits['index'] = '';
1853 * Split an "<ext>" node into an associative array containing name, attr, inner and close
1854 * All values in the resulting array are PPNodes. Inner and close are optional.
1856 * @throws MWException
1859 public function splitExt() {
1861 for ( $child = $this->firstChild
; $child; $child = $child->nextSibling
) {
1862 if ( !isset( $child->name
) ) {
1865 if ( $child->name
== 'name' ) {
1866 $bits['name'] = $child;
1867 } elseif ( $child->name
== 'attr' ) {
1868 $bits['attr'] = $child;
1869 } elseif ( $child->name
== 'inner' ) {
1870 $bits['inner'] = $child;
1871 } elseif ( $child->name
== 'close' ) {
1872 $bits['close'] = $child;
1875 if ( !isset( $bits['name'] ) ) {
1876 throw new MWException( 'Invalid ext node passed to ' . __METHOD__
);
1882 * Split an "<h>" node
1884 * @throws MWException
1887 public function splitHeading() {
1888 if ( $this->name
!== 'h' ) {
1889 throw new MWException( 'Invalid h node passed to ' . __METHOD__
);
1892 for ( $child = $this->firstChild
; $child; $child = $child->nextSibling
) {
1893 if ( !isset( $child->name
) ) {
1896 if ( $child->name
== 'i' ) {
1897 $bits['i'] = $child->value
;
1898 } elseif ( $child->name
== 'level' ) {
1899 $bits['level'] = $child->value
;
1902 if ( !isset( $bits['i'] ) ) {
1903 throw new MWException( 'Invalid h node passed to ' . __METHOD__
);
1909 * Split a "<template>" or "<tplarg>" node
1911 * @throws MWException
1914 public function splitTemplate() {
1916 $bits = array( 'lineStart' => '' );
1917 for ( $child = $this->firstChild
; $child; $child = $child->nextSibling
) {
1918 if ( !isset( $child->name
) ) {
1921 if ( $child->name
== 'title' ) {
1922 $bits['title'] = $child;
1924 if ( $child->name
== 'part' ) {
1927 if ( $child->name
== 'lineStart' ) {
1928 $bits['lineStart'] = '1';
1931 if ( !isset( $bits['title'] ) ) {
1932 throw new MWException( 'Invalid node passed to ' . __METHOD__
);
1934 $bits['parts'] = new PPNode_Hash_Array( $parts );
1941 * @codingStandardsIgnoreStart
1943 class PPNode_Hash_Text
implements PPNode
{
1944 // @codingStandardsIgnoreEnd
1946 public $value, $nextSibling;
1948 public function __construct( $value ) {
1949 if ( is_object( $value ) ) {
1950 throw new MWException( __CLASS__
. ' given object instead of string' );
1952 $this->value
= $value;
1955 public function __toString() {
1956 return htmlspecialchars( $this->value
);
1959 public function getNextSibling() {
1960 return $this->nextSibling
;
1963 public function getChildren() {
1967 public function getFirstChild() {
1971 public function getChildrenOfType( $name ) {
1975 public function getLength() {
1979 public function item( $i ) {
1983 public function getName() {
1987 public function splitArg() {
1988 throw new MWException( __METHOD__
. ': not supported' );
1991 public function splitExt() {
1992 throw new MWException( __METHOD__
. ': not supported' );
1995 public function splitHeading() {
1996 throw new MWException( __METHOD__
. ': not supported' );
2002 * @codingStandardsIgnoreStart
2004 class PPNode_Hash_Array
implements PPNode
{
2005 // @codingStandardsIgnoreEnd
2007 public $value, $nextSibling;
2009 public function __construct( $value ) {
2010 $this->value
= $value;
2013 public function __toString() {
2014 return var_export( $this, true );
2017 public function getLength() {
2018 return count( $this->value
);
2021 public function item( $i ) {
2022 return $this->value
[$i];
2025 public function getName() {
2029 public function getNextSibling() {
2030 return $this->nextSibling
;
2033 public function getChildren() {
2037 public function getFirstChild() {
2041 public function getChildrenOfType( $name ) {
2045 public function splitArg() {
2046 throw new MWException( __METHOD__
. ': not supported' );
2049 public function splitExt() {
2050 throw new MWException( __METHOD__
. ': not supported' );
2053 public function splitHeading() {
2054 throw new MWException( __METHOD__
. ': not supported' );
2060 * @codingStandardsIgnoreStart
2062 class PPNode_Hash_Attr
implements PPNode
{
2063 // @codingStandardsIgnoreEnd
2065 public $name, $value, $nextSibling;
2067 public function __construct( $name, $value ) {
2068 $this->name
= $name;
2069 $this->value
= $value;
2072 public function __toString() {
2073 return "<@{$this->name}>" . htmlspecialchars( $this->value
) . "</@{$this->name}>";
2076 public function getName() {
2080 public function getNextSibling() {
2081 return $this->nextSibling
;
2084 public function getChildren() {
2088 public function getFirstChild() {
2092 public function getChildrenOfType( $name ) {
2096 public function getLength() {
2100 public function item( $i ) {
2104 public function splitArg() {
2105 throw new MWException( __METHOD__
. ': not supported' );
2108 public function splitExt() {
2109 throw new MWException( __METHOD__
. ': not supported' );
2112 public function splitHeading() {
2113 throw new MWException( __METHOD__
. ': not supported' );