Shell.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Shell;
 
use Hooks;
use MediaWiki\MediaWikiServices;
 
class Shell {
 
    const NO_ROOT = 1;
 
    const SECCOMP = 2;
 
    const PRIVATE_DEV = 4;
 
    const NO_NETWORK = 8;
 
    const NO_EXECVE = 16;
 
    const NO_LOCALSETTINGS = 32;
 
    const RESTRICT_DEFAULT = self::NO_ROOT | self::SECCOMP | self::PRIVATE_DEV |
                             self::NO_LOCALSETTINGS;
 
    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() {
        static $disabled = null;
 
        if ( is_null( $disabled ) ) {
            if ( !function_exists( 'proc_open' ) ) {
                wfDebug( "proc_open() is disabled\n" );
                $disabled = true;
            } else {
                $disabled = false;
            }
        }
 
        return $disabled;
    }
 
    public static function escape( ...$args ) {
        if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
            // If only one argument has been passed, and that argument is an array,
            // treat it as a list of arguments
            $args = reset( $args );
        }
 
        $first = true;
        $retVal = '';
        foreach ( $args as $arg ) {
            if ( $arg === null ) {
                continue;
            }
            if ( !$first ) {
                $retVal .= ' ';
            } else {
                $first = false;
            }
 
            if ( wfIsWindows() ) {
                // Escaping for an MSVC-style command line parser and CMD.EXE
                // Refs:
                //  * https://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
                //  * https://technet.microsoft.com/en-us/library/cc723564.aspx
                //  * T15518
                //  * CR r63214
                // Double the backslashes before any double quotes. Escape the double quotes.
                $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE );
                $arg = '';
                $iteration = 0;
                foreach ( $tokens as $token ) {
                    if ( $iteration % 2 == 1 ) {
                        // Delimiter, a double quote preceded by zero or more slashes
                        $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
                    } elseif ( $iteration % 4 == 2 ) {
                        // ^ in $token will be outside quotes, need to be escaped
                        $arg .= str_replace( '^', '^^', $token );
                    } else { // $iteration % 4 == 0
                        // ^ in $token will appear inside double quotes, so leave as is
                        $arg .= $token;
                    }
                    $iteration++;
                }
                // Double the backslashes before the end of the string, because
                // we will soon add a quote
                $m = [];
                if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
                    $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
                }
 
                // Add surrounding quotes
                $retVal .= '"' . $arg . '"';
            } else {
                $retVal .= escapeshellarg( $arg );
            }
        }
        return $retVal;
    }
 
    public static function makeScriptCommand( $script, $parameters, $options = [] ): Command {
        global $wgPhpCli;
        // Give site config file a chance to run the script in a wrapper.
        // The caller may likely want to call wfBasename() on $script.
        Hooks::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
        $cmd = [ $options['php'] ?? $wgPhpCli ];
        if ( isset( $options['wrapper'] ) ) {
            $cmd[] = $options['wrapper'];
        }
        $cmd[] = $script;
 
        return self::command( $cmd )
            ->params( $parameters )
            ->restrict( self::RESTRICT_DEFAULT & ~self::NO_LOCALSETTINGS );
    }
}