Page MenuHomeWickedGov Phorge
Files F4093440

LuaSandboxInterpreter.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

LuaSandboxInterpreter.php
View Options

<?php
namespace MediaWiki\Extension\Scribunto\Engines\LuaSandbox;
use LuaSandbox;
use LuaSandboxError;
use LuaSandboxFunction;
use LuaSandboxTimeoutError;
use MediaWiki\Extension\Scribunto\Engines\LuaCommon\LuaEngine;
use MediaWiki\Extension\Scribunto\Engines\LuaCommon\LuaError;
use MediaWiki\Extension\Scribunto\Engines\LuaCommon\LuaInterpreter;
use MediaWiki\Extension\Scribunto\Engines\LuaCommon\LuaInterpreterBadVersionError;
use MediaWiki\Extension\Scribunto\Engines\LuaCommon\LuaInterpreterNotFoundError;
use RuntimeException;
use UtfNormal\Validator;
class LuaSandboxInterpreter extends LuaInterpreter {
/**
* @var LuaEngine
*/
public $engine;
/**
* @var LuaSandbox
*/
public $sandbox;
/**
* @var bool
*/
public $profilerEnabled;
public const SAMPLES = 0;
public const SECONDS = 1;
public const PERCENT = 2;
/**
* Check that php-luasandbox is available and of a recent-enough version
* @throws LuaInterpreterNotFoundError
* @throws LuaInterpreterBadVersionError
*/
public static function checkLuaSandboxVersion() {
if ( !extension_loaded( 'luasandbox' ) ) {
throw new LuaInterpreterNotFoundError(
'The luasandbox extension is not present, this engine cannot be used.' );
}
if ( !is_callable( [ LuaSandbox::class, 'getVersionInfo' ] ) ) {
throw new LuaInterpreterBadVersionError(
'The luasandbox extension is too old (version 1.6+ is required), ' .
'this engine cannot be used.'
);
}
}
/**
* @param LuaEngine $engine
* @param array $options
*/
public function __construct( $engine, array $options ) {
self::checkLuaSandboxVersion();
$this->engine = $engine;
$this->sandbox = new LuaSandbox;
$this->sandbox->setMemoryLimit( $options['memoryLimit'] );
$this->sandbox->setCPULimit( $options['cpuLimit'] );
if ( !isset( $options['profilerPeriod'] ) ) {
$options['profilerPeriod'] = 0.02;
}
if ( $options['profilerPeriod'] ) {
$this->profilerEnabled = true;
$this->sandbox->enableProfiler( $options['profilerPeriod'] );
}
}
/**
* Convert a LuaSandboxError to a LuaError
* @param LuaSandboxError $e
* @return LuaError
*/
protected function convertSandboxError( LuaSandboxError $e ) {
$opts = [];
if ( isset( $e->luaTrace ) ) {
$trace = $e->luaTrace;
foreach ( $trace as &$val ) {
$val = array_map( static function ( $val ) {
if ( is_string( $val ) ) {
$val = Validator::cleanUp( $val );
}
return $val;
}, $val );
}
$opts['trace'] = $trace;
}
$message = Validator::cleanUp( $e->getMessage() );
if ( preg_match( '/^(.*?):(\d+): (.*)$/', $message, $m ) ) {
$opts['module'] = $m[1];
$opts['line'] = $m[2];
$message = $m[3];
}
return $this->engine->newLuaError( $message, $opts );
}
/**
* @param string $text
* @param string $chunkName
* @return mixed
* @throws LuaError
*/
public function loadString( $text, $chunkName ) {
try {
return $this->sandbox->loadString( $text, $chunkName );
} catch ( LuaSandboxError $e ) {
throw $this->convertSandboxError( $e );
}
}
/** @inheritDoc */
public function registerLibrary( $name, array $functions ) {
$realLibrary = [];
foreach ( $functions as $funcName => $callback ) {
$realLibrary[$funcName] = [
new LuaSandboxCallback( $callback ),
$funcName ];
}
$this->sandbox->registerLibrary( $name, $realLibrary );
# TODO: replace this with
# $this->sandbox->registerVirtualLibrary(
# $name, [ $this, 'callback' ], $functions );
}
/** @inheritDoc */
public function callFunction( $func, ...$args ) {
try {
$ret = $func->call( ...$args );
if ( $ret === false ) {
// Per the documentation on LuaSandboxFunction::call, a return value
// of false means that something went wrong and it's PHP's fault,
// so throw a "real" exception.
throw new RuntimeException(
__METHOD__ . ': LuaSandboxFunction::call returned false' );
}
return $ret;
} catch ( LuaSandboxTimeoutError $e ) {
throw $this->engine->newException( 'scribunto-common-timeout' );
} catch ( LuaSandboxError $e ) {
throw $this->convertSandboxError( $e );
}
}
/** @inheritDoc */
public function wrapPhpFunction( $callable ) {
return $this->sandbox->wrapPhpFunction( $callable );
}
/** @inheritDoc */
public function isLuaFunction( $object ) {
return $object instanceof LuaSandboxFunction;
}
/**
* @return int
*/
public function getPeakMemoryUsage() {
return $this->sandbox->getPeakMemoryUsage();
}
/**
* @return float
*/
public function getCPUUsage() {
return $this->sandbox->getCPUUsage();
}
/**
* @param int $units self::SAMPLES, self::SECONDS, or self::PERCENT
* @return array
*/
public function getProfilerFunctionReport( $units ) {
if ( $this->profilerEnabled ) {
static $unitsMap;
if ( !$unitsMap ) {
$unitsMap = [
self::SAMPLES => LuaSandbox::SAMPLES,
self::SECONDS => LuaSandbox::SECONDS,
self::PERCENT => LuaSandbox::PERCENT,
];
}
return $this->sandbox->getProfilerFunctionReport( $unitsMap[$units] );
} else {
return [];
}
}
public function pauseUsageTimer() {
$this->sandbox->pauseUsageTimer();
}
public function unpauseUsageTimer() {
$this->sandbox->unpauseUsageTimer();
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 18 2026, 12:48 (4 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ab/6b/fd4c7374ba35cacd853f79e97306
Default Alt Text
LuaSandboxInterpreter.php (5 KB)

Event Timeline