FileSystemProvider - Code Metrics - Kunstmaan/skylab - Measure and Improve Code Quality continuously with Scrutinizer

FileSystemProvider A
last analyzed 2016-07-01 08:46 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	325
Duplicated Lines	15.38 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
wmc	35
c	1
b	1
f	0
lcom	1
cbo	7
dl	50
loc	325
rs	9

26 Methods

Rating	Name	Duplication	Size	Complexity
A	writeProtectedFile()	0	7	2
A	register()	0	5	1
A	getProjects()	0	14	1
A	getDotDFiles()	0	7	1
A	projectExists()	0	7	1
A	getProjectConfigDirectory()	0	4	1
A	getProjectDirectory()	0	4	1
A	createProjectDirectory()	0	5	1
A	createDirectory()	0	5	1
A	getDirectory()	0	6	1
A	runTar()	0	10	2
A	removeProjectDirectory()	0	8	2
A	getApacheConfigTemplateDir()	0	4	1
A	getConfigTemplateDir()	0	4	2
A	getCustomConfigTemplateDir()	0	4	2
A	getNginxConfigTemplateDir()	0	4	2
A	projectsLoop()	0	10	2
A	getProjectApacheConfigs()	16	16	1
A	getProjectNginxConfigs()	16	16	1
A	render()	0	7	1
A	renderDist()	0	6	1
A	renderString()	0	4	1
A	renderSingleConfig()	0	7	1
A	renderSingleDistConfig()	0	7	1
A	renderConfig()	9	9	2
A	renderDistConfig()	9	9	2

How to fix Duplicated Code

<?php
namespace Kunstmaan\Skylab\Provider;

use RuntimeException;
use Cilex\Application;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;

/**
 * FileSystemProvider
 */
class FileSystemProvider extends AbstractProvider
{

    /**
     * Registers services on the given app.
     *
     * @param Application $app An Application instance
     */
    public function register(Application $app)
    {
        $app['filesystem'] = $this;
        $this->app = $app;
    }

    /**
     * @return SplFileInfo[]
     */
    public function getProjects()
    {
        $finder = new Finder();
        $finder
            ->directories()
            ->sortByName()
            ->in($this->app["config"]["projects"]["path"])
            ->depth('== 0')
            ->filter(function (\SplFileInfo $file) {
                return file_exists($file->getRealPath() . "/conf/config.xml");
            });

        return iterator_to_array($finder);
    }

    /**
     * @param string $path
     * @return SplFileInfo[]
     */
    public function getDotDFiles($path)
    {
        $finder = new Finder();
        $finder->files()->sortByName()->in($path)->depth('== 0');

        return iterator_to_array($finder);
    }

    /**
     * @param  string $projectname
     * @return bool
     */
    public function projectExists($projectname)
    {
        $finder = new Finder();
        $finder->directories()->sortByName()->in($this->app["config"]["projects"]["path"])->depth('== 0')->name($projectname);

        return $finder->count() != 0;
    }

    /**
     * @param string $projectname
     *
     * @return string
     */
    public function getProjectConfigDirectory($projectname)
    {
        return $this->getProjectDirectory($projectname) . "/conf";
    }

    /**
     * @param string $projectname
     *
     * @return string
     */
    public function getProjectDirectory($projectname)
    {
        return $this->app["config"]["projects"]["path"] . '/' . $projectname;
    }

    /**
     * @param string $projectname The project name
     */
    public function createProjectDirectory($projectname)
    {
        $projectDirectory = $this->getProjectDirectory($projectname);
        $this->processProvider->executeSudoCommand('mkdir -p ' . $projectDirectory);
    }

    /**
     * @param \ArrayObject $project The project
     * @param string $path The relative path in the project folder
     */
    public function createDirectory(\ArrayObject $project, $path)
    {
        $projectDirectory = $this->getProjectDirectory($project["name"]);
        $this->processProvider->executeSudoCommand('mkdir -p ' . $projectDirectory . '/' . $path);
    }

    /**
     * @param \ArrayObject $project The project
     * @param string $path The relative path in the project folder
     *
     * @return string
     */
    public function getDirectory(\ArrayObject $project, $path)
    {
        $projectDirectory = $this->getProjectDirectory($project["name"]);

        return $projectDirectory . '/' . $path;
    }

    /**
     * @param \ArrayObject $project The project
     */
    public function runTar(\ArrayObject $project)
    {
        $this->processProvider->executeSudoCommand('mkdir -p ' . $this->app["config"]["projects"]["backuppath"]);
        $projectDirectory = $this->getProjectDirectory($project["name"]);
        $excluded = '';
        foreach ($project["backupexcludes"] as $backupexclude) {
            $excluded = $excluded . " --exclude='" . $backupexclude . "'";
        }
        $this->processProvider->executeSudoCommand('nice -n 19 tar --create --absolute-names ' . $excluded . ' --file ' . $this->app["config"]["projects"]["backuppath"] . '/' . $project["name"] . '.tar.gz --totals --gzip ' . $projectDirectory . '/ 2>&1');
    }

    /**
     * @param \ArrayObject $project The project
     */
    public function removeProjectDirectory(\ArrayObject $project)
    {
        if (empty($project["dir"])) {
            throw new RuntimeException("The project has no name");
        }
        $projectDirectory = $this->getProjectDirectory($project["name"]);
        $this->processProvider->executeSudoCommand("rm -Rf " . $projectDirectory);
    }

    /**
     * @return string
     */
    public function getApacheConfigTemplateDir($clean = false)
    {
        return $this->getConfigTemplateDir("apache", $clean);
    }

    /**
     * @return string
     */
    public function getConfigTemplateDir($skeletonName, $clean = false)
    {
        return ($clean ? "/" . $skeletonName . "/apache.d/" : BASE_DIR . "/templates/" . $skeletonName . "/apache.d/");
    }

    /**
     * @return string
     */
    public function getCustomConfigTemplateDir($skeletonName, $clean = false)
    {
        return ($clean ? "/" . $skeletonName . "/custom.d/" : BASE_DIR . "/templates/" . $skeletonName . "/custom.d/");
    }

    /**
     * @return string
     */
    public function getNginxConfigTemplateDir($clean = false)
    {
        return ($clean ? "/nginx/nginx.d/" : BASE_DIR . "/templates/nginx/nginx.d/");
    }

    /**
     * @param \Closure $callback
     */
    public function projectsLoop($callback)
    {
        $projects = $this->getProjects();
        foreach ($projects as $projectFile) {
            /** @var $projectFile SplFileInfo */
            $projectname = $projectFile->getFilename();
            $project = $this->projectConfigProvider->loadProjectConfig($projectname);
            $callback($project);
        }
    }

    /**
     * @param  \ArrayObject $project
     * @return array
     */
    public function getProjectApacheConfigs(\ArrayObject $project)

    {
        $finder = new Finder();
        $finder->files()
            ->sortByName()
            ->in($this->getProjectConfigDirectory($project["name"]) . "/apache.d/")
            ->ignoreVCS(true)
            ->ignoreDotFiles(true)
            ->notName("*~")
            ->notName("*.swp")
            ->notName("*.bak")
            ->notName("*-")
            ->depth('== 0');

        return iterator_to_array($finder);
    }

    /**
     * @param  \ArrayObject $project
     * @return array
     */
    public function getProjectNginxConfigs(\ArrayObject $project)

    {
        $finder = new Finder();
        $finder->files()
            ->sortByName()
            ->in($this->getProjectConfigDirectory($project["name"]) . "/nginx.d/")
            ->ignoreVCS(true)
            ->ignoreDotFiles(true)
            ->notName("*~")
            ->notName("*.swp")
            ->notName("*.bak")
            ->notName("*-")
            ->depth('== 0');

        return iterator_to_array($finder);
    }

    /**
     * @param $path
     * @param $content
     */
    public function writeProtectedFile($path, $content, $append=false)
    {
        $tmpfname = tempnam(sys_get_temp_dir(), "skylab");
        file_put_contents($tmpfname, $content);
        $this->processProvider->executeSudoCommand("cat " . $tmpfname . " | sudo tee " . ($append?"-a ":"") . $path);
        $this->processProvider->executeSudoCommand("rm -f " . $tmpfname);
    }

    /**
     * @param string $sourcePath
     * @param string $destinationPath
     * @param string[] $variables
     */
    public function render($sourcePath, $destinationPath, $variables = array())
    {
        $this->dialogProvider->logConfig("Rendering " . $sourcePath . " to " . $destinationPath);
        $this->processProvider->executeSudoCommand('mkdir -p ' . dirname($destinationPath));
        $content = $this->renderString(file_get_contents(BASE_DIR . "/templates" . $sourcePath), $variables);
        $this->writeProtectedFile($destinationPath, $content);
    }

    /**
     * @param string $sourcePath
     * @param string $destinationPath
     * @param string[] $variables
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function renderDist($sourcePath, $destinationPath)
    {
        $this->dialogProvider->logConfig("Dist rendering " . $sourcePath . " to " . $destinationPath);
        $this->processProvider->executeSudoCommand('mkdir -p ' . dirname($destinationPath));
        $this->writeProtectedFile($destinationPath, $sourcePath);
    }

    /**
     * @param $content
     * @param $variables
     * @return string
     */
    public function renderString($content, $variables)
    {
        return $this->twig->render($content, $variables);
    }

    /**
     * @param $cleanedLocation
     * @param $target
     * @param SplFileInfo $config
     */
    public function renderSingleConfig($cleanedLocation, $target, $config)
    {
        $this->fileSystemProvider->render(
            $cleanedLocation . $config->getFilename(),
            $target . str_replace(".conf.twig", ".conf", $config->getFilename())
        );
    }

    /**
     * @param $cleanedLocation
     * @param $target
     * @param SplFileInfo $config
     */
    public function renderSingleDistConfig($cleanedLocation, $target, $config)
    {
        $this->fileSystemProvider->renderDist(
            $cleanedLocation . $config->getFilename(),
            $target . str_replace(".conf.twig", ".dist", $config->getFilename())
        );
    }

    /**
     * @param $location
     * @param $cleanedLocation
     * @param $target
     */
    public function renderConfig($location, $cleanedLocation, $target)

    {
        // render templates
        $finder = new Finder();
        $finder->files()->in($location)->name("*.conf.twig");
        foreach ($finder as $config) {
            $this->renderSingleConfig($cleanedLocation, $target, $config);
        }
    }

    /**
     * @param $location
     * @param $cleanedLocation
     * @param $target
     */
    public function renderDistConfig($location, $cleanedLocation, $target)

    {
        // render templates
        $finder = new Finder();
        $finder->files()->in($location)->name("*.conf.twig");
        foreach ($finder as $config) {
            $this->renderSingleDistConfig($cleanedLocation, $target, $config);
        }
    }
}


1		<?php
2		namespace Kunstmaan\Skylab\Provider;
3
4		use RuntimeException;
5		use Cilex\Application;
6		use Symfony\Component\Finder\Finder;
7		use Symfony\Component\Finder\SplFileInfo;
8
9		/**
10		* FileSystemProvider
11		*/
12		class FileSystemProvider extends AbstractProvider
13		{
14
15		/**
16		* Registers services on the given app.
17		*
18		* @param Application $app An Application instance
19		*/
20		public function register(Application $app)
21		{
22		$app['filesystem'] = $this;
23		$this->app = $app;
24		}
25
26		/**
27		* @return SplFileInfo[]
28		*/
29		public function getProjects()
30		{
31		$finder = new Finder();
32		$finder
33		->directories()
34		->sortByName()
35		->in($this->app["config"]["projects"]["path"])
36		->depth('== 0')
37		->filter(function (\SplFileInfo $file) {
38		return file_exists($file->getRealPath() . "/conf/config.xml");
39		});
40
41		return iterator_to_array($finder);
42		}
43
44		/**
45		* @param string $path
46		* @return SplFileInfo[]
47		*/
48		public function getDotDFiles($path)
49		{
50		$finder = new Finder();
51		$finder->files()->sortByName()->in($path)->depth('== 0');
52
53		return iterator_to_array($finder);
54		}
55
56		/**
57		* @param string $projectname
58		* @return bool
59		*/
60		public function projectExists($projectname)
61		{
62		$finder = new Finder();
63		$finder->directories()->sortByName()->in($this->app["config"]["projects"]["path"])->depth('== 0')->name($projectname);
64
65		return $finder->count() != 0;
66		}
67
68		/**
69		* @param string $projectname
70		*
71		* @return string
72		*/
73		public function getProjectConfigDirectory($projectname)
74		{
75		return $this->getProjectDirectory($projectname) . "/conf";
76		}
77
78		/**
79		* @param string $projectname
80		*
81		* @return string
82		*/
83		public function getProjectDirectory($projectname)
84		{
85		return $this->app["config"]["projects"]["path"] . '/' . $projectname;
86		}
87
88		/**
89		* @param string $projectname The project name
90		*/
91		public function createProjectDirectory($projectname)
92		{
93		$projectDirectory = $this->getProjectDirectory($projectname);
94		$this->processProvider->executeSudoCommand('mkdir -p ' . $projectDirectory);
95		}
96
97		/**
98		* @param \ArrayObject $project The project
99		* @param string $path The relative path in the project folder
100		*/
101		public function createDirectory(\ArrayObject $project, $path)
102		{
103		$projectDirectory = $this->getProjectDirectory($project["name"]);
104		$this->processProvider->executeSudoCommand('mkdir -p ' . $projectDirectory . '/' . $path);
105		}
106
107		/**
108		* @param \ArrayObject $project The project
109		* @param string $path The relative path in the project folder
110		*
111		* @return string
112		*/
113		public function getDirectory(\ArrayObject $project, $path)
114		{
115		$projectDirectory = $this->getProjectDirectory($project["name"]);
116
117		return $projectDirectory . '/' . $path;
118		}
119
120		/**
121		* @param \ArrayObject $project The project
122		*/
123		public function runTar(\ArrayObject $project)
124		{
125		$this->processProvider->executeSudoCommand('mkdir -p ' . $this->app["config"]["projects"]["backuppath"]);
126		$projectDirectory = $this->getProjectDirectory($project["name"]);
127		$excluded = '';
128		foreach ($project["backupexcludes"] as $backupexclude) {
129		$excluded = $excluded . " --exclude='" . $backupexclude . "'";
130		}
131		$this->processProvider->executeSudoCommand('nice -n 19 tar --create --absolute-names ' . $excluded . ' --file ' . $this->app["config"]["projects"]["backuppath"] . '/' . $project["name"] . '.tar.gz --totals --gzip ' . $projectDirectory . '/ 2>&1');
132		}
133
134		/**
135		* @param \ArrayObject $project The project
136		*/
137		public function removeProjectDirectory(\ArrayObject $project)
138		{
139		if (empty($project["dir"])) {
140		throw new RuntimeException("The project has no name");
141		}
142		$projectDirectory = $this->getProjectDirectory($project["name"]);
143		$this->processProvider->executeSudoCommand("rm -Rf " . $projectDirectory);
144		}
145
146		/**
147		* @return string
148		*/
149		public function getApacheConfigTemplateDir($clean = false)
150		{
151		return $this->getConfigTemplateDir("apache", $clean);
152		}
153
154		/**
155		* @return string
156		*/
157		public function getConfigTemplateDir($skeletonName, $clean = false)
158		{
159		return ($clean ? "/" . $skeletonName . "/apache.d/" : BASE_DIR . "/templates/" . $skeletonName . "/apache.d/");
160		}
161
162		/**
163		* @return string
164		*/
165		public function getCustomConfigTemplateDir($skeletonName, $clean = false)
166		{
167		return ($clean ? "/" . $skeletonName . "/custom.d/" : BASE_DIR . "/templates/" . $skeletonName . "/custom.d/");
168		}
169
170		/**
171		* @return string
172		*/
173		public function getNginxConfigTemplateDir($clean = false)
174		{
175		return ($clean ? "/nginx/nginx.d/" : BASE_DIR . "/templates/nginx/nginx.d/");
176		}
177
178		/**
179		* @param \Closure $callback
180		*/
181		public function projectsLoop($callback)
182		{
183		$projects = $this->getProjects();
184		foreach ($projects as $projectFile) {
185		/** @var $projectFile SplFileInfo */
186		$projectname = $projectFile->getFilename();
187		$project = $this->projectConfigProvider->loadProjectConfig($projectname);
188		$callback($project);
189		}
190		}
191
192		/**
193		* @param \ArrayObject $project
194		* @return array
195		*/
196	View Code Duplication	public function getProjectApacheConfigs(\ArrayObject $project)
		0 ignored issues – show Duplication introduced 2015-11-23 11:12 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
197		{
198		$finder = new Finder();
199		$finder->files()
200		->sortByName()
201		->in($this->getProjectConfigDirectory($project["name"]) . "/apache.d/")
202		->ignoreVCS(true)
203		->ignoreDotFiles(true)
204		->notName("*~")
205		->notName("*.swp")
206		->notName("*.bak")
207		->notName("*-")
208		->depth('== 0');
209
210		return iterator_to_array($finder);
211		}
212
213		/**
214		* @param \ArrayObject $project
215		* @return array
216		*/
217	View Code Duplication	public function getProjectNginxConfigs(\ArrayObject $project)
		0 ignored issues – show Duplication introduced 2015-11-23 11:12 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
218		{
219		$finder = new Finder();
220		$finder->files()
221		->sortByName()
222		->in($this->getProjectConfigDirectory($project["name"]) . "/nginx.d/")
223		->ignoreVCS(true)
224		->ignoreDotFiles(true)
225		->notName("*~")
226		->notName("*.swp")
227		->notName("*.bak")
228		->notName("*-")
229		->depth('== 0');
230
231		return iterator_to_array($finder);
232		}
233
234		/**
235		* @param $path
236		* @param $content
237		*/
238		public function writeProtectedFile($path, $content, $append=false)
239		{
240		$tmpfname = tempnam(sys_get_temp_dir(), "skylab");
241		file_put_contents($tmpfname, $content);
242		$this->processProvider->executeSudoCommand("cat " . $tmpfname . " \| sudo tee " . ($append?"-a ":"") . $path);
243		$this->processProvider->executeSudoCommand("rm -f " . $tmpfname);
244		}
245
246		/**
247		* @param string $sourcePath
248		* @param string $destinationPath
249		* @param string[] $variables
250		*/
251		public function render($sourcePath, $destinationPath, $variables = array())
252		{
253		$this->dialogProvider->logConfig("Rendering " . $sourcePath . " to " . $destinationPath);
254		$this->processProvider->executeSudoCommand('mkdir -p ' . dirname($destinationPath));
255		$content = $this->renderString(file_get_contents(BASE_DIR . "/templates" . $sourcePath), $variables);
256		$this->writeProtectedFile($destinationPath, $content);
257		}
258
259		/**
260		* @param string $sourcePath
261		* @param string $destinationPath
262		* @param string[] $variables
		0 ignored issues – show Bug introduced 2015-11-23 11:12 UTC by Report Bug Copy Issue Report There is no parameter named `$variables`. 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...
263		*/
264		public function renderDist($sourcePath, $destinationPath)
265		{
266		$this->dialogProvider->logConfig("Dist rendering " . $sourcePath . " to " . $destinationPath);
267		$this->processProvider->executeSudoCommand('mkdir -p ' . dirname($destinationPath));
268		$this->writeProtectedFile($destinationPath, $sourcePath);
269		}
270
271		/**
272		* @param $content
273		* @param $variables
274		* @return string
275		*/
276		public function renderString($content, $variables)
277		{
278		return $this->twig->render($content, $variables);
279		}
280
281		/**
282		* @param $cleanedLocation
283		* @param $target
284		* @param SplFileInfo $config
285		*/
286		public function renderSingleConfig($cleanedLocation, $target, $config)
287		{
288		$this->fileSystemProvider->render(
289		$cleanedLocation . $config->getFilename(),
290		$target . str_replace(".conf.twig", ".conf", $config->getFilename())
291		);
292		}
293
294		/**
295		* @param $cleanedLocation
296		* @param $target
297		* @param SplFileInfo $config
298		*/
299		public function renderSingleDistConfig($cleanedLocation, $target, $config)
300		{
301		$this->fileSystemProvider->renderDist(
302		$cleanedLocation . $config->getFilename(),
303		$target . str_replace(".conf.twig", ".dist", $config->getFilename())
304		);
305		}
306
307		/**
308		* @param $location
309		* @param $cleanedLocation
310		* @param $target
311		*/
312	View Code Duplication	public function renderConfig($location, $cleanedLocation, $target)
		0 ignored issues – show Duplication introduced 2015-11-23 11:12 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
313		{
314		// render templates
315		$finder = new Finder();
316		$finder->files()->in($location)->name("*.conf.twig");
317		foreach ($finder as $config) {
318		$this->renderSingleConfig($cleanedLocation, $target, $config);
319		}
320		}
321
322		/**
323		* @param $location
324		* @param $cleanedLocation
325		* @param $target
326		*/
327	View Code Duplication	public function renderDistConfig($location, $cleanedLocation, $target)
		0 ignored issues – show Duplication introduced 2015-11-23 11:12 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
328		{
329		// render templates
330		$finder = new Finder();
331		$finder->files()->in($location)->name("*.conf.twig");
332		foreach ($finder as $config) {
333		$this->renderSingleDistConfig($cleanedLocation, $target, $config);
334		}
335		}
336		}
337

Kunstmaan / skylab

GitHub Access Token became invalid

FileSystemProvider A last analyzed 2016-07-01 08:46 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

26 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

FileSystemProvider A
last analyzed 2016-07-01 08:46 UTC