@@ -35,398 +35,398 @@ |
||
35 | 35 | * External storage configuration |
36 | 36 | */ |
37 | 37 | class StorageConfig implements \JsonSerializable { |
38 | - const MOUNT_TYPE_ADMIN = 1; |
|
39 | - const MOUNT_TYPE_PERSONAl = 2; |
|
40 | - |
|
41 | - /** |
|
42 | - * Storage config id |
|
43 | - * |
|
44 | - * @var int |
|
45 | - */ |
|
46 | - private $id; |
|
47 | - |
|
48 | - /** |
|
49 | - * Backend |
|
50 | - * |
|
51 | - * @var Backend |
|
52 | - */ |
|
53 | - private $backend; |
|
54 | - |
|
55 | - /** |
|
56 | - * Authentication mechanism |
|
57 | - * |
|
58 | - * @var AuthMechanism |
|
59 | - */ |
|
60 | - private $authMechanism; |
|
61 | - |
|
62 | - /** |
|
63 | - * Backend options |
|
64 | - * |
|
65 | - * @var array |
|
66 | - */ |
|
67 | - private $backendOptions = []; |
|
68 | - |
|
69 | - /** |
|
70 | - * Mount point path, relative to the user's "files" folder |
|
71 | - * |
|
72 | - * @var string |
|
73 | - */ |
|
74 | - private $mountPoint; |
|
75 | - |
|
76 | - /** |
|
77 | - * Storage status |
|
78 | - * |
|
79 | - * @var int |
|
80 | - */ |
|
81 | - private $status; |
|
82 | - |
|
83 | - /** |
|
84 | - * Status message |
|
85 | - * |
|
86 | - * @var string |
|
87 | - */ |
|
88 | - private $statusMessage; |
|
89 | - |
|
90 | - /** |
|
91 | - * Priority |
|
92 | - * |
|
93 | - * @var int |
|
94 | - */ |
|
95 | - private $priority; |
|
96 | - |
|
97 | - /** |
|
98 | - * List of users who have access to this storage |
|
99 | - * |
|
100 | - * @var array |
|
101 | - */ |
|
102 | - private $applicableUsers = []; |
|
103 | - |
|
104 | - /** |
|
105 | - * List of groups that have access to this storage |
|
106 | - * |
|
107 | - * @var array |
|
108 | - */ |
|
109 | - private $applicableGroups = []; |
|
110 | - |
|
111 | - /** |
|
112 | - * Mount-specific options |
|
113 | - * |
|
114 | - * @var array |
|
115 | - */ |
|
116 | - private $mountOptions = []; |
|
117 | - |
|
118 | - /** |
|
119 | - * Whether it's a personal or admin mount |
|
120 | - * |
|
121 | - * @var int |
|
122 | - */ |
|
123 | - private $type; |
|
124 | - |
|
125 | - /** |
|
126 | - * Creates a storage config |
|
127 | - * |
|
128 | - * @param int|null $id config id or null for a new config |
|
129 | - */ |
|
130 | - public function __construct($id = null) { |
|
131 | - $this->id = $id; |
|
132 | - $this->mountOptions['enable_sharing'] = false; |
|
133 | - } |
|
134 | - |
|
135 | - /** |
|
136 | - * Returns the configuration id |
|
137 | - * |
|
138 | - * @return int |
|
139 | - */ |
|
140 | - public function getId() { |
|
141 | - return $this->id; |
|
142 | - } |
|
143 | - |
|
144 | - /** |
|
145 | - * Sets the configuration id |
|
146 | - * |
|
147 | - * @param int $id configuration id |
|
148 | - */ |
|
149 | - public function setId($id) { |
|
150 | - $this->id = $id; |
|
151 | - } |
|
152 | - |
|
153 | - /** |
|
154 | - * Returns mount point path relative to the user's |
|
155 | - * "files" folder. |
|
156 | - * |
|
157 | - * @return string path |
|
158 | - */ |
|
159 | - public function getMountPoint() { |
|
160 | - return $this->mountPoint; |
|
161 | - } |
|
162 | - |
|
163 | - /** |
|
164 | - * Sets mount point path relative to the user's |
|
165 | - * "files" folder. |
|
166 | - * The path will be normalized. |
|
167 | - * |
|
168 | - * @param string $mountPoint path |
|
169 | - */ |
|
170 | - public function setMountPoint($mountPoint) { |
|
171 | - $this->mountPoint = \OC\Files\Filesystem::normalizePath($mountPoint); |
|
172 | - } |
|
173 | - |
|
174 | - /** |
|
175 | - * @return Backend |
|
176 | - */ |
|
177 | - public function getBackend() { |
|
178 | - return $this->backend; |
|
179 | - } |
|
180 | - |
|
181 | - /** |
|
182 | - * @param Backend $backend |
|
183 | - */ |
|
184 | - public function setBackend(Backend $backend) { |
|
185 | - $this->backend= $backend; |
|
186 | - } |
|
187 | - |
|
188 | - /** |
|
189 | - * @return AuthMechanism |
|
190 | - */ |
|
191 | - public function getAuthMechanism() { |
|
192 | - return $this->authMechanism; |
|
193 | - } |
|
194 | - |
|
195 | - /** |
|
196 | - * @param AuthMechanism $authMechanism |
|
197 | - */ |
|
198 | - public function setAuthMechanism(AuthMechanism $authMechanism) { |
|
199 | - $this->authMechanism = $authMechanism; |
|
200 | - } |
|
201 | - |
|
202 | - /** |
|
203 | - * Returns the external storage backend-specific options |
|
204 | - * |
|
205 | - * @return array backend options |
|
206 | - */ |
|
207 | - public function getBackendOptions() { |
|
208 | - return $this->backendOptions; |
|
209 | - } |
|
210 | - |
|
211 | - /** |
|
212 | - * Sets the external storage backend-specific options |
|
213 | - * |
|
214 | - * @param array $backendOptions backend options |
|
215 | - */ |
|
216 | - public function setBackendOptions($backendOptions) { |
|
217 | - if($this->getBackend() instanceof Backend) { |
|
218 | - $parameters = $this->getBackend()->getParameters(); |
|
219 | - foreach($backendOptions as $key => $value) { |
|
220 | - if(isset($parameters[$key])) { |
|
221 | - switch ($parameters[$key]->getType()) { |
|
222 | - case \OCA\Files_External\Lib\DefinitionParameter::VALUE_BOOLEAN: |
|
223 | - $value = (bool)$value; |
|
224 | - break; |
|
225 | - } |
|
226 | - $backendOptions[$key] = $value; |
|
227 | - } |
|
228 | - } |
|
229 | - } |
|
230 | - |
|
231 | - $this->backendOptions = $backendOptions; |
|
232 | - } |
|
233 | - |
|
234 | - /** |
|
235 | - * @param string $key |
|
236 | - * @return mixed |
|
237 | - */ |
|
238 | - public function getBackendOption($key) { |
|
239 | - if (isset($this->backendOptions[$key])) { |
|
240 | - return $this->backendOptions[$key]; |
|
241 | - } |
|
242 | - return null; |
|
243 | - } |
|
244 | - |
|
245 | - /** |
|
246 | - * @param string $key |
|
247 | - * @param mixed $value |
|
248 | - */ |
|
249 | - public function setBackendOption($key, $value) { |
|
250 | - $this->backendOptions[$key] = $value; |
|
251 | - } |
|
252 | - |
|
253 | - /** |
|
254 | - * Returns the mount priority |
|
255 | - * |
|
256 | - * @return int priority |
|
257 | - */ |
|
258 | - public function getPriority() { |
|
259 | - return $this->priority; |
|
260 | - } |
|
261 | - |
|
262 | - /** |
|
263 | - * Sets the mount priotity |
|
264 | - * |
|
265 | - * @param int $priority priority |
|
266 | - */ |
|
267 | - public function setPriority($priority) { |
|
268 | - $this->priority = $priority; |
|
269 | - } |
|
270 | - |
|
271 | - /** |
|
272 | - * Returns the users for which to mount this storage |
|
273 | - * |
|
274 | - * @return array applicable users |
|
275 | - */ |
|
276 | - public function getApplicableUsers() { |
|
277 | - return $this->applicableUsers; |
|
278 | - } |
|
279 | - |
|
280 | - /** |
|
281 | - * Sets the users for which to mount this storage |
|
282 | - * |
|
283 | - * @param array|null $applicableUsers applicable users |
|
284 | - */ |
|
285 | - public function setApplicableUsers($applicableUsers) { |
|
286 | - if (is_null($applicableUsers)) { |
|
287 | - $applicableUsers = []; |
|
288 | - } |
|
289 | - $this->applicableUsers = $applicableUsers; |
|
290 | - } |
|
291 | - |
|
292 | - /** |
|
293 | - * Returns the groups for which to mount this storage |
|
294 | - * |
|
295 | - * @return array applicable groups |
|
296 | - */ |
|
297 | - public function getApplicableGroups() { |
|
298 | - return $this->applicableGroups; |
|
299 | - } |
|
300 | - |
|
301 | - /** |
|
302 | - * Sets the groups for which to mount this storage |
|
303 | - * |
|
304 | - * @param array|null $applicableGroups applicable groups |
|
305 | - */ |
|
306 | - public function setApplicableGroups($applicableGroups) { |
|
307 | - if (is_null($applicableGroups)) { |
|
308 | - $applicableGroups = []; |
|
309 | - } |
|
310 | - $this->applicableGroups = $applicableGroups; |
|
311 | - } |
|
312 | - |
|
313 | - /** |
|
314 | - * Returns the mount-specific options |
|
315 | - * |
|
316 | - * @return array mount specific options |
|
317 | - */ |
|
318 | - public function getMountOptions() { |
|
319 | - return $this->mountOptions; |
|
320 | - } |
|
321 | - |
|
322 | - /** |
|
323 | - * Sets the mount-specific options |
|
324 | - * |
|
325 | - * @param array $mountOptions applicable groups |
|
326 | - */ |
|
327 | - public function setMountOptions($mountOptions) { |
|
328 | - if (is_null($mountOptions)) { |
|
329 | - $mountOptions = []; |
|
330 | - } |
|
331 | - $this->mountOptions = $mountOptions; |
|
332 | - } |
|
333 | - |
|
334 | - /** |
|
335 | - * @param string $key |
|
336 | - * @return mixed |
|
337 | - */ |
|
338 | - public function getMountOption($key) { |
|
339 | - if (isset($this->mountOptions[$key])) { |
|
340 | - return $this->mountOptions[$key]; |
|
341 | - } |
|
342 | - return null; |
|
343 | - } |
|
344 | - |
|
345 | - /** |
|
346 | - * @param string $key |
|
347 | - * @param mixed $value |
|
348 | - */ |
|
349 | - public function setMountOption($key, $value) { |
|
350 | - $this->mountOptions[$key] = $value; |
|
351 | - } |
|
352 | - |
|
353 | - /** |
|
354 | - * Gets the storage status, whether the config worked last time |
|
355 | - * |
|
356 | - * @return int $status status |
|
357 | - */ |
|
358 | - public function getStatus() { |
|
359 | - return $this->status; |
|
360 | - } |
|
361 | - |
|
362 | - /** |
|
363 | - * Gets the message describing the storage status |
|
364 | - * |
|
365 | - * @return string|null |
|
366 | - */ |
|
367 | - public function getStatusMessage() { |
|
368 | - return $this->statusMessage; |
|
369 | - } |
|
370 | - |
|
371 | - /** |
|
372 | - * Sets the storage status, whether the config worked last time |
|
373 | - * |
|
374 | - * @param int $status status |
|
375 | - * @param string|null $message optional message |
|
376 | - */ |
|
377 | - public function setStatus($status, $message = null) { |
|
378 | - $this->status = $status; |
|
379 | - $this->statusMessage = $message; |
|
380 | - } |
|
381 | - |
|
382 | - /** |
|
383 | - * @return int self::MOUNT_TYPE_ADMIN or self::MOUNT_TYPE_PERSONAl |
|
384 | - */ |
|
385 | - public function getType() { |
|
386 | - return $this->type; |
|
387 | - } |
|
388 | - |
|
389 | - /** |
|
390 | - * @param int $type self::MOUNT_TYPE_ADMIN or self::MOUNT_TYPE_PERSONAl |
|
391 | - */ |
|
392 | - public function setType($type) { |
|
393 | - $this->type = $type; |
|
394 | - } |
|
395 | - |
|
396 | - /** |
|
397 | - * Serialize config to JSON |
|
398 | - * |
|
399 | - * @return array |
|
400 | - */ |
|
401 | - public function jsonSerialize() { |
|
402 | - $result = []; |
|
403 | - if (!is_null($this->id)) { |
|
404 | - $result['id'] = $this->id; |
|
405 | - } |
|
406 | - $result['mountPoint'] = $this->mountPoint; |
|
407 | - $result['backend'] = $this->backend->getIdentifier(); |
|
408 | - $result['authMechanism'] = $this->authMechanism->getIdentifier(); |
|
409 | - $result['backendOptions'] = $this->backendOptions; |
|
410 | - if (!is_null($this->priority)) { |
|
411 | - $result['priority'] = $this->priority; |
|
412 | - } |
|
413 | - if (!empty($this->applicableUsers)) { |
|
414 | - $result['applicableUsers'] = $this->applicableUsers; |
|
415 | - } |
|
416 | - if (!empty($this->applicableGroups)) { |
|
417 | - $result['applicableGroups'] = $this->applicableGroups; |
|
418 | - } |
|
419 | - if (!empty($this->mountOptions)) { |
|
420 | - $result['mountOptions'] = $this->mountOptions; |
|
421 | - } |
|
422 | - if (!is_null($this->status)) { |
|
423 | - $result['status'] = $this->status; |
|
424 | - } |
|
425 | - if (!is_null($this->statusMessage)) { |
|
426 | - $result['statusMessage'] = $this->statusMessage; |
|
427 | - } |
|
428 | - $result['userProvided'] = $this->authMechanism instanceof IUserProvided; |
|
429 | - $result['type'] = ($this->getType() === self::MOUNT_TYPE_PERSONAl) ? 'personal': 'system'; |
|
430 | - return $result; |
|
431 | - } |
|
38 | + const MOUNT_TYPE_ADMIN = 1; |
|
39 | + const MOUNT_TYPE_PERSONAl = 2; |
|
40 | + |
|
41 | + /** |
|
42 | + * Storage config id |
|
43 | + * |
|
44 | + * @var int |
|
45 | + */ |
|
46 | + private $id; |
|
47 | + |
|
48 | + /** |
|
49 | + * Backend |
|
50 | + * |
|
51 | + * @var Backend |
|
52 | + */ |
|
53 | + private $backend; |
|
54 | + |
|
55 | + /** |
|
56 | + * Authentication mechanism |
|
57 | + * |
|
58 | + * @var AuthMechanism |
|
59 | + */ |
|
60 | + private $authMechanism; |
|
61 | + |
|
62 | + /** |
|
63 | + * Backend options |
|
64 | + * |
|
65 | + * @var array |
|
66 | + */ |
|
67 | + private $backendOptions = []; |
|
68 | + |
|
69 | + /** |
|
70 | + * Mount point path, relative to the user's "files" folder |
|
71 | + * |
|
72 | + * @var string |
|
73 | + */ |
|
74 | + private $mountPoint; |
|
75 | + |
|
76 | + /** |
|
77 | + * Storage status |
|
78 | + * |
|
79 | + * @var int |
|
80 | + */ |
|
81 | + private $status; |
|
82 | + |
|
83 | + /** |
|
84 | + * Status message |
|
85 | + * |
|
86 | + * @var string |
|
87 | + */ |
|
88 | + private $statusMessage; |
|
89 | + |
|
90 | + /** |
|
91 | + * Priority |
|
92 | + * |
|
93 | + * @var int |
|
94 | + */ |
|
95 | + private $priority; |
|
96 | + |
|
97 | + /** |
|
98 | + * List of users who have access to this storage |
|
99 | + * |
|
100 | + * @var array |
|
101 | + */ |
|
102 | + private $applicableUsers = []; |
|
103 | + |
|
104 | + /** |
|
105 | + * List of groups that have access to this storage |
|
106 | + * |
|
107 | + * @var array |
|
108 | + */ |
|
109 | + private $applicableGroups = []; |
|
110 | + |
|
111 | + /** |
|
112 | + * Mount-specific options |
|
113 | + * |
|
114 | + * @var array |
|
115 | + */ |
|
116 | + private $mountOptions = []; |
|
117 | + |
|
118 | + /** |
|
119 | + * Whether it's a personal or admin mount |
|
120 | + * |
|
121 | + * @var int |
|
122 | + */ |
|
123 | + private $type; |
|
124 | + |
|
125 | + /** |
|
126 | + * Creates a storage config |
|
127 | + * |
|
128 | + * @param int|null $id config id or null for a new config |
|
129 | + */ |
|
130 | + public function __construct($id = null) { |
|
131 | + $this->id = $id; |
|
132 | + $this->mountOptions['enable_sharing'] = false; |
|
133 | + } |
|
134 | + |
|
135 | + /** |
|
136 | + * Returns the configuration id |
|
137 | + * |
|
138 | + * @return int |
|
139 | + */ |
|
140 | + public function getId() { |
|
141 | + return $this->id; |
|
142 | + } |
|
143 | + |
|
144 | + /** |
|
145 | + * Sets the configuration id |
|
146 | + * |
|
147 | + * @param int $id configuration id |
|
148 | + */ |
|
149 | + public function setId($id) { |
|
150 | + $this->id = $id; |
|
151 | + } |
|
152 | + |
|
153 | + /** |
|
154 | + * Returns mount point path relative to the user's |
|
155 | + * "files" folder. |
|
156 | + * |
|
157 | + * @return string path |
|
158 | + */ |
|
159 | + public function getMountPoint() { |
|
160 | + return $this->mountPoint; |
|
161 | + } |
|
162 | + |
|
163 | + /** |
|
164 | + * Sets mount point path relative to the user's |
|
165 | + * "files" folder. |
|
166 | + * The path will be normalized. |
|
167 | + * |
|
168 | + * @param string $mountPoint path |
|
169 | + */ |
|
170 | + public function setMountPoint($mountPoint) { |
|
171 | + $this->mountPoint = \OC\Files\Filesystem::normalizePath($mountPoint); |
|
172 | + } |
|
173 | + |
|
174 | + /** |
|
175 | + * @return Backend |
|
176 | + */ |
|
177 | + public function getBackend() { |
|
178 | + return $this->backend; |
|
179 | + } |
|
180 | + |
|
181 | + /** |
|
182 | + * @param Backend $backend |
|
183 | + */ |
|
184 | + public function setBackend(Backend $backend) { |
|
185 | + $this->backend= $backend; |
|
186 | + } |
|
187 | + |
|
188 | + /** |
|
189 | + * @return AuthMechanism |
|
190 | + */ |
|
191 | + public function getAuthMechanism() { |
|
192 | + return $this->authMechanism; |
|
193 | + } |
|
194 | + |
|
195 | + /** |
|
196 | + * @param AuthMechanism $authMechanism |
|
197 | + */ |
|
198 | + public function setAuthMechanism(AuthMechanism $authMechanism) { |
|
199 | + $this->authMechanism = $authMechanism; |
|
200 | + } |
|
201 | + |
|
202 | + /** |
|
203 | + * Returns the external storage backend-specific options |
|
204 | + * |
|
205 | + * @return array backend options |
|
206 | + */ |
|
207 | + public function getBackendOptions() { |
|
208 | + return $this->backendOptions; |
|
209 | + } |
|
210 | + |
|
211 | + /** |
|
212 | + * Sets the external storage backend-specific options |
|
213 | + * |
|
214 | + * @param array $backendOptions backend options |
|
215 | + */ |
|
216 | + public function setBackendOptions($backendOptions) { |
|
217 | + if($this->getBackend() instanceof Backend) { |
|
218 | + $parameters = $this->getBackend()->getParameters(); |
|
219 | + foreach($backendOptions as $key => $value) { |
|
220 | + if(isset($parameters[$key])) { |
|
221 | + switch ($parameters[$key]->getType()) { |
|
222 | + case \OCA\Files_External\Lib\DefinitionParameter::VALUE_BOOLEAN: |
|
223 | + $value = (bool)$value; |
|
224 | + break; |
|
225 | + } |
|
226 | + $backendOptions[$key] = $value; |
|
227 | + } |
|
228 | + } |
|
229 | + } |
|
230 | + |
|
231 | + $this->backendOptions = $backendOptions; |
|
232 | + } |
|
233 | + |
|
234 | + /** |
|
235 | + * @param string $key |
|
236 | + * @return mixed |
|
237 | + */ |
|
238 | + public function getBackendOption($key) { |
|
239 | + if (isset($this->backendOptions[$key])) { |
|
240 | + return $this->backendOptions[$key]; |
|
241 | + } |
|
242 | + return null; |
|
243 | + } |
|
244 | + |
|
245 | + /** |
|
246 | + * @param string $key |
|
247 | + * @param mixed $value |
|
248 | + */ |
|
249 | + public function setBackendOption($key, $value) { |
|
250 | + $this->backendOptions[$key] = $value; |
|
251 | + } |
|
252 | + |
|
253 | + /** |
|
254 | + * Returns the mount priority |
|
255 | + * |
|
256 | + * @return int priority |
|
257 | + */ |
|
258 | + public function getPriority() { |
|
259 | + return $this->priority; |
|
260 | + } |
|
261 | + |
|
262 | + /** |
|
263 | + * Sets the mount priotity |
|
264 | + * |
|
265 | + * @param int $priority priority |
|
266 | + */ |
|
267 | + public function setPriority($priority) { |
|
268 | + $this->priority = $priority; |
|
269 | + } |
|
270 | + |
|
271 | + /** |
|
272 | + * Returns the users for which to mount this storage |
|
273 | + * |
|
274 | + * @return array applicable users |
|
275 | + */ |
|
276 | + public function getApplicableUsers() { |
|
277 | + return $this->applicableUsers; |
|
278 | + } |
|
279 | + |
|
280 | + /** |
|
281 | + * Sets the users for which to mount this storage |
|
282 | + * |
|
283 | + * @param array|null $applicableUsers applicable users |
|
284 | + */ |
|
285 | + public function setApplicableUsers($applicableUsers) { |
|
286 | + if (is_null($applicableUsers)) { |
|
287 | + $applicableUsers = []; |
|
288 | + } |
|
289 | + $this->applicableUsers = $applicableUsers; |
|
290 | + } |
|
291 | + |
|
292 | + /** |
|
293 | + * Returns the groups for which to mount this storage |
|
294 | + * |
|
295 | + * @return array applicable groups |
|
296 | + */ |
|
297 | + public function getApplicableGroups() { |
|
298 | + return $this->applicableGroups; |
|
299 | + } |
|
300 | + |
|
301 | + /** |
|
302 | + * Sets the groups for which to mount this storage |
|
303 | + * |
|
304 | + * @param array|null $applicableGroups applicable groups |
|
305 | + */ |
|
306 | + public function setApplicableGroups($applicableGroups) { |
|
307 | + if (is_null($applicableGroups)) { |
|
308 | + $applicableGroups = []; |
|
309 | + } |
|
310 | + $this->applicableGroups = $applicableGroups; |
|
311 | + } |
|
312 | + |
|
313 | + /** |
|
314 | + * Returns the mount-specific options |
|
315 | + * |
|
316 | + * @return array mount specific options |
|
317 | + */ |
|
318 | + public function getMountOptions() { |
|
319 | + return $this->mountOptions; |
|
320 | + } |
|
321 | + |
|
322 | + /** |
|
323 | + * Sets the mount-specific options |
|
324 | + * |
|
325 | + * @param array $mountOptions applicable groups |
|
326 | + */ |
|
327 | + public function setMountOptions($mountOptions) { |
|
328 | + if (is_null($mountOptions)) { |
|
329 | + $mountOptions = []; |
|
330 | + } |
|
331 | + $this->mountOptions = $mountOptions; |
|
332 | + } |
|
333 | + |
|
334 | + /** |
|
335 | + * @param string $key |
|
336 | + * @return mixed |
|
337 | + */ |
|
338 | + public function getMountOption($key) { |
|
339 | + if (isset($this->mountOptions[$key])) { |
|
340 | + return $this->mountOptions[$key]; |
|
341 | + } |
|
342 | + return null; |
|
343 | + } |
|
344 | + |
|
345 | + /** |
|
346 | + * @param string $key |
|
347 | + * @param mixed $value |
|
348 | + */ |
|
349 | + public function setMountOption($key, $value) { |
|
350 | + $this->mountOptions[$key] = $value; |
|
351 | + } |
|
352 | + |
|
353 | + /** |
|
354 | + * Gets the storage status, whether the config worked last time |
|
355 | + * |
|
356 | + * @return int $status status |
|
357 | + */ |
|
358 | + public function getStatus() { |
|
359 | + return $this->status; |
|
360 | + } |
|
361 | + |
|
362 | + /** |
|
363 | + * Gets the message describing the storage status |
|
364 | + * |
|
365 | + * @return string|null |
|
366 | + */ |
|
367 | + public function getStatusMessage() { |
|
368 | + return $this->statusMessage; |
|
369 | + } |
|
370 | + |
|
371 | + /** |
|
372 | + * Sets the storage status, whether the config worked last time |
|
373 | + * |
|
374 | + * @param int $status status |
|
375 | + * @param string|null $message optional message |
|
376 | + */ |
|
377 | + public function setStatus($status, $message = null) { |
|
378 | + $this->status = $status; |
|
379 | + $this->statusMessage = $message; |
|
380 | + } |
|
381 | + |
|
382 | + /** |
|
383 | + * @return int self::MOUNT_TYPE_ADMIN or self::MOUNT_TYPE_PERSONAl |
|
384 | + */ |
|
385 | + public function getType() { |
|
386 | + return $this->type; |
|
387 | + } |
|
388 | + |
|
389 | + /** |
|
390 | + * @param int $type self::MOUNT_TYPE_ADMIN or self::MOUNT_TYPE_PERSONAl |
|
391 | + */ |
|
392 | + public function setType($type) { |
|
393 | + $this->type = $type; |
|
394 | + } |
|
395 | + |
|
396 | + /** |
|
397 | + * Serialize config to JSON |
|
398 | + * |
|
399 | + * @return array |
|
400 | + */ |
|
401 | + public function jsonSerialize() { |
|
402 | + $result = []; |
|
403 | + if (!is_null($this->id)) { |
|
404 | + $result['id'] = $this->id; |
|
405 | + } |
|
406 | + $result['mountPoint'] = $this->mountPoint; |
|
407 | + $result['backend'] = $this->backend->getIdentifier(); |
|
408 | + $result['authMechanism'] = $this->authMechanism->getIdentifier(); |
|
409 | + $result['backendOptions'] = $this->backendOptions; |
|
410 | + if (!is_null($this->priority)) { |
|
411 | + $result['priority'] = $this->priority; |
|
412 | + } |
|
413 | + if (!empty($this->applicableUsers)) { |
|
414 | + $result['applicableUsers'] = $this->applicableUsers; |
|
415 | + } |
|
416 | + if (!empty($this->applicableGroups)) { |
|
417 | + $result['applicableGroups'] = $this->applicableGroups; |
|
418 | + } |
|
419 | + if (!empty($this->mountOptions)) { |
|
420 | + $result['mountOptions'] = $this->mountOptions; |
|
421 | + } |
|
422 | + if (!is_null($this->status)) { |
|
423 | + $result['status'] = $this->status; |
|
424 | + } |
|
425 | + if (!is_null($this->statusMessage)) { |
|
426 | + $result['statusMessage'] = $this->statusMessage; |
|
427 | + } |
|
428 | + $result['userProvided'] = $this->authMechanism instanceof IUserProvided; |
|
429 | + $result['type'] = ($this->getType() === self::MOUNT_TYPE_PERSONAl) ? 'personal': 'system'; |
|
430 | + return $result; |
|
431 | + } |
|
432 | 432 | } |
@@ -33,73 +33,73 @@ |
||
33 | 33 | */ |
34 | 34 | class LegacyBackend extends Backend { |
35 | 35 | |
36 | - use LegacyDependencyCheckPolyfill { |
|
37 | - LegacyDependencyCheckPolyfill::checkDependencies as doCheckDependencies; |
|
38 | - } |
|
36 | + use LegacyDependencyCheckPolyfill { |
|
37 | + LegacyDependencyCheckPolyfill::checkDependencies as doCheckDependencies; |
|
38 | + } |
|
39 | 39 | |
40 | - /** @var bool */ |
|
41 | - protected $hasDependencies = false; |
|
40 | + /** @var bool */ |
|
41 | + protected $hasDependencies = false; |
|
42 | 42 | |
43 | - /** |
|
44 | - * @param string $class |
|
45 | - * @param array $definition |
|
46 | - * @param Builtin $authMechanism |
|
47 | - */ |
|
48 | - public function __construct($class, array $definition, Builtin $authMechanism) { |
|
49 | - $this |
|
50 | - ->setIdentifier($class) |
|
51 | - ->setStorageClass($class) |
|
52 | - ->setText($definition['backend']) |
|
53 | - ->addAuthScheme(Builtin::SCHEME_BUILTIN) |
|
54 | - ->setLegacyAuthMechanism($authMechanism) |
|
55 | - ; |
|
43 | + /** |
|
44 | + * @param string $class |
|
45 | + * @param array $definition |
|
46 | + * @param Builtin $authMechanism |
|
47 | + */ |
|
48 | + public function __construct($class, array $definition, Builtin $authMechanism) { |
|
49 | + $this |
|
50 | + ->setIdentifier($class) |
|
51 | + ->setStorageClass($class) |
|
52 | + ->setText($definition['backend']) |
|
53 | + ->addAuthScheme(Builtin::SCHEME_BUILTIN) |
|
54 | + ->setLegacyAuthMechanism($authMechanism) |
|
55 | + ; |
|
56 | 56 | |
57 | - foreach ($definition['configuration'] as $name => $placeholder) { |
|
58 | - $flags = DefinitionParameter::FLAG_NONE; |
|
59 | - $type = DefinitionParameter::VALUE_TEXT; |
|
60 | - if ($placeholder[0] === '&') { |
|
61 | - $flags = DefinitionParameter::FLAG_OPTIONAL; |
|
62 | - $placeholder = substr($placeholder, 1); |
|
63 | - } |
|
64 | - switch ($placeholder[0]) { |
|
65 | - case '!': |
|
66 | - $type = DefinitionParameter::VALUE_BOOLEAN; |
|
67 | - $placeholder = substr($placeholder, 1); |
|
68 | - break; |
|
69 | - case '*': |
|
70 | - $type = DefinitionParameter::VALUE_PASSWORD; |
|
71 | - $placeholder = substr($placeholder, 1); |
|
72 | - break; |
|
73 | - case '#': |
|
74 | - $type = DefinitionParameter::VALUE_HIDDEN; |
|
75 | - $placeholder = substr($placeholder, 1); |
|
76 | - break; |
|
77 | - } |
|
78 | - $this->addParameter((new DefinitionParameter($name, $placeholder)) |
|
79 | - ->setType($type) |
|
80 | - ->setFlags($flags) |
|
81 | - ); |
|
82 | - } |
|
57 | + foreach ($definition['configuration'] as $name => $placeholder) { |
|
58 | + $flags = DefinitionParameter::FLAG_NONE; |
|
59 | + $type = DefinitionParameter::VALUE_TEXT; |
|
60 | + if ($placeholder[0] === '&') { |
|
61 | + $flags = DefinitionParameter::FLAG_OPTIONAL; |
|
62 | + $placeholder = substr($placeholder, 1); |
|
63 | + } |
|
64 | + switch ($placeholder[0]) { |
|
65 | + case '!': |
|
66 | + $type = DefinitionParameter::VALUE_BOOLEAN; |
|
67 | + $placeholder = substr($placeholder, 1); |
|
68 | + break; |
|
69 | + case '*': |
|
70 | + $type = DefinitionParameter::VALUE_PASSWORD; |
|
71 | + $placeholder = substr($placeholder, 1); |
|
72 | + break; |
|
73 | + case '#': |
|
74 | + $type = DefinitionParameter::VALUE_HIDDEN; |
|
75 | + $placeholder = substr($placeholder, 1); |
|
76 | + break; |
|
77 | + } |
|
78 | + $this->addParameter((new DefinitionParameter($name, $placeholder)) |
|
79 | + ->setType($type) |
|
80 | + ->setFlags($flags) |
|
81 | + ); |
|
82 | + } |
|
83 | 83 | |
84 | - if (isset($definition['priority'])) { |
|
85 | - $this->setPriority($definition['priority']); |
|
86 | - } |
|
87 | - if (isset($definition['custom'])) { |
|
88 | - $this->addCustomJs($definition['custom']); |
|
89 | - } |
|
90 | - if (isset($definition['has_dependencies']) && $definition['has_dependencies']) { |
|
91 | - $this->hasDependencies = true; |
|
92 | - } |
|
93 | - } |
|
84 | + if (isset($definition['priority'])) { |
|
85 | + $this->setPriority($definition['priority']); |
|
86 | + } |
|
87 | + if (isset($definition['custom'])) { |
|
88 | + $this->addCustomJs($definition['custom']); |
|
89 | + } |
|
90 | + if (isset($definition['has_dependencies']) && $definition['has_dependencies']) { |
|
91 | + $this->hasDependencies = true; |
|
92 | + } |
|
93 | + } |
|
94 | 94 | |
95 | - /** |
|
96 | - * @return MissingDependency[] |
|
97 | - */ |
|
98 | - public function checkDependencies() { |
|
99 | - if ($this->hasDependencies) { |
|
100 | - return $this->doCheckDependencies(); |
|
101 | - } |
|
102 | - return []; |
|
103 | - } |
|
95 | + /** |
|
96 | + * @return MissingDependency[] |
|
97 | + */ |
|
98 | + public function checkDependencies() { |
|
99 | + if ($this->hasDependencies) { |
|
100 | + return $this->doCheckDependencies(); |
|
101 | + } |
|
102 | + return []; |
|
103 | + } |
|
104 | 104 | |
105 | 105 | } |
@@ -27,39 +27,39 @@ |
||
27 | 27 | */ |
28 | 28 | class MissingDependency { |
29 | 29 | |
30 | - /** @var string */ |
|
31 | - private $dependency; |
|
30 | + /** @var string */ |
|
31 | + private $dependency; |
|
32 | 32 | |
33 | - /** @var string|null Custom message */ |
|
34 | - private $message = null; |
|
33 | + /** @var string|null Custom message */ |
|
34 | + private $message = null; |
|
35 | 35 | |
36 | - /** |
|
37 | - * @param string $dependency |
|
38 | - */ |
|
39 | - public function __construct($dependency) { |
|
40 | - $this->dependency = $dependency; |
|
41 | - } |
|
36 | + /** |
|
37 | + * @param string $dependency |
|
38 | + */ |
|
39 | + public function __construct($dependency) { |
|
40 | + $this->dependency = $dependency; |
|
41 | + } |
|
42 | 42 | |
43 | - /** |
|
44 | - * @return string |
|
45 | - */ |
|
46 | - public function getDependency() { |
|
47 | - return $this->dependency; |
|
48 | - } |
|
43 | + /** |
|
44 | + * @return string |
|
45 | + */ |
|
46 | + public function getDependency() { |
|
47 | + return $this->dependency; |
|
48 | + } |
|
49 | 49 | |
50 | - /** |
|
51 | - * @return string|null |
|
52 | - */ |
|
53 | - public function getMessage() { |
|
54 | - return $this->message; |
|
55 | - } |
|
50 | + /** |
|
51 | + * @return string|null |
|
52 | + */ |
|
53 | + public function getMessage() { |
|
54 | + return $this->message; |
|
55 | + } |
|
56 | 56 | |
57 | - /** |
|
58 | - * @param string $message |
|
59 | - * @return self |
|
60 | - */ |
|
61 | - public function setMessage($message) { |
|
62 | - $this->message = $message; |
|
63 | - return $this; |
|
64 | - } |
|
57 | + /** |
|
58 | + * @param string $message |
|
59 | + * @return self |
|
60 | + */ |
|
61 | + public function setMessage($message) { |
|
62 | + $this->message = $message; |
|
63 | + return $this; |
|
64 | + } |
|
65 | 65 | } |
@@ -29,14 +29,14 @@ |
||
29 | 29 | */ |
30 | 30 | trait DependencyTrait { |
31 | 31 | |
32 | - /** |
|
33 | - * Check if object is valid for use |
|
34 | - * |
|
35 | - * @return MissingDependency[] Unsatisfied dependencies |
|
36 | - */ |
|
37 | - public function checkDependencies() { |
|
38 | - return []; // no dependencies by default |
|
39 | - } |
|
32 | + /** |
|
33 | + * Check if object is valid for use |
|
34 | + * |
|
35 | + * @return MissingDependency[] Unsatisfied dependencies |
|
36 | + */ |
|
37 | + public function checkDependencies() { |
|
38 | + return []; // no dependencies by default |
|
39 | + } |
|
40 | 40 | |
41 | 41 | } |
42 | 42 |
@@ -27,72 +27,72 @@ |
||
27 | 27 | |
28 | 28 | class Setting implements ISetting { |
29 | 29 | |
30 | - /** @var IL10N */ |
|
31 | - protected $l; |
|
30 | + /** @var IL10N */ |
|
31 | + protected $l; |
|
32 | 32 | |
33 | - /** |
|
34 | - * @param IL10N $l |
|
35 | - */ |
|
36 | - public function __construct(IL10N $l) { |
|
37 | - $this->l = $l; |
|
38 | - } |
|
33 | + /** |
|
34 | + * @param IL10N $l |
|
35 | + */ |
|
36 | + public function __construct(IL10N $l) { |
|
37 | + $this->l = $l; |
|
38 | + } |
|
39 | 39 | |
40 | - /** |
|
41 | - * @return string Lowercase a-z and underscore only identifier |
|
42 | - * @since 11.0.0 |
|
43 | - */ |
|
44 | - public function getIdentifier() { |
|
45 | - return 'systemtags'; |
|
46 | - } |
|
40 | + /** |
|
41 | + * @return string Lowercase a-z and underscore only identifier |
|
42 | + * @since 11.0.0 |
|
43 | + */ |
|
44 | + public function getIdentifier() { |
|
45 | + return 'systemtags'; |
|
46 | + } |
|
47 | 47 | |
48 | - /** |
|
49 | - * @return string A translated string |
|
50 | - * @since 11.0.0 |
|
51 | - */ |
|
52 | - public function getName() { |
|
53 | - return $this->l->t('<strong>System tags</strong> for a file have been modified'); |
|
54 | - } |
|
48 | + /** |
|
49 | + * @return string A translated string |
|
50 | + * @since 11.0.0 |
|
51 | + */ |
|
52 | + public function getName() { |
|
53 | + return $this->l->t('<strong>System tags</strong> for a file have been modified'); |
|
54 | + } |
|
55 | 55 | |
56 | - /** |
|
57 | - * @return int whether the filter should be rather on the top or bottom of |
|
58 | - * the admin section. The filters are arranged in ascending order of the |
|
59 | - * priority values. It is required to return a value between 0 and 100. |
|
60 | - * @since 11.0.0 |
|
61 | - */ |
|
62 | - public function getPriority() { |
|
63 | - return 50; |
|
64 | - } |
|
56 | + /** |
|
57 | + * @return int whether the filter should be rather on the top or bottom of |
|
58 | + * the admin section. The filters are arranged in ascending order of the |
|
59 | + * priority values. It is required to return a value between 0 and 100. |
|
60 | + * @since 11.0.0 |
|
61 | + */ |
|
62 | + public function getPriority() { |
|
63 | + return 50; |
|
64 | + } |
|
65 | 65 | |
66 | - /** |
|
67 | - * @return bool True when the option can be changed for the stream |
|
68 | - * @since 11.0.0 |
|
69 | - */ |
|
70 | - public function canChangeStream() { |
|
71 | - return true; |
|
72 | - } |
|
66 | + /** |
|
67 | + * @return bool True when the option can be changed for the stream |
|
68 | + * @since 11.0.0 |
|
69 | + */ |
|
70 | + public function canChangeStream() { |
|
71 | + return true; |
|
72 | + } |
|
73 | 73 | |
74 | - /** |
|
75 | - * @return bool True when the option can be changed for the stream |
|
76 | - * @since 11.0.0 |
|
77 | - */ |
|
78 | - public function isDefaultEnabledStream() { |
|
79 | - return true; |
|
80 | - } |
|
74 | + /** |
|
75 | + * @return bool True when the option can be changed for the stream |
|
76 | + * @since 11.0.0 |
|
77 | + */ |
|
78 | + public function isDefaultEnabledStream() { |
|
79 | + return true; |
|
80 | + } |
|
81 | 81 | |
82 | - /** |
|
83 | - * @return bool True when the option can be changed for the mail |
|
84 | - * @since 11.0.0 |
|
85 | - */ |
|
86 | - public function canChangeMail() { |
|
87 | - return true; |
|
88 | - } |
|
82 | + /** |
|
83 | + * @return bool True when the option can be changed for the mail |
|
84 | + * @since 11.0.0 |
|
85 | + */ |
|
86 | + public function canChangeMail() { |
|
87 | + return true; |
|
88 | + } |
|
89 | 89 | |
90 | - /** |
|
91 | - * @return bool True when the option can be changed for the stream |
|
92 | - * @since 11.0.0 |
|
93 | - */ |
|
94 | - public function isDefaultEnabledMail() { |
|
95 | - return false; |
|
96 | - } |
|
90 | + /** |
|
91 | + * @return bool True when the option can be changed for the stream |
|
92 | + * @since 11.0.0 |
|
93 | + */ |
|
94 | + public function isDefaultEnabledMail() { |
|
95 | + return false; |
|
96 | + } |
|
97 | 97 | } |
98 | 98 |
@@ -30,30 +30,30 @@ |
||
30 | 30 | |
31 | 31 | class LastUsedController extends Controller { |
32 | 32 | |
33 | - /** @var IConfig */ |
|
34 | - protected $config; |
|
35 | - |
|
36 | - /** @var IUserSession */ |
|
37 | - protected $userSession; |
|
38 | - |
|
39 | - /** |
|
40 | - * @param string $appName |
|
41 | - * @param IRequest $request |
|
42 | - * @param IConfig $config |
|
43 | - * @param IUserSession $userSession |
|
44 | - */ |
|
45 | - public function __construct($appName, IRequest $request, IConfig $config, IUserSession $userSession) { |
|
46 | - parent::__construct($appName, $request); |
|
47 | - $this->config = $config; |
|
48 | - $this->userSession = $userSession; |
|
49 | - } |
|
50 | - |
|
51 | - /** |
|
52 | - * @NoAdminRequired |
|
53 | - */ |
|
54 | - public function getLastUsedTagIds() { |
|
55 | - $lastUsed = $this->config->getUserValue($this->userSession->getUser()->getUID(), 'systemtags', 'last_used', '[]'); |
|
56 | - $tagIds = json_decode($lastUsed, true); |
|
57 | - return new DataResponse(array_map(function($id) { return (string) $id; }, $tagIds)); |
|
58 | - } |
|
33 | + /** @var IConfig */ |
|
34 | + protected $config; |
|
35 | + |
|
36 | + /** @var IUserSession */ |
|
37 | + protected $userSession; |
|
38 | + |
|
39 | + /** |
|
40 | + * @param string $appName |
|
41 | + * @param IRequest $request |
|
42 | + * @param IConfig $config |
|
43 | + * @param IUserSession $userSession |
|
44 | + */ |
|
45 | + public function __construct($appName, IRequest $request, IConfig $config, IUserSession $userSession) { |
|
46 | + parent::__construct($appName, $request); |
|
47 | + $this->config = $config; |
|
48 | + $this->userSession = $userSession; |
|
49 | + } |
|
50 | + |
|
51 | + /** |
|
52 | + * @NoAdminRequired |
|
53 | + */ |
|
54 | + public function getLastUsedTagIds() { |
|
55 | + $lastUsed = $this->config->getUserValue($this->userSession->getUser()->getUID(), 'systemtags', 'last_used', '[]'); |
|
56 | + $tagIds = json_decode($lastUsed, true); |
|
57 | + return new DataResponse(array_map(function($id) { return (string) $id; }, $tagIds)); |
|
58 | + } |
|
59 | 59 | } |
@@ -28,29 +28,29 @@ |
||
28 | 28 | |
29 | 29 | class Admin implements ISettings { |
30 | 30 | |
31 | - /** |
|
32 | - * @return TemplateResponse |
|
33 | - */ |
|
34 | - public function getForm() { |
|
35 | - return new TemplateResponse('systemtags', 'admin', [], ''); |
|
36 | - } |
|
31 | + /** |
|
32 | + * @return TemplateResponse |
|
33 | + */ |
|
34 | + public function getForm() { |
|
35 | + return new TemplateResponse('systemtags', 'admin', [], ''); |
|
36 | + } |
|
37 | 37 | |
38 | - /** |
|
39 | - * @return string the section ID, e.g. 'sharing' |
|
40 | - */ |
|
41 | - public function getSection() { |
|
42 | - return 'workflow'; |
|
43 | - } |
|
38 | + /** |
|
39 | + * @return string the section ID, e.g. 'sharing' |
|
40 | + */ |
|
41 | + public function getSection() { |
|
42 | + return 'workflow'; |
|
43 | + } |
|
44 | 44 | |
45 | - /** |
|
46 | - * @return int whether the form should be rather on the top or bottom of |
|
47 | - * the admin section. The forms are arranged in ascending order of the |
|
48 | - * priority values. It is required to return a value between 0 and 100. |
|
49 | - * |
|
50 | - * E.g.: 70 |
|
51 | - */ |
|
52 | - public function getPriority() { |
|
53 | - return 70; |
|
54 | - } |
|
45 | + /** |
|
46 | + * @return int whether the form should be rather on the top or bottom of |
|
47 | + * the admin section. The forms are arranged in ascending order of the |
|
48 | + * priority values. It is required to return a value between 0 and 100. |
|
49 | + * |
|
50 | + * E.g.: 70 |
|
51 | + */ |
|
52 | + public function getPriority() { |
|
53 | + return 70; |
|
54 | + } |
|
55 | 55 | |
56 | 56 | } |
@@ -22,7 +22,7 @@ |
||
22 | 22 | */ |
23 | 23 | |
24 | 24 | return [ |
25 | - 'routes' => [ |
|
26 | - ['name' => 'LastUsed#getLastUsedTagIds', 'url' => '/lastused', 'verb' => 'GET'], |
|
27 | - ] |
|
25 | + 'routes' => [ |
|
26 | + ['name' => 'LastUsed#getLastUsedTagIds', 'url' => '/lastused', 'verb' => 'GET'], |
|
27 | + ] |
|
28 | 28 | ]; |
@@ -32,153 +32,153 @@ |
||
32 | 32 | |
33 | 33 | abstract class Base implements IProvider { |
34 | 34 | |
35 | - /** @var IFactory */ |
|
36 | - protected $languageFactory; |
|
37 | - |
|
38 | - /** @var IL10N */ |
|
39 | - protected $l; |
|
40 | - |
|
41 | - /** @var IURLGenerator */ |
|
42 | - protected $url; |
|
43 | - |
|
44 | - /** @var IManager */ |
|
45 | - protected $activityManager; |
|
46 | - |
|
47 | - /** @var IUserManager */ |
|
48 | - protected $userManager; |
|
49 | - |
|
50 | - /** @var array */ |
|
51 | - protected $displayNames = []; |
|
52 | - |
|
53 | - /** |
|
54 | - * @param IFactory $languageFactory |
|
55 | - * @param IURLGenerator $url |
|
56 | - * @param IManager $activityManager |
|
57 | - * @param IUserManager $userManager |
|
58 | - */ |
|
59 | - public function __construct(IFactory $languageFactory, IURLGenerator $url, IManager $activityManager, IUserManager $userManager) { |
|
60 | - $this->languageFactory = $languageFactory; |
|
61 | - $this->url = $url; |
|
62 | - $this->activityManager = $activityManager; |
|
63 | - $this->userManager = $userManager; |
|
64 | - } |
|
65 | - |
|
66 | - /** |
|
67 | - * @param string $language |
|
68 | - * @param IEvent $event |
|
69 | - * @param IEvent|null $previousEvent |
|
70 | - * @return IEvent |
|
71 | - * @throws \InvalidArgumentException |
|
72 | - * @since 11.0.0 |
|
73 | - */ |
|
74 | - public function parse($language, IEvent $event, IEvent $previousEvent = null) { |
|
75 | - if ($event->getApp() !== 'files_sharing') { |
|
76 | - throw new \InvalidArgumentException(); |
|
77 | - } |
|
78 | - |
|
79 | - $this->l = $this->languageFactory->get('files_sharing', $language); |
|
80 | - |
|
81 | - if ($this->activityManager->isFormattingFilteredObject()) { |
|
82 | - try { |
|
83 | - return $this->parseShortVersion($event); |
|
84 | - } catch (\InvalidArgumentException $e) { |
|
85 | - // Ignore and simply use the long version... |
|
86 | - } |
|
87 | - } |
|
88 | - |
|
89 | - return $this->parseLongVersion($event); |
|
90 | - } |
|
91 | - |
|
92 | - /** |
|
93 | - * @param IEvent $event |
|
94 | - * @return IEvent |
|
95 | - * @throws \InvalidArgumentException |
|
96 | - * @since 11.0.0 |
|
97 | - */ |
|
98 | - abstract protected function parseShortVersion(IEvent $event); |
|
99 | - |
|
100 | - /** |
|
101 | - * @param IEvent $event |
|
102 | - * @return IEvent |
|
103 | - * @throws \InvalidArgumentException |
|
104 | - * @since 11.0.0 |
|
105 | - */ |
|
106 | - abstract protected function parseLongVersion(IEvent $event); |
|
107 | - |
|
108 | - /** |
|
109 | - * @param IEvent $event |
|
110 | - * @param string $subject |
|
111 | - * @param array $parameters |
|
112 | - * @throws \InvalidArgumentException |
|
113 | - */ |
|
114 | - protected function setSubjects(IEvent $event, $subject, array $parameters) { |
|
115 | - $placeholders = $replacements = []; |
|
116 | - foreach ($parameters as $placeholder => $parameter) { |
|
117 | - $placeholders[] = '{' . $placeholder . '}'; |
|
118 | - if ($parameter['type'] === 'file') { |
|
119 | - $replacements[] = $parameter['path']; |
|
120 | - } else { |
|
121 | - $replacements[] = $parameter['name']; |
|
122 | - } |
|
123 | - } |
|
124 | - |
|
125 | - $event->setParsedSubject(str_replace($placeholders, $replacements, $subject)) |
|
126 | - ->setRichSubject($subject, $parameters); |
|
127 | - } |
|
128 | - |
|
129 | - /** |
|
130 | - * @param array|string $parameter |
|
131 | - * @param IEvent|null $event |
|
132 | - * @return array |
|
133 | - * @throws \InvalidArgumentException |
|
134 | - */ |
|
135 | - protected function getFile($parameter, IEvent $event = null) { |
|
136 | - if (is_array($parameter)) { |
|
137 | - $path = reset($parameter); |
|
138 | - $id = (string) key($parameter); |
|
139 | - } else if ($event !== null) { |
|
140 | - // Legacy from before ownCloud 8.2 |
|
141 | - $path = $parameter; |
|
142 | - $id = $event->getObjectId(); |
|
143 | - } else { |
|
144 | - throw new \InvalidArgumentException('Could not generate file parameter'); |
|
145 | - } |
|
146 | - |
|
147 | - return [ |
|
148 | - 'type' => 'file', |
|
149 | - 'id' => $id, |
|
150 | - 'name' => basename($path), |
|
151 | - 'path' => trim($path, '/'), |
|
152 | - 'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]), |
|
153 | - ]; |
|
154 | - } |
|
155 | - |
|
156 | - /** |
|
157 | - * @param string $uid |
|
158 | - * @return array |
|
159 | - */ |
|
160 | - protected function getUser($uid) { |
|
161 | - if (!isset($this->displayNames[$uid])) { |
|
162 | - $this->displayNames[$uid] = $this->getDisplayName($uid); |
|
163 | - } |
|
164 | - |
|
165 | - return [ |
|
166 | - 'type' => 'user', |
|
167 | - 'id' => $uid, |
|
168 | - 'name' => $this->displayNames[$uid], |
|
169 | - ]; |
|
170 | - } |
|
171 | - |
|
172 | - /** |
|
173 | - * @param string $uid |
|
174 | - * @return string |
|
175 | - */ |
|
176 | - protected function getDisplayName($uid) { |
|
177 | - $user = $this->userManager->get($uid); |
|
178 | - if ($user instanceof IUser) { |
|
179 | - return $user->getDisplayName(); |
|
180 | - } else { |
|
181 | - return $uid; |
|
182 | - } |
|
183 | - } |
|
35 | + /** @var IFactory */ |
|
36 | + protected $languageFactory; |
|
37 | + |
|
38 | + /** @var IL10N */ |
|
39 | + protected $l; |
|
40 | + |
|
41 | + /** @var IURLGenerator */ |
|
42 | + protected $url; |
|
43 | + |
|
44 | + /** @var IManager */ |
|
45 | + protected $activityManager; |
|
46 | + |
|
47 | + /** @var IUserManager */ |
|
48 | + protected $userManager; |
|
49 | + |
|
50 | + /** @var array */ |
|
51 | + protected $displayNames = []; |
|
52 | + |
|
53 | + /** |
|
54 | + * @param IFactory $languageFactory |
|
55 | + * @param IURLGenerator $url |
|
56 | + * @param IManager $activityManager |
|
57 | + * @param IUserManager $userManager |
|
58 | + */ |
|
59 | + public function __construct(IFactory $languageFactory, IURLGenerator $url, IManager $activityManager, IUserManager $userManager) { |
|
60 | + $this->languageFactory = $languageFactory; |
|
61 | + $this->url = $url; |
|
62 | + $this->activityManager = $activityManager; |
|
63 | + $this->userManager = $userManager; |
|
64 | + } |
|
65 | + |
|
66 | + /** |
|
67 | + * @param string $language |
|
68 | + * @param IEvent $event |
|
69 | + * @param IEvent|null $previousEvent |
|
70 | + * @return IEvent |
|
71 | + * @throws \InvalidArgumentException |
|
72 | + * @since 11.0.0 |
|
73 | + */ |
|
74 | + public function parse($language, IEvent $event, IEvent $previousEvent = null) { |
|
75 | + if ($event->getApp() !== 'files_sharing') { |
|
76 | + throw new \InvalidArgumentException(); |
|
77 | + } |
|
78 | + |
|
79 | + $this->l = $this->languageFactory->get('files_sharing', $language); |
|
80 | + |
|
81 | + if ($this->activityManager->isFormattingFilteredObject()) { |
|
82 | + try { |
|
83 | + return $this->parseShortVersion($event); |
|
84 | + } catch (\InvalidArgumentException $e) { |
|
85 | + // Ignore and simply use the long version... |
|
86 | + } |
|
87 | + } |
|
88 | + |
|
89 | + return $this->parseLongVersion($event); |
|
90 | + } |
|
91 | + |
|
92 | + /** |
|
93 | + * @param IEvent $event |
|
94 | + * @return IEvent |
|
95 | + * @throws \InvalidArgumentException |
|
96 | + * @since 11.0.0 |
|
97 | + */ |
|
98 | + abstract protected function parseShortVersion(IEvent $event); |
|
99 | + |
|
100 | + /** |
|
101 | + * @param IEvent $event |
|
102 | + * @return IEvent |
|
103 | + * @throws \InvalidArgumentException |
|
104 | + * @since 11.0.0 |
|
105 | + */ |
|
106 | + abstract protected function parseLongVersion(IEvent $event); |
|
107 | + |
|
108 | + /** |
|
109 | + * @param IEvent $event |
|
110 | + * @param string $subject |
|
111 | + * @param array $parameters |
|
112 | + * @throws \InvalidArgumentException |
|
113 | + */ |
|
114 | + protected function setSubjects(IEvent $event, $subject, array $parameters) { |
|
115 | + $placeholders = $replacements = []; |
|
116 | + foreach ($parameters as $placeholder => $parameter) { |
|
117 | + $placeholders[] = '{' . $placeholder . '}'; |
|
118 | + if ($parameter['type'] === 'file') { |
|
119 | + $replacements[] = $parameter['path']; |
|
120 | + } else { |
|
121 | + $replacements[] = $parameter['name']; |
|
122 | + } |
|
123 | + } |
|
124 | + |
|
125 | + $event->setParsedSubject(str_replace($placeholders, $replacements, $subject)) |
|
126 | + ->setRichSubject($subject, $parameters); |
|
127 | + } |
|
128 | + |
|
129 | + /** |
|
130 | + * @param array|string $parameter |
|
131 | + * @param IEvent|null $event |
|
132 | + * @return array |
|
133 | + * @throws \InvalidArgumentException |
|
134 | + */ |
|
135 | + protected function getFile($parameter, IEvent $event = null) { |
|
136 | + if (is_array($parameter)) { |
|
137 | + $path = reset($parameter); |
|
138 | + $id = (string) key($parameter); |
|
139 | + } else if ($event !== null) { |
|
140 | + // Legacy from before ownCloud 8.2 |
|
141 | + $path = $parameter; |
|
142 | + $id = $event->getObjectId(); |
|
143 | + } else { |
|
144 | + throw new \InvalidArgumentException('Could not generate file parameter'); |
|
145 | + } |
|
146 | + |
|
147 | + return [ |
|
148 | + 'type' => 'file', |
|
149 | + 'id' => $id, |
|
150 | + 'name' => basename($path), |
|
151 | + 'path' => trim($path, '/'), |
|
152 | + 'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]), |
|
153 | + ]; |
|
154 | + } |
|
155 | + |
|
156 | + /** |
|
157 | + * @param string $uid |
|
158 | + * @return array |
|
159 | + */ |
|
160 | + protected function getUser($uid) { |
|
161 | + if (!isset($this->displayNames[$uid])) { |
|
162 | + $this->displayNames[$uid] = $this->getDisplayName($uid); |
|
163 | + } |
|
164 | + |
|
165 | + return [ |
|
166 | + 'type' => 'user', |
|
167 | + 'id' => $uid, |
|
168 | + 'name' => $this->displayNames[$uid], |
|
169 | + ]; |
|
170 | + } |
|
171 | + |
|
172 | + /** |
|
173 | + * @param string $uid |
|
174 | + * @return string |
|
175 | + */ |
|
176 | + protected function getDisplayName($uid) { |
|
177 | + $user = $this->userManager->get($uid); |
|
178 | + if ($user instanceof IUser) { |
|
179 | + return $user->getDisplayName(); |
|
180 | + } else { |
|
181 | + return $uid; |
|
182 | + } |
|
183 | + } |
|
184 | 184 | } |