Completed
Push — master ( d1322e...dc7924 )
by Michael
02:10
created

FilesManagement::rmove()   D

Complexity

Conditions 10
Paths 7

Size

Total Lines 31
Code Lines 15

Duplication

Lines 31
Ratio 100 %

Importance

Changes 0
Metric Value
cc 10
eloc 15
nc 7
nop 2
dl 31
loc 31
rs 4.8196
c 0
b 0
f 0

How to fix   Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/*
3
 You may not change or alter any portion of this comment or credits
4
 of supporting developers from this source code or any supporting source code
5
 which is considered copyrighted (c) material of the original comment or credit authors.
6
7
 This program is distributed in the hope that it will be useful,
8
 but WITHOUT ANY WARRANTY; without even the implied warranty of
9
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10
 */
11
12
/**
13
 * @copyright   XOOPS Project (https://xoops.org)
14
 * @license     http://www.fsf.org/copyleft/gpl.html GNU public license
15
 * @author      mamba <[email protected]>
16
 */
17
trait FilesManagement
0 ignored issues
show
Coding Style Compatibility introduced by
Each trait must be in a namespace of at least one level (a top-level vendor name)

You can fix this by adding a namespace to your class:

namespace YourVendor;

class YourClass { }

When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.

Loading history...
18
{
19
    /**
20
     * Function responsible for checking if a directory exists, we can also write in and create an index.html file
21
     *
22
     * @param string $folder The full path of the directory to check
23
     *
24
     * @return void
25
     */
26
    public static function createFolder($folder)
27
    {
28
        try {
29
            if (!file_exists($folder)) {
30
                if (!mkdir($folder) && !is_dir($folder)) {
31
                    throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder));
32
                }
33
34
                file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
35
            }
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);
0 ignored issues
show
Security Best Practice introduced by
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...
60
        while (false !== ($file = readdir($dir))) {
61
            if (($file !== '.') && ($file !== '..')) {
62
                if (is_dir($src . '/' . $file)) {
63
                    self::recurseCopy($src . '/' . $file, $dst . '/' . $file);
64
                } else {
65
                    copy($src . '/' . $file, $dst . '/' . $file);
66
                }
67
            }
68
        }
69
        closedir($dir);
70
    }
71
72
    /**
73
     *
74
     * Remove files and (sub)directories
75
     *
76
     * @param string $src source directory to delete
77
     *
78
     * @uses \Xmf\Module\Helper::getHelper()
79
     * @uses \Xmf\Module\Helper::isUserAdmin()
80
     *
81
     * @return bool true on success
82
     */
83
    public static function deleteDirectory($src)
0 ignored issues
show
Coding Style introduced by
deleteDirectory uses the super-global variable $GLOBALS which is generally not recommended.

Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
84
    {
85
        // Only continue if user is a 'global' Admin
86
        if (!($GLOBALS['xoopsUser'] instanceof XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
0 ignored issues
show
Bug introduced by
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...
87
            return false;
88
        }
89
90
        $success = true;
91
        // remove old files
92
        $dirInfo = new SplFileInfo($src);
93
        // validate is a directory
94
        if ($dirInfo->isDir()) {
95
            $fileList = array_diff(scandir($src, SCANDIR_SORT_NONE), ['..', '.']);
96
            foreach ($fileList as $k => $v) {
97
                $fileInfo = new SplFileInfo("{$src}/{$v}");
98
                if ($fileInfo->isDir()) {
99
                    // recursively handle subdirectories
100
                    if (!$success = self::deleteDirectory($fileInfo->getRealPath())) {
101
                        break;
102
                    }
103
                } else {
104
                    // delete the file
105
                    if (!($success = unlink($fileInfo->getRealPath()))) {
106
                        break;
107
                    }
108
                }
109
            }
110
            // now delete this (sub)directory if all the files are gone
111
            if ($success) {
112
                $success = rmdir($dirInfo->getRealPath());
113
            }
114
        } else {
115
            // input is not a valid directory
116
            $success = false;
117
        }
118
        return $success;
119
    }
120
121
    /**
122
     *
123
     * Recursively remove directory
124
     *
125
     * @todo currently won't remove directories with hidden files, should it?
126
     *
127
     * @param string $src directory to remove (delete)
128
     *
129
     * @return bool true on success
130
     */
131
    public static function rrmdir($src)
0 ignored issues
show
Coding Style introduced by
rrmdir uses the super-global variable $GLOBALS which is generally not recommended.

Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
132
    {
133
        // Only continue if user is a 'global' Admin
134
        if (!($GLOBALS['xoopsUser'] instanceof XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
0 ignored issues
show
Bug introduced by
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...
135
            return false;
136
        }
137
138
        // If source is not a directory stop processing
139
        if (!is_dir($src)) {
140
            return false;
141
        }
142
143
        $success = true;
0 ignored issues
show
Unused Code introduced by
$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...
144
145
        // Open the source directory to read in files
146
        $iterator = new DirectoryIterator($src);
147
        foreach ($iterator as $fObj) {
148
            if ($fObj->isFile()) {
149
                $filename = $fObj->getPathname();
150
                $fObj     = null; // clear this iterator object to close the file
151
                if (!unlink($filename)) {
152
                    return false; // couldn't delete the file
153
                }
154
            } elseif (!$fObj->isDot() && $fObj->isDir()) {
155
                // Try recursively on directory
156
                self::rrmdir($fObj->getPathname());
157
            }
158
        }
159
        $iterator = null;   // clear iterator Obj to close file/directory
0 ignored issues
show
Unused Code introduced by
$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...
160
        return rmdir($src); // remove the directory & return results
161
    }
162
163
    /**
164
     * Recursively move files from one directory to another
165
     *
166
     * @param string $src  - Source of files being moved
167
     * @param string $dest - Destination of files being moved
168
     *
169
     * @return bool true on success
170
     */
171 View Code Duplication
    public static function rmove($src, $dest)
0 ignored issues
show
Duplication introduced by
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...
Coding Style introduced by
rmove uses the super-global variable $GLOBALS which is generally not recommended.

Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
172
    {
173
        // Only continue if user is a 'global' Admin
174
        if (!($GLOBALS['xoopsUser'] instanceof XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
0 ignored issues
show
Bug introduced by
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...
175
            return false;
176
        }
177
178
        // If source is not a directory stop processing
179
        if (!is_dir($src)) {
180
            return false;
181
        }
182
183
        // If the destination directory does not exist and could not be created stop processing
184
        if (!is_dir($dest) && !mkdir($dest, 0755)) {
185
            return false;
186
        }
187
188
        // Open the source directory to read in files
189
        $iterator = new DirectoryIterator($src);
190
        foreach ($iterator as $fObj) {
191
            if ($fObj->isFile()) {
192
                rename($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
193
            } elseif (!$fObj->isDot() && $fObj->isDir()) {
194
                // Try recursively on directory
195
                self::rmove($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
196
                //                rmdir($fObj->getPath()); // now delete the directory
0 ignored issues
show
Unused Code Comprehensibility introduced by
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...
197
            }
198
        }
199
        $iterator = null;   // clear iterator Obj to close file/directory
0 ignored issues
show
Unused Code introduced by
$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...
200
        return rmdir($src); // remove the directory & return results
201
    }
202
203
    /**
204
     * Recursively copy directories and files from one directory to another
205
     *
206
     * @param string $src  - Source of files being moved
207
     * @param string $dest - Destination of files being moved
208
     *
209
     * @uses \Xmf\Module\Helper::getHelper()
210
     * @uses \Xmf\Module\Helper::isUserAdmin()
211
     *
212
     * @return bool true on success
213
     */
214 View Code Duplication
    public static function rcopy($src, $dest)
0 ignored issues
show
Duplication introduced by
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...
Coding Style introduced by
rcopy uses the super-global variable $GLOBALS which is generally not recommended.

Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
215
    {
216
        // Only continue if user is a 'global' Admin
217
        if (!($GLOBALS['xoopsUser'] instanceof XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
0 ignored issues
show
Bug introduced by
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...
218
            return false;
219
        }
220
221
        // If source is not a directory stop processing
222
        if (!is_dir($src)) {
223
            return false;
224
        }
225
226
        // If the destination directory does not exist and could not be created stop processing
227
        if (!is_dir($dest) && !mkdir($dest, 0755)) {
228
            return false;
229
        }
230
231
        // Open the source directory to read in files
232
        $iterator = new DirectoryIterator($src);
233
        foreach ($iterator as $fObj) {
234
            if ($fObj->isFile()) {
235
                copy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
236
            } elseif (!$fObj->isDot() && $fObj->isDir()) {
237
                self::rcopy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
238
            }
239
        }
240
        return true;
241
    }
242
}
243