Command.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Shell;
 
use Exception;
use MediaWiki\ProcOpenError;
use MediaWiki\ShellDisabledError;
use Profiler;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Shellbox\Command\UnboxedCommand;
use Shellbox\Command\UnboxedExecutor;
use Shellbox\Command\UnboxedResult;
use Wikimedia\ScopedCallback;
 
class Command extends UnboxedCommand {
    private $everExecuted = false;
 
    private $method;
 
    protected $logger;
 
    public function __construct( UnboxedExecutor $executor ) {
        if ( Shell::isDisabled() ) {
            throw new ShellDisabledError();
        }
        parent::__construct( $executor );
        $this->setLogger( new NullLogger );
    }
 
    public function __destruct() {
        if ( !$this->everExecuted ) {
            $context = [ 'command' => $this->getCommandString() ];
            $message = __CLASS__ . " was instantiated, but execute() was never called.";
            if ( $this->method ) {
                $message .= ' Calling method: {method}.';
                $context['method'] = $this->method;
            }
            $message .= ' Command: {command}';
            $this->logger->warning( $message, $context );
        }
    }
 
    public function setLogger( LoggerInterface $logger ) {
        $this->logger = $logger;
        if ( $this->executor ) {
            $this->executor->setLogger( $logger );
        }
    }
 
    public function limits( array $limits ): Command {
        if ( !isset( $limits['walltime'] ) && isset( $limits['time'] ) ) {
            // Emulate the behavior of old wfShellExec() where walltime fell back on time
            // if the latter was overridden and the former wasn't
            $limits['walltime'] = $limits['time'];
        }
        if ( isset( $limits['filesize'] ) ) {
            $this->fileSizeLimit( $limits['filesize'] * 1024 );
        }
        if ( isset( $limits['memory'] ) ) {
            $this->memoryLimit( $limits['memory'] * 1024 );
        }
        if ( isset( $limits['time'] ) ) {
            $this->cpuTimeLimit( $limits['time'] );
        }
        if ( isset( $limits['walltime'] ) ) {
            $this->wallTimeLimit( $limits['walltime'] );
        }
 
        return $this;
    }
 
    public function profileMethod( string $method ): Command {
        $this->method = $method;
 
        return $this;
    }
 
    public function input( string $inputString ): Command {
        return $this->stdin( $inputString );
    }
 
    public function restrict( int $restrictions ): Command {
        $this->privateUserNamespace( (bool)( $restrictions & Shell::NO_ROOT ) );
        $this->firejailDefaultSeccomp( (bool)( $restrictions & Shell::SECCOMP ) );
        $this->noNewPrivs( (bool)( $restrictions & Shell::SECCOMP ) );
        $this->privateDev( (bool)( $restrictions & Shell::PRIVATE_DEV ) );
        $this->disableNetwork( (bool)( $restrictions & Shell::NO_NETWORK ) );
        if ( $restrictions & Shell::NO_EXECVE ) {
            $this->disabledSyscalls( [ 'execve' ] );
        } else {
            $this->disabledSyscalls( [] );
        }
        if ( $restrictions & Shell::NO_LOCALSETTINGS ) {
            $this->disallowedPaths( [ realpath( MW_CONFIG_FILE ) ] );
        } else {
            $this->disallowedPaths( [] );
        }
        if ( $restrictions === 0 ) {
            $this->disableSandbox();
        }
 
        return $this;
    }
 
    public function whitelistPaths( array $paths ): Command {
        wfDeprecated( __METHOD__, '1.36' );
        $this->allowedPaths( array_merge( $this->getAllowedPaths(), $paths ) );
        return $this;
    }
 
    public function execute(): UnboxedResult {
        $this->everExecuted = true;
        $profileMethod = $this->method ?: wfGetCaller();
        $scoped = Profiler::instance()->scopedProfileIn( __FUNCTION__ . '-' . $profileMethod );
        $result = parent::execute();
        ScopedCallback::consume( $scoped );
        return $result;
    }
 
    public function __toString(): string {
        return '#Command: ' . $this->getCommandString();
    }
}