StripState.php

Go to the documentation of this file.

<?php
class StripState {
    protected $prefix;
    protected $data;
    protected $regex;

    protected $tempType, $tempMergePrefix;
    protected $circularRefGuard;
    protected $recursionLevel = 0;

    const UNSTRIP_RECURSION_LIMIT = 20;

    public function __construct( $prefix = null ) {
        if ( $prefix !== null ) {
            wfDeprecated( __METHOD__ . ' with called with $prefix argument' .
                ' (call with no arguments instead)', '1.26' );
        }
        $this->data = [
            'nowiki' => [],
            'general' => []
        ];
        $this->regex = '/' . Parser::MARKER_PREFIX . "([^\x7f<>&'\"]+)" . Parser::MARKER_SUFFIX . '/';
        $this->circularRefGuard = [];
    }

    public function addNoWiki( $marker, $value ) {
        $this->addItem( 'nowiki', $marker, $value );
    }

    public function addGeneral( $marker, $value ) {
        $this->addItem( 'general', $marker, $value );
    }

    protected function addItem( $type, $marker, $value ) {
        if ( !preg_match( $this->regex, $marker, $m ) ) {
            throw new MWException( "Invalid marker: $marker" );
        }

        $this->data[$type][$m[1]] = $value;
    }

    public function unstripGeneral( $text ) {
        return $this->unstripType( 'general', $text );
    }

    public function unstripNoWiki( $text ) {
        return $this->unstripType( 'nowiki', $text );
    }

    public function unstripBoth( $text ) {
        $text = $this->unstripType( 'general', $text );
        $text = $this->unstripType( 'nowiki', $text );
        return $text;
    }

    protected function unstripType( $type, $text ) {
        // Shortcut
        if ( !count( $this->data[$type] ) ) {
            return $text;
        }

        $oldType = $this->tempType;
        $this->tempType = $type;
        $text = preg_replace_callback( $this->regex, [ $this, 'unstripCallback' ], $text );
        $this->tempType = $oldType;
        return $text;
    }

    protected function unstripCallback( $m ) {
        $marker = $m[1];
        if ( isset( $this->data[$this->tempType][$marker] ) ) {
            if ( isset( $this->circularRefGuard[$marker] ) ) {
                return '<span class="error">'
                    . wfMessage( 'parser-unstrip-loop-warning' )->inContentLanguage()->text()
                    . '</span>';
            }
            if ( $this->recursionLevel >= self::UNSTRIP_RECURSION_LIMIT ) {
                return '<span class="error">' .
                    wfMessage( 'parser-unstrip-recursion-limit' )
                        ->numParams( self::UNSTRIP_RECURSION_LIMIT )->inContentLanguage()->text() .
                    '</span>';
            }
            $this->circularRefGuard[$marker] = true;
            $this->recursionLevel++;
            $value = $this->data[$this->tempType][$marker];
            if ( $value instanceof Closure ) {
                $value = $value();
            }
            $ret = $this->unstripType( $this->tempType, $value );
            $this->recursionLevel--;
            unset( $this->circularRefGuard[$marker] );
            return $ret;
        } else {
            return $m[0];
        }
    }

    public function getSubState( $text ) {
        $subState = new StripState();
        $pos = 0;
        while ( true ) {
            $startPos = strpos( $text, Parser::MARKER_PREFIX, $pos );
            $endPos = strpos( $text, Parser::MARKER_SUFFIX, $pos );
            if ( $startPos === false || $endPos === false ) {
                break;
            }

            $endPos += strlen( Parser::MARKER_SUFFIX );
            $marker = substr( $text, $startPos, $endPos - $startPos );
            if ( !preg_match( $this->regex, $marker, $m ) ) {
                continue;
            }

            $key = $m[1];
            if ( isset( $this->data['nowiki'][$key] ) ) {
                $subState->data['nowiki'][$key] = $this->data['nowiki'][$key];
            } elseif ( isset( $this->data['general'][$key] ) ) {
                $subState->data['general'][$key] = $this->data['general'][$key];
            }
            $pos = $endPos;
        }
        return $subState;
    }

    public function merge( $otherState, $texts ) {
        $mergePrefix = wfRandomString( 16 );

        foreach ( $otherState->data as $type => $items ) {
            foreach ( $items as $key => $value ) {
                $this->data[$type]["$mergePrefix-$key"] = $value;
            }
        }

        $this->tempMergePrefix = $mergePrefix;
        $texts = preg_replace_callback( $otherState->regex, [ $this, 'mergeCallback' ], $texts );
        $this->tempMergePrefix = null;
        return $texts;
    }

    protected function mergeCallback( $m ) {
        $key = $m[1];
        return Parser::MARKER_PREFIX . $this->tempMergePrefix . '-' . $key . Parser::MARKER_SUFFIX;
    }

    public function killMarkers( $text ) {
        return preg_replace( $this->regex, '', $text );
    }
}