-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Base.php
267 lines (238 loc) · 5.81 KB
/
Base.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
<?php
/**
* This file is part of Camino.
*
* (c) Sebastian Feldmann <sf@sebastian-feldmann.info>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace SebastianFeldmann\Camino\Path;
use RuntimeException;
use SebastianFeldmann\Camino\Path;
/**
* Base path class for files and directories
*
* @package SebastianFeldmann\Camino
*/
abstract class Base implements Path
{
/**
* The originally given path
*
* @var string
*/
protected $raw;
/**
* The path without the root (/, C:/, stream://)
*
* @var string
*/
protected $path;
/**
* Amount of path segments
*
* @var int
*/
protected $depth;
/**
* List of path segments
*
* @var string[]
*/
protected $segments;
/**
* The path root (/, C:/, stream://)
*
* @var string
*/
protected $root;
/**
* Absolute constructor.
*
* @param string $path
*/
public function __construct(string $path)
{
$this->raw = $path;
$this->normalize($path);
}
/**
* Normalize a path detect root and segments
*
* @param string $path
*/
private function normalize(string $path): void
{
// absolute linux|unix path
if (substr($path, 0, 1) === '/') {
$this->root = '/';
$this->path = ltrim($path, '/');
$this->detectSegments($this->path);
return;
}
// check windows path
if ($this->normalizeWindows($path)) {
return;
}
// check streams
if ($this->normalizeStream($path)) {
return;
}
throw new RuntimeException('path must be absolute');
}
/**
* Normalize a windows path
*
* @param string $path
* @return bool
*/
private function normalizeWindows(string $path): bool
{
// check for C:\ or C:/
$driveMatch = [];
if (strlen($path) >= 3 && preg_match('#^([A-Z]\:)[/\\\]#i', substr($path, 0, 3), $driveMatch)) {
$this->root = $driveMatch[1];
$path = substr($path, 2);
}
if (substr($path, 0, 1) === '\\') {
$this->root = trim($this->root, '/\\') . '/';
$this->path = trim(str_replace('\\', '/', $path), '/');
$this->detectSegments($this->path);
return true;
}
return false;
}
/**
* Normalize a stream path
*
* @param string $path
* @return bool
*/
private function normalizeStream(string $path): bool
{
$schemeMatch = [];
if (strlen($path) > 4 && preg_match('#^([A-Z]+\://).#i', $path, $schemeMatch)) {
$this->root = $schemeMatch[1];
$this->path = substr($path, strlen($this->root));
$this->detectSegments($this->path);
return true;
}
return false;
}
/**
* Detect all path segments
*
* @param string $path
*/
private function detectSegments(string $path)
{
$this->segments = empty($path) ? [] : explode('/', trim($path, '/'));
$this->depth = count($this->segments);
}
/**
* Path getter
*
* @return string
*/
public function getPath(): string
{
return $this->raw;
}
/**
* Root getter
*
* @return string
*/
public function getRoot(): string
{
return $this->root;
}
/**
* Depth getter
*
* @return int
*/
public function getDepth(): int
{
return $this->depth;
}
/**
* Segments getter
*
* @return array
*/
public function getSegments(): array
{
return $this->segments;
}
/**
* Check if a path is child of a given parent path
*
* @param \SebastianFeldmann\Camino\Path\Directory $parent
* @return bool
*/
public function isChildOf(Directory $parent): bool
{
if (!$this->isPossibleParent($parent)) {
return false;
}
// check every path segment of the parent
foreach ($parent->getSegments() as $index => $name) {
if ($this->segments[$index] !== $name) {
return false;
}
}
return true;
}
/**
* Returns the relative path from a parent directory to this one
*
* @param \SebastianFeldmann\Camino\Path\Directory $parent
* @return string
*/
public function getRelativePathFrom(Directory $parent): string
{
if (!$this->isChildOf($parent)) {
throw new RuntimeException($this->getPath() . ' is not a child of ' . $parent->getPath());
}
return implode('/', array_slice($this->segments, $parent->getDepth()));
}
/**
* Check if a Directory possibly be a parent directory
*
* @param \SebastianFeldmann\Camino\Path\Directory $parent
* @return bool
*/
protected function isPossibleParent(Directory $parent): bool
{
// if the root is different it can't be a subdirectory
if (!$this->hasSameRootAs($parent)) {
return false;
}
// if the parent has a deeper nesting level it can't be a parent
if ($parent->getDepth() > $this->getDepth()) {
return false;
}
return true;
}
/**
* Check if a given path has the same root
*
* @param \SebastianFeldmann\Camino\Path $path
* @return bool
*/
protected function hasSameRootAs(Path $path): bool
{
return $this->root === $path->getRoot();
}
/**
* To string conversion method
*
* @return string
*/
public function __toString(): string
{
return $this->raw;
}
}