Page MenuHomeWickedGov Phorge
Files F5974717

LuaSandboxEngine.php
No OneTemporary
Actions

Size
7 KB
Referenced Files
None
Subscribers
None

LuaSandboxEngine.php
View Options

<?php
namespace MediaWiki\Extension\Scribunto\Engines\LuaSandbox;
use LuaSandbox;
use MediaWiki\Extension\Scribunto\Engines\LuaCommon\LuaEngine;
use MediaWiki\Extension\Scribunto\Engines\LuaCommon\LuaInterpreterBadVersionError;
use MediaWiki\Extension\Scribunto\Engines\LuaCommon\LuaInterpreterNotFoundError;
use MediaWiki\Html\Html;
use MediaWiki\MediaWikiServices;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Title\Title;
class LuaSandboxEngine extends LuaEngine {
/** @var array */
public $options;
/** @var bool */
public $loaded = false;
/** @var array */
protected $lineCache = [];
/**
* @var LuaSandboxInterpreter
*/
protected $interpreter;
/** @inheritDoc */
public function getPerformanceCharacteristics() {
return [
'phpCallsRequireSerialization' => false,
];
}
/** @inheritDoc */
public function getSoftwareInfo( array &$software ) {
try {
LuaSandboxInterpreter::checkLuaSandboxVersion();
} catch ( LuaInterpreterNotFoundError $e ) {
// They shouldn't be using this engine if the extension isn't
// loaded. But in case they do for some reason, let's not have
// Special:Version fatal.
return;
} catch ( LuaInterpreterBadVersionError $e ) {
// @phan-suppress-previous-line PhanPluginDuplicateCatchStatementBody
// Same for if the extension is too old.
return;
}
$versions = LuaSandbox::getVersionInfo();
$software['[https://www.mediawiki.org/wiki/LuaSandbox LuaSandbox]'] =
$versions['LuaSandbox'];
$software['[http://www.lua.org/ Lua]'] = str_replace( 'Lua ', '', $versions['Lua'] );
if ( isset( $versions['LuaJIT'] ) ) {
$software['[http://luajit.org/ LuaJIT]'] = str_replace( 'LuaJIT ', '', $versions['LuaJIT'] );
}
}
/** @inheritDoc */
public function getResourceUsage( $resource ) {
$this->load();
switch ( $resource ) {
case self::MEM_PEAK_BYTES:
return $this->interpreter->getPeakMemoryUsage();
case self::CPU_SECONDS:
return $this->interpreter->getCPUUsage();
default:
return false;
}
}
/**
* @return array
*/
private function getLimitReportData() {
$ret = [];
$this->load();
$t = $this->interpreter->getCPUUsage();
$ret['scribunto-limitreport-timeusage'] = [
sprintf( "%.3f", $t ),
sprintf( "%.3f", $this->options['cpuLimit'] )
];
$ret['scribunto-limitreport-memusage'] = [
$this->interpreter->getPeakMemoryUsage(),
$this->options['memoryLimit'],
];
$logs = $this->getLogBuffer();
if ( $logs !== '' ) {
$ret['scribunto-limitreport-logs'] = $logs;
}
if ( $t < 1.0 ) {
return $ret;
}
$percentProfile = $this->interpreter->getProfilerFunctionReport(
LuaSandboxInterpreter::PERCENT
);
if ( !count( $percentProfile ) ) {
return $ret;
}
$timeProfile = $this->interpreter->getProfilerFunctionReport(
LuaSandboxInterpreter::SECONDS
);
$lines = [];
$cumulativePercent = 0;
$num = $otherTime = $otherPercent = 0;
foreach ( $percentProfile as $name => $percent ) {
$time = $timeProfile[$name] * 1000;
$num++;
if ( $cumulativePercent <= 99 && $num <= 10 ) {
// Map some regularly appearing internal names
if ( preg_match( '/^<mw.lua:(\d+)>$/', $name, $m ) ) {
$line = $this->getMwLuaLine( (int)$m[1] );
if ( preg_match( '/^\s*(local\s+)?function ([a-zA-Z0-9_.]*)/', $line, $m ) ) {
$name = $m[2] . ' ' . $name;
}
}
$utf8Name = $this->fixTruncation( $name );
$lines[] = [ $utf8Name, sprintf( '%.0f', $time ), sprintf( '%.1f', $percent ) ];
} else {
$otherTime += $time;
$otherPercent += $percent;
}
$cumulativePercent += $percent;
}
if ( $otherTime ) {
$lines[] = [ '[others]', sprintf( '%.0f', $otherTime ), sprintf( '%.1f', $otherPercent ) ];
}
$ret['scribunto-limitreport-profile'] = $lines;
return $ret;
}
/**
* Lua truncates symbols at 60 bytes, but this may create invalid UTF-8.
*
* MediaWiki has Language::normalize() but that's complex and seems like
* overkill. A no-op iconv() with errors ignored does the job.
*
* @param string $s
* @return string
*/
private function fixTruncation( $s ) {
$lang = MediaWikiServices::getInstance()->getLanguageFactory()->getLanguage( 'en' );
return $lang->iconv( 'UTF-8', 'UTF-8', $s );
}
/** @inheritDoc */
public function reportLimitData( ParserOutput $parserOutput ) {
$data = $this->getLimitReportData();
foreach ( $data as $k => $v ) {
$parserOutput->setLimitReportData( $k, $v );
}
if ( isset( $data['scribunto-limitreport-logs'] ) ) {
$parserOutput->addModules( [ 'ext.scribunto.logs' ] );
}
}
/**
* @inheritDoc
* @suppress SecurityCheck-DoubleEscaped phan false positive
*/
public function formatLimitData( $key, &$value, &$report, $isHTML, $localize ) {
switch ( $key ) {
case 'scribunto-limitreport-logs':
if ( $isHTML ) {
$report .= $this->formatHtmlLogs( $value, $localize );
}
return false;
}
if ( $key !== 'scribunto-limitreport-profile' ) {
return true;
}
'@phan-var string[] $value';
$keyMsg = wfMessage( 'scribunto-limitreport-profile' );
$msMsg = wfMessage( 'scribunto-limitreport-profile-ms' );
$percentMsg = wfMessage( 'scribunto-limitreport-profile-percent' );
if ( !$localize ) {
$keyMsg->inLanguage( 'en' )->useDatabase( false );
$msMsg->inLanguage( 'en' )->useDatabase( false );
$percentMsg->inLanguage( 'en' )->useDatabase( false );
}
// To avoid having to do actual work in Message::fetchMessage for each
// line in the loops below, call ->exists() here to populate ->message.
$msMsg->exists();
$percentMsg->exists();
if ( $isHTML ) {
$report .= Html::openElement( 'tr' ) .
Html::rawElement( 'th', [ 'colspan' => 2 ], $keyMsg->parse() ) .
Html::closeElement( 'tr' ) .
Html::openElement( 'tr' ) .
Html::openElement( 'td', [ 'colspan' => 2 ] ) .
Html::openElement( 'table' );
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
foreach ( $value as $line ) {
$name = $line[0];
$location = '';
if ( preg_match( '/^(.*?) *<([^<>]+):(\d+)>$/', $name, $m ) ) {
$name = $m[1];
$title = Title::newFromText( $m[2] );
if ( $title && $title->hasContentModel( CONTENT_MODEL_SCRIBUNTO ) ) {
$location = '&lt;' .
$linkRenderer->makeLink( $title ) . ":{$m[3]}&gt;";
} else {
$location = htmlspecialchars( "<{$m[2]}:{$m[3]}>" );
}
}
$ms = clone $msMsg;
$ms->params( $line[1] );
$pct = clone $percentMsg;
$pct->params( $line[2] );
$report .= Html::openElement( 'tr' ) .
Html::element( 'td', [], $name ) .
Html::rawElement( 'td', [], $location ) .
Html::rawElement( 'td', [ 'align' => 'right' ], $ms->parse() ) .
Html::rawElement( 'td', [ 'align' => 'right' ], $pct->parse() ) .
Html::closeElement( 'tr' );
}
$report .= Html::closeElement( 'table' ) .
Html::closeElement( 'td' ) .
Html::closeElement( 'tr' );
} else {
$report .= $keyMsg->text() . ":\n";
foreach ( $value as $line ) {
$ms = clone $msMsg;
$ms->params( $line[1] );
$pct = clone $percentMsg;
$pct->params( $line[2] );
$report .= sprintf( " %-59s %11s %11s\n", $line[0], $ms->text(), $pct->text() );
}
}
return false;
}
/**
* Fetch a line from mw.lua
* @param int $lineNum
* @return string
*/
protected function getMwLuaLine( $lineNum ) {
if ( !isset( $this->lineCache['mw.lua'] ) ) {
$this->lineCache['mw.lua'] = file( $this->getLuaLibDir() . '/mw.lua' );
}
return $this->lineCache['mw.lua'][$lineNum - 1];
}
protected function newInterpreter() {
return new LuaSandboxInterpreter( $this, $this->options );
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 17:39 (1 d, 23 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
e0/54/9594356c0664a0f2ec762a14d1c5
Default Alt Text
LuaSandboxEngine.php (7 KB)

Event Timeline