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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
|
<?php
/**
* Lazy file iterator. Pulls directory listings when required.
*/
class Loco_fs_FileFinder implements Iterator, Countable, Loco_fs_FileListInterface {
/**
* Top-level search directories
* @var Loco_fs_FileList
*/
private $roots;
/**
* Directories to search, including those descended into
* @var Loco_fs_FileList|null
*/
private $subdir;
/**
* Whether directories all read into memory
* @var bool
*/
private $cached;
/**
* File listing already matched
* @var Loco_fs_FileList|null
*/
private $cache;
/**
* Internal array pointer for whole list of paths
* @var int
*/
private $i;
/**
* Internal pointer for directory being read
* @var int|null
*/
private $d;
/**
* Current directory being read
* @var resource|null
*/
private $dir;
/**
* Path of current directory being read
* @var string
*/
private $cwd;
/**
* Whether directories added to search will be recursive by default
* @var bool
*/
private $recursive = false;
/**
* Whether currently recursing into subdirectories
* This is switched on and off as each directories is opened
* @var bool|null
*/
private $recursing;
/**
* Whether to follow symlinks when recursing into subdirectories
* Root-level symlinks are always resolved when possible
* @var bool
*/
private $symlinks = true;
/**
* Registry of followed links by their original path
* @var Loco_fs_FileList|null
*/
private $linked;
/**
* List of file extensions to filter on and group by
* @var null|Loco_fs_FileList[]
*/
private $exts;
/**
* List of directory names to exclude from recursion
* @var null|Loco_fs_File[]
*/
private $excluded;
/**
* Create initial list of directories to search
* @param string $root default root to start
*/
public function __construct( $root = '' ){
$this->roots = new Loco_fs_FileList;
$this->linked = new Loco_fs_FileList;
$this->excluded = [];
if( $root ){
$this->addRoot( $root );
}
}
/**
* Set recursive state of all defined roots
* @param bool $bool
* @return Loco_fs_FileFinder
*/
public function setRecursive( $bool ){
$this->invalidate();
$this->recursive = $bool;
/* @var $dir Loco_fs_Directory */
foreach( $this->roots as $dir ){
$dir->setRecursive( $bool );
}
return $this;
}
/**
* @param bool $bool
* @return Loco_fs_FileFinder
*/
public function followLinks( $bool ){
$this->invalidate();
$this->symlinks = (bool) $bool;
return $this;
}
/**
* @param string $path
* @return Loco_fs_Link
*/
public function getFollowed( $path ){
$path = (string) $path;
/* @var Loco_fs_Link $link */
foreach( $this->linked as $link ){
$file = $link->resolve();
$orig = $file->getPath();
// exact match on followed path
if( $orig === $path ){
return $link;
}
// match further up the directory tree
if( $file instanceof Loco_fs_Directory ){
$orig = trailingslashit($orig);
$snip = strlen($orig);
if( $orig === substr($path,0,$snip) ){
return new Loco_fs_Link( $link->getPath().'/'.substr($path,$snip) );
}
}
}
return null;
}
/**
* @return void
*/
private function invalidate(){
$this->cached = false;
$this->cache = null;
$this->subdir = null;
}
/**
* @return Loco_fs_FileList
*/
public function export(){
if( ! $this->cached ){
$this->rewind();
while( $this->valid() ){
$this->next();
}
}
return $this->cache;
}
/**
* @return Loco_fs_FileList[]
*/
public function exportGroups(){
$this->cached || $this->export();
return $this->exts;
}
/**
* Add a directory root to search.
* @param string $root
* @param bool|null $recursive
* @return Loco_fs_FileFinder
*/
public function addRoot( $root, $recursive = null ){
$this->invalidate();
$dir = new Loco_fs_Directory($root);
$this->roots->add( $dir );
// new directory inherits current global setting unless set explicitly
$dir->setRecursive( is_bool($recursive) ? $recursive : $this->recursive );
return $this;
}
/**
* Get all root directories to be searched
* @return Loco_fs_FileList
*/
public function getRootDirectories(){
return $this->roots;
}
/**
* Filter results by given file extensions
* @return Loco_fs_FileFinder
*/
public function group( ...$exts ){
return $this->filterExtensions($exts);
}
/**
* Filter results by file extensions given in array
* @param string[] $exts File extension strings
* @return Loco_fs_FileFinder
*/
public function filterExtensions( array $exts ){
$this->invalidate();
$this->exts = [];
foreach( $exts as $ext ){
$this->exts[ ltrim($ext,'*.') ] = new Loco_fs_FileList;
}
return $this;
}
/**
* Add one or more paths to exclude from listing
* @return Loco_fs_FileFinder
*/
public function exclude( ...$paths ){
$this->invalidate();
foreach( $paths as $path ){
$file = new Loco_fs_File($path);
// if path is absolute, add straight onto list
if( $file->isAbsolute() ){
$file->normalize();
$this->excluded[] = $file;
}
// else append to all defined roots
else {
foreach( $this->roots as $dir ) {
$file = new Loco_fs_File( $dir.'/'.$path );
$file->normalize();
$this->excluded[] = $file;
}
}
}
return $this;
}
/**
* Export excluded paths as file objects
* @return Loco_fs_File[]
*/
public function getExcluded(){
return $this->excluded;
}
/**
* @param Loco_fs_Directory $dir
* @return void
*/
private function open( Loco_fs_Directory $dir ){
$path = $dir->getPath();
$recursive = $dir->isRecursive();
if( is_link($path) ){
$link = new Loco_fs_Link($path);
if( $link->isDirectory() ){
$path = $link->resolve()->getPath();
$this->linked->add($link);
}
}
$this->cwd = $path;
$this->recursing = $recursive;
$this->dir = opendir($path);
}
/**
* @return void
*/
private function close(){
closedir( $this->dir );
$this->dir = null;
$this->recursing = null;
}
/**
* Test if given path is matched by one of our exclude rules
* @param string $path
* @return bool
*/
public function isExcluded( $path ){
/* @var Loco_fs_File $excl */
foreach( $this->excluded as $excl ){
if( $excl->equal($path) ){
return true;
}
}
return false;
}
/**
* Read next valid file path from root directories
* @return Loco_fs_File|null
*/
private function read(){
while( is_resource($this->dir) ){
while( $f = readdir($this->dir) ){
// dot-files always excluded
if( '.' === substr($f,0,1) ){
continue;
}
$path = $this->cwd.'/'.$f;
// early path exclusion check
if( $this->isExcluded($path) ){
continue;
}
// early filter on file extension when grouping
if( is_array($this->exts) ){
$ext = pathinfo($f,PATHINFO_EXTENSION);
// missing file extension only relevant for directories
if( '' === $ext ){
if( ! $this->recursing || ! is_dir($path) ){
continue;
}
}
// any other extension can be skipped
else if( ! array_key_exists($ext,$this->exts) ){
continue;
}
}
// follow symlinks (subdir hash ensures against loops)
if( is_link($path) ){
if( ! $this->symlinks ){
continue;
}
$link = new Loco_fs_Link($path);
if( $file = $link->resolve() ){
$path = $file->getPath();
if( $this->isExcluded($path) ){
continue;
}
$this->linked->add($link);
}
else {
continue;
}
}
// add subdirectory to recursion list, or skip
if( is_dir($path) ){
if( $this->recursing ){
$subdir = new Loco_fs_Directory($path);
$subdir->setRecursive(true);
$this->subdir->add( $subdir );
}
continue;
}
// file represented as object containing original path
$file = new Loco_fs_File($path);
$this->add($file);
return $file;
}
$this->close();
// Advance directory and continue outer loop
$d = $this->d + 1;
if( $this->subdir->offsetExists($d) ){
$this->d = $d;
$this->open( $this->subdir->offsetGet($d) );
}
// else no directories left to search
else {
break;
}
}
// at end of all available files
$this->cached = true;
return null;
}
/**
* {@inheritDoc}
*/
public function add( Loco_fs_File $file ){
if( is_array($this->exts) ){
$ext = $file->extension();
/*if( '' === $ext || ! array_key_exists($ext,$this->exts) ){
throw new LogicException('Should have filtered out '.$file->basename().' when grouping by *.{'.implode(',',array_keys($this->exts)).'}' );
}*/
$this->exts[$ext]->add($file);
}
if( $this->cache->add($file) ){
$this->i++;
return true;
}
return false;
}
/**
* @return int
*/
#[ReturnTypeWillChange]
public function count(){
return count( $this->export() );
}
/**
* @return Loco_fs_File|null
*/
#[ReturnTypeWillChange]
public function current(){
$i = $this->i;
if( is_int($i) && isset($this->cache[$i]) ){
return $this->cache[$i];
}
return null;
}
/**
* @return Loco_fs_File|null
*/
#[ReturnTypeWillChange]
public function next(){
if( $this->cached ){
$i = $this->i + 1;
if( isset($this->cache[$i]) ){
$this->i = $i;
return $this->cache[$i];
}
}
else {
$file = $this->read();
if( $file instanceof Loco_fs_File ) {
return $file;
}
}
// else at end of all directory listings
$this->i = null;
return null;
}
/**
* @return int
*/
#[ReturnTypeWillChange]
public function key(){
return $this->i;
}
/**
* @return bool
*/
#[ReturnTypeWillChange]
public function valid(){
// may be in lazy state after rewind
// must do initial read now in case list is empty
return is_int($this->i);
}
/**
* @return void
*/
#[ReturnTypeWillChange]
public function rewind(){
if( $this->cached ){
$this->cache->rewind();
$this->i = $this->cache->key();
}
else {
$this->d = 0;
$this->dir = null;
$this->cache = new Loco_fs_FileList;
// add only root directories that exist
$this->subdir = new Loco_fs_FileList;
/* @var Loco_fs_Directory $root */
foreach( $this->roots as $root ){
if( $root instanceof Loco_fs_Directory && $root->readable() && ! $this->isExcluded( $root->getPath() ) ){
$this->subdir->add($root);
}
}
if( $this->subdir->offsetExists(0) ){
$this->i = -1;
$this->open( $this->subdir->offsetGet(0) );
$this->next();
}
else {
$this->i = null;
$this->subdir = null;
$this->cached = true;
}
}
}
/**
* Test whether internal list has been fully cached in memory
* @return bool
*/
public function isCached(){
return $this->cached;
}
}
|