Shell.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Shell;
 
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use Shellbox\Shellbox;
 
class Shell {
 
    public const NO_ROOT = 1;
 
    public const SECCOMP = 2;
 
    public const PRIVATE_DEV = 4;
 
    public const NO_NETWORK = 8;
 
    public const NO_EXECVE = 16;
 
    public const NO_LOCALSETTINGS = 32;
 
    public const RESTRICT_DEFAULT = self::NO_ROOT | self::SECCOMP | self::PRIVATE_DEV |
                                    self::NO_LOCALSETTINGS;
 
    public const RESTRICT_NONE = 0;
 
    public static function command( ...$commands ): Command {
        if ( count( $commands ) === 1 && is_array( reset( $commands ) ) ) {
            // If only one argument has been passed, and that argument is an array,
            // treat it as a list of arguments
            $commands = reset( $commands );
        }
        $command = MediaWikiServices::getInstance()
            ->getShellCommandFactory()
            ->create();
 
        return $command->params( $commands );
    }
 
    public static function isDisabled(): bool {
        static $disabled = null;
 
        if ( $disabled === null ) {
            if ( !function_exists( 'proc_open' ) ) {
                wfDebug( "proc_open() is disabled" );
                $disabled = true;
            } else {
                $disabled = false;
            }
        }
 
        return $disabled;
    }
 
    public static function escape( ...$args ): string {
        return Shellbox::escape( ...$args );
    }
 
    public static function makeScriptCommand(
        string $script, array $parameters, array $options = []
    ): Command {
        $services = MediaWikiServices::getInstance();
        $phpCli = $services->getMainConfig()->get( MainConfigNames::PhpCli );
        // Give site config file a chance to run the script in a wrapper.
        // The caller may likely want to call wfBasename() on $script.
        ( new HookRunner( $services->getHookContainer() ) )->onWfShellWikiCmd( $script, $parameters, $options );
        $cmd = [];
        $cmd[] = $options['php'] ?? $phpCli;
        $cmd[] = $options['wrapper'] ?? ( MW_INSTALL_PATH . '/maintenance/run.php' );
        $cmd[] = $script;
 
        return self::command( $cmd )
            ->params( $parameters )
            // Not much point in trying to sandbox maintenance scripts when they run unsandboxed
            // most of the time, and doing so can cause permission problems.
            ->disableSandbox();
    }
 
}