FilesManagement::rrmdir() - Code Metrics - Inspection of "Merge pull request #3 from mambax7/master" - XoopsModules25x/tools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2f6fab...c5b9c9 )

by Goffy

created 2021-06-20 14:10 UTC

FilesManagement::rrmdir() B

↳ Parent: FilesManagement

Complexity

Conditions	9
Paths	7

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace XoopsModules\Tools\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
     */
    public static function createFolder($folder)
    {
        try {
            if (!\is_dir($folder)) {
                if (!\is_dir($folder) && !\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
     */
    public static function recurseCopy($src, $dst)
    {
        $dir = \opendir($src);
        //        @mkdir($dst);
        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
     *
     * @return bool true on success
     * @uses \Xmf\Module\Helper::isUserAdmin()
     *
     * @uses \Xmf\Module\Helper::getHelper()
     */
    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;
                    }
                } elseif (!($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) && !\is_dir($dest)) {
            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
     *
     * @return bool true on success
     * @uses \Xmf\Module\Helper::isUserAdmin()
     *
     * @uses \Xmf\Module\Helper::getHelper()
     */
    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) && !\is_dir($dest)) {
            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;
    }
}


Push — master ( 2f6fab...c5b9c9 )

FilesManagement::rrmdir() B

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
2
3		namespace XoopsModules\Tools\Common;
4
5		/*
6		You may not change or alter any portion of this comment or credits
7		of supporting developers from this source code or any supporting source code
8		which is considered copyrighted (c) material of the original comment or credit authors.
9
10		This program is distributed in the hope that it will be useful,
11		but WITHOUT ANY WARRANTY; without even the implied warranty of
12		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13		*/
14
15		/**
16		* @copyright XOOPS Project (https://xoops.org)
17		* @license http://www.fsf.org/copyleft/gpl.html GNU public license
18		* @author mamba <[email protected]>
19		*/
20		trait FilesManagement
21		{
22		/**
23		* Function responsible for checking if a directory exists, we can also write in and create an index.html file
24		*
25		* @param string $folder The full path of the directory to check
26		*/
27		public static function createFolder($folder)
28		{
29		try {
30		if (!\is_dir($folder)) {
31		if (!\is_dir($folder) && !\mkdir($folder) && !\is_dir($folder)) {
32		throw new \RuntimeException(\sprintf('Unable to create the %s directory', $folder));
33		}
34
35		file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
36		}
37		} catch (\Exception $e) {
38		echo 'Caught exception: ', $e->getMessage(), "\n", '<br>';
39		}
40		}
41
42		/**
43		* @param $file
44		* @param $folder
45		* @return bool
46		*/
47		public static function copyFile($file, $folder)
48		{
49		return \copy($file, $folder);
50		}
51
52		/**
53		* @param $src
54		* @param $dst
55		*/
56		public static function recurseCopy($src, $dst)
57		{
58		$dir = \opendir($src);
59		// @mkdir($dst);
60		if (!@\mkdir($dst) && !\is_dir($dst)) {
61		throw new \RuntimeException('The directory ' . $dst . ' could not be created.');
62		}
63		while (false !== ($file = \readdir($dir))) {
64		if (('.' !== $file) && ('..' !== $file)) {
65		if (\is_dir($src . '/' . $file)) {
66		self::recurseCopy($src . '/' . $file, $dst . '/' . $file);
67		} else {
68		\copy($src . '/' . $file, $dst . '/' . $file);
69		}
70		}
71		}
72		\closedir($dir);
73		}
74
75		/**
76		* Remove files and (sub)directories
77		*
78		* @param string $src source directory to delete
79		*
80		* @return bool true on success
81		* @uses \Xmf\Module\Helper::isUserAdmin()
82		*
83		* @uses \Xmf\Module\Helper::getHelper()
84		*/
85		public static function deleteDirectory($src)
86		{
87		// Only continue if user is a 'global' Admin
88		if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) \|\| !$GLOBALS['xoopsUser']->isAdmin()) {
		0 ignored issues – show Bug introduced 2021-06-19 18:55 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...
89		return false;
90		}
91
92		$success = true;
93		// remove old files
94		$dirInfo = new \SplFileInfo($src);
95		// validate is a directory
96		if ($dirInfo->isDir()) {
97		$fileList = \array_diff(\scandir($src, \SCANDIR_SORT_NONE), ['..', '.']);
98		foreach ($fileList as $k => $v) {
99		$fileInfo = new \SplFileInfo("{$src}/{$v}");
100		if ($fileInfo->isDir()) {
101		// recursively handle subdirectories
102		if (!$success = self::deleteDirectory($fileInfo->getRealPath())) {
103		break;
104		}
105		} elseif (!($success = \unlink($fileInfo->getRealPath()))) {
106		break;
107		}
108		}
109		// now delete this (sub)directory if all the files are gone
110		if ($success) {
111		$success = \rmdir($dirInfo->getRealPath());
112		}
113		} else {
114		// input is not a valid directory
115		$success = false;
116		}
117
118		return $success;
119		}
120
121		/**
122		* Recursively remove directory
123		*
124		* @todo currently won't remove directories with hidden files, should it?
125		*
126		* @param string $src directory to remove (delete)
127		*
128		* @return bool true on success
129		*/
130		public static function rrmdir($src)
131		{
132		// Only continue if user is a 'global' Admin
133		if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) \|\| !$GLOBALS['xoopsUser']->isAdmin()) {
		0 ignored issues – show Bug introduced 2021-06-19 18:55 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...
134		return false;
135		}
136
137		// If source is not a directory stop processing
138		if (!\is_dir($src)) {
139		return false;
140		}
141
142		$success = true;
		0 ignored issues – show Unused Code introduced 2021-06-19 18:55 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...
143
144		// Open the source directory to read in files
145		$iterator = new \DirectoryIterator($src);
146		foreach ($iterator as $fObj) {
147		if ($fObj->isFile()) {
148		$filename = $fObj->getPathname();
149		$fObj = null; // clear this iterator object to close the file
150		if (!\unlink($filename)) {
151		return false; // couldn't delete the file
152		}
153		} elseif (!$fObj->isDot() && $fObj->isDir()) {
154		// Try recursively on directory
155		self::rrmdir($fObj->getPathname());
156		}
157		}
158		$iterator = null; // clear iterator Obj to close file/directory
		0 ignored issues – show Unused Code introduced 2021-06-19 18:55 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...
159		return \rmdir($src); // remove the directory & return results
160		}
161
162		/**
163		* Recursively move files from one directory to another
164		*
165		* @param string $src - Source of files being moved
166		* @param string $dest - Destination of files being moved
167		*
168		* @return bool true on success
169		*/
170	View Code Duplication	public static function rmove($src, $dest)
		0 ignored issues – show Duplication introduced 2021-06-19 18:55 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...
171		{
172		// Only continue if user is a 'global' Admin
173		if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) \|\| !$GLOBALS['xoopsUser']->isAdmin()) {
		0 ignored issues – show Bug introduced 2021-06-19 18:55 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...
174		return false;
175		}
176
177		// If source is not a directory stop processing
178		if (!\is_dir($src)) {
179		return false;
180		}
181
182		// If the destination directory does not exist and could not be created stop processing
183		if (!\is_dir($dest) && !\mkdir($dest) && !\is_dir($dest)) {
184		return false;
185		}
186
187		// Open the source directory to read in files
188		$iterator = new \DirectoryIterator($src);
189		foreach ($iterator as $fObj) {
190		if ($fObj->isFile()) {
191		\rename($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
192		} elseif (!$fObj->isDot() && $fObj->isDir()) {
193		// Try recursively on directory
194		self::rmove($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
195		// rmdir($fObj->getPath()); // now delete the directory
196		}
197		}
198		$iterator = null; // clear iterator Obj to close file/directory
		0 ignored issues – show Unused Code introduced 2021-06-19 18:55 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...
199		return \rmdir($src); // remove the directory & return results
200		}
201
202		/**
203		* Recursively copy directories and files from one directory to another
204		*
205		* @param string $src - Source of files being moved
206		* @param string $dest - Destination of files being moved
207		*
208		* @return bool true on success
209		* @uses \Xmf\Module\Helper::isUserAdmin()
210		*
211		* @uses \Xmf\Module\Helper::getHelper()
212		*/
213	View Code Duplication	public static function rcopy($src, $dest)
		0 ignored issues – show Duplication introduced 2021-06-19 18:55 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...
214		{
215		// Only continue if user is a 'global' Admin
216		if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) \|\| !$GLOBALS['xoopsUser']->isAdmin()) {
		0 ignored issues – show Bug introduced 2021-06-19 18:55 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...
217		return false;
218		}
219
220		// If source is not a directory stop processing
221		if (!\is_dir($src)) {
222		return false;
223		}
224
225		// If the destination directory does not exist and could not be created stop processing
226		if (!\is_dir($dest) && !\mkdir($dest) && !\is_dir($dest)) {
227		return false;
228		}
229
230		// Open the source directory to read in files
231		$iterator = new \DirectoryIterator($src);
232		foreach ($iterator as $fObj) {
233		if ($fObj->isFile()) {
234		\copy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
235		} elseif (!$fObj->isDot() && $fObj->isDir()) {
236		self::rcopy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
237		}
238		}
239
240		return true;
241		}
242		}
243

XoopsModules25x / tools

Push — master ( 2f6fab...c5b9c9 )

FilesManagement::rrmdir() B

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