Completed
Push — master ( 72613d...069c91 )
by Michael
02:16
created

FilesManagement::recurseCopy()   B

Complexity

Conditions 5
Paths 4

Size

Total Lines 15
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 5
eloc 10
nc 4
nop 2
dl 0
loc 15
rs 8.8571
c 0
b 0
f 0
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
        } catch (Exception $e) {
37
            echo 'Caught exception: ', $e->getMessage(), "\n", '<br>';
38
        }
39
    }
40
41
    /**
42
     * @param $file
43
     * @param $folder
44
     * @return bool
45
     */
46
    public static function copyFile($file, $folder)
47
    {
48
        return copy($file, $folder);
49
    }
50
51
    /**
52
     * @param $src
53
     * @param $dst
54
     */
55
    public static function recurseCopy($src, $dst)
56
    {
57
        $dir = opendir($src);
58
        @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...
59
        while (false !== ($file = readdir($dir))) {
60
            if (('.' !== $file) && ('..' !== $file)) {
61
                if (is_dir($src . '/' . $file)) {
62
                    self::recurseCopy($src . '/' . $file, $dst . '/' . $file);
63
                } else {
64
                    copy($src . '/' . $file, $dst . '/' . $file);
65
                }
66
            }
67
        }
68
        closedir($dir);
69
    }
70
71
    /**
72
     *
73
     * Remove files and (sub)directories
74
     *
75
     * @param string $src source directory to delete
76
     *
77
     * @uses \Xmf\Module\Helper::getHelper()
78
     * @uses \Xmf\Module\Helper::isUserAdmin()
79
     *
80
     * @return bool true on success
81
     */
82
    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...
83
    {
84
        // Only continue if user is a 'global' Admin
85
        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...
86
            return false;
87
        }
88
89
        $success = true;
90
        // remove old files
91
        $dirInfo = new SplFileInfo($src);
92
        // validate is a directory
93
        if ($dirInfo->isDir()) {
94
            $fileList = array_diff(scandir($src, SCANDIR_SORT_NONE), ['..', '.']);
95
            foreach ($fileList as $k => $v) {
96
                $fileInfo = new SplFileInfo("{$src}/{$v}");
97
                if ($fileInfo->isDir()) {
98
                    // recursively handle subdirectories
99
                    if (!$success = self::deleteDirectory($fileInfo->getRealPath())) {
100
                        break;
101
                    }
102
                } else {
103
                    // delete the file
104
                    if (!($success = unlink($fileInfo->getRealPath()))) {
105
                        break;
106
                    }
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
        return $success;
118
    }
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)
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...
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 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...
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 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...
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 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...
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 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...
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 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...
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, 0755)) {
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
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...
196
            }
197
        }
198
        $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...
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
     * @uses \Xmf\Module\Helper::getHelper()
209
     * @uses \Xmf\Module\Helper::isUserAdmin()
210
     *
211
     * @return bool true on success
212
     */
213 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...
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 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...
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, 0755)) {
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
        return true;
240
    }
241
}
242