3 * Class used for executing shell commands
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 namespace MediaWiki\Shell
;
26 use MediaWiki\MediaWikiServices
;
29 * Executes shell commands
33 * Use call chaining with this class for expressiveness:
34 * $result = Shell::command( 'some command' )
36 * ->environment( [ 'ENVIRONMENT_VARIABLE' => 'VALUE' ] )
37 * ->limits( [ 'time' => 300 ] )
40 * ... = $result->getExitCode();
41 * ... = $result->getStdout();
42 * ... = $result->getStderr();
47 * Apply a default set of restrictions for improved
48 * security out of the box.
50 * Equal to NO_ROOT | SECCOMP | PRIVATE_DEV | NO_LOCALSETTINGS
52 * @note This value will change over time to provide increased security
53 * by default, and is not guaranteed to be backwards-compatible.
56 const RESTRICT_DEFAULT
= 39;
59 * Disallow any root access. Any setuid binaries
60 * will be run without elevated access.
67 * Use seccomp to block dangerous syscalls
68 * @see <https://en.wikipedia.org/wiki/seccomp>
75 * Create a private /dev
79 const PRIVATE_DEV
= 4;
82 * Restrict the request to have no
90 * Deny execve syscall with seccomp
91 * @see <https://en.wikipedia.org/wiki/exec_(system_call)>
98 * Deny access to LocalSettings.php (MW_CONFIG_FILE)
102 const NO_LOCALSETTINGS
= 32;
105 * Don't apply any restrictions
109 const RESTRICT_NONE
= 0;
112 * Returns a new instance of Command class
114 * @param string|string[] $command String or array of strings representing the command to
115 * be executed, each value will be escaped.
116 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
119 public static function command( $command ) {
120 $args = func_get_args();
121 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
122 // If only one argument has been passed, and that argument is an array,
123 // treat it as a list of arguments
124 $args = reset( $args );
126 $command = MediaWikiServices
::getInstance()
127 ->getShellCommandFactory()
130 return $command->params( $args );
134 * Check if this class is effectively disabled via php.ini config
138 public static function isDisabled() {
139 static $disabled = null;
141 if ( is_null( $disabled ) ) {
142 if ( !function_exists( 'proc_open' ) ) {
143 wfDebug( "proc_open() is disabled\n" );
154 * Version of escapeshellarg() that works better on Windows.
156 * Originally, this fixed the incorrect use of single quotes on Windows
157 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
158 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
160 * @param string $args,... strings to escape and glue together, or a single array of
161 * strings parameter. Null values are ignored.
164 public static function escape( /* ... */ ) {
165 $args = func_get_args();
166 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
167 // If only one argument has been passed, and that argument is an array,
168 // treat it as a list of arguments
169 $args = reset( $args );
174 foreach ( $args as $arg ) {
175 if ( $arg === null ) {
184 if ( wfIsWindows() ) {
185 // Escaping for an MSVC-style command line parser and CMD.EXE
187 // * https://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
188 // * https://technet.microsoft.com/en-us/library/cc723564.aspx
191 // Double the backslashes before any double quotes. Escape the double quotes.
192 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
195 foreach ( $tokens as $token ) {
196 if ( $iteration %
2 == 1 ) {
197 // Delimiter, a double quote preceded by zero or more slashes
198 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
199 } elseif ( $iteration %
4 == 2 ) {
200 // ^ in $token will be outside quotes, need to be escaped
201 $arg .= str_replace( '^', '^^', $token );
202 } else { // $iteration % 4 == 0
203 // ^ in $token will appear inside double quotes, so leave as is
208 // Double the backslashes before the end of the string, because
209 // we will soon add a quote
211 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
212 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
215 // Add surrounding quotes
216 $retVal .= '"' . $arg . '"';
218 $retVal .= escapeshellarg( $arg );
225 * Generate a Command object to run a MediaWiki CLI script.
226 * Note that $parameters should be a flat array and an option with an argument
227 * should consist of two consecutive items in the array (do not use "--option value").
229 * @param string $script MediaWiki CLI script with full path
230 * @param string[] $parameters Arguments and options to the script
231 * @param array $options Associative array of options:
232 * 'php': The path to the php executable
233 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
236 public static function makeScriptCommand( $script, $parameters, $options = [] ) {
238 // Give site config file a chance to run the script in a wrapper.
239 // The caller may likely want to call wfBasename() on $script.
240 Hooks
::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
241 $cmd = isset( $options['php'] ) ?
[ $options['php'] ] : [ $wgPhpCli ];
242 if ( isset( $options['wrapper'] ) ) {
243 $cmd[] = $options['wrapper'];
247 return self
::command( $cmd )
248 ->params( $parameters )
249 ->restrict( self
::RESTRICT_DEFAULT
& ~self
::NO_LOCALSETTINGS
);