X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/includes/shell/Shell.php

diff --git a/includes/shell/Shell.php b/includes/shell/Shell.php
new file mode 100644
index 00000000..cef9ffa3
--- /dev/null
+++ b/includes/shell/Shell.php
@@ -0,0 +1,157 @@
+<?php
+/**
+ * Class used for executing shell commands
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+namespace MediaWiki\Shell;
+
+use MediaWiki\MediaWikiServices;
+
+/**
+ * Executes shell commands
+ *
+ * @since 1.30
+ *
+ * Use call chaining with this class for expressiveness:
+ *  $result = Shell::command( 'some command' )
+ *       ->environment( [ 'ENVIRONMENT_VARIABLE' => 'VALUE' ] )
+ *       ->limits( [ 'time' => 300 ] )
+ *       ->execute();
+ *
+ *  ... = $result->getExitCode();
+ *  ... = $result->getStdout();
+ */
+class Shell {
+
+	/**
+	 * Returns a new instance of Command class
+	 *
+	 * @param string|string[] $command String or array of strings representing the command to
+	 * be executed, each value will be escaped.
+	 *   Example:   [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
+	 * @return Command
+	 */
+	public static function command( $command ) {
+		$args = func_get_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 );
+		}
+		$command = MediaWikiServices::getInstance()
+			->getShellCommandFactory()
+			->create();
+
+		return $command->params( $args );
+	}
+
+	/**
+	 * Check if this class is effectively disabled via php.ini config
+	 *
+	 * @return bool
+	 */
+	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;
+	}
+
+	/**
+	 * Version of escapeshellarg() that works better on Windows.
+	 *
+	 * Originally, this fixed the incorrect use of single quotes on Windows
+	 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
+	 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
+	 *
+	 * @param string $args,... strings to escape and glue together, or a single array of
+	 *     strings parameter. Null values are ignored.
+	 * @return string
+	 */
+	public static function escape( /* ... */ ) {
+		$args = func_get_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
+				// @codingStandardsIgnoreStart For long URLs
+				// 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.
+				// @codingStandardsIgnoreEnd
+				$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;
+	}
+}