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