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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup FileBackend
*/
namespace Wikimedia\FileBackend\FileIteration;
use DirectoryIterator;
use FilesystemIterator;
use Iterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use UnexpectedValueException;
use Wikimedia\FileBackend\FileBackendError;
/**
* Wrapper around RecursiveDirectoryIterator/DirectoryIterator that
* catches exception or does any custom behavior that we may want.
* Do not use this class from places outside FSFileBackend.
*
* @ingroup FileBackend
*/
abstract class FSFileBackendList implements Iterator {
/** @var Iterator|null */
protected $iter;
/** @var string */
protected $lastError;
/** @var int */
protected $suffixStart;
/** @var int */
protected $pos = 0;
/** @var array */
protected $params = [];
/**
* @param string $dir File system directory
* @param array $params
*/
public function __construct( $dir, array $params ) {
$path = realpath( $dir ); // normalize
if ( $path === false ) {
$path = $dir;
}
$this->suffixStart = strlen( $path ) + 1; // size of "path/to/dir/"
$this->params = $params;
try {
$this->iter = $this->initIterator( $path );
} catch ( UnexpectedValueException $e ) {
$this->iter = null; // bad permissions? deleted?
$this->lastError = $e->getMessage();
}
}
/**
* Return an appropriate iterator object to wrap
*
* @param string $dir File system directory
* @return Iterator
* @throws UnexpectedValueException
*/
protected function initIterator( $dir ) {
if ( !empty( $this->params['topOnly'] ) ) { // non-recursive
# Get an iterator that will get direct sub-nodes
return new DirectoryIterator( $dir );
} else { // recursive
# Get an iterator that will return leaf nodes (non-directories)
# RecursiveDirectoryIterator extends FilesystemIterator.
# FilesystemIterator::SKIP_DOTS default is inconsistent in PHP 5.3.x.
$flags = FilesystemIterator::CURRENT_AS_SELF | FilesystemIterator::SKIP_DOTS;
return new RecursiveIteratorIterator(
new RecursiveDirectoryIterator( $dir, $flags ),
RecursiveIteratorIterator::CHILD_FIRST // include dirs
);
}
}
/**
* @see Iterator::key()
* @return int
*/
public function key(): int {
return $this->pos;
}
/**
* @see Iterator::current()
* @return string|false
*/
#[\ReturnTypeWillChange]
public function current() {
return $this->getRelPath( $this->iter->current()->getPathname() );
}
/**
* @see Iterator::next()
* @throws FileBackendError
*/
public function next(): void {
try {
$this->iter->next();
$this->filterViaNext();
} catch ( UnexpectedValueException $e ) { // bad permissions? deleted?
$this->lastError = $e->getMessage();
throw new FileBackendError( "File iterator gave UnexpectedValueException." );
}
++$this->pos;
}
/**
* @see Iterator::rewind()
* @throws FileBackendError
*/
public function rewind(): void {
$this->pos = 0;
try {
$this->iter->rewind();
$this->filterViaNext();
} catch ( UnexpectedValueException $e ) { // bad permissions? deleted?
$this->lastError = $e->getMessage();
throw new FileBackendError( "File iterator gave UnexpectedValueException." );
}
}
/**
* @see Iterator::valid()
* @return bool
*/
public function valid(): bool {
return $this->iter && $this->iter->valid();
}
/**
* @return string|null The last caught exception message
*/
public function getLastError() {
return $this->lastError;
}
/**
* Filter out items by advancing to the next ones
*/
protected function filterViaNext() {
}
/**
* Return only the relative path and normalize slashes to FileBackend-style.
* Uses the "real path" since the suffix is based upon that.
*
* @param string $dir
* @return string
*/
protected function getRelPath( $dir ) {
$path = realpath( $dir );
if ( $path === false ) {
$path = $dir;
}
return strtr( substr( $path, $this->suffixStart ), '\\', '/' );
}
}
/** @deprecated class alias since 1.43 */
class_alias( FSFileBackendList::class, 'FSFileBackendList' );
|
