1
|
|
|
<?php namespace Xoopsmodules\xsitemap\common; |
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 |
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
|
|
|
* @throws \RuntimeException |
26
|
|
|
*/ |
27
|
|
|
public static function createFolder($folder) |
28
|
|
|
{ |
29
|
|
|
try { |
30
|
|
|
if (!file_exists($folder)) { |
31
|
|
|
if (!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
|
|
|
} |
38
|
|
|
catch (\RuntimeException $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
|
|
|
*/ |
57
|
|
|
public static function recurseCopy($src, $dst) |
58
|
|
|
{ |
59
|
|
|
$dir = opendir($src); |
60
|
|
|
// @mkdir($dst); |
61
|
|
|
if (!mkdir($dst) && !is_dir($dst)) { |
62
|
|
|
while (false !== ($file = readdir($dir))) { |
63
|
|
|
if (('.' !== $file) && ('..' !== $file)) { |
64
|
|
|
if (is_dir($src . '/' . $file)) { |
65
|
|
|
self::recurseCopy($src . '/' . $file, $dst . '/' . $file); |
66
|
|
|
} else { |
67
|
|
|
copy($src . '/' . $file, $dst . '/' . $file); |
68
|
|
|
} |
69
|
|
|
} |
70
|
|
|
} |
71
|
|
|
|
72
|
|
|
closedir($dir); |
73
|
|
|
} |
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()) { |
|
|
|
|
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()) { |
|
|
|
|
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; |
|
|
|
|
148
|
|
|
|
149
|
|
|
// Open the source directory to read in files |
150
|
|
|
$iterator = new \DirectoryIterator($src); |
151
|
|
|
foreach ($iterator as $fObj) { |
152
|
|
|
if (null !== $fObj && $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 |
|
|
|
|
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) |
|
|
|
|
176
|
|
|
{ |
177
|
|
|
// Only continue if user is a 'global' Admin |
178
|
|
|
if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) { |
|
|
|
|
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 |
|
|
|
|
201
|
|
|
} |
202
|
|
|
} |
203
|
|
|
$iterator = null; // clear iterator Obj to close file/directory |
|
|
|
|
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) |
|
|
|
|
219
|
|
|
{ |
220
|
|
|
// Only continue if user is a 'global' Admin |
221
|
|
|
if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) { |
|
|
|
|
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
|
|
|
|
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: