includes/parser/Preprocessor_DOM.php

   1 <?php
   2 /**
   3  * Preprocessor using PHP's dom extension
   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  * @ingroup Parser
  26  */
  27 // @codingStandardsIgnoreStart Squiz.Classes.ValidClassName.NotCamelCaps
  28 class Preprocessor_DOM extends Preprocessor {
  29         // @codingStandardsIgnoreEnd
  30
  31         /**
  32          * @var Parser
  33          */
  34         public $parser;
  35
  36         public $memoryLimit;
  37
  38         const CACHE_PREFIX = 'preprocess-xml';
  39
  40         public function __construct( $parser ) {
  41                 $this->parser = $parser;
  42                 $mem = ini_get( 'memory_limit' );
  43                 $this->memoryLimit = false;
  44                 if ( strval( $mem ) !== '' && $mem != -1 ) {
  45                         if ( preg_match( '/^\d+$/', $mem ) ) {
  46                                 $this->memoryLimit = $mem;
  47                         } elseif ( preg_match( '/^(\d+)M$/i', $mem, $m ) ) {
  48                                 $this->memoryLimit = $m[1] * 1048576;
  49                         }
  50                 }
  51         }
  52
  53         /**
  54          * @return PPFrame_DOM
  55          */
  56         public function newFrame() {
  57                 return new PPFrame_DOM( $this );
  58         }
  59
  60         /**
  61          * @param array $args
  62          * @return PPCustomFrame_DOM
  63          */
  64         public function newCustomFrame( $args ) {
  65                 return new PPCustomFrame_DOM( $this, $args );
  66         }
  67
  68         /**
  69          * @param array $values
  70          * @return PPNode_DOM
  71          * @throws MWException
  72          */
  73         public function newPartNodeArray( $values ) {
  74                 // NOTE: DOM manipulation is slower than building & parsing XML! (or so Tim sais)
  75                 $xml = "<list>";
  76
  77                 foreach ( $values as $k => $val ) {
  78                         if ( is_int( $k ) ) {
  79                                 $xml .= "<part><name index=\"$k\"/><value>"
  80                                         . htmlspecialchars( $val ) . "</value></part>";
  81                         } else {
  82                                 $xml .= "<part><name>" . htmlspecialchars( $k )
  83                                         . "</name>=<value>" . htmlspecialchars( $val ) . "</value></part>";
  84                         }
  85                 }
  86
  87                 $xml .= "</list>";
  88
  89                 $dom = new DOMDocument();
  90                 MediaWiki\suppressWarnings();
  91                 $result = $dom->loadXML( $xml );
  92                 MediaWiki\restoreWarnings();
  93                 if ( !$result ) {
  94                         // Try running the XML through UtfNormal to get rid of invalid characters
  95                         $xml = UtfNormal\Validator::cleanUp( $xml );
  96                         // 1 << 19 == XML_PARSE_HUGE, needed so newer versions of libxml2
  97                         // don't barf when the XML is >256 levels deep
  98                         $result = $dom->loadXML( $xml, 1 << 19 );
  99                 }
 100
 101                 if ( !$result ) {
 102                         throw new MWException( 'Parameters passed to ' . __METHOD__ . ' result in invalid XML' );
 103                 }
 104
 105                 $root = $dom->documentElement;
 106                 $node = new PPNode_DOM( $root->childNodes );
 107                 return $node;
 108         }
 109
 110         /**
 111          * @throws MWException
 112          * @return bool
 113          */
 114         public function memCheck() {
 115                 if ( $this->memoryLimit === false ) {
 116                         return true;
 117                 }
 118                 $usage = memory_get_usage();
 119                 if ( $usage > $this->memoryLimit * 0.9 ) {
 120                         $limit = intval( $this->memoryLimit * 0.9 / 1048576 + 0.5 );
 121                         throw new MWException( "Preprocessor hit 90% memory limit ($limit MB)" );
 122                 }
 123                 return $usage <= $this->memoryLimit * 0.8;
 124         }
 125
 126         /**
 127          * Preprocess some wikitext and return the document tree.
 128          * This is the ghost of Parser::replace_variables().
 129          *
 130          * @param string $text The text to parse
 131          * @param int $flags Bitwise combination of:
 132          *     Parser::PTD_FOR_INCLUSION  Handle "<noinclude>" and "<includeonly>"
 133          *                                as if the text is being included. Default
 134          *                                is to assume a direct page view.
 135          *
 136          * The generated DOM tree must depend only on the input text and the flags.
 137          * The DOM tree must be the same in OT_HTML and OT_WIKI mode, to avoid a regression of T6899.
 138          *
 139          * Any flag added to the $flags parameter here, or any other parameter liable to cause a
 140          * change in the DOM tree for a given text, must be passed through the section identifier
 141          * in the section edit link and thus back to extractSections().
 142          *
 143          * The output of this function is currently only cached in process memory, but a persistent
 144          * cache may be implemented at a later date which takes further advantage of these strict
 145          * dependency requirements.
 146          *
 147          * @throws MWException
 148          * @return PPNode_DOM
 149          */
 150         public function preprocessToObj( $text, $flags = 0 ) {
 151
 152                 $xml = $this->cacheGetTree( $text, $flags );
 153                 if ( $xml === false ) {
 154                         $xml = $this->preprocessToXml( $text, $flags );
 155                         $this->cacheSetTree( $text, $flags, $xml );
 156                 }
 157
 158                 // Fail if the number of elements exceeds acceptable limits
 159                 // Do not attempt to generate the DOM
 160                 $this->parser->mGeneratedPPNodeCount += substr_count( $xml, '<' );
 161                 $max = $this->parser->mOptions->getMaxGeneratedPPNodeCount();
 162                 if ( $this->parser->mGeneratedPPNodeCount > $max ) {
 163                         // if ( $cacheable ) { ... }
 164                         throw new MWException( __METHOD__ . ': generated node count limit exceeded' );
 165                 }
 166
 167                 $dom = new DOMDocument;
 168                 MediaWiki\suppressWarnings();
 169                 $result = $dom->loadXML( $xml );
 170                 MediaWiki\restoreWarnings();
 171                 if ( !$result ) {
 172                         // Try running the XML through UtfNormal to get rid of invalid characters
 173                         $xml = UtfNormal\Validator::cleanUp( $xml );
 174                         // 1 << 19 == XML_PARSE_HUGE, needed so newer versions of libxml2
 175                         // don't barf when the XML is >256 levels deep.
 176                         $result = $dom->loadXML( $xml, 1 << 19 );
 177                 }
 178                 if ( $result ) {
 179                         $obj = new PPNode_DOM( $dom->documentElement );
 180                 }
 181
 182                 // if ( $cacheable ) { ... }
 183
 184                 if ( !$result ) {
 185                         throw new MWException( __METHOD__ . ' generated invalid XML' );
 186                 }
 187                 return $obj;
 188         }
 189
 190         /**
 191          * @param string $text
 192          * @param int $flags
 193          * @return string
 194          */
 195         public function preprocessToXml( $text, $flags = 0 ) {
 196                 global $wgDisableLangConversion;
 197
 198                 $forInclusion = $flags & Parser::PTD_FOR_INCLUSION;
 199
 200                 $xmlishElements = $this->parser->getStripList();
 201                 $xmlishAllowMissingEndTag = [ 'includeonly', 'noinclude', 'onlyinclude' ];
 202                 $enableOnlyinclude = false;
 203                 if ( $forInclusion ) {
 204                         $ignoredTags = [ 'includeonly', '/includeonly' ];
 205                         $ignoredElements = [ 'noinclude' ];
 206                         $xmlishElements[] = 'noinclude';
 207                         if ( strpos( $text, '<onlyinclude>' ) !== false
 208                                 && strpos( $text, '</onlyinclude>' ) !== false
 209                         ) {
 210                                 $enableOnlyinclude = true;
 211                         }
 212                 } else {
 213                         $ignoredTags = [ 'noinclude', '/noinclude', 'onlyinclude', '/onlyinclude' ];
 214                         $ignoredElements = [ 'includeonly' ];
 215                         $xmlishElements[] = 'includeonly';
 216                 }
 217                 $xmlishRegex = implode( '|', array_merge( $xmlishElements, $ignoredTags ) );
 218
 219                 // Use "A" modifier (anchored) instead of "^", because ^ doesn't work with an offset
 220                 $elementsRegex = "~($xmlishRegex)(?:\s|\/>|>)|(!--)~iA";
 221
 222                 $stack = new PPDStack;
 223
 224                 $searchBase = "[{<\n"; # }
 225                 if ( !$wgDisableLangConversion ) {
 226                         // FIXME: disabled due to T153761
 227                         // $searchBase .= '-';
 228                 }
 229
 230                 // For fast reverse searches
 231                 $revText = strrev( $text );
 232                 $lengthText = strlen( $text );
 233
 234                 // Input pointer, starts out pointing to a pseudo-newline before the start
 235                 $i = 0;
 236                 // Current accumulator
 237                 $accum =& $stack->getAccum();
 238                 $accum = '<root>';
 239                 // True to find equals signs in arguments
 240                 $findEquals = false;
 241                 // True to take notice of pipe characters
 242                 $findPipe = false;
 243                 $headingIndex = 1;
 244                 // True if $i is inside a possible heading
 245                 $inHeading = false;
 246                 // True if there are no more greater-than (>) signs right of $i
 247                 $noMoreGT = false;
 248                 // Map of tag name => true if there are no more closing tags of given type right of $i
 249                 $noMoreClosingTag = [];
 250                 // True to ignore all input up to the next <onlyinclude>
 251                 $findOnlyinclude = $enableOnlyinclude;
 252                 // Do a line-start run without outputting an LF character
 253                 $fakeLineStart = true;
 254
 255                 while ( true ) {
 256                         // $this->memCheck();
 257
 258                         if ( $findOnlyinclude ) {
 259                                 // Ignore all input up to the next <onlyinclude>
 260                                 $startPos = strpos( $text, '<onlyinclude>', $i );
 261                                 if ( $startPos === false ) {
 262                                         // Ignored section runs to the end
 263                                         $accum .= '<ignore>' . htmlspecialchars( substr( $text, $i ) ) . '</ignore>';
 264                                         break;
 265                                 }
 266                                 $tagEndPos = $startPos + strlen( '<onlyinclude>' ); // past-the-end
 267                                 $accum .= '<ignore>' . htmlspecialchars( substr( $text, $i, $tagEndPos - $i ) ) . '</ignore>';
 268                                 $i = $tagEndPos;
 269                                 $findOnlyinclude = false;
 270                         }
 271
 272                         if ( $fakeLineStart ) {
 273                                 $found = 'line-start';
 274                                 $curChar = '';
 275                         } else {
 276                                 # Find next opening brace, closing brace or pipe
 277                                 $search = $searchBase;
 278                                 if ( $stack->top === false ) {
 279                                         $currentClosing = '';
 280                                 } else {
 281                                         $currentClosing = $stack->top->close;
 282                                         $search .= $currentClosing;
 283                                 }
 284                                 if ( $findPipe ) {
 285                                         $search .= '|';
 286                                 }
 287                                 if ( $findEquals ) {
 288                                         // First equals will be for the template
 289                                         $search .= '=';
 290                                 }
 291                                 $rule = null;
 292                                 # Output literal section, advance input counter
 293                                 $literalLength = strcspn( $text, $search, $i );
 294                                 if ( $literalLength > 0 ) {
 295                                         $accum .= htmlspecialchars( substr( $text, $i, $literalLength ) );
 296                                         $i += $literalLength;
 297                                 }
 298                                 if ( $i >= $lengthText ) {
 299                                         if ( $currentClosing == "\n" ) {
 300                                                 // Do a past-the-end run to finish off the heading
 301                                                 $curChar = '';
 302                                                 $found = 'line-end';
 303                                         } else {
 304                                                 # All done
 305                                                 break;
 306                                         }
 307                                 } else {
 308                                         $curChar = $curTwoChar = $text[$i];
 309                                         if ( ( $i + 1 ) < $lengthText ) {
 310                                                 $curTwoChar .= $text[$i + 1];
 311                                         }
 312                                         if ( $curChar == '|' ) {
 313                                                 $found = 'pipe';
 314                                         } elseif ( $curChar == '=' ) {
 315                                                 $found = 'equals';
 316                                         } elseif ( $curChar == '<' ) {
 317                                                 $found = 'angle';
 318                                         } elseif ( $curChar == "\n" ) {
 319                                                 if ( $inHeading ) {
 320                                                         $found = 'line-end';
 321                                                 } else {
 322                                                         $found = 'line-start';
 323                                                 }
 324                                         } elseif ( $curTwoChar == $currentClosing ) {
 325                                                 $found = 'close';
 326                                                 $curChar = $curTwoChar;
 327                                         } elseif ( $curChar == $currentClosing ) {
 328                                                 $found = 'close';
 329                                         } elseif ( isset( $this->rules[$curTwoChar] ) ) {
 330                                                 $curChar = $curTwoChar;
 331                                                 $found = 'open';
 332                                                 $rule = $this->rules[$curChar];
 333                                         } elseif ( isset( $this->rules[$curChar] ) ) {
 334                                                 $found = 'open';
 335                                                 $rule = $this->rules[$curChar];
 336                                         } elseif ( $curChar == '-' ) {
 337                                                 $found = 'dash';
 338                                         } else {
 339                                                 # Some versions of PHP have a strcspn which stops on null characters
 340                                                 # Ignore and continue
 341                                                 ++$i;
 342                                                 continue;
 343                                         }
 344                                 }
 345                         }
 346
 347                         if ( $found == 'angle' ) {
 348                                 $matches = false;
 349                                 // Handle </onlyinclude>
 350                                 if ( $enableOnlyinclude
 351                                         && substr( $text, $i, strlen( '</onlyinclude>' ) ) == '</onlyinclude>'
 352                                 ) {
 353                                         $findOnlyinclude = true;
 354                                         continue;
 355                                 }
 356
 357                                 // Determine element name
 358                                 if ( !preg_match( $elementsRegex, $text, $matches, 0, $i + 1 ) ) {
 359                                         // Element name missing or not listed
 360                                         $accum .= '&lt;';
 361                                         ++$i;
 362                                         continue;
 363                                 }
 364                                 // Handle comments
 365                                 if ( isset( $matches[2] ) && $matches[2] == '!--' ) {
 366
 367                                         // To avoid leaving blank lines, when a sequence of
 368                                         // space-separated comments is both preceded and followed by
 369                                         // a newline (ignoring spaces), then
 370                                         // trim leading and trailing spaces and the trailing newline.
 371
 372                                         // Find the end
 373                                         $endPos = strpos( $text, '-->', $i + 4 );
 374                                         if ( $endPos === false ) {
 375                                                 // Unclosed comment in input, runs to end
 376                                                 $inner = substr( $text, $i );
 377                                                 $accum .= '<comment>' . htmlspecialchars( $inner ) . '</comment>';
 378                                                 $i = $lengthText;
 379                                         } else {
 380                                                 // Search backwards for leading whitespace
 381                                                 $wsStart = $i ? ( $i - strspn( $revText, " \t", $lengthText - $i ) ) : 0;
 382
 383                                                 // Search forwards for trailing whitespace
 384                                                 // $wsEnd will be the position of the last space (or the '>' if there's none)
 385                                                 $wsEnd = $endPos + 2 + strspn( $text, " \t", $endPos + 3 );
 386
 387                                                 // Keep looking forward as long as we're finding more
 388                                                 // comments.
 389                                                 $comments = [ [ $wsStart, $wsEnd ] ];
 390                                                 while ( substr( $text, $wsEnd + 1, 4 ) == '<!--' ) {
 391                                                         $c = strpos( $text, '-->', $wsEnd + 4 );
 392                                                         if ( $c === false ) {
 393                                                                 break;
 394                                                         }
 395                                                         $c = $c + 2 + strspn( $text, " \t", $c + 3 );
 396                                                         $comments[] = [ $wsEnd + 1, $c ];
 397                                                         $wsEnd = $c;
 398                                                 }
 399
 400                                                 // Eat the line if possible
 401                                                 // TODO: This could theoretically be done if $wsStart == 0, i.e. for comments at
 402                                                 // the overall start. That's not how Sanitizer::removeHTMLcomments() did it, but
 403                                                 // it's a possible beneficial b/c break.
 404                                                 if ( $wsStart > 0 && substr( $text, $wsStart - 1, 1 ) == "\n"
 405                                                         && substr( $text, $wsEnd + 1, 1 ) == "\n"
 406                                                 ) {
 407                                                         // Remove leading whitespace from the end of the accumulator
 408                                                         // Sanity check first though
 409                                                         $wsLength = $i - $wsStart;
 410                                                         if ( $wsLength > 0
 411                                                                 && strspn( $accum, " \t", -$wsLength ) === $wsLength
 412                                                         ) {
 413                                                                 $accum = substr( $accum, 0, -$wsLength );
 414                                                         }
 415
 416                                                         // Dump all but the last comment to the accumulator
 417                                                         foreach ( $comments as $j => $com ) {
 418                                                                 $startPos = $com[0];
 419                                                                 $endPos = $com[1] + 1;
 420                                                                 if ( $j == ( count( $comments ) - 1 ) ) {
 421                                                                         break;
 422                                                                 }
 423                                                                 $inner = substr( $text, $startPos, $endPos - $startPos );
 424                                                                 $accum .= '<comment>' . htmlspecialchars( $inner ) . '</comment>';
 425                                                         }
 426
 427                                                         // Do a line-start run next time to look for headings after the comment
 428                                                         $fakeLineStart = true;
 429                                                 } else {
 430                                                         // No line to eat, just take the comment itself
 431                                                         $startPos = $i;
 432                                                         $endPos += 2;
 433                                                 }
 434
 435                                                 if ( $stack->top ) {
 436                                                         $part = $stack->top->getCurrentPart();
 437                                                         if ( !( isset( $part->commentEnd ) && $part->commentEnd == $wsStart - 1 ) ) {
 438                                                                 $part->visualEnd = $wsStart;
 439                                                         }
 440                                                         // Else comments abutting, no change in visual end
 441                                                         $part->commentEnd = $endPos;
 442                                                 }
 443                                                 $i = $endPos + 1;
 444                                                 $inner = substr( $text, $startPos, $endPos - $startPos + 1 );
 445                                                 $accum .= '<comment>' . htmlspecialchars( $inner ) . '</comment>';
 446                                         }
 447                                         continue;
 448                                 }
 449                                 $name = $matches[1];
 450                                 $lowerName = strtolower( $name );
 451                                 $attrStart = $i + strlen( $name ) + 1;
 452
 453                                 // Find end of tag
 454                                 $tagEndPos = $noMoreGT ? false : strpos( $text, '>', $attrStart );
 455                                 if ( $tagEndPos === false ) {
 456                                         // Infinite backtrack
 457                                         // Disable tag search to prevent worst-case O(N^2) performance
 458                                         $noMoreGT = true;
 459                                         $accum .= '&lt;';
 460                                         ++$i;
 461                                         continue;
 462                                 }
 463
 464                                 // Handle ignored tags
 465                                 if ( in_array( $lowerName, $ignoredTags ) ) {
 466                                         $accum .= '<ignore>'
 467                                                 . htmlspecialchars( substr( $text, $i, $tagEndPos - $i + 1 ) )
 468                                                 . '</ignore>';
 469                                         $i = $tagEndPos + 1;
 470                                         continue;
 471                                 }
 472
 473                                 $tagStartPos = $i;
 474                                 if ( $text[$tagEndPos - 1] == '/' ) {
 475                                         $attrEnd = $tagEndPos - 1;
 476                                         $inner = null;
 477                                         $i = $tagEndPos + 1;
 478                                         $close = '';
 479                                 } else {
 480                                         $attrEnd = $tagEndPos;
 481                                         // Find closing tag
 482                                         if (
 483                                                 !isset( $noMoreClosingTag[$name] ) &&
 484                                                 preg_match( "/<\/" . preg_quote( $name, '/' ) . "\s*>/i",
 485                                                         $text, $matches, PREG_OFFSET_CAPTURE, $tagEndPos + 1 )
 486                                         ) {
 487                                                 $inner = substr( $text, $tagEndPos + 1, $matches[0][1] - $tagEndPos - 1 );
 488                                                 $i = $matches[0][1] + strlen( $matches[0][0] );
 489                                                 $close = '<close>' . htmlspecialchars( $matches[0][0] ) . '</close>';
 490                                         } else {
 491                                                 // No end tag
 492                                                 if ( in_array( $name, $xmlishAllowMissingEndTag ) ) {
 493                                                         // Let it run out to the end of the text.
 494                                                         $inner = substr( $text, $tagEndPos + 1 );
 495                                                         $i = $lengthText;
 496                                                         $close = '';
 497                                                 } else {
 498                                                         // Don't match the tag, treat opening tag as literal and resume parsing.
 499                                                         $i = $tagEndPos + 1;
 500                                                         $accum .= htmlspecialchars( substr( $text, $tagStartPos, $tagEndPos + 1 - $tagStartPos ) );
 501                                                         // Cache results, otherwise we have O(N^2) performance for input like <foo><foo><foo>...
 502                                                         $noMoreClosingTag[$name] = true;
 503                                                         continue;
 504                                                 }
 505                                         }
 506                                 }
 507                                 // <includeonly> and <noinclude> just become <ignore> tags
 508                                 if ( in_array( $lowerName, $ignoredElements ) ) {
 509                                         $accum .= '<ignore>' . htmlspecialchars( substr( $text, $tagStartPos, $i - $tagStartPos ) )
 510                                                 . '</ignore>';
 511                                         continue;
 512                                 }
 513
 514                                 $accum .= '<ext>';
 515                                 if ( $attrEnd <= $attrStart ) {
 516                                         $attr = '';
 517                                 } else {
 518                                         $attr = substr( $text, $attrStart, $attrEnd - $attrStart );
 519                                 }
 520                                 $accum .= '<name>' . htmlspecialchars( $name ) . '</name>' .
 521                                         // Note that the attr element contains the whitespace between name and attribute,
 522                                         // this is necessary for precise reconstruction during pre-save transform.
 523                                         '<attr>' . htmlspecialchars( $attr ) . '</attr>';
 524                                 if ( $inner !== null ) {
 525                                         $accum .= '<inner>' . htmlspecialchars( $inner ) . '</inner>';
 526                                 }
 527                                 $accum .= $close . '</ext>';
 528                         } elseif ( $found == 'line-start' ) {
 529                                 // Is this the start of a heading?
 530                                 // Line break belongs before the heading element in any case
 531                                 if ( $fakeLineStart ) {
 532                                         $fakeLineStart = false;
 533                                 } else {
 534                                         $accum .= $curChar;
 535                                         $i++;
 536                                 }
 537
 538                                 $count = strspn( $text, '=', $i, 6 );
 539                                 if ( $count == 1 && $findEquals ) {
 540                                         // DWIM: This looks kind of like a name/value separator.
 541                                         // Let's let the equals handler have it and break the
 542                                         // potential heading. This is heuristic, but AFAICT the
 543                                         // methods for completely correct disambiguation are very
 544                                         // complex.
 545                                 } elseif ( $count > 0 ) {
 546                                         $piece = [
 547                                                 'open' => "\n",
 548                                                 'close' => "\n",
 549                                                 'parts' => [ new PPDPart( str_repeat( '=', $count ) ) ],
 550                                                 'startPos' => $i,
 551                                                 'count' => $count ];
 552                                         $stack->push( $piece );
 553                                         $accum =& $stack->getAccum();
 554                                         $flags = $stack->getFlags();
 555                                         extract( $flags );
 556                                         $i += $count;
 557                                 }
 558                         } elseif ( $found == 'line-end' ) {
 559                                 $piece = $stack->top;
 560                                 // A heading must be open, otherwise \n wouldn't have been in the search list
 561                                 assert( $piece->open === "\n" );
 562                                 $part = $piece->getCurrentPart();
 563                                 // Search back through the input to see if it has a proper close.
 564                                 // Do this using the reversed string since the other solutions
 565                                 // (end anchor, etc.) are inefficient.
 566                                 $wsLength = strspn( $revText, " \t", $lengthText - $i );
 567                                 $searchStart = $i - $wsLength;
 568                                 if ( isset( $part->commentEnd ) && $searchStart - 1 == $part->commentEnd ) {
 569                                         // Comment found at line end
 570                                         // Search for equals signs before the comment
 571                                         $searchStart = $part->visualEnd;
 572                                         $searchStart -= strspn( $revText, " \t", $lengthText - $searchStart );
 573                                 }
 574                                 $count = $piece->count;
 575                                 $equalsLength = strspn( $revText, '=', $lengthText - $searchStart );
 576                                 if ( $equalsLength > 0 ) {
 577                                         if ( $searchStart - $equalsLength == $piece->startPos ) {
 578                                                 // This is just a single string of equals signs on its own line
 579                                                 // Replicate the doHeadings behavior /={count}(.+)={count}/
 580                                                 // First find out how many equals signs there really are (don't stop at 6)
 581                                                 $count = $equalsLength;
 582                                                 if ( $count < 3 ) {
 583                                                         $count = 0;
 584                                                 } else {
 585                                                         $count = min( 6, intval( ( $count - 1 ) / 2 ) );
 586                                                 }
 587                                         } else {
 588                                                 $count = min( $equalsLength, $count );
 589                                         }
 590                                         if ( $count > 0 ) {
 591                                                 // Normal match, output <h>
 592                                                 $element = "<h level=\"$count\" i=\"$headingIndex\">$accum</h>";
 593                                                 $headingIndex++;
 594                                         } else {
 595                                                 // Single equals sign on its own line, count=0
 596                                                 $element = $accum;
 597                                         }
 598                                 } else {
 599                                         // No match, no <h>, just pass down the inner text
 600                                         $element = $accum;
 601                                 }
 602                                 // Unwind the stack
 603                                 $stack->pop();
 604                                 $accum =& $stack->getAccum();
 605                                 $flags = $stack->getFlags();
 606                                 extract( $flags );
 607
 608                                 // Append the result to the enclosing accumulator
 609                                 $accum .= $element;
 610                                 // Note that we do NOT increment the input pointer.
 611                                 // This is because the closing linebreak could be the opening linebreak of
 612                                 // another heading. Infinite loops are avoided because the next iteration MUST
 613                                 // hit the heading open case above, which unconditionally increments the
 614                                 // input pointer.
 615                         } elseif ( $found == 'open' ) {
 616                                 # count opening brace characters
 617                                 $curLen = strlen( $curChar );
 618                                 $count = ( $curLen > 1 ) ? 1 : strspn( $text, $curChar, $i );
 619
 620                                 # we need to add to stack only if opening brace count is enough for one of the rules
 621                                 if ( $count >= $rule['min'] ) {
 622                                         # Add it to the stack
 623                                         $piece = [
 624                                                 'open' => $curChar,
 625                                                 'close' => $rule['end'],
 626                                                 'count' => $count,
 627                                                 'lineStart' => ( $i > 0 && $text[$i - 1] == "\n" ),
 628                                         ];
 629
 630                                         $stack->push( $piece );
 631                                         $accum =& $stack->getAccum();
 632                                         $flags = $stack->getFlags();
 633                                         extract( $flags );
 634                                 } else {
 635                                         # Add literal brace(s)
 636                                         $accum .= htmlspecialchars( str_repeat( $curChar, $count ) );
 637                                 }
 638                                 $i += $curLen * $count;
 639                         } elseif ( $found == 'close' ) {
 640                                 $piece = $stack->top;
 641                                 # lets check if there are enough characters for closing brace
 642                                 $maxCount = $piece->count;
 643                                 $curLen = strlen( $curChar );
 644                                 $count = ( $curLen > 1 ) ? 1 : strspn( $text, $curChar, $i, $maxCount );
 645
 646                                 # check for maximum matching characters (if there are 5 closing
 647                                 # characters, we will probably need only 3 - depending on the rules)
 648                                 $rule = $this->rules[$piece->open];
 649                                 if ( $count > $rule['max'] ) {
 650                                         # The specified maximum exists in the callback array, unless the caller
 651                                         # has made an error
 652                                         $matchingCount = $rule['max'];
 653                                 } else {
 654                                         # Count is less than the maximum
 655                                         # Skip any gaps in the callback array to find the true largest match
 656                                         # Need to use array_key_exists not isset because the callback can be null
 657                                         $matchingCount = $count;
 658                                         while ( $matchingCount > 0 && !array_key_exists( $matchingCount, $rule['names'] ) ) {
 659                                                 --$matchingCount;
 660                                         }
 661                                 }
 662
 663                                 if ( $matchingCount <= 0 ) {
 664                                         # No matching element found in callback array
 665                                         # Output a literal closing brace and continue
 666                                         $accum .= htmlspecialchars( str_repeat( $curChar, $count ) );
 667                                         $i += $curLen * $count;
 668                                         continue;
 669                                 }
 670                                 $name = $rule['names'][$matchingCount];
 671                                 if ( $name === null ) {
 672                                         // No element, just literal text
 673                                         $element = $piece->breakSyntax( $matchingCount ) . str_repeat( $rule['end'], $matchingCount );
 674                                 } else {
 675                                         # Create XML element
 676                                         # Note: $parts is already XML, does not need to be encoded further
 677                                         $parts = $piece->parts;
 678                                         $title = $parts[0]->out;
 679                                         unset( $parts[0] );
 680
 681                                         # The invocation is at the start of the line if lineStart is set in
 682                                         # the stack, and all opening brackets are used up.
 683                                         if ( $maxCount == $matchingCount && !empty( $piece->lineStart ) ) {
 684                                                 $attr = ' lineStart="1"';
 685                                         } else {
 686                                                 $attr = '';
 687                                         }
 688
 689                                         $element = "<$name$attr>";
 690                                         $element .= "<title>$title</title>";
 691                                         $argIndex = 1;
 692                                         foreach ( $parts as $part ) {
 693                                                 if ( isset( $part->eqpos ) ) {
 694                                                         $argName = substr( $part->out, 0, $part->eqpos );
 695                                                         $argValue = substr( $part->out, $part->eqpos + 1 );
 696                                                         $element .= "<part><name>$argName</name>=<value>$argValue</value></part>";
 697                                                 } else {
 698                                                         $element .= "<part><name index=\"$argIndex\" /><value>{$part->out}</value></part>";
 699                                                         $argIndex++;
 700                                                 }
 701                                         }
 702                                         $element .= "</$name>";
 703                                 }
 704
 705                                 # Advance input pointer
 706                                 $i += $curLen * $matchingCount;
 707
 708                                 # Unwind the stack
 709                                 $stack->pop();
 710                                 $accum =& $stack->getAccum();
 711
 712                                 # Re-add the old stack element if it still has unmatched opening characters remaining
 713                                 if ( $matchingCount < $piece->count ) {
 714                                         $piece->parts = [ new PPDPart ];
 715                                         $piece->count -= $matchingCount;
 716                                         # do we still qualify for any callback with remaining count?
 717                                         $min = $this->rules[$piece->open]['min'];
 718                                         if ( $piece->count >= $min ) {
 719                                                 $stack->push( $piece );
 720                                                 $accum =& $stack->getAccum();
 721                                         } else {
 722                                                 $accum .= str_repeat( $piece->open, $piece->count );
 723                                         }
 724                                 }
 725                                 $flags = $stack->getFlags();
 726                                 extract( $flags );
 727
 728                                 # Add XML element to the enclosing accumulator
 729                                 $accum .= $element;
 730                         } elseif ( $found == 'pipe' ) {
 731                                 $findEquals = true; // shortcut for getFlags()
 732                                 $stack->addPart();
 733                                 $accum =& $stack->getAccum();
 734                                 ++$i;
 735                         } elseif ( $found == 'equals' ) {
 736                                 $findEquals = false; // shortcut for getFlags()
 737                                 $stack->getCurrentPart()->eqpos = strlen( $accum );
 738                                 $accum .= '=';
 739                                 ++$i;
 740                         } elseif ( $found == 'dash' ) {
 741                                 $accum .= '-';
 742                                 ++$i;
 743                         }
 744                 }
 745
 746                 # Output any remaining unclosed brackets
 747                 foreach ( $stack->stack as $piece ) {
 748                         $stack->rootAccum .= $piece->breakSyntax();
 749                 }
 750                 $stack->rootAccum .= '</root>';
 751                 $xml = $stack->rootAccum;
 752
 753                 return $xml;
 754         }
 755 }
 756
 757 /**
 758  * Stack class to help Preprocessor::preprocessToObj()
 759  * @ingroup Parser
 760  */
 761 class PPDStack {
 762         public $stack, $rootAccum;
 763
 764         /**
 765          * @var PPDStack
 766          */
 767         public $top;
 768         public $out;
 769         public $elementClass = 'PPDStackElement';
 770
 771         public static $false = false;
 772
 773         public function __construct() {
 774                 $this->stack = [];
 775                 $this->top = false;
 776                 $this->rootAccum = '';
 777                 $this->accum =& $this->rootAccum;
 778         }
 779
 780         /**
 781          * @return int
 782          */
 783         public function count() {
 784                 return count( $this->stack );
 785         }
 786
 787         public function &getAccum() {
 788                 return $this->accum;
 789         }
 790
 791         public function getCurrentPart() {
 792                 if ( $this->top === false ) {
 793                         return false;
 794                 } else {
 795                         return $this->top->getCurrentPart();
 796                 }
 797         }
 798
 799         public function push( $data ) {
 800                 if ( $data instanceof $this->elementClass ) {
 801                         $this->stack[] = $data;
 802                 } else {
 803                         $class = $this->elementClass;
 804                         $this->stack[] = new $class( $data );
 805                 }
 806                 $this->top = $this->stack[count( $this->stack ) - 1];
 807                 $this->accum =& $this->top->getAccum();
 808         }
 809
 810         public function pop() {
 811                 if ( !count( $this->stack ) ) {
 812                         throw new MWException( __METHOD__ . ': no elements remaining' );
 813                 }
 814                 $temp = array_pop( $this->stack );
 815
 816                 if ( count( $this->stack ) ) {
 817                         $this->top = $this->stack[count( $this->stack ) - 1];
 818                         $this->accum =& $this->top->getAccum();
 819                 } else {
 820                         $this->top = self::$false;
 821                         $this->accum =& $this->rootAccum;
 822                 }
 823                 return $temp;
 824         }
 825
 826         public function addPart( $s = '' ) {
 827                 $this->top->addPart( $s );
 828                 $this->accum =& $this->top->getAccum();
 829         }
 830
 831         /**
 832          * @return array
 833          */
 834         public function getFlags() {
 835                 if ( !count( $this->stack ) ) {
 836                         return [
 837                                 'findEquals' => false,
 838                                 'findPipe' => false,
 839                                 'inHeading' => false,
 840                         ];
 841                 } else {
 842                         return $this->top->getFlags();
 843                 }
 844         }
 845 }
 846
 847 /**
 848  * @ingroup Parser
 849  */
 850 class PPDStackElement {
 851         /**
 852          * @var string Opening character (\n for heading)
 853          */
 854         public $open;
 855
 856         /**
 857          * @var string Matching closing character
 858          */
 859         public $close;
 860
 861         /**
 862          * @var int Number of opening characters found (number of "=" for heading)
 863          */
 864         public $count;
 865
 866         /**
 867          * @var PPDPart[] Array of PPDPart objects describing pipe-separated parts.
 868          */
 869         public $parts;
 870
 871         /**
 872          * @var bool True if the open char appeared at the start of the input line.
 873          *  Not set for headings.
 874          */
 875         public $lineStart;
 876
 877         public $partClass = 'PPDPart';
 878
 879         public function __construct( $data = [] ) {
 880                 $class = $this->partClass;
 881                 $this->parts = [ new $class ];
 882
 883                 foreach ( $data as $name => $value ) {
 884                         $this->$name = $value;
 885                 }
 886         }
 887
 888         public function &getAccum() {
 889                 return $this->parts[count( $this->parts ) - 1]->out;
 890         }
 891
 892         public function addPart( $s = '' ) {
 893                 $class = $this->partClass;
 894                 $this->parts[] = new $class( $s );
 895         }
 896
 897         public function getCurrentPart() {
 898                 return $this->parts[count( $this->parts ) - 1];
 899         }
 900
 901         /**
 902          * @return array
 903          */
 904         public function getFlags() {
 905                 $partCount = count( $this->parts );
 906                 $findPipe = $this->open != "\n" && $this->open != '[';
 907                 return [
 908                         'findPipe' => $findPipe,
 909                         'findEquals' => $findPipe && $partCount > 1 && !isset( $this->parts[$partCount - 1]->eqpos ),
 910                         'inHeading' => $this->open == "\n",
 911                 ];
 912         }
 913
 914         /**
 915          * Get the output string that would result if the close is not found.
 916          *
 917          * @param bool|int $openingCount
 918          * @return string
 919          */
 920         public function breakSyntax( $openingCount = false ) {
 921                 if ( $this->open == "\n" ) {
 922                         $s = $this->parts[0]->out;
 923                 } else {
 924                         if ( $openingCount === false ) {
 925                                 $openingCount = $this->count;
 926                         }
 927                         $s = str_repeat( $this->open, $openingCount );
 928                         $first = true;
 929                         foreach ( $this->parts as $part ) {
 930                                 if ( $first ) {
 931                                         $first = false;
 932                                 } else {
 933                                         $s .= '|';
 934                                 }
 935                                 $s .= $part->out;
 936                         }
 937                 }
 938                 return $s;
 939         }
 940 }
 941
 942 /**
 943  * @ingroup Parser
 944  */
 945 class PPDPart {
 946         /**
 947          * @var string Output accumulator string
 948          */
 949         public $out;
 950
 951         // Optional member variables:
 952         //   eqpos        Position of equals sign in output accumulator
 953         //   commentEnd   Past-the-end input pointer for the last comment encountered
 954         //   visualEnd    Past-the-end input pointer for the end of the accumulator minus comments
 955
 956         public function __construct( $out = '' ) {
 957                 $this->out = $out;
 958         }
 959 }
 960
 961 /**
 962  * An expansion frame, used as a context to expand the result of preprocessToObj()
 963  * @ingroup Parser
 964  */
 965 // @codingStandardsIgnoreStart Squiz.Classes.ValidClassName.NotCamelCaps
 966 class PPFrame_DOM implements PPFrame {
 967         // @codingStandardsIgnoreEnd
 968
 969         /**
 970          * @var Preprocessor
 971          */
 972         public $preprocessor;
 973
 974         /**
 975          * @var Parser
 976          */
 977         public $parser;
 978
 979         /**
 980          * @var Title
 981          */
 982         public $title;
 983         public $titleCache;
 984
 985         /**
 986          * Hashtable listing templates which are disallowed for expansion in this frame,
 987          * having been encountered previously in parent frames.
 988          */
 989         public $loopCheckHash;
 990
 991         /**
 992          * Recursion depth of this frame, top = 0
 993          * Note that this is NOT the same as expansion depth in expand()
 994          */
 995         public $depth;
 996
 997         private $volatile = false;
 998         private $ttl = null;
 999
1000         /**
1001          * @var array
1002          */
1003         protected $childExpansionCache;
1004
1005         /**
1006          * Construct a new preprocessor frame.
1007          * @param Preprocessor $preprocessor The parent preprocessor
1008          */
1009         public function __construct( $preprocessor ) {
1010                 $this->preprocessor = $preprocessor;
1011                 $this->parser = $preprocessor->parser;
1012                 $this->title = $this->parser->mTitle;
1013                 $this->titleCache = [ $this->title ? $this->title->getPrefixedDBkey() : false ];
1014                 $this->loopCheckHash = [];
1015                 $this->depth = 0;
1016                 $this->childExpansionCache = [];
1017         }
1018
1019         /**
1020          * Create a new child frame
1021          * $args is optionally a multi-root PPNode or array containing the template arguments
1022          *
1023          * @param bool|array $args
1024          * @param Title|bool $title
1025          * @param int $indexOffset
1026          * @return PPTemplateFrame_DOM
1027          */
1028         public function newChild( $args = false, $title = false, $indexOffset = 0 ) {
1029                 $namedArgs = [];
1030                 $numberedArgs = [];
1031                 if ( $title === false ) {
1032                         $title = $this->title;
1033                 }
1034                 if ( $args !== false ) {
1035                         $xpath = false;
1036                         if ( $args instanceof PPNode ) {
1037                                 $args = $args->node;
1038                         }
1039                         foreach ( $args as $arg ) {
1040                                 if ( $arg instanceof PPNode ) {
1041                                         $arg = $arg->node;
1042                                 }
1043                                 if ( !$xpath || $xpath->document !== $arg->ownerDocument ) {
1044                                         $xpath = new DOMXPath( $arg->ownerDocument );
1045                                 }
1046
1047                                 $nameNodes = $xpath->query( 'name', $arg );
1048                                 $value = $xpath->query( 'value', $arg );
1049                                 if ( $nameNodes->item( 0 )->hasAttributes() ) {
1050                                         // Numbered parameter
1051                                         $index = $nameNodes->item( 0 )->attributes->getNamedItem( 'index' )->textContent;
1052                                         $index = $index - $indexOffset;
1053                                         if ( isset( $namedArgs[$index] ) || isset( $numberedArgs[$index] ) ) {
1054                                                 $this->parser->getOutput()->addWarning( wfMessage( 'duplicate-args-warning',
1055                                                         wfEscapeWikiText( $this->title ),
1056                                                         wfEscapeWikiText( $title ),
1057                                                         wfEscapeWikiText( $index ) )->text() );
1058                                                 $this->parser->addTrackingCategory( 'duplicate-args-category' );
1059                                         }
1060                                         $numberedArgs[$index] = $value->item( 0 );
1061                                         unset( $namedArgs[$index] );
1062                                 } else {
1063                                         // Named parameter
1064                                         $name = trim( $this->expand( $nameNodes->item( 0 ), PPFrame::STRIP_COMMENTS ) );
1065                                         if ( isset( $namedArgs[$name] ) || isset( $numberedArgs[$name] ) ) {
1066                                                 $this->parser->getOutput()->addWarning( wfMessage( 'duplicate-args-warning',
1067                                                         wfEscapeWikiText( $this->title ),
1068                                                         wfEscapeWikiText( $title ),
1069                                                         wfEscapeWikiText( $name ) )->text() );
1070                                                 $this->parser->addTrackingCategory( 'duplicate-args-category' );
1071                                         }
1072                                         $namedArgs[$name] = $value->item( 0 );
1073                                         unset( $numberedArgs[$name] );
1074                                 }
1075                         }
1076                 }
1077                 return new PPTemplateFrame_DOM( $this->preprocessor, $this, $numberedArgs, $namedArgs, $title );
1078         }
1079
1080         /**
1081          * @throws MWException
1082          * @param string|int $key
1083          * @param string|PPNode_DOM|DOMDocument $root
1084          * @param int $flags
1085          * @return string
1086          */
1087         public function cachedExpand( $key, $root, $flags = 0 ) {
1088                 // we don't have a parent, so we don't have a cache
1089                 return $this->expand( $root, $flags );
1090         }
1091
1092         /**
1093          * @throws MWException
1094          * @param string|PPNode_DOM|DOMDocument $root
1095          * @param int $flags
1096          * @return string
1097          */
1098         public function expand( $root, $flags = 0 ) {
1099                 static $expansionDepth = 0;
1100                 if ( is_string( $root ) ) {
1101                         return $root;
1102                 }
1103
1104                 if ( ++$this->parser->mPPNodeCount > $this->parser->mOptions->getMaxPPNodeCount() ) {
1105                         $this->parser->limitationWarn( 'node-count-exceeded',
1106                                 $this->parser->mPPNodeCount,
1107                                 $this->parser->mOptions->getMaxPPNodeCount()
1108                         );
1109                         return '<span class="error">Node-count limit exceeded</span>';
1110                 }
1111
1112                 if ( $expansionDepth > $this->parser->mOptions->getMaxPPExpandDepth() ) {
1113                         $this->parser->limitationWarn( 'expansion-depth-exceeded',
1114                                 $expansionDepth,
1115                                 $this->parser->mOptions->getMaxPPExpandDepth()
1116                         );
1117                         return '<span class="error">Expansion depth limit exceeded</span>';
1118                 }
1119                 ++$expansionDepth;
1120                 if ( $expansionDepth > $this->parser->mHighestExpansionDepth ) {
1121                         $this->parser->mHighestExpansionDepth = $expansionDepth;
1122                 }
1123
1124                 if ( $root instanceof PPNode_DOM ) {
1125                         $root = $root->node;
1126                 }
1127                 if ( $root instanceof DOMDocument ) {
1128                         $root = $root->documentElement;
1129                 }
1130
1131                 $outStack = [ '', '' ];
1132                 $iteratorStack = [ false, $root ];
1133                 $indexStack = [ 0, 0 ];
1134
1135                 while ( count( $iteratorStack ) > 1 ) {
1136                         $level = count( $outStack ) - 1;
1137                         $iteratorNode =& $iteratorStack[$level];
1138                         $out =& $outStack[$level];
1139                         $index =& $indexStack[$level];
1140
1141                         if ( $iteratorNode instanceof PPNode_DOM ) {
1142                                 $iteratorNode = $iteratorNode->node;
1143                         }
1144
1145                         if ( is_array( $iteratorNode ) ) {
1146                                 if ( $index >= count( $iteratorNode ) ) {
1147                                         // All done with this iterator
1148                                         $iteratorStack[$level] = false;
1149                                         $contextNode = false;
1150                                 } else {
1151                                         $contextNode = $iteratorNode[$index];
1152                                         $index++;
1153                                 }
1154                         } elseif ( $iteratorNode instanceof DOMNodeList ) {
1155                                 if ( $index >= $iteratorNode->length ) {
1156                                         // All done with this iterator
1157                                         $iteratorStack[$level] = false;
1158                                         $contextNode = false;
1159                                 } else {
1160                                         $contextNode = $iteratorNode->item( $index );
1161                                         $index++;
1162                                 }
1163                         } else {
1164                                 // Copy to $contextNode and then delete from iterator stack,
1165                                 // because this is not an iterator but we do have to execute it once
1166                                 $contextNode = $iteratorStack[$level];
1167                                 $iteratorStack[$level] = false;
1168                         }
1169
1170                         if ( $contextNode instanceof PPNode_DOM ) {
1171                                 $contextNode = $contextNode->node;
1172                         }
1173
1174                         $newIterator = false;
1175
1176                         if ( $contextNode === false ) {
1177                                 // nothing to do
1178                         } elseif ( is_string( $contextNode ) ) {
1179                                 $out .= $contextNode;
1180                         } elseif ( is_array( $contextNode ) || $contextNode instanceof DOMNodeList ) {
1181                                 $newIterator = $contextNode;
1182                         } elseif ( $contextNode instanceof DOMNode ) {
1183                                 if ( $contextNode->nodeType == XML_TEXT_NODE ) {
1184                                         $out .= $contextNode->nodeValue;
1185                                 } elseif ( $contextNode->nodeName == 'template' ) {
1186                                         # Double-brace expansion
1187                                         $xpath = new DOMXPath( $contextNode->ownerDocument );
1188                                         $titles = $xpath->query( 'title', $contextNode );
1189                                         $title = $titles->item( 0 );
1190                                         $parts = $xpath->query( 'part', $contextNode );
1191                                         if ( $flags & PPFrame::NO_TEMPLATES ) {
1192                                                 $newIterator = $this->virtualBracketedImplode( '{{', '|', '}}', $title, $parts );
1193                                         } else {
1194                                                 $lineStart = $contextNode->getAttribute( 'lineStart' );
1195                                                 $params = [
1196                                                         'title' => new PPNode_DOM( $title ),
1197                                                         'parts' => new PPNode_DOM( $parts ),
1198                                                         'lineStart' => $lineStart ];
1199                                                 $ret = $this->parser->braceSubstitution( $params, $this );
1200                                                 if ( isset( $ret['object'] ) ) {
1201                                                         $newIterator = $ret['object'];
1202                                                 } else {
1203                                                         $out .= $ret['text'];
1204                                                 }
1205                                         }
1206                                 } elseif ( $contextNode->nodeName == 'tplarg' ) {
1207                                         # Triple-brace expansion
1208                                         $xpath = new DOMXPath( $contextNode->ownerDocument );
1209                                         $titles = $xpath->query( 'title', $contextNode );
1210                                         $title = $titles->item( 0 );
1211                                         $parts = $xpath->query( 'part', $contextNode );
1212                                         if ( $flags & PPFrame::NO_ARGS ) {
1213                                                 $newIterator = $this->virtualBracketedImplode( '{{{', '|', '}}}', $title, $parts );
1214                                         } else {
1215                                                 $params = [
1216                                                         'title' => new PPNode_DOM( $title ),
1217                                                         'parts' => new PPNode_DOM( $parts ) ];
1218                                                 $ret = $this->parser->argSubstitution( $params, $this );
1219                                                 if ( isset( $ret['object'] ) ) {
1220                                                         $newIterator = $ret['object'];
1221                                                 } else {
1222                                                         $out .= $ret['text'];
1223                                                 }
1224                                         }
1225                                 } elseif ( $contextNode->nodeName == 'comment' ) {
1226                                         # HTML-style comment
1227                                         # Remove it in HTML, pre+remove and STRIP_COMMENTS modes
1228                                         # Not in RECOVER_COMMENTS mode (msgnw) though.
1229                                         if ( ( $this->parser->ot['html']
1230                                                 || ( $this->parser->ot['pre'] && $this->parser->mOptions->getRemoveComments() )
1231                                                 || ( $flags & PPFrame::STRIP_COMMENTS )
1232                                                 ) && !( $flags & PPFrame::RECOVER_COMMENTS )
1233                                         ) {
1234                                                 $out .= '';
1235                                         } elseif ( $this->parser->ot['wiki'] && !( $flags & PPFrame::RECOVER_COMMENTS ) ) {
1236                                                 # Add a strip marker in PST mode so that pstPass2() can
1237                                                 # run some old-fashioned regexes on the result.
1238                                                 # Not in RECOVER_COMMENTS mode (extractSections) though.
1239                                                 $out .= $this->parser->insertStripItem( $contextNode->textContent );
1240                                         } else {
1241                                                 # Recover the literal comment in RECOVER_COMMENTS and pre+no-remove
1242                                                 $out .= $contextNode->textContent;
1243                                         }
1244                                 } elseif ( $contextNode->nodeName == 'ignore' ) {
1245                                         # Output suppression used by <includeonly> etc.
1246                                         # OT_WIKI will only respect <ignore> in substed templates.
1247                                         # The other output types respect it unless NO_IGNORE is set.
1248                                         # extractSections() sets NO_IGNORE and so never respects it.
1249                                         if ( ( !isset( $this->parent ) && $this->parser->ot['wiki'] )
1250                                                 || ( $flags & PPFrame::NO_IGNORE )
1251                                         ) {
1252                                                 $out .= $contextNode->textContent;
1253                                         } else {
1254                                                 $out .= '';
1255                                         }
1256                                 } elseif ( $contextNode->nodeName == 'ext' ) {
1257                                         # Extension tag
1258                                         $xpath = new DOMXPath( $contextNode->ownerDocument );
1259                                         $names = $xpath->query( 'name', $contextNode );
1260                                         $attrs = $xpath->query( 'attr', $contextNode );
1261                                         $inners = $xpath->query( 'inner', $contextNode );
1262                                         $closes = $xpath->query( 'close', $contextNode );
1263                                         if ( $flags & PPFrame::NO_TAGS ) {
1264                                                 $s = '<' . $this->expand( $names->item( 0 ), $flags );
1265                                                 if ( $attrs->length > 0 ) {
1266                                                         $s .= $this->expand( $attrs->item( 0 ), $flags );
1267                                                 }
1268                                                 if ( $inners->length > 0 ) {
1269                                                         $s .= '>' . $this->expand( $inners->item( 0 ), $flags );
1270                                                         if ( $closes->length > 0 ) {
1271                                                                 $s .= $this->expand( $closes->item( 0 ), $flags );
1272                                                         }
1273                                                 } else {
1274                                                         $s .= '/>';
1275                                                 }
1276                                                 $out .= $s;
1277                                         } else {
1278                                                 $params = [
1279                                                         'name' => new PPNode_DOM( $names->item( 0 ) ),
1280                                                         'attr' => $attrs->length > 0 ? new PPNode_DOM( $attrs->item( 0 ) ) : null,
1281                                                         'inner' => $inners->length > 0 ? new PPNode_DOM( $inners->item( 0 ) ) : null,
1282                                                         'close' => $closes->length > 0 ? new PPNode_DOM( $closes->item( 0 ) ) : null,
1283                                                 ];
1284                                                 $out .= $this->parser->extensionSubstitution( $params, $this );
1285                                         }
1286                                 } elseif ( $contextNode->nodeName == 'h' ) {
1287                                         # Heading
1288                                         $s = $this->expand( $contextNode->childNodes, $flags );
1289
1290                                         # Insert a heading marker only for <h> children of <root>
1291                                         # This is to stop extractSections from going over multiple tree levels
1292                                         if ( $contextNode->parentNode->nodeName == 'root' && $this->parser->ot['html'] ) {
1293                                                 # Insert heading index marker
1294                                                 $headingIndex = $contextNode->getAttribute( 'i' );
1295                                                 $titleText = $this->title->getPrefixedDBkey();
1296                                                 $this->parser->mHeadings[] = [ $titleText, $headingIndex ];
1297                                                 $serial = count( $this->parser->mHeadings ) - 1;
1298                                                 $marker = Parser::MARKER_PREFIX . "-h-$serial-" . Parser::MARKER_SUFFIX;
1299                                                 $count = $contextNode->getAttribute( 'level' );
1300                                                 $s = substr( $s, 0, $count ) . $marker . substr( $s, $count );
1301                                                 $this->parser->mStripState->addGeneral( $marker, '' );
1302                                         }
1303                                         $out .= $s;
1304                                 } else {
1305                                         # Generic recursive expansion
1306                                         $newIterator = $contextNode->childNodes;
1307                                 }
1308                         } else {
1309                                 throw new MWException( __METHOD__ . ': Invalid parameter type' );
1310                         }
1311
1312                         if ( $newIterator !== false ) {
1313                                 if ( $newIterator instanceof PPNode_DOM ) {
1314                                         $newIterator = $newIterator->node;
1315                                 }
1316                                 $outStack[] = '';
1317                                 $iteratorStack[] = $newIterator;
1318                                 $indexStack[] = 0;
1319                         } elseif ( $iteratorStack[$level] === false ) {
1320                                 // Return accumulated value to parent
1321                                 // With tail recursion
1322                                 while ( $iteratorStack[$level] === false && $level > 0 ) {
1323                                         $outStack[$level - 1] .= $out;
1324                                         array_pop( $outStack );
1325                                         array_pop( $iteratorStack );
1326                                         array_pop( $indexStack );
1327                                         $level--;
1328                                 }
1329                         }
1330                 }
1331                 --$expansionDepth;
1332                 return $outStack[0];
1333         }
1334
1335         /**
1336          * @param string $sep
1337          * @param int $flags
1338          * @param string|PPNode_DOM|DOMDocument $args,...
1339          * @return string
1340          */
1341         public function implodeWithFlags( $sep, $flags /*, ... */ ) {
1342                 $args = array_slice( func_get_args(), 2 );
1343
1344                 $first = true;
1345                 $s = '';
1346                 foreach ( $args as $root ) {
1347                         if ( $root instanceof PPNode_DOM ) {
1348                                 $root = $root->node;
1349                         }
1350                         if ( !is_array( $root ) && !( $root instanceof DOMNodeList ) ) {
1351                                 $root = [ $root ];
1352                         }
1353                         foreach ( $root as $node ) {
1354                                 if ( $first ) {
1355                                         $first = false;
1356                                 } else {
1357                                         $s .= $sep;
1358                                 }
1359                                 $s .= $this->expand( $node, $flags );
1360                         }
1361                 }
1362                 return $s;
1363         }
1364
1365         /**
1366          * Implode with no flags specified
1367          * This previously called implodeWithFlags but has now been inlined to reduce stack depth
1368          *
1369          * @param string $sep
1370          * @param string|PPNode_DOM|DOMDocument $args,...
1371          * @return string
1372          */
1373         public function implode( $sep /*, ... */ ) {
1374                 $args = array_slice( func_get_args(), 1 );
1375
1376                 $first = true;
1377                 $s = '';
1378                 foreach ( $args as $root ) {
1379                         if ( $root instanceof PPNode_DOM ) {
1380                                 $root = $root->node;
1381                         }
1382                         if ( !is_array( $root ) && !( $root instanceof DOMNodeList ) ) {
1383                                 $root = [ $root ];
1384                         }
1385                         foreach ( $root as $node ) {
1386                                 if ( $first ) {
1387                                         $first = false;
1388                                 } else {
1389                                         $s .= $sep;
1390                                 }
1391                                 $s .= $this->expand( $node );
1392                         }
1393                 }
1394                 return $s;
1395         }
1396
1397         /**
1398          * Makes an object that, when expand()ed, will be the same as one obtained
1399          * with implode()
1400          *
1401          * @param string $sep
1402          * @param string|PPNode_DOM|DOMDocument $args,...
1403          * @return array
1404          */
1405         public function virtualImplode( $sep /*, ... */ ) {
1406                 $args = array_slice( func_get_args(), 1 );
1407                 $out = [];
1408                 $first = true;
1409
1410                 foreach ( $args as $root ) {
1411                         if ( $root instanceof PPNode_DOM ) {
1412                                 $root = $root->node;
1413                         }
1414                         if ( !is_array( $root ) && !( $root instanceof DOMNodeList ) ) {
1415                                 $root = [ $root ];
1416                         }
1417                         foreach ( $root as $node ) {
1418                                 if ( $first ) {
1419                                         $first = false;
1420                                 } else {
1421                                         $out[] = $sep;
1422                                 }
1423                                 $out[] = $node;
1424                         }
1425                 }
1426                 return $out;
1427         }
1428
1429         /**
1430          * Virtual implode with brackets
1431          * @param string $start
1432          * @param string $sep
1433          * @param string $end
1434          * @param string|PPNode_DOM|DOMDocument $args,...
1435          * @return array
1436          */
1437         public function virtualBracketedImplode( $start, $sep, $end /*, ... */ ) {
1438                 $args = array_slice( func_get_args(), 3 );
1439                 $out = [ $start ];
1440                 $first = true;
1441
1442                 foreach ( $args as $root ) {
1443                         if ( $root instanceof PPNode_DOM ) {
1444                                 $root = $root->node;
1445                         }
1446                         if ( !is_array( $root ) && !( $root instanceof DOMNodeList ) ) {
1447                                 $root = [ $root ];
1448                         }
1449                         foreach ( $root as $node ) {
1450                                 if ( $first ) {
1451                                         $first = false;
1452                                 } else {
1453                                         $out[] = $sep;
1454                                 }
1455                                 $out[] = $node;
1456                         }
1457                 }
1458                 $out[] = $end;
1459                 return $out;
1460         }
1461
1462         public function __toString() {
1463                 return 'frame{}';
1464         }
1465
1466         public function getPDBK( $level = false ) {
1467                 if ( $level === false ) {
1468                         return $this->title->getPrefixedDBkey();
1469                 } else {
1470                         return isset( $this->titleCache[$level] ) ? $this->titleCache[$level] : false;
1471                 }
1472         }
1473
1474         /**
1475          * @return array
1476          */
1477         public function getArguments() {
1478                 return [];
1479         }
1480
1481         /**
1482          * @return array
1483          */
1484         public function getNumberedArguments() {
1485                 return [];
1486         }
1487
1488         /**
1489          * @return array
1490          */
1491         public function getNamedArguments() {
1492                 return [];
1493         }
1494
1495         /**
1496          * Returns true if there are no arguments in this frame
1497          *
1498          * @return bool
1499          */
1500         public function isEmpty() {
1501                 return true;
1502         }
1503
1504         /**
1505          * @param int|string $name
1506          * @return bool Always false in this implementation.
1507          */
1508         public function getArgument( $name ) {
1509                 return false;
1510         }
1511
1512         /**
1513          * Returns true if the infinite loop check is OK, false if a loop is detected
1514          *
1515          * @param Title $title
1516          * @return bool
1517          */
1518         public function loopCheck( $title ) {
1519                 return !isset( $this->loopCheckHash[$title->getPrefixedDBkey()] );
1520         }
1521
1522         /**
1523          * Return true if the frame is a template frame
1524          *
1525          * @return bool
1526          */
1527         public function isTemplate() {
1528                 return false;
1529         }
1530
1531         /**
1532          * Get a title of frame
1533          *
1534          * @return Title
1535          */
1536         public function getTitle() {
1537                 return $this->title;
1538         }
1539
1540         /**
1541          * Set the volatile flag
1542          *
1543          * @param bool $flag
1544          */
1545         public function setVolatile( $flag = true ) {
1546                 $this->volatile = $flag;
1547         }
1548
1549         /**
1550          * Get the volatile flag
1551          *
1552          * @return bool
1553          */
1554         public function isVolatile() {
1555                 return $this->volatile;
1556         }
1557
1558         /**
1559          * Set the TTL
1560          *
1561          * @param int $ttl
1562          */
1563         public function setTTL( $ttl ) {
1564                 if ( $ttl !== null && ( $this->ttl === null || $ttl < $this->ttl ) ) {
1565                         $this->ttl = $ttl;
1566                 }
1567         }
1568
1569         /**
1570          * Get the TTL
1571          *
1572          * @return int|null
1573          */
1574         public function getTTL() {
1575                 return $this->ttl;
1576         }
1577 }
1578
1579 /**
1580  * Expansion frame with template arguments
1581  * @ingroup Parser
1582  */
1583 // @codingStandardsIgnoreStart Squiz.Classes.ValidClassName.NotCamelCaps
1584 class PPTemplateFrame_DOM extends PPFrame_DOM {
1585         // @codingStandardsIgnoreEnd
1586
1587         public $numberedArgs, $namedArgs;
1588
1589         /**
1590          * @var PPFrame_DOM
1591          */
1592         public $parent;
1593         public $numberedExpansionCache, $namedExpansionCache;
1594
1595         /**
1596          * @param Preprocessor $preprocessor
1597          * @param bool|PPFrame_DOM $parent
1598          * @param array $numberedArgs
1599          * @param array $namedArgs
1600          * @param bool|Title $title
1601          */
1602         public function __construct( $preprocessor, $parent = false, $numberedArgs = [],
1603                 $namedArgs = [], $title = false
1604         ) {
1605                 parent::__construct( $preprocessor );
1606
1607                 $this->parent = $parent;
1608                 $this->numberedArgs = $numberedArgs;
1609                 $this->namedArgs = $namedArgs;
1610                 $this->title = $title;
1611                 $pdbk = $title ? $title->getPrefixedDBkey() : false;
1612                 $this->titleCache = $parent->titleCache;
1613                 $this->titleCache[] = $pdbk;
1614                 $this->loopCheckHash = /*clone*/ $parent->loopCheckHash;
1615                 if ( $pdbk !== false ) {
1616                         $this->loopCheckHash[$pdbk] = true;
1617                 }
1618                 $this->depth = $parent->depth + 1;
1619                 $this->numberedExpansionCache = $this->namedExpansionCache = [];
1620         }
1621
1622         public function __toString() {
1623                 $s = 'tplframe{';
1624                 $first = true;
1625                 $args = $this->numberedArgs + $this->namedArgs;
1626                 foreach ( $args as $name => $value ) {
1627                         if ( $first ) {
1628                                 $first = false;
1629                         } else {
1630                                 $s .= ', ';
1631                         }
1632                         $s .= "\"$name\":\"" .
1633                                 str_replace( '"', '\\"', $value->ownerDocument->saveXML( $value ) ) . '"';
1634                 }
1635                 $s .= '}';
1636                 return $s;
1637         }
1638
1639         /**
1640          * @throws MWException
1641          * @param string|int $key
1642          * @param string|PPNode_DOM|DOMDocument $root
1643          * @param int $flags
1644          * @return string
1645          */
1646         public function cachedExpand( $key, $root, $flags = 0 ) {
1647                 if ( isset( $this->parent->childExpansionCache[$key] ) ) {
1648                         return $this->parent->childExpansionCache[$key];
1649                 }
1650                 $retval = $this->expand( $root, $flags );
1651                 if ( !$this->isVolatile() ) {
1652                         $this->parent->childExpansionCache[$key] = $retval;
1653                 }
1654                 return $retval;
1655         }
1656
1657         /**
1658          * Returns true if there are no arguments in this frame
1659          *
1660          * @return bool
1661          */
1662         public function isEmpty() {
1663                 return !count( $this->numberedArgs ) && !count( $this->namedArgs );
1664         }
1665
1666         public function getArguments() {
1667                 $arguments = [];
1668                 foreach ( array_merge(
1669                                 array_keys( $this->numberedArgs ),
1670                                 array_keys( $this->namedArgs ) ) as $key ) {
1671                         $arguments[$key] = $this->getArgument( $key );
1672                 }
1673                 return $arguments;
1674         }
1675
1676         public function getNumberedArguments() {
1677                 $arguments = [];
1678                 foreach ( array_keys( $this->numberedArgs ) as $key ) {
1679                         $arguments[$key] = $this->getArgument( $key );
1680                 }
1681                 return $arguments;
1682         }
1683
1684         public function getNamedArguments() {
1685                 $arguments = [];
1686                 foreach ( array_keys( $this->namedArgs ) as $key ) {
1687                         $arguments[$key] = $this->getArgument( $key );
1688                 }
1689                 return $arguments;
1690         }
1691
1692         /**
1693          * @param int $index
1694          * @return string|bool
1695          */
1696         public function getNumberedArgument( $index ) {
1697                 if ( !isset( $this->numberedArgs[$index] ) ) {
1698                         return false;
1699                 }
1700                 if ( !isset( $this->numberedExpansionCache[$index] ) ) {
1701                         # No trimming for unnamed arguments
1702                         $this->numberedExpansionCache[$index] = $this->parent->expand(
1703                                 $this->numberedArgs[$index],
1704                                 PPFrame::STRIP_COMMENTS
1705                         );
1706                 }
1707                 return $this->numberedExpansionCache[$index];
1708         }
1709
1710         /**
1711          * @param string $name
1712          * @return string|bool
1713          */
1714         public function getNamedArgument( $name ) {
1715                 if ( !isset( $this->namedArgs[$name] ) ) {
1716                         return false;
1717                 }
1718                 if ( !isset( $this->namedExpansionCache[$name] ) ) {
1719                         # Trim named arguments post-expand, for backwards compatibility
1720                         $this->namedExpansionCache[$name] = trim(
1721                                 $this->parent->expand( $this->namedArgs[$name], PPFrame::STRIP_COMMENTS ) );
1722                 }
1723                 return $this->namedExpansionCache[$name];
1724         }
1725
1726         /**
1727          * @param int|string $name
1728          * @return string|bool
1729          */
1730         public function getArgument( $name ) {
1731                 $text = $this->getNumberedArgument( $name );
1732                 if ( $text === false ) {
1733                         $text = $this->getNamedArgument( $name );
1734                 }
1735                 return $text;
1736         }
1737
1738         /**
1739          * Return true if the frame is a template frame
1740          *
1741          * @return bool
1742          */
1743         public function isTemplate() {
1744                 return true;
1745         }
1746
1747         public function setVolatile( $flag = true ) {
1748                 parent::setVolatile( $flag );
1749                 $this->parent->setVolatile( $flag );
1750         }
1751
1752         public function setTTL( $ttl ) {
1753                 parent::setTTL( $ttl );
1754                 $this->parent->setTTL( $ttl );
1755         }
1756 }
1757
1758 /**
1759  * Expansion frame with custom arguments
1760  * @ingroup Parser
1761  */
1762 // @codingStandardsIgnoreStart Squiz.Classes.ValidClassName.NotCamelCaps
1763 class PPCustomFrame_DOM extends PPFrame_DOM {
1764         // @codingStandardsIgnoreEnd
1765
1766         public $args;
1767
1768         public function __construct( $preprocessor, $args ) {
1769                 parent::__construct( $preprocessor );
1770                 $this->args = $args;
1771         }
1772
1773         public function __toString() {
1774                 $s = 'cstmframe{';
1775                 $first = true;
1776                 foreach ( $this->args as $name => $value ) {
1777                         if ( $first ) {
1778                                 $first = false;
1779                         } else {
1780                                 $s .= ', ';
1781                         }
1782                         $s .= "\"$name\":\"" .
1783                                 str_replace( '"', '\\"', $value->__toString() ) . '"';
1784                 }
1785                 $s .= '}';
1786                 return $s;
1787         }
1788
1789         /**
1790          * @return bool
1791          */
1792         public function isEmpty() {
1793                 return !count( $this->args );
1794         }
1795
1796         /**
1797          * @param int|string $index
1798          * @return string|bool
1799          */
1800         public function getArgument( $index ) {
1801                 if ( !isset( $this->args[$index] ) ) {
1802                         return false;
1803                 }
1804                 return $this->args[$index];
1805         }
1806
1807         public function getArguments() {
1808                 return $this->args;
1809         }
1810 }
1811
1812 /**
1813  * @ingroup Parser
1814  */
1815 // @codingStandardsIgnoreStart Squiz.Classes.ValidClassName.NotCamelCaps
1816 class PPNode_DOM implements PPNode {
1817         // @codingStandardsIgnoreEnd
1818
1819         /**
1820          * @var DOMElement
1821          */
1822         public $node;
1823         public $xpath;
1824
1825         public function __construct( $node, $xpath = false ) {
1826                 $this->node = $node;
1827         }
1828
1829         /**
1830          * @return DOMXPath
1831          */
1832         public function getXPath() {
1833                 if ( $this->xpath === null ) {
1834                         $this->xpath = new DOMXPath( $this->node->ownerDocument );
1835                 }
1836                 return $this->xpath;
1837         }
1838
1839         public function __toString() {
1840                 if ( $this->node instanceof DOMNodeList ) {
1841                         $s = '';
1842                         foreach ( $this->node as $node ) {
1843                                 $s .= $node->ownerDocument->saveXML( $node );
1844                         }
1845                 } else {
1846                         $s = $this->node->ownerDocument->saveXML( $this->node );
1847                 }
1848                 return $s;
1849         }
1850
1851         /**
1852          * @return bool|PPNode_DOM
1853          */
1854         public function getChildren() {
1855                 return $this->node->childNodes ? new self( $this->node->childNodes ) : false;
1856         }
1857
1858         /**
1859          * @return bool|PPNode_DOM
1860          */
1861         public function getFirstChild() {
1862                 return $this->node->firstChild ? new self( $this->node->firstChild ) : false;
1863         }
1864
1865         /**
1866          * @return bool|PPNode_DOM
1867          */
1868         public function getNextSibling() {
1869                 return $this->node->nextSibling ? new self( $this->node->nextSibling ) : false;
1870         }
1871
1872         /**
1873          * @param string $type
1874          *
1875          * @return bool|PPNode_DOM
1876          */
1877         public function getChildrenOfType( $type ) {
1878                 return new self( $this->getXPath()->query( $type, $this->node ) );
1879         }
1880
1881         /**
1882          * @return int
1883          */
1884         public function getLength() {
1885                 if ( $this->node instanceof DOMNodeList ) {
1886                         return $this->node->length;
1887                 } else {
1888                         return false;
1889                 }
1890         }
1891
1892         /**
1893          * @param int $i
1894          * @return bool|PPNode_DOM
1895          */
1896         public function item( $i ) {
1897                 $item = $this->node->item( $i );
1898                 return $item ? new self( $item ) : false;
1899         }
1900
1901         /**
1902          * @return string
1903          */
1904         public function getName() {
1905                 if ( $this->node instanceof DOMNodeList ) {
1906                         return '#nodelist';
1907                 } else {
1908                         return $this->node->nodeName;
1909                 }
1910         }
1911
1912         /**
1913          * Split a "<part>" node into an associative array containing:
1914          *  - name          PPNode name
1915          *  - index         String index
1916          *  - value         PPNode value
1917          *
1918          * @throws MWException
1919          * @return array
1920          */
1921         public function splitArg() {
1922                 $xpath = $this->getXPath();
1923                 $names = $xpath->query( 'name', $this->node );
1924                 $values = $xpath->query( 'value', $this->node );
1925                 if ( !$names->length || !$values->length ) {
1926                         throw new MWException( 'Invalid brace node passed to ' . __METHOD__ );
1927                 }
1928                 $name = $names->item( 0 );
1929                 $index = $name->getAttribute( 'index' );
1930                 return [
1931                         'name' => new self( $name ),
1932                         'index' => $index,
1933                         'value' => new self( $values->item( 0 ) ) ];
1934         }
1935
1936         /**
1937          * Split an "<ext>" node into an associative array containing name, attr, inner and close
1938          * All values in the resulting array are PPNodes. Inner and close are optional.
1939          *
1940          * @throws MWException
1941          * @return array
1942          */
1943         public function splitExt() {
1944                 $xpath = $this->getXPath();
1945                 $names = $xpath->query( 'name', $this->node );
1946                 $attrs = $xpath->query( 'attr', $this->node );
1947                 $inners = $xpath->query( 'inner', $this->node );
1948                 $closes = $xpath->query( 'close', $this->node );
1949                 if ( !$names->length || !$attrs->length ) {
1950                         throw new MWException( 'Invalid ext node passed to ' . __METHOD__ );
1951                 }
1952                 $parts = [
1953                         'name' => new self( $names->item( 0 ) ),
1954                         'attr' => new self( $attrs->item( 0 ) ) ];
1955                 if ( $inners->length ) {
1956                         $parts['inner'] = new self( $inners->item( 0 ) );
1957                 }
1958                 if ( $closes->length ) {
1959                         $parts['close'] = new self( $closes->item( 0 ) );
1960                 }
1961                 return $parts;
1962         }
1963
1964         /**
1965          * Split a "<h>" node
1966          * @throws MWException
1967          * @return array
1968          */
1969         public function splitHeading() {
1970                 if ( $this->getName() !== 'h' ) {
1971                         throw new MWException( 'Invalid h node passed to ' . __METHOD__ );
1972                 }
1973                 return [
1974                         'i' => $this->node->getAttribute( 'i' ),
1975                         'level' => $this->node->getAttribute( 'level' ),
1976                         'contents' => $this->getChildren()
1977                 ];
1978         }
1979 }