ApiScribuntoConsole.php

Go to the documentation of this file.

<?php
 
class ApiScribuntoConsole extends ApiBase {
    const SC_MAX_SIZE = 500000;
    const SC_SESSION_EXPIRY = 3600;
 
    public function execute() {
        $params = $this->extractRequestParams();
 
        $title = Title::newFromText( $params['title'] );
        if ( !$title ) {
            $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['title'] ) ] );
        }
 
        if ( $params['session'] ) {
            $sessionId = $params['session'];
        } else {
            $sessionId = mt_rand( 0, 0x7fffffff );
        }
 
        $cache = ObjectCache::getInstance( CACHE_ANYTHING );
        $sessionKey = $cache->makeKey( 'scribunto-console', $this->getUser()->getId(), $sessionId );
        $session = null;
        $sessionIsNew = false;
        if ( $params['session'] ) {
            $session = $cache->get( $sessionKey );
        }
        if ( !isset( $session['version'] ) ) {
            $session = $this->newSession();
            $sessionIsNew = true;
        }
 
        // Create a variable holding the session which will be stored if there
        // are no errors. If there are errors, we don't want to store the current
        // question to the state builder array, since that will cause subsequent
        // requests to fail.
        $newSession = $session;
 
        if ( !empty( $params['clear'] ) ) {
            $newSession['size'] -= strlen( implode( '', $newSession['questions'] ) );
            $newSession['questions'] = [];
            $session['questions'] = [];
        }
        if ( strlen( $params['question'] ) ) {
            $newSession['size'] += strlen( $params['question'] );
            $newSession['questions'][] = $params['question'];
        }
        if ( $params['content'] ) {
            $newSession['size'] += strlen( $params['content'] ) - strlen( $newSession['content'] );
            $newSession['content'] = $params['content'];
        }
 
        if ( $newSession['size'] > self::SC_MAX_SIZE ) {
            $this->dieWithError( 'scribunto-console-too-large' );
        }
        $result = $this->runConsole( [
            'title' => $title,
            'content' => $newSession['content'],
            'prevQuestions' => $session['questions'],
            'question' => $params['question'],
        ] );
 
        if ( $result['type'] === 'error' ) {
            // Restore the questions array
            $newSession['questions'] = $session['questions'];
        }
        $cache->set( $sessionKey, $newSession, self::SC_SESSION_EXPIRY );
        $result['session'] = $sessionId;
        $result['sessionSize'] = $newSession['size'];
        $result['sessionMaxSize'] = self::SC_MAX_SIZE;
        if ( $sessionIsNew ) {
            $result['sessionIsNew'] = '';
        }
        foreach ( $result as $key => $value ) {
            $this->getResult()->addValue( null, $key, $value );
        }
    }
 
    protected function runConsole( array $params ) {
        global $wgParser;
        $options = new ParserOptions;
        $wgParser->startExternalParse( $params['title'], $options, Parser::OT_HTML, true );
        $engine = Scribunto::getParserEngine( $wgParser );
        try {
            $result = $engine->runConsole( $params );
        } catch ( ScribuntoException $e ) {
            $trace = $e->getScriptTraceHtml();
            $message = $e->getMessage();
            $html = Html::element( 'p', [], $message );
            if ( $trace !== false ) {
                $html .= Html::element( 'p',
                    [],
                    $this->msg( 'scribunto-common-backtrace' )->inContentLanguage()->text()
                ) . $trace;
            }
 
            return [
                'type' => 'error',
                'html' => $html,
                'message' => $message,
                'messagename' => $e->getMessageName() ];
        }
        return [
            'type' => 'normal',
            'print' => strval( $result['print'] ),
            'return' => strval( $result['return'] )
        ];
    }
 
    protected function newSession() {
        return [
            'content' => '',
            'questions' => [],
            'size' => 0,
            'version' => 1,
        ];
    }
 
    public function isInternal() {
        return true;
    }
 
    public function getAllowedParams() {
        return [
            'title' => [
                ApiBase::PARAM_TYPE => 'string',
            ],
            'content' => [
                ApiBase::PARAM_TYPE => 'text'
            ],
            'session' => [
                ApiBase::PARAM_TYPE => 'integer',
            ],
            'question' => [
                ApiBase::PARAM_TYPE => 'text',
                ApiBase::PARAM_REQUIRED => true,
            ],
            'clear' => [
                ApiBase::PARAM_TYPE => 'boolean',
            ],
        ];
    }
}