-
-
Notifications
You must be signed in to change notification settings - Fork 25
/
Filesystem.php
468 lines (409 loc) · 12.9 KB
/
Filesystem.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
<?php namespace Winter\Storm\Filesystem;
use DirectoryIterator;
use FilesystemIterator;
use ReflectionClass;
use Winter\Storm\Support\Facades\Config;
use Illuminate\Filesystem\Filesystem as FilesystemBase;
/**
* File helper
*
* @author Alexey Bobkov, Samuel Georges
*/
class Filesystem extends FilesystemBase
{
/**
* Default file permission mask as a string ("777").
*/
public ?string $filePermissions = null;
/**
* Default folder permission mask as a string ("777").
*/
public ?string $folderPermissions = null;
/**
* Known path symbols and their prefixes.
*/
public array $pathSymbols = [];
/**
* Symlinks within base folder
*/
protected ?array $symlinks = null;
/**
* Determine if the given path contains no files.
*
* Returns a boolean regarding if the directory is empty or not. If the directory does not exist or is not
* readable, this method will return `null`.
*/
public function isDirectoryEmpty(string $directory): ?bool
{
if (!is_readable($directory)) {
return null;
}
$handle = opendir($directory);
while (false !== ($entry = readdir($handle))) {
if ($entry != '.' && $entry != '..') {
closedir($handle);
return false;
}
}
closedir($handle);
return true;
}
/**
* Converts a file size in bytes to a human readable format.
*/
public function sizeToString(int $bytes): string
{
if ($bytes >= 1073741824) {
return number_format($bytes / 1073741824, 2) . ' GB';
}
if ($bytes >= 1048576) {
return number_format($bytes / 1048576, 2) . ' MB';
}
if ($bytes >= 1024) {
return number_format($bytes / 1024, 2) . ' KB';
}
if ($bytes > 1) {
return $bytes . ' bytes';
}
if ($bytes == 1) {
return $bytes . ' byte';
}
return '0 bytes';
}
/**
* Returns a public file path from an absolute path.
*
* Eg: `/home/mysite/public_html/welcome` -> `/welcome`
*
* Returns `null` if the path cannot be converted.
*/
public function localToPublic(string $path): ?string
{
$result = null;
$publicPath = public_path();
if (strpos($path, $publicPath) === 0) {
$result = str_replace("\\", "/", substr($path, strlen($publicPath)));
} else {
/**
* Find symlinks within base folder and work out if this path can be resolved to a symlinked directory.
*
* This abides by the `cms.restrictBaseDir` config and will not allow symlinks to external directories
* if the restriction is enabled.
*/
if ($this->symlinks === null) {
$this->findSymlinks();
}
if (count($this->symlinks) > 0) {
foreach ($this->symlinks as $source => $target) {
if (strpos($path, $target) === 0) {
$relativePath = substr($path, strlen($target));
$result = str_replace("\\", "/", substr($source, strlen($publicPath)) . $relativePath);
break;
}
}
}
}
return $result;
}
/**
* Returns whether the file path is an absolute path.
* @see Symfony\Component\Filesystem\Filesystem::isAbsolutePath()
*/
public function isAbsolutePath(string $file): bool
{
return '' !== $file && (strspn($file, '/\\', 0, 1)
|| (\strlen($file) > 3 && ctype_alpha($file[0])
&& ':' === $file[1]
&& strspn($file, '/\\', 2, 1)
)
|| null !== parse_url($file, \PHP_URL_SCHEME)
);
}
/**
* Determines if the given path is a local path.
*
* Returns `true` if the path is local, `false` otherwise.
*
* @param string $path The path to check
* @param boolean $realpath If `true` (default), the `realpath()` method will be used to resolve symlinks before checking if
* the path is local. Set to `false` if you are looking up non-existent paths.
*/
public function isLocalPath(string $path, bool $realpath = true): bool
{
$base = base_path();
if ($realpath) {
$path = realpath($path);
}
return !($path === false || strncmp($path, $base, strlen($base)) !== 0);
}
/**
* Determines if the given disk is using the "local" driver.
*/
public function isLocalDisk(\Illuminate\Filesystem\FilesystemAdapter $disk): bool
{
return ($disk->getAdapter() instanceof \League\Flysystem\Local\LocalFilesystemAdapter);
}
/**
* Finds the path of a given class.
*
* Returns `false` if the path cannot be determined.
*
* @param string|object $className Class name or object
*/
public function fromClass(string|object $className): string|false
{
$reflector = new ReflectionClass($className);
return $reflector->getFileName();
}
/**
* Determines if a file exists (ignoring the case for the filename only).
*/
public function existsInsensitive(string $path): string|false
{
if ($this->exists($path)) {
return $path;
}
$directoryName = dirname($path);
$pathLower = strtolower($path);
if (!$files = $this->glob($directoryName . '/*', GLOB_NOSORT)) {
return false;
}
foreach ($files as $file) {
if (strtolower($file) == $pathLower) {
return $file;
}
}
return false;
}
/**
* Normalizes the directory separator, often used by Windows systems.
*/
public function normalizePath(string $path): string
{
return str_replace('\\', '/', $path);
}
/**
* Converts a path using path symbol.
*
* Returns the original path if no symbol is used, and no default is specified.
*/
public function symbolizePath(string $path, string|bool|null $default = null): string
{
if (!$this->isPathSymbol($path)) {
return (is_null($default)) ? $path : $default;
}
$firstChar = substr($path, 0, 1);
$_path = substr($path, 1);
return $this->pathSymbols[$firstChar] . $_path;
}
/**
* Determines if the given path is using a path symbol.
*/
public function isPathSymbol(string $path): bool
{
return array_key_exists(substr($path, 0, 1), $this->pathSymbols);
}
/**
* Write the contents of a file.
*
* This method will also set the permissions based on the given chmod() mask in use.
*
* Returns the number of bytes written to the file, or `false` on failure.
*
* @param string $path
* @param string $contents
* @param bool|int $lock
* @return int|false
*/
public function put($path, $contents, $lock = false)
{
$result = parent::put($path, $contents, $lock);
$this->chmod($path);
return $result;
}
/**
* Copy a file to a new location.
*
* This method will also set the permissions based on the given chmod() mask in use.
*
* Returns `true` if successful, or `false` on failure.
*
* @param string $path
* @param string $target
* @return bool
*/
public function copy($path, $target)
{
$result = parent::copy($path, $target);
$this->chmod($target);
return $result;
}
/**
* Create a directory.
*
* @param string $path
* @param int $mode
* @param bool $recursive
* @param bool $force
* @return bool
*/
public function makeDirectory($path, $mode = 0777, $recursive = false, $force = false)
{
$mask = $this->getFolderPermissions();
if (!is_null($mask)) {
$mode = $mask;
}
/*
* Find the green leaves
*/
if ($recursive === true && !is_null($mask)) {
$chmodPath = $path;
while (true) {
$basePath = dirname($chmodPath);
if ($chmodPath === $basePath) {
break;
}
if ($this->isDirectory($basePath)) {
break;
}
$chmodPath = $basePath;
}
} else {
$chmodPath = $path;
}
/*
* Make the directory
*/
$result = parent::makeDirectory($path, $mode, $recursive, $force);
/*
* Apply the permissions
*/
if ($mask) {
$this->chmod($chmodPath, $mask);
if ($recursive) {
$this->chmodRecursive($chmodPath, null, $mask);
}
}
return $result;
}
/**
* Modify file/folder permissions.
*
* @param string $path
* @param int|float|null $mask
* @return bool
*/
public function chmod($path, $mask = null)
{
if (!$mask) {
$mask = $this->isDirectory($path)
? $this->getFolderPermissions()
: $this->getFilePermissions();
}
if (!$mask) {
return false;
}
return @chmod($path, $mask);
}
/**
* Modify file/folder permissions recursively in a given path.
*/
public function chmodRecursive(string $path, int|float|null $fileMask = null, int|float|null $directoryMask = null): void
{
if (!$fileMask) {
$fileMask = $this->getFilePermissions();
}
if (!$directoryMask) {
$directoryMask = $this->getFolderPermissions() ?: $fileMask;
}
if (!$fileMask) {
return;
}
if (!$this->isDirectory($path)) {
$this->chmod($path, $fileMask);
return;
}
$items = new FilesystemIterator($path, FilesystemIterator::SKIP_DOTS);
foreach ($items as $item) {
if ($item->isDir()) {
$_path = $item->getPathname();
$this->chmod($_path, $directoryMask);
$this->chmodRecursive($_path, $fileMask, $directoryMask);
}
else {
$this->chmod($item->getPathname(), $fileMask);
}
}
}
/**
* Returns the default file permission mask to use.
*/
public function getFilePermissions(): int|float|null
{
return $this->filePermissions
? octdec($this->filePermissions)
: null;
}
/**
* Returns the default folder permission mask to use.
*/
public function getFolderPermissions(): int|float|null
{
return $this->folderPermissions
? octdec($this->folderPermissions)
: null;
}
/**
* Match filename against a pattern.
*/
public function fileNameMatch(string $fileName, string $pattern): bool
{
if ($pattern === $fileName) {
return true;
}
$regex = strtr(preg_quote($pattern, '#'), ['\*' => '.*', '\?' => '.']);
return (bool) preg_match('#^' . $regex . '$#i', $fileName);
}
/**
* Finds symlinks within the base path and populates the local symlinks property with an array of source => target symlinks.
*/
protected function findSymlinks(): void
{
$restrictBaseDir = Config::get('cms.restrictBaseDir', true);
$deep = Config::get('develop.allowDeepSymlinks', false);
$basePath = base_path();
$symlinks = [];
$iterator = function ($path) use (&$iterator, &$symlinks, $basePath, $restrictBaseDir, $deep) {
foreach (new DirectoryIterator($path) as $directory) {
if (
$directory->isDot()
|| !$directory->isDir()
) {
continue;
}
if ($directory->isLink()) {
$source = $directory->getPathname();
$target = realpath(readlink($directory->getPathname()));
if (!$target) {
$target = realpath($directory->getPath() . '/' . readlink($directory->getPathname()));
if (!$target) {
// Cannot resolve symlink
continue;
}
}
if ($restrictBaseDir && strpos($target . '/', $basePath . '/') !== 0) {
continue;
}
$symlinks[$source] = $target;
continue;
}
// Get subfolders if "develop.allowDeepSymlinks" is enabled.
if ($deep) {
$iterator($directory->getPathname());
}
}
};
$iterator($basePath);
$this->symlinks = $symlinks;
}
}