1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace XoopsModules\Modulebuilder\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.php file |
24
|
|
|
* |
25
|
|
|
* @param string $folder The full path of the directory to check |
26
|
|
|
* |
27
|
|
|
* @return void |
28
|
|
|
* @throws \RuntimeException |
29
|
|
|
*/ |
30
|
|
|
public static function createFolder($folder) |
31
|
|
|
{ |
32
|
|
|
try { |
33
|
|
|
if (!\file_exists($folder)) { |
34
|
|
|
if (!\is_dir($folder) && !\mkdir($folder) && !\is_dir($folder)) { |
35
|
|
|
throw new \RuntimeException(\sprintf('Unable to create the %s directory', $folder)); |
36
|
|
|
} |
37
|
|
|
|
38
|
|
|
\file_put_contents($folder . '/index.php', "<?php\nheader('HTTP/1.0 404 Not Found');"); |
39
|
|
|
} |
40
|
|
|
} catch (\Exception $e) { |
41
|
|
|
echo 'Caught exception: ', $e->getMessage(), '<br>'; |
42
|
|
|
} |
43
|
|
|
} |
44
|
|
|
|
45
|
|
|
/** |
46
|
|
|
* @param $file |
47
|
|
|
* @param $folder |
48
|
|
|
* @return bool |
49
|
|
|
*/ |
50
|
|
|
public static function copyFile($file, $folder) |
51
|
|
|
{ |
52
|
|
|
return \copy($file, $folder); |
53
|
|
|
} |
54
|
|
|
|
55
|
|
|
/** |
56
|
|
|
* @param $src |
57
|
|
|
* @param $dst |
58
|
|
|
*/ |
59
|
|
|
public static function recurseCopy($src, $dst) |
60
|
|
|
{ |
61
|
|
|
$dir = \opendir($src); |
62
|
|
|
// @\mkdir($dst); |
63
|
|
|
if (!@\mkdir($dst) && !\is_dir($dst)) { |
64
|
|
|
throw new \RuntimeException('The directory ' . $dst . ' could not be created.'); |
65
|
|
|
} |
66
|
|
|
while (false !== ($file = \readdir($dir))) { |
67
|
|
|
if (('.' !== $file) && ('..' !== $file)) { |
68
|
|
|
if (\is_dir($src . '/' . $file)) { |
69
|
|
|
self::recurseCopy($src . '/' . $file, $dst . '/' . $file); |
70
|
|
|
} else { |
71
|
|
|
\copy($src . '/' . $file, $dst . '/' . $file); |
72
|
|
|
} |
73
|
|
|
} |
74
|
|
|
} |
75
|
|
|
\closedir($dir); |
76
|
|
|
} |
77
|
|
|
|
78
|
|
|
/** |
79
|
|
|
* Copy a file, or recursively copy a folder and its contents |
80
|
|
|
* @param string $source Source path |
81
|
|
|
* @param string $dest Destination path |
82
|
|
|
* @return bool Returns true on success, false on failure |
83
|
|
|
* @author Aidan Lister <[email protected]> |
84
|
|
|
* @version 1.0.1 |
85
|
|
|
* @link http://aidanlister.com/2004/04/recursively-copying-directories-in-php/ |
86
|
|
|
*/ |
87
|
|
|
public static function xcopy($source, $dest) |
88
|
|
|
{ |
89
|
|
|
// Check for symlinks |
90
|
|
|
if (\is_link($source)) { |
91
|
|
|
return \symlink(\readlink($source), $dest); |
92
|
|
|
} |
93
|
|
|
|
94
|
|
|
// Simple copy for a file |
95
|
|
|
if (\is_file($source)) { |
96
|
|
|
return \copy($source, $dest); |
97
|
|
|
} |
98
|
|
|
|
99
|
|
|
// Make destination directory |
100
|
|
|
if (!\is_dir($dest)) { |
101
|
|
|
if (!\mkdir($dest) && !\is_dir($dest)) { |
102
|
|
|
throw new \RuntimeException(\sprintf('Directory "%s" was not created', $dest)); |
103
|
|
|
} |
104
|
|
|
} |
105
|
|
|
|
106
|
|
|
// Loop through the folder |
107
|
|
|
$dir = \dir($source); |
108
|
|
|
if (@\is_dir($dir)) { |
|
|
|
|
109
|
|
|
while (false !== $entry = $dir->read()) { |
110
|
|
|
// Skip pointers |
111
|
|
|
if ('.' === $entry || '..' === $entry) { |
112
|
|
|
continue; |
113
|
|
|
} |
114
|
|
|
// Deep copy directories |
115
|
|
|
self::xcopy("$source/$entry", "$dest/$entry"); |
116
|
|
|
} |
117
|
|
|
// Clean up |
118
|
|
|
$dir->close(); |
119
|
|
|
} |
120
|
|
|
|
121
|
|
|
return true; |
122
|
|
|
} |
123
|
|
|
|
124
|
|
|
/** |
125
|
|
|
* Remove files and (sub)directories |
126
|
|
|
* |
127
|
|
|
* @param string $src source directory to delete |
128
|
|
|
* |
129
|
|
|
* @return bool true on success |
130
|
|
|
* @uses \Xmf\Module\Helper::isUserAdmin() |
131
|
|
|
* |
132
|
|
|
* @uses \Xmf\Module\Helper::getHelper() |
133
|
|
|
*/ |
134
|
|
|
public static function deleteDirectory($src) |
135
|
|
|
{ |
136
|
|
|
// Only continue if user is a 'global' Admin |
137
|
|
|
if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) { |
138
|
|
|
return false; |
139
|
|
|
} |
140
|
|
|
|
141
|
|
|
$success = true; |
142
|
|
|
// remove old files |
143
|
|
|
$dirInfo = new \SplFileInfo($src); |
144
|
|
|
// validate is a directory |
145
|
|
|
if ($dirInfo->isDir()) { |
146
|
|
|
$fileList = \array_diff(\scandir($src, \SCANDIR_SORT_NONE), ['..', '.']); |
147
|
|
|
foreach ($fileList as $k => $v) { |
148
|
|
|
$fileInfo = new \SplFileInfo("{$src}/{$v}"); |
149
|
|
|
if ($fileInfo->isDir()) { |
150
|
|
|
// recursively handle subdirectories |
151
|
|
|
if (!$success = self::deleteDirectory($fileInfo->getRealPath())) { |
152
|
|
|
break; |
153
|
|
|
} |
154
|
|
|
} else { |
155
|
|
|
// delete the file |
156
|
|
|
if (!($success = \unlink($fileInfo->getRealPath()))) { |
157
|
|
|
break; |
158
|
|
|
} |
159
|
|
|
} |
160
|
|
|
} |
161
|
|
|
// now delete this (sub)directory if all the files are gone |
162
|
|
|
if ($success) { |
163
|
|
|
$success = \rmdir($dirInfo->getRealPath()); |
164
|
|
|
} |
165
|
|
|
} else { |
166
|
|
|
// input is not a valid directory |
167
|
|
|
$success = false; |
168
|
|
|
} |
169
|
|
|
|
170
|
|
|
return $success; |
171
|
|
|
} |
172
|
|
|
|
173
|
|
|
/** |
174
|
|
|
* Recursively remove directory |
175
|
|
|
* |
176
|
|
|
* @todo currently won't remove directories with hidden files, should it? |
177
|
|
|
* |
178
|
|
|
* @param string $src directory to remove (delete) |
179
|
|
|
* |
180
|
|
|
* @return bool true on success |
181
|
|
|
*/ |
182
|
|
|
public static function rrmdir($src) |
183
|
|
|
{ |
184
|
|
|
// Only continue if user is a 'global' Admin |
185
|
|
|
if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) { |
186
|
|
|
return false; |
187
|
|
|
} |
188
|
|
|
|
189
|
|
|
// If source is not a directory stop processing |
190
|
|
|
if (!\is_dir($src)) { |
191
|
|
|
return false; |
192
|
|
|
} |
193
|
|
|
|
194
|
|
|
$success = true; |
|
|
|
|
195
|
|
|
|
196
|
|
|
// Open the source directory to read in files |
197
|
|
|
$iterator = new \DirectoryIterator($src); |
198
|
|
|
foreach ($iterator as $fObj) { |
199
|
|
|
if ($fObj->isFile()) { |
200
|
|
|
$filename = $fObj->getPathname(); |
201
|
|
|
$fObj = null; // clear this iterator object to close the file |
|
|
|
|
202
|
|
|
if (!\unlink($filename)) { |
203
|
|
|
return false; // couldn't delete the file |
204
|
|
|
} |
205
|
|
|
} elseif (!$fObj->isDot() && $fObj->isDir()) { |
206
|
|
|
// Try recursively on directory |
207
|
|
|
self::rrmdir($fObj->getPathname()); |
208
|
|
|
} |
209
|
|
|
} |
210
|
|
|
$iterator = null; // clear iterator Obj to close file/directory |
|
|
|
|
211
|
|
|
return \rmdir($src); // remove the directory & return results |
212
|
|
|
} |
213
|
|
|
|
214
|
|
|
/** |
215
|
|
|
* Recursively move files from one directory to another |
216
|
|
|
* |
217
|
|
|
* @param string $src - Source of files being moved |
218
|
|
|
* @param string $dest - Destination of files being moved |
219
|
|
|
* |
220
|
|
|
* @return bool true on success |
221
|
|
|
*/ |
222
|
|
|
public static function rmove($src, $dest) |
223
|
|
|
{ |
224
|
|
|
// Only continue if user is a 'global' Admin |
225
|
|
|
if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) { |
226
|
|
|
return false; |
227
|
|
|
} |
228
|
|
|
|
229
|
|
|
// If source is not a directory stop processing |
230
|
|
|
if (!\is_dir($src)) { |
231
|
|
|
return false; |
232
|
|
|
} |
233
|
|
|
|
234
|
|
|
// If the destination directory does not exist and could not be created stop processing |
235
|
|
|
if (!\is_dir($dest) && !\mkdir($dest) && !\is_dir($dest)) { |
236
|
|
|
return false; |
237
|
|
|
} |
238
|
|
|
|
239
|
|
|
// Open the source directory to read in files |
240
|
|
|
$iterator = new \DirectoryIterator($src); |
241
|
|
|
foreach ($iterator as $fObj) { |
242
|
|
|
if ($fObj->isFile()) { |
243
|
|
|
\rename($fObj->getPathname(), "{$dest}/" . $fObj->getFilename()); |
244
|
|
|
} elseif (!$fObj->isDot() && $fObj->isDir()) { |
245
|
|
|
// Try recursively on directory |
246
|
|
|
self::rmove($fObj->getPathname(), "{$dest}/" . $fObj->getFilename()); |
247
|
|
|
// \rmdir($fObj->getPath()); // now delete the directory |
248
|
|
|
} |
249
|
|
|
} |
250
|
|
|
$iterator = null; // clear iterator Obj to close file/directory |
|
|
|
|
251
|
|
|
return \rmdir($src); // remove the directory & return results |
252
|
|
|
} |
253
|
|
|
|
254
|
|
|
/** |
255
|
|
|
* Recursively copy directories and files from one directory to another |
256
|
|
|
* |
257
|
|
|
* @param string $src - Source of files being moved |
258
|
|
|
* @param string $dest - Destination of files being moved |
259
|
|
|
* |
260
|
|
|
* @return bool true on success |
261
|
|
|
* @uses \Xmf\Module\Helper::isUserAdmin() |
262
|
|
|
* |
263
|
|
|
* @uses \Xmf\Module\Helper::getHelper() |
264
|
|
|
*/ |
265
|
|
|
public static function rcopy($src, $dest) |
266
|
|
|
{ |
267
|
|
|
// Only continue if user is a 'global' Admin |
268
|
|
|
if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) { |
269
|
|
|
return false; |
270
|
|
|
} |
271
|
|
|
|
272
|
|
|
// If source is not a directory stop processing |
273
|
|
|
if (!\is_dir($src)) { |
274
|
|
|
return false; |
275
|
|
|
} |
276
|
|
|
|
277
|
|
|
// If the destination directory does not exist and could not be created stop processing |
278
|
|
|
if (!\is_dir($dest) && !\mkdir($dest) && !\is_dir($dest)) { |
279
|
|
|
return false; |
280
|
|
|
} |
281
|
|
|
|
282
|
|
|
// Open the source directory to read in files |
283
|
|
|
$iterator = new \DirectoryIterator($src); |
284
|
|
|
foreach ($iterator as $fObj) { |
285
|
|
|
if ($fObj->isFile()) { |
286
|
|
|
\copy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename()); |
287
|
|
|
} elseif (!$fObj->isDot() && $fObj->isDir()) { |
288
|
|
|
self::rcopy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename()); |
289
|
|
|
} |
290
|
|
|
} |
291
|
|
|
|
292
|
|
|
return true; |
293
|
|
|
} |
294
|
|
|
} |
295
|
|
|
|