includes/parser/Preprocessor_Hash.php

   1 <?php
   2 /**
   3  * Preprocessor using PHP arrays
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Parser
  22  */
  23
  24 /**
  25  * Differences from DOM schema:
  26  *   * attribute nodes are children
  27  *   * "<h>" nodes that aren't at the top are replaced with <possible-h>
  28  * @ingroup Parser
  29  * @codingStandardsIgnoreStart
  30  */
  31 class Preprocessor_Hash implements Preprocessor {
  32         // @codingStandardsIgnoreEnd
  33
  34         /**
  35          * @var Parser
  36          */
  37         public $parser;
  38
  39         const CACHE_VERSION = 1;
  40
  41         public function __construct( $parser ) {
  42                 $this->parser = $parser;
  43         }
  44
  45         /**
  46          * @return PPFrame_Hash
  47          */
  48         public function newFrame() {
  49                 return new PPFrame_Hash( $this );
  50         }
  51
  52         /**
  53          * @param array $args
  54          * @return PPCustomFrame_Hash
  55          */
  56         public function newCustomFrame( $args ) {
  57                 return new PPCustomFrame_Hash( $this, $args );
  58         }
  59
  60         /**
  61          * @param array $values
  62          * @return PPNode_Hash_Array
  63          */
  64         public function newPartNodeArray( $values ) {
  65                 $list = array();
  66
  67                 foreach ( $values as $k => $val ) {
  68                         $partNode = new PPNode_Hash_Tree( 'part' );
  69                         $nameNode = new PPNode_Hash_Tree( 'name' );
  70
  71                         if ( is_int( $k ) ) {
  72                                 $nameNode->addChild( new PPNode_Hash_Attr( 'index', $k ) );
  73                                 $partNode->addChild( $nameNode );
  74                         } else {
  75                                 $nameNode->addChild( new PPNode_Hash_Text( $k ) );
  76                                 $partNode->addChild( $nameNode );
  77                                 $partNode->addChild( new PPNode_Hash_Text( '=' ) );
  78                         }
  79
  80                         $valueNode = new PPNode_Hash_Tree( 'value' );
  81                         $valueNode->addChild( new PPNode_Hash_Text( $val ) );
  82                         $partNode->addChild( $valueNode );
  83
  84                         $list[] = $partNode;
  85                 }
  86
  87                 $node = new PPNode_Hash_Array( $list );
  88                 return $node;
  89         }
  90
  91         /**
  92          * Preprocess some wikitext and return the document tree.
  93          * This is the ghost of Parser::replace_variables().
  94          *
  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.
  99          *
 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.
 102          *
 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().
 106          *
 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.
 110          *
 111          * @throws MWException
 112          * @return PPNode_Hash_Tree
 113          */
 114         public function preprocessToObj( $text, $flags = 0 ) {
 115                 // Check cache.
 116                 global $wgMemc, $wgPreprocessorCacheThreshold;
 117
 118                 $cacheable = $wgPreprocessorCacheThreshold !== false
 119                         && strlen( $text ) > $wgPreprocessorCacheThreshold;
 120
 121                 if ( $cacheable ) {
 122                         $cacheKey = wfMemcKey( 'preprocess-hash', md5( $text ), $flags );
 123                         $cacheValue = $wgMemc->get( $cacheKey );
 124                         if ( $cacheValue ) {
 125                                 $version = substr( $cacheValue, 0, 8 );
 126                                 if ( intval( $version ) == self::CACHE_VERSION ) {
 127                                         $hash = unserialize( substr( $cacheValue, 8 ) );
 128                                         // From the cache
 129                                         wfDebugLog( "Preprocessor",
 130                                                 "Loaded preprocessor hash from memcached (key $cacheKey)" );
 131                                         return $hash;
 132                                 }
 133                         }
 134                 }
 135
 136                 $rules = array(
 137                         '{' => array(
 138                                 'end' => '}',
 139                                 'names' => array(
 140                                         2 => 'template',
 141                                         3 => 'tplarg',
 142                                 ),
 143                                 'min' => 2,
 144                                 'max' => 3,
 145                         ),
 146                         '[' => array(
 147                                 'end' => ']',
 148                                 'names' => array( 2 => null ),
 149                                 'min' => 2,
 150                                 'max' => 2,
 151                         )
 152                 );
 153
 154                 $forInclusion = $flags & Parser::PTD_FOR_INCLUSION;
 155
 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
 164                         ) {
 165                                 $enableOnlyinclude = true;
 166                         }
 167                 } else {
 168                         $ignoredTags = array( 'noinclude', '/noinclude', 'onlyinclude', '/onlyinclude' );
 169                         $ignoredElements = array( 'includeonly' );
 170                         $xmlishElements[] = 'includeonly';
 171                 }
 172                 $xmlishRegex = implode( '|', array_merge( $xmlishElements, $ignoredTags ) );
 173
 174                 // Use "A" modifier (anchored) instead of "^", because ^ doesn't work with an offset
 175                 $elementsRegex = "~($xmlishRegex)(?:\s|\/>|>)|(!--)~iA";
 176
 177                 $stack = new PPDStack_Hash;
 178
 179                 $searchBase = "[{<\n";
 180                 // For fast reverse searches
 181                 $revText = strrev( $text );
 182                 $lengthText = strlen( $text );
 183
 184                 // Input pointer, starts out pointing to a pseudo-newline before the start
 185                 $i = 0;
 186                 // Current accumulator
 187                 $accum =& $stack->getAccum();
 188                 // True to find equals signs in arguments
 189                 $findEquals = false;
 190                 // True to take notice of pipe characters
 191                 $findPipe = false;
 192                 $headingIndex = 1;
 193                 // True if $i is inside a possible heading
 194                 $inHeading = false;
 195                 // True if there are no more greater-than (>) signs right of $i
 196                 $noMoreGT = false;
 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;
 201
 202                 while ( true ) {
 203                         //$this->memCheck();
 204
 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 ) );
 211                                         break;
 212                                 }
 213                                 $tagEndPos = $startPos + strlen( '<onlyinclude>' ); // past-the-end
 214                                 $accum->addNodeWithText( 'ignore', substr( $text, $i, $tagEndPos - $i ) );
 215                                 $i = $tagEndPos;
 216                                 $findOnlyinclude = false;
 217                         }
 218
 219                         if ( $fakeLineStart ) {
 220                                 $found = 'line-start';
 221                                 $curChar = '';
 222                         } else {
 223                                 # Find next opening brace, closing brace or pipe
 224                                 $search = $searchBase;
 225                                 if ( $stack->top === false ) {
 226                                         $currentClosing = '';
 227                                 } else {
 228                                         $currentClosing = $stack->top->close;
 229                                         $search .= $currentClosing;
 230                                 }
 231                                 if ( $findPipe ) {
 232                                         $search .= '|';
 233                                 }
 234                                 if ( $findEquals ) {
 235                                         // First equals will be for the template
 236                                         $search .= '=';
 237                                 }
 238                                 $rule = null;
 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;
 244                                 }
 245                                 if ( $i >= $lengthText ) {
 246                                         if ( $currentClosing == "\n" ) {
 247                                                 // Do a past-the-end run to finish off the heading
 248                                                 $curChar = '';
 249                                                 $found = 'line-end';
 250                                         } else {
 251                                                 # All done
 252                                                 break;
 253                                         }
 254                                 } else {
 255                                         $curChar = $text[$i];
 256                                         if ( $curChar == '|' ) {
 257                                                 $found = 'pipe';
 258                                         } elseif ( $curChar == '=' ) {
 259                                                 $found = 'equals';
 260                                         } elseif ( $curChar == '<' ) {
 261                                                 $found = 'angle';
 262                                         } elseif ( $curChar == "\n" ) {
 263                                                 if ( $inHeading ) {
 264                                                         $found = 'line-end';
 265                                                 } else {
 266                                                         $found = 'line-start';
 267                                                 }
 268                                         } elseif ( $curChar == $currentClosing ) {
 269                                                 $found = 'close';
 270                                         } elseif ( isset( $rules[$curChar] ) ) {
 271                                                 $found = 'open';
 272                                                 $rule = $rules[$curChar];
 273                                         } else {
 274                                                 # Some versions of PHP have a strcspn which stops on null characters
 275                                                 # Ignore and continue
 276                                                 ++$i;
 277                                                 continue;
 278                                         }
 279                                 }
 280                         }
 281
 282                         if ( $found == 'angle' ) {
 283                                 $matches = false;
 284                                 // Handle </onlyinclude>
 285                                 if ( $enableOnlyinclude
 286                                         && substr( $text, $i, strlen( '</onlyinclude>' ) ) == '</onlyinclude>'
 287                                 ) {
 288                                         $findOnlyinclude = true;
 289                                         continue;
 290                                 }
 291
 292                                 // Determine element name
 293                                 if ( !preg_match( $elementsRegex, $text, $matches, 0, $i + 1 ) ) {
 294                                         // Element name missing or not listed
 295                                         $accum->addLiteral( '<' );
 296                                         ++$i;
 297                                         continue;
 298                                 }
 299                                 // Handle comments
 300                                 if ( isset( $matches[2] ) && $matches[2] == '!--' ) {
 301
 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.
 306
 307                                         // Find the end
 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 );
 313                                                 $i = $lengthText;
 314                                         } else {
 315                                                 // Search backwards for leading whitespace
 316                                                 $wsStart = $i ? ( $i - strspn( $revText, " \t", $lengthText - $i ) ) : 0;
 317
 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 );
 321
 322                                                 // Keep looking forward as long as we're finding more
 323                                                 // comments.
 324                                                 $comments = array( array( $wsStart, $wsEnd ) );
 325                                                 while ( substr( $text, $wsEnd + 1, 4 ) == '<!--' ) {
 326                                                         $c = strpos( $text, '-->', $wsEnd + 4 );
 327                                                         if ( $c === false ) {
 328                                                                 break;
 329                                                         }
 330                                                         $c = $c + 2 + strspn( $text, " \t", $c + 3 );
 331                                                         $comments[] = array( $wsEnd + 1, $c );
 332                                                         $wsEnd = $c;
 333                                                 }
 334
 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"
 341                                                 ) {
 342                                                         // Remove leading whitespace from the end of the accumulator
 343                                                         // Sanity check first though
 344                                                         $wsLength = $i - $wsStart;
 345                                                         if ( $wsLength > 0
 346                                                                 && $accum->lastNode instanceof PPNode_Hash_Text
 347                                                                 && strspn( $accum->lastNode->value, " \t", -$wsLength ) === $wsLength
 348                                                         ) {
 349                                                                 $accum->lastNode->value = substr( $accum->lastNode->value, 0, -$wsLength );
 350                                                         }
 351
 352                                                         // Dump all but the last comment to the accumulator
 353                                                         foreach ( $comments as $j => $com ) {
 354                                                                 $startPos = $com[0];
 355                                                                 $endPos = $com[1] + 1;
 356                                                                 if ( $j == ( count( $comments ) - 1 ) ) {
 357                                                                         break;
 358                                                                 }
 359                                                                 $inner = substr( $text, $startPos, $endPos - $startPos );
 360                                                                 $accum->addNodeWithText( 'comment', $inner );
 361                                                         }
 362
 363                                                         // Do a line-start run next time to look for headings after the comment
 364                                                         $fakeLineStart = true;
 365                                                 } else {
 366                                                         // No line to eat, just take the comment itself
 367                                                         $startPos = $i;
 368                                                         $endPos += 2;
 369                                                 }
 370
 371                                                 if ( $stack->top ) {
 372                                                         $part = $stack->top->getCurrentPart();
 373                                                         if ( !( isset( $part->commentEnd ) && $part->commentEnd == $wsStart - 1 ) ) {
 374                                                                 $part->visualEnd = $wsStart;
 375                                                         }
 376                                                         // Else comments abutting, no change in visual end
 377                                                         $part->commentEnd = $endPos;
 378                                                 }
 379                                                 $i = $endPos + 1;
 380                                                 $inner = substr( $text, $startPos, $endPos - $startPos + 1 );
 381                                                 $accum->addNodeWithText( 'comment', $inner );
 382                                         }
 383                                         continue;
 384                                 }
 385                                 $name = $matches[1];
 386                                 $lowerName = strtolower( $name );
 387                                 $attrStart = $i + strlen( $name ) + 1;
 388
 389                                 // Find end of tag
 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
 394                                         $noMoreGT = true;
 395                                         $accum->addLiteral( '<' );
 396                                         ++$i;
 397                                         continue;
 398                                 }
 399
 400                                 // Handle ignored tags
 401                                 if ( in_array( $lowerName, $ignoredTags ) ) {
 402                                         $accum->addNodeWithText( 'ignore', substr( $text, $i, $tagEndPos - $i + 1 ) );
 403                                         $i = $tagEndPos + 1;
 404                                         continue;
 405                                 }
 406
 407                                 $tagStartPos = $i;
 408                                 if ( $text[$tagEndPos - 1] == '/' ) {
 409                                         // Short end tag
 410                                         $attrEnd = $tagEndPos - 1;
 411                                         $inner = null;
 412                                         $i = $tagEndPos + 1;
 413                                         $close = null;
 414                                 } else {
 415                                         $attrEnd = $tagEndPos;
 416                                         // Find closing tag
 417                                         if ( preg_match( "/<\/" . preg_quote( $name, '/' ) . "\s*>/i",
 418                                                         $text, $matches, PREG_OFFSET_CAPTURE, $tagEndPos + 1 )
 419                                         ) {
 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];
 423                                         } else {
 424                                                 // No end tag -- let it run out to the end of the text.
 425                                                 $inner = substr( $text, $tagEndPos + 1 );
 426                                                 $i = $lengthText;
 427                                                 $close = null;
 428                                         }
 429                                 }
 430                                 // <includeonly> and <noinclude> just become <ignore> tags
 431                                 if ( in_array( $lowerName, $ignoredElements ) ) {
 432                                         $accum->addNodeWithText( 'ignore', substr( $text, $tagStartPos, $i - $tagStartPos ) );
 433                                         continue;
 434                                 }
 435
 436                                 if ( $attrEnd <= $attrStart ) {
 437                                         $attr = '';
 438                                 } else {
 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 );
 442                                 }
 443
 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 ) );
 449                                 }
 450                                 if ( $close !== null ) {
 451                                         $extNode->addChild( PPNode_Hash_Tree::newWithText( 'close', $close ) );
 452                                 }
 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;
 459                                 } else {
 460                                         $accum->addLiteral( $curChar );
 461                                         $i++;
 462                                 }
 463
 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 ) {
 471                                         $piece = array(
 472                                                 'open' => "\n",
 473                                                 'close' => "\n",
 474                                                 'parts' => array( new PPDPart_Hash( str_repeat( '=', $count ) ) ),
 475                                                 'startPos' => $i,
 476                                                 'count' => $count );
 477                                         $stack->push( $piece );
 478                                         $accum =& $stack->getAccum();
 479                                         extract( $stack->getFlags() );
 480                                         $i += $count;
 481                                 }
 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 );
 497                                 }
 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;
 506                                                 if ( $count < 3 ) {
 507                                                         $count = 0;
 508                                                 } else {
 509                                                         $count = min( 6, intval( ( $count - 1 ) / 2 ) );
 510                                                 }
 511                                         } else {
 512                                                 $count = min( $equalsLength, $count );
 513                                         }
 514                                         if ( $count > 0 ) {
 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;
 521                                         } else {
 522                                                 // Single equals sign on its own line, count=0
 523                                                 $element = $accum;
 524                                         }
 525                                 } else {
 526                                         // No match, no <h>, just pass down the inner text
 527                                         $element = $accum;
 528                                 }
 529                                 // Unwind the stack
 530                                 $stack->pop();
 531                                 $accum =& $stack->getAccum();
 532                                 extract( $stack->getFlags() );
 533
 534                                 // Append the result to the enclosing accumulator
 535                                 if ( $element instanceof PPNode ) {
 536                                         $accum->addNode( $element );
 537                                 } else {
 538                                         $accum->addAccum( $element );
 539                                 }
 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
 544                                 // input pointer.
 545                         } elseif ( $found == 'open' ) {
 546                                 # count opening brace characters
 547                                 $count = strspn( $text, $curChar, $i );
 548
 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
 552                                         $piece = array(
 553                                                 'open' => $curChar,
 554                                                 'close' => $rule['end'],
 555                                                 'count' => $count,
 556                                                 'lineStart' => ( $i > 0 && $text[$i - 1] == "\n" ),
 557                                         );
 558
 559                                         $stack->push( $piece );
 560                                         $accum =& $stack->getAccum();
 561                                         extract( $stack->getFlags() );
 562                                 } else {
 563                                         # Add literal brace(s)
 564                                         $accum->addLiteral( str_repeat( $curChar, $count ) );
 565                                 }
 566                                 $i += $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 );
 572
 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
 578                                         # has made an error
 579                                         $matchingCount = $rule['max'];
 580                                 } else {
 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'] ) ) {
 586                                                 --$matchingCount;
 587                                         }
 588                                 }
 589
 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 ) );
 594                                         $i += $count;
 595                                         continue;
 596                                 }
 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 ) );
 602                                 } else {
 603                                         # Create XML element
 604                                         # Note: $parts is already XML, does not need to be encoded further
 605                                         $parts = $piece->parts;
 606                                         $titleAccum = $parts[0]->out;
 607                                         unset( $parts[0] );
 608
 609                                         $element = new PPNode_Hash_Tree( $name );
 610
 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 ) );
 615                                         }
 616                                         $titleNode = new PPNode_Hash_Tree( 'title' );
 617                                         $titleNode->firstChild = $titleAccum->firstNode;
 618                                         $titleNode->lastChild = $titleAccum->lastNode;
 619                                         $element->addChild( $titleNode );
 620                                         $argIndex = 1;
 621                                         foreach ( $parts as $part ) {
 622                                                 if ( isset( $part->eqpos ) ) {
 623                                                         // Find equals
 624                                                         $lastNode = false;
 625                                                         for ( $node = $part->out->firstNode; $node; $node = $node->nextSibling ) {
 626                                                                 if ( $node === $part->eqpos ) {
 627                                                                         break;
 628                                                                 }
 629                                                                 $lastNode = $node;
 630                                                         }
 631                                                         if ( !$node ) {
 632                                                                 if ( $cacheable ) {
 633                                                                 }
 634                                                                 throw new MWException( __METHOD__ . ': eqpos not found' );
 635                                                         }
 636                                                         if ( $node->name !== 'equals' ) {
 637                                                                 if ( $cacheable ) {
 638                                                                 }
 639                                                                 throw new MWException( __METHOD__ . ': eqpos is not equals' );
 640                                                         }
 641                                                         $equalsNode = $node;
 642
 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;
 649                                                         }
 650
 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;
 656                                                         }
 657                                                         $partNode = new PPNode_Hash_Tree( 'part' );
 658                                                         $partNode->addChild( $nameNode );
 659                                                         $partNode->addChild( $equalsNode->firstChild );
 660                                                         $partNode->addChild( $valueNode );
 661                                                         $element->addChild( $partNode );
 662                                                 } else {
 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 );
 672                                                 }
 673                                         }
 674                                 }
 675
 676                                 # Advance input pointer
 677                                 $i += $matchingCount;
 678
 679                                 # Unwind the stack
 680                                 $stack->pop();
 681                                 $accum =& $stack->getAccum();
 682
 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();
 692                                         } else {
 693                                                 $accum->addLiteral( str_repeat( $piece->open, $piece->count ) );
 694                                         }
 695                                 }
 696
 697                                 extract( $stack->getFlags() );
 698
 699                                 # Add XML element to the enclosing accumulator
 700                                 if ( $element instanceof PPNode ) {
 701                                         $accum->addNode( $element );
 702                                 } else {
 703                                         $accum->addAccum( $element );
 704                                 }
 705                         } elseif ( $found == 'pipe' ) {
 706                                 $findEquals = true; // shortcut for getFlags()
 707                                 $stack->addPart();
 708                                 $accum =& $stack->getAccum();
 709                                 ++$i;
 710                         } elseif ( $found == 'equals' ) {
 711                                 $findEquals = false; // shortcut for getFlags()
 712                                 $accum->addNodeWithText( 'equals', '=' );
 713                                 $stack->getCurrentPart()->eqpos = $accum->lastNode;
 714                                 ++$i;
 715                         }
 716                 }
 717
 718                 # Output any remaining unclosed brackets
 719                 foreach ( $stack->stack as $piece ) {
 720                         $stack->rootAccum->addAccum( $piece->breakSyntax() );
 721                 }
 722
 723                 # Enable top-level headings
 724                 for ( $node = $stack->rootAccum->firstNode; $node; $node = $node->nextSibling ) {
 725                         if ( isset( $node->name ) && $node->name === 'possible-h' ) {
 726                                 $node->name = 'h';
 727                         }
 728                 }
 729
 730                 $rootNode = new PPNode_Hash_Tree( 'root' );
 731                 $rootNode->firstChild = $stack->rootAccum->firstNode;
 732                 $rootNode->lastChild = $stack->rootAccum->lastNode;
 733
 734                 // Cache
 735                 if ( $cacheable ) {
 736                         $cacheValue = sprintf( "%08d", self::CACHE_VERSION ) . serialize( $rootNode );
 737                         $wgMemc->set( $cacheKey, $cacheValue, 86400 );
 738                         wfDebugLog( "Preprocessor", "Saved preprocessor Hash to memcached (key $cacheKey)" );
 739                 }
 740
 741                 return $rootNode;
 742         }
 743 }
 744
 745 /**
 746  * Stack class to help Preprocessor::preprocessToObj()
 747  * @ingroup Parser
 748  * @codingStandardsIgnoreStart
 749  */
 750 class PPDStack_Hash extends PPDStack {
 751         // @codingStandardsIgnoreEnd
 752
 753         public function __construct() {
 754                 $this->elementClass = 'PPDStackElement_Hash';
 755                 parent::__construct();
 756                 $this->rootAccum = new PPDAccum_Hash;
 757         }
 758 }
 759
 760 /**
 761  * @ingroup Parser
 762  * @codingStandardsIgnoreStart
 763  */
 764 class PPDStackElement_Hash extends PPDStackElement {
 765         // @codingStandardsIgnoreENd
 766
 767         public function __construct( $data = array() ) {
 768                 $this->partClass = 'PPDPart_Hash';
 769                 parent::__construct( $data );
 770         }
 771
 772         /**
 773          * Get the accumulator that would result if the close is not found.
 774          *
 775          * @param int|bool $openingCount
 776          * @return PPDAccum_Hash
 777          */
 778         public function breakSyntax( $openingCount = false ) {
 779                 if ( $this->open == "\n" ) {
 780                         $accum = $this->parts[0]->out;
 781                 } else {
 782                         if ( $openingCount === false ) {
 783                                 $openingCount = $this->count;
 784                         }
 785                         $accum = new PPDAccum_Hash;
 786                         $accum->addLiteral( str_repeat( $this->open, $openingCount ) );
 787                         $first = true;
 788                         foreach ( $this->parts as $part ) {
 789                                 if ( $first ) {
 790                                         $first = false;
 791                                 } else {
 792                                         $accum->addLiteral( '|' );
 793                                 }
 794                                 $accum->addAccum( $part->out );
 795                         }
 796                 }
 797                 return $accum;
 798         }
 799 }
 800
 801 /**
 802  * @ingroup Parser
 803  * @codingStandardsIgnoreStart
 804  */
 805 class PPDPart_Hash extends PPDPart {
 806         // @codingStandardsIgnoreEnd
 807
 808         public function __construct( $out = '' ) {
 809                 $accum = new PPDAccum_Hash;
 810                 if ( $out !== '' ) {
 811                         $accum->addLiteral( $out );
 812                 }
 813                 parent::__construct( $accum );
 814         }
 815 }
 816
 817 /**
 818  * @ingroup Parser
 819  * @codingStandardsIgnoreStart
 820  */
 821 class PPDAccum_Hash {
 822         // @codingStandardsIgnoreEnd
 823
 824         public $firstNode, $lastNode;
 825
 826         public function __construct() {
 827                 $this->firstNode = $this->lastNode = false;
 828         }
 829
 830         /**
 831          * Append a string literal
 832          * @param string $s
 833          */
 834         public function addLiteral( $s ) {
 835                 if ( $this->lastNode === false ) {
 836                         $this->firstNode = $this->lastNode = new PPNode_Hash_Text( $s );
 837                 } elseif ( $this->lastNode instanceof PPNode_Hash_Text ) {
 838                         $this->lastNode->value .= $s;
 839                 } else {
 840                         $this->lastNode->nextSibling = new PPNode_Hash_Text( $s );
 841                         $this->lastNode = $this->lastNode->nextSibling;
 842                 }
 843         }
 844
 845         /**
 846          * Append a PPNode
 847          * @param PPNode $node
 848          */
 849         public function addNode( PPNode $node ) {
 850                 if ( $this->lastNode === false ) {
 851                         $this->firstNode = $this->lastNode = $node;
 852                 } else {
 853                         $this->lastNode->nextSibling = $node;
 854                         $this->lastNode = $node;
 855                 }
 856         }
 857
 858         /**
 859          * Append a tree node with text contents
 860          * @param string $name
 861          * @param string $value
 862          */
 863         public function addNodeWithText( $name, $value ) {
 864                 $node = PPNode_Hash_Tree::newWithText( $name, $value );
 865                 $this->addNode( $node );
 866         }
 867
 868         /**
 869          * Append a PPDAccum_Hash
 870          * Takes over ownership of the nodes in the source argument. These nodes may
 871          * subsequently be modified, especially nextSibling.
 872          * @param PPDAccum_Hash $accum
 873          */
 874         public function addAccum( $accum ) {
 875                 if ( $accum->lastNode === false ) {
 876                         // nothing to add
 877                 } elseif ( $this->lastNode === false ) {
 878                         $this->firstNode = $accum->firstNode;
 879                         $this->lastNode = $accum->lastNode;
 880                 } else {
 881                         $this->lastNode->nextSibling = $accum->firstNode;
 882                         $this->lastNode = $accum->lastNode;
 883                 }
 884         }
 885 }
 886
 887 /**
 888  * An expansion frame, used as a context to expand the result of preprocessToObj()
 889  * @ingroup Parser
 890  * @codingStandardsIgnoreStart
 891  */
 892 class PPFrame_Hash implements PPFrame {
 893         // @codingStandardsIgnoreEnd
 894
 895         /**
 896          * @var Parser
 897          */
 898         public $parser;
 899
 900         /**
 901          * @var Preprocessor
 902          */
 903         public $preprocessor;
 904
 905         /**
 906          * @var Title
 907          */
 908         public $title;
 909         public $titleCache;
 910
 911         /**
 912          * Hashtable listing templates which are disallowed for expansion in this frame,
 913          * having been encountered previously in parent frames.
 914          */
 915         public $loopCheckHash;
 916
 917         /**
 918          * Recursion depth of this frame, top = 0
 919          * Note that this is NOT the same as expansion depth in expand()
 920          */
 921         public $depth;
 922
 923         private $volatile = false;
 924         private $ttl = null;
 925
 926         /**
 927          * @var array
 928          */
 929         protected $childExpansionCache;
 930
 931         /**
 932          * Construct a new preprocessor frame.
 933          * @param Preprocessor $preprocessor The parent preprocessor
 934          */
 935         public function __construct( $preprocessor ) {
 936                 $this->preprocessor = $preprocessor;
 937                 $this->parser = $preprocessor->parser;
 938                 $this->title = $this->parser->mTitle;
 939                 $this->titleCache = array( $this->title ? $this->title->getPrefixedDBkey() : false );
 940                 $this->loopCheckHash = array();
 941                 $this->depth = 0;
 942                 $this->childExpansionCache = array();
 943         }
 944
 945         /**
 946          * Create a new child frame
 947          * $args is optionally a multi-root PPNode or array containing the template arguments
 948          *
 949          * @param array|bool|PPNode_Hash_Array $args
 950          * @param Title|bool $title
 951          * @param int $indexOffset
 952          * @throws MWException
 953          * @return PPTemplateFrame_Hash
 954          */
 955         public function newChild( $args = false, $title = false, $indexOffset = 0 ) {
 956                 $namedArgs = array();
 957                 $numberedArgs = array();
 958                 if ( $title === false ) {
 959                         $title = $this->title;
 960                 }
 961                 if ( $args !== false ) {
 962                         if ( $args instanceof PPNode_Hash_Array ) {
 963                                 $args = $args->value;
 964                         } elseif ( !is_array( $args ) ) {
 965                                 throw new MWException( __METHOD__ . ': $args must be array or PPNode_Hash_Array' );
 966                         }
 967                         foreach ( $args as $arg ) {
 968                                 $bits = $arg->splitArg();
 969                                 if ( $bits['index'] !== '' ) {
 970                                         // Numbered parameter
 971                                         $index = $bits['index'] - $indexOffset;
 972                                         if ( isset( $namedArgs[$index] ) || isset( $numberedArgs[$index] ) ) {
 973                                                 $this->parser->getOutput()->addWarning( wfMessage( 'duplicate-args-warning',
 974                                                         wfEscapeWikiText( $this->title ),
 975                                                         wfEscapeWikiText( $title ),
 976                                                         wfEscapeWikiText( $index ) )->text() );
 977                                                 $this->parser->addTrackingCategory( 'duplicate-args-category' );
 978                                         }
 979                                         $numberedArgs[$index] = $bits['value'];
 980                                         unset( $namedArgs[$index] );
 981                                 } else {
 982                                         // Named parameter
 983                                         $name = trim( $this->expand( $bits['name'], PPFrame::STRIP_COMMENTS ) );
 984                                         if ( isset( $namedArgs[$name] ) || isset( $numberedArgs[$name] ) ) {
 985                                                 $this->parser->getOutput()->addWarning( wfMessage( 'duplicate-args-warning',
 986                                                         wfEscapeWikiText( $this->title ),
 987                                                         wfEscapeWikiText( $title ),
 988                                                         wfEscapeWikiText( $name ) )->text() );
 989                                                 $this->parser->addTrackingCategory( 'duplicate-args-category' );
 990                                         }
 991                                         $namedArgs[$name] = $bits['value'];
 992                                         unset( $numberedArgs[$name] );
 993                                 }
 994                         }
 995                 }
 996                 return new PPTemplateFrame_Hash( $this->preprocessor, $this, $numberedArgs, $namedArgs, $title );
 997         }
 998
 999         /**
1000          * @throws MWException
1001          * @param string|int $key
1002          * @param string|PPNode $root
1003          * @param int $flags
1004          * @return string
1005          */
1006         public function cachedExpand( $key, $root, $flags = 0 ) {
1007                 // we don't have a parent, so we don't have a cache
1008                 return $this->expand( $root, $flags );
1009         }
1010
1011         /**
1012          * @throws MWException
1013          * @param string|PPNode $root
1014          * @param int $flags
1015          * @return string
1016          */
1017         public function expand( $root, $flags = 0 ) {
1018                 static $expansionDepth = 0;
1019                 if ( is_string( $root ) ) {
1020                         return $root;
1021                 }
1022
1023                 if ( ++$this->parser->mPPNodeCount > $this->parser->mOptions->getMaxPPNodeCount() ) {
1024                         $this->parser->limitationWarn( 'node-count-exceeded',
1025                                         $this->parser->mPPNodeCount,
1026                                         $this->parser->mOptions->getMaxPPNodeCount()
1027                         );
1028                         return '<span class="error">Node-count limit exceeded</span>';
1029                 }
1030                 if ( $expansionDepth > $this->parser->mOptions->getMaxPPExpandDepth() ) {
1031                         $this->parser->limitationWarn( 'expansion-depth-exceeded',
1032                                         $expansionDepth,
1033                                         $this->parser->mOptions->getMaxPPExpandDepth()
1034                         );
1035                         return '<span class="error">Expansion depth limit exceeded</span>';
1036                 }
1037                 ++$expansionDepth;
1038                 if ( $expansionDepth > $this->parser->mHighestExpansionDepth ) {
1039                         $this->parser->mHighestExpansionDepth = $expansionDepth;
1040                 }
1041
1042                 $outStack = array( '', '' );
1043                 $iteratorStack = array( false, $root );
1044                 $indexStack = array( 0, 0 );
1045
1046                 while ( count( $iteratorStack ) > 1 ) {
1047                         $level = count( $outStack ) - 1;
1048                         $iteratorNode =& $iteratorStack[$level];
1049                         $out =& $outStack[$level];
1050                         $index =& $indexStack[$level];
1051
1052                         if ( is_array( $iteratorNode ) ) {
1053                                 if ( $index >= count( $iteratorNode ) ) {
1054                                         // All done with this iterator
1055                                         $iteratorStack[$level] = false;
1056                                         $contextNode = false;
1057                                 } else {
1058                                         $contextNode = $iteratorNode[$index];
1059                                         $index++;
1060                                 }
1061                         } elseif ( $iteratorNode instanceof PPNode_Hash_Array ) {
1062                                 if ( $index >= $iteratorNode->getLength() ) {
1063                                         // All done with this iterator
1064                                         $iteratorStack[$level] = false;
1065                                         $contextNode = false;
1066                                 } else {
1067                                         $contextNode = $iteratorNode->item( $index );
1068                                         $index++;
1069                                 }
1070                         } else {
1071                                 // Copy to $contextNode and then delete from iterator stack,
1072                                 // because this is not an iterator but we do have to execute it once
1073                                 $contextNode = $iteratorStack[$level];
1074                                 $iteratorStack[$level] = false;
1075                         }
1076
1077                         $newIterator = false;
1078
1079                         if ( $contextNode === false ) {
1080                                 // nothing to do
1081                         } elseif ( is_string( $contextNode ) ) {
1082                                 $out .= $contextNode;
1083                         } elseif ( is_array( $contextNode ) || $contextNode instanceof PPNode_Hash_Array ) {
1084                                 $newIterator = $contextNode;
1085                         } elseif ( $contextNode instanceof PPNode_Hash_Attr ) {
1086                                 // No output
1087                         } elseif ( $contextNode instanceof PPNode_Hash_Text ) {
1088                                 $out .= $contextNode->value;
1089                         } elseif ( $contextNode instanceof PPNode_Hash_Tree ) {
1090                                 if ( $contextNode->name == 'template' ) {
1091                                         # Double-brace expansion
1092                                         $bits = $contextNode->splitTemplate();
1093                                         if ( $flags & PPFrame::NO_TEMPLATES ) {
1094                                                 $newIterator = $this->virtualBracketedImplode(
1095                                                         '{{', '|', '}}',
1096                                                         $bits['title'],
1097                                                         $bits['parts']
1098                                                 );
1099                                         } else {
1100                                                 $ret = $this->parser->braceSubstitution( $bits, $this );
1101                                                 if ( isset( $ret['object'] ) ) {
1102                                                         $newIterator = $ret['object'];
1103                                                 } else {
1104                                                         $out .= $ret['text'];
1105                                                 }
1106                                         }
1107                                 } elseif ( $contextNode->name == 'tplarg' ) {
1108                                         # Triple-brace expansion
1109                                         $bits = $contextNode->splitTemplate();
1110                                         if ( $flags & PPFrame::NO_ARGS ) {
1111                                                 $newIterator = $this->virtualBracketedImplode(
1112                                                         '{{{', '|', '}}}',
1113                                                         $bits['title'],
1114                                                         $bits['parts']
1115                                                 );
1116                                         } else {
1117                                                 $ret = $this->parser->argSubstitution( $bits, $this );
1118                                                 if ( isset( $ret['object'] ) ) {
1119                                                         $newIterator = $ret['object'];
1120                                                 } else {
1121                                                         $out .= $ret['text'];
1122                                                 }
1123                                         }
1124                                 } elseif ( $contextNode->name == 'comment' ) {
1125                                         # HTML-style comment
1126                                         # Remove it in HTML, pre+remove and STRIP_COMMENTS modes
1127                                         if ( $this->parser->ot['html']
1128                                                 || ( $this->parser->ot['pre'] && $this->parser->mOptions->getRemoveComments() )
1129                                                 || ( $flags & PPFrame::STRIP_COMMENTS )
1130                                         ) {
1131                                                 $out .= '';
1132                                         } elseif ( $this->parser->ot['wiki'] && !( $flags & PPFrame::RECOVER_COMMENTS ) ) {
1133                                                 # Add a strip marker in PST mode so that pstPass2() can
1134                                                 # run some old-fashioned regexes on the result.
1135                                                 # Not in RECOVER_COMMENTS mode (extractSections) though.
1136                                                 $out .= $this->parser->insertStripItem( $contextNode->firstChild->value );
1137                                         } else {
1138                                                 # Recover the literal comment in RECOVER_COMMENTS and pre+no-remove
1139                                                 $out .= $contextNode->firstChild->value;
1140                                         }
1141                                 } elseif ( $contextNode->name == 'ignore' ) {
1142                                         # Output suppression used by <includeonly> etc.
1143                                         # OT_WIKI will only respect <ignore> in substed templates.
1144                                         # The other output types respect it unless NO_IGNORE is set.
1145                                         # extractSections() sets NO_IGNORE and so never respects it.
1146                                         if ( ( !isset( $this->parent ) && $this->parser->ot['wiki'] )
1147                                                 || ( $flags & PPFrame::NO_IGNORE )
1148                                         ) {
1149                                                 $out .= $contextNode->firstChild->value;
1150                                         } else {
1151                                                 //$out .= '';
1152                                         }
1153                                 } elseif ( $contextNode->name == 'ext' ) {
1154                                         # Extension tag
1155                                         $bits = $contextNode->splitExt() + array( 'attr' => null, 'inner' => null, 'close' => null );
1156                                         if ( $flags & PPFrame::NO_TAGS ) {
1157                                                 $s = '<' . $bits['name']->firstChild->value;
1158                                                 if ( $bits['attr'] ) {
1159                                                         $s .= $bits['attr']->firstChild->value;
1160                                                 }
1161                                                 if ( $bits['inner'] ) {
1162                                                         $s .= '>' . $bits['inner']->firstChild->value;
1163                                                         if ( $bits['close'] ) {
1164                                                                 $s .= $bits['close']->firstChild->value;
1165                                                         }
1166                                                 } else {
1167                                                         $s .= '/>';
1168                                                 }
1169                                                 $out .= $s;
1170                                         } else {
1171                                                 $out .= $this->parser->extensionSubstitution( $bits, $this );
1172                                         }
1173                                 } elseif ( $contextNode->name == 'h' ) {
1174                                         # Heading
1175                                         if ( $this->parser->ot['html'] ) {
1176                                                 # Expand immediately and insert heading index marker
1177                                                 $s = '';
1178                                                 for ( $node = $contextNode->firstChild; $node; $node = $node->nextSibling ) {
1179                                                         $s .= $this->expand( $node, $flags );
1180                                                 }
1181
1182                                                 $bits = $contextNode->splitHeading();
1183                                                 $titleText = $this->title->getPrefixedDBkey();
1184                                                 $this->parser->mHeadings[] = array( $titleText, $bits['i'] );
1185                                                 $serial = count( $this->parser->mHeadings ) - 1;
1186                                                 $marker = Parser::MARKER_PREFIX . "-h-$serial-" . Parser::MARKER_SUFFIX;
1187                                                 $s = substr( $s, 0, $bits['level'] ) . $marker . substr( $s, $bits['level'] );
1188                                                 $this->parser->mStripState->addGeneral( $marker, '' );
1189                                                 $out .= $s;
1190                                         } else {
1191                                                 # Expand in virtual stack
1192                                                 $newIterator = $contextNode->getChildren();
1193                                         }
1194                                 } else {
1195                                         # Generic recursive expansion
1196                                         $newIterator = $contextNode->getChildren();
1197                                 }
1198                         } else {
1199                                 throw new MWException( __METHOD__ . ': Invalid parameter type' );
1200                         }
1201
1202                         if ( $newIterator !== false ) {
1203                                 $outStack[] = '';
1204                                 $iteratorStack[] = $newIterator;
1205                                 $indexStack[] = 0;
1206                         } elseif ( $iteratorStack[$level] === false ) {
1207                                 // Return accumulated value to parent
1208                                 // With tail recursion
1209                                 while ( $iteratorStack[$level] === false && $level > 0 ) {
1210                                         $outStack[$level - 1] .= $out;
1211                                         array_pop( $outStack );
1212                                         array_pop( $iteratorStack );
1213                                         array_pop( $indexStack );
1214                                         $level--;
1215                                 }
1216                         }
1217                 }
1218                 --$expansionDepth;
1219                 return $outStack[0];
1220         }
1221
1222         /**
1223          * @param string $sep
1224          * @param int $flags
1225          * @param string|PPNode $args,...
1226          * @return string
1227          */
1228         public function implodeWithFlags( $sep, $flags /*, ... */ ) {
1229                 $args = array_slice( func_get_args(), 2 );
1230
1231                 $first = true;
1232                 $s = '';
1233                 foreach ( $args as $root ) {
1234                         if ( $root instanceof PPNode_Hash_Array ) {
1235                                 $root = $root->value;
1236                         }
1237                         if ( !is_array( $root ) ) {
1238                                 $root = array( $root );
1239                         }
1240                         foreach ( $root as $node ) {
1241                                 if ( $first ) {
1242                                         $first = false;
1243                                 } else {
1244                                         $s .= $sep;
1245                                 }
1246                                 $s .= $this->expand( $node, $flags );
1247                         }
1248                 }
1249                 return $s;
1250         }
1251
1252         /**
1253          * Implode with no flags specified
1254          * This previously called implodeWithFlags but has now been inlined to reduce stack depth
1255          * @param string $sep
1256          * @param string|PPNode $args,...
1257          * @return string
1258          */
1259         public function implode( $sep /*, ... */ ) {
1260                 $args = array_slice( func_get_args(), 1 );
1261
1262                 $first = true;
1263                 $s = '';
1264                 foreach ( $args as $root ) {
1265                         if ( $root instanceof PPNode_Hash_Array ) {
1266                                 $root = $root->value;
1267                         }
1268                         if ( !is_array( $root ) ) {
1269                                 $root = array( $root );
1270                         }
1271                         foreach ( $root as $node ) {
1272                                 if ( $first ) {
1273                                         $first = false;
1274                                 } else {
1275                                         $s .= $sep;
1276                                 }
1277                                 $s .= $this->expand( $node );
1278                         }
1279                 }
1280                 return $s;
1281         }
1282
1283         /**
1284          * Makes an object that, when expand()ed, will be the same as one obtained
1285          * with implode()
1286          *
1287          * @param string $sep
1288          * @param string|PPNode $args,...
1289          * @return PPNode_Hash_Array
1290          */
1291         public function virtualImplode( $sep /*, ... */ ) {
1292                 $args = array_slice( func_get_args(), 1 );
1293                 $out = array();
1294                 $first = true;
1295
1296                 foreach ( $args as $root ) {
1297                         if ( $root instanceof PPNode_Hash_Array ) {
1298                                 $root = $root->value;
1299                         }
1300                         if ( !is_array( $root ) ) {
1301                                 $root = array( $root );
1302                         }
1303                         foreach ( $root as $node ) {
1304                                 if ( $first ) {
1305                                         $first = false;
1306                                 } else {
1307                                         $out[] = $sep;
1308                                 }
1309                                 $out[] = $node;
1310                         }
1311                 }
1312                 return new PPNode_Hash_Array( $out );
1313         }
1314
1315         /**
1316          * Virtual implode with brackets
1317          *
1318          * @param string $start
1319          * @param string $sep
1320          * @param string $end
1321          * @param string|PPNode $args,...
1322          * @return PPNode_Hash_Array
1323          */
1324         public function virtualBracketedImplode( $start, $sep, $end /*, ... */ ) {
1325                 $args = array_slice( func_get_args(), 3 );
1326                 $out = array( $start );
1327                 $first = true;
1328
1329                 foreach ( $args as $root ) {
1330                         if ( $root instanceof PPNode_Hash_Array ) {
1331                                 $root = $root->value;
1332                         }
1333                         if ( !is_array( $root ) ) {
1334                                 $root = array( $root );
1335                         }
1336                         foreach ( $root as $node ) {
1337                                 if ( $first ) {
1338                                         $first = false;
1339                                 } else {
1340                                         $out[] = $sep;
1341                                 }
1342                                 $out[] = $node;
1343                         }
1344                 }
1345                 $out[] = $end;
1346                 return new PPNode_Hash_Array( $out );
1347         }
1348
1349         public function __toString() {
1350                 return 'frame{}';
1351         }
1352
1353         /**
1354          * @param bool $level
1355          * @return array|bool|string
1356          */
1357         public function getPDBK( $level = false ) {
1358                 if ( $level === false ) {
1359                         return $this->title->getPrefixedDBkey();
1360                 } else {
1361                         return isset( $this->titleCache[$level] ) ? $this->titleCache[$level] : false;
1362                 }
1363         }
1364
1365         /**
1366          * @return array
1367          */
1368         public function getArguments() {
1369                 return array();
1370         }
1371
1372         /**
1373          * @return array
1374          */
1375         public function getNumberedArguments() {
1376                 return array();
1377         }
1378
1379         /**
1380          * @return array
1381          */
1382         public function getNamedArguments() {
1383                 return array();
1384         }
1385
1386         /**
1387          * Returns true if there are no arguments in this frame
1388          *
1389          * @return bool
1390          */
1391         public function isEmpty() {
1392                 return true;
1393         }
1394
1395         /**
1396          * @param string $name
1397          * @return bool
1398          */
1399         public function getArgument( $name ) {
1400                 return false;
1401         }
1402
1403         /**
1404          * Returns true if the infinite loop check is OK, false if a loop is detected
1405          *
1406          * @param Title $title
1407          *
1408          * @return bool
1409          */
1410         public function loopCheck( $title ) {
1411                 return !isset( $this->loopCheckHash[$title->getPrefixedDBkey()] );
1412         }
1413
1414         /**
1415          * Return true if the frame is a template frame
1416          *
1417          * @return bool
1418          */
1419         public function isTemplate() {
1420                 return false;
1421         }
1422
1423         /**
1424          * Get a title of frame
1425          *
1426          * @return Title
1427          */
1428         public function getTitle() {
1429                 return $this->title;
1430         }
1431
1432         /**
1433          * Set the volatile flag
1434          *
1435          * @param bool $flag
1436          */
1437         public function setVolatile( $flag = true ) {
1438                 $this->volatile = $flag;
1439         }
1440
1441         /**
1442          * Get the volatile flag
1443          *
1444          * @return bool
1445          */
1446         public function isVolatile() {
1447                 return $this->volatile;
1448         }
1449
1450         /**
1451          * Set the TTL
1452          *
1453          * @param int $ttl
1454          */
1455         public function setTTL( $ttl ) {
1456                 if ( $ttl !== null && ( $this->ttl === null || $ttl < $this->ttl ) ) {
1457                         $this->ttl = $ttl;
1458                 }
1459         }
1460
1461         /**
1462          * Get the TTL
1463          *
1464          * @return int|null
1465          */
1466         public function getTTL() {
1467                 return $this->ttl;
1468         }
1469 }
1470
1471 /**
1472  * Expansion frame with template arguments
1473  * @ingroup Parser
1474  * @codingStandardsIgnoreStart
1475  */
1476 class PPTemplateFrame_Hash extends PPFrame_Hash {
1477         // @codingStandardsIgnoreEnd
1478
1479         public $numberedArgs, $namedArgs, $parent;
1480         public $numberedExpansionCache, $namedExpansionCache;
1481
1482         /**
1483          * @param Preprocessor $preprocessor
1484          * @param bool|PPFrame $parent
1485          * @param array $numberedArgs
1486          * @param array $namedArgs
1487          * @param bool|Title $title
1488          */
1489         public function __construct( $preprocessor, $parent = false, $numberedArgs = array(),
1490                 $namedArgs = array(), $title = false
1491         ) {
1492                 parent::__construct( $preprocessor );
1493
1494                 $this->parent = $parent;
1495                 $this->numberedArgs = $numberedArgs;
1496                 $this->namedArgs = $namedArgs;
1497                 $this->title = $title;
1498                 $pdbk = $title ? $title->getPrefixedDBkey() : false;
1499                 $this->titleCache = $parent->titleCache;
1500                 $this->titleCache[] = $pdbk;
1501                 $this->loopCheckHash = /*clone*/ $parent->loopCheckHash;
1502                 if ( $pdbk !== false ) {
1503                         $this->loopCheckHash[$pdbk] = true;
1504                 }
1505                 $this->depth = $parent->depth + 1;
1506                 $this->numberedExpansionCache = $this->namedExpansionCache = array();
1507         }
1508
1509         public function __toString() {
1510                 $s = 'tplframe{';
1511                 $first = true;
1512                 $args = $this->numberedArgs + $this->namedArgs;
1513                 foreach ( $args as $name => $value ) {
1514                         if ( $first ) {
1515                                 $first = false;
1516                         } else {
1517                                 $s .= ', ';
1518                         }
1519                         $s .= "\"$name\":\"" .
1520                                 str_replace( '"', '\\"', $value->__toString() ) . '"';
1521                 }
1522                 $s .= '}';
1523                 return $s;
1524         }
1525
1526         /**
1527          * @throws MWException
1528          * @param string|int $key
1529          * @param string|PPNode $root
1530          * @param int $flags
1531          * @return string
1532          */
1533         public function cachedExpand( $key, $root, $flags = 0 ) {
1534                 if ( isset( $this->parent->childExpansionCache[$key] ) ) {
1535                         return $this->parent->childExpansionCache[$key];
1536                 }
1537                 $retval = $this->expand( $root, $flags );
1538                 if ( !$this->isVolatile() ) {
1539                         $this->parent->childExpansionCache[$key] = $retval;
1540                 }
1541                 return $retval;
1542         }
1543
1544         /**
1545          * Returns true if there are no arguments in this frame
1546          *
1547          * @return bool
1548          */
1549         public function isEmpty() {
1550                 return !count( $this->numberedArgs ) && !count( $this->namedArgs );
1551         }
1552
1553         /**
1554          * @return array
1555          */
1556         public function getArguments() {
1557                 $arguments = array();
1558                 foreach ( array_merge(
1559                                 array_keys( $this->numberedArgs ),
1560                                 array_keys( $this->namedArgs ) ) as $key ) {
1561                         $arguments[$key] = $this->getArgument( $key );
1562                 }
1563                 return $arguments;
1564         }
1565
1566         /**
1567          * @return array
1568          */
1569         public function getNumberedArguments() {
1570                 $arguments = array();
1571                 foreach ( array_keys( $this->numberedArgs ) as $key ) {
1572                         $arguments[$key] = $this->getArgument( $key );
1573                 }
1574                 return $arguments;
1575         }
1576
1577         /**
1578          * @return array
1579          */
1580         public function getNamedArguments() {
1581                 $arguments = array();
1582                 foreach ( array_keys( $this->namedArgs ) as $key ) {
1583                         $arguments[$key] = $this->getArgument( $key );
1584                 }
1585                 return $arguments;
1586         }
1587
1588         /**
1589          * @param int $index
1590          * @return array|bool
1591          */
1592         public function getNumberedArgument( $index ) {
1593                 if ( !isset( $this->numberedArgs[$index] ) ) {
1594                         return false;
1595                 }
1596                 if ( !isset( $this->numberedExpansionCache[$index] ) ) {
1597                         # No trimming for unnamed arguments
1598                         $this->numberedExpansionCache[$index] = $this->parent->expand(
1599                                 $this->numberedArgs[$index],
1600                                 PPFrame::STRIP_COMMENTS
1601                         );
1602                 }
1603                 return $this->numberedExpansionCache[$index];
1604         }
1605
1606         /**
1607          * @param string $name
1608          * @return bool
1609          */
1610         public function getNamedArgument( $name ) {
1611                 if ( !isset( $this->namedArgs[$name] ) ) {
1612                         return false;
1613                 }
1614                 if ( !isset( $this->namedExpansionCache[$name] ) ) {
1615                         # Trim named arguments post-expand, for backwards compatibility
1616                         $this->namedExpansionCache[$name] = trim(
1617                                 $this->parent->expand( $this->namedArgs[$name], PPFrame::STRIP_COMMENTS ) );
1618                 }
1619                 return $this->namedExpansionCache[$name];
1620         }
1621
1622         /**
1623          * @param string $name
1624          * @return array|bool
1625          */
1626         public function getArgument( $name ) {
1627                 $text = $this->getNumberedArgument( $name );
1628                 if ( $text === false ) {
1629                         $text = $this->getNamedArgument( $name );
1630                 }
1631                 return $text;
1632         }
1633
1634         /**
1635          * Return true if the frame is a template frame
1636          *
1637          * @return bool
1638          */
1639         public function isTemplate() {
1640                 return true;
1641         }
1642
1643         public function setVolatile( $flag = true ) {
1644                 parent::setVolatile( $flag );
1645                 $this->parent->setVolatile( $flag );
1646         }
1647
1648         public function setTTL( $ttl ) {
1649                 parent::setTTL( $ttl );
1650                 $this->parent->setTTL( $ttl );
1651         }
1652 }
1653
1654 /**
1655  * Expansion frame with custom arguments
1656  * @ingroup Parser
1657  * @codingStandardsIgnoreStart
1658  */
1659 class PPCustomFrame_Hash extends PPFrame_Hash {
1660         // @codingStandardsIgnoreEnd
1661
1662         public $args;
1663
1664         public function __construct( $preprocessor, $args ) {
1665                 parent::__construct( $preprocessor );
1666                 $this->args = $args;
1667         }
1668
1669         public function __toString() {
1670                 $s = 'cstmframe{';
1671                 $first = true;
1672                 foreach ( $this->args as $name => $value ) {
1673                         if ( $first ) {
1674                                 $first = false;
1675                         } else {
1676                                 $s .= ', ';
1677                         }
1678                         $s .= "\"$name\":\"" .
1679                                 str_replace( '"', '\\"', $value->__toString() ) . '"';
1680                 }
1681                 $s .= '}';
1682                 return $s;
1683         }
1684
1685         /**
1686          * @return bool
1687          */
1688         public function isEmpty() {
1689                 return !count( $this->args );
1690         }
1691
1692         /**
1693          * @param int $index
1694          * @return bool
1695          */
1696         public function getArgument( $index ) {
1697                 if ( !isset( $this->args[$index] ) ) {
1698                         return false;
1699                 }
1700                 return $this->args[$index];
1701         }
1702
1703         public function getArguments() {
1704                 return $this->args;
1705         }
1706 }
1707
1708 /**
1709  * @ingroup Parser
1710  * @codingStandardsIgnoreStart
1711  */
1712 class PPNode_Hash_Tree implements PPNode {
1713         // @codingStandardsIgnoreEnd
1714
1715         public $name, $firstChild, $lastChild, $nextSibling;
1716
1717         public function __construct( $name ) {
1718                 $this->name = $name;
1719                 $this->firstChild = $this->lastChild = $this->nextSibling = false;
1720         }
1721
1722         public function __toString() {
1723                 $inner = '';
1724                 $attribs = '';
1725                 for ( $node = $this->firstChild; $node; $node = $node->nextSibling ) {
1726                         if ( $node instanceof PPNode_Hash_Attr ) {
1727                                 $attribs .= ' ' . $node->name . '="' . htmlspecialchars( $node->value ) . '"';
1728                         } else {
1729                                 $inner .= $node->__toString();
1730                         }
1731                 }
1732                 if ( $inner === '' ) {
1733                         return "<{$this->name}$attribs/>";
1734                 } else {
1735                         return "<{$this->name}$attribs>$inner</{$this->name}>";
1736                 }
1737         }
1738
1739         /**
1740          * @param string $name
1741          * @param string $text
1742          * @return PPNode_Hash_Tree
1743          */
1744         public static function newWithText( $name, $text ) {
1745                 $obj = new self( $name );
1746                 $obj->addChild( new PPNode_Hash_Text( $text ) );
1747                 return $obj;
1748         }
1749
1750         public function addChild( $node ) {
1751                 if ( $this->lastChild === false ) {
1752                         $this->firstChild = $this->lastChild = $node;
1753                 } else {
1754                         $this->lastChild->nextSibling = $node;
1755                         $this->lastChild = $node;
1756                 }
1757         }
1758
1759         /**
1760          * @return PPNode_Hash_Array
1761          */
1762         public function getChildren() {
1763                 $children = array();
1764                 for ( $child = $this->firstChild; $child; $child = $child->nextSibling ) {
1765                         $children[] = $child;
1766                 }
1767                 return new PPNode_Hash_Array( $children );
1768         }
1769
1770         public function getFirstChild() {
1771                 return $this->firstChild;
1772         }
1773
1774         public function getNextSibling() {
1775                 return $this->nextSibling;
1776         }
1777
1778         public function getChildrenOfType( $name ) {
1779                 $children = array();
1780                 for ( $child = $this->firstChild; $child; $child = $child->nextSibling ) {
1781                         if ( isset( $child->name ) && $child->name === $name ) {
1782                                 $children[] = $child;
1783                         }
1784                 }
1785                 return $children;
1786         }
1787
1788         /**
1789          * @return bool
1790          */
1791         public function getLength() {
1792                 return false;
1793         }
1794
1795         /**
1796          * @param int $i
1797          * @return bool
1798          */
1799         public function item( $i ) {
1800                 return false;
1801         }
1802
1803         /**
1804          * @return string
1805          */
1806         public function getName() {
1807                 return $this->name;
1808         }
1809
1810         /**
1811          * Split a "<part>" node into an associative array containing:
1812          *  - name          PPNode name
1813          *  - index         String index
1814          *  - value         PPNode value
1815          *
1816          * @throws MWException
1817          * @return array
1818          */
1819         public function splitArg() {
1820                 $bits = array();
1821                 for ( $child = $this->firstChild; $child; $child = $child->nextSibling ) {
1822                         if ( !isset( $child->name ) ) {
1823                                 continue;
1824                         }
1825                         if ( $child->name === 'name' ) {
1826                                 $bits['name'] = $child;
1827                                 if ( $child->firstChild instanceof PPNode_Hash_Attr
1828                                         && $child->firstChild->name === 'index'
1829                                 ) {
1830                                         $bits['index'] = $child->firstChild->value;
1831                                 }
1832                         } elseif ( $child->name === 'value' ) {
1833                                 $bits['value'] = $child;
1834                         }
1835                 }
1836
1837                 if ( !isset( $bits['name'] ) ) {
1838                         throw new MWException( 'Invalid brace node passed to ' . __METHOD__ );
1839                 }
1840                 if ( !isset( $bits['index'] ) ) {
1841                         $bits['index'] = '';
1842                 }
1843                 return $bits;
1844         }
1845
1846         /**
1847          * Split an "<ext>" node into an associative array containing name, attr, inner and close
1848          * All values in the resulting array are PPNodes. Inner and close are optional.
1849          *
1850          * @throws MWException
1851          * @return array
1852          */
1853         public function splitExt() {
1854                 $bits = array();
1855                 for ( $child = $this->firstChild; $child; $child = $child->nextSibling ) {
1856                         if ( !isset( $child->name ) ) {
1857                                 continue;
1858                         }
1859                         if ( $child->name == 'name' ) {
1860                                 $bits['name'] = $child;
1861                         } elseif ( $child->name == 'attr' ) {
1862                                 $bits['attr'] = $child;
1863                         } elseif ( $child->name == 'inner' ) {
1864                                 $bits['inner'] = $child;
1865                         } elseif ( $child->name == 'close' ) {
1866                                 $bits['close'] = $child;
1867                         }
1868                 }
1869                 if ( !isset( $bits['name'] ) ) {
1870                         throw new MWException( 'Invalid ext node passed to ' . __METHOD__ );
1871                 }
1872                 return $bits;
1873         }
1874
1875         /**
1876          * Split an "<h>" node
1877          *
1878          * @throws MWException
1879          * @return array
1880          */
1881         public function splitHeading() {
1882                 if ( $this->name !== 'h' ) {
1883                         throw new MWException( 'Invalid h node passed to ' . __METHOD__ );
1884                 }
1885                 $bits = array();
1886                 for ( $child = $this->firstChild; $child; $child = $child->nextSibling ) {
1887                         if ( !isset( $child->name ) ) {
1888                                 continue;
1889                         }
1890                         if ( $child->name == 'i' ) {
1891                                 $bits['i'] = $child->value;
1892                         } elseif ( $child->name == 'level' ) {
1893                                 $bits['level'] = $child->value;
1894                         }
1895                 }
1896                 if ( !isset( $bits['i'] ) ) {
1897                         throw new MWException( 'Invalid h node passed to ' . __METHOD__ );
1898                 }
1899                 return $bits;
1900         }
1901
1902         /**
1903          * Split a "<template>" or "<tplarg>" node
1904          *
1905          * @throws MWException
1906          * @return array
1907          */
1908         public function splitTemplate() {
1909                 $parts = array();
1910                 $bits = array( 'lineStart' => '' );
1911                 for ( $child = $this->firstChild; $child; $child = $child->nextSibling ) {
1912                         if ( !isset( $child->name ) ) {
1913                                 continue;
1914                         }
1915                         if ( $child->name == 'title' ) {
1916                                 $bits['title'] = $child;
1917                         }
1918                         if ( $child->name == 'part' ) {
1919                                 $parts[] = $child;
1920                         }
1921                         if ( $child->name == 'lineStart' ) {
1922                                 $bits['lineStart'] = '1';
1923                         }
1924                 }
1925                 if ( !isset( $bits['title'] ) ) {
1926                         throw new MWException( 'Invalid node passed to ' . __METHOD__ );
1927                 }
1928                 $bits['parts'] = new PPNode_Hash_Array( $parts );
1929                 return $bits;
1930         }
1931 }
1932
1933 /**
1934  * @ingroup Parser
1935  * @codingStandardsIgnoreStart
1936  */
1937 class PPNode_Hash_Text implements PPNode {
1938         // @codingStandardsIgnoreEnd
1939
1940         public $value, $nextSibling;
1941
1942         public function __construct( $value ) {
1943                 if ( is_object( $value ) ) {
1944                         throw new MWException( __CLASS__ . ' given object instead of string' );
1945                 }
1946                 $this->value = $value;
1947         }
1948
1949         public function __toString() {
1950                 return htmlspecialchars( $this->value );
1951         }
1952
1953         public function getNextSibling() {
1954                 return $this->nextSibling;
1955         }
1956
1957         public function getChildren() {
1958                 return false;
1959         }
1960
1961         public function getFirstChild() {
1962                 return false;
1963         }
1964
1965         public function getChildrenOfType( $name ) {
1966                 return false;
1967         }
1968
1969         public function getLength() {
1970                 return false;
1971         }
1972
1973         public function item( $i ) {
1974                 return false;
1975         }
1976
1977         public function getName() {
1978                 return '#text';
1979         }
1980
1981         public function splitArg() {
1982                 throw new MWException( __METHOD__ . ': not supported' );
1983         }
1984
1985         public function splitExt() {
1986                 throw new MWException( __METHOD__ . ': not supported' );
1987         }
1988
1989         public function splitHeading() {
1990                 throw new MWException( __METHOD__ . ': not supported' );
1991         }
1992 }
1993
1994 /**
1995  * @ingroup Parser
1996  * @codingStandardsIgnoreStart
1997  */
1998 class PPNode_Hash_Array implements PPNode {
1999         // @codingStandardsIgnoreEnd
2000
2001         public $value, $nextSibling;
2002
2003         public function __construct( $value ) {
2004                 $this->value = $value;
2005         }
2006
2007         public function __toString() {
2008                 return var_export( $this, true );
2009         }
2010
2011         public function getLength() {
2012                 return count( $this->value );
2013         }
2014
2015         public function item( $i ) {
2016                 return $this->value[$i];
2017         }
2018
2019         public function getName() {
2020                 return '#nodelist';
2021         }
2022
2023         public function getNextSibling() {
2024                 return $this->nextSibling;
2025         }
2026
2027         public function getChildren() {
2028                 return false;
2029         }
2030
2031         public function getFirstChild() {
2032                 return false;
2033         }
2034
2035         public function getChildrenOfType( $name ) {
2036                 return false;
2037         }
2038
2039         public function splitArg() {
2040                 throw new MWException( __METHOD__ . ': not supported' );
2041         }
2042
2043         public function splitExt() {
2044                 throw new MWException( __METHOD__ . ': not supported' );
2045         }
2046
2047         public function splitHeading() {
2048                 throw new MWException( __METHOD__ . ': not supported' );
2049         }
2050 }
2051
2052 /**
2053  * @ingroup Parser
2054  * @codingStandardsIgnoreStart
2055  */
2056 class PPNode_Hash_Attr implements PPNode {
2057         // @codingStandardsIgnoreEnd
2058
2059         public $name, $value, $nextSibling;
2060
2061         public function __construct( $name, $value ) {
2062                 $this->name = $name;
2063                 $this->value = $value;
2064         }
2065
2066         public function __toString() {
2067                 return "<@{$this->name}>" . htmlspecialchars( $this->value ) . "</@{$this->name}>";
2068         }
2069
2070         public function getName() {
2071                 return $this->name;
2072         }
2073
2074         public function getNextSibling() {
2075                 return $this->nextSibling;
2076         }
2077
2078         public function getChildren() {
2079                 return false;
2080         }
2081
2082         public function getFirstChild() {
2083                 return false;
2084         }
2085
2086         public function getChildrenOfType( $name ) {
2087                 return false;
2088         }
2089
2090         public function getLength() {
2091                 return false;
2092         }
2093
2094         public function item( $i ) {
2095                 return false;
2096         }
2097
2098         public function splitArg() {
2099                 throw new MWException( __METHOD__ . ': not supported' );
2100         }
2101
2102         public function splitExt() {
2103                 throw new MWException( __METHOD__ . ': not supported' );
2104         }
2105
2106         public function splitHeading() {
2107                 throw new MWException( __METHOD__ . ': not supported' );
2108         }
2109 }