OperatingSystem::locateProgram() - Code Metrics - Inspection of "Add option to force Composer to use same PHP binar..." - netz98/n98-magerun2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#362)

by Stephan

created 2018-03-05 08:18 UTC

OperatingSystem::locateProgram() A

↳ Parent: OperatingSystem

Complexity

Conditions	4
Paths	5

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.2
c	0
b	0
f	0
cc	4
eloc	7
nc	5
nop	1

<?php
/*
 * this file is part of magerun
 *
 * @author Tom Klingenberg <https://github.com/ktomk>
 */

namespace N98\Util;

/**
 * Class OperatingSystem
 *
 * @package N98\Util
 */
class OperatingSystem
{
    /**
     * @var int
     */
    const UID_ROOT = 0;

    /**
     * Returns true if operating system is
     * based on GNU linux.
     *
     * @return boolean
     */
    public static function isLinux()
    {
        return (bool) stristr(PHP_OS, 'linux');
    }

    /**
     * Returns true if operating system is
     * based on Microsoft Windows.
     *
     * @return boolean
     */
    public static function isWindows()
    {
        return strtolower(substr(PHP_OS, 0, 3)) === 'win';
    }

    /**
     * Returns true if operating system is
     * based on novell netware.
     *
     * @return boolean
     */
    public static function isNetware()
    {
        return (bool) stristr(PHP_OS, 'netware');
    }

    /**
     * Returns true if operating system is
     * based on apple MacOS.
     *
     * @return boolean
     */
    public static function isMacOs()
    {
        return stristr(PHP_OS, 'darwin') || stristr(PHP_OS, 'mac');
    }

    /**
     * @param string $program
     * @return bool
     */
    public static function isProgramInstalled($program)
    {
        if (self::isWindows()) {
            return WindowsSystem::isProgramInstalled($program);
        }

        return '' !== self::locateProgram($program);
    }

    /**
     * Returns the absolute path to the program that should be located or an empty string if the programm
     * could not be found.
     *
     * @param string $program
     * @return string
     */
    public static function locateProgram($program)
    {
        if (self::isWindows()) {
            return WindowsSystem::locateProgram($program);
        }

        $out = null;
        $return = null;
        @exec('which ' . $program, $out, $return);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        return ($return === 0 && isset($out[0])) ? $out[0] : '';
    }

    /**
     * Home directory of the current user
     *
     * @return string|false false in case there is no environment variable related to the home directory
     */
    public static function getHomeDir()
    {
        if (self::isWindows()) {
            return getenv('USERPROFILE');
        }

        return getenv('HOME');
    }

    /**
     * Test for Root UID on a POSIX system if posix_getuid() is available.
     *
     * Returns false negatives if posix_getuid() is not available.
     *
     * @return bool
     */
    public static function isRoot()
    {
        return function_exists('posix_getuid') && posix_getuid() === self::UID_ROOT;
    }

    /**
     * get current working directory
     *
     * @return string the current working directory on success, or false on failure.
     */
    public static function getCwd()
    {
        return getcwd();
    }

    /**
     * Retrieve path to php binary
     *
     * @return string
     */
    public static function getPhpBinary()
    {
        // PHP_BINARY (>= php 5.4)
        if (defined('PHP_BINARY')) {
            return PHP_BINARY;
        }

        if (self::isWindows()) {
            return 'php';
        }

        return '/usr/bin/env php';
    }

    /**
     * Retrieve path to current php binary.
     *
     * @return string
     */
    public static function getCurrentPhpBinary()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (isset($_SERVER['_'])) {
            return $_SERVER['_'];
        }

        return self::getPhpBinary();
    }
}


1			<?php
2			/*
3			* this file is part of magerun
4			*
5			* @author Tom Klingenberg <https://github.com/ktomk>
6			*/
7
8			namespace N98\Util;
9
10			/**
11			* Class OperatingSystem
12			*
13			* @package N98\Util
14			*/
15			class OperatingSystem
16			{
17			/**
18			* @var int
19			*/
20			const UID_ROOT = 0;
21
22			/**
23			* Returns true if operating system is
24			* based on GNU linux.
25			*
26			* @return boolean
27			*/
28			public static function isLinux()
29			{
30			return (bool) stristr(PHP_OS, 'linux');
31			}
32
33			/**
34			* Returns true if operating system is
35			* based on Microsoft Windows.
36			*
37			* @return boolean
38			*/
39			public static function isWindows()
40			{
41			return strtolower(substr(PHP_OS, 0, 3)) === 'win';
42			}
43
44			/**
45			* Returns true if operating system is
46			* based on novell netware.
47			*
48			* @return boolean
49			*/
50			public static function isNetware()
51			{
52			return (bool) stristr(PHP_OS, 'netware');
53			}
54
55			/**
56			* Returns true if operating system is
57			* based on apple MacOS.
58			*
59			* @return boolean
60			*/
61			public static function isMacOs()
62			{
63			return stristr(PHP_OS, 'darwin') \|\| stristr(PHP_OS, 'mac');
64			}
65
66			/**
67			* @param string $program
68			* @return bool
69			*/
70			public static function isProgramInstalled($program)
71			{
72			if (self::isWindows()) {
73			return WindowsSystem::isProgramInstalled($program);
74			}
75
76			return '' !== self::locateProgram($program);
77			}
78
79			/**
80			* Returns the absolute path to the program that should be located or an empty string if the programm
81			* could not be found.
82			*
83			* @param string $program
84			* @return string
85			*/
86			public static function locateProgram($program)
87			{
88			if (self::isWindows()) {
89			return WindowsSystem::locateProgram($program);
90			}
91
92			$out = null;
93			$return = null;
94			@exec('which ' . $program, $out, $return);
			0 ignored issues – show Security Best Practice introduced 2015-11-23 11:00 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
95			return ($return === 0 && isset($out[0])) ? $out[0] : '';
96			}
97
98			/**
99			* Home directory of the current user
100			*
101			* @return string\|false false in case there is no environment variable related to the home directory
102			*/
103			public static function getHomeDir()
104			{
105			if (self::isWindows()) {
106			return getenv('USERPROFILE');
107			}
108
109			return getenv('HOME');
110			}
111
112			/**
113			* Test for Root UID on a POSIX system if posix_getuid() is available.
114			*
115			* Returns false negatives if posix_getuid() is not available.
116			*
117			* @return bool
118			*/
119			public static function isRoot()
120			{
121			return function_exists('posix_getuid') && posix_getuid() === self::UID_ROOT;
122			}
123
124			/**
125			* get current working directory
126			*
127			* @return string the current working directory on success, or false on failure.
128			*/
129			public static function getCwd()
130			{
131			return getcwd();
132			}
133
134			/**
135			* Retrieve path to php binary
136			*
137			* @return string
138			*/
139			public static function getPhpBinary()
140			{
141			// PHP_BINARY (>= php 5.4)
142			if (defined('PHP_BINARY')) {
143			return PHP_BINARY;
144			}
145
146			if (self::isWindows()) {
147			return 'php';
148			}
149
150			return '/usr/bin/env php';
151			}
152
153			/**
154			* Retrieve path to current php binary.
155			*
156			* @return string
157			*/
158			public static function getCurrentPhpBinary()
			0 ignored issues – show Coding Style introduced 2018-03-04 12:03 UTC by Report Bug Copy Issue Report `getCurrentPhpBinary` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
159			{
160			if (isset($_SERVER['_'])) {
161			return $_SERVER['_'];
162			}
163
164			return self::getPhpBinary();
165			}
166			}
167

netz98 / n98-magerun2

Pull Request — develop (#362)

OperatingSystem::locateProgram() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like