BaseOptimizer::detectBinaryPath() - Code Metrics - Inspection of "execute commands from the non-global environment" - spatie/image-optimizer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#57)

by Faton

created 2018-05-10 07:15 UTC

BaseOptimizer::detectBinaryPath() B

↳ Parent: BaseOptimizer

Complexity

Conditions	5
Paths	7

Size

Total Lines	32
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	32
rs	8.439
c	0
b	0
f	0
cc	5
eloc	19
nc	7
nop	0

<?php

namespace Spatie\ImageOptimizer\Optimizers;

use Psr\Log\LoggerInterface;
use Spatie\ImageOptimizer\DummyLogger;
use Spatie\ImageOptimizer\Optimizer;
use Symfony\Component\Process\Process;

abstract class BaseOptimizer implements Optimizer
{
    public $options = [];

    public $imagePath = '';

    /**
     * List of binary paths to check for commands.
     * @var array $binaryPathList
     */
    protected $binaryPathList = [
      '/usr/local',
      '/usr/local/bin',
      '/usr/bin',
      '/usr/sbin',
      '/usr/local/bin',
      '/usr/local/sbin',
      '/bin',
      '/sbin'
    ];

    /** @var \Psr\Log\LoggerInterface */
    protected $logger;

    /**
     * Binary name of the optimizer.
     * @var string $binaryName
     */
    protected $binaryName;

    /**
     * Binary path.
     *
     * @var string $binaryPath
     */
    protected $binaryPath = '';

    public function __construct($options = [])
    {
        $this->useLogger(new DummyLogger());
        $this->setOptions($options);
    }


    /**
     * Set binary Path
     *
     * Useful in case your commands are not accessible by global environment. ex. /usr/bin/local
     *
     * @param string $binaryName
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return string
     */
    public function setBinaryPath(string $binaryPath)
    {
        $this->binaryPath = $binaryPath;

        return $this;
    }

    /**
     * Get binary path
     *
     * @return string
     */
    public function binaryPath(): string
    {
        return $this->binaryPath;
    }


    public function binaryName(): string
    {
        return $this->binaryName;
    }

    public function setImagePath(string $imagePath)
    {
        $this->imagePath = $imagePath;

        return $this;
    }

    public function setOptions(array $options = [])
    {
        $this->options = $options;

        return $this;
    }

    public function useLogger(LoggerInterface $log)
    {
        $this->logger = $log;

        return $this;
    }


    /**
     * Get Binary path list
     *
     * @return array
     */
    public function binaryPathList(){
        return $this->binaryPathList;
    }

    /**
     * Authomatically detect the path where the image optimizes is installed
     *
     * @return $this
     */
    public function detectBinaryPath(){
        // first check if comman is executed in a global environment
        $process = new Process("which -a " .$this->binaryName());
        $process->setTimeout(null);
        $process->run();
        if ($process->isSuccessful()) {
            return $this;
        }

        // add custom path (if given in config.php)
        if($this->binaryPath()) {
            $this->binaryPathList = [
              $this->binaryPath()
            ];
        }

        // check if command is found in every given path
        foreach ($this->binaryPathList() as $path) {
            $path = rtrim($path, '/') . '/';
            $process = new Process("which -a " . $path . '' . $this->binaryName());
            $process->setTimeout(null);
            $process->run();
            if ($process->isSuccessful()) {
                $this->setBinaryPath($path);
                return $this;
            }
        }

        $this->logger->error("Command could not be executed in any of the following binary path: `".implode(",", array_values($this->binaryPathList))."`}");

        return $this;
    }

    public function getCommand(): string
    {
        $optionString = implode(' ', $this->options);
        $fullBinaryPath = $this->detectBinaryPath()->binaryPath().$this->binaryName();

        return "\"{$fullBinaryPath}\" {$optionString} ".escapeshellarg($this->imagePath);
    }
}


1			<?php
2
3			namespace Spatie\ImageOptimizer\Optimizers;
4
5			use Psr\Log\LoggerInterface;
6			use Spatie\ImageOptimizer\DummyLogger;
7			use Spatie\ImageOptimizer\Optimizer;
8			use Symfony\Component\Process\Process;
9
10			abstract class BaseOptimizer implements Optimizer
11			{
12			public $options = [];
13
14			public $imagePath = '';
15
16			/**
17			* List of binary paths to check for commands.
18			* @var array $binaryPathList
19			*/
20			protected $binaryPathList = [
21			'/usr/local',
22			'/usr/local/bin',
23			'/usr/bin',
24			'/usr/sbin',
25			'/usr/local/bin',
26			'/usr/local/sbin',
27			'/bin',
28			'/sbin'
29			];
30
31			/** @var \Psr\Log\LoggerInterface */
32			protected $logger;
33
34			/**
35			* Binary name of the optimizer.
36			* @var string $binaryName
37			*/
38			protected $binaryName;
39
40			/**
41			* Binary path.
42			*
43			* @var string $binaryPath
44			*/
45			protected $binaryPath = '';
46
47			public function __construct($options = [])
48			{
49			$this->useLogger(new DummyLogger());
50			$this->setOptions($options);
51			}
52
53
54			/**
55			* Set binary Path
56			*
57			* Useful in case your commands are not accessible by global environment. ex. /usr/bin/local
58			*
59			* @param string $binaryName
			0 ignored issues – show Bug introduced 2018-05-08 15:50 UTC by Report Bug Copy Issue Report There is no parameter named `$binaryName`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
60			* @return string
61			*/
62			public function setBinaryPath(string $binaryPath)
63			{
64			$this->binaryPath = $binaryPath;
65
66			return $this;
67			}
68
69			/**
70			* Get binary path
71			*
72			* @return string
73			*/
74			public function binaryPath(): string
75			{
76			return $this->binaryPath;
77			}
78
79
80			public function binaryName(): string
81			{
82			return $this->binaryName;
83			}
84
85			public function setImagePath(string $imagePath)
86			{
87			$this->imagePath = $imagePath;
88
89			return $this;
90			}
91
92			public function setOptions(array $options = [])
93			{
94			$this->options = $options;
95
96			return $this;
97			}
98
99			public function useLogger(LoggerInterface $log)
100			{
101			$this->logger = $log;
102
103			return $this;
104			}
105
106
107			/**
108			* Get Binary path list
109			*
110			* @return array
111			*/
112			public function binaryPathList(){
113			return $this->binaryPathList;
114			}
115
116			/**
117			* Authomatically detect the path where the image optimizes is installed
118			*
119			* @return $this
120			*/
121			public function detectBinaryPath(){
122			// first check if comman is executed in a global environment
123			$process = new Process("which -a " .$this->binaryName());
124			$process->setTimeout(null);
125			$process->run();
126			if ($process->isSuccessful()) {
127			return $this;
128			}
129
130			// add custom path (if given in config.php)
131			if($this->binaryPath()) {
132			$this->binaryPathList = [
133			$this->binaryPath()
134			];
135			}
136
137			// check if command is found in every given path
138			foreach ($this->binaryPathList() as $path) {
139			$path = rtrim($path, '/') . '/';
140			$process = new Process("which -a " . $path . '' . $this->binaryName());
141			$process->setTimeout(null);
142			$process->run();
143			if ($process->isSuccessful()) {
144			$this->setBinaryPath($path);
145			return $this;
146			}
147			}
148
149			$this->logger->error("Command could not be executed in any of the following binary path: `".implode(",", array_values($this->binaryPathList))."`}");
150
151			return $this;
152			}
153
154			public function getCommand(): string
155			{
156			$optionString = implode(' ', $this->options);
157			$fullBinaryPath = $this->detectBinaryPath()->binaryPath().$this->binaryName();
158
159			return "\"{$fullBinaryPath}\" {$optionString} ".escapeshellarg($this->imagePath);
160			}
161			}
162

spatie / image-optimizer

GitHub Access Token became invalid

Pull Request — master (#57)

BaseOptimizer::detectBinaryPath() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like