ExecutableFinder.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Utils;
 
use MediaWiki\Shell\Shell;
 
class ExecutableFinder {
 
    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' ) )
        ) );
    }
 
    protected static function findExecutable( $path, $name, $versionInfo = false ) {
        $command = $path . DIRECTORY_SEPARATOR . $name;
 
        // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
        $file_exists = @is_executable( $command );
 
        if ( $file_exists ) {
            if ( !$versionInfo ) {
                return $command;
            }
 
            $output = Shell::command( $command, $versionInfo[0] )
                ->includeStderr()->execute()->getStdout();
            if ( str_contains( $output, $versionInfo[1] ) ) {
                return $command;
            }
        }
 
        return false;
    }
 
    public static function findInDefaultPaths( $names, $versionInfo = false ) {
        if ( Shell::isDisabled() ) {
            // If we can't shell out, there's no point looking for executables
            return false;
        }
 
        $paths = self::getPossibleBinPaths();
        foreach ( (array)$names as $name ) {
            foreach ( $paths as $path ) {
                $exe = self::findExecutable( $path, $name, $versionInfo );
                if ( $exe !== false ) {
                    return $exe;
                }
            }
        }
 
        return false;
    }
 
}
 
class_alias( ExecutableFinder::class, 'ExecutableFinder' );