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
|
<?php
namespace Sabre\DAV;
/**
* This class holds all the information about a PROPFIND request.
*
* It contains the type of PROPFIND request, which properties were requested
* and also the returned items.
*/
class PropFind {
/**
* A normal propfind
*/
const NORMAL = 0;
/**
* An allprops request.
*
* While this was originally intended for instructing the server to really
* fetch every property, because it was used so often and it's so heavy
* this turned into a small list of default properties after a while.
*
* So 'all properties' now means a hardcoded list.
*/
const ALLPROPS = 1;
/**
* A propname request. This just returns a list of properties that are
* defined on a node, without their values.
*/
const PROPNAME = 2;
/**
* Creates the PROPFIND object
*
* @param string $path
* @param array $properties
* @param int $depth
* @param int $requestType
*/
function __construct($path, array $properties, $depth = 0, $requestType = self::NORMAL) {
$this->path = $path;
$this->properties = $properties;
$this->depth = $depth;
$this->requestType = $requestType;
if ($requestType === self::ALLPROPS) {
$this->properties = [
'{DAV:}getlastmodified',
'{DAV:}getcontentlength',
'{DAV:}resourcetype',
'{DAV:}quota-used-bytes',
'{DAV:}quota-available-bytes',
'{DAV:}getetag',
'{DAV:}getcontenttype',
];
}
foreach ($this->properties as $propertyName) {
// Seeding properties with 404's.
$this->result[$propertyName] = [404, null];
}
$this->itemsLeft = count($this->result);
}
/**
* Handles a specific property.
*
* This method checks whether the specified property was requested in this
* PROPFIND request, and if so, it will call the callback and use the
* return value for it's value.
*
* Example:
*
* $propFind->handle('{DAV:}displayname', function() {
* return 'hello';
* });
*
* Note that handle will only work the first time. If null is returned, the
* value is ignored.
*
* It's also possible to not pass a callback, but immediately pass a value
*
* @param string $propertyName
* @param mixed $valueOrCallBack
* @return void
*/
function handle($propertyName, $valueOrCallBack) {
if ($this->itemsLeft && isset($this->result[$propertyName]) && $this->result[$propertyName][0] === 404) {
if (is_callable($valueOrCallBack)) {
$value = $valueOrCallBack();
} else {
$value = $valueOrCallBack;
}
if (!is_null($value)) {
$this->itemsLeft--;
$this->result[$propertyName] = [200, $value];
}
}
}
/**
* Sets the value of the property
*
* If status is not supplied, the status will default to 200 for non-null
* properties, and 404 for null properties.
*
* @param string $propertyName
* @param mixed $value
* @param int $status
* @return void
*/
function set($propertyName, $value, $status = null) {
if (is_null($status)) {
$status = is_null($value) ? 404 : 200;
}
// If this is an ALLPROPS request and the property is
// unknown, add it to the result; else ignore it:
if (!isset($this->result[$propertyName])) {
if ($this->requestType === self::ALLPROPS) {
$this->result[$propertyName] = [$status, $value];
}
return;
}
if ($status !== 404 && $this->result[$propertyName][0] === 404) {
$this->itemsLeft--;
} elseif ($status === 404 && $this->result[$propertyName][0] !== 404) {
$this->itemsLeft++;
}
$this->result[$propertyName] = [$status, $value];
}
/**
* Returns the current value for a property.
*
* @param string $propertyName
* @return mixed
*/
function get($propertyName) {
return isset($this->result[$propertyName]) ? $this->result[$propertyName][1] : null;
}
/**
* Returns the current status code for a property name.
*
* If the property does not appear in the list of requested properties,
* null will be returned.
*
* @param string $propertyName
* @return int|null
*/
function getStatus($propertyName) {
return isset($this->result[$propertyName]) ? $this->result[$propertyName][0] : null;
}
/**
* Updates the path for this PROPFIND.
*
* @param string $path
* @return void
*/
function setPath($path) {
$this->path = $path;
}
/**
* Returns the path this PROPFIND request is for.
*
* @return string
*/
function getPath() {
return $this->path;
}
/**
* Returns the depth of this propfind request.
*
* @return int
*/
function getDepth() {
return $this->depth;
}
/**
* Updates the depth of this propfind request.
*
* @param int $depth
* @return void
*/
function setDepth($depth) {
$this->depth = $depth;
}
/**
* Returns all propertynames that have a 404 status, and thus don't have a
* value yet.
*
* @return array
*/
function get404Properties() {
if ($this->itemsLeft === 0) {
return [];
}
$result = [];
foreach ($this->result as $propertyName => $stuff) {
if ($stuff[0] === 404) {
$result[] = $propertyName;
}
}
return $result;
}
/**
* Returns the full list of requested properties.
*
* This returns just their names, not a status or value.
*
* @return array
*/
function getRequestedProperties() {
return $this->properties;
}
/**
* Returns true if this was an '{DAV:}allprops' request.
*
* @return bool
*/
function isAllProps() {
return $this->requestType === self::ALLPROPS;
}
/**
* Returns a result array that's often used in multistatus responses.
*
* The array uses status codes as keys, and property names and value pairs
* as the value of the top array.. such as :
*
* [
* 200 => [ '{DAV:}displayname' => 'foo' ],
* ]
*
* @return array
*/
function getResultForMultiStatus() {
$r = [
200 => [],
404 => [],
];
foreach ($this->result as $propertyName => $info) {
if (!isset($r[$info[0]])) {
$r[$info[0]] = [$propertyName => $info[1]];
} else {
$r[$info[0]][$propertyName] = $info[1];
}
}
// Removing the 404's for multi-status requests.
if ($this->requestType === self::ALLPROPS) unset($r[404]);
return $r;
}
/**
* The path that we're fetching properties for.
*
* @var string
*/
protected $path;
/**
* The Depth of the request.
*
* 0 means only the current item. 1 means the current item + its children.
* It can also be DEPTH_INFINITY if this is enabled in the server.
*
* @var int
*/
protected $depth = 0;
/**
* The type of request. See the TYPE constants
*/
protected $requestType;
/**
* A list of requested properties
*
* @var array
*/
protected $properties = [];
/**
* The result of the operation.
*
* The keys in this array are property names.
* The values are an array with two elements: the http status code and then
* optionally a value.
*
* Example:
*
* [
* "{DAV:}owner" : [404],
* "{DAV:}displayname" : [200, "Admin"]
* ]
*
* @var array
*/
protected $result = [];
/**
* This is used as an internal counter for the number of properties that do
* not yet have a value.
*
* @var int
*/
protected $itemsLeft;
}
|
