Preprocessor.php

Go to the documentation of this file.

<?php
use MediaWiki\Logger\LoggerFactory;

abstract class Preprocessor {

    const CACHE_VERSION = 1;

    protected $rules = [
        '{' => [
            'end' => '}',
            'names' => [
                2 => 'template',
                3 => 'tplarg',
            ],
            'min' => 2,
            'max' => 3,
        ],
        '[' => [
            'end' => ']',
            'names' => [ 2 => null ],
            'min' => 2,
            'max' => 2,
        ]
    ];

    protected function cacheSetTree( $text, $flags, $tree ) {
        $config = RequestContext::getMain()->getConfig();

        $length = strlen( $text );
        $threshold = $config->get( 'PreprocessorCacheThreshold' );
        if ( $threshold === false || $length < $threshold || $length > 1e6 ) {
            return false;
        }

        $key = wfMemcKey(
            defined( 'static::CACHE_PREFIX' ) ? static::CACHE_PREFIX : static::class,
            md5( $text ), $flags );
        $value = sprintf( "%08d", static::CACHE_VERSION ) . $tree;

        $cache = ObjectCache::getInstance( $config->get( 'MainCacheType' ) );
        $cache->set( $key, $value, 86400 );

        LoggerFactory::getInstance( 'Preprocessor' )
            ->info( "Cached preprocessor output (key: $key)" );
    }

    protected function cacheGetTree( $text, $flags ) {
        $config = RequestContext::getMain()->getConfig();

        $length = strlen( $text );
        $threshold = $config->get( 'PreprocessorCacheThreshold' );
        if ( $threshold === false || $length < $threshold || $length > 1e6 ) {
            return false;
        }

        $cache = ObjectCache::getInstance( $config->get( 'MainCacheType' ) );

        $key = wfMemcKey(
            defined( 'static::CACHE_PREFIX' ) ? static::CACHE_PREFIX : static::class,
            md5( $text ), $flags );

        $value = $cache->get( $key );
        if ( !$value ) {
            return false;
        }

        $version = intval( substr( $value, 0, 8 ) );
        if ( $version !== static::CACHE_VERSION ) {
            return false;
        }

        LoggerFactory::getInstance( 'Preprocessor' )
            ->info( "Loaded preprocessor output from cache (key: $key)" );

        return substr( $value, 8 );
    }

    abstract public function newFrame();

    abstract public function newCustomFrame( $args );

    abstract public function newPartNodeArray( $values );

    abstract public function preprocessToObj( $text, $flags = 0 );
}

interface PPFrame {
    const NO_ARGS = 1;
    const NO_TEMPLATES = 2;
    const STRIP_COMMENTS = 4;
    const NO_IGNORE = 8;
    const RECOVER_COMMENTS = 16;
    const NO_TAGS = 32;

    const RECOVER_ORIG = 59; // = 1|2|8|16|32 no constant expression support in PHP yet

    const SUPPORTS_INDEX_OFFSET = 1;

    public function newChild( $args = false, $title = false, $indexOffset = 0 );

    public function cachedExpand( $key, $root, $flags = 0 );

    public function expand( $root, $flags = 0 );

    public function implodeWithFlags( $sep, $flags /*, ... */ );

    public function implode( $sep /*, ... */ );

    public function virtualImplode( $sep /*, ... */ );

    public function virtualBracketedImplode( $start, $sep, $end /*, ... */ );

    public function isEmpty();

    public function getArguments();

    public function getNumberedArguments();

    public function getNamedArguments();

    public function getArgument( $name );

    public function loopCheck( $title );

    public function isTemplate();

    public function setVolatile( $flag = true );

    public function isVolatile();

    public function getTTL();

    public function setTTL( $ttl );

    public function getTitle();
}

interface PPNode {
    public function getChildren();

    public function getFirstChild();

    public function getNextSibling();

    public function getChildrenOfType( $type );

    public function getLength();

    public function item( $i );

    public function getName();

    public function splitArg();

    public function splitExt();

    public function splitHeading();
}