Apache::addEntry() - Code Metrics - tollwerk/admin - Measure and Improve Code Quality continuously with Scrutinizer

Apache::addEntry() A
last analyzed 2020-07-08 14:33 UTC

↳ Parent: Apache

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	3
crap	6

<?php

/**
 * admin
 *
 * @category    Tollwerk
 * @package     Tollwerk\Admin
 * @subpackage  Tollwerk\Admin\Infrastructure\Persistence
 * @author      Joschi Kuphal <[email protected]> / @jkphl
 * @copyright   Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Tollwerk\Admin\Infrastructure\Persistence;

use Psr\Log\LogLevel;
use Tollwerk\Admin\Domain\Account\AccountInterface;
use Tollwerk\Admin\Domain\Vhost\Vhost;
use Tollwerk\Admin\Domain\Vhost\VhostInterface;
use Tollwerk\Admin\Infrastructure\App;
use Tollwerk\Admin\Infrastructure\Factory\CertbotServiceFactory;
use Tollwerk\Admin\Infrastructure\Service\TemplateService;

/**
 * Apache persister
 *
 * @package Tollwerk\Admin
 * @subpackage Tollwerk\Admin\Infrastructure
 */
class Apache
{
    /**
     * Account
     *
     * @var AccountInterface
     */
    protected $account;
    /**
     * Configuration
     *
     * @var array
     */
    protected $config;
    /**
     * Account helper
     *
     * @var AccountHelper
     */
    protected $helper;

    /**
     * Constructor
     *
     * @param AccountInterface $account Account
     * @param array $config Configuration
     */
    public function __construct(AccountInterface $account, array $config)
    {
        $this->account = $account;
        $this->config = $config;
        $this->helper = new AccountHelper($this->account);

        // Add some directory names
        $this->config['dataroot'] = $this->helper->directory('data');
        $this->config['vhostroot'] = $this->helper->directory('config'.DIRECTORY_SEPARATOR.'vhosts-available');
        $this->config['logdir'] = $this->helper->directory('log');
        $this->config['account'] = $this->account->getName();
    }

    /**
     * Persist a virtual host
     *
     * @param VhostInterface $vhost Virtual host
     * @return array Files
     */
    public function __invoke(VhostInterface $vhost)
    {
        $files = [];

        $variables = $this->config;
        $variables['primary_domain'] = strval($vhost->getPrimaryDomain());
        $variables['primary_domain_pcre'] = preg_quote($variables['primary_domain']);
        $variables['secondary_domains'] = implode(' ', array_map('strval', $vhost->getSecondaryDomains()));
        $variables['secondary_domains_without_wildcards'] =
            implode(', ', array_map('strval', $vhost->getSecondaryDomains(true)));
        $variables['docroot'] =
            rtrim($this->config['dataroot'].DIRECTORY_SEPARATOR.$vhost->getDocroot(), DIRECTORY_SEPARATOR);
        $variables['configroot'] = $this->config['vhostroot'].DIRECTORY_SEPARATOR.$variables['primary_domain'];
        $variables['php_version'] = $vhost->getPhp();

        // If the virtual host should redirect
        if ($vhost->getRedirectUrl() !== null) {
            // TODO: Redirect

            return $files;
        }

        // If the virtual host should support PHP
        if ($vhost->getPhp() !== null) {
            $this->createPhpConfig($vhost, $files, $variables);
        }

        // Add the virtual host include
        $this->addEntry($files, 'apache_vhost.include', TemplateService::render('apache_vhost.include', $variables));
        $this->addEntry(
            $files,
            'apache_vhost_custom_directory.include?',
            TemplateService::render('apache_vhost_custom_directory.include', $variables)
        );
        $this->addEntry(
            $files,
            'apache_vhost_custom_all.include?',
            TemplateService::render('apache_vhost_all.include', $variables)
        );

        // If the HTTPS protocol is supported
        $httpsPorts = $vhost->getPorts(Vhost::PROTOCOL_HTTPS);
        if (!empty($httpsPorts)) {
            $certbotConfig = $this->helper->vhostDirectory($vhost).DIRECTORY_SEPARATOR.'certbot.ini';
            $certbotService = CertbotServiceFactory::create($certbotConfig);
            $primaryDomainIsCertified = $certbotService->isCertified($variables['primary_domain']);

            // Add the SSL configuration include
            $this->addEntry(
                $files,
                'apache_ssl.include',
                TemplateService::render('apache_ssl.include', $variables, !$primaryDomainIsCertified)
            );

            // Run through all SSL ports
            foreach ($httpsPorts as $httpsPort) {

                // Add the HTTPS vhost declaration
                $variables['port'] = $httpsPort;
                $variables['ssl'] = true;
                $this->addEntry(
                    $files, 'apache_vhost.conf',
                    TemplateService::render('apache_vhost.conf', $variables)
                );
                $this->addEntry($files, 'apache_vhost_custom_'.$httpsPort.'.include?', '');
            }

            // Add the Certbot configuration
            $this->addEntry(
                $files, 'certbot.ini',
                TemplateService::render('certbot.ini', $variables)
            );

            // Create the well-known symlink
            $certbotService->prepare($vhost, $this->helper);

            // Output a hint if the primary domain isn't certified
            if (!$primaryDomainIsCertified) {
                App::addMessage(
                    sprintf(
                        'The virtual host primary domain "%s" should be properly certified!',
                        $variables['primary_domain']
                    ),
                    LogLevel::NOTICE
                );
            }
        }

        // Run through all non-SSL ports
        foreach ((array)$vhost->getPorts(Vhost::PROTOCOL_HTTP) as $httpPort) {

            // Add the HTTP vhost declaration
            $variables['port'] = $httpPort;
            $variables['ssl'] = false;
            $this->addEntry(
                $files, 'apache_vhost.conf',
                TemplateService::render('apache_vhost.conf', $variables)
            );
            $this->addEntry(
                $files, 'apache_vhost_custom_'.$httpPort.'.include?',
                TemplateService::render('apache_vhost_http.include', $variables)
            );
        }

        $absoluteFiles = [];
        foreach ($files as $relativeFile => $fileContent) {
            $absoluteFiles[$this->helper->vhostDirectory($vhost).DIRECTORY_SEPARATOR.$relativeFile] =
                implode(PHP_EOL, (array)$fileContent);
        }
        return $absoluteFiles;
    }

    /**
     * Create a PHP configuration include
     *
     * @param VhostInterface $vhost Virtual host
     * @param array $files Configuration files
     * @param array $variables Templating variables
     */
    protected function createPhpConfig(VhostInterface $vhost, array &$files, array $variables)
    {
        $variables['pool'] = $variables['account'];
        if (strlen(trim($vhost->getDocroot()))) {
            $variables['pool'] .= '/'.$vhost->getDocroot();
        }

        // Add the FPM configuration
        $this->addEntry($files, 'fpm-'.$vhost->getPhp().'.conf', TemplateService::render('fpm.conf', $variables));

        // Add the FPM custom configuration
        $this->addEntry($files, 'fpm.include?', TemplateService::render('fpm.include', $variables));

        // Add the FPM include
        $this->addEntry(
            $files, 'apache_fmp.include',
            TemplateService::render('apache_fpm.include', $variables)
        );
    }

    /**
     * Add a file entry
     *
     * @param array $files Files
     * @param string $name File name
     * @param string $entry entry
     */
    protected function addEntry(&$files, $name, $entry)
    {
        if (empty($files[$name])) {
            $files[$name] = [];
        }
        $files[$name][] = $entry;
    }
}


1			<?php
2
3			/**
4			* admin
5			*
6			* @category Tollwerk
7			* @package Tollwerk\Admin
8			* @subpackage Tollwerk\Admin\Infrastructure\Persistence
9			* @author Joschi Kuphal <[email protected]> / @jkphl
10			* @copyright Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
11			* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12			*/
13
14			/***********************************************************************************
15			* The MIT License (MIT)
16			*
17			* Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
18			*
19			* Permission is hereby granted, free of charge, to any person obtaining a copy of
20			* this software and associated documentation files (the "Software"), to deal in
21			* the Software without restriction, including without limitation the rights to
22			* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23			* the Software, and to permit persons to whom the Software is furnished to do so,
24			* subject to the following conditions:
25			*
26			* The above copyright notice and this permission notice shall be included in all
27			* copies or substantial portions of the Software.
28			*
29			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31			* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32			* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33			* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34			* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35			***********************************************************************************/
36
37			namespace Tollwerk\Admin\Infrastructure\Persistence;
38
39			use Psr\Log\LogLevel;
40			use Tollwerk\Admin\Domain\Account\AccountInterface;
41			use Tollwerk\Admin\Domain\Vhost\Vhost;
42			use Tollwerk\Admin\Domain\Vhost\VhostInterface;
43			use Tollwerk\Admin\Infrastructure\App;
44			use Tollwerk\Admin\Infrastructure\Factory\CertbotServiceFactory;
45			use Tollwerk\Admin\Infrastructure\Service\TemplateService;
46
47			/**
48			* Apache persister
49			*
50			* @package Tollwerk\Admin
51			* @subpackage Tollwerk\Admin\Infrastructure
52			*/
53			class Apache
54			{
55			/**
56			* Account
57			*
58			* @var AccountInterface
59			*/
60			protected $account;
61			/**
62			* Configuration
63			*
64			* @var array
65			*/
66			protected $config;
67			/**
68			* Account helper
69			*
70			* @var AccountHelper
71			*/
72			protected $helper;
73
74			/**
75			* Constructor
76			*
77			* @param AccountInterface $account Account
78			* @param array $config Configuration
79			*/
80			public function __construct(AccountInterface $account, array $config)
81			{
82			$this->account = $account;
83			$this->config = $config;
84			$this->helper = new AccountHelper($this->account);
85
86			// Add some directory names
87			$this->config['dataroot'] = $this->helper->directory('data');
88			$this->config['vhostroot'] = $this->helper->directory('config'.DIRECTORY_SEPARATOR.'vhosts-available');
89			$this->config['logdir'] = $this->helper->directory('log');
90			$this->config['account'] = $this->account->getName();
91			}
92
93			/**
94			* Persist a virtual host
95			*
96			* @param VhostInterface $vhost Virtual host
97			* @return array Files
98			*/
99			public function __invoke(VhostInterface $vhost)
100			{
101			$files = [];
102
103			$variables = $this->config;
104			$variables['primary_domain'] = strval($vhost->getPrimaryDomain());
105			$variables['primary_domain_pcre'] = preg_quote($variables['primary_domain']);
106			$variables['secondary_domains'] = implode(' ', array_map('strval', $vhost->getSecondaryDomains()));
107			$variables['secondary_domains_without_wildcards'] =
108			implode(', ', array_map('strval', $vhost->getSecondaryDomains(true)));
109			$variables['docroot'] =
110			rtrim($this->config['dataroot'].DIRECTORY_SEPARATOR.$vhost->getDocroot(), DIRECTORY_SEPARATOR);
111			$variables['configroot'] = $this->config['vhostroot'].DIRECTORY_SEPARATOR.$variables['primary_domain'];
112			$variables['php_version'] = $vhost->getPhp();
113
114			// If the virtual host should redirect
115			if ($vhost->getRedirectUrl() !== null) {
116			// TODO: Redirect
117
118			return $files;
119			}
120
121			// If the virtual host should support PHP
122			if ($vhost->getPhp() !== null) {
123			$this->createPhpConfig($vhost, $files, $variables);
124			}
125
126			// Add the virtual host include
127			$this->addEntry($files, 'apache_vhost.include', TemplateService::render('apache_vhost.include', $variables));
128			$this->addEntry(
129			$files,
130			'apache_vhost_custom_directory.include?',
131			TemplateService::render('apache_vhost_custom_directory.include', $variables)
132			);
133			$this->addEntry(
134			$files,
135			'apache_vhost_custom_all.include?',
136			TemplateService::render('apache_vhost_all.include', $variables)
137			);
138
139			// If the HTTPS protocol is supported
140			$httpsPorts = $vhost->getPorts(Vhost::PROTOCOL_HTTPS);
141			if (!empty($httpsPorts)) {
142			$certbotConfig = $this->helper->vhostDirectory($vhost).DIRECTORY_SEPARATOR.'certbot.ini';
143			$certbotService = CertbotServiceFactory::create($certbotConfig);
144			$primaryDomainIsCertified = $certbotService->isCertified($variables['primary_domain']);
145
146			// Add the SSL configuration include
147			$this->addEntry(
148			$files,
149			'apache_ssl.include',
150			TemplateService::render('apache_ssl.include', $variables, !$primaryDomainIsCertified)
151			);
152
153			// Run through all SSL ports
154			foreach ($httpsPorts as $httpsPort) {
155
156			// Add the HTTPS vhost declaration
157			$variables['port'] = $httpsPort;
158			$variables['ssl'] = true;
159			$this->addEntry(
160			$files, 'apache_vhost.conf',
161			TemplateService::render('apache_vhost.conf', $variables)
162			);
163			$this->addEntry($files, 'apache_vhost_custom_'.$httpsPort.'.include?', '');
164			}
165
166			// Add the Certbot configuration
167			$this->addEntry(
168			$files, 'certbot.ini',
169			TemplateService::render('certbot.ini', $variables)
170			);
171
172			// Create the well-known symlink
173			$certbotService->prepare($vhost, $this->helper);
174
175			// Output a hint if the primary domain isn't certified
176			if (!$primaryDomainIsCertified) {
177			App::addMessage(
178			sprintf(
179			'The virtual host primary domain "%s" should be properly certified!',
180			$variables['primary_domain']
181			),
182			LogLevel::NOTICE
183			);
184			}
185			}
186
187			// Run through all non-SSL ports
188			foreach ((array)$vhost->getPorts(Vhost::PROTOCOL_HTTP) as $httpPort) {
189
190			// Add the HTTP vhost declaration
191			$variables['port'] = $httpPort;
192			$variables['ssl'] = false;
193			$this->addEntry(
194			$files, 'apache_vhost.conf',
195			TemplateService::render('apache_vhost.conf', $variables)
196			);
197			$this->addEntry(
198			$files, 'apache_vhost_custom_'.$httpPort.'.include?',
199			TemplateService::render('apache_vhost_http.include', $variables)
200			);
201			}
202
203			$absoluteFiles = [];
204			foreach ($files as $relativeFile => $fileContent) {
205			$absoluteFiles[$this->helper->vhostDirectory($vhost).DIRECTORY_SEPARATOR.$relativeFile] =
206			implode(PHP_EOL, (array)$fileContent);
207			}
208			return $absoluteFiles;
209			}
210
211			/**
212			* Create a PHP configuration include
213			*
214			* @param VhostInterface $vhost Virtual host
215			* @param array $files Configuration files
216			* @param array $variables Templating variables
217			*/
218			protected function createPhpConfig(VhostInterface $vhost, array &$files, array $variables)
219			{
220			$variables['pool'] = $variables['account'];
221			if (strlen(trim($vhost->getDocroot()))) {
222			$variables['pool'] .= '/'.$vhost->getDocroot();
223			}
224
225			// Add the FPM configuration
226			$this->addEntry($files, 'fpm-'.$vhost->getPhp().'.conf', TemplateService::render('fpm.conf', $variables));
227
228			// Add the FPM custom configuration
229			$this->addEntry($files, 'fpm.include?', TemplateService::render('fpm.include', $variables));
230
231			// Add the FPM include
232			$this->addEntry(
233			$files, 'apache_fmp.include',
234			TemplateService::render('apache_fpm.include', $variables)
235			);
236			}
237
238			/**
239			* Add a file entry
240			*
241			* @param array $files Files
242			* @param string $name File name
243			* @param string $entry entry
244			*/
245			protected function addEntry(&$files, $name, $entry)
246			{
247			if (empty($files[$name])) {
248			$files[$name] = [];
249			}
250			$files[$name][] = $entry;
251			}
252			}
253

tollwerk / admin

Apache::addEntry() A last analyzed 2020-07-08 14:33 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Apache::addEntry() A
last analyzed 2020-07-08 14:33 UTC