FilesManagement   C
last analyzed

Complexity

Total Complexity 54

Size/Duplication

Total Lines 221
Duplicated Lines 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
wmc 54
eloc 80
c 1
b 0
f 0
dl 0
loc 221
rs 6.4799

7 Methods

Rating   Name   Duplication   Size   Complexity  
B rmove() 0 30 11
A copyFile() 0 3 1
B rrmdir() 0 30 9
B rcopy() 0 28 11
A createFolder() 0 12 6
B deleteDirectory() 0 34 9
B recurseCopy() 0 17 7

How to fix   Complexity   

Complex Class

Complex classes like FilesManagement 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.

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 FilesManagement, and based on these observations, apply Extract Interface, too.

1
<?php
2
3
namespace XoopsModules\Statistics\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))) {
0 ignored issues
show
Bug introduced by
It seems like $dir can also be of type false; however, parameter $dir_handle of readdir() does only seem to accept resource, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

63
        while (false !== ($file = \readdir(/** @scrutinizer ignore-type */ $dir))) {
Loading history...
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);
0 ignored issues
show
Bug introduced by
It seems like $dir can also be of type false; however, parameter $dir_handle of closedir() does only seem to accept resource, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

72
        \closedir(/** @scrutinizer ignore-type */ $dir);
Loading history...
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()) {
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), ['..', '.']);
0 ignored issues
show
Bug introduced by
It seems like scandir($src, SCANDIR_SORT_NONE) can also be of type false; however, parameter $array1 of array_diff() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

97
            $fileList = \array_diff(/** @scrutinizer ignore-type */ \scandir($src, \SCANDIR_SORT_NONE), ['..', '.']);
Loading history...
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()) {
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
The assignment to $success is dead and can be removed.
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
0 ignored issues
show
Unused Code introduced by
The assignment to $fObj is dead and can be removed.
Loading history...
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
The assignment to $iterator is dead and can be removed.
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
    public static function rmove($src, $dest)
171
    {
172
        // Only continue if user is a 'global' Admin
173
        if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
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 by
The assignment to $iterator is dead and can be removed.
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
    public static function rcopy($src, $dest)
214
    {
215
        // Only continue if user is a 'global' Admin
216
        if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
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