FilesystemHelper - Code Metrics - owncloud/updater - Measure and Improve Code Quality continuously with Scrutinizer

FilesystemHelper A
last analyzed 2020-04-29 13:34 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	206
Duplicated Lines	3.88 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	42
c	0
b	0
f	0
lcom	1
cbo	1
dl	8
loc	206
ccs	0
cts	80
cp	0
rs	9.0399

14 Methods

Rating	Name	Duplication	Size	Complexity
A	filemtime()	0	3	1
A	scandirFiltered()	0	7	2
A	scandir()	0	3	1
A	fileExists()	0	3	1
A	isWritable()	0	3	1
A	isDir()	0	3	1
A	md5File()	0	3	1
A	mkdir()	0	5	2
B	copyr()	0	23	10
A	move()	0	5	2
B	checkr()	0	19	7
A	removeIfExists()	0	11	3
B	rmdirr()	0	18	7
A	tripleMove()	8	10	3

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like FilesystemHelper often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use FilesystemHelper, and based on these observations, apply Extract Interface, too.

<?php
/**
 * @author Victor Dubiniuk <[email protected]>
 *
 * @copyright Copyright (c) 2015, ownCloud, Inc.
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace Owncloud\Updater\Utils;

/**
 * Class FilesystemHelper
 *
 * @package Owncloud\Updater\Utils
 */
class FilesystemHelper {

	/**
	 * Wrapper for filemtime function
	 * @param string $path
	 * @return integer
	 */
	public function filemtime($path){
		return filemtime($path);
	}

	/**
	 * Wrapper for scandir function. 
	 * Filters current and parent directories
	 * @param string $path
	 * @return array
	 */
	public function scandirFiltered($path){
		$content = $this->scandir($path);
		if (is_array($content)){
			return array_diff($content, ['.', '..']);
		}
		return [];
	}

	/**
	 * Wrapper for scandir function
	 * @param string $path
	 * @return array
	 */
	public function scandir($path){
		return scandir($path);
	}

	/**
	 * Wrapper for file_exists function
	 * @param string $path
	 * @return bool
	 */
	public function fileExists($path){
		return file_exists($path);
	}

	/**
	 * Wrapper for is_writable function
	 * @param string $path
	 * @return bool
	 */
	public function isWritable($path){
		return is_writable($path);
	}

	/**
	 * Wrapper for is_dir function
	 * @param string $path
	 * @return bool
	 */
	public function isDir($path){
		return is_dir($path);
	}

	/**
	 * Wrapper for md5_file function
	 * @param string $path
	 * @return string
	 */
	public function md5File($path){
		return md5_file($path);
	}

	/**
	 * Wrapper for mkdir
	 * @param string $path
	 * @param bool $isRecursive
	 * @throws \Exception on error
	 */
	public function mkdir($path, $isRecursive = false){
		if (!mkdir($path, 0755, $isRecursive)){
			throw new \Exception("Unable to create $path");
		}
	}

	/**
	 * Copy recursive
	 * @param string $src  - source path
	 * @param string $dest - destination path
	 * @throws \Exception on error
	 */
	public function copyr($src, $dest, $stopOnError = true){
		if (is_dir($src)){
			if (!is_dir($dest)){
				try{
					$this->mkdir($dest);
				} catch (\Exception $e){
					if ($stopOnError){
						throw $e;
					}
				}
			}
			$files = scandir($src);
			foreach ($files as $file){
				if (!in_array($file, [".", ".."])){
					$this->copyr("$src/$file", "$dest/$file", $stopOnError);
				}
			}
		} elseif (file_exists($src)){
			if (!copy($src, $dest) && $stopOnError){
				throw new \Exception("Unable to copy $src to $dest");
			}
		}
	}

	/**
	 * Moves file/directory
	 * @param string $src  - source path
	 * @param string $dest - destination path
	 * @throws \Exception on error
	 */
	public function move($src, $dest){
		if (!rename($src, $dest)){
			throw new \Exception("Unable to move $src to $dest");
		}
	}

	/**
	 * Check permissions recursive
	 * @param string $src  - path to check
	 * @param Collection $collection - object to store incorrect permissions
	 */
	public function checkr($src, $collection){
		if (!file_exists($src)){
			return;
		}
		if (!is_writable($src)){
			$collection->addNotWritable($src);
		}
		if (!is_readable($src)){
			$collection->addNotReadable($src);
		}
		if (is_dir($src)){
			$files = scandir($src);
			foreach ($files as $file){
				if (!in_array($file, [".", ".."])){
					$this->checkr("$src/$file", $collection);
				}
			}
		}
	}

	/**
	 * @param string $path
	 */
	public function removeIfExists($path) {
		if (!file_exists($path)) {
			return;
		}

		if (is_dir($path)) {
			$this->rmdirr($path);
		} else {
			@unlink($path);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
		}
	}

	/**
	 * @param $dir
	 * @return bool
	 */
	public function rmdirr($dir) {
		if(is_dir($dir)) {
			$files = scandir($dir);
			foreach($files as $file) {
				if ($file != "." && $file != "..") {
					$this->rmdirr("$dir/$file");
				}
			}
			@rmdir($dir);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
		}elseif(file_exists($dir)) {
			@unlink($dir);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
		}
		if(file_exists($dir)) {
			return false;
		}else{
			return true;
		}
	}

	/**
	 *
	 * @param string $old
	 * @param string $new
	 * @param string $temp
	 * @param string $dirName
	 */
	public function tripleMove($old, $new, $temp, $dirName){
		if ($this->fileExists($old . '/' . $dirName)){

			$this->copyr($old . '/' . $dirName, $temp . '/' . $dirName, false);
			$this->rmdirr($old . '/' . $dirName);
		}
		if ($this->fileExists($new . '/' . $dirName)){

			$this->copyr($new . '/' . $dirName, $old . '/' . $dirName, false);
			$this->rmdirr($new . '/' . $dirName);
		}
	}

}


1		<?php
2		/**
3		* @author Victor Dubiniuk <[email protected]>
4		*
5		* @copyright Copyright (c) 2015, ownCloud, Inc.
6		* @license AGPL-3.0
7		*
8		* This code is free software: you can redistribute it and/or modify
9		* it under the terms of the GNU Affero General Public License, version 3,
10		* as published by the Free Software Foundation.
11		*
12		* This program is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		* GNU Affero General Public License for more details.
16		*
17		* You should have received a copy of the GNU Affero General Public License, version 3,
18		* along with this program. If not, see <http://www.gnu.org/licenses/>
19		*
20		*/
21
22		namespace Owncloud\Updater\Utils;
23
24		/**
25		* Class FilesystemHelper
26		*
27		* @package Owncloud\Updater\Utils
28		*/
29		class FilesystemHelper {
30
31		/**
32		* Wrapper for filemtime function
33		* @param string $path
34		* @return integer
35		*/
36		public function filemtime($path){
37		return filemtime($path);
38		}
39
40		/**
41		* Wrapper for scandir function.
42		* Filters current and parent directories
43		* @param string $path
44		* @return array
45		*/
46		public function scandirFiltered($path){
47		$content = $this->scandir($path);
48		if (is_array($content)){
49		return array_diff($content, ['.', '..']);
50		}
51		return [];
52		}
53
54		/**
55		* Wrapper for scandir function
56		* @param string $path
57		* @return array
58		*/
59		public function scandir($path){
60		return scandir($path);
61		}
62
63		/**
64		* Wrapper for file_exists function
65		* @param string $path
66		* @return bool
67		*/
68		public function fileExists($path){
69		return file_exists($path);
70		}
71
72		/**
73		* Wrapper for is_writable function
74		* @param string $path
75		* @return bool
76		*/
77		public function isWritable($path){
78		return is_writable($path);
79		}
80
81		/**
82		* Wrapper for is_dir function
83		* @param string $path
84		* @return bool
85		*/
86		public function isDir($path){
87		return is_dir($path);
88		}
89
90		/**
91		* Wrapper for md5_file function
92		* @param string $path
93		* @return string
94		*/
95		public function md5File($path){
96		return md5_file($path);
97		}
98
99		/**
100		* Wrapper for mkdir
101		* @param string $path
102		* @param bool $isRecursive
103		* @throws \Exception on error
104		*/
105		public function mkdir($path, $isRecursive = false){
106		if (!mkdir($path, 0755, $isRecursive)){
107		throw new \Exception("Unable to create $path");
108		}
109		}
110
111		/**
112		* Copy recursive
113		* @param string $src - source path
114		* @param string $dest - destination path
115		* @throws \Exception on error
116		*/
117		public function copyr($src, $dest, $stopOnError = true){
118		if (is_dir($src)){
119		if (!is_dir($dest)){
120		try{
121		$this->mkdir($dest);
122		} catch (\Exception $e){
123		if ($stopOnError){
124		throw $e;
125		}
126		}
127		}
128		$files = scandir($src);
129		foreach ($files as $file){
130		if (!in_array($file, [".", ".."])){
131		$this->copyr("$src/$file", "$dest/$file", $stopOnError);
132		}
133		}
134		} elseif (file_exists($src)){
135		if (!copy($src, $dest) && $stopOnError){
136		throw new \Exception("Unable to copy $src to $dest");
137		}
138		}
139		}
140
141		/**
142		* Moves file/directory
143		* @param string $src - source path
144		* @param string $dest - destination path
145		* @throws \Exception on error
146		*/
147		public function move($src, $dest){
148		if (!rename($src, $dest)){
149		throw new \Exception("Unable to move $src to $dest");
150		}
151		}
152
153		/**
154		* Check permissions recursive
155		* @param string $src - path to check
156		* @param Collection $collection - object to store incorrect permissions
157		*/
158		public function checkr($src, $collection){
159		if (!file_exists($src)){
160		return;
161		}
162		if (!is_writable($src)){
163		$collection->addNotWritable($src);
164		}
165		if (!is_readable($src)){
166		$collection->addNotReadable($src);
167		}
168		if (is_dir($src)){
169		$files = scandir($src);
170		foreach ($files as $file){
171		if (!in_array($file, [".", ".."])){
172		$this->checkr("$src/$file", $collection);
173		}
174		}
175		}
176		}
177
178		/**
179		* @param string $path
180		*/
181		public function removeIfExists($path) {
182		if (!file_exists($path)) {
183		return;
184		}
185
186		if (is_dir($path)) {
187		$this->rmdirr($path);
188		} else {
189		@unlink($path);
		0 ignored issues – show Security Best Practice introduced 2015-12-21 09:30 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
190		}
191		}
192
193		/**
194		* @param $dir
195		* @return bool
196		*/
197		public function rmdirr($dir) {
198		if(is_dir($dir)) {
199		$files = scandir($dir);
200		foreach($files as $file) {
201		if ($file != "." && $file != "..") {
202		$this->rmdirr("$dir/$file");
203		}
204		}
205		@rmdir($dir);
		0 ignored issues – show Security Best Practice introduced 2015-12-21 09:30 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
206		}elseif(file_exists($dir)) {
207		@unlink($dir);
		0 ignored issues – show Security Best Practice introduced 2015-12-21 09:30 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
208		}
209		if(file_exists($dir)) {
210		return false;
211		}else{
212		return true;
213		}
214		}
215
216		/**
217		*
218		* @param string $old
219		* @param string $new
220		* @param string $temp
221		* @param string $dirName
222		*/
223		public function tripleMove($old, $new, $temp, $dirName){
224	View Code Duplication	if ($this->fileExists($old . '/' . $dirName)){
		0 ignored issues – show Duplication introduced 2016-02-09 17:57 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...
225		$this->copyr($old . '/' . $dirName, $temp . '/' . $dirName, false);
226		$this->rmdirr($old . '/' . $dirName);
227		}
228	View Code Duplication	if ($this->fileExists($new . '/' . $dirName)){
		0 ignored issues – show Duplication introduced 2016-02-09 17:57 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...
229		$this->copyr($new . '/' . $dirName, $old . '/' . $dirName, false);
230		$this->rmdirr($new . '/' . $dirName);
231		}
232		}
233
234		}
235

owncloud / updater

FilesystemHelper A last analyzed 2020-04-29 13:34 UTC