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
|
<?php
/**
* ownCloud - gallery
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Olivier Paroz <owncloud@interfasys.ch>
*
* @copyright Olivier Paroz 2014-2015
*/
namespace OCA\Gallery\Service;
use OCP\Files\Folder;
use OCA\Gallery\Environment\NotFoundEnvException;
/**
* Looks for the folder to use, based on the request made by the client
*
* This is to make sure we were not:
* * given a file
* * given a folder name with a typo
*
* @package OCA\Gallery\Service
*/
class SearchFolderService extends FilesService {
/**
* @var int
*/
protected $virtualRootLevel = null;
/**
* This returns what we think is the current folder node based on a given path
*
* @param string $location
* @param string[] $features
*
* @return array <string,Folder,bool>
*/
public function getCurrentFolder($location, $features) {
$this->features = $features;
return $this->findFolder($location);
}
/**
* This returns the current folder node based on a path
*
* If the path leads to a file, we'll return the node of the containing folder
*
* If we can't find anything, we try with the parent folder, up to the root or until we reach
* our recursive limit
*
* @param string $location
* @param int $depth
*
* @return array <string,Folder,bool>
*/
private function findFolder($location, $depth = 0) {
$node = null;
$location = $this->validateLocation($location, $depth);
try {
$node = $this->environment->getNodeFromVirtualRoot($location);
if ($node->getType() === 'file') {
$node = $node->getParent();
}
} catch (NotFoundEnvException $exception) {
// There might be a typo in the file or folder name
$folder = pathinfo($location, PATHINFO_DIRNAME);
$depth++;
return $this->findFolder($folder, $depth);
}
$path = $this->environment->getPathFromVirtualRoot($node);
$locationHasChanged = $this->hasLocationChanged($depth);
return $this->sendFolder($path, $node, $locationHasChanged);
}
/**
* Makes sure we don't go too far up before giving up
*
* @param string $location
* @param int $depth
*
* @return string
*/
private function validateLocation($location, $depth) {
if ($depth === 4) {
// We can't find anything, so we decide to return data for the root folder
$location = '';
}
return $location;
}
/**
* @param $depth
*
* @return bool
*/
private function hasLocationChanged($depth) {
$locationHasChanged = false;
if ($depth > 0) {
$locationHasChanged = true;
}
return $locationHasChanged;
}
/**
* Makes sure that the folder is not empty, does meet our requirements in terms of location and
* returns details about it
*
* @param string $path
* @param Folder $node
* @param bool $locationHasChanged
*
* @return array <string,Folder,bool>
* @throws ForbiddenServiceException|NotFoundServiceException
*/
private function sendFolder($path, $node, $locationHasChanged) {
if (is_null($node)) {
// Something very wrong has just happened
throw new NotFoundServiceException('Oh Nooooes!');
} elseif (!$this->isAllowedAndAvailable($node)) {
throw new ForbiddenServiceException('Album is private or unavailable');
}
return [$path, $node, $locationHasChanged];
}
}
|
