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 * Disallow any root access. Any setuid binaries
48 * will be run without elevated access.
55 * Use seccomp to block dangerous syscalls
56 * @see <https://en.wikipedia.org/wiki/seccomp>
63 * Create a private /dev
67 const PRIVATE_DEV
= 4;
70 * Restrict the request to have no
78 * Deny execve syscall with seccomp
79 * @see <https://en.wikipedia.org/wiki/exec_(system_call)>
86 * Deny access to LocalSettings.php (MW_CONFIG_FILE)
90 const NO_LOCALSETTINGS
= 32;
93 * Apply a default set of restrictions for improved
94 * security out of the box.
96 * @note This value will change over time to provide increased security
97 * by default, and is not guaranteed to be backwards-compatible.
100 const RESTRICT_DEFAULT
= self
::NO_ROOT | self
::SECCOMP | self
::PRIVATE_DEV |
101 self
::NO_LOCALSETTINGS
;
104 * Don't apply any restrictions
108 const RESTRICT_NONE
= 0;
111 * Returns a new instance of Command class
113 * @param string|string[] $command String or array of strings representing the command to
114 * be executed, each value will be escaped.
115 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
118 public static function command( $command ) {
119 $args = func_get_args();
120 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
121 // If only one argument has been passed, and that argument is an array,
122 // treat it as a list of arguments
123 $args = reset( $args );
125 $command = MediaWikiServices
::getInstance()
126 ->getShellCommandFactory()
129 return $command->params( $args );
133 * Check if this class is effectively disabled via php.ini config
137 public static function isDisabled() {
138 static $disabled = null;
140 if ( is_null( $disabled ) ) {
141 if ( !function_exists( 'proc_open' ) ) {
142 wfDebug( "proc_open() is disabled\n" );
153 * Version of escapeshellarg() that works better on Windows.
155 * Originally, this fixed the incorrect use of single quotes on Windows
156 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
157 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
159 * @param string $args,... strings to escape and glue together, or a single array of
160 * strings parameter. Null values are ignored.
163 public static function escape( /* ... */ ) {
164 $args = func_get_args();
165 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
166 // If only one argument has been passed, and that argument is an array,
167 // treat it as a list of arguments
168 $args = reset( $args );
173 foreach ( $args as $arg ) {
174 if ( $arg === null ) {
183 if ( wfIsWindows() ) {
184 // Escaping for an MSVC-style command line parser and CMD.EXE
186 // * https://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
187 // * https://technet.microsoft.com/en-us/library/cc723564.aspx
190 // Double the backslashes before any double quotes. Escape the double quotes.
191 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
194 foreach ( $tokens as $token ) {
195 if ( $iteration %
2 == 1 ) {
196 // Delimiter, a double quote preceded by zero or more slashes
197 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
198 } elseif ( $iteration %
4 == 2 ) {
199 // ^ in $token will be outside quotes, need to be escaped
200 $arg .= str_replace( '^', '^^', $token );
201 } else { // $iteration % 4 == 0
202 // ^ in $token will appear inside double quotes, so leave as is
207 // Double the backslashes before the end of the string, because
208 // we will soon add a quote
210 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
211 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
214 // Add surrounding quotes
215 $retVal .= '"' . $arg . '"';
217 $retVal .= escapeshellarg( $arg );
224 * Generate a Command object to run a MediaWiki CLI script.
225 * Note that $parameters should be a flat array and an option with an argument
226 * should consist of two consecutive items in the array (do not use "--option value").
228 * @param string $script MediaWiki CLI script with full path
229 * @param string[] $parameters Arguments and options to the script
230 * @param array $options Associative array of options:
231 * 'php': The path to the php executable
232 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
235 public static function makeScriptCommand( $script, $parameters, $options = [] ) {
237 // Give site config file a chance to run the script in a wrapper.
238 // The caller may likely want to call wfBasename() on $script.
239 Hooks
::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
240 $cmd = isset( $options['php'] ) ?
[ $options['php'] ] : [ $wgPhpCli ];
241 if ( isset( $options['wrapper'] ) ) {
242 $cmd[] = $options['wrapper'];
246 return self
::command( $cmd )
247 ->params( $parameters )
248 ->restrict( self
::RESTRICT_DEFAULT
& ~self
::NO_LOCALSETTINGS
);