Nginx::dump() - Code Metrics - Inspection of "redoing to new hidev" - hiqdev/hidev-nginx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 807037...c31f5c )

by Andrii

created 2017-05-04 15:48 UTC

Nginx::dump() A

↳ Parent: Nginx

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	0

<?php
/**
 * Nginx plugin for HiDev.
 *
 * @see      https://github.com/hiqdev/hidev-nginx
 * @package   hidev-nginx
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2016-2017, HiQDev (http://hiqdev.com/)
 */

namespace hidev\nginx\components;

use Exception;
use hidev\base\File;
use hidev\modifiers\Sudo;
use Yii;

/**
 * nginx component.
 */
class Nginx extends \hidev\base\Component
{
    use \hiqdev\yii2\collection\ManagerTrait;

    protected $_logDir;
    protected $_etcDir;
    protected $_fpmSocket;

    public $defaultClass = Vhost::class;

    public function dump()
    {
        foreach ($this->getItems() as $vhost) {
            $conf = $vhost->renderConf();
            File::plain($vhost->getDomain() . '.conf')->save($conf);
        }
    }

    public function deploy()
    {
        $etcDir = $this->getEtcDir();
        if (!is_dir($etcDir)) {
            throw new InvalidParamException("Non existing Nginx etcDir: $etcDir");
        }
        $enabledDir   = $etcDir . DIRECTORY_SEPARATOR . 'sites-enabled';
        $availableDir = $etcDir . DIRECTORY_SEPARATOR . 'sites-available';
        static::mkdir($enabledDir);
class YourClass
{
    private static function getTemperature() {
        return "3422 °C";
}

public static function getSomeVariable()
{
    return static::getTemperature();
}
        static::mkdir($availableDir);
class YourClass
{
    private static function getTemperature() {
        return "3422 °C";
}

public static function getSomeVariable()
{
    return static::getTemperature();
}
        foreach ($this->getItems() as $vhost) {
            $conf = $vhost->renderConf();
            $name = $vhost->getDomain() . '.conf';
            $file = File::plain($availableDir . DIRECTORY_SEPARATOR . $name);
            $file->save($conf);
            $file->symlink($enabledDir . DIRECTORY_SEPARATOR . $name);
        }
        $this->restart();
    }

    public function start()
    {
        return $this->run('start');
    }

    public function stop()
    {
        return $this->run('stop');
    }

    public function Reload()
    {
        return $this->run('reload');
    }

    public function Restart()
    {
        return $this->run('restart');
    }

    public function Status()
    {
        return $this->run('status', false);
    }

    public function run($operation, $sudo = true)
    {
        $args = ['nginx', $operation];
        if ($sudo) {
            array_push($args, Sudo::create());
        }

        return $this->passthru('service', $args);
    }

    public function letsencrypt()
    {
        foreach ($this->getItems() as $vhost) {
            $domain = $vhost->getDomain();
            $sslDir = $vhost->getSslDir();
            $args = ['certonly', '-a', 'webroot', '--webroot-path=' . $vhost->getWebDir()];
            foreach (array_reverse($vhost->getDomains()) as $name) {
                array_push($args, '-d');
                array_push($args, $name);
            }
            if ($this->passthru('/opt/letsencrypt/letsencrypt-auto', $args)) {
                throw new Exception('failed letsencrypt');
            }
            static::mkdir($sslDir);
class YourClass
{
    private static function getTemperature() {
        return "3422 °C";
}

public static function getSomeVariable()
{
    return static::getTemperature();
}
            $this->passthru('sh', ['-c', "cp /etc/letsencrypt/live/$domain/* $sslDir", Sudo::create()]);
            $vhost->chmodSSL();
        }
    }

    public function chmodSSL()
    {
        foreach ($this->getItems() as $vhost) {
            $vhost->chmodSSL();
        }
    }

    private static function mkdir($path)
    {
        if (file_exists($path)) {
            return true;
        }

        return mkdir($path, 0777, true);
    }

    /**
     * Prepares item config.
     */
    public function getItemConfig($name = null, array $config = [])
    {
        return array_merge([
            'domain' => $name,
            'nginx'  => $this,
            'class'  => $this->defaultClass,
        ], $config);
    }

    public function createItem($id, $config = [])
    {
        return Yii::createObject($this->getItemConfig($id, $config));
    }

    public function setLogDir($value)
    {
        $this->_logDir = $value;
    }

    public function getLogDir()
    {
        if ($this->_logDir === null) {
            $this->_logDir = '/var/log/nginx';
        }

        return $this->_logDir;
    }

    public function setEtcDir($value)
    {
        $this->_etcDir = $value;
    }

    public function getEtcDir()
    {
        if ($this->_etcDir === null) {
            $this->_etcDir = $this->findEtcDir();
        }

        return $this->_etcDir;
    }

    public function findEtcDir()
    {
        $dirs = ['/etc/nginx', '/usr/local/etc/nginx'];
        foreach ($dirs as $dir) {
            if (is_dir($dir)) {
                return $dir;
            }
        }

        return reset($dirs);
    }

    public function setFpmSocket($value)
    {
        $this->_fpmSocket = $value;
    }

    public function getFpmSocket()
    {
        if ($this->_fpmSocket === null) {
            $this->_fpmSocket = 'unix:' . $this->findFpmSocketFile();
        }

        return $this->_fpmSocket;
    }

    public function findFpmSocketFile()
    {
        $files = ['/run/php/php7.0-fpm.sock', '/var/run/php5-fpm.sock', '/tmp/php-fpm.sock'];
        foreach ($files as $file) {
            if (file_exists($file)) {
                return $file;
            }
        }

        return reset($files);
    }
}


1			<?php
2			/**
3			* Nginx plugin for HiDev.
4			*
5			* @see https://github.com/hiqdev/hidev-nginx
6			* @package hidev-nginx
7			* @license BSD-3-Clause
8			* @copyright Copyright (c) 2016-2017, HiQDev (http://hiqdev.com/)
9			*/
10
11			namespace hidev\nginx\components;
12
13			use Exception;
14			use hidev\base\File;
15			use hidev\modifiers\Sudo;
16			use Yii;
17
18			/**
19			* nginx component.
20			*/
21			class Nginx extends \hidev\base\Component
22			{
23			use \hiqdev\yii2\collection\ManagerTrait;
24
25			protected $_logDir;
26			protected $_etcDir;
27			protected $_fpmSocket;
28
29			public $defaultClass = Vhost::class;
30
31			public function dump()
32			{
33			foreach ($this->getItems() as $vhost) {
34			$conf = $vhost->renderConf();
35			File::plain($vhost->getDomain() . '.conf')->save($conf);
36			}
37			}
38
39			public function deploy()
40			{
41			$etcDir = $this->getEtcDir();
42			if (!is_dir($etcDir)) {
43			throw new InvalidParamException("Non existing Nginx etcDir: $etcDir");
44			}
45			$enabledDir = $etcDir . DIRECTORY_SEPARATOR . 'sites-enabled';
46			$availableDir = $etcDir . DIRECTORY_SEPARATOR . 'sites-available';
47			static::mkdir($enabledDir);
			0 ignored issues – show Bug introduced 2017-05-04 15:50 UTC by Report Bug Copy Issue Report Since `mkdir()` is declared private, calling it with `static` will lead to errors in possible sub-classes. You can either use `self`, or increase the visibility of `mkdir()` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return static::getTemperature(); } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { private static function getTemperature() { return "-182 °C"; } } print YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return self::getTemperature(); } } Loading history...
48			static::mkdir($availableDir);
			0 ignored issues – show Bug introduced 2017-05-04 15:50 UTC by Report Bug Copy Issue Report Since `mkdir()` is declared private, calling it with `static` will lead to errors in possible sub-classes. You can either use `self`, or increase the visibility of `mkdir()` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return static::getTemperature(); } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { private static function getTemperature() { return "-182 °C"; } } print YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return self::getTemperature(); } } Loading history...
49			foreach ($this->getItems() as $vhost) {
50			$conf = $vhost->renderConf();
51			$name = $vhost->getDomain() . '.conf';
52			$file = File::plain($availableDir . DIRECTORY_SEPARATOR . $name);
53			$file->save($conf);
54			$file->symlink($enabledDir . DIRECTORY_SEPARATOR . $name);
55			}
56			$this->restart();
57			}
58
59			public function start()
60			{
61			return $this->run('start');
62			}
63
64			public function stop()
65			{
66			return $this->run('stop');
67			}
68
69			public function Reload()
70			{
71			return $this->run('reload');
72			}
73
74			public function Restart()
75			{
76			return $this->run('restart');
77			}
78
79			public function Status()
80			{
81			return $this->run('status', false);
82			}
83
84			public function run($operation, $sudo = true)
85			{
86			$args = ['nginx', $operation];
87			if ($sudo) {
88			array_push($args, Sudo::create());
89			}
90
91			return $this->passthru('service', $args);
92			}
93
94			public function letsencrypt()
95			{
96			foreach ($this->getItems() as $vhost) {
97			$domain = $vhost->getDomain();
98			$sslDir = $vhost->getSslDir();
99			$args = ['certonly', '-a', 'webroot', '--webroot-path=' . $vhost->getWebDir()];
100			foreach (array_reverse($vhost->getDomains()) as $name) {
101			array_push($args, '-d');
102			array_push($args, $name);
103			}
104			if ($this->passthru('/opt/letsencrypt/letsencrypt-auto', $args)) {
105			throw new Exception('failed letsencrypt');
106			}
107			static::mkdir($sslDir);
			0 ignored issues – show Bug introduced 2017-05-04 15:50 UTC by Report Bug Copy Issue Report Since `mkdir()` is declared private, calling it with `static` will lead to errors in possible sub-classes. You can either use `self`, or increase the visibility of `mkdir()` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return static::getTemperature(); } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { private static function getTemperature() { return "-182 °C"; } } print YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return self::getTemperature(); } } Loading history...
108			$this->passthru('sh', ['-c', "cp /etc/letsencrypt/live/$domain/* $sslDir", Sudo::create()]);
109			$vhost->chmodSSL();
110			}
111			}
112
113			public function chmodSSL()
114			{
115			foreach ($this->getItems() as $vhost) {
116			$vhost->chmodSSL();
117			}
118			}
119
120			private static function mkdir($path)
121			{
122			if (file_exists($path)) {
123			return true;
124			}
125
126			return mkdir($path, 0777, true);
127			}
128
129			/**
130			* Prepares item config.
131			*/
132			public function getItemConfig($name = null, array $config = [])
133			{
134			return array_merge([
135			'domain' => $name,
136			'nginx' => $this,
137			'class' => $this->defaultClass,
138			], $config);
139			}
140
141			public function createItem($id, $config = [])
142			{
143			return Yii::createObject($this->getItemConfig($id, $config));
144			}
145
146			public function setLogDir($value)
147			{
148			$this->_logDir = $value;
149			}
150
151			public function getLogDir()
152			{
153			if ($this->_logDir === null) {
154			$this->_logDir = '/var/log/nginx';
155			}
156
157			return $this->_logDir;
158			}
159
160			public function setEtcDir($value)
161			{
162			$this->_etcDir = $value;
163			}
164
165			public function getEtcDir()
166			{
167			if ($this->_etcDir === null) {
168			$this->_etcDir = $this->findEtcDir();
169			}
170
171			return $this->_etcDir;
172			}
173
174			public function findEtcDir()
175			{
176			$dirs = ['/etc/nginx', '/usr/local/etc/nginx'];
177			foreach ($dirs as $dir) {
178			if (is_dir($dir)) {
179			return $dir;
180			}
181			}
182
183			return reset($dirs);
184			}
185
186			public function setFpmSocket($value)
187			{
188			$this->_fpmSocket = $value;
189			}
190
191			public function getFpmSocket()
192			{
193			if ($this->_fpmSocket === null) {
194			$this->_fpmSocket = 'unix:' . $this->findFpmSocketFile();
195			}
196
197			return $this->_fpmSocket;
198			}
199
200			public function findFpmSocketFile()
201			{
202			$files = ['/run/php/php7.0-fpm.sock', '/var/run/php5-fpm.sock', '/tmp/php-fpm.sock'];
203			foreach ($files as $file) {
204			if (file_exists($file)) {
205			return $file;
206			}
207			}
208
209			return reset($files);
210			}
211			}
212

hiqdev / hidev-nginx

Push — master ( 807037...c31f5c )

Nginx::dump() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like