@@ -72,762 +72,762 @@ |
||
72 | 72 | */ |
73 | 73 | abstract class Common implements Storage, ILockingStorage, IWriteStreamStorage { |
74 | 74 | |
75 | - use LocalTempFileTrait; |
|
76 | - |
|
77 | - protected $cache; |
|
78 | - protected $scanner; |
|
79 | - protected $watcher; |
|
80 | - protected $propagator; |
|
81 | - protected $storageCache; |
|
82 | - protected $updater; |
|
83 | - |
|
84 | - protected $mountOptions = []; |
|
85 | - protected $owner = null; |
|
86 | - |
|
87 | - private $shouldLogLocks = null; |
|
88 | - private $logger; |
|
89 | - |
|
90 | - public function __construct($parameters) { |
|
91 | - } |
|
92 | - |
|
93 | - /** |
|
94 | - * Remove a file or folder |
|
95 | - * |
|
96 | - * @param string $path |
|
97 | - * @return bool |
|
98 | - */ |
|
99 | - protected function remove($path) { |
|
100 | - if ($this->is_dir($path)) { |
|
101 | - return $this->rmdir($path); |
|
102 | - } else if ($this->is_file($path)) { |
|
103 | - return $this->unlink($path); |
|
104 | - } else { |
|
105 | - return false; |
|
106 | - } |
|
107 | - } |
|
108 | - |
|
109 | - public function is_dir($path) { |
|
110 | - return $this->filetype($path) === 'dir'; |
|
111 | - } |
|
112 | - |
|
113 | - public function is_file($path) { |
|
114 | - return $this->filetype($path) === 'file'; |
|
115 | - } |
|
116 | - |
|
117 | - public function filesize($path) { |
|
118 | - if ($this->is_dir($path)) { |
|
119 | - return 0; //by definition |
|
120 | - } else { |
|
121 | - $stat = $this->stat($path); |
|
122 | - if (isset($stat['size'])) { |
|
123 | - return $stat['size']; |
|
124 | - } else { |
|
125 | - return 0; |
|
126 | - } |
|
127 | - } |
|
128 | - } |
|
129 | - |
|
130 | - public function isReadable($path) { |
|
131 | - // at least check whether it exists |
|
132 | - // subclasses might want to implement this more thoroughly |
|
133 | - return $this->file_exists($path); |
|
134 | - } |
|
135 | - |
|
136 | - public function isUpdatable($path) { |
|
137 | - // at least check whether it exists |
|
138 | - // subclasses might want to implement this more thoroughly |
|
139 | - // a non-existing file/folder isn't updatable |
|
140 | - return $this->file_exists($path); |
|
141 | - } |
|
142 | - |
|
143 | - public function isCreatable($path) { |
|
144 | - if ($this->is_dir($path) && $this->isUpdatable($path)) { |
|
145 | - return true; |
|
146 | - } |
|
147 | - return false; |
|
148 | - } |
|
149 | - |
|
150 | - public function isDeletable($path) { |
|
151 | - if ($path === '' || $path === '/') { |
|
152 | - return false; |
|
153 | - } |
|
154 | - $parent = dirname($path); |
|
155 | - return $this->isUpdatable($parent) && $this->isUpdatable($path); |
|
156 | - } |
|
157 | - |
|
158 | - public function isSharable($path) { |
|
159 | - return $this->isReadable($path); |
|
160 | - } |
|
161 | - |
|
162 | - public function getPermissions($path) { |
|
163 | - $permissions = 0; |
|
164 | - if ($this->isCreatable($path)) { |
|
165 | - $permissions |= \OCP\Constants::PERMISSION_CREATE; |
|
166 | - } |
|
167 | - if ($this->isReadable($path)) { |
|
168 | - $permissions |= \OCP\Constants::PERMISSION_READ; |
|
169 | - } |
|
170 | - if ($this->isUpdatable($path)) { |
|
171 | - $permissions |= \OCP\Constants::PERMISSION_UPDATE; |
|
172 | - } |
|
173 | - if ($this->isDeletable($path)) { |
|
174 | - $permissions |= \OCP\Constants::PERMISSION_DELETE; |
|
175 | - } |
|
176 | - if ($this->isSharable($path)) { |
|
177 | - $permissions |= \OCP\Constants::PERMISSION_SHARE; |
|
178 | - } |
|
179 | - return $permissions; |
|
180 | - } |
|
181 | - |
|
182 | - public function filemtime($path) { |
|
183 | - $stat = $this->stat($path); |
|
184 | - if (isset($stat['mtime']) && $stat['mtime'] > 0) { |
|
185 | - return $stat['mtime']; |
|
186 | - } else { |
|
187 | - return 0; |
|
188 | - } |
|
189 | - } |
|
190 | - |
|
191 | - public function file_get_contents($path) { |
|
192 | - $handle = $this->fopen($path, "r"); |
|
193 | - if (!$handle) { |
|
194 | - return false; |
|
195 | - } |
|
196 | - $data = stream_get_contents($handle); |
|
197 | - fclose($handle); |
|
198 | - return $data; |
|
199 | - } |
|
200 | - |
|
201 | - public function file_put_contents($path, $data) { |
|
202 | - $handle = $this->fopen($path, "w"); |
|
203 | - $this->removeCachedFile($path); |
|
204 | - $count = fwrite($handle, $data); |
|
205 | - fclose($handle); |
|
206 | - return $count; |
|
207 | - } |
|
208 | - |
|
209 | - public function rename($path1, $path2) { |
|
210 | - $this->remove($path2); |
|
211 | - |
|
212 | - $this->removeCachedFile($path1); |
|
213 | - return $this->copy($path1, $path2) and $this->remove($path1); |
|
214 | - } |
|
215 | - |
|
216 | - public function copy($path1, $path2) { |
|
217 | - if ($this->is_dir($path1)) { |
|
218 | - $this->remove($path2); |
|
219 | - $dir = $this->opendir($path1); |
|
220 | - $this->mkdir($path2); |
|
221 | - while ($file = readdir($dir)) { |
|
222 | - if (!Filesystem::isIgnoredDir($file)) { |
|
223 | - if (!$this->copy($path1 . '/' . $file, $path2 . '/' . $file)) { |
|
224 | - return false; |
|
225 | - } |
|
226 | - } |
|
227 | - } |
|
228 | - closedir($dir); |
|
229 | - return true; |
|
230 | - } else { |
|
231 | - $source = $this->fopen($path1, 'r'); |
|
232 | - $target = $this->fopen($path2, 'w'); |
|
233 | - list(, $result) = \OC_Helper::streamCopy($source, $target); |
|
234 | - if (!$result) { |
|
235 | - \OC::$server->getLogger()->warning("Failed to write data while copying $path1 to $path2"); |
|
236 | - } |
|
237 | - $this->removeCachedFile($path2); |
|
238 | - return $result; |
|
239 | - } |
|
240 | - } |
|
241 | - |
|
242 | - public function getMimeType($path) { |
|
243 | - if ($this->is_dir($path)) { |
|
244 | - return 'httpd/unix-directory'; |
|
245 | - } elseif ($this->file_exists($path)) { |
|
246 | - return \OC::$server->getMimeTypeDetector()->detectPath($path); |
|
247 | - } else { |
|
248 | - return false; |
|
249 | - } |
|
250 | - } |
|
251 | - |
|
252 | - public function hash($type, $path, $raw = false) { |
|
253 | - $fh = $this->fopen($path, 'rb'); |
|
254 | - $ctx = hash_init($type); |
|
255 | - hash_update_stream($ctx, $fh); |
|
256 | - fclose($fh); |
|
257 | - return hash_final($ctx, $raw); |
|
258 | - } |
|
259 | - |
|
260 | - public function search($query) { |
|
261 | - return $this->searchInDir($query); |
|
262 | - } |
|
263 | - |
|
264 | - public function getLocalFile($path) { |
|
265 | - return $this->getCachedFile($path); |
|
266 | - } |
|
267 | - |
|
268 | - /** |
|
269 | - * @param string $path |
|
270 | - * @param string $target |
|
271 | - */ |
|
272 | - private function addLocalFolder($path, $target) { |
|
273 | - $dh = $this->opendir($path); |
|
274 | - if (is_resource($dh)) { |
|
275 | - while (($file = readdir($dh)) !== false) { |
|
276 | - if (!\OC\Files\Filesystem::isIgnoredDir($file)) { |
|
277 | - if ($this->is_dir($path . '/' . $file)) { |
|
278 | - mkdir($target . '/' . $file); |
|
279 | - $this->addLocalFolder($path . '/' . $file, $target . '/' . $file); |
|
280 | - } else { |
|
281 | - $tmp = $this->toTmpFile($path . '/' . $file); |
|
282 | - rename($tmp, $target . '/' . $file); |
|
283 | - } |
|
284 | - } |
|
285 | - } |
|
286 | - } |
|
287 | - } |
|
288 | - |
|
289 | - /** |
|
290 | - * @param string $query |
|
291 | - * @param string $dir |
|
292 | - * @return array |
|
293 | - */ |
|
294 | - protected function searchInDir($query, $dir = '') { |
|
295 | - $files = array(); |
|
296 | - $dh = $this->opendir($dir); |
|
297 | - if (is_resource($dh)) { |
|
298 | - while (($item = readdir($dh)) !== false) { |
|
299 | - if (\OC\Files\Filesystem::isIgnoredDir($item)) continue; |
|
300 | - if (strstr(strtolower($item), strtolower($query)) !== false) { |
|
301 | - $files[] = $dir . '/' . $item; |
|
302 | - } |
|
303 | - if ($this->is_dir($dir . '/' . $item)) { |
|
304 | - $files = array_merge($files, $this->searchInDir($query, $dir . '/' . $item)); |
|
305 | - } |
|
306 | - } |
|
307 | - } |
|
308 | - closedir($dh); |
|
309 | - return $files; |
|
310 | - } |
|
311 | - |
|
312 | - /** |
|
313 | - * check if a file or folder has been updated since $time |
|
314 | - * |
|
315 | - * The method is only used to check if the cache needs to be updated. Storage backends that don't support checking |
|
316 | - * the mtime should always return false here. As a result storage implementations that always return false expect |
|
317 | - * exclusive access to the backend and will not pick up files that have been added in a way that circumvents |
|
318 | - * ownClouds filesystem. |
|
319 | - * |
|
320 | - * @param string $path |
|
321 | - * @param int $time |
|
322 | - * @return bool |
|
323 | - */ |
|
324 | - public function hasUpdated($path, $time) { |
|
325 | - return $this->filemtime($path) > $time; |
|
326 | - } |
|
327 | - |
|
328 | - public function getCache($path = '', $storage = null) { |
|
329 | - if (!$storage) { |
|
330 | - $storage = $this; |
|
331 | - } |
|
332 | - if (!isset($storage->cache)) { |
|
333 | - $storage->cache = new Cache($storage); |
|
334 | - } |
|
335 | - return $storage->cache; |
|
336 | - } |
|
337 | - |
|
338 | - public function getScanner($path = '', $storage = null) { |
|
339 | - if (!$storage) { |
|
340 | - $storage = $this; |
|
341 | - } |
|
342 | - if (!isset($storage->scanner)) { |
|
343 | - $storage->scanner = new Scanner($storage); |
|
344 | - } |
|
345 | - return $storage->scanner; |
|
346 | - } |
|
347 | - |
|
348 | - public function getWatcher($path = '', $storage = null) { |
|
349 | - if (!$storage) { |
|
350 | - $storage = $this; |
|
351 | - } |
|
352 | - if (!isset($this->watcher)) { |
|
353 | - $this->watcher = new Watcher($storage); |
|
354 | - $globalPolicy = \OC::$server->getConfig()->getSystemValue('filesystem_check_changes', Watcher::CHECK_NEVER); |
|
355 | - $this->watcher->setPolicy((int)$this->getMountOption('filesystem_check_changes', $globalPolicy)); |
|
356 | - } |
|
357 | - return $this->watcher; |
|
358 | - } |
|
359 | - |
|
360 | - /** |
|
361 | - * get a propagator instance for the cache |
|
362 | - * |
|
363 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
364 | - * @return \OC\Files\Cache\Propagator |
|
365 | - */ |
|
366 | - public function getPropagator($storage = null) { |
|
367 | - if (!$storage) { |
|
368 | - $storage = $this; |
|
369 | - } |
|
370 | - if (!isset($storage->propagator)) { |
|
371 | - $config = \OC::$server->getSystemConfig(); |
|
372 | - $storage->propagator = new Propagator($storage, \OC::$server->getDatabaseConnection(), ['appdata_' . $config->getValue('instanceid')]); |
|
373 | - } |
|
374 | - return $storage->propagator; |
|
375 | - } |
|
376 | - |
|
377 | - public function getUpdater($storage = null) { |
|
378 | - if (!$storage) { |
|
379 | - $storage = $this; |
|
380 | - } |
|
381 | - if (!isset($storage->updater)) { |
|
382 | - $storage->updater = new Updater($storage); |
|
383 | - } |
|
384 | - return $storage->updater; |
|
385 | - } |
|
386 | - |
|
387 | - public function getStorageCache($storage = null) { |
|
388 | - if (!$storage) { |
|
389 | - $storage = $this; |
|
390 | - } |
|
391 | - if (!isset($this->storageCache)) { |
|
392 | - $this->storageCache = new \OC\Files\Cache\Storage($storage); |
|
393 | - } |
|
394 | - return $this->storageCache; |
|
395 | - } |
|
396 | - |
|
397 | - /** |
|
398 | - * get the owner of a path |
|
399 | - * |
|
400 | - * @param string $path The path to get the owner |
|
401 | - * @return string|false uid or false |
|
402 | - */ |
|
403 | - public function getOwner($path) { |
|
404 | - if ($this->owner === null) { |
|
405 | - $this->owner = \OC_User::getUser(); |
|
406 | - } |
|
407 | - |
|
408 | - return $this->owner; |
|
409 | - } |
|
410 | - |
|
411 | - /** |
|
412 | - * get the ETag for a file or folder |
|
413 | - * |
|
414 | - * @param string $path |
|
415 | - * @return string |
|
416 | - */ |
|
417 | - public function getETag($path) { |
|
418 | - return uniqid(); |
|
419 | - } |
|
420 | - |
|
421 | - /** |
|
422 | - * clean a path, i.e. remove all redundant '.' and '..' |
|
423 | - * making sure that it can't point to higher than '/' |
|
424 | - * |
|
425 | - * @param string $path The path to clean |
|
426 | - * @return string cleaned path |
|
427 | - */ |
|
428 | - public function cleanPath($path) { |
|
429 | - if (strlen($path) == 0 or $path[0] != '/') { |
|
430 | - $path = '/' . $path; |
|
431 | - } |
|
432 | - |
|
433 | - $output = array(); |
|
434 | - foreach (explode('/', $path) as $chunk) { |
|
435 | - if ($chunk == '..') { |
|
436 | - array_pop($output); |
|
437 | - } else if ($chunk == '.') { |
|
438 | - } else { |
|
439 | - $output[] = $chunk; |
|
440 | - } |
|
441 | - } |
|
442 | - return implode('/', $output); |
|
443 | - } |
|
444 | - |
|
445 | - /** |
|
446 | - * Test a storage for availability |
|
447 | - * |
|
448 | - * @return bool |
|
449 | - */ |
|
450 | - public function test() { |
|
451 | - try { |
|
452 | - if ($this->stat('')) { |
|
453 | - return true; |
|
454 | - } |
|
455 | - \OC::$server->getLogger()->info("External storage not available: stat() failed"); |
|
456 | - return false; |
|
457 | - } catch (\Exception $e) { |
|
458 | - \OC::$server->getLogger()->info("External storage not available: " . $e->getMessage()); |
|
459 | - \OC::$server->getLogger()->logException($e, ['level' => ILogger::DEBUG]); |
|
460 | - return false; |
|
461 | - } |
|
462 | - } |
|
463 | - |
|
464 | - /** |
|
465 | - * get the free space in the storage |
|
466 | - * |
|
467 | - * @param string $path |
|
468 | - * @return int|false |
|
469 | - */ |
|
470 | - public function free_space($path) { |
|
471 | - return \OCP\Files\FileInfo::SPACE_UNKNOWN; |
|
472 | - } |
|
473 | - |
|
474 | - /** |
|
475 | - * {@inheritdoc} |
|
476 | - */ |
|
477 | - public function isLocal() { |
|
478 | - // the common implementation returns a temporary file by |
|
479 | - // default, which is not local |
|
480 | - return false; |
|
481 | - } |
|
482 | - |
|
483 | - /** |
|
484 | - * Check if the storage is an instance of $class or is a wrapper for a storage that is an instance of $class |
|
485 | - * |
|
486 | - * @param string $class |
|
487 | - * @return bool |
|
488 | - */ |
|
489 | - public function instanceOfStorage($class) { |
|
490 | - if (ltrim($class, '\\') === 'OC\Files\Storage\Shared') { |
|
491 | - // FIXME Temporary fix to keep existing checks working |
|
492 | - $class = '\OCA\Files_Sharing\SharedStorage'; |
|
493 | - } |
|
494 | - return is_a($this, $class); |
|
495 | - } |
|
496 | - |
|
497 | - /** |
|
498 | - * A custom storage implementation can return an url for direct download of a give file. |
|
499 | - * |
|
500 | - * For now the returned array can hold the parameter url - in future more attributes might follow. |
|
501 | - * |
|
502 | - * @param string $path |
|
503 | - * @return array|false |
|
504 | - */ |
|
505 | - public function getDirectDownload($path) { |
|
506 | - return []; |
|
507 | - } |
|
508 | - |
|
509 | - /** |
|
510 | - * @inheritdoc |
|
511 | - * @throws InvalidPathException |
|
512 | - */ |
|
513 | - public function verifyPath($path, $fileName) { |
|
514 | - |
|
515 | - // verify empty and dot files |
|
516 | - $trimmed = trim($fileName); |
|
517 | - if ($trimmed === '') { |
|
518 | - throw new EmptyFileNameException(); |
|
519 | - } |
|
520 | - |
|
521 | - if (\OC\Files\Filesystem::isIgnoredDir($trimmed)) { |
|
522 | - throw new InvalidDirectoryException(); |
|
523 | - } |
|
524 | - |
|
525 | - if (!\OC::$server->getDatabaseConnection()->supports4ByteText()) { |
|
526 | - // verify database - e.g. mysql only 3-byte chars |
|
527 | - if (preg_match('%(?: |
|
75 | + use LocalTempFileTrait; |
|
76 | + |
|
77 | + protected $cache; |
|
78 | + protected $scanner; |
|
79 | + protected $watcher; |
|
80 | + protected $propagator; |
|
81 | + protected $storageCache; |
|
82 | + protected $updater; |
|
83 | + |
|
84 | + protected $mountOptions = []; |
|
85 | + protected $owner = null; |
|
86 | + |
|
87 | + private $shouldLogLocks = null; |
|
88 | + private $logger; |
|
89 | + |
|
90 | + public function __construct($parameters) { |
|
91 | + } |
|
92 | + |
|
93 | + /** |
|
94 | + * Remove a file or folder |
|
95 | + * |
|
96 | + * @param string $path |
|
97 | + * @return bool |
|
98 | + */ |
|
99 | + protected function remove($path) { |
|
100 | + if ($this->is_dir($path)) { |
|
101 | + return $this->rmdir($path); |
|
102 | + } else if ($this->is_file($path)) { |
|
103 | + return $this->unlink($path); |
|
104 | + } else { |
|
105 | + return false; |
|
106 | + } |
|
107 | + } |
|
108 | + |
|
109 | + public function is_dir($path) { |
|
110 | + return $this->filetype($path) === 'dir'; |
|
111 | + } |
|
112 | + |
|
113 | + public function is_file($path) { |
|
114 | + return $this->filetype($path) === 'file'; |
|
115 | + } |
|
116 | + |
|
117 | + public function filesize($path) { |
|
118 | + if ($this->is_dir($path)) { |
|
119 | + return 0; //by definition |
|
120 | + } else { |
|
121 | + $stat = $this->stat($path); |
|
122 | + if (isset($stat['size'])) { |
|
123 | + return $stat['size']; |
|
124 | + } else { |
|
125 | + return 0; |
|
126 | + } |
|
127 | + } |
|
128 | + } |
|
129 | + |
|
130 | + public function isReadable($path) { |
|
131 | + // at least check whether it exists |
|
132 | + // subclasses might want to implement this more thoroughly |
|
133 | + return $this->file_exists($path); |
|
134 | + } |
|
135 | + |
|
136 | + public function isUpdatable($path) { |
|
137 | + // at least check whether it exists |
|
138 | + // subclasses might want to implement this more thoroughly |
|
139 | + // a non-existing file/folder isn't updatable |
|
140 | + return $this->file_exists($path); |
|
141 | + } |
|
142 | + |
|
143 | + public function isCreatable($path) { |
|
144 | + if ($this->is_dir($path) && $this->isUpdatable($path)) { |
|
145 | + return true; |
|
146 | + } |
|
147 | + return false; |
|
148 | + } |
|
149 | + |
|
150 | + public function isDeletable($path) { |
|
151 | + if ($path === '' || $path === '/') { |
|
152 | + return false; |
|
153 | + } |
|
154 | + $parent = dirname($path); |
|
155 | + return $this->isUpdatable($parent) && $this->isUpdatable($path); |
|
156 | + } |
|
157 | + |
|
158 | + public function isSharable($path) { |
|
159 | + return $this->isReadable($path); |
|
160 | + } |
|
161 | + |
|
162 | + public function getPermissions($path) { |
|
163 | + $permissions = 0; |
|
164 | + if ($this->isCreatable($path)) { |
|
165 | + $permissions |= \OCP\Constants::PERMISSION_CREATE; |
|
166 | + } |
|
167 | + if ($this->isReadable($path)) { |
|
168 | + $permissions |= \OCP\Constants::PERMISSION_READ; |
|
169 | + } |
|
170 | + if ($this->isUpdatable($path)) { |
|
171 | + $permissions |= \OCP\Constants::PERMISSION_UPDATE; |
|
172 | + } |
|
173 | + if ($this->isDeletable($path)) { |
|
174 | + $permissions |= \OCP\Constants::PERMISSION_DELETE; |
|
175 | + } |
|
176 | + if ($this->isSharable($path)) { |
|
177 | + $permissions |= \OCP\Constants::PERMISSION_SHARE; |
|
178 | + } |
|
179 | + return $permissions; |
|
180 | + } |
|
181 | + |
|
182 | + public function filemtime($path) { |
|
183 | + $stat = $this->stat($path); |
|
184 | + if (isset($stat['mtime']) && $stat['mtime'] > 0) { |
|
185 | + return $stat['mtime']; |
|
186 | + } else { |
|
187 | + return 0; |
|
188 | + } |
|
189 | + } |
|
190 | + |
|
191 | + public function file_get_contents($path) { |
|
192 | + $handle = $this->fopen($path, "r"); |
|
193 | + if (!$handle) { |
|
194 | + return false; |
|
195 | + } |
|
196 | + $data = stream_get_contents($handle); |
|
197 | + fclose($handle); |
|
198 | + return $data; |
|
199 | + } |
|
200 | + |
|
201 | + public function file_put_contents($path, $data) { |
|
202 | + $handle = $this->fopen($path, "w"); |
|
203 | + $this->removeCachedFile($path); |
|
204 | + $count = fwrite($handle, $data); |
|
205 | + fclose($handle); |
|
206 | + return $count; |
|
207 | + } |
|
208 | + |
|
209 | + public function rename($path1, $path2) { |
|
210 | + $this->remove($path2); |
|
211 | + |
|
212 | + $this->removeCachedFile($path1); |
|
213 | + return $this->copy($path1, $path2) and $this->remove($path1); |
|
214 | + } |
|
215 | + |
|
216 | + public function copy($path1, $path2) { |
|
217 | + if ($this->is_dir($path1)) { |
|
218 | + $this->remove($path2); |
|
219 | + $dir = $this->opendir($path1); |
|
220 | + $this->mkdir($path2); |
|
221 | + while ($file = readdir($dir)) { |
|
222 | + if (!Filesystem::isIgnoredDir($file)) { |
|
223 | + if (!$this->copy($path1 . '/' . $file, $path2 . '/' . $file)) { |
|
224 | + return false; |
|
225 | + } |
|
226 | + } |
|
227 | + } |
|
228 | + closedir($dir); |
|
229 | + return true; |
|
230 | + } else { |
|
231 | + $source = $this->fopen($path1, 'r'); |
|
232 | + $target = $this->fopen($path2, 'w'); |
|
233 | + list(, $result) = \OC_Helper::streamCopy($source, $target); |
|
234 | + if (!$result) { |
|
235 | + \OC::$server->getLogger()->warning("Failed to write data while copying $path1 to $path2"); |
|
236 | + } |
|
237 | + $this->removeCachedFile($path2); |
|
238 | + return $result; |
|
239 | + } |
|
240 | + } |
|
241 | + |
|
242 | + public function getMimeType($path) { |
|
243 | + if ($this->is_dir($path)) { |
|
244 | + return 'httpd/unix-directory'; |
|
245 | + } elseif ($this->file_exists($path)) { |
|
246 | + return \OC::$server->getMimeTypeDetector()->detectPath($path); |
|
247 | + } else { |
|
248 | + return false; |
|
249 | + } |
|
250 | + } |
|
251 | + |
|
252 | + public function hash($type, $path, $raw = false) { |
|
253 | + $fh = $this->fopen($path, 'rb'); |
|
254 | + $ctx = hash_init($type); |
|
255 | + hash_update_stream($ctx, $fh); |
|
256 | + fclose($fh); |
|
257 | + return hash_final($ctx, $raw); |
|
258 | + } |
|
259 | + |
|
260 | + public function search($query) { |
|
261 | + return $this->searchInDir($query); |
|
262 | + } |
|
263 | + |
|
264 | + public function getLocalFile($path) { |
|
265 | + return $this->getCachedFile($path); |
|
266 | + } |
|
267 | + |
|
268 | + /** |
|
269 | + * @param string $path |
|
270 | + * @param string $target |
|
271 | + */ |
|
272 | + private function addLocalFolder($path, $target) { |
|
273 | + $dh = $this->opendir($path); |
|
274 | + if (is_resource($dh)) { |
|
275 | + while (($file = readdir($dh)) !== false) { |
|
276 | + if (!\OC\Files\Filesystem::isIgnoredDir($file)) { |
|
277 | + if ($this->is_dir($path . '/' . $file)) { |
|
278 | + mkdir($target . '/' . $file); |
|
279 | + $this->addLocalFolder($path . '/' . $file, $target . '/' . $file); |
|
280 | + } else { |
|
281 | + $tmp = $this->toTmpFile($path . '/' . $file); |
|
282 | + rename($tmp, $target . '/' . $file); |
|
283 | + } |
|
284 | + } |
|
285 | + } |
|
286 | + } |
|
287 | + } |
|
288 | + |
|
289 | + /** |
|
290 | + * @param string $query |
|
291 | + * @param string $dir |
|
292 | + * @return array |
|
293 | + */ |
|
294 | + protected function searchInDir($query, $dir = '') { |
|
295 | + $files = array(); |
|
296 | + $dh = $this->opendir($dir); |
|
297 | + if (is_resource($dh)) { |
|
298 | + while (($item = readdir($dh)) !== false) { |
|
299 | + if (\OC\Files\Filesystem::isIgnoredDir($item)) continue; |
|
300 | + if (strstr(strtolower($item), strtolower($query)) !== false) { |
|
301 | + $files[] = $dir . '/' . $item; |
|
302 | + } |
|
303 | + if ($this->is_dir($dir . '/' . $item)) { |
|
304 | + $files = array_merge($files, $this->searchInDir($query, $dir . '/' . $item)); |
|
305 | + } |
|
306 | + } |
|
307 | + } |
|
308 | + closedir($dh); |
|
309 | + return $files; |
|
310 | + } |
|
311 | + |
|
312 | + /** |
|
313 | + * check if a file or folder has been updated since $time |
|
314 | + * |
|
315 | + * The method is only used to check if the cache needs to be updated. Storage backends that don't support checking |
|
316 | + * the mtime should always return false here. As a result storage implementations that always return false expect |
|
317 | + * exclusive access to the backend and will not pick up files that have been added in a way that circumvents |
|
318 | + * ownClouds filesystem. |
|
319 | + * |
|
320 | + * @param string $path |
|
321 | + * @param int $time |
|
322 | + * @return bool |
|
323 | + */ |
|
324 | + public function hasUpdated($path, $time) { |
|
325 | + return $this->filemtime($path) > $time; |
|
326 | + } |
|
327 | + |
|
328 | + public function getCache($path = '', $storage = null) { |
|
329 | + if (!$storage) { |
|
330 | + $storage = $this; |
|
331 | + } |
|
332 | + if (!isset($storage->cache)) { |
|
333 | + $storage->cache = new Cache($storage); |
|
334 | + } |
|
335 | + return $storage->cache; |
|
336 | + } |
|
337 | + |
|
338 | + public function getScanner($path = '', $storage = null) { |
|
339 | + if (!$storage) { |
|
340 | + $storage = $this; |
|
341 | + } |
|
342 | + if (!isset($storage->scanner)) { |
|
343 | + $storage->scanner = new Scanner($storage); |
|
344 | + } |
|
345 | + return $storage->scanner; |
|
346 | + } |
|
347 | + |
|
348 | + public function getWatcher($path = '', $storage = null) { |
|
349 | + if (!$storage) { |
|
350 | + $storage = $this; |
|
351 | + } |
|
352 | + if (!isset($this->watcher)) { |
|
353 | + $this->watcher = new Watcher($storage); |
|
354 | + $globalPolicy = \OC::$server->getConfig()->getSystemValue('filesystem_check_changes', Watcher::CHECK_NEVER); |
|
355 | + $this->watcher->setPolicy((int)$this->getMountOption('filesystem_check_changes', $globalPolicy)); |
|
356 | + } |
|
357 | + return $this->watcher; |
|
358 | + } |
|
359 | + |
|
360 | + /** |
|
361 | + * get a propagator instance for the cache |
|
362 | + * |
|
363 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
364 | + * @return \OC\Files\Cache\Propagator |
|
365 | + */ |
|
366 | + public function getPropagator($storage = null) { |
|
367 | + if (!$storage) { |
|
368 | + $storage = $this; |
|
369 | + } |
|
370 | + if (!isset($storage->propagator)) { |
|
371 | + $config = \OC::$server->getSystemConfig(); |
|
372 | + $storage->propagator = new Propagator($storage, \OC::$server->getDatabaseConnection(), ['appdata_' . $config->getValue('instanceid')]); |
|
373 | + } |
|
374 | + return $storage->propagator; |
|
375 | + } |
|
376 | + |
|
377 | + public function getUpdater($storage = null) { |
|
378 | + if (!$storage) { |
|
379 | + $storage = $this; |
|
380 | + } |
|
381 | + if (!isset($storage->updater)) { |
|
382 | + $storage->updater = new Updater($storage); |
|
383 | + } |
|
384 | + return $storage->updater; |
|
385 | + } |
|
386 | + |
|
387 | + public function getStorageCache($storage = null) { |
|
388 | + if (!$storage) { |
|
389 | + $storage = $this; |
|
390 | + } |
|
391 | + if (!isset($this->storageCache)) { |
|
392 | + $this->storageCache = new \OC\Files\Cache\Storage($storage); |
|
393 | + } |
|
394 | + return $this->storageCache; |
|
395 | + } |
|
396 | + |
|
397 | + /** |
|
398 | + * get the owner of a path |
|
399 | + * |
|
400 | + * @param string $path The path to get the owner |
|
401 | + * @return string|false uid or false |
|
402 | + */ |
|
403 | + public function getOwner($path) { |
|
404 | + if ($this->owner === null) { |
|
405 | + $this->owner = \OC_User::getUser(); |
|
406 | + } |
|
407 | + |
|
408 | + return $this->owner; |
|
409 | + } |
|
410 | + |
|
411 | + /** |
|
412 | + * get the ETag for a file or folder |
|
413 | + * |
|
414 | + * @param string $path |
|
415 | + * @return string |
|
416 | + */ |
|
417 | + public function getETag($path) { |
|
418 | + return uniqid(); |
|
419 | + } |
|
420 | + |
|
421 | + /** |
|
422 | + * clean a path, i.e. remove all redundant '.' and '..' |
|
423 | + * making sure that it can't point to higher than '/' |
|
424 | + * |
|
425 | + * @param string $path The path to clean |
|
426 | + * @return string cleaned path |
|
427 | + */ |
|
428 | + public function cleanPath($path) { |
|
429 | + if (strlen($path) == 0 or $path[0] != '/') { |
|
430 | + $path = '/' . $path; |
|
431 | + } |
|
432 | + |
|
433 | + $output = array(); |
|
434 | + foreach (explode('/', $path) as $chunk) { |
|
435 | + if ($chunk == '..') { |
|
436 | + array_pop($output); |
|
437 | + } else if ($chunk == '.') { |
|
438 | + } else { |
|
439 | + $output[] = $chunk; |
|
440 | + } |
|
441 | + } |
|
442 | + return implode('/', $output); |
|
443 | + } |
|
444 | + |
|
445 | + /** |
|
446 | + * Test a storage for availability |
|
447 | + * |
|
448 | + * @return bool |
|
449 | + */ |
|
450 | + public function test() { |
|
451 | + try { |
|
452 | + if ($this->stat('')) { |
|
453 | + return true; |
|
454 | + } |
|
455 | + \OC::$server->getLogger()->info("External storage not available: stat() failed"); |
|
456 | + return false; |
|
457 | + } catch (\Exception $e) { |
|
458 | + \OC::$server->getLogger()->info("External storage not available: " . $e->getMessage()); |
|
459 | + \OC::$server->getLogger()->logException($e, ['level' => ILogger::DEBUG]); |
|
460 | + return false; |
|
461 | + } |
|
462 | + } |
|
463 | + |
|
464 | + /** |
|
465 | + * get the free space in the storage |
|
466 | + * |
|
467 | + * @param string $path |
|
468 | + * @return int|false |
|
469 | + */ |
|
470 | + public function free_space($path) { |
|
471 | + return \OCP\Files\FileInfo::SPACE_UNKNOWN; |
|
472 | + } |
|
473 | + |
|
474 | + /** |
|
475 | + * {@inheritdoc} |
|
476 | + */ |
|
477 | + public function isLocal() { |
|
478 | + // the common implementation returns a temporary file by |
|
479 | + // default, which is not local |
|
480 | + return false; |
|
481 | + } |
|
482 | + |
|
483 | + /** |
|
484 | + * Check if the storage is an instance of $class or is a wrapper for a storage that is an instance of $class |
|
485 | + * |
|
486 | + * @param string $class |
|
487 | + * @return bool |
|
488 | + */ |
|
489 | + public function instanceOfStorage($class) { |
|
490 | + if (ltrim($class, '\\') === 'OC\Files\Storage\Shared') { |
|
491 | + // FIXME Temporary fix to keep existing checks working |
|
492 | + $class = '\OCA\Files_Sharing\SharedStorage'; |
|
493 | + } |
|
494 | + return is_a($this, $class); |
|
495 | + } |
|
496 | + |
|
497 | + /** |
|
498 | + * A custom storage implementation can return an url for direct download of a give file. |
|
499 | + * |
|
500 | + * For now the returned array can hold the parameter url - in future more attributes might follow. |
|
501 | + * |
|
502 | + * @param string $path |
|
503 | + * @return array|false |
|
504 | + */ |
|
505 | + public function getDirectDownload($path) { |
|
506 | + return []; |
|
507 | + } |
|
508 | + |
|
509 | + /** |
|
510 | + * @inheritdoc |
|
511 | + * @throws InvalidPathException |
|
512 | + */ |
|
513 | + public function verifyPath($path, $fileName) { |
|
514 | + |
|
515 | + // verify empty and dot files |
|
516 | + $trimmed = trim($fileName); |
|
517 | + if ($trimmed === '') { |
|
518 | + throw new EmptyFileNameException(); |
|
519 | + } |
|
520 | + |
|
521 | + if (\OC\Files\Filesystem::isIgnoredDir($trimmed)) { |
|
522 | + throw new InvalidDirectoryException(); |
|
523 | + } |
|
524 | + |
|
525 | + if (!\OC::$server->getDatabaseConnection()->supports4ByteText()) { |
|
526 | + // verify database - e.g. mysql only 3-byte chars |
|
527 | + if (preg_match('%(?: |
|
528 | 528 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 |
529 | 529 | | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 |
530 | 530 | | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 |
531 | 531 | )%xs', $fileName)) { |
532 | - throw new InvalidCharacterInPathException(); |
|
533 | - } |
|
534 | - } |
|
535 | - |
|
536 | - if (isset($fileName[255])) { |
|
537 | - throw new FileNameTooLongException(); |
|
538 | - } |
|
539 | - |
|
540 | - // NOTE: $path will remain unverified for now |
|
541 | - $this->verifyPosixPath($fileName); |
|
542 | - } |
|
543 | - |
|
544 | - /** |
|
545 | - * @param string $fileName |
|
546 | - * @throws InvalidPathException |
|
547 | - */ |
|
548 | - protected function verifyPosixPath($fileName) { |
|
549 | - $fileName = trim($fileName); |
|
550 | - $this->scanForInvalidCharacters($fileName, "\\/"); |
|
551 | - $reservedNames = ['*']; |
|
552 | - if (in_array($fileName, $reservedNames)) { |
|
553 | - throw new ReservedWordException(); |
|
554 | - } |
|
555 | - } |
|
556 | - |
|
557 | - /** |
|
558 | - * @param string $fileName |
|
559 | - * @param string $invalidChars |
|
560 | - * @throws InvalidPathException |
|
561 | - */ |
|
562 | - private function scanForInvalidCharacters($fileName, $invalidChars) { |
|
563 | - foreach (str_split($invalidChars) as $char) { |
|
564 | - if (strpos($fileName, $char) !== false) { |
|
565 | - throw new InvalidCharacterInPathException(); |
|
566 | - } |
|
567 | - } |
|
568 | - |
|
569 | - $sanitizedFileName = filter_var($fileName, FILTER_UNSAFE_RAW, FILTER_FLAG_STRIP_LOW); |
|
570 | - if ($sanitizedFileName !== $fileName) { |
|
571 | - throw new InvalidCharacterInPathException(); |
|
572 | - } |
|
573 | - } |
|
574 | - |
|
575 | - /** |
|
576 | - * @param array $options |
|
577 | - */ |
|
578 | - public function setMountOptions(array $options) { |
|
579 | - $this->mountOptions = $options; |
|
580 | - } |
|
581 | - |
|
582 | - /** |
|
583 | - * @param string $name |
|
584 | - * @param mixed $default |
|
585 | - * @return mixed |
|
586 | - */ |
|
587 | - public function getMountOption($name, $default = null) { |
|
588 | - return isset($this->mountOptions[$name]) ? $this->mountOptions[$name] : $default; |
|
589 | - } |
|
590 | - |
|
591 | - /** |
|
592 | - * @param IStorage $sourceStorage |
|
593 | - * @param string $sourceInternalPath |
|
594 | - * @param string $targetInternalPath |
|
595 | - * @param bool $preserveMtime |
|
596 | - * @return bool |
|
597 | - */ |
|
598 | - public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false) { |
|
599 | - if ($sourceStorage === $this) { |
|
600 | - return $this->copy($sourceInternalPath, $targetInternalPath); |
|
601 | - } |
|
602 | - |
|
603 | - if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
604 | - $dh = $sourceStorage->opendir($sourceInternalPath); |
|
605 | - $result = $this->mkdir($targetInternalPath); |
|
606 | - if (is_resource($dh)) { |
|
607 | - while ($result and ($file = readdir($dh)) !== false) { |
|
608 | - if (!Filesystem::isIgnoredDir($file)) { |
|
609 | - $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file); |
|
610 | - } |
|
611 | - } |
|
612 | - } |
|
613 | - } else { |
|
614 | - $source = $sourceStorage->fopen($sourceInternalPath, 'r'); |
|
615 | - // TODO: call fopen in a way that we execute again all storage wrappers |
|
616 | - // to avoid that we bypass storage wrappers which perform important actions |
|
617 | - // for this operation. Same is true for all other operations which |
|
618 | - // are not the same as the original one.Once this is fixed we also |
|
619 | - // need to adjust the encryption wrapper. |
|
620 | - $target = $this->fopen($targetInternalPath, 'w'); |
|
621 | - list(, $result) = \OC_Helper::streamCopy($source, $target); |
|
622 | - if ($result and $preserveMtime) { |
|
623 | - $this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath)); |
|
624 | - } |
|
625 | - fclose($source); |
|
626 | - fclose($target); |
|
627 | - |
|
628 | - if (!$result) { |
|
629 | - // delete partially written target file |
|
630 | - $this->unlink($targetInternalPath); |
|
631 | - // delete cache entry that was created by fopen |
|
632 | - $this->getCache()->remove($targetInternalPath); |
|
633 | - } |
|
634 | - } |
|
635 | - return (bool)$result; |
|
636 | - } |
|
637 | - |
|
638 | - /** |
|
639 | - * @param IStorage $sourceStorage |
|
640 | - * @param string $sourceInternalPath |
|
641 | - * @param string $targetInternalPath |
|
642 | - * @return bool |
|
643 | - */ |
|
644 | - public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) { |
|
645 | - if ($sourceStorage === $this) { |
|
646 | - return $this->rename($sourceInternalPath, $targetInternalPath); |
|
647 | - } |
|
648 | - |
|
649 | - if (!$sourceStorage->isDeletable($sourceInternalPath)) { |
|
650 | - return false; |
|
651 | - } |
|
652 | - |
|
653 | - $result = $this->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, true); |
|
654 | - if ($result) { |
|
655 | - if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
656 | - $result &= $sourceStorage->rmdir($sourceInternalPath); |
|
657 | - } else { |
|
658 | - $result &= $sourceStorage->unlink($sourceInternalPath); |
|
659 | - } |
|
660 | - } |
|
661 | - return $result; |
|
662 | - } |
|
663 | - |
|
664 | - /** |
|
665 | - * @inheritdoc |
|
666 | - */ |
|
667 | - public function getMetaData($path) { |
|
668 | - $permissions = $this->getPermissions($path); |
|
669 | - if (!$permissions & \OCP\Constants::PERMISSION_READ) { |
|
670 | - //can't read, nothing we can do |
|
671 | - return null; |
|
672 | - } |
|
673 | - |
|
674 | - $data = []; |
|
675 | - $data['mimetype'] = $this->getMimeType($path); |
|
676 | - $data['mtime'] = $this->filemtime($path); |
|
677 | - if ($data['mtime'] === false) { |
|
678 | - $data['mtime'] = time(); |
|
679 | - } |
|
680 | - if ($data['mimetype'] == 'httpd/unix-directory') { |
|
681 | - $data['size'] = -1; //unknown |
|
682 | - } else { |
|
683 | - $data['size'] = $this->filesize($path); |
|
684 | - } |
|
685 | - $data['etag'] = $this->getETag($path); |
|
686 | - $data['storage_mtime'] = $data['mtime']; |
|
687 | - $data['permissions'] = $permissions; |
|
688 | - |
|
689 | - return $data; |
|
690 | - } |
|
691 | - |
|
692 | - /** |
|
693 | - * @param string $path |
|
694 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
695 | - * @param \OCP\Lock\ILockingProvider $provider |
|
696 | - * @throws \OCP\Lock\LockedException |
|
697 | - */ |
|
698 | - public function acquireLock($path, $type, ILockingProvider $provider) { |
|
699 | - $logger = $this->getLockLogger(); |
|
700 | - if ($logger) { |
|
701 | - $typeString = ($type === ILockingProvider::LOCK_SHARED) ? 'shared' : 'exclusive'; |
|
702 | - $logger->info( |
|
703 | - sprintf( |
|
704 | - 'acquire %s lock on "%s" on storage "%s"', |
|
705 | - $typeString, |
|
706 | - $path, |
|
707 | - $this->getId() |
|
708 | - ), |
|
709 | - [ |
|
710 | - 'app' => 'locking', |
|
711 | - ] |
|
712 | - ); |
|
713 | - } |
|
714 | - try { |
|
715 | - $provider->acquireLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type); |
|
716 | - } catch (LockedException $e) { |
|
717 | - if ($logger) { |
|
718 | - $logger->logException($e, ['level' => ILogger::INFO]); |
|
719 | - } |
|
720 | - throw $e; |
|
721 | - } |
|
722 | - } |
|
723 | - |
|
724 | - /** |
|
725 | - * @param string $path |
|
726 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
727 | - * @param \OCP\Lock\ILockingProvider $provider |
|
728 | - * @throws \OCP\Lock\LockedException |
|
729 | - */ |
|
730 | - public function releaseLock($path, $type, ILockingProvider $provider) { |
|
731 | - $logger = $this->getLockLogger(); |
|
732 | - if ($logger) { |
|
733 | - $typeString = ($type === ILockingProvider::LOCK_SHARED) ? 'shared' : 'exclusive'; |
|
734 | - $logger->info( |
|
735 | - sprintf( |
|
736 | - 'release %s lock on "%s" on storage "%s"', |
|
737 | - $typeString, |
|
738 | - $path, |
|
739 | - $this->getId() |
|
740 | - ), |
|
741 | - [ |
|
742 | - 'app' => 'locking', |
|
743 | - ] |
|
744 | - ); |
|
745 | - } |
|
746 | - try { |
|
747 | - $provider->releaseLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type); |
|
748 | - } catch (LockedException $e) { |
|
749 | - if ($logger) { |
|
750 | - $logger->logException($e, ['level' => ILogger::INFO]); |
|
751 | - } |
|
752 | - throw $e; |
|
753 | - } |
|
754 | - } |
|
755 | - |
|
756 | - /** |
|
757 | - * @param string $path |
|
758 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
759 | - * @param \OCP\Lock\ILockingProvider $provider |
|
760 | - * @throws \OCP\Lock\LockedException |
|
761 | - */ |
|
762 | - public function changeLock($path, $type, ILockingProvider $provider) { |
|
763 | - $logger = $this->getLockLogger(); |
|
764 | - if ($logger) { |
|
765 | - $typeString = ($type === ILockingProvider::LOCK_SHARED) ? 'shared' : 'exclusive'; |
|
766 | - $logger->info( |
|
767 | - sprintf( |
|
768 | - 'change lock on "%s" to %s on storage "%s"', |
|
769 | - $path, |
|
770 | - $typeString, |
|
771 | - $this->getId() |
|
772 | - ), |
|
773 | - [ |
|
774 | - 'app' => 'locking', |
|
775 | - ] |
|
776 | - ); |
|
777 | - } |
|
778 | - try { |
|
779 | - $provider->changeLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type); |
|
780 | - } catch (LockedException $e) { |
|
781 | - \OC::$server->getLogger()->logException($e, ['level' => ILogger::INFO]); |
|
782 | - throw $e; |
|
783 | - } |
|
784 | - } |
|
785 | - |
|
786 | - private function getLockLogger() { |
|
787 | - if (is_null($this->shouldLogLocks)) { |
|
788 | - $this->shouldLogLocks = \OC::$server->getConfig()->getSystemValue('filelocking.debug', false); |
|
789 | - $this->logger = $this->shouldLogLocks ? \OC::$server->getLogger() : null; |
|
790 | - } |
|
791 | - return $this->logger; |
|
792 | - } |
|
793 | - |
|
794 | - /** |
|
795 | - * @return array [ available, last_checked ] |
|
796 | - */ |
|
797 | - public function getAvailability() { |
|
798 | - return $this->getStorageCache()->getAvailability(); |
|
799 | - } |
|
800 | - |
|
801 | - /** |
|
802 | - * @param bool $isAvailable |
|
803 | - */ |
|
804 | - public function setAvailability($isAvailable) { |
|
805 | - $this->getStorageCache()->setAvailability($isAvailable); |
|
806 | - } |
|
807 | - |
|
808 | - /** |
|
809 | - * @return bool |
|
810 | - */ |
|
811 | - public function needsPartFile() { |
|
812 | - return true; |
|
813 | - } |
|
814 | - |
|
815 | - /** |
|
816 | - * fallback implementation |
|
817 | - * |
|
818 | - * @param string $path |
|
819 | - * @param resource $stream |
|
820 | - * @param int $size |
|
821 | - * @return int |
|
822 | - */ |
|
823 | - public function writeStream(string $path, $stream, int $size = null): int { |
|
824 | - $target = $this->fopen($path, 'w'); |
|
825 | - if (!$target) { |
|
826 | - return 0; |
|
827 | - } |
|
828 | - list($count, $result) = \OC_Helper::streamCopy($stream, $target); |
|
829 | - fclose($stream); |
|
830 | - fclose($target); |
|
831 | - return $count; |
|
832 | - } |
|
532 | + throw new InvalidCharacterInPathException(); |
|
533 | + } |
|
534 | + } |
|
535 | + |
|
536 | + if (isset($fileName[255])) { |
|
537 | + throw new FileNameTooLongException(); |
|
538 | + } |
|
539 | + |
|
540 | + // NOTE: $path will remain unverified for now |
|
541 | + $this->verifyPosixPath($fileName); |
|
542 | + } |
|
543 | + |
|
544 | + /** |
|
545 | + * @param string $fileName |
|
546 | + * @throws InvalidPathException |
|
547 | + */ |
|
548 | + protected function verifyPosixPath($fileName) { |
|
549 | + $fileName = trim($fileName); |
|
550 | + $this->scanForInvalidCharacters($fileName, "\\/"); |
|
551 | + $reservedNames = ['*']; |
|
552 | + if (in_array($fileName, $reservedNames)) { |
|
553 | + throw new ReservedWordException(); |
|
554 | + } |
|
555 | + } |
|
556 | + |
|
557 | + /** |
|
558 | + * @param string $fileName |
|
559 | + * @param string $invalidChars |
|
560 | + * @throws InvalidPathException |
|
561 | + */ |
|
562 | + private function scanForInvalidCharacters($fileName, $invalidChars) { |
|
563 | + foreach (str_split($invalidChars) as $char) { |
|
564 | + if (strpos($fileName, $char) !== false) { |
|
565 | + throw new InvalidCharacterInPathException(); |
|
566 | + } |
|
567 | + } |
|
568 | + |
|
569 | + $sanitizedFileName = filter_var($fileName, FILTER_UNSAFE_RAW, FILTER_FLAG_STRIP_LOW); |
|
570 | + if ($sanitizedFileName !== $fileName) { |
|
571 | + throw new InvalidCharacterInPathException(); |
|
572 | + } |
|
573 | + } |
|
574 | + |
|
575 | + /** |
|
576 | + * @param array $options |
|
577 | + */ |
|
578 | + public function setMountOptions(array $options) { |
|
579 | + $this->mountOptions = $options; |
|
580 | + } |
|
581 | + |
|
582 | + /** |
|
583 | + * @param string $name |
|
584 | + * @param mixed $default |
|
585 | + * @return mixed |
|
586 | + */ |
|
587 | + public function getMountOption($name, $default = null) { |
|
588 | + return isset($this->mountOptions[$name]) ? $this->mountOptions[$name] : $default; |
|
589 | + } |
|
590 | + |
|
591 | + /** |
|
592 | + * @param IStorage $sourceStorage |
|
593 | + * @param string $sourceInternalPath |
|
594 | + * @param string $targetInternalPath |
|
595 | + * @param bool $preserveMtime |
|
596 | + * @return bool |
|
597 | + */ |
|
598 | + public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false) { |
|
599 | + if ($sourceStorage === $this) { |
|
600 | + return $this->copy($sourceInternalPath, $targetInternalPath); |
|
601 | + } |
|
602 | + |
|
603 | + if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
604 | + $dh = $sourceStorage->opendir($sourceInternalPath); |
|
605 | + $result = $this->mkdir($targetInternalPath); |
|
606 | + if (is_resource($dh)) { |
|
607 | + while ($result and ($file = readdir($dh)) !== false) { |
|
608 | + if (!Filesystem::isIgnoredDir($file)) { |
|
609 | + $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file); |
|
610 | + } |
|
611 | + } |
|
612 | + } |
|
613 | + } else { |
|
614 | + $source = $sourceStorage->fopen($sourceInternalPath, 'r'); |
|
615 | + // TODO: call fopen in a way that we execute again all storage wrappers |
|
616 | + // to avoid that we bypass storage wrappers which perform important actions |
|
617 | + // for this operation. Same is true for all other operations which |
|
618 | + // are not the same as the original one.Once this is fixed we also |
|
619 | + // need to adjust the encryption wrapper. |
|
620 | + $target = $this->fopen($targetInternalPath, 'w'); |
|
621 | + list(, $result) = \OC_Helper::streamCopy($source, $target); |
|
622 | + if ($result and $preserveMtime) { |
|
623 | + $this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath)); |
|
624 | + } |
|
625 | + fclose($source); |
|
626 | + fclose($target); |
|
627 | + |
|
628 | + if (!$result) { |
|
629 | + // delete partially written target file |
|
630 | + $this->unlink($targetInternalPath); |
|
631 | + // delete cache entry that was created by fopen |
|
632 | + $this->getCache()->remove($targetInternalPath); |
|
633 | + } |
|
634 | + } |
|
635 | + return (bool)$result; |
|
636 | + } |
|
637 | + |
|
638 | + /** |
|
639 | + * @param IStorage $sourceStorage |
|
640 | + * @param string $sourceInternalPath |
|
641 | + * @param string $targetInternalPath |
|
642 | + * @return bool |
|
643 | + */ |
|
644 | + public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) { |
|
645 | + if ($sourceStorage === $this) { |
|
646 | + return $this->rename($sourceInternalPath, $targetInternalPath); |
|
647 | + } |
|
648 | + |
|
649 | + if (!$sourceStorage->isDeletable($sourceInternalPath)) { |
|
650 | + return false; |
|
651 | + } |
|
652 | + |
|
653 | + $result = $this->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, true); |
|
654 | + if ($result) { |
|
655 | + if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
656 | + $result &= $sourceStorage->rmdir($sourceInternalPath); |
|
657 | + } else { |
|
658 | + $result &= $sourceStorage->unlink($sourceInternalPath); |
|
659 | + } |
|
660 | + } |
|
661 | + return $result; |
|
662 | + } |
|
663 | + |
|
664 | + /** |
|
665 | + * @inheritdoc |
|
666 | + */ |
|
667 | + public function getMetaData($path) { |
|
668 | + $permissions = $this->getPermissions($path); |
|
669 | + if (!$permissions & \OCP\Constants::PERMISSION_READ) { |
|
670 | + //can't read, nothing we can do |
|
671 | + return null; |
|
672 | + } |
|
673 | + |
|
674 | + $data = []; |
|
675 | + $data['mimetype'] = $this->getMimeType($path); |
|
676 | + $data['mtime'] = $this->filemtime($path); |
|
677 | + if ($data['mtime'] === false) { |
|
678 | + $data['mtime'] = time(); |
|
679 | + } |
|
680 | + if ($data['mimetype'] == 'httpd/unix-directory') { |
|
681 | + $data['size'] = -1; //unknown |
|
682 | + } else { |
|
683 | + $data['size'] = $this->filesize($path); |
|
684 | + } |
|
685 | + $data['etag'] = $this->getETag($path); |
|
686 | + $data['storage_mtime'] = $data['mtime']; |
|
687 | + $data['permissions'] = $permissions; |
|
688 | + |
|
689 | + return $data; |
|
690 | + } |
|
691 | + |
|
692 | + /** |
|
693 | + * @param string $path |
|
694 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
695 | + * @param \OCP\Lock\ILockingProvider $provider |
|
696 | + * @throws \OCP\Lock\LockedException |
|
697 | + */ |
|
698 | + public function acquireLock($path, $type, ILockingProvider $provider) { |
|
699 | + $logger = $this->getLockLogger(); |
|
700 | + if ($logger) { |
|
701 | + $typeString = ($type === ILockingProvider::LOCK_SHARED) ? 'shared' : 'exclusive'; |
|
702 | + $logger->info( |
|
703 | + sprintf( |
|
704 | + 'acquire %s lock on "%s" on storage "%s"', |
|
705 | + $typeString, |
|
706 | + $path, |
|
707 | + $this->getId() |
|
708 | + ), |
|
709 | + [ |
|
710 | + 'app' => 'locking', |
|
711 | + ] |
|
712 | + ); |
|
713 | + } |
|
714 | + try { |
|
715 | + $provider->acquireLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type); |
|
716 | + } catch (LockedException $e) { |
|
717 | + if ($logger) { |
|
718 | + $logger->logException($e, ['level' => ILogger::INFO]); |
|
719 | + } |
|
720 | + throw $e; |
|
721 | + } |
|
722 | + } |
|
723 | + |
|
724 | + /** |
|
725 | + * @param string $path |
|
726 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
727 | + * @param \OCP\Lock\ILockingProvider $provider |
|
728 | + * @throws \OCP\Lock\LockedException |
|
729 | + */ |
|
730 | + public function releaseLock($path, $type, ILockingProvider $provider) { |
|
731 | + $logger = $this->getLockLogger(); |
|
732 | + if ($logger) { |
|
733 | + $typeString = ($type === ILockingProvider::LOCK_SHARED) ? 'shared' : 'exclusive'; |
|
734 | + $logger->info( |
|
735 | + sprintf( |
|
736 | + 'release %s lock on "%s" on storage "%s"', |
|
737 | + $typeString, |
|
738 | + $path, |
|
739 | + $this->getId() |
|
740 | + ), |
|
741 | + [ |
|
742 | + 'app' => 'locking', |
|
743 | + ] |
|
744 | + ); |
|
745 | + } |
|
746 | + try { |
|
747 | + $provider->releaseLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type); |
|
748 | + } catch (LockedException $e) { |
|
749 | + if ($logger) { |
|
750 | + $logger->logException($e, ['level' => ILogger::INFO]); |
|
751 | + } |
|
752 | + throw $e; |
|
753 | + } |
|
754 | + } |
|
755 | + |
|
756 | + /** |
|
757 | + * @param string $path |
|
758 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
759 | + * @param \OCP\Lock\ILockingProvider $provider |
|
760 | + * @throws \OCP\Lock\LockedException |
|
761 | + */ |
|
762 | + public function changeLock($path, $type, ILockingProvider $provider) { |
|
763 | + $logger = $this->getLockLogger(); |
|
764 | + if ($logger) { |
|
765 | + $typeString = ($type === ILockingProvider::LOCK_SHARED) ? 'shared' : 'exclusive'; |
|
766 | + $logger->info( |
|
767 | + sprintf( |
|
768 | + 'change lock on "%s" to %s on storage "%s"', |
|
769 | + $path, |
|
770 | + $typeString, |
|
771 | + $this->getId() |
|
772 | + ), |
|
773 | + [ |
|
774 | + 'app' => 'locking', |
|
775 | + ] |
|
776 | + ); |
|
777 | + } |
|
778 | + try { |
|
779 | + $provider->changeLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type); |
|
780 | + } catch (LockedException $e) { |
|
781 | + \OC::$server->getLogger()->logException($e, ['level' => ILogger::INFO]); |
|
782 | + throw $e; |
|
783 | + } |
|
784 | + } |
|
785 | + |
|
786 | + private function getLockLogger() { |
|
787 | + if (is_null($this->shouldLogLocks)) { |
|
788 | + $this->shouldLogLocks = \OC::$server->getConfig()->getSystemValue('filelocking.debug', false); |
|
789 | + $this->logger = $this->shouldLogLocks ? \OC::$server->getLogger() : null; |
|
790 | + } |
|
791 | + return $this->logger; |
|
792 | + } |
|
793 | + |
|
794 | + /** |
|
795 | + * @return array [ available, last_checked ] |
|
796 | + */ |
|
797 | + public function getAvailability() { |
|
798 | + return $this->getStorageCache()->getAvailability(); |
|
799 | + } |
|
800 | + |
|
801 | + /** |
|
802 | + * @param bool $isAvailable |
|
803 | + */ |
|
804 | + public function setAvailability($isAvailable) { |
|
805 | + $this->getStorageCache()->setAvailability($isAvailable); |
|
806 | + } |
|
807 | + |
|
808 | + /** |
|
809 | + * @return bool |
|
810 | + */ |
|
811 | + public function needsPartFile() { |
|
812 | + return true; |
|
813 | + } |
|
814 | + |
|
815 | + /** |
|
816 | + * fallback implementation |
|
817 | + * |
|
818 | + * @param string $path |
|
819 | + * @param resource $stream |
|
820 | + * @param int $size |
|
821 | + * @return int |
|
822 | + */ |
|
823 | + public function writeStream(string $path, $stream, int $size = null): int { |
|
824 | + $target = $this->fopen($path, 'w'); |
|
825 | + if (!$target) { |
|
826 | + return 0; |
|
827 | + } |
|
828 | + list($count, $result) = \OC_Helper::streamCopy($stream, $target); |
|
829 | + fclose($stream); |
|
830 | + fclose($target); |
|
831 | + return $count; |
|
832 | + } |
|
833 | 833 | } |
@@ -220,7 +220,7 @@ discard block |
||
220 | 220 | $this->mkdir($path2); |
221 | 221 | while ($file = readdir($dir)) { |
222 | 222 | if (!Filesystem::isIgnoredDir($file)) { |
223 | - if (!$this->copy($path1 . '/' . $file, $path2 . '/' . $file)) { |
|
223 | + if (!$this->copy($path1.'/'.$file, $path2.'/'.$file)) { |
|
224 | 224 | return false; |
225 | 225 | } |
226 | 226 | } |
@@ -274,12 +274,12 @@ discard block |
||
274 | 274 | if (is_resource($dh)) { |
275 | 275 | while (($file = readdir($dh)) !== false) { |
276 | 276 | if (!\OC\Files\Filesystem::isIgnoredDir($file)) { |
277 | - if ($this->is_dir($path . '/' . $file)) { |
|
278 | - mkdir($target . '/' . $file); |
|
279 | - $this->addLocalFolder($path . '/' . $file, $target . '/' . $file); |
|
277 | + if ($this->is_dir($path.'/'.$file)) { |
|
278 | + mkdir($target.'/'.$file); |
|
279 | + $this->addLocalFolder($path.'/'.$file, $target.'/'.$file); |
|
280 | 280 | } else { |
281 | - $tmp = $this->toTmpFile($path . '/' . $file); |
|
282 | - rename($tmp, $target . '/' . $file); |
|
281 | + $tmp = $this->toTmpFile($path.'/'.$file); |
|
282 | + rename($tmp, $target.'/'.$file); |
|
283 | 283 | } |
284 | 284 | } |
285 | 285 | } |
@@ -298,10 +298,10 @@ discard block |
||
298 | 298 | while (($item = readdir($dh)) !== false) { |
299 | 299 | if (\OC\Files\Filesystem::isIgnoredDir($item)) continue; |
300 | 300 | if (strstr(strtolower($item), strtolower($query)) !== false) { |
301 | - $files[] = $dir . '/' . $item; |
|
301 | + $files[] = $dir.'/'.$item; |
|
302 | 302 | } |
303 | - if ($this->is_dir($dir . '/' . $item)) { |
|
304 | - $files = array_merge($files, $this->searchInDir($query, $dir . '/' . $item)); |
|
303 | + if ($this->is_dir($dir.'/'.$item)) { |
|
304 | + $files = array_merge($files, $this->searchInDir($query, $dir.'/'.$item)); |
|
305 | 305 | } |
306 | 306 | } |
307 | 307 | } |
@@ -352,7 +352,7 @@ discard block |
||
352 | 352 | if (!isset($this->watcher)) { |
353 | 353 | $this->watcher = new Watcher($storage); |
354 | 354 | $globalPolicy = \OC::$server->getConfig()->getSystemValue('filesystem_check_changes', Watcher::CHECK_NEVER); |
355 | - $this->watcher->setPolicy((int)$this->getMountOption('filesystem_check_changes', $globalPolicy)); |
|
355 | + $this->watcher->setPolicy((int) $this->getMountOption('filesystem_check_changes', $globalPolicy)); |
|
356 | 356 | } |
357 | 357 | return $this->watcher; |
358 | 358 | } |
@@ -369,7 +369,7 @@ discard block |
||
369 | 369 | } |
370 | 370 | if (!isset($storage->propagator)) { |
371 | 371 | $config = \OC::$server->getSystemConfig(); |
372 | - $storage->propagator = new Propagator($storage, \OC::$server->getDatabaseConnection(), ['appdata_' . $config->getValue('instanceid')]); |
|
372 | + $storage->propagator = new Propagator($storage, \OC::$server->getDatabaseConnection(), ['appdata_'.$config->getValue('instanceid')]); |
|
373 | 373 | } |
374 | 374 | return $storage->propagator; |
375 | 375 | } |
@@ -427,7 +427,7 @@ discard block |
||
427 | 427 | */ |
428 | 428 | public function cleanPath($path) { |
429 | 429 | if (strlen($path) == 0 or $path[0] != '/') { |
430 | - $path = '/' . $path; |
|
430 | + $path = '/'.$path; |
|
431 | 431 | } |
432 | 432 | |
433 | 433 | $output = array(); |
@@ -455,7 +455,7 @@ discard block |
||
455 | 455 | \OC::$server->getLogger()->info("External storage not available: stat() failed"); |
456 | 456 | return false; |
457 | 457 | } catch (\Exception $e) { |
458 | - \OC::$server->getLogger()->info("External storage not available: " . $e->getMessage()); |
|
458 | + \OC::$server->getLogger()->info("External storage not available: ".$e->getMessage()); |
|
459 | 459 | \OC::$server->getLogger()->logException($e, ['level' => ILogger::DEBUG]); |
460 | 460 | return false; |
461 | 461 | } |
@@ -606,7 +606,7 @@ discard block |
||
606 | 606 | if (is_resource($dh)) { |
607 | 607 | while ($result and ($file = readdir($dh)) !== false) { |
608 | 608 | if (!Filesystem::isIgnoredDir($file)) { |
609 | - $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file); |
|
609 | + $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath.'/'.$file, $targetInternalPath.'/'.$file); |
|
610 | 610 | } |
611 | 611 | } |
612 | 612 | } |
@@ -632,7 +632,7 @@ discard block |
||
632 | 632 | $this->getCache()->remove($targetInternalPath); |
633 | 633 | } |
634 | 634 | } |
635 | - return (bool)$result; |
|
635 | + return (bool) $result; |
|
636 | 636 | } |
637 | 637 | |
638 | 638 | /** |
@@ -712,7 +712,7 @@ discard block |
||
712 | 712 | ); |
713 | 713 | } |
714 | 714 | try { |
715 | - $provider->acquireLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type); |
|
715 | + $provider->acquireLock('files/'.md5($this->getId().'::'.trim($path, '/')), $type); |
|
716 | 716 | } catch (LockedException $e) { |
717 | 717 | if ($logger) { |
718 | 718 | $logger->logException($e, ['level' => ILogger::INFO]); |
@@ -744,7 +744,7 @@ discard block |
||
744 | 744 | ); |
745 | 745 | } |
746 | 746 | try { |
747 | - $provider->releaseLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type); |
|
747 | + $provider->releaseLock('files/'.md5($this->getId().'::'.trim($path, '/')), $type); |
|
748 | 748 | } catch (LockedException $e) { |
749 | 749 | if ($logger) { |
750 | 750 | $logger->logException($e, ['level' => ILogger::INFO]); |
@@ -776,7 +776,7 @@ discard block |
||
776 | 776 | ); |
777 | 777 | } |
778 | 778 | try { |
779 | - $provider->changeLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type); |
|
779 | + $provider->changeLock('files/'.md5($this->getId().'::'.trim($path, '/')), $type); |
|
780 | 780 | } catch (LockedException $e) { |
781 | 781 | \OC::$server->getLogger()->logException($e, ['level' => ILogger::INFO]); |
782 | 782 | throw $e; |