WebserverSkeleton::writeToFirstHostFile() - Code Metrics - Inspection of "Fix: remove webserver and php-fpm config file when..." - Kunstmaan/skylab - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#114)

unknown

created 2016-01-05 14:58 UTC

WebserverSkeleton::writeToFirstHostFile() A

↳ Parent: WebserverSkeleton

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	6
rs	9.4286
cc	1
eloc	3
nc	1
nop	0

<?php
namespace Kunstmaan\Skylab\Skeleton;

use Kunstmaan\Skylab\Exceptions\SkylabException;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;

/**
 * ApacheSkeleton
 */
class WebserverSkeleton extends AbstractSkeleton
{

    const NAME = "apache";

    /**
     * @param \ArrayObject $project
     *
     * @return mixed
     */
    public function create(\ArrayObject $project)
    {
        $this->handleAliases($project, $aliases);
        // nginx
        $this->prepareNginxDirectories($project);
        $this->fileSystemProvider->renderConfig($this->fileSystemProvider->getNginxConfigTemplateDir(),$this->fileSystemProvider->getNginxConfigTemplateDir(true),$this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/nginx.d/");
        // apache
        $this->prepareApacheDirectories($project);
        $this->fileSystemProvider->renderDistConfig($this->fileSystemProvider->getApacheConfigTemplateDir(),$this->fileSystemProvider->getApacheConfigTemplateDir(true),$this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/apache.d/");
    }

    /**
     * @return mixed
     */
    public function preMaintenance()
    {
        if ($this->isWebserverNginx()) {
            $this->processProvider->executeSudoCommand("rm -Rf " . $this->app["config"]["nginx"]["sitesavailable"] . "/*");
            $this->processProvider->executeSudoCommand("rm -Rf " . $this->app["config"]["nginx"]["sitesenabled"] . "/*");
        } else {
            $this->processProvider->executeSudoCommand("rm -Rf " . $this->app["config"]["apache"]["sitesavailable"] . "/*");
            $this->processProvider->executeSudoCommand("rm -Rf " . $this->app["config"]["apache"]["sitesenabled"] . "/*");
        }
    }

    /**
     * @param \ArrayObject $project
     *
     * @return mixed
     */
    public function maintenance(\ArrayObject $project)
    {
        if ($this->app["config"]["develmode"] || !file_exists($this->fileSystemProvider->getProjectDirectory($project["name"]) . "/data/current")) {
            if (!is_dir($this->fileSystemProvider->getProjectDirectory($project["name"]) . "/data/current")){
                $this->processProvider->executeSudoCommand("rm -f " . $this->fileSystemProvider->getProjectDirectory($project["name"]) . "/data/current");
                $this->processProvider->executeSudoCommand("ln -sf " . $this->fileSystemProvider->getProjectDirectory($project["name"]) . "/data/" . $project["name"] . "/ " . $this->fileSystemProvider->getProjectDirectory($project["name"]) . "/data/current");
            }
        }

        if (PHP_OS == "Darwin") {

            $this->processProvider->executeSudoCommand('find ' . $this->fileSystemProvider->getProjectDirectory($project["name"]) . '/data/current -type d -name .git -exec cd {} "\;" -exec git config core.filemode false "\;"');
        } else {
            $this->processProvider->executeSudoCommand('find ' . $this->fileSystemProvider->getProjectDirectory($project["name"]) . '/data/current -type d -name .git -exec cd {} \; -exec git config core.filemode false \;');
        }

        $this->dialogProvider->logConfig("Updating aliases webserver config file");
        $this->generateBasicAliases($project, $aliases);

        if ($this->isWebserverNginx()) {
            $this->maintenanceNginx($project, $aliases);
        } else {
            $this->maintenanceApache($project, $aliases);
        }
    }

    /**
     * @return mixed
     */
    public function postMaintenance()
    {
        $this->writeToHostFile();
        if ($this->isWebserverNginx()) {
            $finder = new Finder();
            $finder->files()->in($this->app["config"]["nginx"]["sitesavailable"])->name("*.conf");
            /** @var SplFileInfo $config */
            foreach ($finder as $config) {

                $this->processProvider->executeSudoCommand("ln -sf " . $this->app["config"]["nginx"]["sitesavailable"] . "/" . $config->getFilename() . " " . $this->app["config"]["nginx"]["sitesenabled"] . "/" . $config->getFilename());
            }
        } else {
            $this->writeToFirstHostFile();
            $finder = new Finder();
            $finder->files()->in($this->app["config"]["apache"]["sitesavailable"])->name("*.conf");
            /** @var SplFileInfo $config */
            foreach ($finder as $config) {

                $this->processProvider->executeSudoCommand("ln -sf " . $this->app["config"]["apache"]["sitesavailable"] . "/" . $config->getFilename() . " " . $this->app["config"]["apache"]["sitesenabled"] . "/" . $config->getFilename());
            }
        }
    }

    private function writeToFirstHostFile()
    {
        $this->fileSystemProvider->render("/apache/000firsthost.conf.twig", $this->app["config"]["apache"]["sitesavailable"] . "/000firsthost.conf", array(
            'admin' => $this->app["config"]["apache"]["admin"]
        ));
    }

    private function writeToHostFile()
    {
        $hostlines = array();
        $dialogProvider = $this->dialogProvider;
        $this->fileSystemProvider->projectsLoop(function ($project) use (&$hostlines, $dialogProvider) {
            $hostlines[] = $this->app["config"]["webserver"]["localip"] . " " . $project["name"] . "." . $this->app["config"]["webserver"]["hostmachine"] . " www." . $project["name"] . "." . $this->app["config"]["webserver"]["hostmachine"] . "\n";
        });
        $this->dialogProvider->logTask("Updating the /etc/hosts file (add lines)");
        $hostsfile = file("/etc/hosts");
        $resultLines = array();
        $foundSection = false;
        $inSection = false;
        foreach ($hostsfile as $line) {
            if (!$inSection) {
                if (strpos($line, "#KDEPLOY_start") === 0) {
                    $inSection = true;
                    $foundSection = true;
                    $resultLines[] = $line;
                    $resultLines = array_merge($resultLines, $hostlines);
                } else {
                    $resultLines[] = $line;
                }
            } else {
                if (strpos($line, "#KDEPLOY_end") === 0) {
                    $inSection = false;
                    $resultLines[] = $line;
                }
            }
        }
        if (!$foundSection) {
            $resultLines[] = "#KDEPLOY_start autogenerated section. do not edit below this line. do not remove this line.\n";
            $resultLines = array_merge($resultLines, $hostlines);
            $resultLines[] = "#KDEPLOY_end autogenerated section. do not edit above this line. do not remove this line.\n";
        }
        $this->fileSystemProvider->writeProtectedFile("/etc/hosts", implode("", $resultLines));
    }

    /**
     * @param \ArrayObject $project
     */
    private function removeFromHostFile(\ArrayObject $project)
    {

        $hostlines[] = $this->app["config"]["webserver"]["localip"] . " " . $project["name"] . "." . $this->app["config"]["webserver"]["hostmachine"] . " www." . $project["name"] . "." . $this->app["config"]["webserver"]["hostmachine"] . "\n";
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        $this->dialogProvider->logTask("Updating the /etc/hosts file (remove lines)");
        $hostsfile = file("/etc/hosts");
        $resultLines = array();

        foreach ($hostsfile as $line) {
            if (!in_array($line, $hostlines)) {
                $resultLines[] = $line;
            }
        }

        $this->fileSystemProvider->writeProtectedFile("/etc/hosts", implode("", $resultLines));
    }

    /**
     * @return string
     */
    public function getName()
    {
        return self::NAME;
    }

    /**
     * @param \ArrayObject $project
     *
     * @return mixed
     */
    public function preBackup(\ArrayObject $project)
    {
    }

    /**
     * @param \ArrayObject $project
     *
     * @return mixed
     */
    public function postBackup(\ArrayObject $project)
    {
    }

    /**
     * @param \ArrayObject $project
     *
     * @return mixed
     */
    public function preRemove(\ArrayObject $project)
    {
    }

    /**
     * @param \ArrayObject $project
     *
     * @return mixed
     */
    public function postRemove(\ArrayObject $project)
    {
        $this->removeFromHostFile($project);

        if ($this->isWebserverNginx()) {
            $this->processProvider->executeSudoCommand("rm -f ".$this->app["config"]["nginx"]["sitesenabled"] . "/" . $project["name"] . ".conf");
            $this->processProvider->executeSudoCommand("rm -f ".$this->app["config"]["nginx"]["sitesavailable"] . "/" . $project["name"] . ".conf");
        }
        else{
            $this->processProvider->executeSudoCommand("rm -f ".$this->app["config"]["apache"]["sitesenabled"] . "/" . $project["name"] . ".conf");
            $this->processProvider->executeSudoCommand("rm -f ".$this->app["config"]["apache"]["sitesavailable"] . "/" . $project["name"] . ".conf");
        }

        if (PHP_OS == "Darwin") {
            $this->processProvider->executeSudoCommand("apachectl -k restart");
        }
        else{
            if ($this->isWebserverNginx()) {
                $this->processProvider->executeSudoCommand("service nginx reload");
            } else {
                $this->processProvider->executeSudoCommand("service apache2 reload");
            }
        }

    }

    /**
     * @param  \ArrayObject      $project
     * @param  \SimpleXMLElement $config  The configuration array
     * @return \SimpleXMLElement
     */
    public function writeConfig(\ArrayObject $project, \SimpleXMLElement $config)
    {
        $config = $this->projectConfigProvider->addVar($config, 'project.url', $project["url"]);
        if (isset($project["aliases"])) {
            $config = $this->projectConfigProvider->addVarWithItems($config, 'project.aliases', $project["aliases"]);
        }

        return $config;
    }

    /**
     * @return string[]
     */
    public function dependsOn()
    {
        return array("base");
    }

    /**
     * @param \ArrayObject $project
     */
    private function prepareNginxDirectories(\ArrayObject $project)
    {
        $this->processProvider->executeSudoCommand("mkdir -p " . $this->app["config"]["nginx"]["sitesavailable"]);
        $this->processProvider->executeSudoCommand("mkdir -p " . $this->app["config"]["nginx"]["sitesenabled"]);
        $this->processProvider->executeSudoCommand("mkdir -p " . $this->fileSystemProvider->getProjectDirectory($project["name"]) . "/apachelogs");
        $this->processProvider->executeSudoCommand("mkdir -p " . $this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/nginx.d");
    }

    /**
     * @param \ArrayObject $project
     */
    public function prepareApacheDirectories(\ArrayObject $project)
    {
        $this->processProvider->executeSudoCommand("mkdir -p " . $this->app["config"]["apache"]["vhostdir"]);
        $this->processProvider->executeSudoCommand("mkdir -p " . $this->fileSystemProvider->getProjectDirectory($project["name"]) . "/apachelogs");
        $this->processProvider->executeSudoCommand("mkdir -p " . $this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/apache.d");
        $this->processProvider->executeSudoCommand("mkdir -p " . $this->fileSystemProvider->getProjectDirectory($project["name"]) . "/stats");
        $this->processProvider->executeSudoCommand("chmod -R 777 " . $this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/apache.d/");
    }

    /**
     * @param \ArrayObject $project
     * @param $aliases
     */
    private function handleAliases(\ArrayObject &$project, &$aliases)
    {
        // url
        $defaultUrl = $project["name"] . ".be";
        $project["url"] = $this->dialogProvider->askFor("Enter the base url", null, $defaultUrl);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        // url aliases
        $this->generateBasicAliases($project, $aliases);
        $aliases = array();
        if ($this->noInteraction) {
            $this->dialogProvider->logNotice("--no-iteraction selected, using www." . $project["url"]);
            $aliases[] = "www." . $project["url"];
        } else {
            while (1 == 1) {
                $alias = $this->dialogProvider->askFor("Add an url alias (leave empty to stop adding):");
                if (empty($alias)) {
                    break;
                } else {
                    $aliases[] = $alias;
                }
            }
        }
        $project["aliases"] = $aliases;
    }

    /**
     * @param \ArrayObject $project
     * @param $aliases
     */
    private function generateBasicAliases(\ArrayObject &$project, &$aliases)
    {
        $hostmachine = $this->app["config"]["webserver"]["hostmachine"];
        $aliases = (isset($project["aliases"])) ? $project["aliases"] : array();
        $aliases[] = $project["url"];
        $aliases[] = $project["name"] . "." . $hostmachine;
        $aliases[] = "*." . $project["name"] . "." . $hostmachine;
        if ($this->app["config"]["develmode"]) {
            $aliases[] = $project["name"] . ".*.xip.io";
            $aliases[] = "*." . $project["name"] . ".*.xip.io";
        }
    }

    /**
     * @param \ArrayObject $project
     * @return string
     */
    private function processConfigFiles(\ArrayObject $project, $configs)
    {
        $ignoreList = array();
        foreach ($configs as $config) {
            /** @var SplFileInfo $config */
            if ($config->getExtension() == "local") {
                $ignoreList[] = $config->getBasename('.' . $config->getExtension());
            }
        }

        $configcontent = '';
        foreach ($configs as $config) {
            /** @var SplFileInfo $config */
            if ($config->getExtension() == "dist" ){
                $realPathArray = explode("\n", file_get_contents($config->getRealPath()));
                $realPath = $realPathArray[0];
                $path = BASE_DIR . "/templates" . $realPath;
                if (!file_exists($path)){
                    $this->dialogProvider->logError("There is Apache config in a .dist file, or you mistyped the template path, check " . $config);
                }
                $content = $this->fileSystemProvider->renderString(file_get_contents($path), array());
            } else {
                $realPath = $config->getRealPath();
                $content = file_get_contents($realPath);
            }
            if ($config->getExtension() != "local" && in_array($config->getBasename('.'. $config->getExtension()),$ignoreList)){
                $configcontent .= "\n#SKIPPED " . $realPath . " because there was a .local file\n\n";
            } else {
                $configcontent .= "\n#BEGIN " . $realPath . "\n\n";
                $configcontent .= $this->projectConfigProvider->searchReplacer($content, $project) . "\n";
                $configcontent .= "\n#END " . $realPath . "\n\n";
            }
            $this->checkObviousErrors($project, $config, $configcontent);
        }
        return $configcontent;
    }

    /**
     * @param \ArrayObject $project
     * @param SplFileInfo $config
     * @param string $content
     */
    function checkObviousErrors(\ArrayObject $project, SplFileInfo $config, $content){

        // project was not migrated because the 19php.conf file does not contain "proxy:unix:/var/run/php5-fpm"
        if (!$this->app["config"]["develmode"] && strpos($config->getFilename(), "19php") !== FALSE && strpos($content, "proxy:unix:/var/run/php5-fpm") === FALSE){
            $this->dialogProvider->logWarning("The ".$project["name"]." project was not migrated yet, this will NOT work");
        }
    }

    /**
     * @param $aliases
     * @return string
     */
    private function generateAliasLine($aliases, $type)
    {
        $serverName = ($type == 'nginx'?"server_name ":"ServerAlias ");
        foreach ($aliases as $alias) {
            $serverName .= " " . $alias;
        }
        $serverName .= ($type == 'nginx'?";\n":"\n");
        return $serverName;
    }

    /**
     * @param \ArrayObject $project
     * @param $aliases
     */
    public function maintenanceNginx(\ArrayObject $project, $aliases)
    {
        $this->prepareNginxDirectories($project);
        $serverName = $this->generateAliasLine($aliases, $this->app["config"]["webserver"]["engine"]);
        $this->processProvider->executeSudoCommand("rm -f " . $this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/nginx.d/05servername*");
        $finder = new Finder();
        $finder->files()->in($this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/nginx.d/")->name("01-base*");
        if ($finder->count() == 0) {
            $this->fileSystemProvider->writeProtectedFile($this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/nginx.d/05servername", $serverName);
        }
        $configcontent = $this->processConfigFiles($project, $this->fileSystemProvider->getProjectNginxConfigs($project));
        $this->fileSystemProvider->writeProtectedFile($this->app["config"]["nginx"]["sitesavailable"] . "/" . $project["name"] . ".conf", $configcontent);
    }

    /**
     * @param \ArrayObject $project
     * @param $aliases
     */
    private function maintenanceApache(\ArrayObject $project, $aliases)
    {
        $serverAlias = $this->generateAliasLine($aliases, $this->app["config"]["webserver"]["engine"]);
        $this->fileSystemProvider->writeProtectedFile($this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/apache.d/05aliases", $serverAlias);
        if ($this->app["config"]["develmode"]) {
            $this->fileSystemProvider->writeProtectedFile($this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/apache.d/06devmode", "SetEnv APP_ENV dev");
        } else {
            $this->processProvider->executeSudoCommand("rm -f " . $this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/apache.d/06devmode");
        }
        $configcontent = $this->processConfigFiles($project, $this->fileSystemProvider->getProjectApacheConfigs($project));
        if ($this->app["config"]["develmode"]) {
            $configcontent = str_replace("-Indexes", "+Indexes", $configcontent);
        }
        $this->fileSystemProvider->writeProtectedFile($this->app["config"]["apache"]["sitesavailable"] . "/" . $project["name"] . ".conf", $configcontent);
    }

    /**
     * @return bool
     */
    private function isWebserverNginx()
    {
        return $this->app["config"]["webserver"]["engine"] == 'nginx';
    }

}


1		<?php
2		namespace Kunstmaan\Skylab\Skeleton;
3
4		use Kunstmaan\Skylab\Exceptions\SkylabException;
5		use Symfony\Component\Finder\Finder;
6		use Symfony\Component\Finder\SplFileInfo;
7
8		/**
9		* ApacheSkeleton
10		*/
11		class WebserverSkeleton extends AbstractSkeleton
12		{
13
14		const NAME = "apache";
15
16		/**
17		* @param \ArrayObject $project
18		*
19		* @return mixed
20		*/
21		public function create(\ArrayObject $project)
22		{
23		$this->handleAliases($project, $aliases);
24		// nginx
25		$this->prepareNginxDirectories($project);
26		$this->fileSystemProvider->renderConfig($this->fileSystemProvider->getNginxConfigTemplateDir(),$this->fileSystemProvider->getNginxConfigTemplateDir(true),$this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/nginx.d/");
27		// apache
28		$this->prepareApacheDirectories($project);
29		$this->fileSystemProvider->renderDistConfig($this->fileSystemProvider->getApacheConfigTemplateDir(),$this->fileSystemProvider->getApacheConfigTemplateDir(true),$this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/apache.d/");
30		}
31
32		/**
33		* @return mixed
34		*/
35		public function preMaintenance()
36		{
37		if ($this->isWebserverNginx()) {
38		$this->processProvider->executeSudoCommand("rm -Rf " . $this->app["config"]["nginx"]["sitesavailable"] . "/*");
39		$this->processProvider->executeSudoCommand("rm -Rf " . $this->app["config"]["nginx"]["sitesenabled"] . "/*");
40		} else {
41		$this->processProvider->executeSudoCommand("rm -Rf " . $this->app["config"]["apache"]["sitesavailable"] . "/*");
42		$this->processProvider->executeSudoCommand("rm -Rf " . $this->app["config"]["apache"]["sitesenabled"] . "/*");
43		}
44		}
45
46		/**
47		* @param \ArrayObject $project
48		*
49		* @return mixed
50		*/
51		public function maintenance(\ArrayObject $project)
52		{
53		if ($this->app["config"]["develmode"] \|\| !file_exists($this->fileSystemProvider->getProjectDirectory($project["name"]) . "/data/current")) {
54		if (!is_dir($this->fileSystemProvider->getProjectDirectory($project["name"]) . "/data/current")){
55		$this->processProvider->executeSudoCommand("rm -f " . $this->fileSystemProvider->getProjectDirectory($project["name"]) . "/data/current");
56		$this->processProvider->executeSudoCommand("ln -sf " . $this->fileSystemProvider->getProjectDirectory($project["name"]) . "/data/" . $project["name"] . "/ " . $this->fileSystemProvider->getProjectDirectory($project["name"]) . "/data/current");
57		}
58		}
59
60	View Code Duplication	if (PHP_OS == "Darwin") {
		0 ignored issues – show Duplication introduced 2015-11-23 11:12 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
61		$this->processProvider->executeSudoCommand('find ' . $this->fileSystemProvider->getProjectDirectory($project["name"]) . '/data/current -type d -name .git -exec cd {} "\;" -exec git config core.filemode false "\;"');
62		} else {
63		$this->processProvider->executeSudoCommand('find ' . $this->fileSystemProvider->getProjectDirectory($project["name"]) . '/data/current -type d -name .git -exec cd {} \; -exec git config core.filemode false \;');
64		}
65
66		$this->dialogProvider->logConfig("Updating aliases webserver config file");
67		$this->generateBasicAliases($project, $aliases);
68
69		if ($this->isWebserverNginx()) {
70		$this->maintenanceNginx($project, $aliases);
71		} else {
72		$this->maintenanceApache($project, $aliases);
73		}
74		}
75
76		/**
77		* @return mixed
78		*/
79		public function postMaintenance()
80		{
81		$this->writeToHostFile();
82		if ($this->isWebserverNginx()) {
83		$finder = new Finder();
84		$finder->files()->in($this->app["config"]["nginx"]["sitesavailable"])->name("*.conf");
85		/** @var SplFileInfo $config */
86	View Code Duplication	foreach ($finder as $config) {
		0 ignored issues – show Duplication introduced 2016-01-05 15:07 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
87		$this->processProvider->executeSudoCommand("ln -sf " . $this->app["config"]["nginx"]["sitesavailable"] . "/" . $config->getFilename() . " " . $this->app["config"]["nginx"]["sitesenabled"] . "/" . $config->getFilename());
88		}
89		} else {
90		$this->writeToFirstHostFile();
91		$finder = new Finder();
92		$finder->files()->in($this->app["config"]["apache"]["sitesavailable"])->name("*.conf");
93		/** @var SplFileInfo $config */
94	View Code Duplication	foreach ($finder as $config) {
		0 ignored issues – show Duplication introduced 2016-01-05 15:07 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
95		$this->processProvider->executeSudoCommand("ln -sf " . $this->app["config"]["apache"]["sitesavailable"] . "/" . $config->getFilename() . " " . $this->app["config"]["apache"]["sitesenabled"] . "/" . $config->getFilename());
96		}
97		}
98		}
99
100		private function writeToFirstHostFile()
101		{
102		$this->fileSystemProvider->render("/apache/000firsthost.conf.twig", $this->app["config"]["apache"]["sitesavailable"] . "/000firsthost.conf", array(
103		'admin' => $this->app["config"]["apache"]["admin"]
104		));
105		}
106
107		private function writeToHostFile()
108		{
109		$hostlines = array();
110		$dialogProvider = $this->dialogProvider;
111		$this->fileSystemProvider->projectsLoop(function ($project) use (&$hostlines, $dialogProvider) {
112		$hostlines[] = $this->app["config"]["webserver"]["localip"] . " " . $project["name"] . "." . $this->app["config"]["webserver"]["hostmachine"] . " www." . $project["name"] . "." . $this->app["config"]["webserver"]["hostmachine"] . "\n";
113		});
114		$this->dialogProvider->logTask("Updating the /etc/hosts file (add lines)");
115		$hostsfile = file("/etc/hosts");
116		$resultLines = array();
117		$foundSection = false;
118		$inSection = false;
119		foreach ($hostsfile as $line) {
120		if (!$inSection) {
121		if (strpos($line, "#KDEPLOY_start") === 0) {
122		$inSection = true;
123		$foundSection = true;
124		$resultLines[] = $line;
125		$resultLines = array_merge($resultLines, $hostlines);
126		} else {
127		$resultLines[] = $line;
128		}
129		} else {
130		if (strpos($line, "#KDEPLOY_end") === 0) {
131		$inSection = false;
132		$resultLines[] = $line;
133		}
134		}
135		}
136		if (!$foundSection) {
137		$resultLines[] = "#KDEPLOY_start autogenerated section. do not edit below this line. do not remove this line.\n";
138		$resultLines = array_merge($resultLines, $hostlines);
139		$resultLines[] = "#KDEPLOY_end autogenerated section. do not edit above this line. do not remove this line.\n";
140		}
141		$this->fileSystemProvider->writeProtectedFile("/etc/hosts", implode("", $resultLines));
142		}
143
144		/**
145		* @param \ArrayObject $project
146		*/
147		private function removeFromHostFile(\ArrayObject $project)
148		{
149
150		$hostlines[] = $this->app["config"]["webserver"]["localip"] . " " . $project["name"] . "." . $this->app["config"]["webserver"]["hostmachine"] . " www." . $project["name"] . "." . $this->app["config"]["webserver"]["hostmachine"] . "\n";
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-05 15:07 UTC by Report Bug Copy Issue Report `$hostlines` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$hostlines = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
151
152		$this->dialogProvider->logTask("Updating the /etc/hosts file (remove lines)");
153		$hostsfile = file("/etc/hosts");
154		$resultLines = array();
155
156		foreach ($hostsfile as $line) {
157		if (!in_array($line, $hostlines)) {
158		$resultLines[] = $line;
159		}
160		}
161
162		$this->fileSystemProvider->writeProtectedFile("/etc/hosts", implode("", $resultLines));
163		}
164
165		/**
166		* @return string
167		*/
168		public function getName()
169		{
170		return self::NAME;
171		}
172
173		/**
174		* @param \ArrayObject $project
175		*
176		* @return mixed
177		*/
178		public function preBackup(\ArrayObject $project)
179		{
180		}
181
182		/**
183		* @param \ArrayObject $project
184		*
185		* @return mixed
186		*/
187		public function postBackup(\ArrayObject $project)
188		{
189		}
190
191		/**
192		* @param \ArrayObject $project
193		*
194		* @return mixed
195		*/
196		public function preRemove(\ArrayObject $project)
197		{
198		}
199
200		/**
201		* @param \ArrayObject $project
202		*
203		* @return mixed
204		*/
205		public function postRemove(\ArrayObject $project)
206		{
207		$this->removeFromHostFile($project);
208
209		if ($this->isWebserverNginx()) {
210		$this->processProvider->executeSudoCommand("rm -f ".$this->app["config"]["nginx"]["sitesenabled"] . "/" . $project["name"] . ".conf");
211		$this->processProvider->executeSudoCommand("rm -f ".$this->app["config"]["nginx"]["sitesavailable"] . "/" . $project["name"] . ".conf");
212		}
213		else{
214		$this->processProvider->executeSudoCommand("rm -f ".$this->app["config"]["apache"]["sitesenabled"] . "/" . $project["name"] . ".conf");
215		$this->processProvider->executeSudoCommand("rm -f ".$this->app["config"]["apache"]["sitesavailable"] . "/" . $project["name"] . ".conf");
216		}
217
218		if (PHP_OS == "Darwin") {
219		$this->processProvider->executeSudoCommand("apachectl -k restart");
220		}
221		else{
222		if ($this->isWebserverNginx()) {
223		$this->processProvider->executeSudoCommand("service nginx reload");
224		} else {
225		$this->processProvider->executeSudoCommand("service apache2 reload");
226		}
227		}
228
229		}
230
231		/**
232		* @param \ArrayObject $project
233		* @param \SimpleXMLElement $config The configuration array
234		* @return \SimpleXMLElement
235		*/
236		public function writeConfig(\ArrayObject $project, \SimpleXMLElement $config)
237		{
238		$config = $this->projectConfigProvider->addVar($config, 'project.url', $project["url"]);
239		if (isset($project["aliases"])) {
240		$config = $this->projectConfigProvider->addVarWithItems($config, 'project.aliases', $project["aliases"]);
241		}
242
243		return $config;
244		}
245
246		/**
247		* @return string[]
248		*/
249		public function dependsOn()
250		{
251		return array("base");
252		}
253
254		/**
255		* @param \ArrayObject $project
256		*/
257		private function prepareNginxDirectories(\ArrayObject $project)
258		{
259		$this->processProvider->executeSudoCommand("mkdir -p " . $this->app["config"]["nginx"]["sitesavailable"]);
260		$this->processProvider->executeSudoCommand("mkdir -p " . $this->app["config"]["nginx"]["sitesenabled"]);
261		$this->processProvider->executeSudoCommand("mkdir -p " . $this->fileSystemProvider->getProjectDirectory($project["name"]) . "/apachelogs");
262		$this->processProvider->executeSudoCommand("mkdir -p " . $this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/nginx.d");
263		}
264
265		/**
266		* @param \ArrayObject $project
267		*/
268		public function prepareApacheDirectories(\ArrayObject $project)
269		{
270		$this->processProvider->executeSudoCommand("mkdir -p " . $this->app["config"]["apache"]["vhostdir"]);
271		$this->processProvider->executeSudoCommand("mkdir -p " . $this->fileSystemProvider->getProjectDirectory($project["name"]) . "/apachelogs");
272		$this->processProvider->executeSudoCommand("mkdir -p " . $this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/apache.d");
273		$this->processProvider->executeSudoCommand("mkdir -p " . $this->fileSystemProvider->getProjectDirectory($project["name"]) . "/stats");
274		$this->processProvider->executeSudoCommand("chmod -R 777 " . $this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/apache.d/");
275		}
276
277		/**
278		* @param \ArrayObject $project
279		* @param $aliases
280		*/
281		private function handleAliases(\ArrayObject &$project, &$aliases)
282		{
283		// url
284		$defaultUrl = $project["name"] . ".be";
285		$project["url"] = $this->dialogProvider->askFor("Enter the base url", null, $defaultUrl);
		1 ignored issue – show Documentation introduced 2015-11-23 11:12 UTC by Report Bug Copy Issue Report `$defaultUrl` is of type `string`, but the function expects a `null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
286		// url aliases
287		$this->generateBasicAliases($project, $aliases);
288		$aliases = array();
289		if ($this->noInteraction) {
290		$this->dialogProvider->logNotice("--no-iteraction selected, using www." . $project["url"]);
291		$aliases[] = "www." . $project["url"];
292		} else {
293		while (1 == 1) {
294		$alias = $this->dialogProvider->askFor("Add an url alias (leave empty to stop adding):");
295		if (empty($alias)) {
296		break;
297		} else {
298		$aliases[] = $alias;
299		}
300		}
301		}
302		$project["aliases"] = $aliases;
303		}
304
305		/**
306		* @param \ArrayObject $project
307		* @param $aliases
308		*/
309		private function generateBasicAliases(\ArrayObject &$project, &$aliases)
310		{
311		$hostmachine = $this->app["config"]["webserver"]["hostmachine"];
312		$aliases = (isset($project["aliases"])) ? $project["aliases"] : array();
313		$aliases[] = $project["url"];
314		$aliases[] = $project["name"] . "." . $hostmachine;
315		$aliases[] = "*." . $project["name"] . "." . $hostmachine;
316		if ($this->app["config"]["develmode"]) {
317		$aliases[] = $project["name"] . ".*.xip.io";
318		$aliases[] = "." . $project["name"] . "..xip.io";
319		}
320		}
321
322		/**
323		* @param \ArrayObject $project
324		* @return string
325		*/
326		private function processConfigFiles(\ArrayObject $project, $configs)
327		{
328		$ignoreList = array();
329		foreach ($configs as $config) {
330		/** @var SplFileInfo $config */
331		if ($config->getExtension() == "local") {
332		$ignoreList[] = $config->getBasename('.' . $config->getExtension());
333		}
334		}
335
336		$configcontent = '';
337		foreach ($configs as $config) {
338		/** @var SplFileInfo $config */
339		if ($config->getExtension() == "dist" ){
340		$realPathArray = explode("\n", file_get_contents($config->getRealPath()));
341		$realPath = $realPathArray[0];
342		$path = BASE_DIR . "/templates" . $realPath;
343		if (!file_exists($path)){
344		$this->dialogProvider->logError("There is Apache config in a .dist file, or you mistyped the template path, check " . $config);
345		}
346		$content = $this->fileSystemProvider->renderString(file_get_contents($path), array());
347		} else {
348		$realPath = $config->getRealPath();
349		$content = file_get_contents($realPath);
350		}
351		if ($config->getExtension() != "local" && in_array($config->getBasename('.'. $config->getExtension()),$ignoreList)){
352		$configcontent .= "\n#SKIPPED " . $realPath . " because there was a .local file\n\n";
353		} else {
354		$configcontent .= "\n#BEGIN " . $realPath . "\n\n";
355		$configcontent .= $this->projectConfigProvider->searchReplacer($content, $project) . "\n";
356		$configcontent .= "\n#END " . $realPath . "\n\n";
357		}
358		$this->checkObviousErrors($project, $config, $configcontent);
359		}
360		return $configcontent;
361		}
362
363		/**
364		* @param \ArrayObject $project
365		* @param SplFileInfo $config
366		* @param string $content
367		*/
368		function checkObviousErrors(\ArrayObject $project, SplFileInfo $config, $content){
		0 ignored issues – show Best Practice introduced 2015-11-23 11:12 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
369		// project was not migrated because the 19php.conf file does not contain "proxy:unix:/var/run/php5-fpm"
370		if (!$this->app["config"]["develmode"] && strpos($config->getFilename(), "19php") !== FALSE && strpos($content, "proxy:unix:/var/run/php5-fpm") === FALSE){
371		$this->dialogProvider->logWarning("The ".$project["name"]." project was not migrated yet, this will NOT work");
372		}
373		}
374
375		/**
376		* @param $aliases
377		* @return string
378		*/
379		private function generateAliasLine($aliases, $type)
380		{
381		$serverName = ($type == 'nginx'?"server_name ":"ServerAlias ");
382		foreach ($aliases as $alias) {
383		$serverName .= " " . $alias;
384		}
385		$serverName .= ($type == 'nginx'?";\n":"\n");
386		return $serverName;
387		}
388
389		/**
390		* @param \ArrayObject $project
391		* @param $aliases
392		*/
393		public function maintenanceNginx(\ArrayObject $project, $aliases)
394		{
395		$this->prepareNginxDirectories($project);
396		$serverName = $this->generateAliasLine($aliases, $this->app["config"]["webserver"]["engine"]);
397		$this->processProvider->executeSudoCommand("rm -f " . $this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/nginx.d/05servername*");
398		$finder = new Finder();
399		$finder->files()->in($this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/nginx.d/")->name("01-base*");
400		if ($finder->count() == 0) {
401		$this->fileSystemProvider->writeProtectedFile($this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/nginx.d/05servername", $serverName);
402		}
403		$configcontent = $this->processConfigFiles($project, $this->fileSystemProvider->getProjectNginxConfigs($project));
404		$this->fileSystemProvider->writeProtectedFile($this->app["config"]["nginx"]["sitesavailable"] . "/" . $project["name"] . ".conf", $configcontent);
405		}
406
407		/**
408		* @param \ArrayObject $project
409		* @param $aliases
410		*/
411		private function maintenanceApache(\ArrayObject $project, $aliases)
412		{
413		$serverAlias = $this->generateAliasLine($aliases, $this->app["config"]["webserver"]["engine"]);
414		$this->fileSystemProvider->writeProtectedFile($this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/apache.d/05aliases", $serverAlias);
415		if ($this->app["config"]["develmode"]) {
416		$this->fileSystemProvider->writeProtectedFile($this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/apache.d/06devmode", "SetEnv APP_ENV dev");
417		} else {
418		$this->processProvider->executeSudoCommand("rm -f " . $this->fileSystemProvider->getProjectConfigDirectory($project["name"]) . "/apache.d/06devmode");
419		}
420		$configcontent = $this->processConfigFiles($project, $this->fileSystemProvider->getProjectApacheConfigs($project));
421		if ($this->app["config"]["develmode"]) {
422		$configcontent = str_replace("-Indexes", "+Indexes", $configcontent);
423		}
424		$this->fileSystemProvider->writeProtectedFile($this->app["config"]["apache"]["sitesavailable"] . "/" . $project["name"] . ".conf", $configcontent);
425		}
426
427		/**
428		* @return bool
429		*/
430		private function isWebserverNginx()
431		{
432		return $this->app["config"]["webserver"]["engine"] == 'nginx';
433		}
434
435		}
436

Kunstmaan / skylab

GitHub Access Token became invalid

Pull Request — master (#114)

WebserverSkeleton::writeToFirstHostFile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like