Common.php

Go to the documentation of this file.

<?php
 
class Scribunto {
    const LOCAL = 'local';
 
    public static function newEngine( $options ) {
        if ( isset( $options['factory'] ) ) {
            return call_user_func( $options['factory'], $options );
        } else {
            $class = $options['class'];
            return new $class( $options );
        }
    }
 
    public static function newDefaultEngine( $extraOptions = [] ) {
        global $wgScribuntoDefaultEngine, $wgScribuntoEngineConf;
        if ( !$wgScribuntoDefaultEngine ) {
            throw new MWException(
                'Scribunto extension is enabled but $wgScribuntoDefaultEngine is not set'
            );
        }
 
        if ( !isset( $wgScribuntoEngineConf[$wgScribuntoDefaultEngine] ) ) {
            throw new MWException( 'Invalid scripting engine is specified in $wgScribuntoDefaultEngine' );
        }
        $options = $extraOptions + $wgScribuntoEngineConf[$wgScribuntoDefaultEngine];
        // @phan-suppress-next-line PhanTypeMismatchArgument false positive
        return self::newEngine( $options );
    }
 
    public static function getParserEngine( Parser $parser ) {
        if ( empty( $parser->scribunto_engine ) ) {
            $parser->scribunto_engine = self::newDefaultEngine( [ 'parser' => $parser ] );
            $parser->scribunto_engine->setTitle( $parser->getTitle() );
        }
        return $parser->scribunto_engine;
    }
 
    public static function isParserEnginePresent( Parser $parser ) {
        return !empty( $parser->scribunto_engine );
    }
 
    public static function resetParserEngine( Parser $parser ) {
        if ( !empty( $parser->scribunto_engine ) ) {
            $parser->scribunto_engine->destroy();
            $parser->scribunto_engine = null;
        }
    }
 
    public static function isDocPage( Title $title, Title &$forModule = null ) {
        $docPage = wfMessage( 'scribunto-doc-page-name' )->inContentLanguage();
        if ( $docPage->isDisabled() ) {
            return false;
        }
 
        // Canonicalize the input pseudo-title. The unreplaced "$1" shouldn't
        // cause a problem.
        $docTitle = Title::newFromText( $docPage->plain() );
        if ( !$docTitle ) {
            return false;
        }
        $docPage = $docTitle->getPrefixedText();
 
        // Make it into a regex, and match it against the input title
        $docPage = str_replace( '\\$1', '(.+)', preg_quote( $docPage, '/' ) );
        if ( preg_match( "/^$docPage$/", $title->getPrefixedText(), $m ) ) {
            $forModule = Title::makeTitleSafe( NS_MODULE, $m[1] );
            return $forModule !== null;
        } else {
            return false;
        }
    }
 
    public static function getDocPage( Title $title ) {
        $docPage = wfMessage( 'scribunto-doc-page-name', $title->getText() )->inContentLanguage();
        if ( $docPage->isDisabled() ) {
            return null;
        }
 
        return Title::newFromText( $docPage->plain() );
    }
}
 
class ScribuntoException extends MWException {
    public $messageName;
 
    public $messageArgs;
 
    public $params;
 
    public function __construct( $messageName, $params = [] ) {
        if ( isset( $params['args'] ) ) {
            $this->messageArgs = $params['args'];
        } else {
            $this->messageArgs = [];
        }
        if ( isset( $params['module'] ) && isset( $params['line'] ) ) {
            $codeLocation = false;
            if ( isset( $params['title'] ) ) {
                $moduleTitle = Title::newFromText( $params['module'] );
                if ( $moduleTitle && $moduleTitle->equals( $params['title'] ) ) {
                    $codeLocation = wfMessage( 'scribunto-line', $params['line'] )->inContentLanguage()->text();
                }
            }
            if ( $codeLocation === false ) {
                $codeLocation = wfMessage(
                    'scribunto-module-line',
                    $params['module'],
                    $params['line']
                )->inContentLanguage()->text();
            }
        } else {
            $codeLocation = '[UNKNOWN]';
        }
        array_unshift( $this->messageArgs, $codeLocation );
        $msg = wfMessage( $messageName )->params( $this->messageArgs )->inContentLanguage()->text();
        parent::__construct( $msg );
 
        $this->messageName = $messageName;
        $this->params = $params;
    }
 
    public function getMessageName() {
        return $this->messageName;
    }
 
    public function toStatus() {
        $status = Status::newFatal( $this->messageName, ...$this->messageArgs );
        $status->scribunto_error = $this;
        return $status;
    }
 
    public function getScriptTraceHtml( $options = [] ) {
        return false;
    }
}