@@ -86,7 +86,7 @@ discard block |
||
86 | 86 | */ |
87 | 87 | public function setId($id) { |
88 | 88 | if (is_int($id)) { |
89 | - $id = (string)$id; |
|
89 | + $id = (string) $id; |
|
90 | 90 | } |
91 | 91 | |
92 | 92 | if (!is_string($id)) { |
@@ -115,7 +115,7 @@ discard block |
||
115 | 115 | if ($this->providerId === null || $this->id === null) { |
116 | 116 | throw new \UnexpectedValueException; |
117 | 117 | } |
118 | - return $this->providerId . ':' . $this->id; |
|
118 | + return $this->providerId.':'.$this->id; |
|
119 | 119 | } |
120 | 120 | |
121 | 121 | /** |
@@ -163,7 +163,7 @@ discard block |
||
163 | 163 | |
164 | 164 | $nodes = $userFolder->getById($this->fileId); |
165 | 165 | if (empty($nodes)) { |
166 | - throw new NotFoundException('Node for share not found, fileid: ' . $this->fileId); |
|
166 | + throw new NotFoundException('Node for share not found, fileid: '.$this->fileId); |
|
167 | 167 | } |
168 | 168 | |
169 | 169 | $this->node = $nodes[0]; |
@@ -41,583 +41,583 @@ |
||
41 | 41 | use OCP\Share\IShare; |
42 | 42 | |
43 | 43 | class Share implements IShare { |
44 | - /** @var string */ |
|
45 | - private $id; |
|
46 | - /** @var string */ |
|
47 | - private $providerId; |
|
48 | - /** @var Node */ |
|
49 | - private $node; |
|
50 | - /** @var int */ |
|
51 | - private $fileId; |
|
52 | - /** @var string */ |
|
53 | - private $nodeType; |
|
54 | - /** @var int */ |
|
55 | - private $shareType; |
|
56 | - /** @var string */ |
|
57 | - private $sharedWith; |
|
58 | - /** @var string */ |
|
59 | - private $sharedWithDisplayName; |
|
60 | - /** @var string */ |
|
61 | - private $sharedWithAvatar; |
|
62 | - /** @var string */ |
|
63 | - private $sharedBy; |
|
64 | - /** @var string */ |
|
65 | - private $shareOwner; |
|
66 | - /** @var int */ |
|
67 | - private $permissions; |
|
68 | - /** @var IAttributes */ |
|
69 | - private $attributes; |
|
70 | - /** @var int */ |
|
71 | - private $status; |
|
72 | - /** @var string */ |
|
73 | - private $note = ''; |
|
74 | - /** @var \DateTime */ |
|
75 | - private $expireDate; |
|
76 | - /** @var string */ |
|
77 | - private $password; |
|
78 | - private ?\DateTimeInterface $passwordExpirationTime = null; |
|
79 | - /** @var bool */ |
|
80 | - private $sendPasswordByTalk = false; |
|
81 | - /** @var string */ |
|
82 | - private $token; |
|
83 | - /** @var int */ |
|
84 | - private $parent; |
|
85 | - /** @var string */ |
|
86 | - private $target; |
|
87 | - /** @var \DateTime */ |
|
88 | - private $shareTime; |
|
89 | - /** @var bool */ |
|
90 | - private $mailSend; |
|
91 | - /** @var string */ |
|
92 | - private $label = ''; |
|
93 | - |
|
94 | - /** @var IRootFolder */ |
|
95 | - private $rootFolder; |
|
96 | - |
|
97 | - /** @var IUserManager */ |
|
98 | - private $userManager; |
|
99 | - |
|
100 | - /** @var ICacheEntry|null */ |
|
101 | - private $nodeCacheEntry; |
|
102 | - |
|
103 | - /** @var bool */ |
|
104 | - private $hideDownload = false; |
|
105 | - |
|
106 | - public function __construct(IRootFolder $rootFolder, IUserManager $userManager) { |
|
107 | - $this->rootFolder = $rootFolder; |
|
108 | - $this->userManager = $userManager; |
|
109 | - } |
|
110 | - |
|
111 | - /** |
|
112 | - * @inheritdoc |
|
113 | - */ |
|
114 | - public function setId($id) { |
|
115 | - if (is_int($id)) { |
|
116 | - $id = (string)$id; |
|
117 | - } |
|
118 | - |
|
119 | - if (!is_string($id)) { |
|
120 | - throw new \InvalidArgumentException('String expected.'); |
|
121 | - } |
|
122 | - |
|
123 | - if ($this->id !== null) { |
|
124 | - throw new IllegalIDChangeException('Not allowed to assign a new internal id to a share'); |
|
125 | - } |
|
126 | - |
|
127 | - $this->id = trim($id); |
|
128 | - return $this; |
|
129 | - } |
|
130 | - |
|
131 | - /** |
|
132 | - * @inheritdoc |
|
133 | - */ |
|
134 | - public function getId() { |
|
135 | - return $this->id; |
|
136 | - } |
|
137 | - |
|
138 | - /** |
|
139 | - * @inheritdoc |
|
140 | - */ |
|
141 | - public function getFullId() { |
|
142 | - if ($this->providerId === null || $this->id === null) { |
|
143 | - throw new \UnexpectedValueException; |
|
144 | - } |
|
145 | - return $this->providerId . ':' . $this->id; |
|
146 | - } |
|
147 | - |
|
148 | - /** |
|
149 | - * @inheritdoc |
|
150 | - */ |
|
151 | - public function setProviderId($id) { |
|
152 | - if (!is_string($id)) { |
|
153 | - throw new \InvalidArgumentException('String expected.'); |
|
154 | - } |
|
155 | - |
|
156 | - if ($this->providerId !== null) { |
|
157 | - throw new IllegalIDChangeException('Not allowed to assign a new provider id to a share'); |
|
158 | - } |
|
159 | - |
|
160 | - $this->providerId = trim($id); |
|
161 | - return $this; |
|
162 | - } |
|
163 | - |
|
164 | - /** |
|
165 | - * @inheritdoc |
|
166 | - */ |
|
167 | - public function setNode(Node $node) { |
|
168 | - $this->fileId = null; |
|
169 | - $this->nodeType = null; |
|
170 | - $this->node = $node; |
|
171 | - return $this; |
|
172 | - } |
|
173 | - |
|
174 | - /** |
|
175 | - * @inheritdoc |
|
176 | - */ |
|
177 | - public function getNode() { |
|
178 | - if ($this->node === null) { |
|
179 | - if ($this->shareOwner === null || $this->fileId === null) { |
|
180 | - throw new NotFoundException(); |
|
181 | - } |
|
182 | - |
|
183 | - // for federated shares the owner can be a remote user, in this |
|
184 | - // case we use the initiator |
|
185 | - if ($this->userManager->userExists($this->shareOwner)) { |
|
186 | - $userFolder = $this->rootFolder->getUserFolder($this->shareOwner); |
|
187 | - } else { |
|
188 | - $userFolder = $this->rootFolder->getUserFolder($this->sharedBy); |
|
189 | - } |
|
190 | - |
|
191 | - $nodes = $userFolder->getById($this->fileId); |
|
192 | - if (empty($nodes)) { |
|
193 | - throw new NotFoundException('Node for share not found, fileid: ' . $this->fileId); |
|
194 | - } |
|
195 | - |
|
196 | - $this->node = $nodes[0]; |
|
197 | - } |
|
198 | - |
|
199 | - return $this->node; |
|
200 | - } |
|
201 | - |
|
202 | - /** |
|
203 | - * @inheritdoc |
|
204 | - */ |
|
205 | - public function setNodeId($fileId) { |
|
206 | - $this->node = null; |
|
207 | - $this->fileId = $fileId; |
|
208 | - return $this; |
|
209 | - } |
|
210 | - |
|
211 | - /** |
|
212 | - * @inheritdoc |
|
213 | - */ |
|
214 | - public function getNodeId() { |
|
215 | - if ($this->fileId === null) { |
|
216 | - $this->fileId = $this->getNode()->getId(); |
|
217 | - } |
|
218 | - |
|
219 | - return $this->fileId; |
|
220 | - } |
|
221 | - |
|
222 | - /** |
|
223 | - * @inheritdoc |
|
224 | - */ |
|
225 | - public function setNodeType($type) { |
|
226 | - if ($type !== 'file' && $type !== 'folder') { |
|
227 | - throw new \InvalidArgumentException(); |
|
228 | - } |
|
229 | - |
|
230 | - $this->nodeType = $type; |
|
231 | - return $this; |
|
232 | - } |
|
233 | - |
|
234 | - /** |
|
235 | - * @inheritdoc |
|
236 | - */ |
|
237 | - public function getNodeType() { |
|
238 | - if ($this->nodeType === null) { |
|
239 | - if ($this->getNodeCacheEntry()) { |
|
240 | - $info = $this->getNodeCacheEntry(); |
|
241 | - $this->nodeType = $info->getMimeType() === FileInfo::MIMETYPE_FOLDER ? 'folder' : 'file'; |
|
242 | - } else { |
|
243 | - $node = $this->getNode(); |
|
244 | - $this->nodeType = $node instanceof File ? 'file' : 'folder'; |
|
245 | - } |
|
246 | - } |
|
247 | - |
|
248 | - return $this->nodeType; |
|
249 | - } |
|
250 | - |
|
251 | - /** |
|
252 | - * @inheritdoc |
|
253 | - */ |
|
254 | - public function setShareType($shareType) { |
|
255 | - $this->shareType = $shareType; |
|
256 | - return $this; |
|
257 | - } |
|
258 | - |
|
259 | - /** |
|
260 | - * @inheritdoc |
|
261 | - */ |
|
262 | - public function getShareType() { |
|
263 | - return $this->shareType; |
|
264 | - } |
|
265 | - |
|
266 | - /** |
|
267 | - * @inheritdoc |
|
268 | - */ |
|
269 | - public function setSharedWith($sharedWith) { |
|
270 | - if (!is_string($sharedWith)) { |
|
271 | - throw new \InvalidArgumentException(); |
|
272 | - } |
|
273 | - $this->sharedWith = $sharedWith; |
|
274 | - return $this; |
|
275 | - } |
|
276 | - |
|
277 | - /** |
|
278 | - * @inheritdoc |
|
279 | - */ |
|
280 | - public function getSharedWith() { |
|
281 | - return $this->sharedWith; |
|
282 | - } |
|
283 | - |
|
284 | - /** |
|
285 | - * @inheritdoc |
|
286 | - */ |
|
287 | - public function setSharedWithDisplayName($displayName) { |
|
288 | - if (!is_string($displayName)) { |
|
289 | - throw new \InvalidArgumentException(); |
|
290 | - } |
|
291 | - $this->sharedWithDisplayName = $displayName; |
|
292 | - return $this; |
|
293 | - } |
|
294 | - |
|
295 | - /** |
|
296 | - * @inheritdoc |
|
297 | - */ |
|
298 | - public function getSharedWithDisplayName() { |
|
299 | - return $this->sharedWithDisplayName; |
|
300 | - } |
|
301 | - |
|
302 | - /** |
|
303 | - * @inheritdoc |
|
304 | - */ |
|
305 | - public function setSharedWithAvatar($src) { |
|
306 | - if (!is_string($src)) { |
|
307 | - throw new \InvalidArgumentException(); |
|
308 | - } |
|
309 | - $this->sharedWithAvatar = $src; |
|
310 | - return $this; |
|
311 | - } |
|
312 | - |
|
313 | - /** |
|
314 | - * @inheritdoc |
|
315 | - */ |
|
316 | - public function getSharedWithAvatar() { |
|
317 | - return $this->sharedWithAvatar; |
|
318 | - } |
|
319 | - |
|
320 | - /** |
|
321 | - * @inheritdoc |
|
322 | - */ |
|
323 | - public function setPermissions($permissions) { |
|
324 | - //TODO checks |
|
325 | - |
|
326 | - $this->permissions = $permissions; |
|
327 | - return $this; |
|
328 | - } |
|
329 | - |
|
330 | - /** |
|
331 | - * @inheritdoc |
|
332 | - */ |
|
333 | - public function getPermissions() { |
|
334 | - return $this->permissions; |
|
335 | - } |
|
336 | - |
|
337 | - /** |
|
338 | - * @inheritdoc |
|
339 | - */ |
|
340 | - public function newAttributes(): IAttributes { |
|
341 | - return new ShareAttributes(); |
|
342 | - } |
|
343 | - |
|
344 | - /** |
|
345 | - * @inheritdoc |
|
346 | - */ |
|
347 | - public function setAttributes(?IAttributes $attributes) { |
|
348 | - $this->attributes = $attributes; |
|
349 | - return $this; |
|
350 | - } |
|
351 | - |
|
352 | - /** |
|
353 | - * @inheritdoc |
|
354 | - */ |
|
355 | - public function getAttributes(): ?IAttributes { |
|
356 | - return $this->attributes; |
|
357 | - } |
|
358 | - |
|
359 | - /** |
|
360 | - * @inheritdoc |
|
361 | - */ |
|
362 | - public function setStatus(int $status): IShare { |
|
363 | - $this->status = $status; |
|
364 | - return $this; |
|
365 | - } |
|
366 | - |
|
367 | - /** |
|
368 | - * @inheritdoc |
|
369 | - */ |
|
370 | - public function getStatus(): int { |
|
371 | - return $this->status; |
|
372 | - } |
|
373 | - |
|
374 | - /** |
|
375 | - * @inheritdoc |
|
376 | - */ |
|
377 | - public function setNote($note) { |
|
378 | - $this->note = $note; |
|
379 | - return $this; |
|
380 | - } |
|
381 | - |
|
382 | - /** |
|
383 | - * @inheritdoc |
|
384 | - */ |
|
385 | - public function getNote() { |
|
386 | - if (is_string($this->note)) { |
|
387 | - return $this->note; |
|
388 | - } |
|
389 | - return ''; |
|
390 | - } |
|
391 | - |
|
392 | - /** |
|
393 | - * @inheritdoc |
|
394 | - */ |
|
395 | - public function setLabel($label) { |
|
396 | - $this->label = $label; |
|
397 | - return $this; |
|
398 | - } |
|
399 | - |
|
400 | - /** |
|
401 | - * @inheritdoc |
|
402 | - */ |
|
403 | - public function getLabel() { |
|
404 | - return $this->label; |
|
405 | - } |
|
406 | - |
|
407 | - /** |
|
408 | - * @inheritdoc |
|
409 | - */ |
|
410 | - public function setExpirationDate($expireDate) { |
|
411 | - //TODO checks |
|
412 | - |
|
413 | - $this->expireDate = $expireDate; |
|
414 | - return $this; |
|
415 | - } |
|
416 | - |
|
417 | - /** |
|
418 | - * @inheritdoc |
|
419 | - */ |
|
420 | - public function getExpirationDate() { |
|
421 | - return $this->expireDate; |
|
422 | - } |
|
423 | - |
|
424 | - /** |
|
425 | - * @inheritdoc |
|
426 | - */ |
|
427 | - public function isExpired() { |
|
428 | - return $this->getExpirationDate() !== null && |
|
429 | - $this->getExpirationDate() <= new \DateTime(); |
|
430 | - } |
|
431 | - |
|
432 | - /** |
|
433 | - * @inheritdoc |
|
434 | - */ |
|
435 | - public function setSharedBy($sharedBy) { |
|
436 | - if (!is_string($sharedBy)) { |
|
437 | - throw new \InvalidArgumentException(); |
|
438 | - } |
|
439 | - //TODO checks |
|
440 | - $this->sharedBy = $sharedBy; |
|
441 | - |
|
442 | - return $this; |
|
443 | - } |
|
444 | - |
|
445 | - /** |
|
446 | - * @inheritdoc |
|
447 | - */ |
|
448 | - public function getSharedBy() { |
|
449 | - //TODO check if set |
|
450 | - return $this->sharedBy; |
|
451 | - } |
|
452 | - |
|
453 | - /** |
|
454 | - * @inheritdoc |
|
455 | - */ |
|
456 | - public function setShareOwner($shareOwner) { |
|
457 | - if (!is_string($shareOwner)) { |
|
458 | - throw new \InvalidArgumentException(); |
|
459 | - } |
|
460 | - //TODO checks |
|
461 | - |
|
462 | - $this->shareOwner = $shareOwner; |
|
463 | - return $this; |
|
464 | - } |
|
465 | - |
|
466 | - /** |
|
467 | - * @inheritdoc |
|
468 | - */ |
|
469 | - public function getShareOwner() { |
|
470 | - //TODO check if set |
|
471 | - return $this->shareOwner; |
|
472 | - } |
|
473 | - |
|
474 | - /** |
|
475 | - * @inheritdoc |
|
476 | - */ |
|
477 | - public function setPassword($password) { |
|
478 | - $this->password = $password; |
|
479 | - return $this; |
|
480 | - } |
|
481 | - |
|
482 | - /** |
|
483 | - * @inheritdoc |
|
484 | - */ |
|
485 | - public function getPassword() { |
|
486 | - return $this->password; |
|
487 | - } |
|
488 | - |
|
489 | - /** |
|
490 | - * @inheritdoc |
|
491 | - */ |
|
492 | - public function setPasswordExpirationTime(?\DateTimeInterface $passwordExpirationTime = null): IShare { |
|
493 | - $this->passwordExpirationTime = $passwordExpirationTime; |
|
494 | - return $this; |
|
495 | - } |
|
496 | - |
|
497 | - /** |
|
498 | - * @inheritdoc |
|
499 | - */ |
|
500 | - public function getPasswordExpirationTime(): ?\DateTimeInterface { |
|
501 | - return $this->passwordExpirationTime; |
|
502 | - } |
|
503 | - |
|
504 | - /** |
|
505 | - * @inheritdoc |
|
506 | - */ |
|
507 | - public function setSendPasswordByTalk(bool $sendPasswordByTalk) { |
|
508 | - $this->sendPasswordByTalk = $sendPasswordByTalk; |
|
509 | - return $this; |
|
510 | - } |
|
511 | - |
|
512 | - /** |
|
513 | - * @inheritdoc |
|
514 | - */ |
|
515 | - public function getSendPasswordByTalk(): bool { |
|
516 | - return $this->sendPasswordByTalk; |
|
517 | - } |
|
518 | - |
|
519 | - /** |
|
520 | - * @inheritdoc |
|
521 | - */ |
|
522 | - public function setToken($token) { |
|
523 | - $this->token = $token; |
|
524 | - return $this; |
|
525 | - } |
|
526 | - |
|
527 | - /** |
|
528 | - * @inheritdoc |
|
529 | - */ |
|
530 | - public function getToken() { |
|
531 | - return $this->token; |
|
532 | - } |
|
533 | - |
|
534 | - /** |
|
535 | - * Set the parent of this share |
|
536 | - * |
|
537 | - * @param int parent |
|
538 | - * @return IShare |
|
539 | - * @deprecated The new shares do not have parents. This is just here for legacy reasons. |
|
540 | - */ |
|
541 | - public function setParent($parent) { |
|
542 | - $this->parent = $parent; |
|
543 | - return $this; |
|
544 | - } |
|
545 | - |
|
546 | - /** |
|
547 | - * Get the parent of this share. |
|
548 | - * |
|
549 | - * @return int |
|
550 | - * @deprecated The new shares do not have parents. This is just here for legacy reasons. |
|
551 | - */ |
|
552 | - public function getParent() { |
|
553 | - return $this->parent; |
|
554 | - } |
|
555 | - |
|
556 | - /** |
|
557 | - * @inheritdoc |
|
558 | - */ |
|
559 | - public function setTarget($target) { |
|
560 | - $this->target = $target; |
|
561 | - return $this; |
|
562 | - } |
|
563 | - |
|
564 | - /** |
|
565 | - * @inheritdoc |
|
566 | - */ |
|
567 | - public function getTarget() { |
|
568 | - return $this->target; |
|
569 | - } |
|
570 | - |
|
571 | - /** |
|
572 | - * @inheritdoc |
|
573 | - */ |
|
574 | - public function setShareTime(\DateTime $shareTime) { |
|
575 | - $this->shareTime = $shareTime; |
|
576 | - return $this; |
|
577 | - } |
|
578 | - |
|
579 | - /** |
|
580 | - * @inheritdoc |
|
581 | - */ |
|
582 | - public function getShareTime() { |
|
583 | - return $this->shareTime; |
|
584 | - } |
|
585 | - |
|
586 | - /** |
|
587 | - * @inheritdoc |
|
588 | - */ |
|
589 | - public function setMailSend($mailSend) { |
|
590 | - $this->mailSend = $mailSend; |
|
591 | - return $this; |
|
592 | - } |
|
593 | - |
|
594 | - /** |
|
595 | - * @inheritdoc |
|
596 | - */ |
|
597 | - public function getMailSend() { |
|
598 | - return $this->mailSend; |
|
599 | - } |
|
600 | - |
|
601 | - /** |
|
602 | - * @inheritdoc |
|
603 | - */ |
|
604 | - public function setNodeCacheEntry(ICacheEntry $entry) { |
|
605 | - $this->nodeCacheEntry = $entry; |
|
606 | - } |
|
607 | - |
|
608 | - /** |
|
609 | - * @inheritdoc |
|
610 | - */ |
|
611 | - public function getNodeCacheEntry() { |
|
612 | - return $this->nodeCacheEntry; |
|
613 | - } |
|
614 | - |
|
615 | - public function setHideDownload(bool $hide): IShare { |
|
616 | - $this->hideDownload = $hide; |
|
617 | - return $this; |
|
618 | - } |
|
619 | - |
|
620 | - public function getHideDownload(): bool { |
|
621 | - return $this->hideDownload; |
|
622 | - } |
|
44 | + /** @var string */ |
|
45 | + private $id; |
|
46 | + /** @var string */ |
|
47 | + private $providerId; |
|
48 | + /** @var Node */ |
|
49 | + private $node; |
|
50 | + /** @var int */ |
|
51 | + private $fileId; |
|
52 | + /** @var string */ |
|
53 | + private $nodeType; |
|
54 | + /** @var int */ |
|
55 | + private $shareType; |
|
56 | + /** @var string */ |
|
57 | + private $sharedWith; |
|
58 | + /** @var string */ |
|
59 | + private $sharedWithDisplayName; |
|
60 | + /** @var string */ |
|
61 | + private $sharedWithAvatar; |
|
62 | + /** @var string */ |
|
63 | + private $sharedBy; |
|
64 | + /** @var string */ |
|
65 | + private $shareOwner; |
|
66 | + /** @var int */ |
|
67 | + private $permissions; |
|
68 | + /** @var IAttributes */ |
|
69 | + private $attributes; |
|
70 | + /** @var int */ |
|
71 | + private $status; |
|
72 | + /** @var string */ |
|
73 | + private $note = ''; |
|
74 | + /** @var \DateTime */ |
|
75 | + private $expireDate; |
|
76 | + /** @var string */ |
|
77 | + private $password; |
|
78 | + private ?\DateTimeInterface $passwordExpirationTime = null; |
|
79 | + /** @var bool */ |
|
80 | + private $sendPasswordByTalk = false; |
|
81 | + /** @var string */ |
|
82 | + private $token; |
|
83 | + /** @var int */ |
|
84 | + private $parent; |
|
85 | + /** @var string */ |
|
86 | + private $target; |
|
87 | + /** @var \DateTime */ |
|
88 | + private $shareTime; |
|
89 | + /** @var bool */ |
|
90 | + private $mailSend; |
|
91 | + /** @var string */ |
|
92 | + private $label = ''; |
|
93 | + |
|
94 | + /** @var IRootFolder */ |
|
95 | + private $rootFolder; |
|
96 | + |
|
97 | + /** @var IUserManager */ |
|
98 | + private $userManager; |
|
99 | + |
|
100 | + /** @var ICacheEntry|null */ |
|
101 | + private $nodeCacheEntry; |
|
102 | + |
|
103 | + /** @var bool */ |
|
104 | + private $hideDownload = false; |
|
105 | + |
|
106 | + public function __construct(IRootFolder $rootFolder, IUserManager $userManager) { |
|
107 | + $this->rootFolder = $rootFolder; |
|
108 | + $this->userManager = $userManager; |
|
109 | + } |
|
110 | + |
|
111 | + /** |
|
112 | + * @inheritdoc |
|
113 | + */ |
|
114 | + public function setId($id) { |
|
115 | + if (is_int($id)) { |
|
116 | + $id = (string)$id; |
|
117 | + } |
|
118 | + |
|
119 | + if (!is_string($id)) { |
|
120 | + throw new \InvalidArgumentException('String expected.'); |
|
121 | + } |
|
122 | + |
|
123 | + if ($this->id !== null) { |
|
124 | + throw new IllegalIDChangeException('Not allowed to assign a new internal id to a share'); |
|
125 | + } |
|
126 | + |
|
127 | + $this->id = trim($id); |
|
128 | + return $this; |
|
129 | + } |
|
130 | + |
|
131 | + /** |
|
132 | + * @inheritdoc |
|
133 | + */ |
|
134 | + public function getId() { |
|
135 | + return $this->id; |
|
136 | + } |
|
137 | + |
|
138 | + /** |
|
139 | + * @inheritdoc |
|
140 | + */ |
|
141 | + public function getFullId() { |
|
142 | + if ($this->providerId === null || $this->id === null) { |
|
143 | + throw new \UnexpectedValueException; |
|
144 | + } |
|
145 | + return $this->providerId . ':' . $this->id; |
|
146 | + } |
|
147 | + |
|
148 | + /** |
|
149 | + * @inheritdoc |
|
150 | + */ |
|
151 | + public function setProviderId($id) { |
|
152 | + if (!is_string($id)) { |
|
153 | + throw new \InvalidArgumentException('String expected.'); |
|
154 | + } |
|
155 | + |
|
156 | + if ($this->providerId !== null) { |
|
157 | + throw new IllegalIDChangeException('Not allowed to assign a new provider id to a share'); |
|
158 | + } |
|
159 | + |
|
160 | + $this->providerId = trim($id); |
|
161 | + return $this; |
|
162 | + } |
|
163 | + |
|
164 | + /** |
|
165 | + * @inheritdoc |
|
166 | + */ |
|
167 | + public function setNode(Node $node) { |
|
168 | + $this->fileId = null; |
|
169 | + $this->nodeType = null; |
|
170 | + $this->node = $node; |
|
171 | + return $this; |
|
172 | + } |
|
173 | + |
|
174 | + /** |
|
175 | + * @inheritdoc |
|
176 | + */ |
|
177 | + public function getNode() { |
|
178 | + if ($this->node === null) { |
|
179 | + if ($this->shareOwner === null || $this->fileId === null) { |
|
180 | + throw new NotFoundException(); |
|
181 | + } |
|
182 | + |
|
183 | + // for federated shares the owner can be a remote user, in this |
|
184 | + // case we use the initiator |
|
185 | + if ($this->userManager->userExists($this->shareOwner)) { |
|
186 | + $userFolder = $this->rootFolder->getUserFolder($this->shareOwner); |
|
187 | + } else { |
|
188 | + $userFolder = $this->rootFolder->getUserFolder($this->sharedBy); |
|
189 | + } |
|
190 | + |
|
191 | + $nodes = $userFolder->getById($this->fileId); |
|
192 | + if (empty($nodes)) { |
|
193 | + throw new NotFoundException('Node for share not found, fileid: ' . $this->fileId); |
|
194 | + } |
|
195 | + |
|
196 | + $this->node = $nodes[0]; |
|
197 | + } |
|
198 | + |
|
199 | + return $this->node; |
|
200 | + } |
|
201 | + |
|
202 | + /** |
|
203 | + * @inheritdoc |
|
204 | + */ |
|
205 | + public function setNodeId($fileId) { |
|
206 | + $this->node = null; |
|
207 | + $this->fileId = $fileId; |
|
208 | + return $this; |
|
209 | + } |
|
210 | + |
|
211 | + /** |
|
212 | + * @inheritdoc |
|
213 | + */ |
|
214 | + public function getNodeId() { |
|
215 | + if ($this->fileId === null) { |
|
216 | + $this->fileId = $this->getNode()->getId(); |
|
217 | + } |
|
218 | + |
|
219 | + return $this->fileId; |
|
220 | + } |
|
221 | + |
|
222 | + /** |
|
223 | + * @inheritdoc |
|
224 | + */ |
|
225 | + public function setNodeType($type) { |
|
226 | + if ($type !== 'file' && $type !== 'folder') { |
|
227 | + throw new \InvalidArgumentException(); |
|
228 | + } |
|
229 | + |
|
230 | + $this->nodeType = $type; |
|
231 | + return $this; |
|
232 | + } |
|
233 | + |
|
234 | + /** |
|
235 | + * @inheritdoc |
|
236 | + */ |
|
237 | + public function getNodeType() { |
|
238 | + if ($this->nodeType === null) { |
|
239 | + if ($this->getNodeCacheEntry()) { |
|
240 | + $info = $this->getNodeCacheEntry(); |
|
241 | + $this->nodeType = $info->getMimeType() === FileInfo::MIMETYPE_FOLDER ? 'folder' : 'file'; |
|
242 | + } else { |
|
243 | + $node = $this->getNode(); |
|
244 | + $this->nodeType = $node instanceof File ? 'file' : 'folder'; |
|
245 | + } |
|
246 | + } |
|
247 | + |
|
248 | + return $this->nodeType; |
|
249 | + } |
|
250 | + |
|
251 | + /** |
|
252 | + * @inheritdoc |
|
253 | + */ |
|
254 | + public function setShareType($shareType) { |
|
255 | + $this->shareType = $shareType; |
|
256 | + return $this; |
|
257 | + } |
|
258 | + |
|
259 | + /** |
|
260 | + * @inheritdoc |
|
261 | + */ |
|
262 | + public function getShareType() { |
|
263 | + return $this->shareType; |
|
264 | + } |
|
265 | + |
|
266 | + /** |
|
267 | + * @inheritdoc |
|
268 | + */ |
|
269 | + public function setSharedWith($sharedWith) { |
|
270 | + if (!is_string($sharedWith)) { |
|
271 | + throw new \InvalidArgumentException(); |
|
272 | + } |
|
273 | + $this->sharedWith = $sharedWith; |
|
274 | + return $this; |
|
275 | + } |
|
276 | + |
|
277 | + /** |
|
278 | + * @inheritdoc |
|
279 | + */ |
|
280 | + public function getSharedWith() { |
|
281 | + return $this->sharedWith; |
|
282 | + } |
|
283 | + |
|
284 | + /** |
|
285 | + * @inheritdoc |
|
286 | + */ |
|
287 | + public function setSharedWithDisplayName($displayName) { |
|
288 | + if (!is_string($displayName)) { |
|
289 | + throw new \InvalidArgumentException(); |
|
290 | + } |
|
291 | + $this->sharedWithDisplayName = $displayName; |
|
292 | + return $this; |
|
293 | + } |
|
294 | + |
|
295 | + /** |
|
296 | + * @inheritdoc |
|
297 | + */ |
|
298 | + public function getSharedWithDisplayName() { |
|
299 | + return $this->sharedWithDisplayName; |
|
300 | + } |
|
301 | + |
|
302 | + /** |
|
303 | + * @inheritdoc |
|
304 | + */ |
|
305 | + public function setSharedWithAvatar($src) { |
|
306 | + if (!is_string($src)) { |
|
307 | + throw new \InvalidArgumentException(); |
|
308 | + } |
|
309 | + $this->sharedWithAvatar = $src; |
|
310 | + return $this; |
|
311 | + } |
|
312 | + |
|
313 | + /** |
|
314 | + * @inheritdoc |
|
315 | + */ |
|
316 | + public function getSharedWithAvatar() { |
|
317 | + return $this->sharedWithAvatar; |
|
318 | + } |
|
319 | + |
|
320 | + /** |
|
321 | + * @inheritdoc |
|
322 | + */ |
|
323 | + public function setPermissions($permissions) { |
|
324 | + //TODO checks |
|
325 | + |
|
326 | + $this->permissions = $permissions; |
|
327 | + return $this; |
|
328 | + } |
|
329 | + |
|
330 | + /** |
|
331 | + * @inheritdoc |
|
332 | + */ |
|
333 | + public function getPermissions() { |
|
334 | + return $this->permissions; |
|
335 | + } |
|
336 | + |
|
337 | + /** |
|
338 | + * @inheritdoc |
|
339 | + */ |
|
340 | + public function newAttributes(): IAttributes { |
|
341 | + return new ShareAttributes(); |
|
342 | + } |
|
343 | + |
|
344 | + /** |
|
345 | + * @inheritdoc |
|
346 | + */ |
|
347 | + public function setAttributes(?IAttributes $attributes) { |
|
348 | + $this->attributes = $attributes; |
|
349 | + return $this; |
|
350 | + } |
|
351 | + |
|
352 | + /** |
|
353 | + * @inheritdoc |
|
354 | + */ |
|
355 | + public function getAttributes(): ?IAttributes { |
|
356 | + return $this->attributes; |
|
357 | + } |
|
358 | + |
|
359 | + /** |
|
360 | + * @inheritdoc |
|
361 | + */ |
|
362 | + public function setStatus(int $status): IShare { |
|
363 | + $this->status = $status; |
|
364 | + return $this; |
|
365 | + } |
|
366 | + |
|
367 | + /** |
|
368 | + * @inheritdoc |
|
369 | + */ |
|
370 | + public function getStatus(): int { |
|
371 | + return $this->status; |
|
372 | + } |
|
373 | + |
|
374 | + /** |
|
375 | + * @inheritdoc |
|
376 | + */ |
|
377 | + public function setNote($note) { |
|
378 | + $this->note = $note; |
|
379 | + return $this; |
|
380 | + } |
|
381 | + |
|
382 | + /** |
|
383 | + * @inheritdoc |
|
384 | + */ |
|
385 | + public function getNote() { |
|
386 | + if (is_string($this->note)) { |
|
387 | + return $this->note; |
|
388 | + } |
|
389 | + return ''; |
|
390 | + } |
|
391 | + |
|
392 | + /** |
|
393 | + * @inheritdoc |
|
394 | + */ |
|
395 | + public function setLabel($label) { |
|
396 | + $this->label = $label; |
|
397 | + return $this; |
|
398 | + } |
|
399 | + |
|
400 | + /** |
|
401 | + * @inheritdoc |
|
402 | + */ |
|
403 | + public function getLabel() { |
|
404 | + return $this->label; |
|
405 | + } |
|
406 | + |
|
407 | + /** |
|
408 | + * @inheritdoc |
|
409 | + */ |
|
410 | + public function setExpirationDate($expireDate) { |
|
411 | + //TODO checks |
|
412 | + |
|
413 | + $this->expireDate = $expireDate; |
|
414 | + return $this; |
|
415 | + } |
|
416 | + |
|
417 | + /** |
|
418 | + * @inheritdoc |
|
419 | + */ |
|
420 | + public function getExpirationDate() { |
|
421 | + return $this->expireDate; |
|
422 | + } |
|
423 | + |
|
424 | + /** |
|
425 | + * @inheritdoc |
|
426 | + */ |
|
427 | + public function isExpired() { |
|
428 | + return $this->getExpirationDate() !== null && |
|
429 | + $this->getExpirationDate() <= new \DateTime(); |
|
430 | + } |
|
431 | + |
|
432 | + /** |
|
433 | + * @inheritdoc |
|
434 | + */ |
|
435 | + public function setSharedBy($sharedBy) { |
|
436 | + if (!is_string($sharedBy)) { |
|
437 | + throw new \InvalidArgumentException(); |
|
438 | + } |
|
439 | + //TODO checks |
|
440 | + $this->sharedBy = $sharedBy; |
|
441 | + |
|
442 | + return $this; |
|
443 | + } |
|
444 | + |
|
445 | + /** |
|
446 | + * @inheritdoc |
|
447 | + */ |
|
448 | + public function getSharedBy() { |
|
449 | + //TODO check if set |
|
450 | + return $this->sharedBy; |
|
451 | + } |
|
452 | + |
|
453 | + /** |
|
454 | + * @inheritdoc |
|
455 | + */ |
|
456 | + public function setShareOwner($shareOwner) { |
|
457 | + if (!is_string($shareOwner)) { |
|
458 | + throw new \InvalidArgumentException(); |
|
459 | + } |
|
460 | + //TODO checks |
|
461 | + |
|
462 | + $this->shareOwner = $shareOwner; |
|
463 | + return $this; |
|
464 | + } |
|
465 | + |
|
466 | + /** |
|
467 | + * @inheritdoc |
|
468 | + */ |
|
469 | + public function getShareOwner() { |
|
470 | + //TODO check if set |
|
471 | + return $this->shareOwner; |
|
472 | + } |
|
473 | + |
|
474 | + /** |
|
475 | + * @inheritdoc |
|
476 | + */ |
|
477 | + public function setPassword($password) { |
|
478 | + $this->password = $password; |
|
479 | + return $this; |
|
480 | + } |
|
481 | + |
|
482 | + /** |
|
483 | + * @inheritdoc |
|
484 | + */ |
|
485 | + public function getPassword() { |
|
486 | + return $this->password; |
|
487 | + } |
|
488 | + |
|
489 | + /** |
|
490 | + * @inheritdoc |
|
491 | + */ |
|
492 | + public function setPasswordExpirationTime(?\DateTimeInterface $passwordExpirationTime = null): IShare { |
|
493 | + $this->passwordExpirationTime = $passwordExpirationTime; |
|
494 | + return $this; |
|
495 | + } |
|
496 | + |
|
497 | + /** |
|
498 | + * @inheritdoc |
|
499 | + */ |
|
500 | + public function getPasswordExpirationTime(): ?\DateTimeInterface { |
|
501 | + return $this->passwordExpirationTime; |
|
502 | + } |
|
503 | + |
|
504 | + /** |
|
505 | + * @inheritdoc |
|
506 | + */ |
|
507 | + public function setSendPasswordByTalk(bool $sendPasswordByTalk) { |
|
508 | + $this->sendPasswordByTalk = $sendPasswordByTalk; |
|
509 | + return $this; |
|
510 | + } |
|
511 | + |
|
512 | + /** |
|
513 | + * @inheritdoc |
|
514 | + */ |
|
515 | + public function getSendPasswordByTalk(): bool { |
|
516 | + return $this->sendPasswordByTalk; |
|
517 | + } |
|
518 | + |
|
519 | + /** |
|
520 | + * @inheritdoc |
|
521 | + */ |
|
522 | + public function setToken($token) { |
|
523 | + $this->token = $token; |
|
524 | + return $this; |
|
525 | + } |
|
526 | + |
|
527 | + /** |
|
528 | + * @inheritdoc |
|
529 | + */ |
|
530 | + public function getToken() { |
|
531 | + return $this->token; |
|
532 | + } |
|
533 | + |
|
534 | + /** |
|
535 | + * Set the parent of this share |
|
536 | + * |
|
537 | + * @param int parent |
|
538 | + * @return IShare |
|
539 | + * @deprecated The new shares do not have parents. This is just here for legacy reasons. |
|
540 | + */ |
|
541 | + public function setParent($parent) { |
|
542 | + $this->parent = $parent; |
|
543 | + return $this; |
|
544 | + } |
|
545 | + |
|
546 | + /** |
|
547 | + * Get the parent of this share. |
|
548 | + * |
|
549 | + * @return int |
|
550 | + * @deprecated The new shares do not have parents. This is just here for legacy reasons. |
|
551 | + */ |
|
552 | + public function getParent() { |
|
553 | + return $this->parent; |
|
554 | + } |
|
555 | + |
|
556 | + /** |
|
557 | + * @inheritdoc |
|
558 | + */ |
|
559 | + public function setTarget($target) { |
|
560 | + $this->target = $target; |
|
561 | + return $this; |
|
562 | + } |
|
563 | + |
|
564 | + /** |
|
565 | + * @inheritdoc |
|
566 | + */ |
|
567 | + public function getTarget() { |
|
568 | + return $this->target; |
|
569 | + } |
|
570 | + |
|
571 | + /** |
|
572 | + * @inheritdoc |
|
573 | + */ |
|
574 | + public function setShareTime(\DateTime $shareTime) { |
|
575 | + $this->shareTime = $shareTime; |
|
576 | + return $this; |
|
577 | + } |
|
578 | + |
|
579 | + /** |
|
580 | + * @inheritdoc |
|
581 | + */ |
|
582 | + public function getShareTime() { |
|
583 | + return $this->shareTime; |
|
584 | + } |
|
585 | + |
|
586 | + /** |
|
587 | + * @inheritdoc |
|
588 | + */ |
|
589 | + public function setMailSend($mailSend) { |
|
590 | + $this->mailSend = $mailSend; |
|
591 | + return $this; |
|
592 | + } |
|
593 | + |
|
594 | + /** |
|
595 | + * @inheritdoc |
|
596 | + */ |
|
597 | + public function getMailSend() { |
|
598 | + return $this->mailSend; |
|
599 | + } |
|
600 | + |
|
601 | + /** |
|
602 | + * @inheritdoc |
|
603 | + */ |
|
604 | + public function setNodeCacheEntry(ICacheEntry $entry) { |
|
605 | + $this->nodeCacheEntry = $entry; |
|
606 | + } |
|
607 | + |
|
608 | + /** |
|
609 | + * @inheritdoc |
|
610 | + */ |
|
611 | + public function getNodeCacheEntry() { |
|
612 | + return $this->nodeCacheEntry; |
|
613 | + } |
|
614 | + |
|
615 | + public function setHideDownload(bool $hide): IShare { |
|
616 | + $this->hideDownload = $hide; |
|
617 | + return $this; |
|
618 | + } |
|
619 | + |
|
620 | + public function getHideDownload(): bool { |
|
621 | + return $this->hideDownload; |
|
622 | + } |
|
623 | 623 | } |
@@ -60,7 +60,7 @@ |
||
60 | 60 | $capabilities = array_replace_recursive($capabilities, $c->getCapabilities()); |
61 | 61 | } |
62 | 62 | } else { |
63 | - throw new \InvalidArgumentException('The given Capability (' . get_class($c) . ') does not implement the ICapability interface'); |
|
63 | + throw new \InvalidArgumentException('The given Capability ('.get_class($c).') does not implement the ICapability interface'); |
|
64 | 64 | } |
65 | 65 | } |
66 | 66 |
@@ -35,61 +35,61 @@ |
||
35 | 35 | use Psr\Log\LoggerInterface; |
36 | 36 | |
37 | 37 | class CapabilitiesManager { |
38 | - /** @var \Closure[] */ |
|
39 | - private $capabilities = []; |
|
38 | + /** @var \Closure[] */ |
|
39 | + private $capabilities = []; |
|
40 | 40 | |
41 | - /** @var LoggerInterface */ |
|
42 | - private $logger; |
|
41 | + /** @var LoggerInterface */ |
|
42 | + private $logger; |
|
43 | 43 | |
44 | - public function __construct(LoggerInterface $logger) { |
|
45 | - $this->logger = $logger; |
|
46 | - } |
|
44 | + public function __construct(LoggerInterface $logger) { |
|
45 | + $this->logger = $logger; |
|
46 | + } |
|
47 | 47 | |
48 | - /** |
|
49 | - * Get an array of al the capabilities that are registered at this manager |
|
50 | - * |
|
51 | - * @param bool $public get public capabilities only |
|
52 | - * @throws \InvalidArgumentException |
|
53 | - * @return array |
|
54 | - */ |
|
55 | - public function getCapabilities(bool $public = false, bool $initialState = false) : array { |
|
56 | - $capabilities = []; |
|
57 | - foreach ($this->capabilities as $capability) { |
|
58 | - try { |
|
59 | - $c = $capability(); |
|
60 | - } catch (QueryException $e) { |
|
61 | - $this->logger->error('CapabilitiesManager', [ |
|
62 | - 'exception' => $e, |
|
63 | - ]); |
|
64 | - continue; |
|
65 | - } |
|
48 | + /** |
|
49 | + * Get an array of al the capabilities that are registered at this manager |
|
50 | + * |
|
51 | + * @param bool $public get public capabilities only |
|
52 | + * @throws \InvalidArgumentException |
|
53 | + * @return array |
|
54 | + */ |
|
55 | + public function getCapabilities(bool $public = false, bool $initialState = false) : array { |
|
56 | + $capabilities = []; |
|
57 | + foreach ($this->capabilities as $capability) { |
|
58 | + try { |
|
59 | + $c = $capability(); |
|
60 | + } catch (QueryException $e) { |
|
61 | + $this->logger->error('CapabilitiesManager', [ |
|
62 | + 'exception' => $e, |
|
63 | + ]); |
|
64 | + continue; |
|
65 | + } |
|
66 | 66 | |
67 | - if ($c instanceof ICapability) { |
|
68 | - if (!$public || $c instanceof IPublicCapability) { |
|
69 | - if ($initialState && ($c instanceof IInitialStateExcludedCapability)) { |
|
70 | - // Remove less important capabilities information that are expensive to query |
|
71 | - // that we would otherwise inject to every page load |
|
72 | - continue; |
|
73 | - } |
|
74 | - $capabilities = array_replace_recursive($capabilities, $c->getCapabilities()); |
|
75 | - } |
|
76 | - } else { |
|
77 | - throw new \InvalidArgumentException('The given Capability (' . get_class($c) . ') does not implement the ICapability interface'); |
|
78 | - } |
|
79 | - } |
|
67 | + if ($c instanceof ICapability) { |
|
68 | + if (!$public || $c instanceof IPublicCapability) { |
|
69 | + if ($initialState && ($c instanceof IInitialStateExcludedCapability)) { |
|
70 | + // Remove less important capabilities information that are expensive to query |
|
71 | + // that we would otherwise inject to every page load |
|
72 | + continue; |
|
73 | + } |
|
74 | + $capabilities = array_replace_recursive($capabilities, $c->getCapabilities()); |
|
75 | + } |
|
76 | + } else { |
|
77 | + throw new \InvalidArgumentException('The given Capability (' . get_class($c) . ') does not implement the ICapability interface'); |
|
78 | + } |
|
79 | + } |
|
80 | 80 | |
81 | - return $capabilities; |
|
82 | - } |
|
81 | + return $capabilities; |
|
82 | + } |
|
83 | 83 | |
84 | - /** |
|
85 | - * In order to improve lazy loading a closure can be registered which will be called in case |
|
86 | - * capabilities are actually requested |
|
87 | - * |
|
88 | - * $callable has to return an instance of OCP\Capabilities\ICapability |
|
89 | - * |
|
90 | - * @param \Closure $callable |
|
91 | - */ |
|
92 | - public function registerCapability(\Closure $callable) { |
|
93 | - $this->capabilities[] = $callable; |
|
94 | - } |
|
84 | + /** |
|
85 | + * In order to improve lazy loading a closure can be registered which will be called in case |
|
86 | + * capabilities are actually requested |
|
87 | + * |
|
88 | + * $callable has to return an instance of OCP\Capabilities\ICapability |
|
89 | + * |
|
90 | + * @param \Closure $callable |
|
91 | + */ |
|
92 | + public function registerCapability(\Closure $callable) { |
|
93 | + $this->capabilities[] = $callable; |
|
94 | + } |
|
95 | 95 | } |
@@ -135,7 +135,7 @@ |
||
135 | 135 | * @return $this |
136 | 136 | */ |
137 | 137 | public function addHeader($name, $value) { |
138 | - $name = trim($name); // always remove leading and trailing whitespace |
|
138 | + $name = trim($name); // always remove leading and trailing whitespace |
|
139 | 139 | // to be able to reliably check for security |
140 | 140 | // headers |
141 | 141 |
@@ -31,127 +31,127 @@ |
||
31 | 31 | namespace OC\OCS; |
32 | 32 | |
33 | 33 | class Result { |
34 | - /** @var array */ |
|
35 | - protected $data; |
|
36 | - |
|
37 | - /** @var null|string */ |
|
38 | - protected $message; |
|
39 | - |
|
40 | - /** @var int */ |
|
41 | - protected $statusCode; |
|
42 | - |
|
43 | - /** @var integer */ |
|
44 | - protected $items; |
|
45 | - |
|
46 | - /** @var integer */ |
|
47 | - protected $perPage; |
|
48 | - |
|
49 | - /** @var array */ |
|
50 | - private $headers = []; |
|
51 | - |
|
52 | - /** |
|
53 | - * create the OCS_Result object |
|
54 | - * @param mixed $data the data to return |
|
55 | - * @param int $code |
|
56 | - * @param null|string $message |
|
57 | - * @param array $headers |
|
58 | - */ |
|
59 | - public function __construct($data = null, $code = 100, $message = null, $headers = []) { |
|
60 | - if ($data === null) { |
|
61 | - $this->data = []; |
|
62 | - } elseif (!is_array($data)) { |
|
63 | - $this->data = [$this->data]; |
|
64 | - } else { |
|
65 | - $this->data = $data; |
|
66 | - } |
|
67 | - $this->statusCode = $code; |
|
68 | - $this->message = $message; |
|
69 | - $this->headers = $headers; |
|
70 | - } |
|
71 | - |
|
72 | - /** |
|
73 | - * optionally set the total number of items available |
|
74 | - * @param int $items |
|
75 | - */ |
|
76 | - public function setTotalItems($items) { |
|
77 | - $this->items = $items; |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * optionally set the the number of items per page |
|
82 | - * @param int $items |
|
83 | - */ |
|
84 | - public function setItemsPerPage($items) { |
|
85 | - $this->perPage = $items; |
|
86 | - } |
|
87 | - |
|
88 | - /** |
|
89 | - * get the status code |
|
90 | - * @return int |
|
91 | - */ |
|
92 | - public function getStatusCode() { |
|
93 | - return $this->statusCode; |
|
94 | - } |
|
95 | - |
|
96 | - /** |
|
97 | - * get the meta data for the result |
|
98 | - * @return array |
|
99 | - */ |
|
100 | - public function getMeta() { |
|
101 | - $meta = []; |
|
102 | - $meta['status'] = $this->succeeded() ? 'ok' : 'failure'; |
|
103 | - $meta['statuscode'] = $this->statusCode; |
|
104 | - $meta['message'] = $this->message; |
|
105 | - if ($this->items !== null) { |
|
106 | - $meta['totalitems'] = $this->items; |
|
107 | - } |
|
108 | - if ($this->perPage !== null) { |
|
109 | - $meta['itemsperpage'] = $this->perPage; |
|
110 | - } |
|
111 | - return $meta; |
|
112 | - } |
|
113 | - |
|
114 | - /** |
|
115 | - * get the result data |
|
116 | - * @return array |
|
117 | - */ |
|
118 | - public function getData() { |
|
119 | - return $this->data; |
|
120 | - } |
|
121 | - |
|
122 | - /** |
|
123 | - * return bool Whether the method succeeded |
|
124 | - * @return bool |
|
125 | - */ |
|
126 | - public function succeeded() { |
|
127 | - return ($this->statusCode == 100); |
|
128 | - } |
|
129 | - |
|
130 | - /** |
|
131 | - * Adds a new header to the response |
|
132 | - * @param string $name The name of the HTTP header |
|
133 | - * @param string $value The value, null will delete it |
|
134 | - * @return $this |
|
135 | - */ |
|
136 | - public function addHeader($name, $value) { |
|
137 | - $name = trim($name); // always remove leading and trailing whitespace |
|
138 | - // to be able to reliably check for security |
|
139 | - // headers |
|
140 | - |
|
141 | - if (is_null($value)) { |
|
142 | - unset($this->headers[$name]); |
|
143 | - } else { |
|
144 | - $this->headers[$name] = $value; |
|
145 | - } |
|
146 | - |
|
147 | - return $this; |
|
148 | - } |
|
149 | - |
|
150 | - /** |
|
151 | - * Returns the set headers |
|
152 | - * @return array the headers |
|
153 | - */ |
|
154 | - public function getHeaders() { |
|
155 | - return $this->headers; |
|
156 | - } |
|
34 | + /** @var array */ |
|
35 | + protected $data; |
|
36 | + |
|
37 | + /** @var null|string */ |
|
38 | + protected $message; |
|
39 | + |
|
40 | + /** @var int */ |
|
41 | + protected $statusCode; |
|
42 | + |
|
43 | + /** @var integer */ |
|
44 | + protected $items; |
|
45 | + |
|
46 | + /** @var integer */ |
|
47 | + protected $perPage; |
|
48 | + |
|
49 | + /** @var array */ |
|
50 | + private $headers = []; |
|
51 | + |
|
52 | + /** |
|
53 | + * create the OCS_Result object |
|
54 | + * @param mixed $data the data to return |
|
55 | + * @param int $code |
|
56 | + * @param null|string $message |
|
57 | + * @param array $headers |
|
58 | + */ |
|
59 | + public function __construct($data = null, $code = 100, $message = null, $headers = []) { |
|
60 | + if ($data === null) { |
|
61 | + $this->data = []; |
|
62 | + } elseif (!is_array($data)) { |
|
63 | + $this->data = [$this->data]; |
|
64 | + } else { |
|
65 | + $this->data = $data; |
|
66 | + } |
|
67 | + $this->statusCode = $code; |
|
68 | + $this->message = $message; |
|
69 | + $this->headers = $headers; |
|
70 | + } |
|
71 | + |
|
72 | + /** |
|
73 | + * optionally set the total number of items available |
|
74 | + * @param int $items |
|
75 | + */ |
|
76 | + public function setTotalItems($items) { |
|
77 | + $this->items = $items; |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * optionally set the the number of items per page |
|
82 | + * @param int $items |
|
83 | + */ |
|
84 | + public function setItemsPerPage($items) { |
|
85 | + $this->perPage = $items; |
|
86 | + } |
|
87 | + |
|
88 | + /** |
|
89 | + * get the status code |
|
90 | + * @return int |
|
91 | + */ |
|
92 | + public function getStatusCode() { |
|
93 | + return $this->statusCode; |
|
94 | + } |
|
95 | + |
|
96 | + /** |
|
97 | + * get the meta data for the result |
|
98 | + * @return array |
|
99 | + */ |
|
100 | + public function getMeta() { |
|
101 | + $meta = []; |
|
102 | + $meta['status'] = $this->succeeded() ? 'ok' : 'failure'; |
|
103 | + $meta['statuscode'] = $this->statusCode; |
|
104 | + $meta['message'] = $this->message; |
|
105 | + if ($this->items !== null) { |
|
106 | + $meta['totalitems'] = $this->items; |
|
107 | + } |
|
108 | + if ($this->perPage !== null) { |
|
109 | + $meta['itemsperpage'] = $this->perPage; |
|
110 | + } |
|
111 | + return $meta; |
|
112 | + } |
|
113 | + |
|
114 | + /** |
|
115 | + * get the result data |
|
116 | + * @return array |
|
117 | + */ |
|
118 | + public function getData() { |
|
119 | + return $this->data; |
|
120 | + } |
|
121 | + |
|
122 | + /** |
|
123 | + * return bool Whether the method succeeded |
|
124 | + * @return bool |
|
125 | + */ |
|
126 | + public function succeeded() { |
|
127 | + return ($this->statusCode == 100); |
|
128 | + } |
|
129 | + |
|
130 | + /** |
|
131 | + * Adds a new header to the response |
|
132 | + * @param string $name The name of the HTTP header |
|
133 | + * @param string $value The value, null will delete it |
|
134 | + * @return $this |
|
135 | + */ |
|
136 | + public function addHeader($name, $value) { |
|
137 | + $name = trim($name); // always remove leading and trailing whitespace |
|
138 | + // to be able to reliably check for security |
|
139 | + // headers |
|
140 | + |
|
141 | + if (is_null($value)) { |
|
142 | + unset($this->headers[$name]); |
|
143 | + } else { |
|
144 | + $this->headers[$name] = $value; |
|
145 | + } |
|
146 | + |
|
147 | + return $this; |
|
148 | + } |
|
149 | + |
|
150 | + /** |
|
151 | + * Returns the set headers |
|
152 | + * @return array the headers |
|
153 | + */ |
|
154 | + public function getHeaders() { |
|
155 | + return $this->headers; |
|
156 | + } |
|
157 | 157 | } |
@@ -33,53 +33,53 @@ |
||
33 | 33 | namespace OC\Files\Storage; |
34 | 34 | |
35 | 35 | class CommonTest extends \OC\Files\Storage\Common { |
36 | - /** |
|
37 | - * underlying local storage used for missing functions |
|
38 | - * @var \OC\Files\Storage\Local |
|
39 | - */ |
|
40 | - private $storage; |
|
36 | + /** |
|
37 | + * underlying local storage used for missing functions |
|
38 | + * @var \OC\Files\Storage\Local |
|
39 | + */ |
|
40 | + private $storage; |
|
41 | 41 | |
42 | - public function __construct($params) { |
|
43 | - $this->storage = new \OC\Files\Storage\Local($params); |
|
44 | - } |
|
42 | + public function __construct($params) { |
|
43 | + $this->storage = new \OC\Files\Storage\Local($params); |
|
44 | + } |
|
45 | 45 | |
46 | - public function getId() { |
|
47 | - return 'test::'.$this->storage->getId(); |
|
48 | - } |
|
49 | - public function mkdir($path) { |
|
50 | - return $this->storage->mkdir($path); |
|
51 | - } |
|
52 | - public function rmdir($path) { |
|
53 | - return $this->storage->rmdir($path); |
|
54 | - } |
|
55 | - public function opendir($path) { |
|
56 | - return $this->storage->opendir($path); |
|
57 | - } |
|
58 | - public function stat($path) { |
|
59 | - return $this->storage->stat($path); |
|
60 | - } |
|
61 | - public function filetype($path) { |
|
62 | - return @$this->storage->filetype($path); |
|
63 | - } |
|
64 | - public function isReadable($path) { |
|
65 | - return $this->storage->isReadable($path); |
|
66 | - } |
|
67 | - public function isUpdatable($path) { |
|
68 | - return $this->storage->isUpdatable($path); |
|
69 | - } |
|
70 | - public function file_exists($path) { |
|
71 | - return $this->storage->file_exists($path); |
|
72 | - } |
|
73 | - public function unlink($path) { |
|
74 | - return $this->storage->unlink($path); |
|
75 | - } |
|
76 | - public function fopen($path, $mode) { |
|
77 | - return $this->storage->fopen($path, $mode); |
|
78 | - } |
|
79 | - public function free_space($path) { |
|
80 | - return $this->storage->free_space($path); |
|
81 | - } |
|
82 | - public function touch($path, $mtime = null) { |
|
83 | - return $this->storage->touch($path, $mtime); |
|
84 | - } |
|
46 | + public function getId() { |
|
47 | + return 'test::'.$this->storage->getId(); |
|
48 | + } |
|
49 | + public function mkdir($path) { |
|
50 | + return $this->storage->mkdir($path); |
|
51 | + } |
|
52 | + public function rmdir($path) { |
|
53 | + return $this->storage->rmdir($path); |
|
54 | + } |
|
55 | + public function opendir($path) { |
|
56 | + return $this->storage->opendir($path); |
|
57 | + } |
|
58 | + public function stat($path) { |
|
59 | + return $this->storage->stat($path); |
|
60 | + } |
|
61 | + public function filetype($path) { |
|
62 | + return @$this->storage->filetype($path); |
|
63 | + } |
|
64 | + public function isReadable($path) { |
|
65 | + return $this->storage->isReadable($path); |
|
66 | + } |
|
67 | + public function isUpdatable($path) { |
|
68 | + return $this->storage->isUpdatable($path); |
|
69 | + } |
|
70 | + public function file_exists($path) { |
|
71 | + return $this->storage->file_exists($path); |
|
72 | + } |
|
73 | + public function unlink($path) { |
|
74 | + return $this->storage->unlink($path); |
|
75 | + } |
|
76 | + public function fopen($path, $mode) { |
|
77 | + return $this->storage->fopen($path, $mode); |
|
78 | + } |
|
79 | + public function free_space($path) { |
|
80 | + return $this->storage->free_space($path); |
|
81 | + } |
|
82 | + public function touch($path, $mtime = null) { |
|
83 | + return $this->storage->touch($path, $mtime); |
|
84 | + } |
|
85 | 85 | } |
@@ -29,20 +29,20 @@ |
||
29 | 29 | * local storage backend in temporary folder for testing purpose |
30 | 30 | */ |
31 | 31 | class Temporary extends Local { |
32 | - public function __construct($arguments = null) { |
|
33 | - parent::__construct(['datadir' => \OC::$server->getTempManager()->getTemporaryFolder()]); |
|
34 | - } |
|
32 | + public function __construct($arguments = null) { |
|
33 | + parent::__construct(['datadir' => \OC::$server->getTempManager()->getTemporaryFolder()]); |
|
34 | + } |
|
35 | 35 | |
36 | - public function cleanUp() { |
|
37 | - \OC_Helper::rmdirr($this->datadir); |
|
38 | - } |
|
36 | + public function cleanUp() { |
|
37 | + \OC_Helper::rmdirr($this->datadir); |
|
38 | + } |
|
39 | 39 | |
40 | - public function __destruct() { |
|
41 | - parent::__destruct(); |
|
42 | - $this->cleanUp(); |
|
43 | - } |
|
40 | + public function __destruct() { |
|
41 | + parent::__destruct(); |
|
42 | + $this->cleanUp(); |
|
43 | + } |
|
44 | 44 | |
45 | - public function getDataDir() { |
|
46 | - return $this->datadir; |
|
47 | - } |
|
45 | + public function getDataDir() { |
|
46 | + return $this->datadir; |
|
47 | + } |
|
48 | 48 | } |
@@ -50,7 +50,7 @@ |
||
50 | 50 | public function __construct($arguments) { |
51 | 51 | $this->user = $arguments['user']; |
52 | 52 | $datadir = $this->user->getHome(); |
53 | - $this->id = 'home::' . $this->user->getUID(); |
|
53 | + $this->id = 'home::'.$this->user->getUID(); |
|
54 | 54 | |
55 | 55 | parent::__construct(['datadir' => $datadir]); |
56 | 56 | } |
@@ -33,80 +33,80 @@ |
||
33 | 33 | * Specialized version of Local storage for home directory usage |
34 | 34 | */ |
35 | 35 | class Home extends Local implements \OCP\Files\IHomeStorage { |
36 | - /** |
|
37 | - * @var string |
|
38 | - */ |
|
39 | - protected $id; |
|
36 | + /** |
|
37 | + * @var string |
|
38 | + */ |
|
39 | + protected $id; |
|
40 | 40 | |
41 | - /** |
|
42 | - * @var \OC\User\User $user |
|
43 | - */ |
|
44 | - protected $user; |
|
41 | + /** |
|
42 | + * @var \OC\User\User $user |
|
43 | + */ |
|
44 | + protected $user; |
|
45 | 45 | |
46 | - /** |
|
47 | - * Construct a Home storage instance |
|
48 | - * |
|
49 | - * @param array $arguments array with "user" containing the |
|
50 | - * storage owner |
|
51 | - */ |
|
52 | - public function __construct($arguments) { |
|
53 | - $this->user = $arguments['user']; |
|
54 | - $datadir = $this->user->getHome(); |
|
55 | - $this->id = 'home::' . $this->user->getUID(); |
|
46 | + /** |
|
47 | + * Construct a Home storage instance |
|
48 | + * |
|
49 | + * @param array $arguments array with "user" containing the |
|
50 | + * storage owner |
|
51 | + */ |
|
52 | + public function __construct($arguments) { |
|
53 | + $this->user = $arguments['user']; |
|
54 | + $datadir = $this->user->getHome(); |
|
55 | + $this->id = 'home::' . $this->user->getUID(); |
|
56 | 56 | |
57 | - parent::__construct(['datadir' => $datadir]); |
|
58 | - } |
|
57 | + parent::__construct(['datadir' => $datadir]); |
|
58 | + } |
|
59 | 59 | |
60 | - public function getId() { |
|
61 | - return $this->id; |
|
62 | - } |
|
60 | + public function getId() { |
|
61 | + return $this->id; |
|
62 | + } |
|
63 | 63 | |
64 | - /** |
|
65 | - * @return \OC\Files\Cache\HomeCache |
|
66 | - */ |
|
67 | - public function getCache($path = '', $storage = null) { |
|
68 | - if (!$storage) { |
|
69 | - $storage = $this; |
|
70 | - } |
|
71 | - if (!isset($this->cache)) { |
|
72 | - $this->cache = new \OC\Files\Cache\HomeCache($storage); |
|
73 | - } |
|
74 | - return $this->cache; |
|
75 | - } |
|
64 | + /** |
|
65 | + * @return \OC\Files\Cache\HomeCache |
|
66 | + */ |
|
67 | + public function getCache($path = '', $storage = null) { |
|
68 | + if (!$storage) { |
|
69 | + $storage = $this; |
|
70 | + } |
|
71 | + if (!isset($this->cache)) { |
|
72 | + $this->cache = new \OC\Files\Cache\HomeCache($storage); |
|
73 | + } |
|
74 | + return $this->cache; |
|
75 | + } |
|
76 | 76 | |
77 | - /** |
|
78 | - * get a propagator instance for the cache |
|
79 | - * |
|
80 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
81 | - * @return \OC\Files\Cache\Propagator |
|
82 | - */ |
|
83 | - public function getPropagator($storage = null) { |
|
84 | - if (!$storage) { |
|
85 | - $storage = $this; |
|
86 | - } |
|
87 | - if (!isset($this->propagator)) { |
|
88 | - $this->propagator = new HomePropagator($storage, \OC::$server->getDatabaseConnection()); |
|
89 | - } |
|
90 | - return $this->propagator; |
|
91 | - } |
|
77 | + /** |
|
78 | + * get a propagator instance for the cache |
|
79 | + * |
|
80 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
81 | + * @return \OC\Files\Cache\Propagator |
|
82 | + */ |
|
83 | + public function getPropagator($storage = null) { |
|
84 | + if (!$storage) { |
|
85 | + $storage = $this; |
|
86 | + } |
|
87 | + if (!isset($this->propagator)) { |
|
88 | + $this->propagator = new HomePropagator($storage, \OC::$server->getDatabaseConnection()); |
|
89 | + } |
|
90 | + return $this->propagator; |
|
91 | + } |
|
92 | 92 | |
93 | 93 | |
94 | - /** |
|
95 | - * Returns the owner of this home storage |
|
96 | - * |
|
97 | - * @return \OC\User\User owner of this home storage |
|
98 | - */ |
|
99 | - public function getUser() { |
|
100 | - return $this->user; |
|
101 | - } |
|
94 | + /** |
|
95 | + * Returns the owner of this home storage |
|
96 | + * |
|
97 | + * @return \OC\User\User owner of this home storage |
|
98 | + */ |
|
99 | + public function getUser() { |
|
100 | + return $this->user; |
|
101 | + } |
|
102 | 102 | |
103 | - /** |
|
104 | - * get the owner of a path |
|
105 | - * |
|
106 | - * @param string $path The path to get the owner |
|
107 | - * @return string uid or false |
|
108 | - */ |
|
109 | - public function getOwner($path) { |
|
110 | - return $this->user->getUID(); |
|
111 | - } |
|
103 | + /** |
|
104 | + * get the owner of a path |
|
105 | + * |
|
106 | + * @param string $path The path to get the owner |
|
107 | + * @return string uid or false |
|
108 | + */ |
|
109 | + public function getOwner($path) { |
|
110 | + return $this->user->getUID(); |
|
111 | + } |
|
112 | 112 | } |
@@ -33,7 +33,7 @@ discard block |
||
33 | 33 | * @param array $params |
34 | 34 | */ |
35 | 35 | public function __construct($params) { |
36 | - if (! isset($params['user']) || ! $params['user'] instanceof User) { |
|
36 | + if (!isset($params['user']) || !$params['user'] instanceof User) { |
|
37 | 37 | throw new \Exception('missing user object in parameters'); |
38 | 38 | } |
39 | 39 | $this->user = $params['user']; |
@@ -41,7 +41,7 @@ discard block |
||
41 | 41 | } |
42 | 42 | |
43 | 43 | public function getId() { |
44 | - return 'object::user:' . $this->user->getUID(); |
|
44 | + return 'object::user:'.$this->user->getUID(); |
|
45 | 45 | } |
46 | 46 | |
47 | 47 | /** |
@@ -28,40 +28,40 @@ |
||
28 | 28 | use OC\User\User; |
29 | 29 | |
30 | 30 | class HomeObjectStoreStorage extends ObjectStoreStorage implements \OCP\Files\IHomeStorage { |
31 | - /** |
|
32 | - * The home user storage requires a user object to create a unique storage id |
|
33 | - * @param array $params |
|
34 | - */ |
|
35 | - public function __construct($params) { |
|
36 | - if (! isset($params['user']) || ! $params['user'] instanceof User) { |
|
37 | - throw new \Exception('missing user object in parameters'); |
|
38 | - } |
|
39 | - $this->user = $params['user']; |
|
40 | - parent::__construct($params); |
|
41 | - } |
|
31 | + /** |
|
32 | + * The home user storage requires a user object to create a unique storage id |
|
33 | + * @param array $params |
|
34 | + */ |
|
35 | + public function __construct($params) { |
|
36 | + if (! isset($params['user']) || ! $params['user'] instanceof User) { |
|
37 | + throw new \Exception('missing user object in parameters'); |
|
38 | + } |
|
39 | + $this->user = $params['user']; |
|
40 | + parent::__construct($params); |
|
41 | + } |
|
42 | 42 | |
43 | - public function getId() { |
|
44 | - return 'object::user:' . $this->user->getUID(); |
|
45 | - } |
|
43 | + public function getId() { |
|
44 | + return 'object::user:' . $this->user->getUID(); |
|
45 | + } |
|
46 | 46 | |
47 | - /** |
|
48 | - * get the owner of a path |
|
49 | - * |
|
50 | - * @param string $path The path to get the owner |
|
51 | - * @return false|string uid |
|
52 | - */ |
|
53 | - public function getOwner($path) { |
|
54 | - if (is_object($this->user)) { |
|
55 | - return $this->user->getUID(); |
|
56 | - } |
|
57 | - return false; |
|
58 | - } |
|
47 | + /** |
|
48 | + * get the owner of a path |
|
49 | + * |
|
50 | + * @param string $path The path to get the owner |
|
51 | + * @return false|string uid |
|
52 | + */ |
|
53 | + public function getOwner($path) { |
|
54 | + if (is_object($this->user)) { |
|
55 | + return $this->user->getUID(); |
|
56 | + } |
|
57 | + return false; |
|
58 | + } |
|
59 | 59 | |
60 | - /** |
|
61 | - * @param string $path, optional |
|
62 | - * @return \OC\User\User |
|
63 | - */ |
|
64 | - public function getUser($path = null) { |
|
65 | - return $this->user; |
|
66 | - } |
|
60 | + /** |
|
61 | + * @param string $path, optional |
|
62 | + * @return \OC\User\User |
|
63 | + */ |
|
64 | + public function getUser($path = null) { |
|
65 | + return $this->user; |
|
66 | + } |
|
67 | 67 | } |
@@ -24,17 +24,17 @@ |
||
24 | 24 | namespace OC\DB; |
25 | 25 | |
26 | 26 | class MigrationException extends \Exception { |
27 | - private $table; |
|
27 | + private $table; |
|
28 | 28 | |
29 | - public function __construct($table, $message) { |
|
30 | - $this->table = $table; |
|
31 | - parent::__construct($message); |
|
32 | - } |
|
29 | + public function __construct($table, $message) { |
|
30 | + $this->table = $table; |
|
31 | + parent::__construct($message); |
|
32 | + } |
|
33 | 33 | |
34 | - /** |
|
35 | - * @return string |
|
36 | - */ |
|
37 | - public function getTable() { |
|
38 | - return $this->table; |
|
39 | - } |
|
34 | + /** |
|
35 | + * @return string |
|
36 | + */ |
|
37 | + public function getTable() { |
|
38 | + return $this->table; |
|
39 | + } |
|
40 | 40 | } |
@@ -25,17 +25,17 @@ |
||
25 | 25 | use OCP\DB\QueryBuilder\ILiteral; |
26 | 26 | |
27 | 27 | class Literal implements ILiteral { |
28 | - /** @var mixed */ |
|
29 | - protected $literal; |
|
28 | + /** @var mixed */ |
|
29 | + protected $literal; |
|
30 | 30 | |
31 | - public function __construct($literal) { |
|
32 | - $this->literal = $literal; |
|
33 | - } |
|
31 | + public function __construct($literal) { |
|
32 | + $this->literal = $literal; |
|
33 | + } |
|
34 | 34 | |
35 | - /** |
|
36 | - * @return string |
|
37 | - */ |
|
38 | - public function __toString() { |
|
39 | - return (string) $this->literal; |
|
40 | - } |
|
35 | + /** |
|
36 | + * @return string |
|
37 | + */ |
|
38 | + public function __toString() { |
|
39 | + return (string) $this->literal; |
|
40 | + } |
|
41 | 41 | } |