includes/parser/Preprocessor_HipHop.hphp

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