Legoktm has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/385322 )
Change subject: Refactor some Installer code into ExecutableFinder
......................................................................
Refactor some Installer code into ExecutableFinder
Refactor Installer::locateExecutableInDefaultPaths() into a separate
utility class, ExecutableFinder. This class is already used in plenty of
places outside of the installer, so it's ripe for being extracted.
Modifications in ExecutableFinder:
* Instance caching for lookups
* Use Shell::command() instead of wfShellExec() and include stderr
** This dependency is what is keeping this class in utils/
* Add /bin to hardcoded path list and remove duplicates in $PATH
Change-Id: I175465acc0d64f990445ce05fabcee8b88a0b259
---
M RELEASE-NOTES-1.31
M autoload.php
M includes/installer/Installer.php
A includes/utils/ExecutableFinder.php
M maintenance/Maintenance.php
M tests/parser/TidySupport.php
M tests/phpunit/maintenance/DumpTestCase.php
7 files changed, 149 insertions(+), 31 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/22/385322/1
diff --git a/RELEASE-NOTES-1.31 b/RELEASE-NOTES-1.31
index 5d2d9d9..02a1d05 100644
--- a/RELEASE-NOTES-1.31
+++ b/RELEASE-NOTES-1.31
@@ -49,6 +49,8 @@
* The OutputPage class constructor now requires a context parameter,
(instantiating without context was deprecated in 1.18)
* mw.page (deprecated in 1.30) was removed.
+* Installer::locateExecutable() and Installer::locateExecutableInDefaultPaths()
+ are deprecated, use ExecutableFinder::findInDefaultPaths() instead.
== Compatibility ==
MediaWiki 1.31 requires PHP 5.5.9 or later. There is experimental support for
diff --git a/autoload.php b/autoload.php
index cf4a115..3bee411 100644
--- a/autoload.php
+++ b/autoload.php
@@ -441,6 +441,7 @@
'EventRelayerGroup' => __DIR__ . '/includes/EventRelayerGroup.php',
'EventRelayerKafka' => __DIR__ .
'/includes/libs/eventrelayer/EventRelayerKafka.php',
'EventRelayerNull' => __DIR__ .
'/includes/libs/eventrelayer/EventRelayerNull.php',
+ 'ExecutableFinder' => __DIR__ . '/includes/utils/ExecutableFinder.php',
'Exif' => __DIR__ . '/includes/media/Exif.php',
'ExifBitmapHandler' => __DIR__ . '/includes/media/ExifBitmap.php',
'ExplodeIterator' => __DIR__ . '/includes/libs/ExplodeIterator.php',
diff --git a/includes/installer/Installer.php b/includes/installer/Installer.php
index 52be321..1dae306 100644
--- a/includes/installer/Installer.php
+++ b/includes/installer/Installer.php
@@ -882,10 +882,13 @@
* @return bool
*/
protected function envCheckDiff3() {
- $names = [ "gdiff3", "diff3", "diff3.exe" ];
- $versionInfo = [ '$1 --version 2>&1', 'GNU diffutils' ];
+ $names = [ "gdiff3", "diff3" ];
+ if ( wfIsWindows() ) {
+ $names[] = 'diff3.exe';
+ }
+ $versionInfo = [ '$1 --version', 'GNU diffutils' ];
- $diff3 = self::locateExecutableInDefaultPaths( $names,
$versionInfo );
+ $diff3 = ExecutableFinder::findInDefaultPaths( $names,
$versionInfo );
if ( $diff3 ) {
$this->setVar( 'wgDiff3', $diff3 );
@@ -904,7 +907,7 @@
protected function envCheckGraphics() {
$names = [ wfIsWindows() ? 'convert.exe' : 'convert' ];
$versionInfo = [ '$1 -version', 'ImageMagick' ];
- $convert = self::locateExecutableInDefaultPaths( $names,
$versionInfo );
+ $convert = ExecutableFinder::findInDefaultPaths( $names,
$versionInfo );
$this->setVar( 'wgImageMagickConvertCommand', '' );
if ( $convert ) {
@@ -931,7 +934,7 @@
$names = [ wfIsWindows() ? 'git.exe' : 'git' ];
$versionInfo = [ '$1 --version', 'git version' ];
- $git = self::locateExecutableInDefaultPaths( $names,
$versionInfo );
+ $git = ExecutableFinder::findInDefaultPaths( $names,
$versionInfo );
if ( $git ) {
$this->setVar( 'wgGitBin', $git );
@@ -1181,21 +1184,6 @@
}
/**
- * Get an array of likely places we can find executables. Check a bunch
- * of known Unix-like defaults, as well as the PATH environment variable
- * (which should maybe make it work for Windows?)
- *
- * @return array
- */
- protected static function getPossibleBinPaths() {
- return array_merge(
- [ '/usr/bin', '/usr/local/bin', '/opt/csw/bin',
- '/usr/gnu/bin', '/usr/sfw/bin', '/sw/bin',
'/opt/local/bin' ],
- explode( PATH_SEPARATOR, getenv( 'PATH' ) )
- );
- }
-
- /**
* Search a path for any of the given executable names. Returns the
* executable name if found. Also checks the version string returned
* by each executable.
@@ -1211,8 +1199,10 @@
* If $versionInfo is not false, only executables with a version
* matching $versionInfo[1] will be returned.
* @return bool|string
+ * @deprecated since 1.31 use ExecutableFinder::findInDefaultPaths()
*/
public static function locateExecutable( $path, $names, $versionInfo =
false ) {
+ wfDeprecated( __METHOD__, '1.31' );
if ( !is_array( $names ) ) {
$names = [ $names ];
}
@@ -1250,16 +1240,11 @@
* If $versionInfo is not false, only executables with a version
* matching $versionInfo[1] will be returned.
* @return bool|string
+ * @deprecated since 1.31 use ExecutableFinder::findInDefaultPaths()
*/
public static function locateExecutableInDefaultPaths( $names,
$versionInfo = false ) {
- foreach ( self::getPossibleBinPaths() as $path ) {
- $exe = self::locateExecutable( $path, $names,
$versionInfo );
- if ( $exe !== false ) {
- return $exe;
- }
- }
-
- return false;
+ wfDeprecated( __METHOD__, '1.31' );
+ return ExecutableFinder::findInDefaultPaths( $names,
$versionInfo );
}
/**
diff --git a/includes/utils/ExecutableFinder.php
b/includes/utils/ExecutableFinder.php
new file mode 100644
index 0000000..9b3fd18
--- /dev/null
+++ b/includes/utils/ExecutableFinder.php
@@ -0,0 +1,130 @@
+<?php
+/**
+ * Copyright (C) 2017 Kunal Mehta <[email protected]>
+ *
+ * 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.
+ *
+ */
+
+use MediaWiki\Shell\Shell;
+
+/**
+ * Utility class to find executables in likely places
+ *
+ * @since 1.31
+ */
+class ExecutableFinder {
+
+ /**
+ * @var array [ search => string|bool ]
+ */
+ static $cache = [];
+
+ /**
+ * Get an array of likely places we can find executables. Check a bunch
+ * of known Unix-like defaults, as well as the PATH environment variable
+ * (which should maybe make it work for Windows?)
+ *
+ * @return array
+ */
+ protected static function getPossibleBinPaths() {
+ return array_unique( array_merge(
+ [ '/usr/bin', '/bin', '/usr/local/bin', '/opt/csw/bin',
+ '/usr/gnu/bin', '/usr/sfw/bin', '/sw/bin',
'/opt/local/bin' ],
+ explode( PATH_SEPARATOR, getenv( 'PATH' ) )
+ ) );
+ }
+
+ /**
+ * Search a path for any of the given executable names. Returns the
+ * executable name if found. Also checks the version string returned
+ * by each executable.
+ *
+ * Used only by environment checks.
+ *
+ * @param string $path Path to search
+ * @param string $name Executable name to look for
+ * @param array|bool $versionInfo False or array with two members:
+ * 0 => Command to run for version check, with $1 for the full
executable name
+ * 1 => String to compare the output with
+ *
+ * If $versionInfo is not false, only executables with a version
+ * matching $versionInfo[1] will be returned.
+ * @return bool|string
+ */
+ protected static function findExecutable( $path, $name, $versionInfo =
false ) {
+ $command = $path . DIRECTORY_SEPARATOR . $name;
+
+ MediaWiki\suppressWarnings();
+ $file_exists = is_executable( $command );
+ MediaWiki\restoreWarnings();
+
+ if ( $file_exists ) {
+ if ( !$versionInfo ) {
+ return $command;
+ }
+
+ $file = str_replace( '$1', $command, $versionInfo[0] );
+ $output = Shell::command( $file
)->includeStderr()->execute()->getStdout();
+ if ( strstr( $output, $versionInfo[1] ) !== false ) {
+ return $command;
+ }
+ }
+
+ return false;
+ }
+
+
+ /**
+ * Same as locateExecutable(), but checks in getPossibleBinPaths() by
default
+ * @see locateExecutable()
+ * @param string|string[] $names Array of possible names.
+ * @param array|bool $versionInfo Default: false or array with two
members:
+ * 0 => Command to run for version check, with $1 for the full
executable name
+ * 1 => String to compare the output with
+ *
+ * If $versionInfo is not false, only executables with a version
+ * matching $versionInfo[1] will be returned.
+ * @return bool|string
+ */
+ public static function findInDefaultPaths( $names, $versionInfo = false
) {
+ $paths = self::getPossibleBinPaths();
+ foreach( (array)$names as $name ) {
+ if ( $versionInfo === false && isset(
self::$cache[$name] ) ) {
+ $cached = self::$cache[$name];
+ if ( $cached !== false ) {
+ return $cached;
+ } else {
+ continue;
+ }
+ }
+ foreach ( $paths as $path ) {
+ $exe = self::findExecutable( $path, $name,
$versionInfo );
+ if ( $exe !== false ) {
+ if ( $versionInfo === false ) {
+ self::$cache[$name] = $exe;
+ }
+ return $exe;
+ }
+ }
+ if ( $versionInfo === false ) {
+ self::$cache[$name] = false;
+ }
+ }
+
+ return false;
+ }
+
+}
diff --git a/maintenance/Maintenance.php b/maintenance/Maintenance.php
index 7de0ae4..174b973 100644
--- a/maintenance/Maintenance.php
+++ b/maintenance/Maintenance.php
@@ -1496,7 +1496,7 @@
* @return string
*/
private static function readlineEmulation( $prompt ) {
- $bash = Installer::locateExecutableInDefaultPaths( [ 'bash' ] );
+ $bash = ExecutableFinder::findInDefaultPaths( 'bash' );
if ( !wfIsWindows() && $bash ) {
$retval = false;
$encPrompt = wfEscapeShellArg( $prompt );
diff --git a/tests/parser/TidySupport.php b/tests/parser/TidySupport.php
index 6aed02f..c0a9312 100644
--- a/tests/parser/TidySupport.php
+++ b/tests/parser/TidySupport.php
@@ -66,7 +66,7 @@
$this->config['driver'] =
'RaggettExternal';
$this->config['tidyBin'] = $wgTidyBin;
} else {
- $path =
Installer::locateExecutableInDefaultPaths( $wgTidyBin );
+ $path =
ExecutableFinder::findInDefaultPaths( $wgTidyBin );
if ( $path !== false ) {
$this->config['driver'] =
'RaggettExternal';
$this->config['tidyBin'] =
$wgTidyBin;
diff --git a/tests/phpunit/maintenance/DumpTestCase.php
b/tests/phpunit/maintenance/DumpTestCase.php
index 99bd427..58cb6f3 100644
--- a/tests/phpunit/maintenance/DumpTestCase.php
+++ b/tests/phpunit/maintenance/DumpTestCase.php
@@ -35,7 +35,7 @@
*/
protected function checkHasGzip() {
if ( self::$hasGzip === null ) {
- self::$hasGzip = (
Installer::locateExecutableInDefaultPaths( 'gzip' ) !== false );
+ self::$hasGzip = (
ExecutableFinder::findInDefaultPaths( 'gzip' ) !== false );
}
if ( !self::$hasGzip ) {
--
To view, visit https://gerrit.wikimedia.org/r/385322
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I175465acc0d64f990445ce05fabcee8b88a0b259
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Legoktm <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
