@@ -156,7 +156,7 @@ |
||
156 | 156 | /** |
157 | 157 | * @param string $gid |
158 | 158 | * @param string $displayName |
159 | - * @return \OCP\IGroup |
|
159 | + * @return null|Group |
|
160 | 160 | */ |
161 | 161 | protected function getGroupObject($gid, $displayName = null) { |
162 | 162 | $backends = array(); |
@@ -93,20 +93,20 @@ discard block |
||
93 | 93 | $this->logger = $logger; |
94 | 94 | $cachedGroups = & $this->cachedGroups; |
95 | 95 | $cachedUserGroups = & $this->cachedUserGroups; |
96 | - $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
96 | + $this->listen('\OC\Group', 'postDelete', function($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
97 | 97 | /** |
98 | 98 | * @var \OC\Group\Group $group |
99 | 99 | */ |
100 | 100 | unset($cachedGroups[$group->getGID()]); |
101 | 101 | $cachedUserGroups = array(); |
102 | 102 | }); |
103 | - $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) { |
|
103 | + $this->listen('\OC\Group', 'postAddUser', function($group) use (&$cachedUserGroups) { |
|
104 | 104 | /** |
105 | 105 | * @var \OC\Group\Group $group |
106 | 106 | */ |
107 | 107 | $cachedUserGroups = array(); |
108 | 108 | }); |
109 | - $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) { |
|
109 | + $this->listen('\OC\Group', 'postRemoveUser', function($group) use (&$cachedUserGroups) { |
|
110 | 110 | /** |
111 | 111 | * @var \OC\Group\Group $group |
112 | 112 | */ |
@@ -235,7 +235,7 @@ discard block |
||
235 | 235 | if ($aGroup instanceof IGroup) { |
236 | 236 | $groups[$groupId] = $aGroup; |
237 | 237 | } else { |
238 | - $this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']); |
|
238 | + $this->logger->debug('Group "'.$groupId.'" was returned by search but not found through direct access', ['app' => 'core']); |
|
239 | 239 | } |
240 | 240 | } |
241 | 241 | if (!is_null($limit) and $limit <= 0) { |
@@ -249,7 +249,7 @@ discard block |
||
249 | 249 | * @param IUser|null $user |
250 | 250 | * @return \OC\Group\Group[] |
251 | 251 | */ |
252 | - public function getUserGroups(IUser $user= null) { |
|
252 | + public function getUserGroups(IUser $user = null) { |
|
253 | 253 | if (!$user instanceof IUser) { |
254 | 254 | return []; |
255 | 255 | } |
@@ -273,7 +273,7 @@ discard block |
||
273 | 273 | if ($aGroup instanceof IGroup) { |
274 | 274 | $groups[$groupId] = $aGroup; |
275 | 275 | } else { |
276 | - $this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']); |
|
276 | + $this->logger->debug('User "'.$uid.'" belongs to deleted group: "'.$groupId.'"', ['app' => 'core']); |
|
277 | 277 | } |
278 | 278 | } |
279 | 279 | } |
@@ -322,32 +322,32 @@ discard block |
||
322 | 322 | */ |
323 | 323 | public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
324 | 324 | $group = $this->get($gid); |
325 | - if(is_null($group)) { |
|
325 | + if (is_null($group)) { |
|
326 | 326 | return array(); |
327 | 327 | } |
328 | 328 | |
329 | 329 | $search = trim($search); |
330 | 330 | $groupUsers = array(); |
331 | 331 | |
332 | - if(!empty($search)) { |
|
332 | + if (!empty($search)) { |
|
333 | 333 | // only user backends have the capability to do a complex search for users |
334 | 334 | $searchOffset = 0; |
335 | 335 | $searchLimit = $limit * 100; |
336 | - if($limit === -1) { |
|
336 | + if ($limit === -1) { |
|
337 | 337 | $searchLimit = 500; |
338 | 338 | } |
339 | 339 | |
340 | 340 | do { |
341 | 341 | $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset); |
342 | - foreach($filteredUsers as $filteredUser) { |
|
343 | - if($group->inGroup($filteredUser)) { |
|
344 | - $groupUsers[]= $filteredUser; |
|
342 | + foreach ($filteredUsers as $filteredUser) { |
|
343 | + if ($group->inGroup($filteredUser)) { |
|
344 | + $groupUsers[] = $filteredUser; |
|
345 | 345 | } |
346 | 346 | } |
347 | 347 | $searchOffset += $searchLimit; |
348 | - } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit); |
|
348 | + } while (count($groupUsers) < $searchLimit + $offset && count($filteredUsers) >= $searchLimit); |
|
349 | 349 | |
350 | - if($limit === -1) { |
|
350 | + if ($limit === -1) { |
|
351 | 351 | $groupUsers = array_slice($groupUsers, $offset); |
352 | 352 | } else { |
353 | 353 | $groupUsers = array_slice($groupUsers, $offset, $limit); |
@@ -357,7 +357,7 @@ discard block |
||
357 | 357 | } |
358 | 358 | |
359 | 359 | $matchingUsers = array(); |
360 | - foreach($groupUsers as $groupUser) { |
|
360 | + foreach ($groupUsers as $groupUser) { |
|
361 | 361 | $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName(); |
362 | 362 | } |
363 | 363 | return $matchingUsers; |
@@ -58,328 +58,328 @@ |
||
58 | 58 | * @package OC\Group |
59 | 59 | */ |
60 | 60 | class Manager extends PublicEmitter implements IGroupManager { |
61 | - /** |
|
62 | - * @var GroupInterface[] $backends |
|
63 | - */ |
|
64 | - private $backends = array(); |
|
65 | - |
|
66 | - /** |
|
67 | - * @var \OC\User\Manager $userManager |
|
68 | - */ |
|
69 | - private $userManager; |
|
70 | - |
|
71 | - /** |
|
72 | - * @var \OC\Group\Group[] |
|
73 | - */ |
|
74 | - private $cachedGroups = array(); |
|
75 | - |
|
76 | - /** |
|
77 | - * @var \OC\Group\Group[][] |
|
78 | - */ |
|
79 | - private $cachedUserGroups = array(); |
|
80 | - |
|
81 | - /** @var \OC\SubAdmin */ |
|
82 | - private $subAdmin = null; |
|
83 | - |
|
84 | - /** @var ILogger */ |
|
85 | - private $logger; |
|
86 | - |
|
87 | - /** |
|
88 | - * @param \OC\User\Manager $userManager |
|
89 | - * @param ILogger $logger |
|
90 | - */ |
|
91 | - public function __construct(\OC\User\Manager $userManager, ILogger $logger) { |
|
92 | - $this->userManager = $userManager; |
|
93 | - $this->logger = $logger; |
|
94 | - $cachedGroups = & $this->cachedGroups; |
|
95 | - $cachedUserGroups = & $this->cachedUserGroups; |
|
96 | - $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
97 | - /** |
|
98 | - * @var \OC\Group\Group $group |
|
99 | - */ |
|
100 | - unset($cachedGroups[$group->getGID()]); |
|
101 | - $cachedUserGroups = array(); |
|
102 | - }); |
|
103 | - $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) { |
|
104 | - /** |
|
105 | - * @var \OC\Group\Group $group |
|
106 | - */ |
|
107 | - $cachedUserGroups = array(); |
|
108 | - }); |
|
109 | - $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) { |
|
110 | - /** |
|
111 | - * @var \OC\Group\Group $group |
|
112 | - */ |
|
113 | - $cachedUserGroups = array(); |
|
114 | - }); |
|
115 | - } |
|
116 | - |
|
117 | - /** |
|
118 | - * Checks whether a given backend is used |
|
119 | - * |
|
120 | - * @param string $backendClass Full classname including complete namespace |
|
121 | - * @return bool |
|
122 | - */ |
|
123 | - public function isBackendUsed($backendClass) { |
|
124 | - $backendClass = strtolower(ltrim($backendClass, '\\')); |
|
125 | - |
|
126 | - foreach ($this->backends as $backend) { |
|
127 | - if (strtolower(get_class($backend)) === $backendClass) { |
|
128 | - return true; |
|
129 | - } |
|
130 | - } |
|
131 | - |
|
132 | - return false; |
|
133 | - } |
|
134 | - |
|
135 | - /** |
|
136 | - * @param \OCP\GroupInterface $backend |
|
137 | - */ |
|
138 | - public function addBackend($backend) { |
|
139 | - $this->backends[] = $backend; |
|
140 | - $this->clearCaches(); |
|
141 | - } |
|
142 | - |
|
143 | - public function clearBackends() { |
|
144 | - $this->backends = array(); |
|
145 | - $this->clearCaches(); |
|
146 | - } |
|
61 | + /** |
|
62 | + * @var GroupInterface[] $backends |
|
63 | + */ |
|
64 | + private $backends = array(); |
|
65 | + |
|
66 | + /** |
|
67 | + * @var \OC\User\Manager $userManager |
|
68 | + */ |
|
69 | + private $userManager; |
|
70 | + |
|
71 | + /** |
|
72 | + * @var \OC\Group\Group[] |
|
73 | + */ |
|
74 | + private $cachedGroups = array(); |
|
75 | + |
|
76 | + /** |
|
77 | + * @var \OC\Group\Group[][] |
|
78 | + */ |
|
79 | + private $cachedUserGroups = array(); |
|
80 | + |
|
81 | + /** @var \OC\SubAdmin */ |
|
82 | + private $subAdmin = null; |
|
83 | + |
|
84 | + /** @var ILogger */ |
|
85 | + private $logger; |
|
86 | + |
|
87 | + /** |
|
88 | + * @param \OC\User\Manager $userManager |
|
89 | + * @param ILogger $logger |
|
90 | + */ |
|
91 | + public function __construct(\OC\User\Manager $userManager, ILogger $logger) { |
|
92 | + $this->userManager = $userManager; |
|
93 | + $this->logger = $logger; |
|
94 | + $cachedGroups = & $this->cachedGroups; |
|
95 | + $cachedUserGroups = & $this->cachedUserGroups; |
|
96 | + $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
97 | + /** |
|
98 | + * @var \OC\Group\Group $group |
|
99 | + */ |
|
100 | + unset($cachedGroups[$group->getGID()]); |
|
101 | + $cachedUserGroups = array(); |
|
102 | + }); |
|
103 | + $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) { |
|
104 | + /** |
|
105 | + * @var \OC\Group\Group $group |
|
106 | + */ |
|
107 | + $cachedUserGroups = array(); |
|
108 | + }); |
|
109 | + $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) { |
|
110 | + /** |
|
111 | + * @var \OC\Group\Group $group |
|
112 | + */ |
|
113 | + $cachedUserGroups = array(); |
|
114 | + }); |
|
115 | + } |
|
116 | + |
|
117 | + /** |
|
118 | + * Checks whether a given backend is used |
|
119 | + * |
|
120 | + * @param string $backendClass Full classname including complete namespace |
|
121 | + * @return bool |
|
122 | + */ |
|
123 | + public function isBackendUsed($backendClass) { |
|
124 | + $backendClass = strtolower(ltrim($backendClass, '\\')); |
|
125 | + |
|
126 | + foreach ($this->backends as $backend) { |
|
127 | + if (strtolower(get_class($backend)) === $backendClass) { |
|
128 | + return true; |
|
129 | + } |
|
130 | + } |
|
131 | + |
|
132 | + return false; |
|
133 | + } |
|
134 | + |
|
135 | + /** |
|
136 | + * @param \OCP\GroupInterface $backend |
|
137 | + */ |
|
138 | + public function addBackend($backend) { |
|
139 | + $this->backends[] = $backend; |
|
140 | + $this->clearCaches(); |
|
141 | + } |
|
142 | + |
|
143 | + public function clearBackends() { |
|
144 | + $this->backends = array(); |
|
145 | + $this->clearCaches(); |
|
146 | + } |
|
147 | 147 | |
148 | - protected function clearCaches() { |
|
149 | - $this->cachedGroups = array(); |
|
150 | - $this->cachedUserGroups = array(); |
|
151 | - } |
|
152 | - |
|
153 | - /** |
|
154 | - * @param string $gid |
|
155 | - * @return \OC\Group\Group |
|
156 | - */ |
|
157 | - public function get($gid) { |
|
158 | - if (isset($this->cachedGroups[$gid])) { |
|
159 | - return $this->cachedGroups[$gid]; |
|
160 | - } |
|
161 | - return $this->getGroupObject($gid); |
|
162 | - } |
|
163 | - |
|
164 | - /** |
|
165 | - * @param string $gid |
|
166 | - * @param string $displayName |
|
167 | - * @return \OCP\IGroup |
|
168 | - */ |
|
169 | - protected function getGroupObject($gid, $displayName = null) { |
|
170 | - $backends = array(); |
|
171 | - foreach ($this->backends as $backend) { |
|
172 | - if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) { |
|
173 | - $groupData = $backend->getGroupDetails($gid); |
|
174 | - if (is_array($groupData)) { |
|
175 | - // take the display name from the first backend that has a non-null one |
|
176 | - if (is_null($displayName) && isset($groupData['displayName'])) { |
|
177 | - $displayName = $groupData['displayName']; |
|
178 | - } |
|
179 | - $backends[] = $backend; |
|
180 | - } |
|
181 | - } else if ($backend->groupExists($gid)) { |
|
182 | - $backends[] = $backend; |
|
183 | - } |
|
184 | - } |
|
185 | - if (count($backends) === 0) { |
|
186 | - return null; |
|
187 | - } |
|
188 | - $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName); |
|
189 | - return $this->cachedGroups[$gid]; |
|
190 | - } |
|
191 | - |
|
192 | - /** |
|
193 | - * @param string $gid |
|
194 | - * @return bool |
|
195 | - */ |
|
196 | - public function groupExists($gid) { |
|
197 | - return $this->get($gid) instanceof IGroup; |
|
198 | - } |
|
199 | - |
|
200 | - /** |
|
201 | - * @param string $gid |
|
202 | - * @return \OC\Group\Group |
|
203 | - */ |
|
204 | - public function createGroup($gid) { |
|
205 | - if ($gid === '' || $gid === null) { |
|
206 | - return false; |
|
207 | - } else if ($group = $this->get($gid)) { |
|
208 | - return $group; |
|
209 | - } else { |
|
210 | - $this->emit('\OC\Group', 'preCreate', array($gid)); |
|
211 | - foreach ($this->backends as $backend) { |
|
212 | - if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) { |
|
213 | - $backend->createGroup($gid); |
|
214 | - $group = $this->getGroupObject($gid); |
|
215 | - $this->emit('\OC\Group', 'postCreate', array($group)); |
|
216 | - return $group; |
|
217 | - } |
|
218 | - } |
|
219 | - return null; |
|
220 | - } |
|
221 | - } |
|
222 | - |
|
223 | - /** |
|
224 | - * @param string $search |
|
225 | - * @param int $limit |
|
226 | - * @param int $offset |
|
227 | - * @return \OC\Group\Group[] |
|
228 | - */ |
|
229 | - public function search($search, $limit = null, $offset = null) { |
|
230 | - $groups = array(); |
|
231 | - foreach ($this->backends as $backend) { |
|
232 | - $groupIds = $backend->getGroups($search, $limit, $offset); |
|
233 | - foreach ($groupIds as $groupId) { |
|
234 | - $aGroup = $this->get($groupId); |
|
235 | - if ($aGroup instanceof IGroup) { |
|
236 | - $groups[$groupId] = $aGroup; |
|
237 | - } else { |
|
238 | - $this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']); |
|
239 | - } |
|
240 | - } |
|
241 | - if (!is_null($limit) and $limit <= 0) { |
|
242 | - return array_values($groups); |
|
243 | - } |
|
244 | - } |
|
245 | - return array_values($groups); |
|
246 | - } |
|
247 | - |
|
248 | - /** |
|
249 | - * @param IUser|null $user |
|
250 | - * @return \OC\Group\Group[] |
|
251 | - */ |
|
252 | - public function getUserGroups(IUser $user= null) { |
|
253 | - if (!$user instanceof IUser) { |
|
254 | - return []; |
|
255 | - } |
|
256 | - return $this->getUserIdGroups($user->getUID()); |
|
257 | - } |
|
258 | - |
|
259 | - /** |
|
260 | - * @param string $uid the user id |
|
261 | - * @return \OC\Group\Group[] |
|
262 | - */ |
|
263 | - public function getUserIdGroups($uid) { |
|
264 | - if (isset($this->cachedUserGroups[$uid])) { |
|
265 | - return $this->cachedUserGroups[$uid]; |
|
266 | - } |
|
267 | - $groups = array(); |
|
268 | - foreach ($this->backends as $backend) { |
|
269 | - $groupIds = $backend->getUserGroups($uid); |
|
270 | - if (is_array($groupIds)) { |
|
271 | - foreach ($groupIds as $groupId) { |
|
272 | - $aGroup = $this->get($groupId); |
|
273 | - if ($aGroup instanceof IGroup) { |
|
274 | - $groups[$groupId] = $aGroup; |
|
275 | - } else { |
|
276 | - $this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']); |
|
277 | - } |
|
278 | - } |
|
279 | - } |
|
280 | - } |
|
281 | - $this->cachedUserGroups[$uid] = $groups; |
|
282 | - return $this->cachedUserGroups[$uid]; |
|
283 | - } |
|
284 | - |
|
285 | - /** |
|
286 | - * Checks if a userId is in the admin group |
|
287 | - * @param string $userId |
|
288 | - * @return bool if admin |
|
289 | - */ |
|
290 | - public function isAdmin($userId) { |
|
291 | - foreach ($this->backends as $backend) { |
|
292 | - if ($backend->implementsActions(\OC\Group\Backend::IS_ADMIN) && $backend->isAdmin($userId)) { |
|
293 | - return true; |
|
294 | - } |
|
295 | - } |
|
296 | - return $this->isInGroup($userId, 'admin'); |
|
297 | - } |
|
298 | - |
|
299 | - /** |
|
300 | - * Checks if a userId is in a group |
|
301 | - * @param string $userId |
|
302 | - * @param string $group |
|
303 | - * @return bool if in group |
|
304 | - */ |
|
305 | - public function isInGroup($userId, $group) { |
|
306 | - return array_key_exists($group, $this->getUserIdGroups($userId)); |
|
307 | - } |
|
308 | - |
|
309 | - /** |
|
310 | - * get a list of group ids for a user |
|
311 | - * @param IUser $user |
|
312 | - * @return array with group ids |
|
313 | - */ |
|
314 | - public function getUserGroupIds(IUser $user) { |
|
315 | - return array_map(function($value) { |
|
316 | - return (string) $value; |
|
317 | - }, array_keys($this->getUserGroups($user))); |
|
318 | - } |
|
319 | - |
|
320 | - /** |
|
321 | - * get a list of all display names in a group |
|
322 | - * @param string $gid |
|
323 | - * @param string $search |
|
324 | - * @param int $limit |
|
325 | - * @param int $offset |
|
326 | - * @return array an array of display names (value) and user ids (key) |
|
327 | - */ |
|
328 | - public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
|
329 | - $group = $this->get($gid); |
|
330 | - if(is_null($group)) { |
|
331 | - return array(); |
|
332 | - } |
|
333 | - |
|
334 | - $search = trim($search); |
|
335 | - $groupUsers = array(); |
|
336 | - |
|
337 | - if(!empty($search)) { |
|
338 | - // only user backends have the capability to do a complex search for users |
|
339 | - $searchOffset = 0; |
|
340 | - $searchLimit = $limit * 100; |
|
341 | - if($limit === -1) { |
|
342 | - $searchLimit = 500; |
|
343 | - } |
|
344 | - |
|
345 | - do { |
|
346 | - $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset); |
|
347 | - foreach($filteredUsers as $filteredUser) { |
|
348 | - if($group->inGroup($filteredUser)) { |
|
349 | - $groupUsers[]= $filteredUser; |
|
350 | - } |
|
351 | - } |
|
352 | - $searchOffset += $searchLimit; |
|
353 | - } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit); |
|
354 | - |
|
355 | - if($limit === -1) { |
|
356 | - $groupUsers = array_slice($groupUsers, $offset); |
|
357 | - } else { |
|
358 | - $groupUsers = array_slice($groupUsers, $offset, $limit); |
|
359 | - } |
|
360 | - } else { |
|
361 | - $groupUsers = $group->searchUsers('', $limit, $offset); |
|
362 | - } |
|
363 | - |
|
364 | - $matchingUsers = array(); |
|
365 | - foreach($groupUsers as $groupUser) { |
|
366 | - $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName(); |
|
367 | - } |
|
368 | - return $matchingUsers; |
|
369 | - } |
|
370 | - |
|
371 | - /** |
|
372 | - * @return \OC\SubAdmin |
|
373 | - */ |
|
374 | - public function getSubAdmin() { |
|
375 | - if (!$this->subAdmin) { |
|
376 | - $this->subAdmin = new \OC\SubAdmin( |
|
377 | - $this->userManager, |
|
378 | - $this, |
|
379 | - \OC::$server->getDatabaseConnection() |
|
380 | - ); |
|
381 | - } |
|
382 | - |
|
383 | - return $this->subAdmin; |
|
384 | - } |
|
148 | + protected function clearCaches() { |
|
149 | + $this->cachedGroups = array(); |
|
150 | + $this->cachedUserGroups = array(); |
|
151 | + } |
|
152 | + |
|
153 | + /** |
|
154 | + * @param string $gid |
|
155 | + * @return \OC\Group\Group |
|
156 | + */ |
|
157 | + public function get($gid) { |
|
158 | + if (isset($this->cachedGroups[$gid])) { |
|
159 | + return $this->cachedGroups[$gid]; |
|
160 | + } |
|
161 | + return $this->getGroupObject($gid); |
|
162 | + } |
|
163 | + |
|
164 | + /** |
|
165 | + * @param string $gid |
|
166 | + * @param string $displayName |
|
167 | + * @return \OCP\IGroup |
|
168 | + */ |
|
169 | + protected function getGroupObject($gid, $displayName = null) { |
|
170 | + $backends = array(); |
|
171 | + foreach ($this->backends as $backend) { |
|
172 | + if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) { |
|
173 | + $groupData = $backend->getGroupDetails($gid); |
|
174 | + if (is_array($groupData)) { |
|
175 | + // take the display name from the first backend that has a non-null one |
|
176 | + if (is_null($displayName) && isset($groupData['displayName'])) { |
|
177 | + $displayName = $groupData['displayName']; |
|
178 | + } |
|
179 | + $backends[] = $backend; |
|
180 | + } |
|
181 | + } else if ($backend->groupExists($gid)) { |
|
182 | + $backends[] = $backend; |
|
183 | + } |
|
184 | + } |
|
185 | + if (count($backends) === 0) { |
|
186 | + return null; |
|
187 | + } |
|
188 | + $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName); |
|
189 | + return $this->cachedGroups[$gid]; |
|
190 | + } |
|
191 | + |
|
192 | + /** |
|
193 | + * @param string $gid |
|
194 | + * @return bool |
|
195 | + */ |
|
196 | + public function groupExists($gid) { |
|
197 | + return $this->get($gid) instanceof IGroup; |
|
198 | + } |
|
199 | + |
|
200 | + /** |
|
201 | + * @param string $gid |
|
202 | + * @return \OC\Group\Group |
|
203 | + */ |
|
204 | + public function createGroup($gid) { |
|
205 | + if ($gid === '' || $gid === null) { |
|
206 | + return false; |
|
207 | + } else if ($group = $this->get($gid)) { |
|
208 | + return $group; |
|
209 | + } else { |
|
210 | + $this->emit('\OC\Group', 'preCreate', array($gid)); |
|
211 | + foreach ($this->backends as $backend) { |
|
212 | + if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) { |
|
213 | + $backend->createGroup($gid); |
|
214 | + $group = $this->getGroupObject($gid); |
|
215 | + $this->emit('\OC\Group', 'postCreate', array($group)); |
|
216 | + return $group; |
|
217 | + } |
|
218 | + } |
|
219 | + return null; |
|
220 | + } |
|
221 | + } |
|
222 | + |
|
223 | + /** |
|
224 | + * @param string $search |
|
225 | + * @param int $limit |
|
226 | + * @param int $offset |
|
227 | + * @return \OC\Group\Group[] |
|
228 | + */ |
|
229 | + public function search($search, $limit = null, $offset = null) { |
|
230 | + $groups = array(); |
|
231 | + foreach ($this->backends as $backend) { |
|
232 | + $groupIds = $backend->getGroups($search, $limit, $offset); |
|
233 | + foreach ($groupIds as $groupId) { |
|
234 | + $aGroup = $this->get($groupId); |
|
235 | + if ($aGroup instanceof IGroup) { |
|
236 | + $groups[$groupId] = $aGroup; |
|
237 | + } else { |
|
238 | + $this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']); |
|
239 | + } |
|
240 | + } |
|
241 | + if (!is_null($limit) and $limit <= 0) { |
|
242 | + return array_values($groups); |
|
243 | + } |
|
244 | + } |
|
245 | + return array_values($groups); |
|
246 | + } |
|
247 | + |
|
248 | + /** |
|
249 | + * @param IUser|null $user |
|
250 | + * @return \OC\Group\Group[] |
|
251 | + */ |
|
252 | + public function getUserGroups(IUser $user= null) { |
|
253 | + if (!$user instanceof IUser) { |
|
254 | + return []; |
|
255 | + } |
|
256 | + return $this->getUserIdGroups($user->getUID()); |
|
257 | + } |
|
258 | + |
|
259 | + /** |
|
260 | + * @param string $uid the user id |
|
261 | + * @return \OC\Group\Group[] |
|
262 | + */ |
|
263 | + public function getUserIdGroups($uid) { |
|
264 | + if (isset($this->cachedUserGroups[$uid])) { |
|
265 | + return $this->cachedUserGroups[$uid]; |
|
266 | + } |
|
267 | + $groups = array(); |
|
268 | + foreach ($this->backends as $backend) { |
|
269 | + $groupIds = $backend->getUserGroups($uid); |
|
270 | + if (is_array($groupIds)) { |
|
271 | + foreach ($groupIds as $groupId) { |
|
272 | + $aGroup = $this->get($groupId); |
|
273 | + if ($aGroup instanceof IGroup) { |
|
274 | + $groups[$groupId] = $aGroup; |
|
275 | + } else { |
|
276 | + $this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']); |
|
277 | + } |
|
278 | + } |
|
279 | + } |
|
280 | + } |
|
281 | + $this->cachedUserGroups[$uid] = $groups; |
|
282 | + return $this->cachedUserGroups[$uid]; |
|
283 | + } |
|
284 | + |
|
285 | + /** |
|
286 | + * Checks if a userId is in the admin group |
|
287 | + * @param string $userId |
|
288 | + * @return bool if admin |
|
289 | + */ |
|
290 | + public function isAdmin($userId) { |
|
291 | + foreach ($this->backends as $backend) { |
|
292 | + if ($backend->implementsActions(\OC\Group\Backend::IS_ADMIN) && $backend->isAdmin($userId)) { |
|
293 | + return true; |
|
294 | + } |
|
295 | + } |
|
296 | + return $this->isInGroup($userId, 'admin'); |
|
297 | + } |
|
298 | + |
|
299 | + /** |
|
300 | + * Checks if a userId is in a group |
|
301 | + * @param string $userId |
|
302 | + * @param string $group |
|
303 | + * @return bool if in group |
|
304 | + */ |
|
305 | + public function isInGroup($userId, $group) { |
|
306 | + return array_key_exists($group, $this->getUserIdGroups($userId)); |
|
307 | + } |
|
308 | + |
|
309 | + /** |
|
310 | + * get a list of group ids for a user |
|
311 | + * @param IUser $user |
|
312 | + * @return array with group ids |
|
313 | + */ |
|
314 | + public function getUserGroupIds(IUser $user) { |
|
315 | + return array_map(function($value) { |
|
316 | + return (string) $value; |
|
317 | + }, array_keys($this->getUserGroups($user))); |
|
318 | + } |
|
319 | + |
|
320 | + /** |
|
321 | + * get a list of all display names in a group |
|
322 | + * @param string $gid |
|
323 | + * @param string $search |
|
324 | + * @param int $limit |
|
325 | + * @param int $offset |
|
326 | + * @return array an array of display names (value) and user ids (key) |
|
327 | + */ |
|
328 | + public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
|
329 | + $group = $this->get($gid); |
|
330 | + if(is_null($group)) { |
|
331 | + return array(); |
|
332 | + } |
|
333 | + |
|
334 | + $search = trim($search); |
|
335 | + $groupUsers = array(); |
|
336 | + |
|
337 | + if(!empty($search)) { |
|
338 | + // only user backends have the capability to do a complex search for users |
|
339 | + $searchOffset = 0; |
|
340 | + $searchLimit = $limit * 100; |
|
341 | + if($limit === -1) { |
|
342 | + $searchLimit = 500; |
|
343 | + } |
|
344 | + |
|
345 | + do { |
|
346 | + $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset); |
|
347 | + foreach($filteredUsers as $filteredUser) { |
|
348 | + if($group->inGroup($filteredUser)) { |
|
349 | + $groupUsers[]= $filteredUser; |
|
350 | + } |
|
351 | + } |
|
352 | + $searchOffset += $searchLimit; |
|
353 | + } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit); |
|
354 | + |
|
355 | + if($limit === -1) { |
|
356 | + $groupUsers = array_slice($groupUsers, $offset); |
|
357 | + } else { |
|
358 | + $groupUsers = array_slice($groupUsers, $offset, $limit); |
|
359 | + } |
|
360 | + } else { |
|
361 | + $groupUsers = $group->searchUsers('', $limit, $offset); |
|
362 | + } |
|
363 | + |
|
364 | + $matchingUsers = array(); |
|
365 | + foreach($groupUsers as $groupUser) { |
|
366 | + $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName(); |
|
367 | + } |
|
368 | + return $matchingUsers; |
|
369 | + } |
|
370 | + |
|
371 | + /** |
|
372 | + * @return \OC\SubAdmin |
|
373 | + */ |
|
374 | + public function getSubAdmin() { |
|
375 | + if (!$this->subAdmin) { |
|
376 | + $this->subAdmin = new \OC\SubAdmin( |
|
377 | + $this->userManager, |
|
378 | + $this, |
|
379 | + \OC::$server->getDatabaseConnection() |
|
380 | + ); |
|
381 | + } |
|
382 | + |
|
383 | + return $this->subAdmin; |
|
384 | + } |
|
385 | 385 | } |
@@ -65,7 +65,7 @@ |
||
65 | 65 | * Set a value in the cache if it's not already stored |
66 | 66 | * |
67 | 67 | * @param string $key |
68 | - * @param mixed $value |
|
68 | + * @param integer $value |
|
69 | 69 | * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
70 | 70 | * @return bool |
71 | 71 | */ |
@@ -30,140 +30,140 @@ |
||
30 | 30 | use OCP\IMemcache; |
31 | 31 | |
32 | 32 | class APCu extends Cache implements IMemcache { |
33 | - use CASTrait { |
|
34 | - cas as casEmulated; |
|
35 | - } |
|
33 | + use CASTrait { |
|
34 | + cas as casEmulated; |
|
35 | + } |
|
36 | 36 | |
37 | - use CADTrait; |
|
37 | + use CADTrait; |
|
38 | 38 | |
39 | - public function get($key) { |
|
40 | - $result = apcu_fetch($this->getPrefix() . $key, $success); |
|
41 | - if (!$success) { |
|
42 | - return null; |
|
43 | - } |
|
44 | - return $result; |
|
45 | - } |
|
39 | + public function get($key) { |
|
40 | + $result = apcu_fetch($this->getPrefix() . $key, $success); |
|
41 | + if (!$success) { |
|
42 | + return null; |
|
43 | + } |
|
44 | + return $result; |
|
45 | + } |
|
46 | 46 | |
47 | - public function set($key, $value, $ttl = 0) { |
|
48 | - return apcu_store($this->getPrefix() . $key, $value, $ttl); |
|
49 | - } |
|
47 | + public function set($key, $value, $ttl = 0) { |
|
48 | + return apcu_store($this->getPrefix() . $key, $value, $ttl); |
|
49 | + } |
|
50 | 50 | |
51 | - public function hasKey($key) { |
|
52 | - return apcu_exists($this->getPrefix() . $key); |
|
53 | - } |
|
51 | + public function hasKey($key) { |
|
52 | + return apcu_exists($this->getPrefix() . $key); |
|
53 | + } |
|
54 | 54 | |
55 | - public function remove($key) { |
|
56 | - return apcu_delete($this->getPrefix() . $key); |
|
57 | - } |
|
55 | + public function remove($key) { |
|
56 | + return apcu_delete($this->getPrefix() . $key); |
|
57 | + } |
|
58 | 58 | |
59 | - public function clear($prefix = '') { |
|
60 | - $ns = $this->getPrefix() . $prefix; |
|
61 | - $ns = preg_quote($ns, '/'); |
|
62 | - if(class_exists('\APCIterator')) { |
|
63 | - $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY); |
|
64 | - } else { |
|
65 | - $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY); |
|
66 | - } |
|
67 | - return apcu_delete($iter); |
|
68 | - } |
|
59 | + public function clear($prefix = '') { |
|
60 | + $ns = $this->getPrefix() . $prefix; |
|
61 | + $ns = preg_quote($ns, '/'); |
|
62 | + if(class_exists('\APCIterator')) { |
|
63 | + $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY); |
|
64 | + } else { |
|
65 | + $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY); |
|
66 | + } |
|
67 | + return apcu_delete($iter); |
|
68 | + } |
|
69 | 69 | |
70 | - /** |
|
71 | - * Set a value in the cache if it's not already stored |
|
72 | - * |
|
73 | - * @param string $key |
|
74 | - * @param mixed $value |
|
75 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
76 | - * @return bool |
|
77 | - */ |
|
78 | - public function add($key, $value, $ttl = 0) { |
|
79 | - return apcu_add($this->getPrefix() . $key, $value, $ttl); |
|
80 | - } |
|
70 | + /** |
|
71 | + * Set a value in the cache if it's not already stored |
|
72 | + * |
|
73 | + * @param string $key |
|
74 | + * @param mixed $value |
|
75 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
76 | + * @return bool |
|
77 | + */ |
|
78 | + public function add($key, $value, $ttl = 0) { |
|
79 | + return apcu_add($this->getPrefix() . $key, $value, $ttl); |
|
80 | + } |
|
81 | 81 | |
82 | - /** |
|
83 | - * Increase a stored number |
|
84 | - * |
|
85 | - * @param string $key |
|
86 | - * @param int $step |
|
87 | - * @return int | bool |
|
88 | - */ |
|
89 | - public function inc($key, $step = 1) { |
|
90 | - $this->add($key, 0); |
|
91 | - /** |
|
92 | - * TODO - hack around a PHP 7 specific issue in APCu |
|
93 | - * |
|
94 | - * on PHP 7 the apcu_inc method on a non-existing object will increment |
|
95 | - * "0" and result in "1" as value - therefore we check for existence |
|
96 | - * first |
|
97 | - * |
|
98 | - * on PHP 5.6 this is not the case |
|
99 | - * |
|
100 | - * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
101 | - * for details |
|
102 | - */ |
|
103 | - return apcu_exists($this->getPrefix() . $key) |
|
104 | - ? apcu_inc($this->getPrefix() . $key, $step) |
|
105 | - : false; |
|
106 | - } |
|
82 | + /** |
|
83 | + * Increase a stored number |
|
84 | + * |
|
85 | + * @param string $key |
|
86 | + * @param int $step |
|
87 | + * @return int | bool |
|
88 | + */ |
|
89 | + public function inc($key, $step = 1) { |
|
90 | + $this->add($key, 0); |
|
91 | + /** |
|
92 | + * TODO - hack around a PHP 7 specific issue in APCu |
|
93 | + * |
|
94 | + * on PHP 7 the apcu_inc method on a non-existing object will increment |
|
95 | + * "0" and result in "1" as value - therefore we check for existence |
|
96 | + * first |
|
97 | + * |
|
98 | + * on PHP 5.6 this is not the case |
|
99 | + * |
|
100 | + * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
101 | + * for details |
|
102 | + */ |
|
103 | + return apcu_exists($this->getPrefix() . $key) |
|
104 | + ? apcu_inc($this->getPrefix() . $key, $step) |
|
105 | + : false; |
|
106 | + } |
|
107 | 107 | |
108 | - /** |
|
109 | - * Decrease a stored number |
|
110 | - * |
|
111 | - * @param string $key |
|
112 | - * @param int $step |
|
113 | - * @return int | bool |
|
114 | - */ |
|
115 | - public function dec($key, $step = 1) { |
|
116 | - /** |
|
117 | - * TODO - hack around a PHP 7 specific issue in APCu |
|
118 | - * |
|
119 | - * on PHP 7 the apcu_dec method on a non-existing object will decrement |
|
120 | - * "0" and result in "-1" as value - therefore we check for existence |
|
121 | - * first |
|
122 | - * |
|
123 | - * on PHP 5.6 this is not the case |
|
124 | - * |
|
125 | - * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
126 | - * for details |
|
127 | - */ |
|
128 | - return apcu_exists($this->getPrefix() . $key) |
|
129 | - ? apcu_dec($this->getPrefix() . $key, $step) |
|
130 | - : false; |
|
131 | - } |
|
108 | + /** |
|
109 | + * Decrease a stored number |
|
110 | + * |
|
111 | + * @param string $key |
|
112 | + * @param int $step |
|
113 | + * @return int | bool |
|
114 | + */ |
|
115 | + public function dec($key, $step = 1) { |
|
116 | + /** |
|
117 | + * TODO - hack around a PHP 7 specific issue in APCu |
|
118 | + * |
|
119 | + * on PHP 7 the apcu_dec method on a non-existing object will decrement |
|
120 | + * "0" and result in "-1" as value - therefore we check for existence |
|
121 | + * first |
|
122 | + * |
|
123 | + * on PHP 5.6 this is not the case |
|
124 | + * |
|
125 | + * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
126 | + * for details |
|
127 | + */ |
|
128 | + return apcu_exists($this->getPrefix() . $key) |
|
129 | + ? apcu_dec($this->getPrefix() . $key, $step) |
|
130 | + : false; |
|
131 | + } |
|
132 | 132 | |
133 | - /** |
|
134 | - * Compare and set |
|
135 | - * |
|
136 | - * @param string $key |
|
137 | - * @param mixed $old |
|
138 | - * @param mixed $new |
|
139 | - * @return bool |
|
140 | - */ |
|
141 | - public function cas($key, $old, $new) { |
|
142 | - // apc only does cas for ints |
|
143 | - if (is_int($old) and is_int($new)) { |
|
144 | - return apcu_cas($this->getPrefix() . $key, $old, $new); |
|
145 | - } else { |
|
146 | - return $this->casEmulated($key, $old, $new); |
|
147 | - } |
|
148 | - } |
|
133 | + /** |
|
134 | + * Compare and set |
|
135 | + * |
|
136 | + * @param string $key |
|
137 | + * @param mixed $old |
|
138 | + * @param mixed $new |
|
139 | + * @return bool |
|
140 | + */ |
|
141 | + public function cas($key, $old, $new) { |
|
142 | + // apc only does cas for ints |
|
143 | + if (is_int($old) and is_int($new)) { |
|
144 | + return apcu_cas($this->getPrefix() . $key, $old, $new); |
|
145 | + } else { |
|
146 | + return $this->casEmulated($key, $old, $new); |
|
147 | + } |
|
148 | + } |
|
149 | 149 | |
150 | - /** |
|
151 | - * @return bool |
|
152 | - */ |
|
153 | - static public function isAvailable() { |
|
154 | - if (!extension_loaded('apcu')) { |
|
155 | - return false; |
|
156 | - } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) { |
|
157 | - return false; |
|
158 | - } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) { |
|
159 | - return false; |
|
160 | - } elseif ( |
|
161 | - version_compare(phpversion('apc'), '4.0.6') === -1 && |
|
162 | - version_compare(phpversion('apcu'), '5.1.0') === -1 |
|
163 | - ) { |
|
164 | - return false; |
|
165 | - } else { |
|
166 | - return true; |
|
167 | - } |
|
168 | - } |
|
150 | + /** |
|
151 | + * @return bool |
|
152 | + */ |
|
153 | + static public function isAvailable() { |
|
154 | + if (!extension_loaded('apcu')) { |
|
155 | + return false; |
|
156 | + } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) { |
|
157 | + return false; |
|
158 | + } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) { |
|
159 | + return false; |
|
160 | + } elseif ( |
|
161 | + version_compare(phpversion('apc'), '4.0.6') === -1 && |
|
162 | + version_compare(phpversion('apcu'), '5.1.0') === -1 |
|
163 | + ) { |
|
164 | + return false; |
|
165 | + } else { |
|
166 | + return true; |
|
167 | + } |
|
168 | + } |
|
169 | 169 | } |
@@ -37,7 +37,7 @@ discard block |
||
37 | 37 | use CADTrait; |
38 | 38 | |
39 | 39 | public function get($key) { |
40 | - $result = apcu_fetch($this->getPrefix() . $key, $success); |
|
40 | + $result = apcu_fetch($this->getPrefix().$key, $success); |
|
41 | 41 | if (!$success) { |
42 | 42 | return null; |
43 | 43 | } |
@@ -45,24 +45,24 @@ discard block |
||
45 | 45 | } |
46 | 46 | |
47 | 47 | public function set($key, $value, $ttl = 0) { |
48 | - return apcu_store($this->getPrefix() . $key, $value, $ttl); |
|
48 | + return apcu_store($this->getPrefix().$key, $value, $ttl); |
|
49 | 49 | } |
50 | 50 | |
51 | 51 | public function hasKey($key) { |
52 | - return apcu_exists($this->getPrefix() . $key); |
|
52 | + return apcu_exists($this->getPrefix().$key); |
|
53 | 53 | } |
54 | 54 | |
55 | 55 | public function remove($key) { |
56 | - return apcu_delete($this->getPrefix() . $key); |
|
56 | + return apcu_delete($this->getPrefix().$key); |
|
57 | 57 | } |
58 | 58 | |
59 | 59 | public function clear($prefix = '') { |
60 | - $ns = $this->getPrefix() . $prefix; |
|
60 | + $ns = $this->getPrefix().$prefix; |
|
61 | 61 | $ns = preg_quote($ns, '/'); |
62 | - if(class_exists('\APCIterator')) { |
|
63 | - $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY); |
|
62 | + if (class_exists('\APCIterator')) { |
|
63 | + $iter = new \APCIterator('user', '/^'.$ns.'/', APC_ITER_KEY); |
|
64 | 64 | } else { |
65 | - $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY); |
|
65 | + $iter = new \APCUIterator('/^'.$ns.'/', APC_ITER_KEY); |
|
66 | 66 | } |
67 | 67 | return apcu_delete($iter); |
68 | 68 | } |
@@ -76,7 +76,7 @@ discard block |
||
76 | 76 | * @return bool |
77 | 77 | */ |
78 | 78 | public function add($key, $value, $ttl = 0) { |
79 | - return apcu_add($this->getPrefix() . $key, $value, $ttl); |
|
79 | + return apcu_add($this->getPrefix().$key, $value, $ttl); |
|
80 | 80 | } |
81 | 81 | |
82 | 82 | /** |
@@ -100,8 +100,8 @@ discard block |
||
100 | 100 | * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
101 | 101 | * for details |
102 | 102 | */ |
103 | - return apcu_exists($this->getPrefix() . $key) |
|
104 | - ? apcu_inc($this->getPrefix() . $key, $step) |
|
103 | + return apcu_exists($this->getPrefix().$key) |
|
104 | + ? apcu_inc($this->getPrefix().$key, $step) |
|
105 | 105 | : false; |
106 | 106 | } |
107 | 107 | |
@@ -125,8 +125,8 @@ discard block |
||
125 | 125 | * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
126 | 126 | * for details |
127 | 127 | */ |
128 | - return apcu_exists($this->getPrefix() . $key) |
|
129 | - ? apcu_dec($this->getPrefix() . $key, $step) |
|
128 | + return apcu_exists($this->getPrefix().$key) |
|
129 | + ? apcu_dec($this->getPrefix().$key, $step) |
|
130 | 130 | : false; |
131 | 131 | } |
132 | 132 | |
@@ -141,7 +141,7 @@ discard block |
||
141 | 141 | public function cas($key, $old, $new) { |
142 | 142 | // apc only does cas for ints |
143 | 143 | if (is_int($old) and is_int($new)) { |
144 | - return apcu_cas($this->getPrefix() . $key, $old, $new); |
|
144 | + return apcu_cas($this->getPrefix().$key, $old, $new); |
|
145 | 145 | } else { |
146 | 146 | return $this->casEmulated($key, $old, $new); |
147 | 147 | } |
@@ -65,7 +65,7 @@ |
||
65 | 65 | * Set a value in the cache if it's not already stored |
66 | 66 | * |
67 | 67 | * @param string $key |
68 | - * @param mixed $value |
|
68 | + * @param integer $value |
|
69 | 69 | * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
70 | 70 | * @return bool |
71 | 71 | */ |
@@ -27,133 +27,133 @@ |
||
27 | 27 | use OCP\IMemcache; |
28 | 28 | |
29 | 29 | class ArrayCache extends Cache implements IMemcache { |
30 | - /** @var array Array with the cached data */ |
|
31 | - protected $cachedData = array(); |
|
30 | + /** @var array Array with the cached data */ |
|
31 | + protected $cachedData = array(); |
|
32 | 32 | |
33 | - use CADTrait; |
|
33 | + use CADTrait; |
|
34 | 34 | |
35 | - /** |
|
36 | - * {@inheritDoc} |
|
37 | - */ |
|
38 | - public function get($key) { |
|
39 | - if ($this->hasKey($key)) { |
|
40 | - return $this->cachedData[$key]; |
|
41 | - } |
|
42 | - return null; |
|
43 | - } |
|
35 | + /** |
|
36 | + * {@inheritDoc} |
|
37 | + */ |
|
38 | + public function get($key) { |
|
39 | + if ($this->hasKey($key)) { |
|
40 | + return $this->cachedData[$key]; |
|
41 | + } |
|
42 | + return null; |
|
43 | + } |
|
44 | 44 | |
45 | - /** |
|
46 | - * {@inheritDoc} |
|
47 | - */ |
|
48 | - public function set($key, $value, $ttl = 0) { |
|
49 | - $this->cachedData[$key] = $value; |
|
50 | - return true; |
|
51 | - } |
|
45 | + /** |
|
46 | + * {@inheritDoc} |
|
47 | + */ |
|
48 | + public function set($key, $value, $ttl = 0) { |
|
49 | + $this->cachedData[$key] = $value; |
|
50 | + return true; |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * {@inheritDoc} |
|
55 | - */ |
|
56 | - public function hasKey($key) { |
|
57 | - return isset($this->cachedData[$key]); |
|
58 | - } |
|
53 | + /** |
|
54 | + * {@inheritDoc} |
|
55 | + */ |
|
56 | + public function hasKey($key) { |
|
57 | + return isset($this->cachedData[$key]); |
|
58 | + } |
|
59 | 59 | |
60 | - /** |
|
61 | - * {@inheritDoc} |
|
62 | - */ |
|
63 | - public function remove($key) { |
|
64 | - unset($this->cachedData[$key]); |
|
65 | - return true; |
|
66 | - } |
|
60 | + /** |
|
61 | + * {@inheritDoc} |
|
62 | + */ |
|
63 | + public function remove($key) { |
|
64 | + unset($this->cachedData[$key]); |
|
65 | + return true; |
|
66 | + } |
|
67 | 67 | |
68 | - /** |
|
69 | - * {@inheritDoc} |
|
70 | - */ |
|
71 | - public function clear($prefix = '') { |
|
72 | - if ($prefix === '') { |
|
73 | - $this->cachedData = []; |
|
74 | - return true; |
|
75 | - } |
|
68 | + /** |
|
69 | + * {@inheritDoc} |
|
70 | + */ |
|
71 | + public function clear($prefix = '') { |
|
72 | + if ($prefix === '') { |
|
73 | + $this->cachedData = []; |
|
74 | + return true; |
|
75 | + } |
|
76 | 76 | |
77 | - foreach ($this->cachedData as $key => $value) { |
|
78 | - if (strpos($key, $prefix) === 0) { |
|
79 | - $this->remove($key); |
|
80 | - } |
|
81 | - } |
|
82 | - return true; |
|
83 | - } |
|
77 | + foreach ($this->cachedData as $key => $value) { |
|
78 | + if (strpos($key, $prefix) === 0) { |
|
79 | + $this->remove($key); |
|
80 | + } |
|
81 | + } |
|
82 | + return true; |
|
83 | + } |
|
84 | 84 | |
85 | - /** |
|
86 | - * Set a value in the cache if it's not already stored |
|
87 | - * |
|
88 | - * @param string $key |
|
89 | - * @param mixed $value |
|
90 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
91 | - * @return bool |
|
92 | - */ |
|
93 | - public function add($key, $value, $ttl = 0) { |
|
94 | - // since this cache is not shared race conditions aren't an issue |
|
95 | - if ($this->hasKey($key)) { |
|
96 | - return false; |
|
97 | - } else { |
|
98 | - return $this->set($key, $value, $ttl); |
|
99 | - } |
|
100 | - } |
|
85 | + /** |
|
86 | + * Set a value in the cache if it's not already stored |
|
87 | + * |
|
88 | + * @param string $key |
|
89 | + * @param mixed $value |
|
90 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
91 | + * @return bool |
|
92 | + */ |
|
93 | + public function add($key, $value, $ttl = 0) { |
|
94 | + // since this cache is not shared race conditions aren't an issue |
|
95 | + if ($this->hasKey($key)) { |
|
96 | + return false; |
|
97 | + } else { |
|
98 | + return $this->set($key, $value, $ttl); |
|
99 | + } |
|
100 | + } |
|
101 | 101 | |
102 | - /** |
|
103 | - * Increase a stored number |
|
104 | - * |
|
105 | - * @param string $key |
|
106 | - * @param int $step |
|
107 | - * @return int | bool |
|
108 | - */ |
|
109 | - public function inc($key, $step = 1) { |
|
110 | - $oldValue = $this->get($key); |
|
111 | - if (is_int($oldValue)) { |
|
112 | - $this->set($key, $oldValue + $step); |
|
113 | - return $oldValue + $step; |
|
114 | - } else { |
|
115 | - $success = $this->add($key, $step); |
|
116 | - return ($success) ? $step : false; |
|
117 | - } |
|
118 | - } |
|
102 | + /** |
|
103 | + * Increase a stored number |
|
104 | + * |
|
105 | + * @param string $key |
|
106 | + * @param int $step |
|
107 | + * @return int | bool |
|
108 | + */ |
|
109 | + public function inc($key, $step = 1) { |
|
110 | + $oldValue = $this->get($key); |
|
111 | + if (is_int($oldValue)) { |
|
112 | + $this->set($key, $oldValue + $step); |
|
113 | + return $oldValue + $step; |
|
114 | + } else { |
|
115 | + $success = $this->add($key, $step); |
|
116 | + return ($success) ? $step : false; |
|
117 | + } |
|
118 | + } |
|
119 | 119 | |
120 | - /** |
|
121 | - * Decrease a stored number |
|
122 | - * |
|
123 | - * @param string $key |
|
124 | - * @param int $step |
|
125 | - * @return int | bool |
|
126 | - */ |
|
127 | - public function dec($key, $step = 1) { |
|
128 | - $oldValue = $this->get($key); |
|
129 | - if (is_int($oldValue)) { |
|
130 | - $this->set($key, $oldValue - $step); |
|
131 | - return $oldValue - $step; |
|
132 | - } else { |
|
133 | - return false; |
|
134 | - } |
|
135 | - } |
|
120 | + /** |
|
121 | + * Decrease a stored number |
|
122 | + * |
|
123 | + * @param string $key |
|
124 | + * @param int $step |
|
125 | + * @return int | bool |
|
126 | + */ |
|
127 | + public function dec($key, $step = 1) { |
|
128 | + $oldValue = $this->get($key); |
|
129 | + if (is_int($oldValue)) { |
|
130 | + $this->set($key, $oldValue - $step); |
|
131 | + return $oldValue - $step; |
|
132 | + } else { |
|
133 | + return false; |
|
134 | + } |
|
135 | + } |
|
136 | 136 | |
137 | - /** |
|
138 | - * Compare and set |
|
139 | - * |
|
140 | - * @param string $key |
|
141 | - * @param mixed $old |
|
142 | - * @param mixed $new |
|
143 | - * @return bool |
|
144 | - */ |
|
145 | - public function cas($key, $old, $new) { |
|
146 | - if ($this->get($key) === $old) { |
|
147 | - return $this->set($key, $new); |
|
148 | - } else { |
|
149 | - return false; |
|
150 | - } |
|
151 | - } |
|
137 | + /** |
|
138 | + * Compare and set |
|
139 | + * |
|
140 | + * @param string $key |
|
141 | + * @param mixed $old |
|
142 | + * @param mixed $new |
|
143 | + * @return bool |
|
144 | + */ |
|
145 | + public function cas($key, $old, $new) { |
|
146 | + if ($this->get($key) === $old) { |
|
147 | + return $this->set($key, $new); |
|
148 | + } else { |
|
149 | + return false; |
|
150 | + } |
|
151 | + } |
|
152 | 152 | |
153 | - /** |
|
154 | - * {@inheritDoc} |
|
155 | - */ |
|
156 | - static public function isAvailable() { |
|
157 | - return true; |
|
158 | - } |
|
153 | + /** |
|
154 | + * {@inheritDoc} |
|
155 | + */ |
|
156 | + static public function isAvailable() { |
|
157 | + return true; |
|
158 | + } |
|
159 | 159 | } |
@@ -498,6 +498,9 @@ |
||
498 | 498 | }); |
499 | 499 | } |
500 | 500 | |
501 | + /** |
|
502 | + * @param string $path |
|
503 | + */ |
|
501 | 504 | public function notify($path) { |
502 | 505 | $path = '/' . ltrim($path, '/'); |
503 | 506 | $shareNotifyHandler = $this->share->notify($this->buildPath($path)); |
@@ -51,475 +51,475 @@ |
||
51 | 51 | use OCP\Files\StorageNotAvailableException; |
52 | 52 | |
53 | 53 | class SMB extends Common implements INotifyStorage { |
54 | - /** |
|
55 | - * @var \Icewind\SMB\Server |
|
56 | - */ |
|
57 | - protected $server; |
|
58 | - |
|
59 | - /** |
|
60 | - * @var \Icewind\SMB\Share |
|
61 | - */ |
|
62 | - protected $share; |
|
63 | - |
|
64 | - /** |
|
65 | - * @var string |
|
66 | - */ |
|
67 | - protected $root; |
|
68 | - |
|
69 | - /** |
|
70 | - * @var \Icewind\SMB\FileInfo[] |
|
71 | - */ |
|
72 | - protected $statCache; |
|
73 | - |
|
74 | - public function __construct($params) { |
|
75 | - if (isset($params['host']) && isset($params['user']) && isset($params['password']) && isset($params['share'])) { |
|
76 | - if (Server::NativeAvailable()) { |
|
77 | - $this->server = new NativeServer($params['host'], $params['user'], $params['password']); |
|
78 | - } else { |
|
79 | - $this->server = new Server($params['host'], $params['user'], $params['password']); |
|
80 | - } |
|
81 | - $this->share = $this->server->getShare(trim($params['share'], '/')); |
|
82 | - |
|
83 | - $this->root = isset($params['root']) ? $params['root'] : '/'; |
|
84 | - if (!$this->root || $this->root[0] !== '/') { |
|
85 | - $this->root = '/' . $this->root; |
|
86 | - } |
|
87 | - if (substr($this->root, -1, 1) !== '/') { |
|
88 | - $this->root .= '/'; |
|
89 | - } |
|
90 | - } else { |
|
91 | - throw new \Exception('Invalid configuration'); |
|
92 | - } |
|
93 | - $this->statCache = new CappedMemoryCache(); |
|
94 | - parent::__construct($params); |
|
95 | - } |
|
96 | - |
|
97 | - /** |
|
98 | - * @return string |
|
99 | - */ |
|
100 | - public function getId() { |
|
101 | - // FIXME: double slash to keep compatible with the old storage ids, |
|
102 | - // failure to do so will lead to creation of a new storage id and |
|
103 | - // loss of shares from the storage |
|
104 | - return 'smb::' . $this->server->getUser() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root; |
|
105 | - } |
|
106 | - |
|
107 | - /** |
|
108 | - * @param string $path |
|
109 | - * @return string |
|
110 | - */ |
|
111 | - protected function buildPath($path) { |
|
112 | - return Filesystem::normalizePath($this->root . '/' . $path, true, false, true); |
|
113 | - } |
|
114 | - |
|
115 | - protected function relativePath($fullPath) { |
|
116 | - if ($fullPath === $this->root) { |
|
117 | - return ''; |
|
118 | - } else if (substr($fullPath, 0, strlen($this->root)) === $this->root) { |
|
119 | - return substr($fullPath, strlen($this->root)); |
|
120 | - } else { |
|
121 | - return null; |
|
122 | - } |
|
123 | - } |
|
124 | - |
|
125 | - /** |
|
126 | - * @param string $path |
|
127 | - * @return \Icewind\SMB\IFileInfo |
|
128 | - * @throws StorageNotAvailableException |
|
129 | - */ |
|
130 | - protected function getFileInfo($path) { |
|
131 | - try { |
|
132 | - $path = $this->buildPath($path); |
|
133 | - if (!isset($this->statCache[$path])) { |
|
134 | - $this->statCache[$path] = $this->share->stat($path); |
|
135 | - } |
|
136 | - return $this->statCache[$path]; |
|
137 | - } catch (ConnectException $e) { |
|
138 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
139 | - } |
|
140 | - } |
|
141 | - |
|
142 | - /** |
|
143 | - * @param string $path |
|
144 | - * @return \Icewind\SMB\IFileInfo[] |
|
145 | - * @throws StorageNotAvailableException |
|
146 | - */ |
|
147 | - protected function getFolderContents($path) { |
|
148 | - try { |
|
149 | - $path = $this->buildPath($path); |
|
150 | - $files = $this->share->dir($path); |
|
151 | - foreach ($files as $file) { |
|
152 | - $this->statCache[$path . '/' . $file->getName()] = $file; |
|
153 | - } |
|
154 | - return array_filter($files, function (IFileInfo $file) { |
|
155 | - return !$file->isHidden(); |
|
156 | - }); |
|
157 | - } catch (ConnectException $e) { |
|
158 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
159 | - } |
|
160 | - } |
|
161 | - |
|
162 | - /** |
|
163 | - * @param \Icewind\SMB\IFileInfo $info |
|
164 | - * @return array |
|
165 | - */ |
|
166 | - protected function formatInfo($info) { |
|
167 | - $result = [ |
|
168 | - 'size' => $info->getSize(), |
|
169 | - 'mtime' => $info->getMTime(), |
|
170 | - ]; |
|
171 | - if ($info->isDirectory()) { |
|
172 | - $result['type'] = 'dir'; |
|
173 | - } else { |
|
174 | - $result['type'] = 'file'; |
|
175 | - } |
|
176 | - return $result; |
|
177 | - } |
|
178 | - |
|
179 | - /** |
|
180 | - * Rename the files. If the source or the target is the root, the rename won't happen. |
|
181 | - * |
|
182 | - * @param string $source the old name of the path |
|
183 | - * @param string $target the new name of the path |
|
184 | - * @return bool true if the rename is successful, false otherwise |
|
185 | - */ |
|
186 | - public function rename($source, $target) { |
|
187 | - if ($this->isRootDir($source) || $this->isRootDir($target)) { |
|
188 | - return false; |
|
189 | - } |
|
190 | - |
|
191 | - $absoluteSource = $this->buildPath($source); |
|
192 | - $absoluteTarget = $this->buildPath($target); |
|
193 | - try { |
|
194 | - $result = $this->share->rename($absoluteSource, $absoluteTarget); |
|
195 | - } catch (AlreadyExistsException $e) { |
|
196 | - $this->remove($target); |
|
197 | - $result = $this->share->rename($absoluteSource, $absoluteTarget); |
|
198 | - } catch (\Exception $e) { |
|
199 | - return false; |
|
200 | - } |
|
201 | - unset($this->statCache[$absoluteSource], $this->statCache[$absoluteTarget]); |
|
202 | - return $result; |
|
203 | - } |
|
204 | - |
|
205 | - /** |
|
206 | - * @param string $path |
|
207 | - * @return array |
|
208 | - */ |
|
209 | - public function stat($path) { |
|
210 | - $result = $this->formatInfo($this->getFileInfo($path)); |
|
211 | - if ($this->remoteIsShare() && $this->isRootDir($path)) { |
|
212 | - $result['mtime'] = $this->shareMTime(); |
|
213 | - } |
|
214 | - return $result; |
|
215 | - } |
|
216 | - |
|
217 | - /** |
|
218 | - * get the best guess for the modification time of the share |
|
219 | - * |
|
220 | - * @return int |
|
221 | - */ |
|
222 | - private function shareMTime() { |
|
223 | - $highestMTime = 0; |
|
224 | - $files = $this->share->dir($this->root); |
|
225 | - foreach ($files as $fileInfo) { |
|
226 | - if ($fileInfo->getMTime() > $highestMTime) { |
|
227 | - $highestMTime = $fileInfo->getMTime(); |
|
228 | - } |
|
229 | - } |
|
230 | - return $highestMTime; |
|
231 | - } |
|
232 | - |
|
233 | - /** |
|
234 | - * Check if the path is our root dir (not the smb one) |
|
235 | - * |
|
236 | - * @param string $path the path |
|
237 | - * @return bool |
|
238 | - */ |
|
239 | - private function isRootDir($path) { |
|
240 | - return $path === '' || $path === '/' || $path === '.'; |
|
241 | - } |
|
242 | - |
|
243 | - /** |
|
244 | - * Check if our root points to a smb share |
|
245 | - * |
|
246 | - * @return bool true if our root points to a share false otherwise |
|
247 | - */ |
|
248 | - private function remoteIsShare() { |
|
249 | - return $this->share->getName() && (!$this->root || $this->root === '/'); |
|
250 | - } |
|
251 | - |
|
252 | - /** |
|
253 | - * @param string $path |
|
254 | - * @return bool |
|
255 | - */ |
|
256 | - public function unlink($path) { |
|
257 | - if ($this->isRootDir($path)) { |
|
258 | - return false; |
|
259 | - } |
|
260 | - |
|
261 | - try { |
|
262 | - if ($this->is_dir($path)) { |
|
263 | - return $this->rmdir($path); |
|
264 | - } else { |
|
265 | - $path = $this->buildPath($path); |
|
266 | - unset($this->statCache[$path]); |
|
267 | - $this->share->del($path); |
|
268 | - return true; |
|
269 | - } |
|
270 | - } catch (NotFoundException $e) { |
|
271 | - return false; |
|
272 | - } catch (ForbiddenException $e) { |
|
273 | - return false; |
|
274 | - } catch (ConnectException $e) { |
|
275 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
276 | - } |
|
277 | - } |
|
278 | - |
|
279 | - /** |
|
280 | - * check if a file or folder has been updated since $time |
|
281 | - * |
|
282 | - * @param string $path |
|
283 | - * @param int $time |
|
284 | - * @return bool |
|
285 | - */ |
|
286 | - public function hasUpdated($path, $time) { |
|
287 | - if (!$path and $this->root === '/') { |
|
288 | - // mtime doesn't work for shares, but giving the nature of the backend, |
|
289 | - // doing a full update is still just fast enough |
|
290 | - return true; |
|
291 | - } else { |
|
292 | - $actualTime = $this->filemtime($path); |
|
293 | - return $actualTime > $time; |
|
294 | - } |
|
295 | - } |
|
296 | - |
|
297 | - /** |
|
298 | - * @param string $path |
|
299 | - * @param string $mode |
|
300 | - * @return resource|false |
|
301 | - */ |
|
302 | - public function fopen($path, $mode) { |
|
303 | - $fullPath = $this->buildPath($path); |
|
304 | - try { |
|
305 | - switch ($mode) { |
|
306 | - case 'r': |
|
307 | - case 'rb': |
|
308 | - if (!$this->file_exists($path)) { |
|
309 | - return false; |
|
310 | - } |
|
311 | - return $this->share->read($fullPath); |
|
312 | - case 'w': |
|
313 | - case 'wb': |
|
314 | - $source = $this->share->write($fullPath); |
|
315 | - return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) { |
|
316 | - unset($this->statCache[$fullPath]); |
|
317 | - }); |
|
318 | - case 'a': |
|
319 | - case 'ab': |
|
320 | - case 'r+': |
|
321 | - case 'w+': |
|
322 | - case 'wb+': |
|
323 | - case 'a+': |
|
324 | - case 'x': |
|
325 | - case 'x+': |
|
326 | - case 'c': |
|
327 | - case 'c+': |
|
328 | - //emulate these |
|
329 | - if (strrpos($path, '.') !== false) { |
|
330 | - $ext = substr($path, strrpos($path, '.')); |
|
331 | - } else { |
|
332 | - $ext = ''; |
|
333 | - } |
|
334 | - if ($this->file_exists($path)) { |
|
335 | - if (!$this->isUpdatable($path)) { |
|
336 | - return false; |
|
337 | - } |
|
338 | - $tmpFile = $this->getCachedFile($path); |
|
339 | - } else { |
|
340 | - if (!$this->isCreatable(dirname($path))) { |
|
341 | - return false; |
|
342 | - } |
|
343 | - $tmpFile = \OCP\Files::tmpFile($ext); |
|
344 | - } |
|
345 | - $source = fopen($tmpFile, $mode); |
|
346 | - $share = $this->share; |
|
347 | - return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) { |
|
348 | - unset($this->statCache[$fullPath]); |
|
349 | - $share->put($tmpFile, $fullPath); |
|
350 | - unlink($tmpFile); |
|
351 | - }); |
|
352 | - } |
|
353 | - return false; |
|
354 | - } catch (NotFoundException $e) { |
|
355 | - return false; |
|
356 | - } catch (ForbiddenException $e) { |
|
357 | - return false; |
|
358 | - } catch (ConnectException $e) { |
|
359 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
360 | - } |
|
361 | - } |
|
362 | - |
|
363 | - public function rmdir($path) { |
|
364 | - if ($this->isRootDir($path)) { |
|
365 | - return false; |
|
366 | - } |
|
367 | - |
|
368 | - try { |
|
369 | - $this->statCache = array(); |
|
370 | - $content = $this->share->dir($this->buildPath($path)); |
|
371 | - foreach ($content as $file) { |
|
372 | - if ($file->isDirectory()) { |
|
373 | - $this->rmdir($path . '/' . $file->getName()); |
|
374 | - } else { |
|
375 | - $this->share->del($file->getPath()); |
|
376 | - } |
|
377 | - } |
|
378 | - $this->share->rmdir($this->buildPath($path)); |
|
379 | - return true; |
|
380 | - } catch (NotFoundException $e) { |
|
381 | - return false; |
|
382 | - } catch (ForbiddenException $e) { |
|
383 | - return false; |
|
384 | - } catch (ConnectException $e) { |
|
385 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
386 | - } |
|
387 | - } |
|
388 | - |
|
389 | - public function touch($path, $time = null) { |
|
390 | - try { |
|
391 | - if (!$this->file_exists($path)) { |
|
392 | - $fh = $this->share->write($this->buildPath($path)); |
|
393 | - fclose($fh); |
|
394 | - return true; |
|
395 | - } |
|
396 | - return false; |
|
397 | - } catch (ConnectException $e) { |
|
398 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
399 | - } |
|
400 | - } |
|
401 | - |
|
402 | - public function opendir($path) { |
|
403 | - try { |
|
404 | - $files = $this->getFolderContents($path); |
|
405 | - } catch (NotFoundException $e) { |
|
406 | - return false; |
|
407 | - } catch (ForbiddenException $e) { |
|
408 | - return false; |
|
409 | - } |
|
410 | - $names = array_map(function ($info) { |
|
411 | - /** @var \Icewind\SMB\IFileInfo $info */ |
|
412 | - return $info->getName(); |
|
413 | - }, $files); |
|
414 | - return IteratorDirectory::wrap($names); |
|
415 | - } |
|
416 | - |
|
417 | - public function filetype($path) { |
|
418 | - try { |
|
419 | - return $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file'; |
|
420 | - } catch (NotFoundException $e) { |
|
421 | - return false; |
|
422 | - } catch (ForbiddenException $e) { |
|
423 | - return false; |
|
424 | - } |
|
425 | - } |
|
426 | - |
|
427 | - public function mkdir($path) { |
|
428 | - $path = $this->buildPath($path); |
|
429 | - try { |
|
430 | - $this->share->mkdir($path); |
|
431 | - return true; |
|
432 | - } catch (ConnectException $e) { |
|
433 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
434 | - } catch (Exception $e) { |
|
435 | - return false; |
|
436 | - } |
|
437 | - } |
|
438 | - |
|
439 | - public function file_exists($path) { |
|
440 | - try { |
|
441 | - $this->getFileInfo($path); |
|
442 | - return true; |
|
443 | - } catch (NotFoundException $e) { |
|
444 | - return false; |
|
445 | - } catch (ForbiddenException $e) { |
|
446 | - return false; |
|
447 | - } catch (ConnectException $e) { |
|
448 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
449 | - } |
|
450 | - } |
|
451 | - |
|
452 | - public function isReadable($path) { |
|
453 | - try { |
|
454 | - $info = $this->getFileInfo($path); |
|
455 | - return !$info->isHidden(); |
|
456 | - } catch (NotFoundException $e) { |
|
457 | - return false; |
|
458 | - } catch (ForbiddenException $e) { |
|
459 | - return false; |
|
460 | - } |
|
461 | - } |
|
462 | - |
|
463 | - public function isUpdatable($path) { |
|
464 | - try { |
|
465 | - $info = $this->getFileInfo($path); |
|
466 | - // following windows behaviour for read-only folders: they can be written into |
|
467 | - // (https://support.microsoft.com/en-us/kb/326549 - "cause" section) |
|
468 | - return !$info->isHidden() && (!$info->isReadOnly() || $this->is_dir($path)); |
|
469 | - } catch (NotFoundException $e) { |
|
470 | - return false; |
|
471 | - } catch (ForbiddenException $e) { |
|
472 | - return false; |
|
473 | - } |
|
474 | - } |
|
475 | - |
|
476 | - public function isDeletable($path) { |
|
477 | - try { |
|
478 | - $info = $this->getFileInfo($path); |
|
479 | - return !$info->isHidden() && !$info->isReadOnly(); |
|
480 | - } catch (NotFoundException $e) { |
|
481 | - return false; |
|
482 | - } catch (ForbiddenException $e) { |
|
483 | - return false; |
|
484 | - } |
|
485 | - } |
|
486 | - |
|
487 | - /** |
|
488 | - * check if smbclient is installed |
|
489 | - */ |
|
490 | - public static function checkDependencies() { |
|
491 | - return ( |
|
492 | - (bool)\OC_Helper::findBinaryPath('smbclient') |
|
493 | - || Server::NativeAvailable() |
|
494 | - ) ? true : ['smbclient']; |
|
495 | - } |
|
496 | - |
|
497 | - /** |
|
498 | - * Test a storage for availability |
|
499 | - * |
|
500 | - * @return bool |
|
501 | - */ |
|
502 | - public function test() { |
|
503 | - try { |
|
504 | - return parent::test(); |
|
505 | - } catch (Exception $e) { |
|
506 | - return false; |
|
507 | - } |
|
508 | - } |
|
509 | - |
|
510 | - public function listen($path, callable $callback) { |
|
511 | - $this->notify($path)->listen(function (IChange $change) use ($callback) { |
|
512 | - if ($change instanceof IRenameChange) { |
|
513 | - return $callback($change->getType(), $change->getPath(), $change->getTargetPath()); |
|
514 | - } else { |
|
515 | - return $callback($change->getType(), $change->getPath()); |
|
516 | - } |
|
517 | - }); |
|
518 | - } |
|
519 | - |
|
520 | - public function notify($path) { |
|
521 | - $path = '/' . ltrim($path, '/'); |
|
522 | - $shareNotifyHandler = $this->share->notify($this->buildPath($path)); |
|
523 | - return new SMBNotifyHandler($shareNotifyHandler, $this->root); |
|
524 | - } |
|
54 | + /** |
|
55 | + * @var \Icewind\SMB\Server |
|
56 | + */ |
|
57 | + protected $server; |
|
58 | + |
|
59 | + /** |
|
60 | + * @var \Icewind\SMB\Share |
|
61 | + */ |
|
62 | + protected $share; |
|
63 | + |
|
64 | + /** |
|
65 | + * @var string |
|
66 | + */ |
|
67 | + protected $root; |
|
68 | + |
|
69 | + /** |
|
70 | + * @var \Icewind\SMB\FileInfo[] |
|
71 | + */ |
|
72 | + protected $statCache; |
|
73 | + |
|
74 | + public function __construct($params) { |
|
75 | + if (isset($params['host']) && isset($params['user']) && isset($params['password']) && isset($params['share'])) { |
|
76 | + if (Server::NativeAvailable()) { |
|
77 | + $this->server = new NativeServer($params['host'], $params['user'], $params['password']); |
|
78 | + } else { |
|
79 | + $this->server = new Server($params['host'], $params['user'], $params['password']); |
|
80 | + } |
|
81 | + $this->share = $this->server->getShare(trim($params['share'], '/')); |
|
82 | + |
|
83 | + $this->root = isset($params['root']) ? $params['root'] : '/'; |
|
84 | + if (!$this->root || $this->root[0] !== '/') { |
|
85 | + $this->root = '/' . $this->root; |
|
86 | + } |
|
87 | + if (substr($this->root, -1, 1) !== '/') { |
|
88 | + $this->root .= '/'; |
|
89 | + } |
|
90 | + } else { |
|
91 | + throw new \Exception('Invalid configuration'); |
|
92 | + } |
|
93 | + $this->statCache = new CappedMemoryCache(); |
|
94 | + parent::__construct($params); |
|
95 | + } |
|
96 | + |
|
97 | + /** |
|
98 | + * @return string |
|
99 | + */ |
|
100 | + public function getId() { |
|
101 | + // FIXME: double slash to keep compatible with the old storage ids, |
|
102 | + // failure to do so will lead to creation of a new storage id and |
|
103 | + // loss of shares from the storage |
|
104 | + return 'smb::' . $this->server->getUser() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root; |
|
105 | + } |
|
106 | + |
|
107 | + /** |
|
108 | + * @param string $path |
|
109 | + * @return string |
|
110 | + */ |
|
111 | + protected function buildPath($path) { |
|
112 | + return Filesystem::normalizePath($this->root . '/' . $path, true, false, true); |
|
113 | + } |
|
114 | + |
|
115 | + protected function relativePath($fullPath) { |
|
116 | + if ($fullPath === $this->root) { |
|
117 | + return ''; |
|
118 | + } else if (substr($fullPath, 0, strlen($this->root)) === $this->root) { |
|
119 | + return substr($fullPath, strlen($this->root)); |
|
120 | + } else { |
|
121 | + return null; |
|
122 | + } |
|
123 | + } |
|
124 | + |
|
125 | + /** |
|
126 | + * @param string $path |
|
127 | + * @return \Icewind\SMB\IFileInfo |
|
128 | + * @throws StorageNotAvailableException |
|
129 | + */ |
|
130 | + protected function getFileInfo($path) { |
|
131 | + try { |
|
132 | + $path = $this->buildPath($path); |
|
133 | + if (!isset($this->statCache[$path])) { |
|
134 | + $this->statCache[$path] = $this->share->stat($path); |
|
135 | + } |
|
136 | + return $this->statCache[$path]; |
|
137 | + } catch (ConnectException $e) { |
|
138 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
139 | + } |
|
140 | + } |
|
141 | + |
|
142 | + /** |
|
143 | + * @param string $path |
|
144 | + * @return \Icewind\SMB\IFileInfo[] |
|
145 | + * @throws StorageNotAvailableException |
|
146 | + */ |
|
147 | + protected function getFolderContents($path) { |
|
148 | + try { |
|
149 | + $path = $this->buildPath($path); |
|
150 | + $files = $this->share->dir($path); |
|
151 | + foreach ($files as $file) { |
|
152 | + $this->statCache[$path . '/' . $file->getName()] = $file; |
|
153 | + } |
|
154 | + return array_filter($files, function (IFileInfo $file) { |
|
155 | + return !$file->isHidden(); |
|
156 | + }); |
|
157 | + } catch (ConnectException $e) { |
|
158 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
159 | + } |
|
160 | + } |
|
161 | + |
|
162 | + /** |
|
163 | + * @param \Icewind\SMB\IFileInfo $info |
|
164 | + * @return array |
|
165 | + */ |
|
166 | + protected function formatInfo($info) { |
|
167 | + $result = [ |
|
168 | + 'size' => $info->getSize(), |
|
169 | + 'mtime' => $info->getMTime(), |
|
170 | + ]; |
|
171 | + if ($info->isDirectory()) { |
|
172 | + $result['type'] = 'dir'; |
|
173 | + } else { |
|
174 | + $result['type'] = 'file'; |
|
175 | + } |
|
176 | + return $result; |
|
177 | + } |
|
178 | + |
|
179 | + /** |
|
180 | + * Rename the files. If the source or the target is the root, the rename won't happen. |
|
181 | + * |
|
182 | + * @param string $source the old name of the path |
|
183 | + * @param string $target the new name of the path |
|
184 | + * @return bool true if the rename is successful, false otherwise |
|
185 | + */ |
|
186 | + public function rename($source, $target) { |
|
187 | + if ($this->isRootDir($source) || $this->isRootDir($target)) { |
|
188 | + return false; |
|
189 | + } |
|
190 | + |
|
191 | + $absoluteSource = $this->buildPath($source); |
|
192 | + $absoluteTarget = $this->buildPath($target); |
|
193 | + try { |
|
194 | + $result = $this->share->rename($absoluteSource, $absoluteTarget); |
|
195 | + } catch (AlreadyExistsException $e) { |
|
196 | + $this->remove($target); |
|
197 | + $result = $this->share->rename($absoluteSource, $absoluteTarget); |
|
198 | + } catch (\Exception $e) { |
|
199 | + return false; |
|
200 | + } |
|
201 | + unset($this->statCache[$absoluteSource], $this->statCache[$absoluteTarget]); |
|
202 | + return $result; |
|
203 | + } |
|
204 | + |
|
205 | + /** |
|
206 | + * @param string $path |
|
207 | + * @return array |
|
208 | + */ |
|
209 | + public function stat($path) { |
|
210 | + $result = $this->formatInfo($this->getFileInfo($path)); |
|
211 | + if ($this->remoteIsShare() && $this->isRootDir($path)) { |
|
212 | + $result['mtime'] = $this->shareMTime(); |
|
213 | + } |
|
214 | + return $result; |
|
215 | + } |
|
216 | + |
|
217 | + /** |
|
218 | + * get the best guess for the modification time of the share |
|
219 | + * |
|
220 | + * @return int |
|
221 | + */ |
|
222 | + private function shareMTime() { |
|
223 | + $highestMTime = 0; |
|
224 | + $files = $this->share->dir($this->root); |
|
225 | + foreach ($files as $fileInfo) { |
|
226 | + if ($fileInfo->getMTime() > $highestMTime) { |
|
227 | + $highestMTime = $fileInfo->getMTime(); |
|
228 | + } |
|
229 | + } |
|
230 | + return $highestMTime; |
|
231 | + } |
|
232 | + |
|
233 | + /** |
|
234 | + * Check if the path is our root dir (not the smb one) |
|
235 | + * |
|
236 | + * @param string $path the path |
|
237 | + * @return bool |
|
238 | + */ |
|
239 | + private function isRootDir($path) { |
|
240 | + return $path === '' || $path === '/' || $path === '.'; |
|
241 | + } |
|
242 | + |
|
243 | + /** |
|
244 | + * Check if our root points to a smb share |
|
245 | + * |
|
246 | + * @return bool true if our root points to a share false otherwise |
|
247 | + */ |
|
248 | + private function remoteIsShare() { |
|
249 | + return $this->share->getName() && (!$this->root || $this->root === '/'); |
|
250 | + } |
|
251 | + |
|
252 | + /** |
|
253 | + * @param string $path |
|
254 | + * @return bool |
|
255 | + */ |
|
256 | + public function unlink($path) { |
|
257 | + if ($this->isRootDir($path)) { |
|
258 | + return false; |
|
259 | + } |
|
260 | + |
|
261 | + try { |
|
262 | + if ($this->is_dir($path)) { |
|
263 | + return $this->rmdir($path); |
|
264 | + } else { |
|
265 | + $path = $this->buildPath($path); |
|
266 | + unset($this->statCache[$path]); |
|
267 | + $this->share->del($path); |
|
268 | + return true; |
|
269 | + } |
|
270 | + } catch (NotFoundException $e) { |
|
271 | + return false; |
|
272 | + } catch (ForbiddenException $e) { |
|
273 | + return false; |
|
274 | + } catch (ConnectException $e) { |
|
275 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
276 | + } |
|
277 | + } |
|
278 | + |
|
279 | + /** |
|
280 | + * check if a file or folder has been updated since $time |
|
281 | + * |
|
282 | + * @param string $path |
|
283 | + * @param int $time |
|
284 | + * @return bool |
|
285 | + */ |
|
286 | + public function hasUpdated($path, $time) { |
|
287 | + if (!$path and $this->root === '/') { |
|
288 | + // mtime doesn't work for shares, but giving the nature of the backend, |
|
289 | + // doing a full update is still just fast enough |
|
290 | + return true; |
|
291 | + } else { |
|
292 | + $actualTime = $this->filemtime($path); |
|
293 | + return $actualTime > $time; |
|
294 | + } |
|
295 | + } |
|
296 | + |
|
297 | + /** |
|
298 | + * @param string $path |
|
299 | + * @param string $mode |
|
300 | + * @return resource|false |
|
301 | + */ |
|
302 | + public function fopen($path, $mode) { |
|
303 | + $fullPath = $this->buildPath($path); |
|
304 | + try { |
|
305 | + switch ($mode) { |
|
306 | + case 'r': |
|
307 | + case 'rb': |
|
308 | + if (!$this->file_exists($path)) { |
|
309 | + return false; |
|
310 | + } |
|
311 | + return $this->share->read($fullPath); |
|
312 | + case 'w': |
|
313 | + case 'wb': |
|
314 | + $source = $this->share->write($fullPath); |
|
315 | + return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) { |
|
316 | + unset($this->statCache[$fullPath]); |
|
317 | + }); |
|
318 | + case 'a': |
|
319 | + case 'ab': |
|
320 | + case 'r+': |
|
321 | + case 'w+': |
|
322 | + case 'wb+': |
|
323 | + case 'a+': |
|
324 | + case 'x': |
|
325 | + case 'x+': |
|
326 | + case 'c': |
|
327 | + case 'c+': |
|
328 | + //emulate these |
|
329 | + if (strrpos($path, '.') !== false) { |
|
330 | + $ext = substr($path, strrpos($path, '.')); |
|
331 | + } else { |
|
332 | + $ext = ''; |
|
333 | + } |
|
334 | + if ($this->file_exists($path)) { |
|
335 | + if (!$this->isUpdatable($path)) { |
|
336 | + return false; |
|
337 | + } |
|
338 | + $tmpFile = $this->getCachedFile($path); |
|
339 | + } else { |
|
340 | + if (!$this->isCreatable(dirname($path))) { |
|
341 | + return false; |
|
342 | + } |
|
343 | + $tmpFile = \OCP\Files::tmpFile($ext); |
|
344 | + } |
|
345 | + $source = fopen($tmpFile, $mode); |
|
346 | + $share = $this->share; |
|
347 | + return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) { |
|
348 | + unset($this->statCache[$fullPath]); |
|
349 | + $share->put($tmpFile, $fullPath); |
|
350 | + unlink($tmpFile); |
|
351 | + }); |
|
352 | + } |
|
353 | + return false; |
|
354 | + } catch (NotFoundException $e) { |
|
355 | + return false; |
|
356 | + } catch (ForbiddenException $e) { |
|
357 | + return false; |
|
358 | + } catch (ConnectException $e) { |
|
359 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
360 | + } |
|
361 | + } |
|
362 | + |
|
363 | + public function rmdir($path) { |
|
364 | + if ($this->isRootDir($path)) { |
|
365 | + return false; |
|
366 | + } |
|
367 | + |
|
368 | + try { |
|
369 | + $this->statCache = array(); |
|
370 | + $content = $this->share->dir($this->buildPath($path)); |
|
371 | + foreach ($content as $file) { |
|
372 | + if ($file->isDirectory()) { |
|
373 | + $this->rmdir($path . '/' . $file->getName()); |
|
374 | + } else { |
|
375 | + $this->share->del($file->getPath()); |
|
376 | + } |
|
377 | + } |
|
378 | + $this->share->rmdir($this->buildPath($path)); |
|
379 | + return true; |
|
380 | + } catch (NotFoundException $e) { |
|
381 | + return false; |
|
382 | + } catch (ForbiddenException $e) { |
|
383 | + return false; |
|
384 | + } catch (ConnectException $e) { |
|
385 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
386 | + } |
|
387 | + } |
|
388 | + |
|
389 | + public function touch($path, $time = null) { |
|
390 | + try { |
|
391 | + if (!$this->file_exists($path)) { |
|
392 | + $fh = $this->share->write($this->buildPath($path)); |
|
393 | + fclose($fh); |
|
394 | + return true; |
|
395 | + } |
|
396 | + return false; |
|
397 | + } catch (ConnectException $e) { |
|
398 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
399 | + } |
|
400 | + } |
|
401 | + |
|
402 | + public function opendir($path) { |
|
403 | + try { |
|
404 | + $files = $this->getFolderContents($path); |
|
405 | + } catch (NotFoundException $e) { |
|
406 | + return false; |
|
407 | + } catch (ForbiddenException $e) { |
|
408 | + return false; |
|
409 | + } |
|
410 | + $names = array_map(function ($info) { |
|
411 | + /** @var \Icewind\SMB\IFileInfo $info */ |
|
412 | + return $info->getName(); |
|
413 | + }, $files); |
|
414 | + return IteratorDirectory::wrap($names); |
|
415 | + } |
|
416 | + |
|
417 | + public function filetype($path) { |
|
418 | + try { |
|
419 | + return $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file'; |
|
420 | + } catch (NotFoundException $e) { |
|
421 | + return false; |
|
422 | + } catch (ForbiddenException $e) { |
|
423 | + return false; |
|
424 | + } |
|
425 | + } |
|
426 | + |
|
427 | + public function mkdir($path) { |
|
428 | + $path = $this->buildPath($path); |
|
429 | + try { |
|
430 | + $this->share->mkdir($path); |
|
431 | + return true; |
|
432 | + } catch (ConnectException $e) { |
|
433 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
434 | + } catch (Exception $e) { |
|
435 | + return false; |
|
436 | + } |
|
437 | + } |
|
438 | + |
|
439 | + public function file_exists($path) { |
|
440 | + try { |
|
441 | + $this->getFileInfo($path); |
|
442 | + return true; |
|
443 | + } catch (NotFoundException $e) { |
|
444 | + return false; |
|
445 | + } catch (ForbiddenException $e) { |
|
446 | + return false; |
|
447 | + } catch (ConnectException $e) { |
|
448 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
449 | + } |
|
450 | + } |
|
451 | + |
|
452 | + public function isReadable($path) { |
|
453 | + try { |
|
454 | + $info = $this->getFileInfo($path); |
|
455 | + return !$info->isHidden(); |
|
456 | + } catch (NotFoundException $e) { |
|
457 | + return false; |
|
458 | + } catch (ForbiddenException $e) { |
|
459 | + return false; |
|
460 | + } |
|
461 | + } |
|
462 | + |
|
463 | + public function isUpdatable($path) { |
|
464 | + try { |
|
465 | + $info = $this->getFileInfo($path); |
|
466 | + // following windows behaviour for read-only folders: they can be written into |
|
467 | + // (https://support.microsoft.com/en-us/kb/326549 - "cause" section) |
|
468 | + return !$info->isHidden() && (!$info->isReadOnly() || $this->is_dir($path)); |
|
469 | + } catch (NotFoundException $e) { |
|
470 | + return false; |
|
471 | + } catch (ForbiddenException $e) { |
|
472 | + return false; |
|
473 | + } |
|
474 | + } |
|
475 | + |
|
476 | + public function isDeletable($path) { |
|
477 | + try { |
|
478 | + $info = $this->getFileInfo($path); |
|
479 | + return !$info->isHidden() && !$info->isReadOnly(); |
|
480 | + } catch (NotFoundException $e) { |
|
481 | + return false; |
|
482 | + } catch (ForbiddenException $e) { |
|
483 | + return false; |
|
484 | + } |
|
485 | + } |
|
486 | + |
|
487 | + /** |
|
488 | + * check if smbclient is installed |
|
489 | + */ |
|
490 | + public static function checkDependencies() { |
|
491 | + return ( |
|
492 | + (bool)\OC_Helper::findBinaryPath('smbclient') |
|
493 | + || Server::NativeAvailable() |
|
494 | + ) ? true : ['smbclient']; |
|
495 | + } |
|
496 | + |
|
497 | + /** |
|
498 | + * Test a storage for availability |
|
499 | + * |
|
500 | + * @return bool |
|
501 | + */ |
|
502 | + public function test() { |
|
503 | + try { |
|
504 | + return parent::test(); |
|
505 | + } catch (Exception $e) { |
|
506 | + return false; |
|
507 | + } |
|
508 | + } |
|
509 | + |
|
510 | + public function listen($path, callable $callback) { |
|
511 | + $this->notify($path)->listen(function (IChange $change) use ($callback) { |
|
512 | + if ($change instanceof IRenameChange) { |
|
513 | + return $callback($change->getType(), $change->getPath(), $change->getTargetPath()); |
|
514 | + } else { |
|
515 | + return $callback($change->getType(), $change->getPath()); |
|
516 | + } |
|
517 | + }); |
|
518 | + } |
|
519 | + |
|
520 | + public function notify($path) { |
|
521 | + $path = '/' . ltrim($path, '/'); |
|
522 | + $shareNotifyHandler = $this->share->notify($this->buildPath($path)); |
|
523 | + return new SMBNotifyHandler($shareNotifyHandler, $this->root); |
|
524 | + } |
|
525 | 525 | } |
@@ -82,7 +82,7 @@ discard block |
||
82 | 82 | |
83 | 83 | $this->root = isset($params['root']) ? $params['root'] : '/'; |
84 | 84 | if (!$this->root || $this->root[0] !== '/') { |
85 | - $this->root = '/' . $this->root; |
|
85 | + $this->root = '/'.$this->root; |
|
86 | 86 | } |
87 | 87 | if (substr($this->root, -1, 1) !== '/') { |
88 | 88 | $this->root .= '/'; |
@@ -101,7 +101,7 @@ discard block |
||
101 | 101 | // FIXME: double slash to keep compatible with the old storage ids, |
102 | 102 | // failure to do so will lead to creation of a new storage id and |
103 | 103 | // loss of shares from the storage |
104 | - return 'smb::' . $this->server->getUser() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root; |
|
104 | + return 'smb::'.$this->server->getUser().'@'.$this->server->getHost().'//'.$this->share->getName().'/'.$this->root; |
|
105 | 105 | } |
106 | 106 | |
107 | 107 | /** |
@@ -109,7 +109,7 @@ discard block |
||
109 | 109 | * @return string |
110 | 110 | */ |
111 | 111 | protected function buildPath($path) { |
112 | - return Filesystem::normalizePath($this->root . '/' . $path, true, false, true); |
|
112 | + return Filesystem::normalizePath($this->root.'/'.$path, true, false, true); |
|
113 | 113 | } |
114 | 114 | |
115 | 115 | protected function relativePath($fullPath) { |
@@ -149,9 +149,9 @@ discard block |
||
149 | 149 | $path = $this->buildPath($path); |
150 | 150 | $files = $this->share->dir($path); |
151 | 151 | foreach ($files as $file) { |
152 | - $this->statCache[$path . '/' . $file->getName()] = $file; |
|
152 | + $this->statCache[$path.'/'.$file->getName()] = $file; |
|
153 | 153 | } |
154 | - return array_filter($files, function (IFileInfo $file) { |
|
154 | + return array_filter($files, function(IFileInfo $file) { |
|
155 | 155 | return !$file->isHidden(); |
156 | 156 | }); |
157 | 157 | } catch (ConnectException $e) { |
@@ -312,7 +312,7 @@ discard block |
||
312 | 312 | case 'w': |
313 | 313 | case 'wb': |
314 | 314 | $source = $this->share->write($fullPath); |
315 | - return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) { |
|
315 | + return CallBackWrapper::wrap($source, null, null, function() use ($fullPath) { |
|
316 | 316 | unset($this->statCache[$fullPath]); |
317 | 317 | }); |
318 | 318 | case 'a': |
@@ -344,7 +344,7 @@ discard block |
||
344 | 344 | } |
345 | 345 | $source = fopen($tmpFile, $mode); |
346 | 346 | $share = $this->share; |
347 | - return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) { |
|
347 | + return CallbackWrapper::wrap($source, null, null, function() use ($tmpFile, $fullPath, $share) { |
|
348 | 348 | unset($this->statCache[$fullPath]); |
349 | 349 | $share->put($tmpFile, $fullPath); |
350 | 350 | unlink($tmpFile); |
@@ -370,7 +370,7 @@ discard block |
||
370 | 370 | $content = $this->share->dir($this->buildPath($path)); |
371 | 371 | foreach ($content as $file) { |
372 | 372 | if ($file->isDirectory()) { |
373 | - $this->rmdir($path . '/' . $file->getName()); |
|
373 | + $this->rmdir($path.'/'.$file->getName()); |
|
374 | 374 | } else { |
375 | 375 | $this->share->del($file->getPath()); |
376 | 376 | } |
@@ -407,7 +407,7 @@ discard block |
||
407 | 407 | } catch (ForbiddenException $e) { |
408 | 408 | return false; |
409 | 409 | } |
410 | - $names = array_map(function ($info) { |
|
410 | + $names = array_map(function($info) { |
|
411 | 411 | /** @var \Icewind\SMB\IFileInfo $info */ |
412 | 412 | return $info->getName(); |
413 | 413 | }, $files); |
@@ -489,7 +489,7 @@ discard block |
||
489 | 489 | */ |
490 | 490 | public static function checkDependencies() { |
491 | 491 | return ( |
492 | - (bool)\OC_Helper::findBinaryPath('smbclient') |
|
492 | + (bool) \OC_Helper::findBinaryPath('smbclient') |
|
493 | 493 | || Server::NativeAvailable() |
494 | 494 | ) ? true : ['smbclient']; |
495 | 495 | } |
@@ -508,7 +508,7 @@ discard block |
||
508 | 508 | } |
509 | 509 | |
510 | 510 | public function listen($path, callable $callback) { |
511 | - $this->notify($path)->listen(function (IChange $change) use ($callback) { |
|
511 | + $this->notify($path)->listen(function(IChange $change) use ($callback) { |
|
512 | 512 | if ($change instanceof IRenameChange) { |
513 | 513 | return $callback($change->getType(), $change->getPath(), $change->getTargetPath()); |
514 | 514 | } else { |
@@ -518,7 +518,7 @@ discard block |
||
518 | 518 | } |
519 | 519 | |
520 | 520 | public function notify($path) { |
521 | - $path = '/' . ltrim($path, '/'); |
|
521 | + $path = '/'.ltrim($path, '/'); |
|
522 | 522 | $shareNotifyHandler = $this->share->notify($this->buildPath($path)); |
523 | 523 | return new SMBNotifyHandler($shareNotifyHandler, $this->root); |
524 | 524 | } |
@@ -23,7 +23,6 @@ |
||
23 | 23 | namespace OCA\User_LDAP\Controller; |
24 | 24 | |
25 | 25 | use OC\HintException; |
26 | -use OC_Util; |
|
27 | 26 | use OCP\AppFramework\Controller; |
28 | 27 | use OCP\AppFramework\Http\RedirectResponse; |
29 | 28 | use OCP\AppFramework\Http\TemplateResponse; |
@@ -85,7 +85,7 @@ discard block |
||
85 | 85 | * @return TemplateResponse|RedirectResponse |
86 | 86 | */ |
87 | 87 | public function showRenewPasswordForm($user) { |
88 | - if($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') { |
|
88 | + if ($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') { |
|
89 | 89 | return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm')); |
90 | 90 | } |
91 | 91 | $parameters = []; |
@@ -129,7 +129,7 @@ discard block |
||
129 | 129 | * @return RedirectResponse |
130 | 130 | */ |
131 | 131 | public function tryRenewPassword($user, $oldPassword, $newPassword) { |
132 | - if($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') { |
|
132 | + if ($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') { |
|
133 | 133 | return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm')); |
134 | 134 | } |
135 | 135 | $args = !is_null($user) ? ['user' => $user] : []; |
@@ -37,144 +37,144 @@ |
||
37 | 37 | use OCP\IUserManager; |
38 | 38 | |
39 | 39 | class RenewPasswordController extends Controller { |
40 | - /** @var IUserManager */ |
|
41 | - private $userManager; |
|
42 | - /** @var IConfig */ |
|
43 | - private $config; |
|
44 | - /** @var IL10N */ |
|
45 | - protected $l10n; |
|
46 | - /** @var ISession */ |
|
47 | - private $session; |
|
48 | - /** @var IURLGenerator */ |
|
49 | - private $urlGenerator; |
|
40 | + /** @var IUserManager */ |
|
41 | + private $userManager; |
|
42 | + /** @var IConfig */ |
|
43 | + private $config; |
|
44 | + /** @var IL10N */ |
|
45 | + protected $l10n; |
|
46 | + /** @var ISession */ |
|
47 | + private $session; |
|
48 | + /** @var IURLGenerator */ |
|
49 | + private $urlGenerator; |
|
50 | 50 | |
51 | - /** |
|
52 | - * @param string $appName |
|
53 | - * @param IRequest $request |
|
54 | - * @param IUserManager $userManager |
|
55 | - * @param IConfig $config |
|
56 | - * @param IURLGenerator $urlGenerator |
|
57 | - */ |
|
58 | - function __construct($appName, IRequest $request, IUserManager $userManager, |
|
59 | - IConfig $config, IL10N $l10n, ISession $session, IURLGenerator $urlGenerator) { |
|
60 | - parent::__construct($appName, $request); |
|
61 | - $this->userManager = $userManager; |
|
62 | - $this->config = $config; |
|
63 | - $this->l10n = $l10n; |
|
64 | - $this->session = $session; |
|
65 | - $this->urlGenerator = $urlGenerator; |
|
66 | - } |
|
51 | + /** |
|
52 | + * @param string $appName |
|
53 | + * @param IRequest $request |
|
54 | + * @param IUserManager $userManager |
|
55 | + * @param IConfig $config |
|
56 | + * @param IURLGenerator $urlGenerator |
|
57 | + */ |
|
58 | + function __construct($appName, IRequest $request, IUserManager $userManager, |
|
59 | + IConfig $config, IL10N $l10n, ISession $session, IURLGenerator $urlGenerator) { |
|
60 | + parent::__construct($appName, $request); |
|
61 | + $this->userManager = $userManager; |
|
62 | + $this->config = $config; |
|
63 | + $this->l10n = $l10n; |
|
64 | + $this->session = $session; |
|
65 | + $this->urlGenerator = $urlGenerator; |
|
66 | + } |
|
67 | 67 | |
68 | - /** |
|
69 | - * @PublicPage |
|
70 | - * @NoCSRFRequired |
|
71 | - * |
|
72 | - * @return RedirectResponse |
|
73 | - */ |
|
74 | - public function cancel() { |
|
75 | - return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm')); |
|
76 | - } |
|
68 | + /** |
|
69 | + * @PublicPage |
|
70 | + * @NoCSRFRequired |
|
71 | + * |
|
72 | + * @return RedirectResponse |
|
73 | + */ |
|
74 | + public function cancel() { |
|
75 | + return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm')); |
|
76 | + } |
|
77 | 77 | |
78 | - /** |
|
79 | - * @PublicPage |
|
80 | - * @NoCSRFRequired |
|
81 | - * @UseSession |
|
82 | - * |
|
83 | - * @param string $user |
|
84 | - * |
|
85 | - * @return TemplateResponse|RedirectResponse |
|
86 | - */ |
|
87 | - public function showRenewPasswordForm($user) { |
|
88 | - if($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') { |
|
89 | - return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm')); |
|
90 | - } |
|
91 | - $parameters = []; |
|
92 | - $renewPasswordMessages = $this->session->get('renewPasswordMessages'); |
|
93 | - $errors = []; |
|
94 | - $messages = []; |
|
95 | - if (is_array($renewPasswordMessages)) { |
|
96 | - list($errors, $messages) = $renewPasswordMessages; |
|
97 | - } |
|
98 | - $this->session->remove('renewPasswordMessages'); |
|
99 | - foreach ($errors as $value) { |
|
100 | - $parameters[$value] = true; |
|
101 | - } |
|
78 | + /** |
|
79 | + * @PublicPage |
|
80 | + * @NoCSRFRequired |
|
81 | + * @UseSession |
|
82 | + * |
|
83 | + * @param string $user |
|
84 | + * |
|
85 | + * @return TemplateResponse|RedirectResponse |
|
86 | + */ |
|
87 | + public function showRenewPasswordForm($user) { |
|
88 | + if($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') { |
|
89 | + return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm')); |
|
90 | + } |
|
91 | + $parameters = []; |
|
92 | + $renewPasswordMessages = $this->session->get('renewPasswordMessages'); |
|
93 | + $errors = []; |
|
94 | + $messages = []; |
|
95 | + if (is_array($renewPasswordMessages)) { |
|
96 | + list($errors, $messages) = $renewPasswordMessages; |
|
97 | + } |
|
98 | + $this->session->remove('renewPasswordMessages'); |
|
99 | + foreach ($errors as $value) { |
|
100 | + $parameters[$value] = true; |
|
101 | + } |
|
102 | 102 | |
103 | - $parameters['messages'] = $messages; |
|
104 | - $parameters['user'] = $user; |
|
103 | + $parameters['messages'] = $messages; |
|
104 | + $parameters['user'] = $user; |
|
105 | 105 | |
106 | - $parameters['canResetPassword'] = true; |
|
107 | - $parameters['resetPasswordLink'] = $this->config->getSystemValue('lost_password_link', ''); |
|
108 | - if (!$parameters['resetPasswordLink']) { |
|
109 | - $userObj = $this->userManager->get($user); |
|
110 | - if ($userObj instanceof IUser) { |
|
111 | - $parameters['canResetPassword'] = $userObj->canChangePassword(); |
|
112 | - } |
|
113 | - } |
|
114 | - $parameters['cancelLink'] = $this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm'); |
|
106 | + $parameters['canResetPassword'] = true; |
|
107 | + $parameters['resetPasswordLink'] = $this->config->getSystemValue('lost_password_link', ''); |
|
108 | + if (!$parameters['resetPasswordLink']) { |
|
109 | + $userObj = $this->userManager->get($user); |
|
110 | + if ($userObj instanceof IUser) { |
|
111 | + $parameters['canResetPassword'] = $userObj->canChangePassword(); |
|
112 | + } |
|
113 | + } |
|
114 | + $parameters['cancelLink'] = $this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm'); |
|
115 | 115 | |
116 | - return new TemplateResponse( |
|
117 | - $this->appName, 'renewpassword', $parameters, 'guest' |
|
118 | - ); |
|
119 | - } |
|
116 | + return new TemplateResponse( |
|
117 | + $this->appName, 'renewpassword', $parameters, 'guest' |
|
118 | + ); |
|
119 | + } |
|
120 | 120 | |
121 | - /** |
|
122 | - * @PublicPage |
|
123 | - * @UseSession |
|
124 | - * |
|
125 | - * @param string $user |
|
126 | - * @param string $oldPassword |
|
127 | - * @param string $newPassword |
|
128 | - * |
|
129 | - * @return RedirectResponse |
|
130 | - */ |
|
131 | - public function tryRenewPassword($user, $oldPassword, $newPassword) { |
|
132 | - if($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') { |
|
133 | - return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm')); |
|
134 | - } |
|
135 | - $args = !is_null($user) ? ['user' => $user] : []; |
|
136 | - $loginResult = $this->userManager->checkPassword($user, $oldPassword); |
|
137 | - if ($loginResult === false) { |
|
138 | - $this->session->set('renewPasswordMessages', [ |
|
139 | - ['invalidpassword'], [] |
|
140 | - ]); |
|
141 | - return new RedirectResponse($this->urlGenerator->linkToRoute('user_ldap.renewPassword.showRenewPasswordForm', $args)); |
|
142 | - } |
|
121 | + /** |
|
122 | + * @PublicPage |
|
123 | + * @UseSession |
|
124 | + * |
|
125 | + * @param string $user |
|
126 | + * @param string $oldPassword |
|
127 | + * @param string $newPassword |
|
128 | + * |
|
129 | + * @return RedirectResponse |
|
130 | + */ |
|
131 | + public function tryRenewPassword($user, $oldPassword, $newPassword) { |
|
132 | + if($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') { |
|
133 | + return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm')); |
|
134 | + } |
|
135 | + $args = !is_null($user) ? ['user' => $user] : []; |
|
136 | + $loginResult = $this->userManager->checkPassword($user, $oldPassword); |
|
137 | + if ($loginResult === false) { |
|
138 | + $this->session->set('renewPasswordMessages', [ |
|
139 | + ['invalidpassword'], [] |
|
140 | + ]); |
|
141 | + return new RedirectResponse($this->urlGenerator->linkToRoute('user_ldap.renewPassword.showRenewPasswordForm', $args)); |
|
142 | + } |
|
143 | 143 | |
144 | - try { |
|
145 | - if (!is_null($newPassword) && \OC_User::setPassword($user, $newPassword)) { |
|
146 | - $this->session->set('loginMessages', [ |
|
147 | - [], [$this->l10n->t("Please login with the new password")] |
|
148 | - ]); |
|
149 | - $this->config->setUserValue($user, 'user_ldap', 'needsPasswordReset', 'false'); |
|
150 | - return new RedirectResponse($this->urlGenerator->linkToRoute('core.login.showLoginForm', $args)); |
|
151 | - } else { |
|
152 | - $this->session->set('renewPasswordMessages', [ |
|
153 | - ['internalexception'], [] |
|
154 | - ]); |
|
155 | - } |
|
156 | - } catch (HintException $e) { |
|
157 | - $this->session->set('renewPasswordMessages', [ |
|
158 | - [], [$e->getHint()] |
|
159 | - ]); |
|
160 | - } |
|
144 | + try { |
|
145 | + if (!is_null($newPassword) && \OC_User::setPassword($user, $newPassword)) { |
|
146 | + $this->session->set('loginMessages', [ |
|
147 | + [], [$this->l10n->t("Please login with the new password")] |
|
148 | + ]); |
|
149 | + $this->config->setUserValue($user, 'user_ldap', 'needsPasswordReset', 'false'); |
|
150 | + return new RedirectResponse($this->urlGenerator->linkToRoute('core.login.showLoginForm', $args)); |
|
151 | + } else { |
|
152 | + $this->session->set('renewPasswordMessages', [ |
|
153 | + ['internalexception'], [] |
|
154 | + ]); |
|
155 | + } |
|
156 | + } catch (HintException $e) { |
|
157 | + $this->session->set('renewPasswordMessages', [ |
|
158 | + [], [$e->getHint()] |
|
159 | + ]); |
|
160 | + } |
|
161 | 161 | |
162 | - return new RedirectResponse($this->urlGenerator->linkToRoute('user_ldap.renewPassword.showRenewPasswordForm', $args)); |
|
163 | - } |
|
162 | + return new RedirectResponse($this->urlGenerator->linkToRoute('user_ldap.renewPassword.showRenewPasswordForm', $args)); |
|
163 | + } |
|
164 | 164 | |
165 | - /** |
|
166 | - * @PublicPage |
|
167 | - * @NoCSRFRequired |
|
168 | - * @UseSession |
|
169 | - * |
|
170 | - * @return RedirectResponse |
|
171 | - */ |
|
172 | - public function showLoginFormInvalidPassword($user) { |
|
173 | - $args = !is_null($user) ? ['user' => $user] : []; |
|
174 | - $this->session->set('loginMessages', [ |
|
175 | - ['invalidpassword'], [] |
|
176 | - ]); |
|
177 | - return new RedirectResponse($this->urlGenerator->linkToRoute('core.login.showLoginForm', $args)); |
|
178 | - } |
|
165 | + /** |
|
166 | + * @PublicPage |
|
167 | + * @NoCSRFRequired |
|
168 | + * @UseSession |
|
169 | + * |
|
170 | + * @return RedirectResponse |
|
171 | + */ |
|
172 | + public function showLoginFormInvalidPassword($user) { |
|
173 | + $args = !is_null($user) ? ['user' => $user] : []; |
|
174 | + $this->session->set('loginMessages', [ |
|
175 | + ['invalidpassword'], [] |
|
176 | + ]); |
|
177 | + return new RedirectResponse($this->urlGenerator->linkToRoute('core.login.showLoginForm', $args)); |
|
178 | + } |
|
179 | 179 | |
180 | 180 | } |
@@ -104,6 +104,10 @@ |
||
104 | 104 | } |
105 | 105 | } |
106 | 106 | |
107 | + /** |
|
108 | + * @param string $href |
|
109 | + * @param string $path |
|
110 | + */ |
|
107 | 111 | public function getPropertyDefinitionsForScope($href, $path) { |
108 | 112 | // all valid scopes support the same schema |
109 | 113 |
@@ -49,234 +49,234 @@ |
||
49 | 49 | use SearchDAV\XML\Order; |
50 | 50 | |
51 | 51 | class FileSearchBackend implements ISearchBackend { |
52 | - /** @var CachingTree */ |
|
53 | - private $tree; |
|
52 | + /** @var CachingTree */ |
|
53 | + private $tree; |
|
54 | 54 | |
55 | - /** @var IUser */ |
|
56 | - private $user; |
|
55 | + /** @var IUser */ |
|
56 | + private $user; |
|
57 | 57 | |
58 | - /** @var IRootFolder */ |
|
59 | - private $rootFolder; |
|
58 | + /** @var IRootFolder */ |
|
59 | + private $rootFolder; |
|
60 | 60 | |
61 | - /** @var IManager */ |
|
62 | - private $shareManager; |
|
61 | + /** @var IManager */ |
|
62 | + private $shareManager; |
|
63 | 63 | |
64 | - /** @var View */ |
|
65 | - private $view; |
|
64 | + /** @var View */ |
|
65 | + private $view; |
|
66 | 66 | |
67 | - /** |
|
68 | - * FileSearchBackend constructor. |
|
69 | - * |
|
70 | - * @param CachingTree $tree |
|
71 | - * @param IUser $user |
|
72 | - * @param IRootFolder $rootFolder |
|
73 | - * @param IManager $shareManager |
|
74 | - * @param View $view |
|
75 | - * @internal param IRootFolder $rootFolder |
|
76 | - */ |
|
77 | - public function __construct(CachingTree $tree, IUser $user, IRootFolder $rootFolder, IManager $shareManager, View $view) { |
|
78 | - $this->tree = $tree; |
|
79 | - $this->user = $user; |
|
80 | - $this->rootFolder = $rootFolder; |
|
81 | - $this->shareManager = $shareManager; |
|
82 | - $this->view = $view; |
|
83 | - } |
|
67 | + /** |
|
68 | + * FileSearchBackend constructor. |
|
69 | + * |
|
70 | + * @param CachingTree $tree |
|
71 | + * @param IUser $user |
|
72 | + * @param IRootFolder $rootFolder |
|
73 | + * @param IManager $shareManager |
|
74 | + * @param View $view |
|
75 | + * @internal param IRootFolder $rootFolder |
|
76 | + */ |
|
77 | + public function __construct(CachingTree $tree, IUser $user, IRootFolder $rootFolder, IManager $shareManager, View $view) { |
|
78 | + $this->tree = $tree; |
|
79 | + $this->user = $user; |
|
80 | + $this->rootFolder = $rootFolder; |
|
81 | + $this->shareManager = $shareManager; |
|
82 | + $this->view = $view; |
|
83 | + } |
|
84 | 84 | |
85 | - /** |
|
86 | - * Search endpoint will be remote.php/dav |
|
87 | - * |
|
88 | - * @return string |
|
89 | - */ |
|
90 | - public function getArbiterPath() { |
|
91 | - return ''; |
|
92 | - } |
|
85 | + /** |
|
86 | + * Search endpoint will be remote.php/dav |
|
87 | + * |
|
88 | + * @return string |
|
89 | + */ |
|
90 | + public function getArbiterPath() { |
|
91 | + return ''; |
|
92 | + } |
|
93 | 93 | |
94 | - public function isValidScope($href, $depth, $path) { |
|
95 | - // only allow scopes inside the dav server |
|
96 | - if (is_null($path)) { |
|
97 | - return false; |
|
98 | - } |
|
94 | + public function isValidScope($href, $depth, $path) { |
|
95 | + // only allow scopes inside the dav server |
|
96 | + if (is_null($path)) { |
|
97 | + return false; |
|
98 | + } |
|
99 | 99 | |
100 | - try { |
|
101 | - $node = $this->tree->getNodeForPath($path); |
|
102 | - return $node instanceof Directory; |
|
103 | - } catch (NotFound $e) { |
|
104 | - return false; |
|
105 | - } |
|
106 | - } |
|
100 | + try { |
|
101 | + $node = $this->tree->getNodeForPath($path); |
|
102 | + return $node instanceof Directory; |
|
103 | + } catch (NotFound $e) { |
|
104 | + return false; |
|
105 | + } |
|
106 | + } |
|
107 | 107 | |
108 | - public function getPropertyDefinitionsForScope($href, $path) { |
|
109 | - // all valid scopes support the same schema |
|
108 | + public function getPropertyDefinitionsForScope($href, $path) { |
|
109 | + // all valid scopes support the same schema |
|
110 | 110 | |
111 | - //todo dynamically load all propfind properties that are supported |
|
112 | - return [ |
|
113 | - // queryable properties |
|
114 | - new SearchPropertyDefinition('{DAV:}displayname', true, false, true), |
|
115 | - new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true), |
|
116 | - new SearchPropertyDefinition('{DAV:}getlastmodified', true, true, true, SearchPropertyDefinition::DATATYPE_DATETIME), |
|
117 | - new SearchPropertyDefinition(FilesPlugin::SIZE_PROPERTYNAME, true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), |
|
118 | - new SearchPropertyDefinition(TagsPlugin::FAVORITE_PROPERTYNAME, true, true, true, SearchPropertyDefinition::DATATYPE_BOOLEAN), |
|
119 | - new SearchPropertyDefinition(FilesPlugin::INTERNAL_FILEID_PROPERTYNAME, true, true, false, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), |
|
111 | + //todo dynamically load all propfind properties that are supported |
|
112 | + return [ |
|
113 | + // queryable properties |
|
114 | + new SearchPropertyDefinition('{DAV:}displayname', true, false, true), |
|
115 | + new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true), |
|
116 | + new SearchPropertyDefinition('{DAV:}getlastmodified', true, true, true, SearchPropertyDefinition::DATATYPE_DATETIME), |
|
117 | + new SearchPropertyDefinition(FilesPlugin::SIZE_PROPERTYNAME, true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), |
|
118 | + new SearchPropertyDefinition(TagsPlugin::FAVORITE_PROPERTYNAME, true, true, true, SearchPropertyDefinition::DATATYPE_BOOLEAN), |
|
119 | + new SearchPropertyDefinition(FilesPlugin::INTERNAL_FILEID_PROPERTYNAME, true, true, false, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), |
|
120 | 120 | |
121 | - // select only properties |
|
122 | - new SearchPropertyDefinition('{DAV:}resourcetype', false, true, false), |
|
123 | - new SearchPropertyDefinition('{DAV:}getcontentlength', false, true, false), |
|
124 | - new SearchPropertyDefinition(FilesPlugin::CHECKSUMS_PROPERTYNAME, false, true, false), |
|
125 | - new SearchPropertyDefinition(FilesPlugin::PERMISSIONS_PROPERTYNAME, false, true, false), |
|
126 | - new SearchPropertyDefinition(FilesPlugin::GETETAG_PROPERTYNAME, false, true, false), |
|
127 | - new SearchPropertyDefinition(FilesPlugin::OWNER_ID_PROPERTYNAME, false, true, false), |
|
128 | - new SearchPropertyDefinition(FilesPlugin::OWNER_DISPLAY_NAME_PROPERTYNAME, false, true, false), |
|
129 | - new SearchPropertyDefinition(FilesPlugin::DATA_FINGERPRINT_PROPERTYNAME, false, true, false), |
|
130 | - new SearchPropertyDefinition(FilesPlugin::HAS_PREVIEW_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_BOOLEAN), |
|
131 | - new SearchPropertyDefinition(FilesPlugin::FILEID_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), |
|
132 | - ]; |
|
133 | - } |
|
121 | + // select only properties |
|
122 | + new SearchPropertyDefinition('{DAV:}resourcetype', false, true, false), |
|
123 | + new SearchPropertyDefinition('{DAV:}getcontentlength', false, true, false), |
|
124 | + new SearchPropertyDefinition(FilesPlugin::CHECKSUMS_PROPERTYNAME, false, true, false), |
|
125 | + new SearchPropertyDefinition(FilesPlugin::PERMISSIONS_PROPERTYNAME, false, true, false), |
|
126 | + new SearchPropertyDefinition(FilesPlugin::GETETAG_PROPERTYNAME, false, true, false), |
|
127 | + new SearchPropertyDefinition(FilesPlugin::OWNER_ID_PROPERTYNAME, false, true, false), |
|
128 | + new SearchPropertyDefinition(FilesPlugin::OWNER_DISPLAY_NAME_PROPERTYNAME, false, true, false), |
|
129 | + new SearchPropertyDefinition(FilesPlugin::DATA_FINGERPRINT_PROPERTYNAME, false, true, false), |
|
130 | + new SearchPropertyDefinition(FilesPlugin::HAS_PREVIEW_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_BOOLEAN), |
|
131 | + new SearchPropertyDefinition(FilesPlugin::FILEID_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), |
|
132 | + ]; |
|
133 | + } |
|
134 | 134 | |
135 | - /** |
|
136 | - * @param BasicSearch $search |
|
137 | - * @return SearchResult[] |
|
138 | - */ |
|
139 | - public function search(BasicSearch $search) { |
|
140 | - if (count($search->from) !== 1) { |
|
141 | - throw new \InvalidArgumentException('Searching more than one folder is not supported'); |
|
142 | - } |
|
143 | - $query = $this->transformQuery($search); |
|
144 | - $scope = $search->from[0]; |
|
145 | - if ($scope->path === null) { |
|
146 | - throw new \InvalidArgumentException('Using uri\'s as scope is not supported, please use a path relative to the search arbiter instead'); |
|
147 | - } |
|
148 | - $node = $this->tree->getNodeForPath($scope->path); |
|
149 | - if (!$node instanceof Directory) { |
|
150 | - throw new \InvalidArgumentException('Search is only supported on directories'); |
|
151 | - } |
|
135 | + /** |
|
136 | + * @param BasicSearch $search |
|
137 | + * @return SearchResult[] |
|
138 | + */ |
|
139 | + public function search(BasicSearch $search) { |
|
140 | + if (count($search->from) !== 1) { |
|
141 | + throw new \InvalidArgumentException('Searching more than one folder is not supported'); |
|
142 | + } |
|
143 | + $query = $this->transformQuery($search); |
|
144 | + $scope = $search->from[0]; |
|
145 | + if ($scope->path === null) { |
|
146 | + throw new \InvalidArgumentException('Using uri\'s as scope is not supported, please use a path relative to the search arbiter instead'); |
|
147 | + } |
|
148 | + $node = $this->tree->getNodeForPath($scope->path); |
|
149 | + if (!$node instanceof Directory) { |
|
150 | + throw new \InvalidArgumentException('Search is only supported on directories'); |
|
151 | + } |
|
152 | 152 | |
153 | - $fileInfo = $node->getFileInfo(); |
|
154 | - $folder = $this->rootFolder->get($fileInfo->getPath()); |
|
155 | - /** @var Folder $folder $results */ |
|
156 | - $results = $folder->search($query); |
|
153 | + $fileInfo = $node->getFileInfo(); |
|
154 | + $folder = $this->rootFolder->get($fileInfo->getPath()); |
|
155 | + /** @var Folder $folder $results */ |
|
156 | + $results = $folder->search($query); |
|
157 | 157 | |
158 | - return array_map(function (Node $node) { |
|
159 | - if ($node instanceof Folder) { |
|
160 | - $davNode = new \OCA\DAV\Connector\Sabre\Directory($this->view, $node, $this->tree, $this->shareManager); |
|
161 | - } else { |
|
162 | - $davNode = new \OCA\DAV\Connector\Sabre\File($this->view, $node, $this->shareManager); |
|
163 | - } |
|
164 | - $path = $this->getHrefForNode($node); |
|
165 | - $this->tree->cacheNode($davNode, $path); |
|
166 | - return new SearchResult($davNode, $path); |
|
167 | - }, $results); |
|
168 | - } |
|
158 | + return array_map(function (Node $node) { |
|
159 | + if ($node instanceof Folder) { |
|
160 | + $davNode = new \OCA\DAV\Connector\Sabre\Directory($this->view, $node, $this->tree, $this->shareManager); |
|
161 | + } else { |
|
162 | + $davNode = new \OCA\DAV\Connector\Sabre\File($this->view, $node, $this->shareManager); |
|
163 | + } |
|
164 | + $path = $this->getHrefForNode($node); |
|
165 | + $this->tree->cacheNode($davNode, $path); |
|
166 | + return new SearchResult($davNode, $path); |
|
167 | + }, $results); |
|
168 | + } |
|
169 | 169 | |
170 | - /** |
|
171 | - * @param Node $node |
|
172 | - * @return string |
|
173 | - */ |
|
174 | - private function getHrefForNode(Node $node) { |
|
175 | - $base = '/files/' . $this->user->getUID(); |
|
176 | - return $base . $this->view->getRelativePath($node->getPath()); |
|
177 | - } |
|
170 | + /** |
|
171 | + * @param Node $node |
|
172 | + * @return string |
|
173 | + */ |
|
174 | + private function getHrefForNode(Node $node) { |
|
175 | + $base = '/files/' . $this->user->getUID(); |
|
176 | + return $base . $this->view->getRelativePath($node->getPath()); |
|
177 | + } |
|
178 | 178 | |
179 | - /** |
|
180 | - * @param BasicSearch $query |
|
181 | - * @return ISearchQuery |
|
182 | - */ |
|
183 | - private function transformQuery(BasicSearch $query) { |
|
184 | - // TODO offset, limit |
|
185 | - $orders = array_map([$this, 'mapSearchOrder'], $query->orderBy); |
|
186 | - return new SearchQuery($this->transformSearchOperation($query->where), 0, 0, $orders, $this->user); |
|
187 | - } |
|
179 | + /** |
|
180 | + * @param BasicSearch $query |
|
181 | + * @return ISearchQuery |
|
182 | + */ |
|
183 | + private function transformQuery(BasicSearch $query) { |
|
184 | + // TODO offset, limit |
|
185 | + $orders = array_map([$this, 'mapSearchOrder'], $query->orderBy); |
|
186 | + return new SearchQuery($this->transformSearchOperation($query->where), 0, 0, $orders, $this->user); |
|
187 | + } |
|
188 | 188 | |
189 | - /** |
|
190 | - * @param Order $order |
|
191 | - * @return ISearchOrder |
|
192 | - */ |
|
193 | - private function mapSearchOrder(Order $order) { |
|
194 | - return new SearchOrder($order->order === Order::ASC ? ISearchOrder::DIRECTION_ASCENDING : ISearchOrder::DIRECTION_DESCENDING, $this->mapPropertyNameToColumn($order->property)); |
|
195 | - } |
|
189 | + /** |
|
190 | + * @param Order $order |
|
191 | + * @return ISearchOrder |
|
192 | + */ |
|
193 | + private function mapSearchOrder(Order $order) { |
|
194 | + return new SearchOrder($order->order === Order::ASC ? ISearchOrder::DIRECTION_ASCENDING : ISearchOrder::DIRECTION_DESCENDING, $this->mapPropertyNameToColumn($order->property)); |
|
195 | + } |
|
196 | 196 | |
197 | - /** |
|
198 | - * @param Operator $operator |
|
199 | - * @return ISearchOperator |
|
200 | - */ |
|
201 | - private function transformSearchOperation(Operator $operator) { |
|
202 | - list(, $trimmedType) = explode('}', $operator->type); |
|
203 | - switch ($operator->type) { |
|
204 | - case Operator::OPERATION_AND: |
|
205 | - case Operator::OPERATION_OR: |
|
206 | - case Operator::OPERATION_NOT: |
|
207 | - $arguments = array_map([$this, 'transformSearchOperation'], $operator->arguments); |
|
208 | - return new SearchBinaryOperator($trimmedType, $arguments); |
|
209 | - case Operator::OPERATION_EQUAL: |
|
210 | - case Operator::OPERATION_GREATER_OR_EQUAL_THAN: |
|
211 | - case Operator::OPERATION_GREATER_THAN: |
|
212 | - case Operator::OPERATION_LESS_OR_EQUAL_THAN: |
|
213 | - case Operator::OPERATION_LESS_THAN: |
|
214 | - case Operator::OPERATION_IS_LIKE: |
|
215 | - if (count($operator->arguments) !== 2) { |
|
216 | - throw new \InvalidArgumentException('Invalid number of arguments for ' . $trimmedType . ' operation'); |
|
217 | - } |
|
218 | - if (!is_string($operator->arguments[0])) { |
|
219 | - throw new \InvalidArgumentException('Invalid argument 1 for ' . $trimmedType . ' operation, expected property'); |
|
220 | - } |
|
221 | - if (!($operator->arguments[1] instanceof Literal)) { |
|
222 | - throw new \InvalidArgumentException('Invalid argument 2 for ' . $trimmedType . ' operation, expected literal'); |
|
223 | - } |
|
224 | - return new SearchComparison($trimmedType, $this->mapPropertyNameToColumn($operator->arguments[0]), $this->castValue($operator->arguments[0], $operator->arguments[1]->value)); |
|
225 | - case Operator::OPERATION_IS_COLLECTION: |
|
226 | - return new SearchComparison('eq', 'mimetype', ICacheEntry::DIRECTORY_MIMETYPE); |
|
227 | - default: |
|
228 | - throw new \InvalidArgumentException('Unsupported operation ' . $trimmedType . ' (' . $operator->type . ')'); |
|
229 | - } |
|
230 | - } |
|
197 | + /** |
|
198 | + * @param Operator $operator |
|
199 | + * @return ISearchOperator |
|
200 | + */ |
|
201 | + private function transformSearchOperation(Operator $operator) { |
|
202 | + list(, $trimmedType) = explode('}', $operator->type); |
|
203 | + switch ($operator->type) { |
|
204 | + case Operator::OPERATION_AND: |
|
205 | + case Operator::OPERATION_OR: |
|
206 | + case Operator::OPERATION_NOT: |
|
207 | + $arguments = array_map([$this, 'transformSearchOperation'], $operator->arguments); |
|
208 | + return new SearchBinaryOperator($trimmedType, $arguments); |
|
209 | + case Operator::OPERATION_EQUAL: |
|
210 | + case Operator::OPERATION_GREATER_OR_EQUAL_THAN: |
|
211 | + case Operator::OPERATION_GREATER_THAN: |
|
212 | + case Operator::OPERATION_LESS_OR_EQUAL_THAN: |
|
213 | + case Operator::OPERATION_LESS_THAN: |
|
214 | + case Operator::OPERATION_IS_LIKE: |
|
215 | + if (count($operator->arguments) !== 2) { |
|
216 | + throw new \InvalidArgumentException('Invalid number of arguments for ' . $trimmedType . ' operation'); |
|
217 | + } |
|
218 | + if (!is_string($operator->arguments[0])) { |
|
219 | + throw new \InvalidArgumentException('Invalid argument 1 for ' . $trimmedType . ' operation, expected property'); |
|
220 | + } |
|
221 | + if (!($operator->arguments[1] instanceof Literal)) { |
|
222 | + throw new \InvalidArgumentException('Invalid argument 2 for ' . $trimmedType . ' operation, expected literal'); |
|
223 | + } |
|
224 | + return new SearchComparison($trimmedType, $this->mapPropertyNameToColumn($operator->arguments[0]), $this->castValue($operator->arguments[0], $operator->arguments[1]->value)); |
|
225 | + case Operator::OPERATION_IS_COLLECTION: |
|
226 | + return new SearchComparison('eq', 'mimetype', ICacheEntry::DIRECTORY_MIMETYPE); |
|
227 | + default: |
|
228 | + throw new \InvalidArgumentException('Unsupported operation ' . $trimmedType . ' (' . $operator->type . ')'); |
|
229 | + } |
|
230 | + } |
|
231 | 231 | |
232 | - /** |
|
233 | - * @param string $propertyName |
|
234 | - * @return string |
|
235 | - */ |
|
236 | - private function mapPropertyNameToColumn($propertyName) { |
|
237 | - switch ($propertyName) { |
|
238 | - case '{DAV:}displayname': |
|
239 | - return 'name'; |
|
240 | - case '{DAV:}getcontenttype': |
|
241 | - return 'mimetype'; |
|
242 | - case '{DAV:}getlastmodified': |
|
243 | - return 'mtime'; |
|
244 | - case FilesPlugin::SIZE_PROPERTYNAME: |
|
245 | - return 'size'; |
|
246 | - case TagsPlugin::FAVORITE_PROPERTYNAME: |
|
247 | - return 'favorite'; |
|
248 | - case TagsPlugin::TAGS_PROPERTYNAME: |
|
249 | - return 'tagname'; |
|
250 | - case FilesPlugin::INTERNAL_FILEID_PROPERTYNAME: |
|
251 | - return 'fileid'; |
|
252 | - default: |
|
253 | - throw new \InvalidArgumentException('Unsupported property for search or order: ' . $propertyName); |
|
254 | - } |
|
255 | - } |
|
232 | + /** |
|
233 | + * @param string $propertyName |
|
234 | + * @return string |
|
235 | + */ |
|
236 | + private function mapPropertyNameToColumn($propertyName) { |
|
237 | + switch ($propertyName) { |
|
238 | + case '{DAV:}displayname': |
|
239 | + return 'name'; |
|
240 | + case '{DAV:}getcontenttype': |
|
241 | + return 'mimetype'; |
|
242 | + case '{DAV:}getlastmodified': |
|
243 | + return 'mtime'; |
|
244 | + case FilesPlugin::SIZE_PROPERTYNAME: |
|
245 | + return 'size'; |
|
246 | + case TagsPlugin::FAVORITE_PROPERTYNAME: |
|
247 | + return 'favorite'; |
|
248 | + case TagsPlugin::TAGS_PROPERTYNAME: |
|
249 | + return 'tagname'; |
|
250 | + case FilesPlugin::INTERNAL_FILEID_PROPERTYNAME: |
|
251 | + return 'fileid'; |
|
252 | + default: |
|
253 | + throw new \InvalidArgumentException('Unsupported property for search or order: ' . $propertyName); |
|
254 | + } |
|
255 | + } |
|
256 | 256 | |
257 | - private function castValue($propertyName, $value) { |
|
258 | - $allProps = $this->getPropertyDefinitionsForScope('', ''); |
|
259 | - foreach ($allProps as $prop) { |
|
260 | - if ($prop->name === $propertyName) { |
|
261 | - $dataType = $prop->dataType; |
|
262 | - switch ($dataType) { |
|
263 | - case SearchPropertyDefinition::DATATYPE_BOOLEAN: |
|
264 | - return $value === 'yes'; |
|
265 | - case SearchPropertyDefinition::DATATYPE_DECIMAL: |
|
266 | - case SearchPropertyDefinition::DATATYPE_INTEGER: |
|
267 | - case SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER: |
|
268 | - return 0 + $value; |
|
269 | - case SearchPropertyDefinition::DATATYPE_DATETIME: |
|
270 | - if (is_numeric($value)) { |
|
271 | - return 0 + $value; |
|
272 | - } |
|
273 | - $date = \DateTime::createFromFormat(\DateTime::ATOM, $value); |
|
274 | - return ($date instanceof \DateTime) ? $date->getTimestamp() : 0; |
|
275 | - default: |
|
276 | - return $value; |
|
277 | - } |
|
278 | - } |
|
279 | - } |
|
280 | - return $value; |
|
281 | - } |
|
257 | + private function castValue($propertyName, $value) { |
|
258 | + $allProps = $this->getPropertyDefinitionsForScope('', ''); |
|
259 | + foreach ($allProps as $prop) { |
|
260 | + if ($prop->name === $propertyName) { |
|
261 | + $dataType = $prop->dataType; |
|
262 | + switch ($dataType) { |
|
263 | + case SearchPropertyDefinition::DATATYPE_BOOLEAN: |
|
264 | + return $value === 'yes'; |
|
265 | + case SearchPropertyDefinition::DATATYPE_DECIMAL: |
|
266 | + case SearchPropertyDefinition::DATATYPE_INTEGER: |
|
267 | + case SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER: |
|
268 | + return 0 + $value; |
|
269 | + case SearchPropertyDefinition::DATATYPE_DATETIME: |
|
270 | + if (is_numeric($value)) { |
|
271 | + return 0 + $value; |
|
272 | + } |
|
273 | + $date = \DateTime::createFromFormat(\DateTime::ATOM, $value); |
|
274 | + return ($date instanceof \DateTime) ? $date->getTimestamp() : 0; |
|
275 | + default: |
|
276 | + return $value; |
|
277 | + } |
|
278 | + } |
|
279 | + } |
|
280 | + return $value; |
|
281 | + } |
|
282 | 282 | } |
@@ -155,7 +155,7 @@ discard block |
||
155 | 155 | /** @var Folder $folder $results */ |
156 | 156 | $results = $folder->search($query); |
157 | 157 | |
158 | - return array_map(function (Node $node) { |
|
158 | + return array_map(function(Node $node) { |
|
159 | 159 | if ($node instanceof Folder) { |
160 | 160 | $davNode = new \OCA\DAV\Connector\Sabre\Directory($this->view, $node, $this->tree, $this->shareManager); |
161 | 161 | } else { |
@@ -172,8 +172,8 @@ discard block |
||
172 | 172 | * @return string |
173 | 173 | */ |
174 | 174 | private function getHrefForNode(Node $node) { |
175 | - $base = '/files/' . $this->user->getUID(); |
|
176 | - return $base . $this->view->getRelativePath($node->getPath()); |
|
175 | + $base = '/files/'.$this->user->getUID(); |
|
176 | + return $base.$this->view->getRelativePath($node->getPath()); |
|
177 | 177 | } |
178 | 178 | |
179 | 179 | /** |
@@ -213,19 +213,19 @@ discard block |
||
213 | 213 | case Operator::OPERATION_LESS_THAN: |
214 | 214 | case Operator::OPERATION_IS_LIKE: |
215 | 215 | if (count($operator->arguments) !== 2) { |
216 | - throw new \InvalidArgumentException('Invalid number of arguments for ' . $trimmedType . ' operation'); |
|
216 | + throw new \InvalidArgumentException('Invalid number of arguments for '.$trimmedType.' operation'); |
|
217 | 217 | } |
218 | 218 | if (!is_string($operator->arguments[0])) { |
219 | - throw new \InvalidArgumentException('Invalid argument 1 for ' . $trimmedType . ' operation, expected property'); |
|
219 | + throw new \InvalidArgumentException('Invalid argument 1 for '.$trimmedType.' operation, expected property'); |
|
220 | 220 | } |
221 | 221 | if (!($operator->arguments[1] instanceof Literal)) { |
222 | - throw new \InvalidArgumentException('Invalid argument 2 for ' . $trimmedType . ' operation, expected literal'); |
|
222 | + throw new \InvalidArgumentException('Invalid argument 2 for '.$trimmedType.' operation, expected literal'); |
|
223 | 223 | } |
224 | 224 | return new SearchComparison($trimmedType, $this->mapPropertyNameToColumn($operator->arguments[0]), $this->castValue($operator->arguments[0], $operator->arguments[1]->value)); |
225 | 225 | case Operator::OPERATION_IS_COLLECTION: |
226 | 226 | return new SearchComparison('eq', 'mimetype', ICacheEntry::DIRECTORY_MIMETYPE); |
227 | 227 | default: |
228 | - throw new \InvalidArgumentException('Unsupported operation ' . $trimmedType . ' (' . $operator->type . ')'); |
|
228 | + throw new \InvalidArgumentException('Unsupported operation '.$trimmedType.' ('.$operator->type.')'); |
|
229 | 229 | } |
230 | 230 | } |
231 | 231 | |
@@ -250,7 +250,7 @@ discard block |
||
250 | 250 | case FilesPlugin::INTERNAL_FILEID_PROPERTYNAME: |
251 | 251 | return 'fileid'; |
252 | 252 | default: |
253 | - throw new \InvalidArgumentException('Unsupported property for search or order: ' . $propertyName); |
|
253 | + throw new \InvalidArgumentException('Unsupported property for search or order: '.$propertyName); |
|
254 | 254 | } |
255 | 255 | } |
256 | 256 |
@@ -37,7 +37,7 @@ |
||
37 | 37 | private $filePath; |
38 | 38 | |
39 | 39 | /** |
40 | - * @param string|resource $filePath the path to the file or a file handle which should be streamed |
|
40 | + * @param string $filePath the path to the file or a file handle which should be streamed |
|
41 | 41 | * @since 8.1.0 |
42 | 42 | */ |
43 | 43 | public function __construct ($filePath) { |
@@ -33,33 +33,33 @@ |
||
33 | 33 | * @since 8.1.0 |
34 | 34 | */ |
35 | 35 | class StreamResponse extends Response implements ICallbackResponse { |
36 | - /** @var string */ |
|
37 | - private $filePath; |
|
36 | + /** @var string */ |
|
37 | + private $filePath; |
|
38 | 38 | |
39 | - /** |
|
40 | - * @param string|resource $filePath the path to the file or a file handle which should be streamed |
|
41 | - * @since 8.1.0 |
|
42 | - */ |
|
43 | - public function __construct ($filePath) { |
|
44 | - $this->filePath = $filePath; |
|
45 | - } |
|
39 | + /** |
|
40 | + * @param string|resource $filePath the path to the file or a file handle which should be streamed |
|
41 | + * @since 8.1.0 |
|
42 | + */ |
|
43 | + public function __construct ($filePath) { |
|
44 | + $this->filePath = $filePath; |
|
45 | + } |
|
46 | 46 | |
47 | 47 | |
48 | - /** |
|
49 | - * Streams the file using readfile |
|
50 | - * |
|
51 | - * @param IOutput $output a small wrapper that handles output |
|
52 | - * @since 8.1.0 |
|
53 | - */ |
|
54 | - public function callback (IOutput $output) { |
|
55 | - // handle caching |
|
56 | - if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) { |
|
57 | - if (!(is_resource($this->filePath) || file_exists($this->filePath))) { |
|
58 | - $output->setHttpResponseCode(Http::STATUS_NOT_FOUND); |
|
59 | - } elseif ($output->setReadfile($this->filePath) === false) { |
|
60 | - $output->setHttpResponseCode(Http::STATUS_BAD_REQUEST); |
|
61 | - } |
|
62 | - } |
|
63 | - } |
|
48 | + /** |
|
49 | + * Streams the file using readfile |
|
50 | + * |
|
51 | + * @param IOutput $output a small wrapper that handles output |
|
52 | + * @since 8.1.0 |
|
53 | + */ |
|
54 | + public function callback (IOutput $output) { |
|
55 | + // handle caching |
|
56 | + if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) { |
|
57 | + if (!(is_resource($this->filePath) || file_exists($this->filePath))) { |
|
58 | + $output->setHttpResponseCode(Http::STATUS_NOT_FOUND); |
|
59 | + } elseif ($output->setReadfile($this->filePath) === false) { |
|
60 | + $output->setHttpResponseCode(Http::STATUS_BAD_REQUEST); |
|
61 | + } |
|
62 | + } |
|
63 | + } |
|
64 | 64 | |
65 | 65 | } |
@@ -40,7 +40,7 @@ discard block |
||
40 | 40 | * @param string|resource $filePath the path to the file or a file handle which should be streamed |
41 | 41 | * @since 8.1.0 |
42 | 42 | */ |
43 | - public function __construct ($filePath) { |
|
43 | + public function __construct($filePath) { |
|
44 | 44 | $this->filePath = $filePath; |
45 | 45 | } |
46 | 46 | |
@@ -51,7 +51,7 @@ discard block |
||
51 | 51 | * @param IOutput $output a small wrapper that handles output |
52 | 52 | * @since 8.1.0 |
53 | 53 | */ |
54 | - public function callback (IOutput $output) { |
|
54 | + public function callback(IOutput $output) { |
|
55 | 55 | // handle caching |
56 | 56 | if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) { |
57 | 57 | if (!(is_resource($this->filePath) || file_exists($this->filePath))) { |
@@ -47,6 +47,9 @@ |
||
47 | 47 | $this->allowUnauthenticatedAccess = false; |
48 | 48 | } |
49 | 49 | |
50 | + /** |
|
51 | + * @param string $privileges |
|
52 | + */ |
|
50 | 53 | function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) { |
51 | 54 | $access = parent::checkPrivileges($uri, $privileges, $recursion, false); |
52 | 55 | if($access === false && $throwExceptions) { |
@@ -43,50 +43,50 @@ |
||
43 | 43 | * @package OCA\DAV\Connector\Sabre |
44 | 44 | */ |
45 | 45 | class DavAclPlugin extends \Sabre\DAVACL\Plugin { |
46 | - public function __construct() { |
|
47 | - $this->hideNodesFromListings = true; |
|
48 | - $this->allowUnauthenticatedAccess = false; |
|
49 | - } |
|
46 | + public function __construct() { |
|
47 | + $this->hideNodesFromListings = true; |
|
48 | + $this->allowUnauthenticatedAccess = false; |
|
49 | + } |
|
50 | 50 | |
51 | - function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) { |
|
52 | - $access = parent::checkPrivileges($uri, $privileges, $recursion, false); |
|
53 | - if($access === false && $throwExceptions) { |
|
54 | - /** @var INode $node */ |
|
55 | - $node = $this->server->tree->getNodeForPath($uri); |
|
51 | + function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) { |
|
52 | + $access = parent::checkPrivileges($uri, $privileges, $recursion, false); |
|
53 | + if($access === false && $throwExceptions) { |
|
54 | + /** @var INode $node */ |
|
55 | + $node = $this->server->tree->getNodeForPath($uri); |
|
56 | 56 | |
57 | - switch(get_class($node)) { |
|
58 | - case 'OCA\DAV\CardDAV\AddressBook': |
|
59 | - $type = 'Addressbook'; |
|
60 | - break; |
|
61 | - default: |
|
62 | - $type = 'Node'; |
|
63 | - break; |
|
64 | - } |
|
65 | - throw new NotFound( |
|
66 | - sprintf( |
|
67 | - "%s with name '%s' could not be found", |
|
68 | - $type, |
|
69 | - $node->getName() |
|
70 | - ) |
|
71 | - ); |
|
72 | - } |
|
57 | + switch(get_class($node)) { |
|
58 | + case 'OCA\DAV\CardDAV\AddressBook': |
|
59 | + $type = 'Addressbook'; |
|
60 | + break; |
|
61 | + default: |
|
62 | + $type = 'Node'; |
|
63 | + break; |
|
64 | + } |
|
65 | + throw new NotFound( |
|
66 | + sprintf( |
|
67 | + "%s with name '%s' could not be found", |
|
68 | + $type, |
|
69 | + $node->getName() |
|
70 | + ) |
|
71 | + ); |
|
72 | + } |
|
73 | 73 | |
74 | - return $access; |
|
75 | - } |
|
74 | + return $access; |
|
75 | + } |
|
76 | 76 | |
77 | - public function propFind(PropFind $propFind, INode $node) { |
|
78 | - // If the node is neither readable nor writable then fail unless its of |
|
79 | - // the standard user-principal |
|
80 | - if(!($node instanceof User)) { |
|
81 | - $path = $propFind->getPath(); |
|
82 | - $readPermissions = $this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, false); |
|
83 | - $writePermissions = $this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, false); |
|
84 | - if ($readPermissions === false && $writePermissions === false) { |
|
85 | - $this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, true); |
|
86 | - $this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, true); |
|
87 | - } |
|
88 | - } |
|
77 | + public function propFind(PropFind $propFind, INode $node) { |
|
78 | + // If the node is neither readable nor writable then fail unless its of |
|
79 | + // the standard user-principal |
|
80 | + if(!($node instanceof User)) { |
|
81 | + $path = $propFind->getPath(); |
|
82 | + $readPermissions = $this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, false); |
|
83 | + $writePermissions = $this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, false); |
|
84 | + if ($readPermissions === false && $writePermissions === false) { |
|
85 | + $this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, true); |
|
86 | + $this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, true); |
|
87 | + } |
|
88 | + } |
|
89 | 89 | |
90 | - return parent::propFind($propFind, $node); |
|
91 | - } |
|
90 | + return parent::propFind($propFind, $node); |
|
91 | + } |
|
92 | 92 | } |
@@ -50,11 +50,11 @@ discard block |
||
50 | 50 | |
51 | 51 | function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) { |
52 | 52 | $access = parent::checkPrivileges($uri, $privileges, $recursion, false); |
53 | - if($access === false && $throwExceptions) { |
|
53 | + if ($access === false && $throwExceptions) { |
|
54 | 54 | /** @var INode $node */ |
55 | 55 | $node = $this->server->tree->getNodeForPath($uri); |
56 | 56 | |
57 | - switch(get_class($node)) { |
|
57 | + switch (get_class($node)) { |
|
58 | 58 | case 'OCA\DAV\CardDAV\AddressBook': |
59 | 59 | $type = 'Addressbook'; |
60 | 60 | break; |
@@ -77,7 +77,7 @@ discard block |
||
77 | 77 | public function propFind(PropFind $propFind, INode $node) { |
78 | 78 | // If the node is neither readable nor writable then fail unless its of |
79 | 79 | // the standard user-principal |
80 | - if(!($node instanceof User)) { |
|
80 | + if (!($node instanceof User)) { |
|
81 | 81 | $path = $propFind->getPath(); |
82 | 82 | $readPermissions = $this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, false); |
83 | 83 | $writePermissions = $this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, false); |
@@ -100,6 +100,7 @@ discard block |
||
100 | 100 | * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
101 | 101 | * @param \OCP\Lock\ILockingProvider $provider |
102 | 102 | * @throws \OCP\Lock\LockedException |
103 | + * @return void |
|
103 | 104 | */ |
104 | 105 | public function acquireLock($path, $type, ILockingProvider $provider); |
105 | 106 | |
@@ -108,6 +109,7 @@ discard block |
||
108 | 109 | * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
109 | 110 | * @param \OCP\Lock\ILockingProvider $provider |
110 | 111 | * @throws \OCP\Lock\LockedException |
112 | + * @return void |
|
111 | 113 | */ |
112 | 114 | public function releaseLock($path, $type, ILockingProvider $provider); |
113 | 115 | |
@@ -116,6 +118,7 @@ discard block |
||
116 | 118 | * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
117 | 119 | * @param \OCP\Lock\ILockingProvider $provider |
118 | 120 | * @throws \OCP\Lock\LockedException |
121 | + * @return void |
|
119 | 122 | */ |
120 | 123 | public function changeLock($path, $type, ILockingProvider $provider); |
121 | 124 | } |
@@ -32,90 +32,90 @@ |
||
32 | 32 | */ |
33 | 33 | interface Storage extends \OCP\Files\Storage { |
34 | 34 | |
35 | - /** |
|
36 | - * get a cache instance for the storage |
|
37 | - * |
|
38 | - * @param string $path |
|
39 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the cache |
|
40 | - * @return \OC\Files\Cache\Cache |
|
41 | - */ |
|
42 | - public function getCache($path = '', $storage = null); |
|
35 | + /** |
|
36 | + * get a cache instance for the storage |
|
37 | + * |
|
38 | + * @param string $path |
|
39 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the cache |
|
40 | + * @return \OC\Files\Cache\Cache |
|
41 | + */ |
|
42 | + public function getCache($path = '', $storage = null); |
|
43 | 43 | |
44 | - /** |
|
45 | - * get a scanner instance for the storage |
|
46 | - * |
|
47 | - * @param string $path |
|
48 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner |
|
49 | - * @return \OC\Files\Cache\Scanner |
|
50 | - */ |
|
51 | - public function getScanner($path = '', $storage = null); |
|
44 | + /** |
|
45 | + * get a scanner instance for the storage |
|
46 | + * |
|
47 | + * @param string $path |
|
48 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner |
|
49 | + * @return \OC\Files\Cache\Scanner |
|
50 | + */ |
|
51 | + public function getScanner($path = '', $storage = null); |
|
52 | 52 | |
53 | 53 | |
54 | - /** |
|
55 | - * get the user id of the owner of a file or folder |
|
56 | - * |
|
57 | - * @param string $path |
|
58 | - * @return string |
|
59 | - */ |
|
60 | - public function getOwner($path); |
|
54 | + /** |
|
55 | + * get the user id of the owner of a file or folder |
|
56 | + * |
|
57 | + * @param string $path |
|
58 | + * @return string |
|
59 | + */ |
|
60 | + public function getOwner($path); |
|
61 | 61 | |
62 | - /** |
|
63 | - * get a watcher instance for the cache |
|
64 | - * |
|
65 | - * @param string $path |
|
66 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
67 | - * @return \OC\Files\Cache\Watcher |
|
68 | - */ |
|
69 | - public function getWatcher($path = '', $storage = null); |
|
62 | + /** |
|
63 | + * get a watcher instance for the cache |
|
64 | + * |
|
65 | + * @param string $path |
|
66 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
67 | + * @return \OC\Files\Cache\Watcher |
|
68 | + */ |
|
69 | + public function getWatcher($path = '', $storage = null); |
|
70 | 70 | |
71 | - /** |
|
72 | - * get a propagator instance for the cache |
|
73 | - * |
|
74 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
75 | - * @return \OC\Files\Cache\Propagator |
|
76 | - */ |
|
77 | - public function getPropagator($storage = null); |
|
71 | + /** |
|
72 | + * get a propagator instance for the cache |
|
73 | + * |
|
74 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
75 | + * @return \OC\Files\Cache\Propagator |
|
76 | + */ |
|
77 | + public function getPropagator($storage = null); |
|
78 | 78 | |
79 | - /** |
|
80 | - * get a updater instance for the cache |
|
81 | - * |
|
82 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
83 | - * @return \OC\Files\Cache\Updater |
|
84 | - */ |
|
85 | - public function getUpdater($storage = null); |
|
79 | + /** |
|
80 | + * get a updater instance for the cache |
|
81 | + * |
|
82 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
83 | + * @return \OC\Files\Cache\Updater |
|
84 | + */ |
|
85 | + public function getUpdater($storage = null); |
|
86 | 86 | |
87 | - /** |
|
88 | - * @return \OC\Files\Cache\Storage |
|
89 | - */ |
|
90 | - public function getStorageCache(); |
|
87 | + /** |
|
88 | + * @return \OC\Files\Cache\Storage |
|
89 | + */ |
|
90 | + public function getStorageCache(); |
|
91 | 91 | |
92 | - /** |
|
93 | - * @param string $path |
|
94 | - * @return array |
|
95 | - */ |
|
96 | - public function getMetaData($path); |
|
92 | + /** |
|
93 | + * @param string $path |
|
94 | + * @return array |
|
95 | + */ |
|
96 | + public function getMetaData($path); |
|
97 | 97 | |
98 | - /** |
|
99 | - * @param string $path The path of the file to acquire the lock for |
|
100 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
101 | - * @param \OCP\Lock\ILockingProvider $provider |
|
102 | - * @throws \OCP\Lock\LockedException |
|
103 | - */ |
|
104 | - public function acquireLock($path, $type, ILockingProvider $provider); |
|
98 | + /** |
|
99 | + * @param string $path The path of the file to acquire the lock for |
|
100 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
101 | + * @param \OCP\Lock\ILockingProvider $provider |
|
102 | + * @throws \OCP\Lock\LockedException |
|
103 | + */ |
|
104 | + public function acquireLock($path, $type, ILockingProvider $provider); |
|
105 | 105 | |
106 | - /** |
|
107 | - * @param string $path The path of the file to release the lock for |
|
108 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
109 | - * @param \OCP\Lock\ILockingProvider $provider |
|
110 | - * @throws \OCP\Lock\LockedException |
|
111 | - */ |
|
112 | - public function releaseLock($path, $type, ILockingProvider $provider); |
|
106 | + /** |
|
107 | + * @param string $path The path of the file to release the lock for |
|
108 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
109 | + * @param \OCP\Lock\ILockingProvider $provider |
|
110 | + * @throws \OCP\Lock\LockedException |
|
111 | + */ |
|
112 | + public function releaseLock($path, $type, ILockingProvider $provider); |
|
113 | 113 | |
114 | - /** |
|
115 | - * @param string $path The path of the file to change the lock for |
|
116 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
117 | - * @param \OCP\Lock\ILockingProvider $provider |
|
118 | - * @throws \OCP\Lock\LockedException |
|
119 | - */ |
|
120 | - public function changeLock($path, $type, ILockingProvider $provider); |
|
114 | + /** |
|
115 | + * @param string $path The path of the file to change the lock for |
|
116 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
117 | + * @param \OCP\Lock\ILockingProvider $provider |
|
118 | + * @throws \OCP\Lock\LockedException |
|
119 | + */ |
|
120 | + public function changeLock($path, $type, ILockingProvider $provider); |
|
121 | 121 | } |