FilesManagement::rrmdir() - Code Metrics - mambax7/instruction - Measure and Improve Code Quality continuously with Scrutinizer

FilesManagement::rrmdir() D
last analyzed 2017-10-23 08:58 UTC

↳ Parent: FilesManagement

Complexity

Conditions	9
Paths	7

Size

Total Lines	31
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	9
eloc	17
nc	7
nop	1
dl	0
loc	31
rs	4.909
c	0
b	0
f	0

<?php namespace Xoopsmodules\instruction\common;

/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 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.
 */

/**
 * @copyright   XOOPS Project (https://xoops.org)
 * @license     http://www.fsf.org/copyleft/gpl.html GNU public license
 * @author      mamba <[email protected]>
 */
trait FilesManagement
{
    /**
     * Function responsible for checking if a directory exists, we can also write in and create an index.html file
     *
     * @param string $folder The full path of the directory to check
     *
     * @return void
     * @throws \RuntimeException
     */
    public static function createFolder($folder)
    {
        try {
            if (!file_exists($folder)) {
                if (!mkdir($folder) && !is_dir($folder)) {

                    throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder));
                }

                file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
            }
        } catch (\Exception $e) {
            echo 'Caught exception: ', $e->getMessage(), "\n", '<br>';
        }
    }

    /**
     * @param $file
     * @param $folder
     * @return bool
     */
    public static function copyFile($file, $folder)
    {
        return copy($file, $folder);
    }

    /**
     * @param $src
     * @param $dst
     * @throws \RuntimeException
     */
    public static function recurseCopy($src, $dst)
    {
        $dir = opendir($src);
        if (!mkdir($dst) && !is_dir($dst)) {

            throw new \RuntimeException('The directory ' . $dst . ' could not be created.');
        }
        while (false !== ($file = readdir($dir))) {
            if (('.' !== $file) && ('..' !== $file)) {
                if (is_dir($src . '/' . $file)) {
                    self::recurseCopy($src . '/' . $file, $dst . '/' . $file);
                } else {
                    copy($src . '/' . $file, $dst . '/' . $file);
                }
            }
        }
        closedir($dir);
    }

    /**
     *
     * Remove files and (sub)directories
     *
     * @param string $src source directory to delete
     *
     * @uses \Xmf\Module\Helper::getHelper()
     * @uses \Xmf\Module\Helper::isUserAdmin()
     *
     * @return bool true on success
     */
    public static function deleteDirectory($src)
    {
        // Only continue if user is a 'global' Admin
        if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return false;
        }

        $success = true;
        // remove old files
        $dirInfo = new \SplFileInfo($src);
        // validate is a directory
        if ($dirInfo->isDir()) {
            $fileList = array_diff(scandir($src, SCANDIR_SORT_NONE), ['..', '.']);
            foreach ($fileList as $k => $v) {
                $fileInfo = new \SplFileInfo("{$src}/{$v}");
                if ($fileInfo->isDir()) {
                    // recursively handle subdirectories
                    if (!$success = self::deleteDirectory($fileInfo->getRealPath())) {
                        break;
                    }
                } else {
                    // delete the file
                    if (!($success = unlink($fileInfo->getRealPath()))) {
                        break;
                    }
                }
            }
            // now delete this (sub)directory if all the files are gone
            if ($success) {
                $success = rmdir($dirInfo->getRealPath());
            }
        } else {
            // input is not a valid directory
            $success = false;
        }
        return $success;
    }

    /**
     *
     * Recursively remove directory
     *
     * @todo currently won't remove directories with hidden files, should it?
     *
     * @param string $src directory to remove (delete)
     *
     * @return bool true on success
     */
    public static function rrmdir($src)
    {
        // Only continue if user is a 'global' Admin
        if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return false;
        }

        // If source is not a directory stop processing
        if (!is_dir($src)) {
            return false;
        }

        $success = true;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        // Open the source directory to read in files
        $iterator = new \DirectoryIterator($src);
        foreach ($iterator as $fObj) {
            if ($fObj->isFile()) {
                $filename = $fObj->getPathname();
                $fObj     = null; // clear this iterator object to close the file
                if (!unlink($filename)) {
                    return false; // couldn't delete the file
                }
            } elseif (!$fObj->isDot() && $fObj->isDir()) {
                // Try recursively on directory
                self::rrmdir($fObj->getPathname());
            }
        }
        $iterator = null;   // clear iterator Obj to close file/directory
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        return rmdir($src); // remove the directory & return results
    }

    /**
     * Recursively move files from one directory to another
     *
     * @param string $src  - Source of files being moved
     * @param string $dest - Destination of files being moved
     *
     * @return bool true on success
     */
    public static function rmove($src, $dest)

    {
        // Only continue if user is a 'global' Admin
        if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return false;
        }

        // If source is not a directory stop processing
        if (!is_dir($src)) {
            return false;
        }

        // If the destination directory does not exist and could not be created stop processing
        if (!is_dir($dest) && !mkdir($dest, 0755)) {
            return false;
        }

        // Open the source directory to read in files
        $iterator = new \DirectoryIterator($src);
        foreach ($iterator as $fObj) {
            if ($fObj->isFile()) {
                rename($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
            } elseif (!$fObj->isDot() && $fObj->isDir()) {
                // Try recursively on directory
                self::rmove($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
                //                rmdir($fObj->getPath()); // now delete the directory

            }
        }
        $iterator = null;   // clear iterator Obj to close file/directory
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        return rmdir($src); // remove the directory & return results
    }

    /**
     * Recursively copy directories and files from one directory to another
     *
     * @param string $src  - Source of files being moved
     * @param string $dest - Destination of files being moved
     *
     * @uses \Xmf\Module\Helper::getHelper()
     * @uses \Xmf\Module\Helper::isUserAdmin()
     *
     * @return bool true on success
     */
    public static function rcopy($src, $dest)

    {
        // Only continue if user is a 'global' Admin
        if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return false;
        }

        // If source is not a directory stop processing
        if (!is_dir($src)) {
            return false;
        }

        // If the destination directory does not exist and could not be created stop processing
        if (!is_dir($dest) && !mkdir($dest, 0755)) {
            return false;
        }

        // Open the source directory to read in files
        $iterator = new \DirectoryIterator($src);
        foreach ($iterator as $fObj) {
            if ($fObj->isFile()) {
                copy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
            } elseif (!$fObj->isDot() && $fObj->isDir()) {
                self::rcopy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
            }
        }
        return true;
    }
}


FilesManagement::rrmdir() D
last analyzed 2017-10-23 08:58 UTC

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1		<?php namespace Xoopsmodules\instruction\common;
2
3		/*
4		You may not change or alter any portion of this comment or credits
5		of supporting developers from this source code or any supporting source code
6		which is considered copyrighted (c) material of the original comment or credit authors.
7
8		This program is distributed in the hope that it will be useful,
9		but WITHOUT ANY WARRANTY; without even the implied warranty of
10		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11		*/
12
13		/**
14		* @copyright XOOPS Project (https://xoops.org)
15		* @license http://www.fsf.org/copyleft/gpl.html GNU public license
16		* @author mamba <[email protected]>
17		*/
18		trait FilesManagement
19		{
20		/**
21		* Function responsible for checking if a directory exists, we can also write in and create an index.html file
22		*
23		* @param string $folder The full path of the directory to check
24		*
25		* @return void
26		* @throws \RuntimeException
27		*/
28		public static function createFolder($folder)
29		{
30		try {
31		if (!file_exists($folder)) {
32	View Code Duplication	if (!mkdir($folder) && !is_dir($folder)) {
		0 ignored issues – show Duplication introduced 2017-10-10 07:27 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...
33		throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder));
34		}
35
36		file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
37		}
38		} catch (\Exception $e) {
39		echo 'Caught exception: ', $e->getMessage(), "\n", '<br>';
40		}
41		}
42
43		/**
44		* @param $file
45		* @param $folder
46		* @return bool
47		*/
48		public static function copyFile($file, $folder)
49		{
50		return copy($file, $folder);
51		}
52
53		/**
54		* @param $src
55		* @param $dst
56		* @throws \RuntimeException
57		*/
58		public static function recurseCopy($src, $dst)
59		{
60		$dir = opendir($src);
61	View Code Duplication	if (!mkdir($dst) && !is_dir($dst)) {
		0 ignored issues – show Duplication introduced 2017-10-10 07:27 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...
62		throw new \RuntimeException('The directory ' . $dst . ' could not be created.');
63		}
64		while (false !== ($file = readdir($dir))) {
65		if (('.' !== $file) && ('..' !== $file)) {
66		if (is_dir($src . '/' . $file)) {
67		self::recurseCopy($src . '/' . $file, $dst . '/' . $file);
68		} else {
69		copy($src . '/' . $file, $dst . '/' . $file);
70		}
71		}
72		}
73		closedir($dir);
74		}
75
76		/**
77		*
78		* Remove files and (sub)directories
79		*
80		* @param string $src source directory to delete
81		*
82		* @uses \Xmf\Module\Helper::getHelper()
83		* @uses \Xmf\Module\Helper::isUserAdmin()
84		*
85		* @return bool true on success
86		*/
87		public static function deleteDirectory($src)
88		{
89		// Only continue if user is a 'global' Admin
90		if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) \|\| !$GLOBALS['xoopsUser']->isAdmin()) {
		0 ignored issues – show Bug introduced 2017-10-03 09:49 UTC by Report Bug Copy Issue Report The class `XoopsUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
91		return false;
92		}
93
94		$success = true;
95		// remove old files
96		$dirInfo = new \SplFileInfo($src);
97		// validate is a directory
98		if ($dirInfo->isDir()) {
99		$fileList = array_diff(scandir($src, SCANDIR_SORT_NONE), ['..', '.']);
100		foreach ($fileList as $k => $v) {
101		$fileInfo = new \SplFileInfo("{$src}/{$v}");
102		if ($fileInfo->isDir()) {
103		// recursively handle subdirectories
104		if (!$success = self::deleteDirectory($fileInfo->getRealPath())) {
105		break;
106		}
107		} else {
108		// delete the file
109		if (!($success = unlink($fileInfo->getRealPath()))) {
110		break;
111		}
112		}
113		}
114		// now delete this (sub)directory if all the files are gone
115		if ($success) {
116		$success = rmdir($dirInfo->getRealPath());
117		}
118		} else {
119		// input is not a valid directory
120		$success = false;
121		}
122		return $success;
123		}
124
125		/**
126		*
127		* Recursively remove directory
128		*
129		* @todo currently won't remove directories with hidden files, should it?
130		*
131		* @param string $src directory to remove (delete)
132		*
133		* @return bool true on success
134		*/
135		public static function rrmdir($src)
136		{
137		// Only continue if user is a 'global' Admin
138		if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) \|\| !$GLOBALS['xoopsUser']->isAdmin()) {
		0 ignored issues – show Bug introduced 2017-10-03 09:49 UTC by Report Bug Copy Issue Report The class `XoopsUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
139		return false;
140		}
141
142		// If source is not a directory stop processing
143		if (!is_dir($src)) {
144		return false;
145		}
146
147		$success = true;
		0 ignored issues – show Unused Code introduced 2017-10-03 09:49 UTC by Report Bug Copy Issue Report `$success` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
148
149		// Open the source directory to read in files
150		$iterator = new \DirectoryIterator($src);
151		foreach ($iterator as $fObj) {
152		if ($fObj->isFile()) {
153		$filename = $fObj->getPathname();
154		$fObj = null; // clear this iterator object to close the file
155		if (!unlink($filename)) {
156		return false; // couldn't delete the file
157		}
158		} elseif (!$fObj->isDot() && $fObj->isDir()) {
159		// Try recursively on directory
160		self::rrmdir($fObj->getPathname());
161		}
162		}
163		$iterator = null; // clear iterator Obj to close file/directory
		0 ignored issues – show Unused Code introduced 2017-10-03 09:49 UTC by Report Bug Copy Issue Report `$iterator` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
164		return rmdir($src); // remove the directory & return results
165		}
166
167		/**
168		* Recursively move files from one directory to another
169		*
170		* @param string $src - Source of files being moved
171		* @param string $dest - Destination of files being moved
172		*
173		* @return bool true on success
174		*/
175	View Code Duplication	public static function rmove($src, $dest)
		0 ignored issues – show Duplication introduced 2017-10-03 09:49 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...
176		{
177		// Only continue if user is a 'global' Admin
178		if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) \|\| !$GLOBALS['xoopsUser']->isAdmin()) {
		0 ignored issues – show Bug introduced 2017-10-03 09:49 UTC by Report Bug Copy Issue Report The class `XoopsUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
179		return false;
180		}
181
182		// If source is not a directory stop processing
183		if (!is_dir($src)) {
184		return false;
185		}
186
187		// If the destination directory does not exist and could not be created stop processing
188		if (!is_dir($dest) && !mkdir($dest, 0755)) {
189		return false;
190		}
191
192		// Open the source directory to read in files
193		$iterator = new \DirectoryIterator($src);
194		foreach ($iterator as $fObj) {
195		if ($fObj->isFile()) {
196		rename($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
197		} elseif (!$fObj->isDot() && $fObj->isDir()) {
198		// Try recursively on directory
199		self::rmove($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
200		// rmdir($fObj->getPath()); // now delete the directory
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-10-03 09:49 UTC by Report Bug Copy Issue Report `64%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
201		}
202		}
203		$iterator = null; // clear iterator Obj to close file/directory
		0 ignored issues – show Unused Code introduced 2017-10-03 09:49 UTC by Report Bug Copy Issue Report `$iterator` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
204		return rmdir($src); // remove the directory & return results
205		}
206
207		/**
208		* Recursively copy directories and files from one directory to another
209		*
210		* @param string $src - Source of files being moved
211		* @param string $dest - Destination of files being moved
212		*
213		* @uses \Xmf\Module\Helper::getHelper()
214		* @uses \Xmf\Module\Helper::isUserAdmin()
215		*
216		* @return bool true on success
217		*/
218	View Code Duplication	public static function rcopy($src, $dest)
		0 ignored issues – show Duplication introduced 2017-10-03 09:49 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...
219		{
220		// Only continue if user is a 'global' Admin
221		if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) \|\| !$GLOBALS['xoopsUser']->isAdmin()) {
		0 ignored issues – show Bug introduced 2017-10-03 09:49 UTC by Report Bug Copy Issue Report The class `XoopsUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
222		return false;
223		}
224
225		// If source is not a directory stop processing
226		if (!is_dir($src)) {
227		return false;
228		}
229
230		// If the destination directory does not exist and could not be created stop processing
231		if (!is_dir($dest) && !mkdir($dest, 0755)) {
232		return false;
233		}
234
235		// Open the source directory to read in files
236		$iterator = new \DirectoryIterator($src);
237		foreach ($iterator as $fObj) {
238		if ($fObj->isFile()) {
239		copy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
240		} elseif (!$fObj->isDot() && $fObj->isDir()) {
241		self::rcopy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
242		}
243		}
244		return true;
245		}
246		}
247

mambax7 / instruction

FilesManagement::rrmdir() D last analyzed 2017-10-23 08:58 UTC

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like

FilesManagement::rrmdir() D
last analyzed 2017-10-23 08:58 UTC