Base.php

Go to the documentation of this file.

<?php
 
abstract class ScribuntoEngineBase {
 
    // Flags for ScribuntoEngineBase::getResourceUsage()
    const CPU_SECONDS = 1;
    const MEM_PEAK_BYTES = 2;
 
    protected $title;
 
    protected $options;
 
    protected $modules = [];
 
    protected $parser;
 
    abstract protected function newModule( $text, $chunkName );
 
    abstract public function runConsole( array $params );
 
    abstract public function getSoftwareInfo( array &$software );
 
    public function __construct( array $options ) {
        $this->options = $options;
        if ( isset( $options['parser'] ) ) {
            $this->parser = $options['parser'];
        }
        if ( isset( $options['title'] ) ) {
            $this->title = $options['title'];
        }
    }
 
    public function __destruct() {
        $this->destroy();
    }
 
    public function destroy() {
        // Break reference cycles
        $this->parser = null;
        $this->title = null;
        $this->modules = null;
    }
 
    public function setTitle( $title ) {
        $this->title = $title;
    }
 
    public function getTitle() {
        return $this->title;
    }
 
    public function getOption( $optionName ) {
        return $this->options[$optionName] ?? null;
    }
 
    public function newException( $message, array $params = [] ) {
        return new ScribuntoException( $message, $this->getDefaultExceptionParams() + $params );
    }
 
    public function getDefaultExceptionParams() {
        $params = [];
        if ( $this->title ) {
            $params['title'] = $this->title;
        }
        return $params;
    }
 
    public function fetchModuleFromParser( Title $title ) {
        $key = $title->getPrefixedDBkey();
        if ( !array_key_exists( $key, $this->modules ) ) {
            list( $text, $finalTitle ) = $this->parser->fetchTemplateAndTitle( $title );
            if ( $text === false ) {
                $this->modules[$key] = null;
                return null;
            }
 
            $finalKey = $finalTitle->getPrefixedDBkey();
            if ( !isset( $this->modules[$finalKey] ) ) {
                $this->modules[$finalKey] = $this->newModule( $text, $finalKey );
            }
            // Almost certainly $key === $finalKey, but just in case...
            $this->modules[$key] = $this->modules[$finalKey];
        }
        return $this->modules[$key];
    }
 
    public function validate( $text, $chunkName = false ) {
        $module = $this->newModule( $text, $chunkName );
        return $module->validate();
    }
 
    public function getResourceUsage( $resource ) {
        return false;
    }
 
    public function getGeSHiLanguage() {
        return false;
    }
 
    public function getCodeEditorLanguage() {
        return false;
    }
 
    public function getParser() {
        return $this->parser;
    }
 
    protected function getLibraries( $engine, array $coreLibraries = [] ) {
        $extraLibraries = [];
        Hooks::run( 'ScribuntoExternalLibraries', [ $engine, &$extraLibraries ] );
        return $coreLibraries + $extraLibraries;
    }
 
    protected function getLibraryPaths( $engine, array $coreLibraryPaths = [] ) {
        $extraLibraryPaths = [];
        Hooks::run( 'ScribuntoExternalLibraryPaths', [ $engine, &$extraLibraryPaths ] );
        return array_merge( $coreLibraryPaths, $extraLibraryPaths );
    }
 
    public function reportLimitData( ParserOutput $output ) {
    }
 
    public function formatLimitData( $key, &$value, &$report, $isHTML, $localize ) {
        return true;
    }
}
 
abstract class ScribuntoModuleBase {
    protected $engine;
 
    protected $code;
 
    protected $chunkName;
 
    public function __construct( ScribuntoEngineBase $engine, $code, $chunkName ) {
        $this->engine = $engine;
        $this->code = $code;
        $this->chunkName = $chunkName;
    }
 
    public function getEngine() {
        return $this->engine;
    }
 
    public function getCode() {
        return $this->code;
    }
 
    public function getChunkName() {
        return $this->chunkName;
    }
 
    abstract public function validate();
 
    abstract public function invoke( $name, $frame );
}