@@ -984,7 +984,7 @@ discard block |
||
984 | 984 | /** |
985 | 985 | * check if path points to a files version |
986 | 986 | * |
987 | - * @param $path |
|
987 | + * @param string $path |
|
988 | 988 | * @return bool |
989 | 989 | */ |
990 | 990 | protected function isVersion($path) { |
@@ -995,7 +995,7 @@ discard block |
||
995 | 995 | /** |
996 | 996 | * check if the given storage should be encrypted or not |
997 | 997 | * |
998 | - * @param $path |
|
998 | + * @param string $path |
|
999 | 999 | * @return bool |
1000 | 1000 | */ |
1001 | 1001 | protected function shouldEncrypt($path) { |
@@ -368,8 +368,8 @@ discard block |
||
368 | 368 | // check if the file is stored in the array cache, this means that we |
369 | 369 | // copy a file over to the versions folder, in this case we don't want to |
370 | 370 | // decrypt it |
371 | - if ($this->arrayCache->hasKey('encryption_copy_version_' . $path)) { |
|
372 | - $this->arrayCache->remove('encryption_copy_version_' . $path); |
|
371 | + if ($this->arrayCache->hasKey('encryption_copy_version_'.$path)) { |
|
372 | + $this->arrayCache->remove('encryption_copy_version_'.$path); |
|
373 | 373 | return $this->storage->fopen($path, $mode); |
374 | 374 | } |
375 | 375 | |
@@ -439,8 +439,8 @@ discard block |
||
439 | 439 | } |
440 | 440 | } |
441 | 441 | } catch (ModuleDoesNotExistsException $e) { |
442 | - $this->logger->warning('Encryption module "' . $encryptionModuleId . |
|
443 | - '" not found, file will be stored unencrypted (' . $e->getMessage() . ')'); |
|
442 | + $this->logger->warning('Encryption module "'.$encryptionModuleId. |
|
443 | + '" not found, file will be stored unencrypted ('.$e->getMessage().')'); |
|
444 | 444 | } |
445 | 445 | |
446 | 446 | // encryption disabled on write of new file and write to existing unencrypted file -> don't encrypt |
@@ -492,7 +492,7 @@ discard block |
||
492 | 492 | try { |
493 | 493 | $result = $this->fixUnencryptedSize($path, $size, $unencryptedSize); |
494 | 494 | } catch (\Exception $e) { |
495 | - $this->logger->error('Couldn\'t re-calculate unencrypted size for '. $path); |
|
495 | + $this->logger->error('Couldn\'t re-calculate unencrypted size for '.$path); |
|
496 | 496 | $this->logger->logException($e); |
497 | 497 | } |
498 | 498 | unset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]); |
@@ -521,7 +521,7 @@ discard block |
||
521 | 521 | |
522 | 522 | // if we couldn't open the file we return the old unencrypted size |
523 | 523 | if (!is_resource($stream)) { |
524 | - $this->logger->error('Could not open ' . $path . '. Recalculation of unencrypted size aborted.'); |
|
524 | + $this->logger->error('Could not open '.$path.'. Recalculation of unencrypted size aborted.'); |
|
525 | 525 | return $unencryptedSize; |
526 | 526 | } |
527 | 527 | |
@@ -546,7 +546,7 @@ discard block |
||
546 | 546 | // next highest is end of chunks, one subtracted is last one |
547 | 547 | // we have to read the last chunk, we can't just calculate it (because of padding etc) |
548 | 548 | |
549 | - $lastChunkNr = ceil($size/ $blockSize)-1; |
|
549 | + $lastChunkNr = ceil($size / $blockSize) - 1; |
|
550 | 550 | // calculate last chunk position |
551 | 551 | $lastChunkPos = ($lastChunkNr * $blockSize); |
552 | 552 | // try to fseek to the last chunk, if it fails we have to read the whole file |
@@ -554,16 +554,16 @@ discard block |
||
554 | 554 | $newUnencryptedSize += $lastChunkNr * $unencryptedBlockSize; |
555 | 555 | } |
556 | 556 | |
557 | - $lastChunkContentEncrypted=''; |
|
557 | + $lastChunkContentEncrypted = ''; |
|
558 | 558 | $count = $blockSize; |
559 | 559 | |
560 | 560 | while ($count > 0) { |
561 | - $data=fread($stream, $blockSize); |
|
562 | - $count=strlen($data); |
|
561 | + $data = fread($stream, $blockSize); |
|
562 | + $count = strlen($data); |
|
563 | 563 | $lastChunkContentEncrypted .= $data; |
564 | - if(strlen($lastChunkContentEncrypted) > $blockSize) { |
|
564 | + if (strlen($lastChunkContentEncrypted) > $blockSize) { |
|
565 | 565 | $newUnencryptedSize += $unencryptedBlockSize; |
566 | - $lastChunkContentEncrypted=substr($lastChunkContentEncrypted, $blockSize); |
|
566 | + $lastChunkContentEncrypted = substr($lastChunkContentEncrypted, $blockSize); |
|
567 | 567 | } |
568 | 568 | } |
569 | 569 | |
@@ -571,8 +571,8 @@ discard block |
||
571 | 571 | |
572 | 572 | // we have to decrypt the last chunk to get it actual size |
573 | 573 | $encryptionModule->begin($this->getFullPath($path), $this->uid, 'r', $header, []); |
574 | - $decryptedLastChunk = $encryptionModule->decrypt($lastChunkContentEncrypted, $lastChunkNr . 'end'); |
|
575 | - $decryptedLastChunk .= $encryptionModule->end($this->getFullPath($path), $lastChunkNr . 'end'); |
|
574 | + $decryptedLastChunk = $encryptionModule->decrypt($lastChunkContentEncrypted, $lastChunkNr.'end'); |
|
575 | + $decryptedLastChunk .= $encryptionModule->end($this->getFullPath($path), $lastChunkNr.'end'); |
|
576 | 576 | |
577 | 577 | // calc the real file size with the size of the last chunk |
578 | 578 | $newUnencryptedSize += strlen($decryptedLastChunk); |
@@ -653,9 +653,9 @@ discard block |
||
653 | 653 | private function updateEncryptedVersion(Storage $sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename) { |
654 | 654 | $isEncrypted = $this->encryptionManager->isEnabled() && $this->shouldEncrypt($targetInternalPath) ? 1 : 0; |
655 | 655 | $cacheInformation = [ |
656 | - 'encrypted' => (bool)$isEncrypted, |
|
656 | + 'encrypted' => (bool) $isEncrypted, |
|
657 | 657 | ]; |
658 | - if($isEncrypted === 1) { |
|
658 | + if ($isEncrypted === 1) { |
|
659 | 659 | $encryptedVersion = $sourceStorage->getCache()->get($sourceInternalPath)['encryptedVersion']; |
660 | 660 | |
661 | 661 | // In case of a move operation from an unencrypted to an encrypted |
@@ -663,7 +663,7 @@ discard block |
||
663 | 663 | // correct value would be "1". Thus we manually set the value to "1" |
664 | 664 | // for those cases. |
665 | 665 | // See also https://github.com/owncloud/core/issues/23078 |
666 | - if($encryptedVersion === 0) { |
|
666 | + if ($encryptedVersion === 0) { |
|
667 | 667 | $encryptedVersion = 1; |
668 | 668 | } |
669 | 669 | |
@@ -699,9 +699,9 @@ discard block |
||
699 | 699 | // remember that we try to create a version so that we can detect it during |
700 | 700 | // fopen($sourceInternalPath) and by-pass the encryption in order to |
701 | 701 | // create a 1:1 copy of the file |
702 | - $this->arrayCache->set('encryption_copy_version_' . $sourceInternalPath, true); |
|
702 | + $this->arrayCache->set('encryption_copy_version_'.$sourceInternalPath, true); |
|
703 | 703 | $result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
704 | - $this->arrayCache->remove('encryption_copy_version_' . $sourceInternalPath); |
|
704 | + $this->arrayCache->remove('encryption_copy_version_'.$sourceInternalPath); |
|
705 | 705 | if ($result) { |
706 | 706 | $info = $this->getCache('', $sourceStorage)->get($sourceInternalPath); |
707 | 707 | // make sure that we update the unencrypted size for the version |
@@ -721,7 +721,7 @@ discard block |
||
721 | 721 | $mount = $this->mountManager->findByStorageId($sourceStorage->getId()); |
722 | 722 | if (count($mount) === 1) { |
723 | 723 | $mountPoint = $mount[0]->getMountPoint(); |
724 | - $source = $mountPoint . '/' . $sourceInternalPath; |
|
724 | + $source = $mountPoint.'/'.$sourceInternalPath; |
|
725 | 725 | $target = $this->getFullPath($targetInternalPath); |
726 | 726 | $this->copyKeys($source, $target); |
727 | 727 | } else { |
@@ -734,7 +734,7 @@ discard block |
||
734 | 734 | if (is_resource($dh)) { |
735 | 735 | while ($result and ($file = readdir($dh)) !== false) { |
736 | 736 | if (!Filesystem::isIgnoredDir($file)) { |
737 | - $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file, false, $isRename); |
|
737 | + $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath.'/'.$file, $targetInternalPath.'/'.$file, false, $isRename); |
|
738 | 738 | } |
739 | 739 | } |
740 | 740 | } |
@@ -750,7 +750,7 @@ discard block |
||
750 | 750 | fclose($target); |
751 | 751 | throw $e; |
752 | 752 | } |
753 | - if($result) { |
|
753 | + if ($result) { |
|
754 | 754 | if ($preserveMtime) { |
755 | 755 | $this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath)); |
756 | 756 | } |
@@ -762,7 +762,7 @@ discard block |
||
762 | 762 | $this->getCache()->remove($targetInternalPath); |
763 | 763 | } |
764 | 764 | } |
765 | - return (bool)$result; |
|
765 | + return (bool) $result; |
|
766 | 766 | |
767 | 767 | } |
768 | 768 | |
@@ -833,7 +833,7 @@ discard block |
||
833 | 833 | * @return string full path including mount point |
834 | 834 | */ |
835 | 835 | protected function getFullPath($path) { |
836 | - return Filesystem::normalizePath($this->mountPoint . '/' . $path); |
|
836 | + return Filesystem::normalizePath($this->mountPoint.'/'.$path); |
|
837 | 837 | } |
838 | 838 | |
839 | 839 | /** |
@@ -889,7 +889,7 @@ discard block |
||
889 | 889 | $header = substr($header, 0, $endAt + strlen(Util::HEADER_END)); |
890 | 890 | |
891 | 891 | // +1 to not start with an ':' which would result in empty element at the beginning |
892 | - $exploded = explode(':', substr($header, strlen(Util::HEADER_START)+1)); |
|
892 | + $exploded = explode(':', substr($header, strlen(Util::HEADER_START) + 1)); |
|
893 | 893 | |
894 | 894 | $element = array_shift($exploded); |
895 | 895 | while ($element !== Util::HEADER_END) { |
@@ -950,7 +950,7 @@ discard block |
||
950 | 950 | try { |
951 | 951 | $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
952 | 952 | } catch (ModuleDoesNotExistsException $e) { |
953 | - $this->logger->critical('Encryption module defined in "' . $path . '" not loaded!'); |
|
953 | + $this->logger->critical('Encryption module defined in "'.$path.'" not loaded!'); |
|
954 | 954 | throw $e; |
955 | 955 | } |
956 | 956 | } |
@@ -46,979 +46,979 @@ |
||
46 | 46 | |
47 | 47 | class Encryption extends Wrapper { |
48 | 48 | |
49 | - use LocalTempFileTrait; |
|
50 | - |
|
51 | - /** @var string */ |
|
52 | - private $mountPoint; |
|
53 | - |
|
54 | - /** @var \OC\Encryption\Util */ |
|
55 | - private $util; |
|
56 | - |
|
57 | - /** @var \OCP\Encryption\IManager */ |
|
58 | - private $encryptionManager; |
|
59 | - |
|
60 | - /** @var \OCP\ILogger */ |
|
61 | - private $logger; |
|
62 | - |
|
63 | - /** @var string */ |
|
64 | - private $uid; |
|
65 | - |
|
66 | - /** @var array */ |
|
67 | - protected $unencryptedSize; |
|
68 | - |
|
69 | - /** @var \OCP\Encryption\IFile */ |
|
70 | - private $fileHelper; |
|
71 | - |
|
72 | - /** @var IMountPoint */ |
|
73 | - private $mount; |
|
74 | - |
|
75 | - /** @var IStorage */ |
|
76 | - private $keyStorage; |
|
77 | - |
|
78 | - /** @var Update */ |
|
79 | - private $update; |
|
80 | - |
|
81 | - /** @var Manager */ |
|
82 | - private $mountManager; |
|
83 | - |
|
84 | - /** @var array remember for which path we execute the repair step to avoid recursions */ |
|
85 | - private $fixUnencryptedSizeOf = array(); |
|
86 | - |
|
87 | - /** @var ArrayCache */ |
|
88 | - private $arrayCache; |
|
89 | - |
|
90 | - /** |
|
91 | - * @param array $parameters |
|
92 | - * @param IManager $encryptionManager |
|
93 | - * @param Util $util |
|
94 | - * @param ILogger $logger |
|
95 | - * @param IFile $fileHelper |
|
96 | - * @param string $uid |
|
97 | - * @param IStorage $keyStorage |
|
98 | - * @param Update $update |
|
99 | - * @param Manager $mountManager |
|
100 | - * @param ArrayCache $arrayCache |
|
101 | - */ |
|
102 | - public function __construct( |
|
103 | - $parameters, |
|
104 | - IManager $encryptionManager = null, |
|
105 | - Util $util = null, |
|
106 | - ILogger $logger = null, |
|
107 | - IFile $fileHelper = null, |
|
108 | - $uid = null, |
|
109 | - IStorage $keyStorage = null, |
|
110 | - Update $update = null, |
|
111 | - Manager $mountManager = null, |
|
112 | - ArrayCache $arrayCache = null |
|
113 | - ) { |
|
114 | - |
|
115 | - $this->mountPoint = $parameters['mountPoint']; |
|
116 | - $this->mount = $parameters['mount']; |
|
117 | - $this->encryptionManager = $encryptionManager; |
|
118 | - $this->util = $util; |
|
119 | - $this->logger = $logger; |
|
120 | - $this->uid = $uid; |
|
121 | - $this->fileHelper = $fileHelper; |
|
122 | - $this->keyStorage = $keyStorage; |
|
123 | - $this->unencryptedSize = array(); |
|
124 | - $this->update = $update; |
|
125 | - $this->mountManager = $mountManager; |
|
126 | - $this->arrayCache = $arrayCache; |
|
127 | - parent::__construct($parameters); |
|
128 | - } |
|
129 | - |
|
130 | - /** |
|
131 | - * see http://php.net/manual/en/function.filesize.php |
|
132 | - * The result for filesize when called on a folder is required to be 0 |
|
133 | - * |
|
134 | - * @param string $path |
|
135 | - * @return int |
|
136 | - */ |
|
137 | - public function filesize($path) { |
|
138 | - $fullPath = $this->getFullPath($path); |
|
139 | - |
|
140 | - /** @var CacheEntry $info */ |
|
141 | - $info = $this->getCache()->get($path); |
|
142 | - if (isset($this->unencryptedSize[$fullPath])) { |
|
143 | - $size = $this->unencryptedSize[$fullPath]; |
|
144 | - // update file cache |
|
145 | - if ($info instanceof ICacheEntry) { |
|
146 | - $info = $info->getData(); |
|
147 | - $info['encrypted'] = $info['encryptedVersion']; |
|
148 | - } else { |
|
149 | - if (!is_array($info)) { |
|
150 | - $info = []; |
|
151 | - } |
|
152 | - $info['encrypted'] = true; |
|
153 | - } |
|
154 | - |
|
155 | - $info['size'] = $size; |
|
156 | - $this->getCache()->put($path, $info); |
|
157 | - |
|
158 | - return $size; |
|
159 | - } |
|
160 | - |
|
161 | - if (isset($info['fileid']) && $info['encrypted']) { |
|
162 | - return $this->verifyUnencryptedSize($path, $info['size']); |
|
163 | - } |
|
164 | - |
|
165 | - return $this->storage->filesize($path); |
|
166 | - } |
|
167 | - |
|
168 | - /** |
|
169 | - * @param string $path |
|
170 | - * @return array |
|
171 | - */ |
|
172 | - public function getMetaData($path) { |
|
173 | - $data = $this->storage->getMetaData($path); |
|
174 | - if (is_null($data)) { |
|
175 | - return null; |
|
176 | - } |
|
177 | - $fullPath = $this->getFullPath($path); |
|
178 | - $info = $this->getCache()->get($path); |
|
179 | - |
|
180 | - if (isset($this->unencryptedSize[$fullPath])) { |
|
181 | - $data['encrypted'] = true; |
|
182 | - $data['size'] = $this->unencryptedSize[$fullPath]; |
|
183 | - } else { |
|
184 | - if (isset($info['fileid']) && $info['encrypted']) { |
|
185 | - $data['size'] = $this->verifyUnencryptedSize($path, $info['size']); |
|
186 | - $data['encrypted'] = true; |
|
187 | - } |
|
188 | - } |
|
189 | - |
|
190 | - if (isset($info['encryptedVersion']) && $info['encryptedVersion'] > 1) { |
|
191 | - $data['encryptedVersion'] = $info['encryptedVersion']; |
|
192 | - } |
|
193 | - |
|
194 | - return $data; |
|
195 | - } |
|
196 | - |
|
197 | - /** |
|
198 | - * see http://php.net/manual/en/function.file_get_contents.php |
|
199 | - * |
|
200 | - * @param string $path |
|
201 | - * @return string |
|
202 | - */ |
|
203 | - public function file_get_contents($path) { |
|
204 | - |
|
205 | - $encryptionModule = $this->getEncryptionModule($path); |
|
206 | - |
|
207 | - if ($encryptionModule) { |
|
208 | - $handle = $this->fopen($path, "r"); |
|
209 | - if (!$handle) { |
|
210 | - return false; |
|
211 | - } |
|
212 | - $data = stream_get_contents($handle); |
|
213 | - fclose($handle); |
|
214 | - return $data; |
|
215 | - } |
|
216 | - return $this->storage->file_get_contents($path); |
|
217 | - } |
|
218 | - |
|
219 | - /** |
|
220 | - * see http://php.net/manual/en/function.file_put_contents.php |
|
221 | - * |
|
222 | - * @param string $path |
|
223 | - * @param string $data |
|
224 | - * @return bool |
|
225 | - */ |
|
226 | - public function file_put_contents($path, $data) { |
|
227 | - // file put content will always be translated to a stream write |
|
228 | - $handle = $this->fopen($path, 'w'); |
|
229 | - if (is_resource($handle)) { |
|
230 | - $written = fwrite($handle, $data); |
|
231 | - fclose($handle); |
|
232 | - return $written; |
|
233 | - } |
|
234 | - |
|
235 | - return false; |
|
236 | - } |
|
237 | - |
|
238 | - /** |
|
239 | - * see http://php.net/manual/en/function.unlink.php |
|
240 | - * |
|
241 | - * @param string $path |
|
242 | - * @return bool |
|
243 | - */ |
|
244 | - public function unlink($path) { |
|
245 | - $fullPath = $this->getFullPath($path); |
|
246 | - if ($this->util->isExcluded($fullPath)) { |
|
247 | - return $this->storage->unlink($path); |
|
248 | - } |
|
249 | - |
|
250 | - $encryptionModule = $this->getEncryptionModule($path); |
|
251 | - if ($encryptionModule) { |
|
252 | - $this->keyStorage->deleteAllFileKeys($this->getFullPath($path)); |
|
253 | - } |
|
254 | - |
|
255 | - return $this->storage->unlink($path); |
|
256 | - } |
|
257 | - |
|
258 | - /** |
|
259 | - * see http://php.net/manual/en/function.rename.php |
|
260 | - * |
|
261 | - * @param string $path1 |
|
262 | - * @param string $path2 |
|
263 | - * @return bool |
|
264 | - */ |
|
265 | - public function rename($path1, $path2) { |
|
266 | - |
|
267 | - $result = $this->storage->rename($path1, $path2); |
|
268 | - |
|
269 | - if ($result && |
|
270 | - // versions always use the keys from the original file, so we can skip |
|
271 | - // this step for versions |
|
272 | - $this->isVersion($path2) === false && |
|
273 | - $this->encryptionManager->isEnabled()) { |
|
274 | - $source = $this->getFullPath($path1); |
|
275 | - if (!$this->util->isExcluded($source)) { |
|
276 | - $target = $this->getFullPath($path2); |
|
277 | - if (isset($this->unencryptedSize[$source])) { |
|
278 | - $this->unencryptedSize[$target] = $this->unencryptedSize[$source]; |
|
279 | - } |
|
280 | - $this->keyStorage->renameKeys($source, $target); |
|
281 | - $module = $this->getEncryptionModule($path2); |
|
282 | - if ($module) { |
|
283 | - $module->update($target, $this->uid, []); |
|
284 | - } |
|
285 | - } |
|
286 | - } |
|
287 | - |
|
288 | - return $result; |
|
289 | - } |
|
290 | - |
|
291 | - /** |
|
292 | - * see http://php.net/manual/en/function.rmdir.php |
|
293 | - * |
|
294 | - * @param string $path |
|
295 | - * @return bool |
|
296 | - */ |
|
297 | - public function rmdir($path) { |
|
298 | - $result = $this->storage->rmdir($path); |
|
299 | - $fullPath = $this->getFullPath($path); |
|
300 | - if ($result && |
|
301 | - $this->util->isExcluded($fullPath) === false && |
|
302 | - $this->encryptionManager->isEnabled() |
|
303 | - ) { |
|
304 | - $this->keyStorage->deleteAllFileKeys($fullPath); |
|
305 | - } |
|
306 | - |
|
307 | - return $result; |
|
308 | - } |
|
309 | - |
|
310 | - /** |
|
311 | - * check if a file can be read |
|
312 | - * |
|
313 | - * @param string $path |
|
314 | - * @return bool |
|
315 | - */ |
|
316 | - public function isReadable($path) { |
|
317 | - |
|
318 | - $isReadable = true; |
|
319 | - |
|
320 | - $metaData = $this->getMetaData($path); |
|
321 | - if ( |
|
322 | - !$this->is_dir($path) && |
|
323 | - isset($metaData['encrypted']) && |
|
324 | - $metaData['encrypted'] === true |
|
325 | - ) { |
|
326 | - $fullPath = $this->getFullPath($path); |
|
327 | - $module = $this->getEncryptionModule($path); |
|
328 | - $isReadable = $module->isReadable($fullPath, $this->uid); |
|
329 | - } |
|
330 | - |
|
331 | - return $this->storage->isReadable($path) && $isReadable; |
|
332 | - } |
|
333 | - |
|
334 | - /** |
|
335 | - * see http://php.net/manual/en/function.copy.php |
|
336 | - * |
|
337 | - * @param string $path1 |
|
338 | - * @param string $path2 |
|
339 | - * @return bool |
|
340 | - */ |
|
341 | - public function copy($path1, $path2) { |
|
342 | - |
|
343 | - $source = $this->getFullPath($path1); |
|
344 | - |
|
345 | - if ($this->util->isExcluded($source)) { |
|
346 | - return $this->storage->copy($path1, $path2); |
|
347 | - } |
|
348 | - |
|
349 | - // need to stream copy file by file in case we copy between a encrypted |
|
350 | - // and a unencrypted storage |
|
351 | - $this->unlink($path2); |
|
352 | - $result = $this->copyFromStorage($this, $path1, $path2); |
|
353 | - |
|
354 | - return $result; |
|
355 | - } |
|
356 | - |
|
357 | - /** |
|
358 | - * see http://php.net/manual/en/function.fopen.php |
|
359 | - * |
|
360 | - * @param string $path |
|
361 | - * @param string $mode |
|
362 | - * @return resource|bool |
|
363 | - * @throws GenericEncryptionException |
|
364 | - * @throws ModuleDoesNotExistsException |
|
365 | - */ |
|
366 | - public function fopen($path, $mode) { |
|
367 | - |
|
368 | - // check if the file is stored in the array cache, this means that we |
|
369 | - // copy a file over to the versions folder, in this case we don't want to |
|
370 | - // decrypt it |
|
371 | - if ($this->arrayCache->hasKey('encryption_copy_version_' . $path)) { |
|
372 | - $this->arrayCache->remove('encryption_copy_version_' . $path); |
|
373 | - return $this->storage->fopen($path, $mode); |
|
374 | - } |
|
375 | - |
|
376 | - $encryptionEnabled = $this->encryptionManager->isEnabled(); |
|
377 | - $shouldEncrypt = false; |
|
378 | - $encryptionModule = null; |
|
379 | - $header = $this->getHeader($path); |
|
380 | - $signed = (isset($header['signed']) && $header['signed'] === 'true') ? true : false; |
|
381 | - $fullPath = $this->getFullPath($path); |
|
382 | - $encryptionModuleId = $this->util->getEncryptionModuleId($header); |
|
383 | - |
|
384 | - if ($this->util->isExcluded($fullPath) === false) { |
|
385 | - |
|
386 | - $size = $unencryptedSize = 0; |
|
387 | - $realFile = $this->util->stripPartialFileExtension($path); |
|
388 | - $targetExists = $this->file_exists($realFile) || $this->file_exists($path); |
|
389 | - $targetIsEncrypted = false; |
|
390 | - if ($targetExists) { |
|
391 | - // in case the file exists we require the explicit module as |
|
392 | - // specified in the file header - otherwise we need to fail hard to |
|
393 | - // prevent data loss on client side |
|
394 | - if (!empty($encryptionModuleId)) { |
|
395 | - $targetIsEncrypted = true; |
|
396 | - $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
397 | - } |
|
398 | - |
|
399 | - if ($this->file_exists($path)) { |
|
400 | - $size = $this->storage->filesize($path); |
|
401 | - $unencryptedSize = $this->filesize($path); |
|
402 | - } else { |
|
403 | - $size = $unencryptedSize = 0; |
|
404 | - } |
|
405 | - } |
|
406 | - |
|
407 | - try { |
|
408 | - |
|
409 | - if ( |
|
410 | - $mode === 'w' |
|
411 | - || $mode === 'w+' |
|
412 | - || $mode === 'wb' |
|
413 | - || $mode === 'wb+' |
|
414 | - ) { |
|
415 | - // don't overwrite encrypted files if encryption is not enabled |
|
416 | - if ($targetIsEncrypted && $encryptionEnabled === false) { |
|
417 | - throw new GenericEncryptionException('Tried to access encrypted file but encryption is not enabled'); |
|
418 | - } |
|
419 | - if ($encryptionEnabled) { |
|
420 | - // if $encryptionModuleId is empty, the default module will be used |
|
421 | - $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
422 | - $shouldEncrypt = $encryptionModule->shouldEncrypt($fullPath); |
|
423 | - $signed = true; |
|
424 | - } |
|
425 | - } else { |
|
426 | - $info = $this->getCache()->get($path); |
|
427 | - // only get encryption module if we found one in the header |
|
428 | - // or if file should be encrypted according to the file cache |
|
429 | - if (!empty($encryptionModuleId)) { |
|
430 | - $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
431 | - $shouldEncrypt = true; |
|
432 | - } else if (empty($encryptionModuleId) && $info['encrypted'] === true) { |
|
433 | - // we come from a old installation. No header and/or no module defined |
|
434 | - // but the file is encrypted. In this case we need to use the |
|
435 | - // OC_DEFAULT_MODULE to read the file |
|
436 | - $encryptionModule = $this->encryptionManager->getEncryptionModule('OC_DEFAULT_MODULE'); |
|
437 | - $shouldEncrypt = true; |
|
438 | - $targetIsEncrypted = true; |
|
439 | - } |
|
440 | - } |
|
441 | - } catch (ModuleDoesNotExistsException $e) { |
|
442 | - $this->logger->warning('Encryption module "' . $encryptionModuleId . |
|
443 | - '" not found, file will be stored unencrypted (' . $e->getMessage() . ')'); |
|
444 | - } |
|
445 | - |
|
446 | - // encryption disabled on write of new file and write to existing unencrypted file -> don't encrypt |
|
447 | - if (!$encryptionEnabled || !$this->shouldEncrypt($path)) { |
|
448 | - if (!$targetExists || !$targetIsEncrypted) { |
|
449 | - $shouldEncrypt = false; |
|
450 | - } |
|
451 | - } |
|
452 | - |
|
453 | - if ($shouldEncrypt === true && $encryptionModule !== null) { |
|
454 | - $headerSize = $this->getHeaderSize($path); |
|
455 | - $source = $this->storage->fopen($path, $mode); |
|
456 | - if (!is_resource($source)) { |
|
457 | - return false; |
|
458 | - } |
|
459 | - $handle = \OC\Files\Stream\Encryption::wrap($source, $path, $fullPath, $header, |
|
460 | - $this->uid, $encryptionModule, $this->storage, $this, $this->util, $this->fileHelper, $mode, |
|
461 | - $size, $unencryptedSize, $headerSize, $signed); |
|
462 | - return $handle; |
|
463 | - } |
|
464 | - |
|
465 | - } |
|
466 | - |
|
467 | - return $this->storage->fopen($path, $mode); |
|
468 | - } |
|
469 | - |
|
470 | - |
|
471 | - /** |
|
472 | - * perform some plausibility checks if the the unencrypted size is correct. |
|
473 | - * If not, we calculate the correct unencrypted size and return it |
|
474 | - * |
|
475 | - * @param string $path internal path relative to the storage root |
|
476 | - * @param int $unencryptedSize size of the unencrypted file |
|
477 | - * |
|
478 | - * @return int unencrypted size |
|
479 | - */ |
|
480 | - protected function verifyUnencryptedSize($path, $unencryptedSize) { |
|
481 | - |
|
482 | - $size = $this->storage->filesize($path); |
|
483 | - $result = $unencryptedSize; |
|
484 | - |
|
485 | - if ($unencryptedSize < 0 || |
|
486 | - ($size > 0 && $unencryptedSize === $size) |
|
487 | - ) { |
|
488 | - // check if we already calculate the unencrypted size for the |
|
489 | - // given path to avoid recursions |
|
490 | - if (isset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]) === false) { |
|
491 | - $this->fixUnencryptedSizeOf[$this->getFullPath($path)] = true; |
|
492 | - try { |
|
493 | - $result = $this->fixUnencryptedSize($path, $size, $unencryptedSize); |
|
494 | - } catch (\Exception $e) { |
|
495 | - $this->logger->error('Couldn\'t re-calculate unencrypted size for '. $path); |
|
496 | - $this->logger->logException($e); |
|
497 | - } |
|
498 | - unset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]); |
|
499 | - } |
|
500 | - } |
|
501 | - |
|
502 | - return $result; |
|
503 | - } |
|
504 | - |
|
505 | - /** |
|
506 | - * calculate the unencrypted size |
|
507 | - * |
|
508 | - * @param string $path internal path relative to the storage root |
|
509 | - * @param int $size size of the physical file |
|
510 | - * @param int $unencryptedSize size of the unencrypted file |
|
511 | - * |
|
512 | - * @return int calculated unencrypted size |
|
513 | - */ |
|
514 | - protected function fixUnencryptedSize($path, $size, $unencryptedSize) { |
|
515 | - |
|
516 | - $headerSize = $this->getHeaderSize($path); |
|
517 | - $header = $this->getHeader($path); |
|
518 | - $encryptionModule = $this->getEncryptionModule($path); |
|
519 | - |
|
520 | - $stream = $this->storage->fopen($path, 'r'); |
|
521 | - |
|
522 | - // if we couldn't open the file we return the old unencrypted size |
|
523 | - if (!is_resource($stream)) { |
|
524 | - $this->logger->error('Could not open ' . $path . '. Recalculation of unencrypted size aborted.'); |
|
525 | - return $unencryptedSize; |
|
526 | - } |
|
527 | - |
|
528 | - $newUnencryptedSize = 0; |
|
529 | - $size -= $headerSize; |
|
530 | - $blockSize = $this->util->getBlockSize(); |
|
531 | - |
|
532 | - // if a header exists we skip it |
|
533 | - if ($headerSize > 0) { |
|
534 | - fread($stream, $headerSize); |
|
535 | - } |
|
536 | - |
|
537 | - // fast path, else the calculation for $lastChunkNr is bogus |
|
538 | - if ($size === 0) { |
|
539 | - return 0; |
|
540 | - } |
|
541 | - |
|
542 | - $signed = (isset($header['signed']) && $header['signed'] === 'true') ? true : false; |
|
543 | - $unencryptedBlockSize = $encryptionModule->getUnencryptedBlockSize($signed); |
|
544 | - |
|
545 | - // calculate last chunk nr |
|
546 | - // next highest is end of chunks, one subtracted is last one |
|
547 | - // we have to read the last chunk, we can't just calculate it (because of padding etc) |
|
548 | - |
|
549 | - $lastChunkNr = ceil($size/ $blockSize)-1; |
|
550 | - // calculate last chunk position |
|
551 | - $lastChunkPos = ($lastChunkNr * $blockSize); |
|
552 | - // try to fseek to the last chunk, if it fails we have to read the whole file |
|
553 | - if (@fseek($stream, $lastChunkPos, SEEK_CUR) === 0) { |
|
554 | - $newUnencryptedSize += $lastChunkNr * $unencryptedBlockSize; |
|
555 | - } |
|
556 | - |
|
557 | - $lastChunkContentEncrypted=''; |
|
558 | - $count = $blockSize; |
|
559 | - |
|
560 | - while ($count > 0) { |
|
561 | - $data=fread($stream, $blockSize); |
|
562 | - $count=strlen($data); |
|
563 | - $lastChunkContentEncrypted .= $data; |
|
564 | - if(strlen($lastChunkContentEncrypted) > $blockSize) { |
|
565 | - $newUnencryptedSize += $unencryptedBlockSize; |
|
566 | - $lastChunkContentEncrypted=substr($lastChunkContentEncrypted, $blockSize); |
|
567 | - } |
|
568 | - } |
|
569 | - |
|
570 | - fclose($stream); |
|
571 | - |
|
572 | - // we have to decrypt the last chunk to get it actual size |
|
573 | - $encryptionModule->begin($this->getFullPath($path), $this->uid, 'r', $header, []); |
|
574 | - $decryptedLastChunk = $encryptionModule->decrypt($lastChunkContentEncrypted, $lastChunkNr . 'end'); |
|
575 | - $decryptedLastChunk .= $encryptionModule->end($this->getFullPath($path), $lastChunkNr . 'end'); |
|
576 | - |
|
577 | - // calc the real file size with the size of the last chunk |
|
578 | - $newUnencryptedSize += strlen($decryptedLastChunk); |
|
579 | - |
|
580 | - $this->updateUnencryptedSize($this->getFullPath($path), $newUnencryptedSize); |
|
581 | - |
|
582 | - // write to cache if applicable |
|
583 | - $cache = $this->storage->getCache(); |
|
584 | - if ($cache) { |
|
585 | - $entry = $cache->get($path); |
|
586 | - $cache->update($entry['fileid'], ['size' => $newUnencryptedSize]); |
|
587 | - } |
|
588 | - |
|
589 | - return $newUnencryptedSize; |
|
590 | - } |
|
591 | - |
|
592 | - /** |
|
593 | - * @param Storage $sourceStorage |
|
594 | - * @param string $sourceInternalPath |
|
595 | - * @param string $targetInternalPath |
|
596 | - * @param bool $preserveMtime |
|
597 | - * @return bool |
|
598 | - */ |
|
599 | - public function moveFromStorage(Storage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = true) { |
|
600 | - if ($sourceStorage === $this) { |
|
601 | - return $this->rename($sourceInternalPath, $targetInternalPath); |
|
602 | - } |
|
603 | - |
|
604 | - // TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed: |
|
605 | - // - call $this->storage->moveFromStorage() instead of $this->copyBetweenStorage |
|
606 | - // - copy the file cache update from $this->copyBetweenStorage to this method |
|
607 | - // - copy the copyKeys() call from $this->copyBetweenStorage to this method |
|
608 | - // - remove $this->copyBetweenStorage |
|
609 | - |
|
610 | - if (!$sourceStorage->isDeletable($sourceInternalPath)) { |
|
611 | - return false; |
|
612 | - } |
|
613 | - |
|
614 | - $result = $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, true); |
|
615 | - if ($result) { |
|
616 | - if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
617 | - $result &= $sourceStorage->rmdir($sourceInternalPath); |
|
618 | - } else { |
|
619 | - $result &= $sourceStorage->unlink($sourceInternalPath); |
|
620 | - } |
|
621 | - } |
|
622 | - return $result; |
|
623 | - } |
|
624 | - |
|
625 | - |
|
626 | - /** |
|
627 | - * @param Storage $sourceStorage |
|
628 | - * @param string $sourceInternalPath |
|
629 | - * @param string $targetInternalPath |
|
630 | - * @param bool $preserveMtime |
|
631 | - * @param bool $isRename |
|
632 | - * @return bool |
|
633 | - */ |
|
634 | - public function copyFromStorage(Storage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false, $isRename = false) { |
|
635 | - |
|
636 | - // TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed: |
|
637 | - // - call $this->storage->copyFromStorage() instead of $this->copyBetweenStorage |
|
638 | - // - copy the file cache update from $this->copyBetweenStorage to this method |
|
639 | - // - copy the copyKeys() call from $this->copyBetweenStorage to this method |
|
640 | - // - remove $this->copyBetweenStorage |
|
641 | - |
|
642 | - return $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename); |
|
643 | - } |
|
644 | - |
|
645 | - /** |
|
646 | - * Update the encrypted cache version in the database |
|
647 | - * |
|
648 | - * @param Storage $sourceStorage |
|
649 | - * @param string $sourceInternalPath |
|
650 | - * @param string $targetInternalPath |
|
651 | - * @param bool $isRename |
|
652 | - */ |
|
653 | - private function updateEncryptedVersion(Storage $sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename) { |
|
654 | - $isEncrypted = $this->encryptionManager->isEnabled() && $this->shouldEncrypt($targetInternalPath) ? 1 : 0; |
|
655 | - $cacheInformation = [ |
|
656 | - 'encrypted' => (bool)$isEncrypted, |
|
657 | - ]; |
|
658 | - if($isEncrypted === 1) { |
|
659 | - $encryptedVersion = $sourceStorage->getCache()->get($sourceInternalPath)['encryptedVersion']; |
|
660 | - |
|
661 | - // In case of a move operation from an unencrypted to an encrypted |
|
662 | - // storage the old encrypted version would stay with "0" while the |
|
663 | - // correct value would be "1". Thus we manually set the value to "1" |
|
664 | - // for those cases. |
|
665 | - // See also https://github.com/owncloud/core/issues/23078 |
|
666 | - if($encryptedVersion === 0) { |
|
667 | - $encryptedVersion = 1; |
|
668 | - } |
|
669 | - |
|
670 | - $cacheInformation['encryptedVersion'] = $encryptedVersion; |
|
671 | - } |
|
672 | - |
|
673 | - // in case of a rename we need to manipulate the source cache because |
|
674 | - // this information will be kept for the new target |
|
675 | - if ($isRename) { |
|
676 | - $sourceStorage->getCache()->put($sourceInternalPath, $cacheInformation); |
|
677 | - } else { |
|
678 | - $this->getCache()->put($targetInternalPath, $cacheInformation); |
|
679 | - } |
|
680 | - } |
|
681 | - |
|
682 | - /** |
|
683 | - * copy file between two storages |
|
684 | - * |
|
685 | - * @param Storage $sourceStorage |
|
686 | - * @param string $sourceInternalPath |
|
687 | - * @param string $targetInternalPath |
|
688 | - * @param bool $preserveMtime |
|
689 | - * @param bool $isRename |
|
690 | - * @return bool |
|
691 | - * @throws \Exception |
|
692 | - */ |
|
693 | - private function copyBetweenStorage(Storage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename) { |
|
694 | - |
|
695 | - // for versions we have nothing to do, because versions should always use the |
|
696 | - // key from the original file. Just create a 1:1 copy and done |
|
697 | - if ($this->isVersion($targetInternalPath) || |
|
698 | - $this->isVersion($sourceInternalPath)) { |
|
699 | - // remember that we try to create a version so that we can detect it during |
|
700 | - // fopen($sourceInternalPath) and by-pass the encryption in order to |
|
701 | - // create a 1:1 copy of the file |
|
702 | - $this->arrayCache->set('encryption_copy_version_' . $sourceInternalPath, true); |
|
703 | - $result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
|
704 | - $this->arrayCache->remove('encryption_copy_version_' . $sourceInternalPath); |
|
705 | - if ($result) { |
|
706 | - $info = $this->getCache('', $sourceStorage)->get($sourceInternalPath); |
|
707 | - // make sure that we update the unencrypted size for the version |
|
708 | - if (isset($info['encrypted']) && $info['encrypted'] === true) { |
|
709 | - $this->updateUnencryptedSize( |
|
710 | - $this->getFullPath($targetInternalPath), |
|
711 | - $info['size'] |
|
712 | - ); |
|
713 | - } |
|
714 | - $this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename); |
|
715 | - } |
|
716 | - return $result; |
|
717 | - } |
|
718 | - |
|
719 | - // first copy the keys that we reuse the existing file key on the target location |
|
720 | - // and don't create a new one which would break versions for example. |
|
721 | - $mount = $this->mountManager->findByStorageId($sourceStorage->getId()); |
|
722 | - if (count($mount) === 1) { |
|
723 | - $mountPoint = $mount[0]->getMountPoint(); |
|
724 | - $source = $mountPoint . '/' . $sourceInternalPath; |
|
725 | - $target = $this->getFullPath($targetInternalPath); |
|
726 | - $this->copyKeys($source, $target); |
|
727 | - } else { |
|
728 | - $this->logger->error('Could not find mount point, can\'t keep encryption keys'); |
|
729 | - } |
|
730 | - |
|
731 | - if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
732 | - $dh = $sourceStorage->opendir($sourceInternalPath); |
|
733 | - $result = $this->mkdir($targetInternalPath); |
|
734 | - if (is_resource($dh)) { |
|
735 | - while ($result and ($file = readdir($dh)) !== false) { |
|
736 | - if (!Filesystem::isIgnoredDir($file)) { |
|
737 | - $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file, false, $isRename); |
|
738 | - } |
|
739 | - } |
|
740 | - } |
|
741 | - } else { |
|
742 | - try { |
|
743 | - $source = $sourceStorage->fopen($sourceInternalPath, 'r'); |
|
744 | - $target = $this->fopen($targetInternalPath, 'w'); |
|
745 | - list(, $result) = \OC_Helper::streamCopy($source, $target); |
|
746 | - fclose($source); |
|
747 | - fclose($target); |
|
748 | - } catch (\Exception $e) { |
|
749 | - fclose($source); |
|
750 | - fclose($target); |
|
751 | - throw $e; |
|
752 | - } |
|
753 | - if($result) { |
|
754 | - if ($preserveMtime) { |
|
755 | - $this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath)); |
|
756 | - } |
|
757 | - $this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename); |
|
758 | - } else { |
|
759 | - // delete partially written target file |
|
760 | - $this->unlink($targetInternalPath); |
|
761 | - // delete cache entry that was created by fopen |
|
762 | - $this->getCache()->remove($targetInternalPath); |
|
763 | - } |
|
764 | - } |
|
765 | - return (bool)$result; |
|
766 | - |
|
767 | - } |
|
768 | - |
|
769 | - /** |
|
770 | - * get the path to a local version of the file. |
|
771 | - * The local version of the file can be temporary and doesn't have to be persistent across requests |
|
772 | - * |
|
773 | - * @param string $path |
|
774 | - * @return string |
|
775 | - */ |
|
776 | - public function getLocalFile($path) { |
|
777 | - if ($this->encryptionManager->isEnabled()) { |
|
778 | - $cachedFile = $this->getCachedFile($path); |
|
779 | - if (is_string($cachedFile)) { |
|
780 | - return $cachedFile; |
|
781 | - } |
|
782 | - } |
|
783 | - return $this->storage->getLocalFile($path); |
|
784 | - } |
|
785 | - |
|
786 | - /** |
|
787 | - * Returns the wrapped storage's value for isLocal() |
|
788 | - * |
|
789 | - * @return bool wrapped storage's isLocal() value |
|
790 | - */ |
|
791 | - public function isLocal() { |
|
792 | - if ($this->encryptionManager->isEnabled()) { |
|
793 | - return false; |
|
794 | - } |
|
795 | - return $this->storage->isLocal(); |
|
796 | - } |
|
797 | - |
|
798 | - /** |
|
799 | - * see http://php.net/manual/en/function.stat.php |
|
800 | - * only the following keys are required in the result: size and mtime |
|
801 | - * |
|
802 | - * @param string $path |
|
803 | - * @return array |
|
804 | - */ |
|
805 | - public function stat($path) { |
|
806 | - $stat = $this->storage->stat($path); |
|
807 | - $fileSize = $this->filesize($path); |
|
808 | - $stat['size'] = $fileSize; |
|
809 | - $stat[7] = $fileSize; |
|
810 | - return $stat; |
|
811 | - } |
|
812 | - |
|
813 | - /** |
|
814 | - * see http://php.net/manual/en/function.hash.php |
|
815 | - * |
|
816 | - * @param string $type |
|
817 | - * @param string $path |
|
818 | - * @param bool $raw |
|
819 | - * @return string |
|
820 | - */ |
|
821 | - public function hash($type, $path, $raw = false) { |
|
822 | - $fh = $this->fopen($path, 'rb'); |
|
823 | - $ctx = hash_init($type); |
|
824 | - hash_update_stream($ctx, $fh); |
|
825 | - fclose($fh); |
|
826 | - return hash_final($ctx, $raw); |
|
827 | - } |
|
828 | - |
|
829 | - /** |
|
830 | - * return full path, including mount point |
|
831 | - * |
|
832 | - * @param string $path relative to mount point |
|
833 | - * @return string full path including mount point |
|
834 | - */ |
|
835 | - protected function getFullPath($path) { |
|
836 | - return Filesystem::normalizePath($this->mountPoint . '/' . $path); |
|
837 | - } |
|
838 | - |
|
839 | - /** |
|
840 | - * read first block of encrypted file, typically this will contain the |
|
841 | - * encryption header |
|
842 | - * |
|
843 | - * @param string $path |
|
844 | - * @return string |
|
845 | - */ |
|
846 | - protected function readFirstBlock($path) { |
|
847 | - $firstBlock = ''; |
|
848 | - if ($this->storage->file_exists($path)) { |
|
849 | - $handle = $this->storage->fopen($path, 'r'); |
|
850 | - $firstBlock = fread($handle, $this->util->getHeaderSize()); |
|
851 | - fclose($handle); |
|
852 | - } |
|
853 | - return $firstBlock; |
|
854 | - } |
|
855 | - |
|
856 | - /** |
|
857 | - * return header size of given file |
|
858 | - * |
|
859 | - * @param string $path |
|
860 | - * @return int |
|
861 | - */ |
|
862 | - protected function getHeaderSize($path) { |
|
863 | - $headerSize = 0; |
|
864 | - $realFile = $this->util->stripPartialFileExtension($path); |
|
865 | - if ($this->storage->file_exists($realFile)) { |
|
866 | - $path = $realFile; |
|
867 | - } |
|
868 | - $firstBlock = $this->readFirstBlock($path); |
|
869 | - |
|
870 | - if (substr($firstBlock, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) { |
|
871 | - $headerSize = $this->util->getHeaderSize(); |
|
872 | - } |
|
873 | - |
|
874 | - return $headerSize; |
|
875 | - } |
|
876 | - |
|
877 | - /** |
|
878 | - * parse raw header to array |
|
879 | - * |
|
880 | - * @param string $rawHeader |
|
881 | - * @return array |
|
882 | - */ |
|
883 | - protected function parseRawHeader($rawHeader) { |
|
884 | - $result = array(); |
|
885 | - if (substr($rawHeader, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) { |
|
886 | - $header = $rawHeader; |
|
887 | - $endAt = strpos($header, Util::HEADER_END); |
|
888 | - if ($endAt !== false) { |
|
889 | - $header = substr($header, 0, $endAt + strlen(Util::HEADER_END)); |
|
890 | - |
|
891 | - // +1 to not start with an ':' which would result in empty element at the beginning |
|
892 | - $exploded = explode(':', substr($header, strlen(Util::HEADER_START)+1)); |
|
893 | - |
|
894 | - $element = array_shift($exploded); |
|
895 | - while ($element !== Util::HEADER_END) { |
|
896 | - $result[$element] = array_shift($exploded); |
|
897 | - $element = array_shift($exploded); |
|
898 | - } |
|
899 | - } |
|
900 | - } |
|
901 | - |
|
902 | - return $result; |
|
903 | - } |
|
904 | - |
|
905 | - /** |
|
906 | - * read header from file |
|
907 | - * |
|
908 | - * @param string $path |
|
909 | - * @return array |
|
910 | - */ |
|
911 | - protected function getHeader($path) { |
|
912 | - $realFile = $this->util->stripPartialFileExtension($path); |
|
913 | - $exists = $this->storage->file_exists($realFile); |
|
914 | - if ($exists) { |
|
915 | - $path = $realFile; |
|
916 | - } |
|
917 | - |
|
918 | - $firstBlock = $this->readFirstBlock($path); |
|
919 | - $result = $this->parseRawHeader($firstBlock); |
|
920 | - |
|
921 | - // if the header doesn't contain a encryption module we check if it is a |
|
922 | - // legacy file. If true, we add the default encryption module |
|
923 | - if (!isset($result[Util::HEADER_ENCRYPTION_MODULE_KEY])) { |
|
924 | - if (!empty($result)) { |
|
925 | - $result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE'; |
|
926 | - } else if ($exists) { |
|
927 | - // if the header was empty we have to check first if it is a encrypted file at all |
|
928 | - // We would do query to filecache only if we know that entry in filecache exists |
|
929 | - $info = $this->getCache()->get($path); |
|
930 | - if (isset($info['encrypted']) && $info['encrypted'] === true) { |
|
931 | - $result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE'; |
|
932 | - } |
|
933 | - } |
|
934 | - } |
|
935 | - |
|
936 | - return $result; |
|
937 | - } |
|
938 | - |
|
939 | - /** |
|
940 | - * read encryption module needed to read/write the file located at $path |
|
941 | - * |
|
942 | - * @param string $path |
|
943 | - * @return null|\OCP\Encryption\IEncryptionModule |
|
944 | - * @throws ModuleDoesNotExistsException |
|
945 | - * @throws \Exception |
|
946 | - */ |
|
947 | - protected function getEncryptionModule($path) { |
|
948 | - $encryptionModule = null; |
|
949 | - $header = $this->getHeader($path); |
|
950 | - $encryptionModuleId = $this->util->getEncryptionModuleId($header); |
|
951 | - if (!empty($encryptionModuleId)) { |
|
952 | - try { |
|
953 | - $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
954 | - } catch (ModuleDoesNotExistsException $e) { |
|
955 | - $this->logger->critical('Encryption module defined in "' . $path . '" not loaded!'); |
|
956 | - throw $e; |
|
957 | - } |
|
958 | - } |
|
959 | - |
|
960 | - return $encryptionModule; |
|
961 | - } |
|
962 | - |
|
963 | - /** |
|
964 | - * @param string $path |
|
965 | - * @param int $unencryptedSize |
|
966 | - */ |
|
967 | - public function updateUnencryptedSize($path, $unencryptedSize) { |
|
968 | - $this->unencryptedSize[$path] = $unencryptedSize; |
|
969 | - } |
|
970 | - |
|
971 | - /** |
|
972 | - * copy keys to new location |
|
973 | - * |
|
974 | - * @param string $source path relative to data/ |
|
975 | - * @param string $target path relative to data/ |
|
976 | - * @return bool |
|
977 | - */ |
|
978 | - protected function copyKeys($source, $target) { |
|
979 | - if (!$this->util->isExcluded($source)) { |
|
980 | - return $this->keyStorage->copyKeys($source, $target); |
|
981 | - } |
|
982 | - |
|
983 | - return false; |
|
984 | - } |
|
985 | - |
|
986 | - /** |
|
987 | - * check if path points to a files version |
|
988 | - * |
|
989 | - * @param $path |
|
990 | - * @return bool |
|
991 | - */ |
|
992 | - protected function isVersion($path) { |
|
993 | - $normalized = Filesystem::normalizePath($path); |
|
994 | - return substr($normalized, 0, strlen('/files_versions/')) === '/files_versions/'; |
|
995 | - } |
|
996 | - |
|
997 | - /** |
|
998 | - * check if the given storage should be encrypted or not |
|
999 | - * |
|
1000 | - * @param $path |
|
1001 | - * @return bool |
|
1002 | - */ |
|
1003 | - protected function shouldEncrypt($path) { |
|
1004 | - $fullPath = $this->getFullPath($path); |
|
1005 | - $mountPointConfig = $this->mount->getOption('encrypt', true); |
|
1006 | - if ($mountPointConfig === false) { |
|
1007 | - return false; |
|
1008 | - } |
|
1009 | - |
|
1010 | - try { |
|
1011 | - $encryptionModule = $this->getEncryptionModule($fullPath); |
|
1012 | - } catch (ModuleDoesNotExistsException $e) { |
|
1013 | - return false; |
|
1014 | - } |
|
1015 | - |
|
1016 | - if ($encryptionModule === null) { |
|
1017 | - $encryptionModule = $this->encryptionManager->getEncryptionModule(); |
|
1018 | - } |
|
1019 | - |
|
1020 | - return $encryptionModule->shouldEncrypt($fullPath); |
|
1021 | - |
|
1022 | - } |
|
49 | + use LocalTempFileTrait; |
|
50 | + |
|
51 | + /** @var string */ |
|
52 | + private $mountPoint; |
|
53 | + |
|
54 | + /** @var \OC\Encryption\Util */ |
|
55 | + private $util; |
|
56 | + |
|
57 | + /** @var \OCP\Encryption\IManager */ |
|
58 | + private $encryptionManager; |
|
59 | + |
|
60 | + /** @var \OCP\ILogger */ |
|
61 | + private $logger; |
|
62 | + |
|
63 | + /** @var string */ |
|
64 | + private $uid; |
|
65 | + |
|
66 | + /** @var array */ |
|
67 | + protected $unencryptedSize; |
|
68 | + |
|
69 | + /** @var \OCP\Encryption\IFile */ |
|
70 | + private $fileHelper; |
|
71 | + |
|
72 | + /** @var IMountPoint */ |
|
73 | + private $mount; |
|
74 | + |
|
75 | + /** @var IStorage */ |
|
76 | + private $keyStorage; |
|
77 | + |
|
78 | + /** @var Update */ |
|
79 | + private $update; |
|
80 | + |
|
81 | + /** @var Manager */ |
|
82 | + private $mountManager; |
|
83 | + |
|
84 | + /** @var array remember for which path we execute the repair step to avoid recursions */ |
|
85 | + private $fixUnencryptedSizeOf = array(); |
|
86 | + |
|
87 | + /** @var ArrayCache */ |
|
88 | + private $arrayCache; |
|
89 | + |
|
90 | + /** |
|
91 | + * @param array $parameters |
|
92 | + * @param IManager $encryptionManager |
|
93 | + * @param Util $util |
|
94 | + * @param ILogger $logger |
|
95 | + * @param IFile $fileHelper |
|
96 | + * @param string $uid |
|
97 | + * @param IStorage $keyStorage |
|
98 | + * @param Update $update |
|
99 | + * @param Manager $mountManager |
|
100 | + * @param ArrayCache $arrayCache |
|
101 | + */ |
|
102 | + public function __construct( |
|
103 | + $parameters, |
|
104 | + IManager $encryptionManager = null, |
|
105 | + Util $util = null, |
|
106 | + ILogger $logger = null, |
|
107 | + IFile $fileHelper = null, |
|
108 | + $uid = null, |
|
109 | + IStorage $keyStorage = null, |
|
110 | + Update $update = null, |
|
111 | + Manager $mountManager = null, |
|
112 | + ArrayCache $arrayCache = null |
|
113 | + ) { |
|
114 | + |
|
115 | + $this->mountPoint = $parameters['mountPoint']; |
|
116 | + $this->mount = $parameters['mount']; |
|
117 | + $this->encryptionManager = $encryptionManager; |
|
118 | + $this->util = $util; |
|
119 | + $this->logger = $logger; |
|
120 | + $this->uid = $uid; |
|
121 | + $this->fileHelper = $fileHelper; |
|
122 | + $this->keyStorage = $keyStorage; |
|
123 | + $this->unencryptedSize = array(); |
|
124 | + $this->update = $update; |
|
125 | + $this->mountManager = $mountManager; |
|
126 | + $this->arrayCache = $arrayCache; |
|
127 | + parent::__construct($parameters); |
|
128 | + } |
|
129 | + |
|
130 | + /** |
|
131 | + * see http://php.net/manual/en/function.filesize.php |
|
132 | + * The result for filesize when called on a folder is required to be 0 |
|
133 | + * |
|
134 | + * @param string $path |
|
135 | + * @return int |
|
136 | + */ |
|
137 | + public function filesize($path) { |
|
138 | + $fullPath = $this->getFullPath($path); |
|
139 | + |
|
140 | + /** @var CacheEntry $info */ |
|
141 | + $info = $this->getCache()->get($path); |
|
142 | + if (isset($this->unencryptedSize[$fullPath])) { |
|
143 | + $size = $this->unencryptedSize[$fullPath]; |
|
144 | + // update file cache |
|
145 | + if ($info instanceof ICacheEntry) { |
|
146 | + $info = $info->getData(); |
|
147 | + $info['encrypted'] = $info['encryptedVersion']; |
|
148 | + } else { |
|
149 | + if (!is_array($info)) { |
|
150 | + $info = []; |
|
151 | + } |
|
152 | + $info['encrypted'] = true; |
|
153 | + } |
|
154 | + |
|
155 | + $info['size'] = $size; |
|
156 | + $this->getCache()->put($path, $info); |
|
157 | + |
|
158 | + return $size; |
|
159 | + } |
|
160 | + |
|
161 | + if (isset($info['fileid']) && $info['encrypted']) { |
|
162 | + return $this->verifyUnencryptedSize($path, $info['size']); |
|
163 | + } |
|
164 | + |
|
165 | + return $this->storage->filesize($path); |
|
166 | + } |
|
167 | + |
|
168 | + /** |
|
169 | + * @param string $path |
|
170 | + * @return array |
|
171 | + */ |
|
172 | + public function getMetaData($path) { |
|
173 | + $data = $this->storage->getMetaData($path); |
|
174 | + if (is_null($data)) { |
|
175 | + return null; |
|
176 | + } |
|
177 | + $fullPath = $this->getFullPath($path); |
|
178 | + $info = $this->getCache()->get($path); |
|
179 | + |
|
180 | + if (isset($this->unencryptedSize[$fullPath])) { |
|
181 | + $data['encrypted'] = true; |
|
182 | + $data['size'] = $this->unencryptedSize[$fullPath]; |
|
183 | + } else { |
|
184 | + if (isset($info['fileid']) && $info['encrypted']) { |
|
185 | + $data['size'] = $this->verifyUnencryptedSize($path, $info['size']); |
|
186 | + $data['encrypted'] = true; |
|
187 | + } |
|
188 | + } |
|
189 | + |
|
190 | + if (isset($info['encryptedVersion']) && $info['encryptedVersion'] > 1) { |
|
191 | + $data['encryptedVersion'] = $info['encryptedVersion']; |
|
192 | + } |
|
193 | + |
|
194 | + return $data; |
|
195 | + } |
|
196 | + |
|
197 | + /** |
|
198 | + * see http://php.net/manual/en/function.file_get_contents.php |
|
199 | + * |
|
200 | + * @param string $path |
|
201 | + * @return string |
|
202 | + */ |
|
203 | + public function file_get_contents($path) { |
|
204 | + |
|
205 | + $encryptionModule = $this->getEncryptionModule($path); |
|
206 | + |
|
207 | + if ($encryptionModule) { |
|
208 | + $handle = $this->fopen($path, "r"); |
|
209 | + if (!$handle) { |
|
210 | + return false; |
|
211 | + } |
|
212 | + $data = stream_get_contents($handle); |
|
213 | + fclose($handle); |
|
214 | + return $data; |
|
215 | + } |
|
216 | + return $this->storage->file_get_contents($path); |
|
217 | + } |
|
218 | + |
|
219 | + /** |
|
220 | + * see http://php.net/manual/en/function.file_put_contents.php |
|
221 | + * |
|
222 | + * @param string $path |
|
223 | + * @param string $data |
|
224 | + * @return bool |
|
225 | + */ |
|
226 | + public function file_put_contents($path, $data) { |
|
227 | + // file put content will always be translated to a stream write |
|
228 | + $handle = $this->fopen($path, 'w'); |
|
229 | + if (is_resource($handle)) { |
|
230 | + $written = fwrite($handle, $data); |
|
231 | + fclose($handle); |
|
232 | + return $written; |
|
233 | + } |
|
234 | + |
|
235 | + return false; |
|
236 | + } |
|
237 | + |
|
238 | + /** |
|
239 | + * see http://php.net/manual/en/function.unlink.php |
|
240 | + * |
|
241 | + * @param string $path |
|
242 | + * @return bool |
|
243 | + */ |
|
244 | + public function unlink($path) { |
|
245 | + $fullPath = $this->getFullPath($path); |
|
246 | + if ($this->util->isExcluded($fullPath)) { |
|
247 | + return $this->storage->unlink($path); |
|
248 | + } |
|
249 | + |
|
250 | + $encryptionModule = $this->getEncryptionModule($path); |
|
251 | + if ($encryptionModule) { |
|
252 | + $this->keyStorage->deleteAllFileKeys($this->getFullPath($path)); |
|
253 | + } |
|
254 | + |
|
255 | + return $this->storage->unlink($path); |
|
256 | + } |
|
257 | + |
|
258 | + /** |
|
259 | + * see http://php.net/manual/en/function.rename.php |
|
260 | + * |
|
261 | + * @param string $path1 |
|
262 | + * @param string $path2 |
|
263 | + * @return bool |
|
264 | + */ |
|
265 | + public function rename($path1, $path2) { |
|
266 | + |
|
267 | + $result = $this->storage->rename($path1, $path2); |
|
268 | + |
|
269 | + if ($result && |
|
270 | + // versions always use the keys from the original file, so we can skip |
|
271 | + // this step for versions |
|
272 | + $this->isVersion($path2) === false && |
|
273 | + $this->encryptionManager->isEnabled()) { |
|
274 | + $source = $this->getFullPath($path1); |
|
275 | + if (!$this->util->isExcluded($source)) { |
|
276 | + $target = $this->getFullPath($path2); |
|
277 | + if (isset($this->unencryptedSize[$source])) { |
|
278 | + $this->unencryptedSize[$target] = $this->unencryptedSize[$source]; |
|
279 | + } |
|
280 | + $this->keyStorage->renameKeys($source, $target); |
|
281 | + $module = $this->getEncryptionModule($path2); |
|
282 | + if ($module) { |
|
283 | + $module->update($target, $this->uid, []); |
|
284 | + } |
|
285 | + } |
|
286 | + } |
|
287 | + |
|
288 | + return $result; |
|
289 | + } |
|
290 | + |
|
291 | + /** |
|
292 | + * see http://php.net/manual/en/function.rmdir.php |
|
293 | + * |
|
294 | + * @param string $path |
|
295 | + * @return bool |
|
296 | + */ |
|
297 | + public function rmdir($path) { |
|
298 | + $result = $this->storage->rmdir($path); |
|
299 | + $fullPath = $this->getFullPath($path); |
|
300 | + if ($result && |
|
301 | + $this->util->isExcluded($fullPath) === false && |
|
302 | + $this->encryptionManager->isEnabled() |
|
303 | + ) { |
|
304 | + $this->keyStorage->deleteAllFileKeys($fullPath); |
|
305 | + } |
|
306 | + |
|
307 | + return $result; |
|
308 | + } |
|
309 | + |
|
310 | + /** |
|
311 | + * check if a file can be read |
|
312 | + * |
|
313 | + * @param string $path |
|
314 | + * @return bool |
|
315 | + */ |
|
316 | + public function isReadable($path) { |
|
317 | + |
|
318 | + $isReadable = true; |
|
319 | + |
|
320 | + $metaData = $this->getMetaData($path); |
|
321 | + if ( |
|
322 | + !$this->is_dir($path) && |
|
323 | + isset($metaData['encrypted']) && |
|
324 | + $metaData['encrypted'] === true |
|
325 | + ) { |
|
326 | + $fullPath = $this->getFullPath($path); |
|
327 | + $module = $this->getEncryptionModule($path); |
|
328 | + $isReadable = $module->isReadable($fullPath, $this->uid); |
|
329 | + } |
|
330 | + |
|
331 | + return $this->storage->isReadable($path) && $isReadable; |
|
332 | + } |
|
333 | + |
|
334 | + /** |
|
335 | + * see http://php.net/manual/en/function.copy.php |
|
336 | + * |
|
337 | + * @param string $path1 |
|
338 | + * @param string $path2 |
|
339 | + * @return bool |
|
340 | + */ |
|
341 | + public function copy($path1, $path2) { |
|
342 | + |
|
343 | + $source = $this->getFullPath($path1); |
|
344 | + |
|
345 | + if ($this->util->isExcluded($source)) { |
|
346 | + return $this->storage->copy($path1, $path2); |
|
347 | + } |
|
348 | + |
|
349 | + // need to stream copy file by file in case we copy between a encrypted |
|
350 | + // and a unencrypted storage |
|
351 | + $this->unlink($path2); |
|
352 | + $result = $this->copyFromStorage($this, $path1, $path2); |
|
353 | + |
|
354 | + return $result; |
|
355 | + } |
|
356 | + |
|
357 | + /** |
|
358 | + * see http://php.net/manual/en/function.fopen.php |
|
359 | + * |
|
360 | + * @param string $path |
|
361 | + * @param string $mode |
|
362 | + * @return resource|bool |
|
363 | + * @throws GenericEncryptionException |
|
364 | + * @throws ModuleDoesNotExistsException |
|
365 | + */ |
|
366 | + public function fopen($path, $mode) { |
|
367 | + |
|
368 | + // check if the file is stored in the array cache, this means that we |
|
369 | + // copy a file over to the versions folder, in this case we don't want to |
|
370 | + // decrypt it |
|
371 | + if ($this->arrayCache->hasKey('encryption_copy_version_' . $path)) { |
|
372 | + $this->arrayCache->remove('encryption_copy_version_' . $path); |
|
373 | + return $this->storage->fopen($path, $mode); |
|
374 | + } |
|
375 | + |
|
376 | + $encryptionEnabled = $this->encryptionManager->isEnabled(); |
|
377 | + $shouldEncrypt = false; |
|
378 | + $encryptionModule = null; |
|
379 | + $header = $this->getHeader($path); |
|
380 | + $signed = (isset($header['signed']) && $header['signed'] === 'true') ? true : false; |
|
381 | + $fullPath = $this->getFullPath($path); |
|
382 | + $encryptionModuleId = $this->util->getEncryptionModuleId($header); |
|
383 | + |
|
384 | + if ($this->util->isExcluded($fullPath) === false) { |
|
385 | + |
|
386 | + $size = $unencryptedSize = 0; |
|
387 | + $realFile = $this->util->stripPartialFileExtension($path); |
|
388 | + $targetExists = $this->file_exists($realFile) || $this->file_exists($path); |
|
389 | + $targetIsEncrypted = false; |
|
390 | + if ($targetExists) { |
|
391 | + // in case the file exists we require the explicit module as |
|
392 | + // specified in the file header - otherwise we need to fail hard to |
|
393 | + // prevent data loss on client side |
|
394 | + if (!empty($encryptionModuleId)) { |
|
395 | + $targetIsEncrypted = true; |
|
396 | + $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
397 | + } |
|
398 | + |
|
399 | + if ($this->file_exists($path)) { |
|
400 | + $size = $this->storage->filesize($path); |
|
401 | + $unencryptedSize = $this->filesize($path); |
|
402 | + } else { |
|
403 | + $size = $unencryptedSize = 0; |
|
404 | + } |
|
405 | + } |
|
406 | + |
|
407 | + try { |
|
408 | + |
|
409 | + if ( |
|
410 | + $mode === 'w' |
|
411 | + || $mode === 'w+' |
|
412 | + || $mode === 'wb' |
|
413 | + || $mode === 'wb+' |
|
414 | + ) { |
|
415 | + // don't overwrite encrypted files if encryption is not enabled |
|
416 | + if ($targetIsEncrypted && $encryptionEnabled === false) { |
|
417 | + throw new GenericEncryptionException('Tried to access encrypted file but encryption is not enabled'); |
|
418 | + } |
|
419 | + if ($encryptionEnabled) { |
|
420 | + // if $encryptionModuleId is empty, the default module will be used |
|
421 | + $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
422 | + $shouldEncrypt = $encryptionModule->shouldEncrypt($fullPath); |
|
423 | + $signed = true; |
|
424 | + } |
|
425 | + } else { |
|
426 | + $info = $this->getCache()->get($path); |
|
427 | + // only get encryption module if we found one in the header |
|
428 | + // or if file should be encrypted according to the file cache |
|
429 | + if (!empty($encryptionModuleId)) { |
|
430 | + $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
431 | + $shouldEncrypt = true; |
|
432 | + } else if (empty($encryptionModuleId) && $info['encrypted'] === true) { |
|
433 | + // we come from a old installation. No header and/or no module defined |
|
434 | + // but the file is encrypted. In this case we need to use the |
|
435 | + // OC_DEFAULT_MODULE to read the file |
|
436 | + $encryptionModule = $this->encryptionManager->getEncryptionModule('OC_DEFAULT_MODULE'); |
|
437 | + $shouldEncrypt = true; |
|
438 | + $targetIsEncrypted = true; |
|
439 | + } |
|
440 | + } |
|
441 | + } catch (ModuleDoesNotExistsException $e) { |
|
442 | + $this->logger->warning('Encryption module "' . $encryptionModuleId . |
|
443 | + '" not found, file will be stored unencrypted (' . $e->getMessage() . ')'); |
|
444 | + } |
|
445 | + |
|
446 | + // encryption disabled on write of new file and write to existing unencrypted file -> don't encrypt |
|
447 | + if (!$encryptionEnabled || !$this->shouldEncrypt($path)) { |
|
448 | + if (!$targetExists || !$targetIsEncrypted) { |
|
449 | + $shouldEncrypt = false; |
|
450 | + } |
|
451 | + } |
|
452 | + |
|
453 | + if ($shouldEncrypt === true && $encryptionModule !== null) { |
|
454 | + $headerSize = $this->getHeaderSize($path); |
|
455 | + $source = $this->storage->fopen($path, $mode); |
|
456 | + if (!is_resource($source)) { |
|
457 | + return false; |
|
458 | + } |
|
459 | + $handle = \OC\Files\Stream\Encryption::wrap($source, $path, $fullPath, $header, |
|
460 | + $this->uid, $encryptionModule, $this->storage, $this, $this->util, $this->fileHelper, $mode, |
|
461 | + $size, $unencryptedSize, $headerSize, $signed); |
|
462 | + return $handle; |
|
463 | + } |
|
464 | + |
|
465 | + } |
|
466 | + |
|
467 | + return $this->storage->fopen($path, $mode); |
|
468 | + } |
|
469 | + |
|
470 | + |
|
471 | + /** |
|
472 | + * perform some plausibility checks if the the unencrypted size is correct. |
|
473 | + * If not, we calculate the correct unencrypted size and return it |
|
474 | + * |
|
475 | + * @param string $path internal path relative to the storage root |
|
476 | + * @param int $unencryptedSize size of the unencrypted file |
|
477 | + * |
|
478 | + * @return int unencrypted size |
|
479 | + */ |
|
480 | + protected function verifyUnencryptedSize($path, $unencryptedSize) { |
|
481 | + |
|
482 | + $size = $this->storage->filesize($path); |
|
483 | + $result = $unencryptedSize; |
|
484 | + |
|
485 | + if ($unencryptedSize < 0 || |
|
486 | + ($size > 0 && $unencryptedSize === $size) |
|
487 | + ) { |
|
488 | + // check if we already calculate the unencrypted size for the |
|
489 | + // given path to avoid recursions |
|
490 | + if (isset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]) === false) { |
|
491 | + $this->fixUnencryptedSizeOf[$this->getFullPath($path)] = true; |
|
492 | + try { |
|
493 | + $result = $this->fixUnencryptedSize($path, $size, $unencryptedSize); |
|
494 | + } catch (\Exception $e) { |
|
495 | + $this->logger->error('Couldn\'t re-calculate unencrypted size for '. $path); |
|
496 | + $this->logger->logException($e); |
|
497 | + } |
|
498 | + unset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]); |
|
499 | + } |
|
500 | + } |
|
501 | + |
|
502 | + return $result; |
|
503 | + } |
|
504 | + |
|
505 | + /** |
|
506 | + * calculate the unencrypted size |
|
507 | + * |
|
508 | + * @param string $path internal path relative to the storage root |
|
509 | + * @param int $size size of the physical file |
|
510 | + * @param int $unencryptedSize size of the unencrypted file |
|
511 | + * |
|
512 | + * @return int calculated unencrypted size |
|
513 | + */ |
|
514 | + protected function fixUnencryptedSize($path, $size, $unencryptedSize) { |
|
515 | + |
|
516 | + $headerSize = $this->getHeaderSize($path); |
|
517 | + $header = $this->getHeader($path); |
|
518 | + $encryptionModule = $this->getEncryptionModule($path); |
|
519 | + |
|
520 | + $stream = $this->storage->fopen($path, 'r'); |
|
521 | + |
|
522 | + // if we couldn't open the file we return the old unencrypted size |
|
523 | + if (!is_resource($stream)) { |
|
524 | + $this->logger->error('Could not open ' . $path . '. Recalculation of unencrypted size aborted.'); |
|
525 | + return $unencryptedSize; |
|
526 | + } |
|
527 | + |
|
528 | + $newUnencryptedSize = 0; |
|
529 | + $size -= $headerSize; |
|
530 | + $blockSize = $this->util->getBlockSize(); |
|
531 | + |
|
532 | + // if a header exists we skip it |
|
533 | + if ($headerSize > 0) { |
|
534 | + fread($stream, $headerSize); |
|
535 | + } |
|
536 | + |
|
537 | + // fast path, else the calculation for $lastChunkNr is bogus |
|
538 | + if ($size === 0) { |
|
539 | + return 0; |
|
540 | + } |
|
541 | + |
|
542 | + $signed = (isset($header['signed']) && $header['signed'] === 'true') ? true : false; |
|
543 | + $unencryptedBlockSize = $encryptionModule->getUnencryptedBlockSize($signed); |
|
544 | + |
|
545 | + // calculate last chunk nr |
|
546 | + // next highest is end of chunks, one subtracted is last one |
|
547 | + // we have to read the last chunk, we can't just calculate it (because of padding etc) |
|
548 | + |
|
549 | + $lastChunkNr = ceil($size/ $blockSize)-1; |
|
550 | + // calculate last chunk position |
|
551 | + $lastChunkPos = ($lastChunkNr * $blockSize); |
|
552 | + // try to fseek to the last chunk, if it fails we have to read the whole file |
|
553 | + if (@fseek($stream, $lastChunkPos, SEEK_CUR) === 0) { |
|
554 | + $newUnencryptedSize += $lastChunkNr * $unencryptedBlockSize; |
|
555 | + } |
|
556 | + |
|
557 | + $lastChunkContentEncrypted=''; |
|
558 | + $count = $blockSize; |
|
559 | + |
|
560 | + while ($count > 0) { |
|
561 | + $data=fread($stream, $blockSize); |
|
562 | + $count=strlen($data); |
|
563 | + $lastChunkContentEncrypted .= $data; |
|
564 | + if(strlen($lastChunkContentEncrypted) > $blockSize) { |
|
565 | + $newUnencryptedSize += $unencryptedBlockSize; |
|
566 | + $lastChunkContentEncrypted=substr($lastChunkContentEncrypted, $blockSize); |
|
567 | + } |
|
568 | + } |
|
569 | + |
|
570 | + fclose($stream); |
|
571 | + |
|
572 | + // we have to decrypt the last chunk to get it actual size |
|
573 | + $encryptionModule->begin($this->getFullPath($path), $this->uid, 'r', $header, []); |
|
574 | + $decryptedLastChunk = $encryptionModule->decrypt($lastChunkContentEncrypted, $lastChunkNr . 'end'); |
|
575 | + $decryptedLastChunk .= $encryptionModule->end($this->getFullPath($path), $lastChunkNr . 'end'); |
|
576 | + |
|
577 | + // calc the real file size with the size of the last chunk |
|
578 | + $newUnencryptedSize += strlen($decryptedLastChunk); |
|
579 | + |
|
580 | + $this->updateUnencryptedSize($this->getFullPath($path), $newUnencryptedSize); |
|
581 | + |
|
582 | + // write to cache if applicable |
|
583 | + $cache = $this->storage->getCache(); |
|
584 | + if ($cache) { |
|
585 | + $entry = $cache->get($path); |
|
586 | + $cache->update($entry['fileid'], ['size' => $newUnencryptedSize]); |
|
587 | + } |
|
588 | + |
|
589 | + return $newUnencryptedSize; |
|
590 | + } |
|
591 | + |
|
592 | + /** |
|
593 | + * @param Storage $sourceStorage |
|
594 | + * @param string $sourceInternalPath |
|
595 | + * @param string $targetInternalPath |
|
596 | + * @param bool $preserveMtime |
|
597 | + * @return bool |
|
598 | + */ |
|
599 | + public function moveFromStorage(Storage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = true) { |
|
600 | + if ($sourceStorage === $this) { |
|
601 | + return $this->rename($sourceInternalPath, $targetInternalPath); |
|
602 | + } |
|
603 | + |
|
604 | + // TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed: |
|
605 | + // - call $this->storage->moveFromStorage() instead of $this->copyBetweenStorage |
|
606 | + // - copy the file cache update from $this->copyBetweenStorage to this method |
|
607 | + // - copy the copyKeys() call from $this->copyBetweenStorage to this method |
|
608 | + // - remove $this->copyBetweenStorage |
|
609 | + |
|
610 | + if (!$sourceStorage->isDeletable($sourceInternalPath)) { |
|
611 | + return false; |
|
612 | + } |
|
613 | + |
|
614 | + $result = $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, true); |
|
615 | + if ($result) { |
|
616 | + if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
617 | + $result &= $sourceStorage->rmdir($sourceInternalPath); |
|
618 | + } else { |
|
619 | + $result &= $sourceStorage->unlink($sourceInternalPath); |
|
620 | + } |
|
621 | + } |
|
622 | + return $result; |
|
623 | + } |
|
624 | + |
|
625 | + |
|
626 | + /** |
|
627 | + * @param Storage $sourceStorage |
|
628 | + * @param string $sourceInternalPath |
|
629 | + * @param string $targetInternalPath |
|
630 | + * @param bool $preserveMtime |
|
631 | + * @param bool $isRename |
|
632 | + * @return bool |
|
633 | + */ |
|
634 | + public function copyFromStorage(Storage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false, $isRename = false) { |
|
635 | + |
|
636 | + // TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed: |
|
637 | + // - call $this->storage->copyFromStorage() instead of $this->copyBetweenStorage |
|
638 | + // - copy the file cache update from $this->copyBetweenStorage to this method |
|
639 | + // - copy the copyKeys() call from $this->copyBetweenStorage to this method |
|
640 | + // - remove $this->copyBetweenStorage |
|
641 | + |
|
642 | + return $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename); |
|
643 | + } |
|
644 | + |
|
645 | + /** |
|
646 | + * Update the encrypted cache version in the database |
|
647 | + * |
|
648 | + * @param Storage $sourceStorage |
|
649 | + * @param string $sourceInternalPath |
|
650 | + * @param string $targetInternalPath |
|
651 | + * @param bool $isRename |
|
652 | + */ |
|
653 | + private function updateEncryptedVersion(Storage $sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename) { |
|
654 | + $isEncrypted = $this->encryptionManager->isEnabled() && $this->shouldEncrypt($targetInternalPath) ? 1 : 0; |
|
655 | + $cacheInformation = [ |
|
656 | + 'encrypted' => (bool)$isEncrypted, |
|
657 | + ]; |
|
658 | + if($isEncrypted === 1) { |
|
659 | + $encryptedVersion = $sourceStorage->getCache()->get($sourceInternalPath)['encryptedVersion']; |
|
660 | + |
|
661 | + // In case of a move operation from an unencrypted to an encrypted |
|
662 | + // storage the old encrypted version would stay with "0" while the |
|
663 | + // correct value would be "1". Thus we manually set the value to "1" |
|
664 | + // for those cases. |
|
665 | + // See also https://github.com/owncloud/core/issues/23078 |
|
666 | + if($encryptedVersion === 0) { |
|
667 | + $encryptedVersion = 1; |
|
668 | + } |
|
669 | + |
|
670 | + $cacheInformation['encryptedVersion'] = $encryptedVersion; |
|
671 | + } |
|
672 | + |
|
673 | + // in case of a rename we need to manipulate the source cache because |
|
674 | + // this information will be kept for the new target |
|
675 | + if ($isRename) { |
|
676 | + $sourceStorage->getCache()->put($sourceInternalPath, $cacheInformation); |
|
677 | + } else { |
|
678 | + $this->getCache()->put($targetInternalPath, $cacheInformation); |
|
679 | + } |
|
680 | + } |
|
681 | + |
|
682 | + /** |
|
683 | + * copy file between two storages |
|
684 | + * |
|
685 | + * @param Storage $sourceStorage |
|
686 | + * @param string $sourceInternalPath |
|
687 | + * @param string $targetInternalPath |
|
688 | + * @param bool $preserveMtime |
|
689 | + * @param bool $isRename |
|
690 | + * @return bool |
|
691 | + * @throws \Exception |
|
692 | + */ |
|
693 | + private function copyBetweenStorage(Storage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename) { |
|
694 | + |
|
695 | + // for versions we have nothing to do, because versions should always use the |
|
696 | + // key from the original file. Just create a 1:1 copy and done |
|
697 | + if ($this->isVersion($targetInternalPath) || |
|
698 | + $this->isVersion($sourceInternalPath)) { |
|
699 | + // remember that we try to create a version so that we can detect it during |
|
700 | + // fopen($sourceInternalPath) and by-pass the encryption in order to |
|
701 | + // create a 1:1 copy of the file |
|
702 | + $this->arrayCache->set('encryption_copy_version_' . $sourceInternalPath, true); |
|
703 | + $result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
|
704 | + $this->arrayCache->remove('encryption_copy_version_' . $sourceInternalPath); |
|
705 | + if ($result) { |
|
706 | + $info = $this->getCache('', $sourceStorage)->get($sourceInternalPath); |
|
707 | + // make sure that we update the unencrypted size for the version |
|
708 | + if (isset($info['encrypted']) && $info['encrypted'] === true) { |
|
709 | + $this->updateUnencryptedSize( |
|
710 | + $this->getFullPath($targetInternalPath), |
|
711 | + $info['size'] |
|
712 | + ); |
|
713 | + } |
|
714 | + $this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename); |
|
715 | + } |
|
716 | + return $result; |
|
717 | + } |
|
718 | + |
|
719 | + // first copy the keys that we reuse the existing file key on the target location |
|
720 | + // and don't create a new one which would break versions for example. |
|
721 | + $mount = $this->mountManager->findByStorageId($sourceStorage->getId()); |
|
722 | + if (count($mount) === 1) { |
|
723 | + $mountPoint = $mount[0]->getMountPoint(); |
|
724 | + $source = $mountPoint . '/' . $sourceInternalPath; |
|
725 | + $target = $this->getFullPath($targetInternalPath); |
|
726 | + $this->copyKeys($source, $target); |
|
727 | + } else { |
|
728 | + $this->logger->error('Could not find mount point, can\'t keep encryption keys'); |
|
729 | + } |
|
730 | + |
|
731 | + if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
732 | + $dh = $sourceStorage->opendir($sourceInternalPath); |
|
733 | + $result = $this->mkdir($targetInternalPath); |
|
734 | + if (is_resource($dh)) { |
|
735 | + while ($result and ($file = readdir($dh)) !== false) { |
|
736 | + if (!Filesystem::isIgnoredDir($file)) { |
|
737 | + $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file, false, $isRename); |
|
738 | + } |
|
739 | + } |
|
740 | + } |
|
741 | + } else { |
|
742 | + try { |
|
743 | + $source = $sourceStorage->fopen($sourceInternalPath, 'r'); |
|
744 | + $target = $this->fopen($targetInternalPath, 'w'); |
|
745 | + list(, $result) = \OC_Helper::streamCopy($source, $target); |
|
746 | + fclose($source); |
|
747 | + fclose($target); |
|
748 | + } catch (\Exception $e) { |
|
749 | + fclose($source); |
|
750 | + fclose($target); |
|
751 | + throw $e; |
|
752 | + } |
|
753 | + if($result) { |
|
754 | + if ($preserveMtime) { |
|
755 | + $this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath)); |
|
756 | + } |
|
757 | + $this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename); |
|
758 | + } else { |
|
759 | + // delete partially written target file |
|
760 | + $this->unlink($targetInternalPath); |
|
761 | + // delete cache entry that was created by fopen |
|
762 | + $this->getCache()->remove($targetInternalPath); |
|
763 | + } |
|
764 | + } |
|
765 | + return (bool)$result; |
|
766 | + |
|
767 | + } |
|
768 | + |
|
769 | + /** |
|
770 | + * get the path to a local version of the file. |
|
771 | + * The local version of the file can be temporary and doesn't have to be persistent across requests |
|
772 | + * |
|
773 | + * @param string $path |
|
774 | + * @return string |
|
775 | + */ |
|
776 | + public function getLocalFile($path) { |
|
777 | + if ($this->encryptionManager->isEnabled()) { |
|
778 | + $cachedFile = $this->getCachedFile($path); |
|
779 | + if (is_string($cachedFile)) { |
|
780 | + return $cachedFile; |
|
781 | + } |
|
782 | + } |
|
783 | + return $this->storage->getLocalFile($path); |
|
784 | + } |
|
785 | + |
|
786 | + /** |
|
787 | + * Returns the wrapped storage's value for isLocal() |
|
788 | + * |
|
789 | + * @return bool wrapped storage's isLocal() value |
|
790 | + */ |
|
791 | + public function isLocal() { |
|
792 | + if ($this->encryptionManager->isEnabled()) { |
|
793 | + return false; |
|
794 | + } |
|
795 | + return $this->storage->isLocal(); |
|
796 | + } |
|
797 | + |
|
798 | + /** |
|
799 | + * see http://php.net/manual/en/function.stat.php |
|
800 | + * only the following keys are required in the result: size and mtime |
|
801 | + * |
|
802 | + * @param string $path |
|
803 | + * @return array |
|
804 | + */ |
|
805 | + public function stat($path) { |
|
806 | + $stat = $this->storage->stat($path); |
|
807 | + $fileSize = $this->filesize($path); |
|
808 | + $stat['size'] = $fileSize; |
|
809 | + $stat[7] = $fileSize; |
|
810 | + return $stat; |
|
811 | + } |
|
812 | + |
|
813 | + /** |
|
814 | + * see http://php.net/manual/en/function.hash.php |
|
815 | + * |
|
816 | + * @param string $type |
|
817 | + * @param string $path |
|
818 | + * @param bool $raw |
|
819 | + * @return string |
|
820 | + */ |
|
821 | + public function hash($type, $path, $raw = false) { |
|
822 | + $fh = $this->fopen($path, 'rb'); |
|
823 | + $ctx = hash_init($type); |
|
824 | + hash_update_stream($ctx, $fh); |
|
825 | + fclose($fh); |
|
826 | + return hash_final($ctx, $raw); |
|
827 | + } |
|
828 | + |
|
829 | + /** |
|
830 | + * return full path, including mount point |
|
831 | + * |
|
832 | + * @param string $path relative to mount point |
|
833 | + * @return string full path including mount point |
|
834 | + */ |
|
835 | + protected function getFullPath($path) { |
|
836 | + return Filesystem::normalizePath($this->mountPoint . '/' . $path); |
|
837 | + } |
|
838 | + |
|
839 | + /** |
|
840 | + * read first block of encrypted file, typically this will contain the |
|
841 | + * encryption header |
|
842 | + * |
|
843 | + * @param string $path |
|
844 | + * @return string |
|
845 | + */ |
|
846 | + protected function readFirstBlock($path) { |
|
847 | + $firstBlock = ''; |
|
848 | + if ($this->storage->file_exists($path)) { |
|
849 | + $handle = $this->storage->fopen($path, 'r'); |
|
850 | + $firstBlock = fread($handle, $this->util->getHeaderSize()); |
|
851 | + fclose($handle); |
|
852 | + } |
|
853 | + return $firstBlock; |
|
854 | + } |
|
855 | + |
|
856 | + /** |
|
857 | + * return header size of given file |
|
858 | + * |
|
859 | + * @param string $path |
|
860 | + * @return int |
|
861 | + */ |
|
862 | + protected function getHeaderSize($path) { |
|
863 | + $headerSize = 0; |
|
864 | + $realFile = $this->util->stripPartialFileExtension($path); |
|
865 | + if ($this->storage->file_exists($realFile)) { |
|
866 | + $path = $realFile; |
|
867 | + } |
|
868 | + $firstBlock = $this->readFirstBlock($path); |
|
869 | + |
|
870 | + if (substr($firstBlock, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) { |
|
871 | + $headerSize = $this->util->getHeaderSize(); |
|
872 | + } |
|
873 | + |
|
874 | + return $headerSize; |
|
875 | + } |
|
876 | + |
|
877 | + /** |
|
878 | + * parse raw header to array |
|
879 | + * |
|
880 | + * @param string $rawHeader |
|
881 | + * @return array |
|
882 | + */ |
|
883 | + protected function parseRawHeader($rawHeader) { |
|
884 | + $result = array(); |
|
885 | + if (substr($rawHeader, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) { |
|
886 | + $header = $rawHeader; |
|
887 | + $endAt = strpos($header, Util::HEADER_END); |
|
888 | + if ($endAt !== false) { |
|
889 | + $header = substr($header, 0, $endAt + strlen(Util::HEADER_END)); |
|
890 | + |
|
891 | + // +1 to not start with an ':' which would result in empty element at the beginning |
|
892 | + $exploded = explode(':', substr($header, strlen(Util::HEADER_START)+1)); |
|
893 | + |
|
894 | + $element = array_shift($exploded); |
|
895 | + while ($element !== Util::HEADER_END) { |
|
896 | + $result[$element] = array_shift($exploded); |
|
897 | + $element = array_shift($exploded); |
|
898 | + } |
|
899 | + } |
|
900 | + } |
|
901 | + |
|
902 | + return $result; |
|
903 | + } |
|
904 | + |
|
905 | + /** |
|
906 | + * read header from file |
|
907 | + * |
|
908 | + * @param string $path |
|
909 | + * @return array |
|
910 | + */ |
|
911 | + protected function getHeader($path) { |
|
912 | + $realFile = $this->util->stripPartialFileExtension($path); |
|
913 | + $exists = $this->storage->file_exists($realFile); |
|
914 | + if ($exists) { |
|
915 | + $path = $realFile; |
|
916 | + } |
|
917 | + |
|
918 | + $firstBlock = $this->readFirstBlock($path); |
|
919 | + $result = $this->parseRawHeader($firstBlock); |
|
920 | + |
|
921 | + // if the header doesn't contain a encryption module we check if it is a |
|
922 | + // legacy file. If true, we add the default encryption module |
|
923 | + if (!isset($result[Util::HEADER_ENCRYPTION_MODULE_KEY])) { |
|
924 | + if (!empty($result)) { |
|
925 | + $result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE'; |
|
926 | + } else if ($exists) { |
|
927 | + // if the header was empty we have to check first if it is a encrypted file at all |
|
928 | + // We would do query to filecache only if we know that entry in filecache exists |
|
929 | + $info = $this->getCache()->get($path); |
|
930 | + if (isset($info['encrypted']) && $info['encrypted'] === true) { |
|
931 | + $result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE'; |
|
932 | + } |
|
933 | + } |
|
934 | + } |
|
935 | + |
|
936 | + return $result; |
|
937 | + } |
|
938 | + |
|
939 | + /** |
|
940 | + * read encryption module needed to read/write the file located at $path |
|
941 | + * |
|
942 | + * @param string $path |
|
943 | + * @return null|\OCP\Encryption\IEncryptionModule |
|
944 | + * @throws ModuleDoesNotExistsException |
|
945 | + * @throws \Exception |
|
946 | + */ |
|
947 | + protected function getEncryptionModule($path) { |
|
948 | + $encryptionModule = null; |
|
949 | + $header = $this->getHeader($path); |
|
950 | + $encryptionModuleId = $this->util->getEncryptionModuleId($header); |
|
951 | + if (!empty($encryptionModuleId)) { |
|
952 | + try { |
|
953 | + $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
954 | + } catch (ModuleDoesNotExistsException $e) { |
|
955 | + $this->logger->critical('Encryption module defined in "' . $path . '" not loaded!'); |
|
956 | + throw $e; |
|
957 | + } |
|
958 | + } |
|
959 | + |
|
960 | + return $encryptionModule; |
|
961 | + } |
|
962 | + |
|
963 | + /** |
|
964 | + * @param string $path |
|
965 | + * @param int $unencryptedSize |
|
966 | + */ |
|
967 | + public function updateUnencryptedSize($path, $unencryptedSize) { |
|
968 | + $this->unencryptedSize[$path] = $unencryptedSize; |
|
969 | + } |
|
970 | + |
|
971 | + /** |
|
972 | + * copy keys to new location |
|
973 | + * |
|
974 | + * @param string $source path relative to data/ |
|
975 | + * @param string $target path relative to data/ |
|
976 | + * @return bool |
|
977 | + */ |
|
978 | + protected function copyKeys($source, $target) { |
|
979 | + if (!$this->util->isExcluded($source)) { |
|
980 | + return $this->keyStorage->copyKeys($source, $target); |
|
981 | + } |
|
982 | + |
|
983 | + return false; |
|
984 | + } |
|
985 | + |
|
986 | + /** |
|
987 | + * check if path points to a files version |
|
988 | + * |
|
989 | + * @param $path |
|
990 | + * @return bool |
|
991 | + */ |
|
992 | + protected function isVersion($path) { |
|
993 | + $normalized = Filesystem::normalizePath($path); |
|
994 | + return substr($normalized, 0, strlen('/files_versions/')) === '/files_versions/'; |
|
995 | + } |
|
996 | + |
|
997 | + /** |
|
998 | + * check if the given storage should be encrypted or not |
|
999 | + * |
|
1000 | + * @param $path |
|
1001 | + * @return bool |
|
1002 | + */ |
|
1003 | + protected function shouldEncrypt($path) { |
|
1004 | + $fullPath = $this->getFullPath($path); |
|
1005 | + $mountPointConfig = $this->mount->getOption('encrypt', true); |
|
1006 | + if ($mountPointConfig === false) { |
|
1007 | + return false; |
|
1008 | + } |
|
1009 | + |
|
1010 | + try { |
|
1011 | + $encryptionModule = $this->getEncryptionModule($fullPath); |
|
1012 | + } catch (ModuleDoesNotExistsException $e) { |
|
1013 | + return false; |
|
1014 | + } |
|
1015 | + |
|
1016 | + if ($encryptionModule === null) { |
|
1017 | + $encryptionModule = $this->encryptionManager->getEncryptionModule(); |
|
1018 | + } |
|
1019 | + |
|
1020 | + return $encryptionModule->shouldEncrypt($fullPath); |
|
1021 | + |
|
1022 | + } |
|
1023 | 1023 | |
1024 | 1024 | } |
@@ -191,6 +191,9 @@ discard block |
||
191 | 191 | return false; |
192 | 192 | } |
193 | 193 | |
194 | + /** |
|
195 | + * @param string $path |
|
196 | + */ |
|
194 | 197 | private function batchDelete ($path = null) { |
195 | 198 | $params = array( |
196 | 199 | 'Bucket' => $this->bucket |
@@ -516,6 +519,9 @@ discard block |
||
516 | 519 | return $this->id; |
517 | 520 | } |
518 | 521 | |
522 | + /** |
|
523 | + * @param string $path |
|
524 | + */ |
|
519 | 525 | public function writeBack($tmpFile, $path) { |
520 | 526 | try { |
521 | 527 | $this->getConnection()->putObject(array( |
@@ -37,7 +37,7 @@ discard block |
||
37 | 37 | namespace OCA\Files_External\Lib\Storage; |
38 | 38 | |
39 | 39 | set_include_path(get_include_path() . PATH_SEPARATOR . |
40 | - \OC_App::getAppPath('files_external') . '/3rdparty/aws-sdk-php'); |
|
40 | + \OC_App::getAppPath('files_external') . '/3rdparty/aws-sdk-php'); |
|
41 | 41 | require_once 'aws-autoloader.php'; |
42 | 42 | |
43 | 43 | use Aws\S3\S3Client; |
@@ -47,498 +47,498 @@ discard block |
||
47 | 47 | use OC\Files\ObjectStore\S3ConnectionTrait; |
48 | 48 | |
49 | 49 | class AmazonS3 extends \OC\Files\Storage\Common { |
50 | - use S3ConnectionTrait; |
|
51 | - |
|
52 | - /** |
|
53 | - * @var array |
|
54 | - */ |
|
55 | - private static $tmpFiles = array(); |
|
56 | - |
|
57 | - /** |
|
58 | - * @var int in seconds |
|
59 | - */ |
|
60 | - private $rescanDelay = 10; |
|
61 | - |
|
62 | - public function __construct($parameters) { |
|
63 | - parent::__construct($parameters); |
|
64 | - $this->parseParams($parameters); |
|
65 | - } |
|
66 | - |
|
67 | - /** |
|
68 | - * @param string $path |
|
69 | - * @return string correctly encoded path |
|
70 | - */ |
|
71 | - private function normalizePath($path) { |
|
72 | - $path = trim($path, '/'); |
|
73 | - |
|
74 | - if (!$path) { |
|
75 | - $path = '.'; |
|
76 | - } |
|
77 | - |
|
78 | - return $path; |
|
79 | - } |
|
80 | - |
|
81 | - private function isRoot($path) { |
|
82 | - return $path === '.'; |
|
83 | - } |
|
84 | - |
|
85 | - private function cleanKey($path) { |
|
86 | - if ($this->isRoot($path)) { |
|
87 | - return '/'; |
|
88 | - } |
|
89 | - return $path; |
|
90 | - } |
|
91 | - |
|
92 | - /** |
|
93 | - * Updates old storage ids (v0.2.1 and older) that are based on key and secret to new ones based on the bucket name. |
|
94 | - * TODO Do this in an update.php. requires iterating over all users and loading the mount.json from their home |
|
95 | - * |
|
96 | - * @param array $params |
|
97 | - */ |
|
98 | - public function updateLegacyId (array $params) { |
|
99 | - $oldId = 'amazon::' . $params['key'] . md5($params['secret']); |
|
100 | - |
|
101 | - // find by old id or bucket |
|
102 | - $stmt = \OC::$server->getDatabaseConnection()->prepare( |
|
103 | - 'SELECT `numeric_id`, `id` FROM `*PREFIX*storages` WHERE `id` IN (?, ?)' |
|
104 | - ); |
|
105 | - $stmt->execute(array($oldId, $this->id)); |
|
106 | - while ($row = $stmt->fetch()) { |
|
107 | - $storages[$row['id']] = $row['numeric_id']; |
|
108 | - } |
|
109 | - |
|
110 | - if (isset($storages[$this->id]) && isset($storages[$oldId])) { |
|
111 | - // if both ids exist, delete the old storage and corresponding filecache entries |
|
112 | - \OC\Files\Cache\Storage::remove($oldId); |
|
113 | - } else if (isset($storages[$oldId])) { |
|
114 | - // if only the old id exists do an update |
|
115 | - $stmt = \OC::$server->getDatabaseConnection()->prepare( |
|
116 | - 'UPDATE `*PREFIX*storages` SET `id` = ? WHERE `id` = ?' |
|
117 | - ); |
|
118 | - $stmt->execute(array($this->id, $oldId)); |
|
119 | - } |
|
120 | - // only the bucket based id may exist, do nothing |
|
121 | - } |
|
122 | - |
|
123 | - /** |
|
124 | - * Remove a file or folder |
|
125 | - * |
|
126 | - * @param string $path |
|
127 | - * @return bool |
|
128 | - */ |
|
129 | - protected function remove($path) { |
|
130 | - // remember fileType to reduce http calls |
|
131 | - $fileType = $this->filetype($path); |
|
132 | - if ($fileType === 'dir') { |
|
133 | - return $this->rmdir($path); |
|
134 | - } else if ($fileType === 'file') { |
|
135 | - return $this->unlink($path); |
|
136 | - } else { |
|
137 | - return false; |
|
138 | - } |
|
139 | - } |
|
140 | - |
|
141 | - public function mkdir($path) { |
|
142 | - $path = $this->normalizePath($path); |
|
143 | - |
|
144 | - if ($this->is_dir($path)) { |
|
145 | - return false; |
|
146 | - } |
|
147 | - |
|
148 | - try { |
|
149 | - $this->getConnection()->putObject(array( |
|
150 | - 'Bucket' => $this->bucket, |
|
151 | - 'Key' => $path . '/', |
|
152 | - 'Body' => '', |
|
153 | - 'ContentType' => 'httpd/unix-directory' |
|
154 | - )); |
|
155 | - $this->testTimeout(); |
|
156 | - } catch (S3Exception $e) { |
|
157 | - \OCP\Util::logException('files_external', $e); |
|
158 | - return false; |
|
159 | - } |
|
160 | - |
|
161 | - return true; |
|
162 | - } |
|
163 | - |
|
164 | - public function file_exists($path) { |
|
165 | - return $this->filetype($path) !== false; |
|
166 | - } |
|
167 | - |
|
168 | - |
|
169 | - public function rmdir($path) { |
|
170 | - $path = $this->normalizePath($path); |
|
171 | - |
|
172 | - if ($this->isRoot($path)) { |
|
173 | - return $this->clearBucket(); |
|
174 | - } |
|
175 | - |
|
176 | - if (!$this->file_exists($path)) { |
|
177 | - return false; |
|
178 | - } |
|
179 | - |
|
180 | - return $this->batchDelete($path); |
|
181 | - } |
|
182 | - |
|
183 | - protected function clearBucket() { |
|
184 | - try { |
|
185 | - $this->getConnection()->clearBucket($this->bucket); |
|
186 | - return true; |
|
187 | - // clearBucket() is not working with Ceph, so if it fails we try the slower approach |
|
188 | - } catch (\Exception $e) { |
|
189 | - return $this->batchDelete(); |
|
190 | - } |
|
191 | - return false; |
|
192 | - } |
|
193 | - |
|
194 | - private function batchDelete ($path = null) { |
|
195 | - $params = array( |
|
196 | - 'Bucket' => $this->bucket |
|
197 | - ); |
|
198 | - if ($path !== null) { |
|
199 | - $params['Prefix'] = $path . '/'; |
|
200 | - } |
|
201 | - try { |
|
202 | - // Since there are no real directories on S3, we need |
|
203 | - // to delete all objects prefixed with the path. |
|
204 | - do { |
|
205 | - // instead of the iterator, manually loop over the list ... |
|
206 | - $objects = $this->getConnection()->listObjects($params); |
|
207 | - // ... so we can delete the files in batches |
|
208 | - $this->getConnection()->deleteObjects(array( |
|
209 | - 'Bucket' => $this->bucket, |
|
210 | - 'Objects' => $objects['Contents'] |
|
211 | - )); |
|
212 | - $this->testTimeout(); |
|
213 | - // we reached the end when the list is no longer truncated |
|
214 | - } while ($objects['IsTruncated']); |
|
215 | - } catch (S3Exception $e) { |
|
216 | - \OCP\Util::logException('files_external', $e); |
|
217 | - return false; |
|
218 | - } |
|
219 | - return true; |
|
220 | - } |
|
221 | - |
|
222 | - public function opendir($path) { |
|
223 | - $path = $this->normalizePath($path); |
|
224 | - |
|
225 | - if ($this->isRoot($path)) { |
|
226 | - $path = ''; |
|
227 | - } else { |
|
228 | - $path .= '/'; |
|
229 | - } |
|
230 | - |
|
231 | - try { |
|
232 | - $files = array(); |
|
233 | - $result = $this->getConnection()->getIterator('ListObjects', array( |
|
234 | - 'Bucket' => $this->bucket, |
|
235 | - 'Delimiter' => '/', |
|
236 | - 'Prefix' => $path |
|
237 | - ), array('return_prefixes' => true)); |
|
238 | - |
|
239 | - foreach ($result as $object) { |
|
240 | - if (isset($object['Key']) && $object['Key'] === $path) { |
|
241 | - // it's the directory itself, skip |
|
242 | - continue; |
|
243 | - } |
|
244 | - $file = basename( |
|
245 | - isset($object['Key']) ? $object['Key'] : $object['Prefix'] |
|
246 | - ); |
|
247 | - $files[] = $file; |
|
248 | - } |
|
249 | - |
|
250 | - return IteratorDirectory::wrap($files); |
|
251 | - } catch (S3Exception $e) { |
|
252 | - \OCP\Util::logException('files_external', $e); |
|
253 | - return false; |
|
254 | - } |
|
255 | - } |
|
256 | - |
|
257 | - public function stat($path) { |
|
258 | - $path = $this->normalizePath($path); |
|
259 | - |
|
260 | - try { |
|
261 | - $stat = array(); |
|
262 | - if ($this->is_dir($path)) { |
|
263 | - //folders don't really exist |
|
264 | - $stat['size'] = -1; //unknown |
|
265 | - $stat['mtime'] = time() - $this->rescanDelay * 1000; |
|
266 | - } else { |
|
267 | - $result = $this->getConnection()->headObject(array( |
|
268 | - 'Bucket' => $this->bucket, |
|
269 | - 'Key' => $path |
|
270 | - )); |
|
271 | - |
|
272 | - $stat['size'] = $result['ContentLength'] ? $result['ContentLength'] : 0; |
|
273 | - if ($result['Metadata']['lastmodified']) { |
|
274 | - $stat['mtime'] = strtotime($result['Metadata']['lastmodified']); |
|
275 | - } else { |
|
276 | - $stat['mtime'] = strtotime($result['LastModified']); |
|
277 | - } |
|
278 | - } |
|
279 | - $stat['atime'] = time(); |
|
280 | - |
|
281 | - return $stat; |
|
282 | - } catch(S3Exception $e) { |
|
283 | - \OCP\Util::logException('files_external', $e); |
|
284 | - return false; |
|
285 | - } |
|
286 | - } |
|
287 | - |
|
288 | - public function filetype($path) { |
|
289 | - $path = $this->normalizePath($path); |
|
290 | - |
|
291 | - if ($this->isRoot($path)) { |
|
292 | - return 'dir'; |
|
293 | - } |
|
294 | - |
|
295 | - try { |
|
296 | - if ($this->getConnection()->doesObjectExist($this->bucket, $path)) { |
|
297 | - return 'file'; |
|
298 | - } |
|
299 | - if ($this->getConnection()->doesObjectExist($this->bucket, $path.'/')) { |
|
300 | - return 'dir'; |
|
301 | - } |
|
302 | - } catch (S3Exception $e) { |
|
303 | - \OCP\Util::logException('files_external', $e); |
|
304 | - return false; |
|
305 | - } |
|
306 | - |
|
307 | - return false; |
|
308 | - } |
|
309 | - |
|
310 | - public function unlink($path) { |
|
311 | - $path = $this->normalizePath($path); |
|
312 | - |
|
313 | - if ($this->is_dir($path)) { |
|
314 | - return $this->rmdir($path); |
|
315 | - } |
|
316 | - |
|
317 | - try { |
|
318 | - $this->getConnection()->deleteObject(array( |
|
319 | - 'Bucket' => $this->bucket, |
|
320 | - 'Key' => $path |
|
321 | - )); |
|
322 | - $this->testTimeout(); |
|
323 | - } catch (S3Exception $e) { |
|
324 | - \OCP\Util::logException('files_external', $e); |
|
325 | - return false; |
|
326 | - } |
|
327 | - |
|
328 | - return true; |
|
329 | - } |
|
330 | - |
|
331 | - public function fopen($path, $mode) { |
|
332 | - $path = $this->normalizePath($path); |
|
333 | - |
|
334 | - switch ($mode) { |
|
335 | - case 'r': |
|
336 | - case 'rb': |
|
337 | - $tmpFile = \OCP\Files::tmpFile(); |
|
338 | - self::$tmpFiles[$tmpFile] = $path; |
|
339 | - |
|
340 | - try { |
|
341 | - $this->getConnection()->getObject(array( |
|
342 | - 'Bucket' => $this->bucket, |
|
343 | - 'Key' => $path, |
|
344 | - 'SaveAs' => $tmpFile |
|
345 | - )); |
|
346 | - } catch (S3Exception $e) { |
|
347 | - \OCP\Util::logException('files_external', $e); |
|
348 | - return false; |
|
349 | - } |
|
350 | - |
|
351 | - return fopen($tmpFile, 'r'); |
|
352 | - case 'w': |
|
353 | - case 'wb': |
|
354 | - case 'a': |
|
355 | - case 'ab': |
|
356 | - case 'r+': |
|
357 | - case 'w+': |
|
358 | - case 'wb+': |
|
359 | - case 'a+': |
|
360 | - case 'x': |
|
361 | - case 'x+': |
|
362 | - case 'c': |
|
363 | - case 'c+': |
|
364 | - if (strrpos($path, '.') !== false) { |
|
365 | - $ext = substr($path, strrpos($path, '.')); |
|
366 | - } else { |
|
367 | - $ext = ''; |
|
368 | - } |
|
369 | - $tmpFile = \OCP\Files::tmpFile($ext); |
|
370 | - if ($this->file_exists($path)) { |
|
371 | - $source = $this->fopen($path, 'r'); |
|
372 | - file_put_contents($tmpFile, $source); |
|
373 | - } |
|
374 | - |
|
375 | - $handle = fopen($tmpFile, $mode); |
|
376 | - return CallbackWrapper::wrap($handle, null, null, function() use ($path, $tmpFile) { |
|
377 | - $this->writeBack($tmpFile, $path); |
|
378 | - }); |
|
379 | - } |
|
380 | - return false; |
|
381 | - } |
|
382 | - |
|
383 | - public function touch($path, $mtime = null) { |
|
384 | - $path = $this->normalizePath($path); |
|
385 | - |
|
386 | - $metadata = array(); |
|
387 | - if (is_null($mtime)) { |
|
388 | - $mtime = time(); |
|
389 | - } |
|
390 | - $metadata = [ |
|
391 | - 'lastmodified' => gmdate(\Aws\Common\Enum\DateFormat::RFC1123, $mtime) |
|
392 | - ]; |
|
393 | - |
|
394 | - $fileType = $this->filetype($path); |
|
395 | - try { |
|
396 | - if ($fileType !== false) { |
|
397 | - if ($fileType === 'dir' && ! $this->isRoot($path)) { |
|
398 | - $path .= '/'; |
|
399 | - } |
|
400 | - $this->getConnection()->copyObject([ |
|
401 | - 'Bucket' => $this->bucket, |
|
402 | - 'Key' => $this->cleanKey($path), |
|
403 | - 'Metadata' => $metadata, |
|
404 | - 'CopySource' => $this->bucket . '/' . $path, |
|
405 | - 'MetadataDirective' => 'REPLACE', |
|
406 | - ]); |
|
407 | - $this->testTimeout(); |
|
408 | - } else { |
|
409 | - $mimeType = \OC::$server->getMimeTypeDetector()->detectPath($path); |
|
410 | - $this->getConnection()->putObject([ |
|
411 | - 'Bucket' => $this->bucket, |
|
412 | - 'Key' => $this->cleanKey($path), |
|
413 | - 'Metadata' => $metadata, |
|
414 | - 'Body' => '', |
|
415 | - 'ContentType' => $mimeType, |
|
416 | - 'MetadataDirective' => 'REPLACE', |
|
417 | - ]); |
|
418 | - $this->testTimeout(); |
|
419 | - } |
|
420 | - } catch (S3Exception $e) { |
|
421 | - \OCP\Util::logException('files_external', $e); |
|
422 | - return false; |
|
423 | - } |
|
424 | - |
|
425 | - return true; |
|
426 | - } |
|
427 | - |
|
428 | - public function copy($path1, $path2) { |
|
429 | - $path1 = $this->normalizePath($path1); |
|
430 | - $path2 = $this->normalizePath($path2); |
|
431 | - |
|
432 | - if ($this->is_file($path1)) { |
|
433 | - try { |
|
434 | - $this->getConnection()->copyObject(array( |
|
435 | - 'Bucket' => $this->bucket, |
|
436 | - 'Key' => $this->cleanKey($path2), |
|
437 | - 'CopySource' => S3Client::encodeKey($this->bucket . '/' . $path1) |
|
438 | - )); |
|
439 | - $this->testTimeout(); |
|
440 | - } catch (S3Exception $e) { |
|
441 | - \OCP\Util::logException('files_external', $e); |
|
442 | - return false; |
|
443 | - } |
|
444 | - } else { |
|
445 | - $this->remove($path2); |
|
446 | - |
|
447 | - try { |
|
448 | - $this->getConnection()->copyObject(array( |
|
449 | - 'Bucket' => $this->bucket, |
|
450 | - 'Key' => $path2 . '/', |
|
451 | - 'CopySource' => S3Client::encodeKey($this->bucket . '/' . $path1 . '/') |
|
452 | - )); |
|
453 | - $this->testTimeout(); |
|
454 | - } catch (S3Exception $e) { |
|
455 | - \OCP\Util::logException('files_external', $e); |
|
456 | - return false; |
|
457 | - } |
|
458 | - |
|
459 | - $dh = $this->opendir($path1); |
|
460 | - if (is_resource($dh)) { |
|
461 | - while (($file = readdir($dh)) !== false) { |
|
462 | - if (\OC\Files\Filesystem::isIgnoredDir($file)) { |
|
463 | - continue; |
|
464 | - } |
|
465 | - |
|
466 | - $source = $path1 . '/' . $file; |
|
467 | - $target = $path2 . '/' . $file; |
|
468 | - $this->copy($source, $target); |
|
469 | - } |
|
470 | - } |
|
471 | - } |
|
472 | - |
|
473 | - return true; |
|
474 | - } |
|
475 | - |
|
476 | - public function rename($path1, $path2) { |
|
477 | - $path1 = $this->normalizePath($path1); |
|
478 | - $path2 = $this->normalizePath($path2); |
|
479 | - |
|
480 | - if ($this->is_file($path1)) { |
|
481 | - |
|
482 | - if ($this->copy($path1, $path2) === false) { |
|
483 | - return false; |
|
484 | - } |
|
485 | - |
|
486 | - if ($this->unlink($path1) === false) { |
|
487 | - $this->unlink($path2); |
|
488 | - return false; |
|
489 | - } |
|
490 | - } else { |
|
491 | - |
|
492 | - if ($this->copy($path1, $path2) === false) { |
|
493 | - return false; |
|
494 | - } |
|
495 | - |
|
496 | - if ($this->rmdir($path1) === false) { |
|
497 | - $this->rmdir($path2); |
|
498 | - return false; |
|
499 | - } |
|
500 | - } |
|
501 | - |
|
502 | - return true; |
|
503 | - } |
|
504 | - |
|
505 | - public function test() { |
|
506 | - $test = $this->getConnection()->getBucketAcl(array( |
|
507 | - 'Bucket' => $this->bucket, |
|
508 | - )); |
|
509 | - if (isset($test) && !is_null($test->getPath('Owner/ID'))) { |
|
510 | - return true; |
|
511 | - } |
|
512 | - return false; |
|
513 | - } |
|
514 | - |
|
515 | - public function getId() { |
|
516 | - return $this->id; |
|
517 | - } |
|
518 | - |
|
519 | - public function writeBack($tmpFile, $path) { |
|
520 | - try { |
|
521 | - $this->getConnection()->putObject(array( |
|
522 | - 'Bucket' => $this->bucket, |
|
523 | - 'Key' => $this->cleanKey($path), |
|
524 | - 'SourceFile' => $tmpFile, |
|
525 | - 'ContentType' => \OC::$server->getMimeTypeDetector()->detect($tmpFile), |
|
526 | - 'ContentLength' => filesize($tmpFile) |
|
527 | - )); |
|
528 | - $this->testTimeout(); |
|
529 | - |
|
530 | - unlink($tmpFile); |
|
531 | - } catch (S3Exception $e) { |
|
532 | - \OCP\Util::logException('files_external', $e); |
|
533 | - return false; |
|
534 | - } |
|
535 | - } |
|
536 | - |
|
537 | - /** |
|
538 | - * check if curl is installed |
|
539 | - */ |
|
540 | - public static function checkDependencies() { |
|
541 | - return true; |
|
542 | - } |
|
50 | + use S3ConnectionTrait; |
|
51 | + |
|
52 | + /** |
|
53 | + * @var array |
|
54 | + */ |
|
55 | + private static $tmpFiles = array(); |
|
56 | + |
|
57 | + /** |
|
58 | + * @var int in seconds |
|
59 | + */ |
|
60 | + private $rescanDelay = 10; |
|
61 | + |
|
62 | + public function __construct($parameters) { |
|
63 | + parent::__construct($parameters); |
|
64 | + $this->parseParams($parameters); |
|
65 | + } |
|
66 | + |
|
67 | + /** |
|
68 | + * @param string $path |
|
69 | + * @return string correctly encoded path |
|
70 | + */ |
|
71 | + private function normalizePath($path) { |
|
72 | + $path = trim($path, '/'); |
|
73 | + |
|
74 | + if (!$path) { |
|
75 | + $path = '.'; |
|
76 | + } |
|
77 | + |
|
78 | + return $path; |
|
79 | + } |
|
80 | + |
|
81 | + private function isRoot($path) { |
|
82 | + return $path === '.'; |
|
83 | + } |
|
84 | + |
|
85 | + private function cleanKey($path) { |
|
86 | + if ($this->isRoot($path)) { |
|
87 | + return '/'; |
|
88 | + } |
|
89 | + return $path; |
|
90 | + } |
|
91 | + |
|
92 | + /** |
|
93 | + * Updates old storage ids (v0.2.1 and older) that are based on key and secret to new ones based on the bucket name. |
|
94 | + * TODO Do this in an update.php. requires iterating over all users and loading the mount.json from their home |
|
95 | + * |
|
96 | + * @param array $params |
|
97 | + */ |
|
98 | + public function updateLegacyId (array $params) { |
|
99 | + $oldId = 'amazon::' . $params['key'] . md5($params['secret']); |
|
100 | + |
|
101 | + // find by old id or bucket |
|
102 | + $stmt = \OC::$server->getDatabaseConnection()->prepare( |
|
103 | + 'SELECT `numeric_id`, `id` FROM `*PREFIX*storages` WHERE `id` IN (?, ?)' |
|
104 | + ); |
|
105 | + $stmt->execute(array($oldId, $this->id)); |
|
106 | + while ($row = $stmt->fetch()) { |
|
107 | + $storages[$row['id']] = $row['numeric_id']; |
|
108 | + } |
|
109 | + |
|
110 | + if (isset($storages[$this->id]) && isset($storages[$oldId])) { |
|
111 | + // if both ids exist, delete the old storage and corresponding filecache entries |
|
112 | + \OC\Files\Cache\Storage::remove($oldId); |
|
113 | + } else if (isset($storages[$oldId])) { |
|
114 | + // if only the old id exists do an update |
|
115 | + $stmt = \OC::$server->getDatabaseConnection()->prepare( |
|
116 | + 'UPDATE `*PREFIX*storages` SET `id` = ? WHERE `id` = ?' |
|
117 | + ); |
|
118 | + $stmt->execute(array($this->id, $oldId)); |
|
119 | + } |
|
120 | + // only the bucket based id may exist, do nothing |
|
121 | + } |
|
122 | + |
|
123 | + /** |
|
124 | + * Remove a file or folder |
|
125 | + * |
|
126 | + * @param string $path |
|
127 | + * @return bool |
|
128 | + */ |
|
129 | + protected function remove($path) { |
|
130 | + // remember fileType to reduce http calls |
|
131 | + $fileType = $this->filetype($path); |
|
132 | + if ($fileType === 'dir') { |
|
133 | + return $this->rmdir($path); |
|
134 | + } else if ($fileType === 'file') { |
|
135 | + return $this->unlink($path); |
|
136 | + } else { |
|
137 | + return false; |
|
138 | + } |
|
139 | + } |
|
140 | + |
|
141 | + public function mkdir($path) { |
|
142 | + $path = $this->normalizePath($path); |
|
143 | + |
|
144 | + if ($this->is_dir($path)) { |
|
145 | + return false; |
|
146 | + } |
|
147 | + |
|
148 | + try { |
|
149 | + $this->getConnection()->putObject(array( |
|
150 | + 'Bucket' => $this->bucket, |
|
151 | + 'Key' => $path . '/', |
|
152 | + 'Body' => '', |
|
153 | + 'ContentType' => 'httpd/unix-directory' |
|
154 | + )); |
|
155 | + $this->testTimeout(); |
|
156 | + } catch (S3Exception $e) { |
|
157 | + \OCP\Util::logException('files_external', $e); |
|
158 | + return false; |
|
159 | + } |
|
160 | + |
|
161 | + return true; |
|
162 | + } |
|
163 | + |
|
164 | + public function file_exists($path) { |
|
165 | + return $this->filetype($path) !== false; |
|
166 | + } |
|
167 | + |
|
168 | + |
|
169 | + public function rmdir($path) { |
|
170 | + $path = $this->normalizePath($path); |
|
171 | + |
|
172 | + if ($this->isRoot($path)) { |
|
173 | + return $this->clearBucket(); |
|
174 | + } |
|
175 | + |
|
176 | + if (!$this->file_exists($path)) { |
|
177 | + return false; |
|
178 | + } |
|
179 | + |
|
180 | + return $this->batchDelete($path); |
|
181 | + } |
|
182 | + |
|
183 | + protected function clearBucket() { |
|
184 | + try { |
|
185 | + $this->getConnection()->clearBucket($this->bucket); |
|
186 | + return true; |
|
187 | + // clearBucket() is not working with Ceph, so if it fails we try the slower approach |
|
188 | + } catch (\Exception $e) { |
|
189 | + return $this->batchDelete(); |
|
190 | + } |
|
191 | + return false; |
|
192 | + } |
|
193 | + |
|
194 | + private function batchDelete ($path = null) { |
|
195 | + $params = array( |
|
196 | + 'Bucket' => $this->bucket |
|
197 | + ); |
|
198 | + if ($path !== null) { |
|
199 | + $params['Prefix'] = $path . '/'; |
|
200 | + } |
|
201 | + try { |
|
202 | + // Since there are no real directories on S3, we need |
|
203 | + // to delete all objects prefixed with the path. |
|
204 | + do { |
|
205 | + // instead of the iterator, manually loop over the list ... |
|
206 | + $objects = $this->getConnection()->listObjects($params); |
|
207 | + // ... so we can delete the files in batches |
|
208 | + $this->getConnection()->deleteObjects(array( |
|
209 | + 'Bucket' => $this->bucket, |
|
210 | + 'Objects' => $objects['Contents'] |
|
211 | + )); |
|
212 | + $this->testTimeout(); |
|
213 | + // we reached the end when the list is no longer truncated |
|
214 | + } while ($objects['IsTruncated']); |
|
215 | + } catch (S3Exception $e) { |
|
216 | + \OCP\Util::logException('files_external', $e); |
|
217 | + return false; |
|
218 | + } |
|
219 | + return true; |
|
220 | + } |
|
221 | + |
|
222 | + public function opendir($path) { |
|
223 | + $path = $this->normalizePath($path); |
|
224 | + |
|
225 | + if ($this->isRoot($path)) { |
|
226 | + $path = ''; |
|
227 | + } else { |
|
228 | + $path .= '/'; |
|
229 | + } |
|
230 | + |
|
231 | + try { |
|
232 | + $files = array(); |
|
233 | + $result = $this->getConnection()->getIterator('ListObjects', array( |
|
234 | + 'Bucket' => $this->bucket, |
|
235 | + 'Delimiter' => '/', |
|
236 | + 'Prefix' => $path |
|
237 | + ), array('return_prefixes' => true)); |
|
238 | + |
|
239 | + foreach ($result as $object) { |
|
240 | + if (isset($object['Key']) && $object['Key'] === $path) { |
|
241 | + // it's the directory itself, skip |
|
242 | + continue; |
|
243 | + } |
|
244 | + $file = basename( |
|
245 | + isset($object['Key']) ? $object['Key'] : $object['Prefix'] |
|
246 | + ); |
|
247 | + $files[] = $file; |
|
248 | + } |
|
249 | + |
|
250 | + return IteratorDirectory::wrap($files); |
|
251 | + } catch (S3Exception $e) { |
|
252 | + \OCP\Util::logException('files_external', $e); |
|
253 | + return false; |
|
254 | + } |
|
255 | + } |
|
256 | + |
|
257 | + public function stat($path) { |
|
258 | + $path = $this->normalizePath($path); |
|
259 | + |
|
260 | + try { |
|
261 | + $stat = array(); |
|
262 | + if ($this->is_dir($path)) { |
|
263 | + //folders don't really exist |
|
264 | + $stat['size'] = -1; //unknown |
|
265 | + $stat['mtime'] = time() - $this->rescanDelay * 1000; |
|
266 | + } else { |
|
267 | + $result = $this->getConnection()->headObject(array( |
|
268 | + 'Bucket' => $this->bucket, |
|
269 | + 'Key' => $path |
|
270 | + )); |
|
271 | + |
|
272 | + $stat['size'] = $result['ContentLength'] ? $result['ContentLength'] : 0; |
|
273 | + if ($result['Metadata']['lastmodified']) { |
|
274 | + $stat['mtime'] = strtotime($result['Metadata']['lastmodified']); |
|
275 | + } else { |
|
276 | + $stat['mtime'] = strtotime($result['LastModified']); |
|
277 | + } |
|
278 | + } |
|
279 | + $stat['atime'] = time(); |
|
280 | + |
|
281 | + return $stat; |
|
282 | + } catch(S3Exception $e) { |
|
283 | + \OCP\Util::logException('files_external', $e); |
|
284 | + return false; |
|
285 | + } |
|
286 | + } |
|
287 | + |
|
288 | + public function filetype($path) { |
|
289 | + $path = $this->normalizePath($path); |
|
290 | + |
|
291 | + if ($this->isRoot($path)) { |
|
292 | + return 'dir'; |
|
293 | + } |
|
294 | + |
|
295 | + try { |
|
296 | + if ($this->getConnection()->doesObjectExist($this->bucket, $path)) { |
|
297 | + return 'file'; |
|
298 | + } |
|
299 | + if ($this->getConnection()->doesObjectExist($this->bucket, $path.'/')) { |
|
300 | + return 'dir'; |
|
301 | + } |
|
302 | + } catch (S3Exception $e) { |
|
303 | + \OCP\Util::logException('files_external', $e); |
|
304 | + return false; |
|
305 | + } |
|
306 | + |
|
307 | + return false; |
|
308 | + } |
|
309 | + |
|
310 | + public function unlink($path) { |
|
311 | + $path = $this->normalizePath($path); |
|
312 | + |
|
313 | + if ($this->is_dir($path)) { |
|
314 | + return $this->rmdir($path); |
|
315 | + } |
|
316 | + |
|
317 | + try { |
|
318 | + $this->getConnection()->deleteObject(array( |
|
319 | + 'Bucket' => $this->bucket, |
|
320 | + 'Key' => $path |
|
321 | + )); |
|
322 | + $this->testTimeout(); |
|
323 | + } catch (S3Exception $e) { |
|
324 | + \OCP\Util::logException('files_external', $e); |
|
325 | + return false; |
|
326 | + } |
|
327 | + |
|
328 | + return true; |
|
329 | + } |
|
330 | + |
|
331 | + public function fopen($path, $mode) { |
|
332 | + $path = $this->normalizePath($path); |
|
333 | + |
|
334 | + switch ($mode) { |
|
335 | + case 'r': |
|
336 | + case 'rb': |
|
337 | + $tmpFile = \OCP\Files::tmpFile(); |
|
338 | + self::$tmpFiles[$tmpFile] = $path; |
|
339 | + |
|
340 | + try { |
|
341 | + $this->getConnection()->getObject(array( |
|
342 | + 'Bucket' => $this->bucket, |
|
343 | + 'Key' => $path, |
|
344 | + 'SaveAs' => $tmpFile |
|
345 | + )); |
|
346 | + } catch (S3Exception $e) { |
|
347 | + \OCP\Util::logException('files_external', $e); |
|
348 | + return false; |
|
349 | + } |
|
350 | + |
|
351 | + return fopen($tmpFile, 'r'); |
|
352 | + case 'w': |
|
353 | + case 'wb': |
|
354 | + case 'a': |
|
355 | + case 'ab': |
|
356 | + case 'r+': |
|
357 | + case 'w+': |
|
358 | + case 'wb+': |
|
359 | + case 'a+': |
|
360 | + case 'x': |
|
361 | + case 'x+': |
|
362 | + case 'c': |
|
363 | + case 'c+': |
|
364 | + if (strrpos($path, '.') !== false) { |
|
365 | + $ext = substr($path, strrpos($path, '.')); |
|
366 | + } else { |
|
367 | + $ext = ''; |
|
368 | + } |
|
369 | + $tmpFile = \OCP\Files::tmpFile($ext); |
|
370 | + if ($this->file_exists($path)) { |
|
371 | + $source = $this->fopen($path, 'r'); |
|
372 | + file_put_contents($tmpFile, $source); |
|
373 | + } |
|
374 | + |
|
375 | + $handle = fopen($tmpFile, $mode); |
|
376 | + return CallbackWrapper::wrap($handle, null, null, function() use ($path, $tmpFile) { |
|
377 | + $this->writeBack($tmpFile, $path); |
|
378 | + }); |
|
379 | + } |
|
380 | + return false; |
|
381 | + } |
|
382 | + |
|
383 | + public function touch($path, $mtime = null) { |
|
384 | + $path = $this->normalizePath($path); |
|
385 | + |
|
386 | + $metadata = array(); |
|
387 | + if (is_null($mtime)) { |
|
388 | + $mtime = time(); |
|
389 | + } |
|
390 | + $metadata = [ |
|
391 | + 'lastmodified' => gmdate(\Aws\Common\Enum\DateFormat::RFC1123, $mtime) |
|
392 | + ]; |
|
393 | + |
|
394 | + $fileType = $this->filetype($path); |
|
395 | + try { |
|
396 | + if ($fileType !== false) { |
|
397 | + if ($fileType === 'dir' && ! $this->isRoot($path)) { |
|
398 | + $path .= '/'; |
|
399 | + } |
|
400 | + $this->getConnection()->copyObject([ |
|
401 | + 'Bucket' => $this->bucket, |
|
402 | + 'Key' => $this->cleanKey($path), |
|
403 | + 'Metadata' => $metadata, |
|
404 | + 'CopySource' => $this->bucket . '/' . $path, |
|
405 | + 'MetadataDirective' => 'REPLACE', |
|
406 | + ]); |
|
407 | + $this->testTimeout(); |
|
408 | + } else { |
|
409 | + $mimeType = \OC::$server->getMimeTypeDetector()->detectPath($path); |
|
410 | + $this->getConnection()->putObject([ |
|
411 | + 'Bucket' => $this->bucket, |
|
412 | + 'Key' => $this->cleanKey($path), |
|
413 | + 'Metadata' => $metadata, |
|
414 | + 'Body' => '', |
|
415 | + 'ContentType' => $mimeType, |
|
416 | + 'MetadataDirective' => 'REPLACE', |
|
417 | + ]); |
|
418 | + $this->testTimeout(); |
|
419 | + } |
|
420 | + } catch (S3Exception $e) { |
|
421 | + \OCP\Util::logException('files_external', $e); |
|
422 | + return false; |
|
423 | + } |
|
424 | + |
|
425 | + return true; |
|
426 | + } |
|
427 | + |
|
428 | + public function copy($path1, $path2) { |
|
429 | + $path1 = $this->normalizePath($path1); |
|
430 | + $path2 = $this->normalizePath($path2); |
|
431 | + |
|
432 | + if ($this->is_file($path1)) { |
|
433 | + try { |
|
434 | + $this->getConnection()->copyObject(array( |
|
435 | + 'Bucket' => $this->bucket, |
|
436 | + 'Key' => $this->cleanKey($path2), |
|
437 | + 'CopySource' => S3Client::encodeKey($this->bucket . '/' . $path1) |
|
438 | + )); |
|
439 | + $this->testTimeout(); |
|
440 | + } catch (S3Exception $e) { |
|
441 | + \OCP\Util::logException('files_external', $e); |
|
442 | + return false; |
|
443 | + } |
|
444 | + } else { |
|
445 | + $this->remove($path2); |
|
446 | + |
|
447 | + try { |
|
448 | + $this->getConnection()->copyObject(array( |
|
449 | + 'Bucket' => $this->bucket, |
|
450 | + 'Key' => $path2 . '/', |
|
451 | + 'CopySource' => S3Client::encodeKey($this->bucket . '/' . $path1 . '/') |
|
452 | + )); |
|
453 | + $this->testTimeout(); |
|
454 | + } catch (S3Exception $e) { |
|
455 | + \OCP\Util::logException('files_external', $e); |
|
456 | + return false; |
|
457 | + } |
|
458 | + |
|
459 | + $dh = $this->opendir($path1); |
|
460 | + if (is_resource($dh)) { |
|
461 | + while (($file = readdir($dh)) !== false) { |
|
462 | + if (\OC\Files\Filesystem::isIgnoredDir($file)) { |
|
463 | + continue; |
|
464 | + } |
|
465 | + |
|
466 | + $source = $path1 . '/' . $file; |
|
467 | + $target = $path2 . '/' . $file; |
|
468 | + $this->copy($source, $target); |
|
469 | + } |
|
470 | + } |
|
471 | + } |
|
472 | + |
|
473 | + return true; |
|
474 | + } |
|
475 | + |
|
476 | + public function rename($path1, $path2) { |
|
477 | + $path1 = $this->normalizePath($path1); |
|
478 | + $path2 = $this->normalizePath($path2); |
|
479 | + |
|
480 | + if ($this->is_file($path1)) { |
|
481 | + |
|
482 | + if ($this->copy($path1, $path2) === false) { |
|
483 | + return false; |
|
484 | + } |
|
485 | + |
|
486 | + if ($this->unlink($path1) === false) { |
|
487 | + $this->unlink($path2); |
|
488 | + return false; |
|
489 | + } |
|
490 | + } else { |
|
491 | + |
|
492 | + if ($this->copy($path1, $path2) === false) { |
|
493 | + return false; |
|
494 | + } |
|
495 | + |
|
496 | + if ($this->rmdir($path1) === false) { |
|
497 | + $this->rmdir($path2); |
|
498 | + return false; |
|
499 | + } |
|
500 | + } |
|
501 | + |
|
502 | + return true; |
|
503 | + } |
|
504 | + |
|
505 | + public function test() { |
|
506 | + $test = $this->getConnection()->getBucketAcl(array( |
|
507 | + 'Bucket' => $this->bucket, |
|
508 | + )); |
|
509 | + if (isset($test) && !is_null($test->getPath('Owner/ID'))) { |
|
510 | + return true; |
|
511 | + } |
|
512 | + return false; |
|
513 | + } |
|
514 | + |
|
515 | + public function getId() { |
|
516 | + return $this->id; |
|
517 | + } |
|
518 | + |
|
519 | + public function writeBack($tmpFile, $path) { |
|
520 | + try { |
|
521 | + $this->getConnection()->putObject(array( |
|
522 | + 'Bucket' => $this->bucket, |
|
523 | + 'Key' => $this->cleanKey($path), |
|
524 | + 'SourceFile' => $tmpFile, |
|
525 | + 'ContentType' => \OC::$server->getMimeTypeDetector()->detect($tmpFile), |
|
526 | + 'ContentLength' => filesize($tmpFile) |
|
527 | + )); |
|
528 | + $this->testTimeout(); |
|
529 | + |
|
530 | + unlink($tmpFile); |
|
531 | + } catch (S3Exception $e) { |
|
532 | + \OCP\Util::logException('files_external', $e); |
|
533 | + return false; |
|
534 | + } |
|
535 | + } |
|
536 | + |
|
537 | + /** |
|
538 | + * check if curl is installed |
|
539 | + */ |
|
540 | + public static function checkDependencies() { |
|
541 | + return true; |
|
542 | + } |
|
543 | 543 | |
544 | 544 | } |
@@ -36,8 +36,8 @@ discard block |
||
36 | 36 | |
37 | 37 | namespace OCA\Files_External\Lib\Storage; |
38 | 38 | |
39 | -set_include_path(get_include_path() . PATH_SEPARATOR . |
|
40 | - \OC_App::getAppPath('files_external') . '/3rdparty/aws-sdk-php'); |
|
39 | +set_include_path(get_include_path().PATH_SEPARATOR. |
|
40 | + \OC_App::getAppPath('files_external').'/3rdparty/aws-sdk-php'); |
|
41 | 41 | require_once 'aws-autoloader.php'; |
42 | 42 | |
43 | 43 | use Aws\S3\S3Client; |
@@ -95,8 +95,8 @@ discard block |
||
95 | 95 | * |
96 | 96 | * @param array $params |
97 | 97 | */ |
98 | - public function updateLegacyId (array $params) { |
|
99 | - $oldId = 'amazon::' . $params['key'] . md5($params['secret']); |
|
98 | + public function updateLegacyId(array $params) { |
|
99 | + $oldId = 'amazon::'.$params['key'].md5($params['secret']); |
|
100 | 100 | |
101 | 101 | // find by old id or bucket |
102 | 102 | $stmt = \OC::$server->getDatabaseConnection()->prepare( |
@@ -148,7 +148,7 @@ discard block |
||
148 | 148 | try { |
149 | 149 | $this->getConnection()->putObject(array( |
150 | 150 | 'Bucket' => $this->bucket, |
151 | - 'Key' => $path . '/', |
|
151 | + 'Key' => $path.'/', |
|
152 | 152 | 'Body' => '', |
153 | 153 | 'ContentType' => 'httpd/unix-directory' |
154 | 154 | )); |
@@ -191,12 +191,12 @@ discard block |
||
191 | 191 | return false; |
192 | 192 | } |
193 | 193 | |
194 | - private function batchDelete ($path = null) { |
|
194 | + private function batchDelete($path = null) { |
|
195 | 195 | $params = array( |
196 | 196 | 'Bucket' => $this->bucket |
197 | 197 | ); |
198 | 198 | if ($path !== null) { |
199 | - $params['Prefix'] = $path . '/'; |
|
199 | + $params['Prefix'] = $path.'/'; |
|
200 | 200 | } |
201 | 201 | try { |
202 | 202 | // Since there are no real directories on S3, we need |
@@ -279,7 +279,7 @@ discard block |
||
279 | 279 | $stat['atime'] = time(); |
280 | 280 | |
281 | 281 | return $stat; |
282 | - } catch(S3Exception $e) { |
|
282 | + } catch (S3Exception $e) { |
|
283 | 283 | \OCP\Util::logException('files_external', $e); |
284 | 284 | return false; |
285 | 285 | } |
@@ -394,14 +394,14 @@ discard block |
||
394 | 394 | $fileType = $this->filetype($path); |
395 | 395 | try { |
396 | 396 | if ($fileType !== false) { |
397 | - if ($fileType === 'dir' && ! $this->isRoot($path)) { |
|
397 | + if ($fileType === 'dir' && !$this->isRoot($path)) { |
|
398 | 398 | $path .= '/'; |
399 | 399 | } |
400 | 400 | $this->getConnection()->copyObject([ |
401 | 401 | 'Bucket' => $this->bucket, |
402 | 402 | 'Key' => $this->cleanKey($path), |
403 | 403 | 'Metadata' => $metadata, |
404 | - 'CopySource' => $this->bucket . '/' . $path, |
|
404 | + 'CopySource' => $this->bucket.'/'.$path, |
|
405 | 405 | 'MetadataDirective' => 'REPLACE', |
406 | 406 | ]); |
407 | 407 | $this->testTimeout(); |
@@ -434,7 +434,7 @@ discard block |
||
434 | 434 | $this->getConnection()->copyObject(array( |
435 | 435 | 'Bucket' => $this->bucket, |
436 | 436 | 'Key' => $this->cleanKey($path2), |
437 | - 'CopySource' => S3Client::encodeKey($this->bucket . '/' . $path1) |
|
437 | + 'CopySource' => S3Client::encodeKey($this->bucket.'/'.$path1) |
|
438 | 438 | )); |
439 | 439 | $this->testTimeout(); |
440 | 440 | } catch (S3Exception $e) { |
@@ -447,8 +447,8 @@ discard block |
||
447 | 447 | try { |
448 | 448 | $this->getConnection()->copyObject(array( |
449 | 449 | 'Bucket' => $this->bucket, |
450 | - 'Key' => $path2 . '/', |
|
451 | - 'CopySource' => S3Client::encodeKey($this->bucket . '/' . $path1 . '/') |
|
450 | + 'Key' => $path2.'/', |
|
451 | + 'CopySource' => S3Client::encodeKey($this->bucket.'/'.$path1.'/') |
|
452 | 452 | )); |
453 | 453 | $this->testTimeout(); |
454 | 454 | } catch (S3Exception $e) { |
@@ -463,8 +463,8 @@ discard block |
||
463 | 463 | continue; |
464 | 464 | } |
465 | 465 | |
466 | - $source = $path1 . '/' . $file; |
|
467 | - $target = $path2 . '/' . $file; |
|
466 | + $source = $path1.'/'.$file; |
|
467 | + $target = $path2.'/'.$file; |
|
468 | 468 | $this->copy($source, $target); |
469 | 469 | } |
470 | 470 | } |
@@ -76,6 +76,9 @@ discard block |
||
76 | 76 | return false; |
77 | 77 | } |
78 | 78 | |
79 | + /** |
|
80 | + * @param string $path |
|
81 | + */ |
|
79 | 82 | private function setMetaData($path, $metaData) { |
80 | 83 | $this->metaData[ltrim($path, '/')] = $metaData; |
81 | 84 | } |
@@ -316,6 +319,9 @@ discard block |
||
316 | 319 | return false; |
317 | 320 | } |
318 | 321 | |
322 | + /** |
|
323 | + * @param string $path |
|
324 | + */ |
|
319 | 325 | public function writeBack($tmpFile, $path) { |
320 | 326 | $handle = fopen($tmpFile, 'r'); |
321 | 327 | try { |
@@ -40,317 +40,317 @@ |
||
40 | 40 | |
41 | 41 | class Dropbox extends \OC\Files\Storage\Common { |
42 | 42 | |
43 | - private $dropbox; |
|
44 | - private $root; |
|
45 | - private $id; |
|
46 | - private $metaData = array(); |
|
47 | - private $oauth; |
|
43 | + private $dropbox; |
|
44 | + private $root; |
|
45 | + private $id; |
|
46 | + private $metaData = array(); |
|
47 | + private $oauth; |
|
48 | 48 | |
49 | - public function __construct($params) { |
|
50 | - if (isset($params['configured']) && $params['configured'] == 'true' |
|
51 | - && isset($params['app_key']) |
|
52 | - && isset($params['app_secret']) |
|
53 | - && isset($params['token']) |
|
54 | - && isset($params['token_secret']) |
|
55 | - ) { |
|
56 | - $this->root = isset($params['root']) ? $params['root'] : ''; |
|
57 | - $this->id = 'dropbox::'.$params['app_key'] . $params['token']. '/' . $this->root; |
|
58 | - $this->oauth = new \Dropbox_OAuth_Curl($params['app_key'], $params['app_secret']); |
|
59 | - $this->oauth->setToken($params['token'], $params['token_secret']); |
|
60 | - // note: Dropbox_API connection is lazy |
|
61 | - $this->dropbox = new \Dropbox_API($this->oauth, 'auto'); |
|
62 | - } else { |
|
63 | - throw new \Exception('Creating Dropbox storage failed'); |
|
64 | - } |
|
65 | - } |
|
49 | + public function __construct($params) { |
|
50 | + if (isset($params['configured']) && $params['configured'] == 'true' |
|
51 | + && isset($params['app_key']) |
|
52 | + && isset($params['app_secret']) |
|
53 | + && isset($params['token']) |
|
54 | + && isset($params['token_secret']) |
|
55 | + ) { |
|
56 | + $this->root = isset($params['root']) ? $params['root'] : ''; |
|
57 | + $this->id = 'dropbox::'.$params['app_key'] . $params['token']. '/' . $this->root; |
|
58 | + $this->oauth = new \Dropbox_OAuth_Curl($params['app_key'], $params['app_secret']); |
|
59 | + $this->oauth->setToken($params['token'], $params['token_secret']); |
|
60 | + // note: Dropbox_API connection is lazy |
|
61 | + $this->dropbox = new \Dropbox_API($this->oauth, 'auto'); |
|
62 | + } else { |
|
63 | + throw new \Exception('Creating Dropbox storage failed'); |
|
64 | + } |
|
65 | + } |
|
66 | 66 | |
67 | - /** |
|
68 | - * @param string $path |
|
69 | - */ |
|
70 | - private function deleteMetaData($path) { |
|
71 | - $path = ltrim($this->root.$path, '/'); |
|
72 | - if (isset($this->metaData[$path])) { |
|
73 | - unset($this->metaData[$path]); |
|
74 | - return true; |
|
75 | - } |
|
76 | - return false; |
|
77 | - } |
|
67 | + /** |
|
68 | + * @param string $path |
|
69 | + */ |
|
70 | + private function deleteMetaData($path) { |
|
71 | + $path = ltrim($this->root.$path, '/'); |
|
72 | + if (isset($this->metaData[$path])) { |
|
73 | + unset($this->metaData[$path]); |
|
74 | + return true; |
|
75 | + } |
|
76 | + return false; |
|
77 | + } |
|
78 | 78 | |
79 | - private function setMetaData($path, $metaData) { |
|
80 | - $this->metaData[ltrim($path, '/')] = $metaData; |
|
81 | - } |
|
79 | + private function setMetaData($path, $metaData) { |
|
80 | + $this->metaData[ltrim($path, '/')] = $metaData; |
|
81 | + } |
|
82 | 82 | |
83 | - /** |
|
84 | - * Returns the path's metadata |
|
85 | - * @param string $path path for which to return the metadata |
|
86 | - * @param bool $list if true, also return the directory's contents |
|
87 | - * @return mixed directory contents if $list is true, file metadata if $list is |
|
88 | - * false, null if the file doesn't exist or "false" if the operation failed |
|
89 | - */ |
|
90 | - private function getDropBoxMetaData($path, $list = false) { |
|
91 | - $path = ltrim($this->root.$path, '/'); |
|
92 | - if ( ! $list && isset($this->metaData[$path])) { |
|
93 | - return $this->metaData[$path]; |
|
94 | - } else { |
|
95 | - if ($list) { |
|
96 | - try { |
|
97 | - $response = $this->dropbox->getMetaData($path); |
|
98 | - } catch (\Dropbox_Exception_Forbidden $e) { |
|
99 | - throw new StorageNotAvailableException('Dropbox API rate limit exceeded', StorageNotAvailableException::STATUS_ERROR, $e); |
|
100 | - } catch (\Exception $exception) { |
|
101 | - \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
102 | - return false; |
|
103 | - } |
|
104 | - $contents = array(); |
|
105 | - if ($response && isset($response['contents'])) { |
|
106 | - // Cache folder's contents |
|
107 | - foreach ($response['contents'] as $file) { |
|
108 | - if (!isset($file['is_deleted']) || !$file['is_deleted']) { |
|
109 | - $this->setMetaData($path.'/'.basename($file['path']), $file); |
|
110 | - $contents[] = $file; |
|
111 | - } |
|
112 | - } |
|
113 | - unset($response['contents']); |
|
114 | - } |
|
115 | - if (!isset($response['is_deleted']) || !$response['is_deleted']) { |
|
116 | - $this->setMetaData($path, $response); |
|
117 | - } |
|
118 | - // Return contents of folder only |
|
119 | - return $contents; |
|
120 | - } else { |
|
121 | - try { |
|
122 | - $requestPath = $path; |
|
123 | - if ($path === '.') { |
|
124 | - $requestPath = ''; |
|
125 | - } |
|
83 | + /** |
|
84 | + * Returns the path's metadata |
|
85 | + * @param string $path path for which to return the metadata |
|
86 | + * @param bool $list if true, also return the directory's contents |
|
87 | + * @return mixed directory contents if $list is true, file metadata if $list is |
|
88 | + * false, null if the file doesn't exist or "false" if the operation failed |
|
89 | + */ |
|
90 | + private function getDropBoxMetaData($path, $list = false) { |
|
91 | + $path = ltrim($this->root.$path, '/'); |
|
92 | + if ( ! $list && isset($this->metaData[$path])) { |
|
93 | + return $this->metaData[$path]; |
|
94 | + } else { |
|
95 | + if ($list) { |
|
96 | + try { |
|
97 | + $response = $this->dropbox->getMetaData($path); |
|
98 | + } catch (\Dropbox_Exception_Forbidden $e) { |
|
99 | + throw new StorageNotAvailableException('Dropbox API rate limit exceeded', StorageNotAvailableException::STATUS_ERROR, $e); |
|
100 | + } catch (\Exception $exception) { |
|
101 | + \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
102 | + return false; |
|
103 | + } |
|
104 | + $contents = array(); |
|
105 | + if ($response && isset($response['contents'])) { |
|
106 | + // Cache folder's contents |
|
107 | + foreach ($response['contents'] as $file) { |
|
108 | + if (!isset($file['is_deleted']) || !$file['is_deleted']) { |
|
109 | + $this->setMetaData($path.'/'.basename($file['path']), $file); |
|
110 | + $contents[] = $file; |
|
111 | + } |
|
112 | + } |
|
113 | + unset($response['contents']); |
|
114 | + } |
|
115 | + if (!isset($response['is_deleted']) || !$response['is_deleted']) { |
|
116 | + $this->setMetaData($path, $response); |
|
117 | + } |
|
118 | + // Return contents of folder only |
|
119 | + return $contents; |
|
120 | + } else { |
|
121 | + try { |
|
122 | + $requestPath = $path; |
|
123 | + if ($path === '.') { |
|
124 | + $requestPath = ''; |
|
125 | + } |
|
126 | 126 | |
127 | - $response = $this->dropbox->getMetaData($requestPath, 'false'); |
|
128 | - if (!isset($response['is_deleted']) || !$response['is_deleted']) { |
|
129 | - $this->setMetaData($path, $response); |
|
130 | - return $response; |
|
131 | - } |
|
132 | - return null; |
|
133 | - } catch (\Dropbox_Exception_Forbidden $e) { |
|
134 | - throw new StorageNotAvailableException('Dropbox API rate limit exceeded', StorageNotAvailableException::STATUS_ERROR, $e); |
|
135 | - } catch (\Exception $exception) { |
|
136 | - if ($exception instanceof \Dropbox_Exception_NotFound) { |
|
137 | - // don't log, might be a file_exist check |
|
138 | - return false; |
|
139 | - } |
|
140 | - \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
141 | - return false; |
|
142 | - } |
|
143 | - } |
|
144 | - } |
|
145 | - } |
|
127 | + $response = $this->dropbox->getMetaData($requestPath, 'false'); |
|
128 | + if (!isset($response['is_deleted']) || !$response['is_deleted']) { |
|
129 | + $this->setMetaData($path, $response); |
|
130 | + return $response; |
|
131 | + } |
|
132 | + return null; |
|
133 | + } catch (\Dropbox_Exception_Forbidden $e) { |
|
134 | + throw new StorageNotAvailableException('Dropbox API rate limit exceeded', StorageNotAvailableException::STATUS_ERROR, $e); |
|
135 | + } catch (\Exception $exception) { |
|
136 | + if ($exception instanceof \Dropbox_Exception_NotFound) { |
|
137 | + // don't log, might be a file_exist check |
|
138 | + return false; |
|
139 | + } |
|
140 | + \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
141 | + return false; |
|
142 | + } |
|
143 | + } |
|
144 | + } |
|
145 | + } |
|
146 | 146 | |
147 | - public function getId(){ |
|
148 | - return $this->id; |
|
149 | - } |
|
147 | + public function getId(){ |
|
148 | + return $this->id; |
|
149 | + } |
|
150 | 150 | |
151 | - public function mkdir($path) { |
|
152 | - $path = $this->root.$path; |
|
153 | - try { |
|
154 | - $this->dropbox->createFolder($path); |
|
155 | - return true; |
|
156 | - } catch (\Exception $exception) { |
|
157 | - \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
158 | - return false; |
|
159 | - } |
|
160 | - } |
|
151 | + public function mkdir($path) { |
|
152 | + $path = $this->root.$path; |
|
153 | + try { |
|
154 | + $this->dropbox->createFolder($path); |
|
155 | + return true; |
|
156 | + } catch (\Exception $exception) { |
|
157 | + \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
158 | + return false; |
|
159 | + } |
|
160 | + } |
|
161 | 161 | |
162 | - public function rmdir($path) { |
|
163 | - return $this->unlink($path); |
|
164 | - } |
|
162 | + public function rmdir($path) { |
|
163 | + return $this->unlink($path); |
|
164 | + } |
|
165 | 165 | |
166 | - public function opendir($path) { |
|
167 | - $contents = $this->getDropBoxMetaData($path, true); |
|
168 | - if ($contents !== false) { |
|
169 | - $files = array(); |
|
170 | - foreach ($contents as $file) { |
|
171 | - $files[] = basename($file['path']); |
|
172 | - } |
|
173 | - return IteratorDirectory::wrap($files); |
|
174 | - } |
|
175 | - return false; |
|
176 | - } |
|
166 | + public function opendir($path) { |
|
167 | + $contents = $this->getDropBoxMetaData($path, true); |
|
168 | + if ($contents !== false) { |
|
169 | + $files = array(); |
|
170 | + foreach ($contents as $file) { |
|
171 | + $files[] = basename($file['path']); |
|
172 | + } |
|
173 | + return IteratorDirectory::wrap($files); |
|
174 | + } |
|
175 | + return false; |
|
176 | + } |
|
177 | 177 | |
178 | - public function stat($path) { |
|
179 | - $metaData = $this->getDropBoxMetaData($path); |
|
180 | - if ($metaData) { |
|
181 | - $stat['size'] = $metaData['bytes']; |
|
182 | - $stat['atime'] = time(); |
|
183 | - $stat['mtime'] = (isset($metaData['modified'])) ? strtotime($metaData['modified']) : time(); |
|
184 | - return $stat; |
|
185 | - } |
|
186 | - return false; |
|
187 | - } |
|
178 | + public function stat($path) { |
|
179 | + $metaData = $this->getDropBoxMetaData($path); |
|
180 | + if ($metaData) { |
|
181 | + $stat['size'] = $metaData['bytes']; |
|
182 | + $stat['atime'] = time(); |
|
183 | + $stat['mtime'] = (isset($metaData['modified'])) ? strtotime($metaData['modified']) : time(); |
|
184 | + return $stat; |
|
185 | + } |
|
186 | + return false; |
|
187 | + } |
|
188 | 188 | |
189 | - public function filetype($path) { |
|
190 | - if ($path == '' || $path == '/') { |
|
191 | - return 'dir'; |
|
192 | - } else { |
|
193 | - $metaData = $this->getDropBoxMetaData($path); |
|
194 | - if ($metaData) { |
|
195 | - if ($metaData['is_dir'] == 'true') { |
|
196 | - return 'dir'; |
|
197 | - } else { |
|
198 | - return 'file'; |
|
199 | - } |
|
200 | - } |
|
201 | - } |
|
202 | - return false; |
|
203 | - } |
|
189 | + public function filetype($path) { |
|
190 | + if ($path == '' || $path == '/') { |
|
191 | + return 'dir'; |
|
192 | + } else { |
|
193 | + $metaData = $this->getDropBoxMetaData($path); |
|
194 | + if ($metaData) { |
|
195 | + if ($metaData['is_dir'] == 'true') { |
|
196 | + return 'dir'; |
|
197 | + } else { |
|
198 | + return 'file'; |
|
199 | + } |
|
200 | + } |
|
201 | + } |
|
202 | + return false; |
|
203 | + } |
|
204 | 204 | |
205 | - public function file_exists($path) { |
|
206 | - if ($path == '' || $path == '/') { |
|
207 | - return true; |
|
208 | - } |
|
209 | - if ($this->getDropBoxMetaData($path)) { |
|
210 | - return true; |
|
211 | - } |
|
212 | - return false; |
|
213 | - } |
|
205 | + public function file_exists($path) { |
|
206 | + if ($path == '' || $path == '/') { |
|
207 | + return true; |
|
208 | + } |
|
209 | + if ($this->getDropBoxMetaData($path)) { |
|
210 | + return true; |
|
211 | + } |
|
212 | + return false; |
|
213 | + } |
|
214 | 214 | |
215 | - public function unlink($path) { |
|
216 | - try { |
|
217 | - $this->dropbox->delete($this->root.$path); |
|
218 | - $this->deleteMetaData($path); |
|
219 | - return true; |
|
220 | - } catch (\Exception $exception) { |
|
221 | - \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
222 | - return false; |
|
223 | - } |
|
224 | - } |
|
215 | + public function unlink($path) { |
|
216 | + try { |
|
217 | + $this->dropbox->delete($this->root.$path); |
|
218 | + $this->deleteMetaData($path); |
|
219 | + return true; |
|
220 | + } catch (\Exception $exception) { |
|
221 | + \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
222 | + return false; |
|
223 | + } |
|
224 | + } |
|
225 | 225 | |
226 | - public function rename($path1, $path2) { |
|
227 | - try { |
|
228 | - // overwrite if target file exists and is not a directory |
|
229 | - $destMetaData = $this->getDropBoxMetaData($path2); |
|
230 | - if (isset($destMetaData) && $destMetaData !== false && !$destMetaData['is_dir']) { |
|
231 | - $this->unlink($path2); |
|
232 | - } |
|
233 | - $this->dropbox->move($this->root.$path1, $this->root.$path2); |
|
234 | - $this->deleteMetaData($path1); |
|
235 | - return true; |
|
236 | - } catch (\Exception $exception) { |
|
237 | - \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
238 | - return false; |
|
239 | - } |
|
240 | - } |
|
226 | + public function rename($path1, $path2) { |
|
227 | + try { |
|
228 | + // overwrite if target file exists and is not a directory |
|
229 | + $destMetaData = $this->getDropBoxMetaData($path2); |
|
230 | + if (isset($destMetaData) && $destMetaData !== false && !$destMetaData['is_dir']) { |
|
231 | + $this->unlink($path2); |
|
232 | + } |
|
233 | + $this->dropbox->move($this->root.$path1, $this->root.$path2); |
|
234 | + $this->deleteMetaData($path1); |
|
235 | + return true; |
|
236 | + } catch (\Exception $exception) { |
|
237 | + \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
238 | + return false; |
|
239 | + } |
|
240 | + } |
|
241 | 241 | |
242 | - public function copy($path1, $path2) { |
|
243 | - $path1 = $this->root.$path1; |
|
244 | - $path2 = $this->root.$path2; |
|
245 | - try { |
|
246 | - $this->dropbox->copy($path1, $path2); |
|
247 | - return true; |
|
248 | - } catch (\Exception $exception) { |
|
249 | - \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
250 | - return false; |
|
251 | - } |
|
252 | - } |
|
242 | + public function copy($path1, $path2) { |
|
243 | + $path1 = $this->root.$path1; |
|
244 | + $path2 = $this->root.$path2; |
|
245 | + try { |
|
246 | + $this->dropbox->copy($path1, $path2); |
|
247 | + return true; |
|
248 | + } catch (\Exception $exception) { |
|
249 | + \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
250 | + return false; |
|
251 | + } |
|
252 | + } |
|
253 | 253 | |
254 | - public function fopen($path, $mode) { |
|
255 | - $path = $this->root.$path; |
|
256 | - switch ($mode) { |
|
257 | - case 'r': |
|
258 | - case 'rb': |
|
259 | - try { |
|
260 | - // slashes need to stay |
|
261 | - $encodedPath = str_replace('%2F', '/', rawurlencode(trim($path, '/'))); |
|
262 | - $downloadUrl = 'https://api-content.dropbox.com/1/files/auto/' . $encodedPath; |
|
263 | - $headers = $this->oauth->getOAuthHeader($downloadUrl, [], 'GET'); |
|
254 | + public function fopen($path, $mode) { |
|
255 | + $path = $this->root.$path; |
|
256 | + switch ($mode) { |
|
257 | + case 'r': |
|
258 | + case 'rb': |
|
259 | + try { |
|
260 | + // slashes need to stay |
|
261 | + $encodedPath = str_replace('%2F', '/', rawurlencode(trim($path, '/'))); |
|
262 | + $downloadUrl = 'https://api-content.dropbox.com/1/files/auto/' . $encodedPath; |
|
263 | + $headers = $this->oauth->getOAuthHeader($downloadUrl, [], 'GET'); |
|
264 | 264 | |
265 | - $client = \OC::$server->getHTTPClientService()->newClient(); |
|
266 | - try { |
|
267 | - $response = $client->get($downloadUrl, [ |
|
268 | - 'headers' => $headers, |
|
269 | - 'stream' => true, |
|
270 | - ]); |
|
271 | - } catch (RequestException $e) { |
|
272 | - if (!is_null($e->getResponse())) { |
|
273 | - if ($e->getResponse()->getStatusCode() === 404) { |
|
274 | - return false; |
|
275 | - } else { |
|
276 | - throw $e; |
|
277 | - } |
|
278 | - } else { |
|
279 | - throw $e; |
|
280 | - } |
|
281 | - } |
|
265 | + $client = \OC::$server->getHTTPClientService()->newClient(); |
|
266 | + try { |
|
267 | + $response = $client->get($downloadUrl, [ |
|
268 | + 'headers' => $headers, |
|
269 | + 'stream' => true, |
|
270 | + ]); |
|
271 | + } catch (RequestException $e) { |
|
272 | + if (!is_null($e->getResponse())) { |
|
273 | + if ($e->getResponse()->getStatusCode() === 404) { |
|
274 | + return false; |
|
275 | + } else { |
|
276 | + throw $e; |
|
277 | + } |
|
278 | + } else { |
|
279 | + throw $e; |
|
280 | + } |
|
281 | + } |
|
282 | 282 | |
283 | - $handle = $response->getBody(); |
|
284 | - return RetryWrapper::wrap($handle); |
|
285 | - } catch (\Exception $exception) { |
|
286 | - \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
287 | - return false; |
|
288 | - } |
|
289 | - case 'w': |
|
290 | - case 'wb': |
|
291 | - case 'a': |
|
292 | - case 'ab': |
|
293 | - case 'r+': |
|
294 | - case 'w+': |
|
295 | - case 'wb+': |
|
296 | - case 'a+': |
|
297 | - case 'x': |
|
298 | - case 'x+': |
|
299 | - case 'c': |
|
300 | - case 'c+': |
|
301 | - if (strrpos($path, '.') !== false) { |
|
302 | - $ext = substr($path, strrpos($path, '.')); |
|
303 | - } else { |
|
304 | - $ext = ''; |
|
305 | - } |
|
306 | - $tmpFile = \OCP\Files::tmpFile($ext); |
|
307 | - if ($this->file_exists($path)) { |
|
308 | - $source = $this->fopen($path, 'r'); |
|
309 | - file_put_contents($tmpFile, $source); |
|
310 | - } |
|
311 | - $handle = fopen($tmpFile, $mode); |
|
312 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
313 | - $this->writeBack($tmpFile, $path); |
|
314 | - }); |
|
315 | - } |
|
316 | - return false; |
|
317 | - } |
|
283 | + $handle = $response->getBody(); |
|
284 | + return RetryWrapper::wrap($handle); |
|
285 | + } catch (\Exception $exception) { |
|
286 | + \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
287 | + return false; |
|
288 | + } |
|
289 | + case 'w': |
|
290 | + case 'wb': |
|
291 | + case 'a': |
|
292 | + case 'ab': |
|
293 | + case 'r+': |
|
294 | + case 'w+': |
|
295 | + case 'wb+': |
|
296 | + case 'a+': |
|
297 | + case 'x': |
|
298 | + case 'x+': |
|
299 | + case 'c': |
|
300 | + case 'c+': |
|
301 | + if (strrpos($path, '.') !== false) { |
|
302 | + $ext = substr($path, strrpos($path, '.')); |
|
303 | + } else { |
|
304 | + $ext = ''; |
|
305 | + } |
|
306 | + $tmpFile = \OCP\Files::tmpFile($ext); |
|
307 | + if ($this->file_exists($path)) { |
|
308 | + $source = $this->fopen($path, 'r'); |
|
309 | + file_put_contents($tmpFile, $source); |
|
310 | + } |
|
311 | + $handle = fopen($tmpFile, $mode); |
|
312 | + return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
313 | + $this->writeBack($tmpFile, $path); |
|
314 | + }); |
|
315 | + } |
|
316 | + return false; |
|
317 | + } |
|
318 | 318 | |
319 | - public function writeBack($tmpFile, $path) { |
|
320 | - $handle = fopen($tmpFile, 'r'); |
|
321 | - try { |
|
322 | - $this->dropbox->putFile($path, $handle); |
|
323 | - unlink($tmpFile); |
|
324 | - $this->deleteMetaData($path); |
|
325 | - } catch (\Exception $exception) { |
|
326 | - \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
327 | - } |
|
328 | - } |
|
319 | + public function writeBack($tmpFile, $path) { |
|
320 | + $handle = fopen($tmpFile, 'r'); |
|
321 | + try { |
|
322 | + $this->dropbox->putFile($path, $handle); |
|
323 | + unlink($tmpFile); |
|
324 | + $this->deleteMetaData($path); |
|
325 | + } catch (\Exception $exception) { |
|
326 | + \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
327 | + } |
|
328 | + } |
|
329 | 329 | |
330 | - public function free_space($path) { |
|
331 | - try { |
|
332 | - $info = $this->dropbox->getAccountInfo(); |
|
333 | - return $info['quota_info']['quota'] - $info['quota_info']['normal']; |
|
334 | - } catch (\Exception $exception) { |
|
335 | - \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
336 | - return false; |
|
337 | - } |
|
338 | - } |
|
330 | + public function free_space($path) { |
|
331 | + try { |
|
332 | + $info = $this->dropbox->getAccountInfo(); |
|
333 | + return $info['quota_info']['quota'] - $info['quota_info']['normal']; |
|
334 | + } catch (\Exception $exception) { |
|
335 | + \OCP\Util::writeLog('files_external', $exception->getMessage(), \OCP\Util::ERROR); |
|
336 | + return false; |
|
337 | + } |
|
338 | + } |
|
339 | 339 | |
340 | - public function touch($path, $mtime = null) { |
|
341 | - if ($this->file_exists($path)) { |
|
342 | - return false; |
|
343 | - } else { |
|
344 | - $this->file_put_contents($path, ''); |
|
345 | - } |
|
346 | - return true; |
|
347 | - } |
|
340 | + public function touch($path, $mtime = null) { |
|
341 | + if ($this->file_exists($path)) { |
|
342 | + return false; |
|
343 | + } else { |
|
344 | + $this->file_put_contents($path, ''); |
|
345 | + } |
|
346 | + return true; |
|
347 | + } |
|
348 | 348 | |
349 | - /** |
|
350 | - * check if curl is installed |
|
351 | - */ |
|
352 | - public static function checkDependencies() { |
|
353 | - return true; |
|
354 | - } |
|
349 | + /** |
|
350 | + * check if curl is installed |
|
351 | + */ |
|
352 | + public static function checkDependencies() { |
|
353 | + return true; |
|
354 | + } |
|
355 | 355 | |
356 | 356 | } |
@@ -36,7 +36,7 @@ discard block |
||
36 | 36 | use Icewind\Streams\RetryWrapper; |
37 | 37 | use OCP\Files\StorageNotAvailableException; |
38 | 38 | |
39 | -require_once __DIR__ . '/../../../3rdparty/Dropbox/autoload.php'; |
|
39 | +require_once __DIR__.'/../../../3rdparty/Dropbox/autoload.php'; |
|
40 | 40 | |
41 | 41 | class Dropbox extends \OC\Files\Storage\Common { |
42 | 42 | |
@@ -54,7 +54,7 @@ discard block |
||
54 | 54 | && isset($params['token_secret']) |
55 | 55 | ) { |
56 | 56 | $this->root = isset($params['root']) ? $params['root'] : ''; |
57 | - $this->id = 'dropbox::'.$params['app_key'] . $params['token']. '/' . $this->root; |
|
57 | + $this->id = 'dropbox::'.$params['app_key'].$params['token'].'/'.$this->root; |
|
58 | 58 | $this->oauth = new \Dropbox_OAuth_Curl($params['app_key'], $params['app_secret']); |
59 | 59 | $this->oauth->setToken($params['token'], $params['token_secret']); |
60 | 60 | // note: Dropbox_API connection is lazy |
@@ -89,7 +89,7 @@ discard block |
||
89 | 89 | */ |
90 | 90 | private function getDropBoxMetaData($path, $list = false) { |
91 | 91 | $path = ltrim($this->root.$path, '/'); |
92 | - if ( ! $list && isset($this->metaData[$path])) { |
|
92 | + if (!$list && isset($this->metaData[$path])) { |
|
93 | 93 | return $this->metaData[$path]; |
94 | 94 | } else { |
95 | 95 | if ($list) { |
@@ -144,7 +144,7 @@ discard block |
||
144 | 144 | } |
145 | 145 | } |
146 | 146 | |
147 | - public function getId(){ |
|
147 | + public function getId() { |
|
148 | 148 | return $this->id; |
149 | 149 | } |
150 | 150 | |
@@ -259,7 +259,7 @@ discard block |
||
259 | 259 | try { |
260 | 260 | // slashes need to stay |
261 | 261 | $encodedPath = str_replace('%2F', '/', rawurlencode(trim($path, '/'))); |
262 | - $downloadUrl = 'https://api-content.dropbox.com/1/files/auto/' . $encodedPath; |
|
262 | + $downloadUrl = 'https://api-content.dropbox.com/1/files/auto/'.$encodedPath; |
|
263 | 263 | $headers = $this->oauth->getOAuthHeader($downloadUrl, [], 'GET'); |
264 | 264 | |
265 | 265 | $client = \OC::$server->getHTTPClientService()->newClient(); |
@@ -309,7 +309,7 @@ discard block |
||
309 | 309 | file_put_contents($tmpFile, $source); |
310 | 310 | } |
311 | 311 | $handle = fopen($tmpFile, $mode); |
312 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
312 | + return CallbackWrapper::wrap($handle, null, null, function() use ($path, $tmpFile) { |
|
313 | 313 | $this->writeBack($tmpFile, $path); |
314 | 314 | }); |
315 | 315 | } |
@@ -216,7 +216,7 @@ discard block |
||
216 | 216 | * |
217 | 217 | * @param \Google_Service_Drive_DriveFile |
218 | 218 | * |
219 | - * @return true if the file is a Google Doc file, false otherwise |
|
219 | + * @return boolean if the file is a Google Doc file, false otherwise |
|
220 | 220 | */ |
221 | 221 | private function isGoogleDocFile($file) { |
222 | 222 | return $this->getGoogleDocExtension($file->getMimeType()) !== ''; |
@@ -505,6 +505,9 @@ discard block |
||
505 | 505 | } |
506 | 506 | } |
507 | 507 | |
508 | + /** |
|
509 | + * @param string $path |
|
510 | + */ |
|
508 | 511 | public function writeBack($tmpFile, $path) { |
509 | 512 | $parentFolder = $this->getDriveFile(dirname($path)); |
510 | 513 | if ($parentFolder) { |
@@ -123,7 +123,7 @@ discard block |
||
123 | 123 | if (isset($this->driveFiles[$path])) { |
124 | 124 | $parentId = $this->driveFiles[$path]->getId(); |
125 | 125 | } else { |
126 | - $q = "title='" . str_replace("'","\\'", $name) . "' and '" . str_replace("'","\\'", $parentId) . "' in parents and trashed = false"; |
|
126 | + $q = "title='".str_replace("'", "\\'", $name)."' and '".str_replace("'", "\\'", $parentId)."' in parents and trashed = false"; |
|
127 | 127 | $result = $this->service->files->listFiles(array('q' => $q))->getItems(); |
128 | 128 | if (!empty($result)) { |
129 | 129 | // Google Drive allows files with the same name, Nextcloud doesn't |
@@ -236,7 +236,7 @@ discard block |
||
236 | 236 | if ($result) { |
237 | 237 | $this->setDriveFile($path, $result); |
238 | 238 | } |
239 | - return (bool)$result; |
|
239 | + return (bool) $result; |
|
240 | 240 | } |
241 | 241 | } |
242 | 242 | return false; |
@@ -248,7 +248,7 @@ discard block |
||
248 | 248 | } |
249 | 249 | if (trim($path, '/') === '') { |
250 | 250 | $dir = $this->opendir($path); |
251 | - if(is_resource($dir)) { |
|
251 | + if (is_resource($dir)) { |
|
252 | 252 | while (($file = readdir($dir)) !== false) { |
253 | 253 | if (!\OC\Files\Filesystem::isIgnoredDir($file)) { |
254 | 254 | if (!$this->unlink($path.'/'.$file)) { |
@@ -276,7 +276,7 @@ discard block |
||
276 | 276 | if ($pageToken !== true) { |
277 | 277 | $params['pageToken'] = $pageToken; |
278 | 278 | } |
279 | - $params['q'] = "'" . str_replace("'","\\'", $folder->getId()) . "' in parents and trashed = false"; |
|
279 | + $params['q'] = "'".str_replace("'", "\\'", $folder->getId())."' in parents and trashed = false"; |
|
280 | 280 | $children = $this->service->files->listFiles($params); |
281 | 281 | foreach ($children->getItems() as $child) { |
282 | 282 | $name = $child->getTitle(); |
@@ -369,7 +369,7 @@ discard block |
||
369 | 369 | } |
370 | 370 | |
371 | 371 | public function file_exists($path) { |
372 | - return (bool)$this->getDriveFile($path); |
|
372 | + return (bool) $this->getDriveFile($path); |
|
373 | 373 | } |
374 | 374 | |
375 | 375 | public function unlink($path) { |
@@ -379,7 +379,7 @@ discard block |
||
379 | 379 | if ($result) { |
380 | 380 | $this->setDriveFile($path, false); |
381 | 381 | } |
382 | - return (bool)$result; |
|
382 | + return (bool) $result; |
|
383 | 383 | } else { |
384 | 384 | return false; |
385 | 385 | } |
@@ -427,7 +427,7 @@ discard block |
||
427 | 427 | } |
428 | 428 | } |
429 | 429 | } |
430 | - return (bool)$result; |
|
430 | + return (bool) $result; |
|
431 | 431 | } else { |
432 | 432 | return false; |
433 | 433 | } |
@@ -462,10 +462,10 @@ discard block |
||
462 | 462 | $response = $client->get($downloadUrl, [ |
463 | 463 | 'headers' => $httpRequest->getRequestHeaders(), |
464 | 464 | 'stream' => true, |
465 | - 'verify' => realpath(__DIR__ . '/../../../3rdparty/google-api-php-client/src/Google/IO/cacerts.pem'), |
|
465 | + 'verify' => realpath(__DIR__.'/../../../3rdparty/google-api-php-client/src/Google/IO/cacerts.pem'), |
|
466 | 466 | ]); |
467 | 467 | } catch (RequestException $e) { |
468 | - if(!is_null($e->getResponse())) { |
|
468 | + if (!is_null($e->getResponse())) { |
|
469 | 469 | if ($e->getResponse()->getStatusCode() === 404) { |
470 | 470 | return false; |
471 | 471 | } else { |
@@ -499,7 +499,7 @@ discard block |
||
499 | 499 | file_put_contents($tmpFile, $source); |
500 | 500 | } |
501 | 501 | $handle = fopen($tmpFile, $mode); |
502 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
502 | + return CallbackWrapper::wrap($handle, null, null, function() use ($path, $tmpFile) { |
|
503 | 503 | $this->writeBack($tmpFile, $path); |
504 | 504 | }); |
505 | 505 | } |
@@ -641,7 +641,7 @@ discard block |
||
641 | 641 | if ($result) { |
642 | 642 | $this->setDriveFile($path, $result); |
643 | 643 | } |
644 | - return (bool)$result; |
|
644 | + return (bool) $result; |
|
645 | 645 | } |
646 | 646 | |
647 | 647 | public function test() { |
@@ -668,7 +668,7 @@ discard block |
||
668 | 668 | 'includeSubscribed' => true, |
669 | 669 | ); |
670 | 670 | if (isset($startChangeId)) { |
671 | - $startChangeId = (int)$startChangeId; |
|
671 | + $startChangeId = (int) $startChangeId; |
|
672 | 672 | $largestChangeId = $startChangeId; |
673 | 673 | $params['startChangeId'] = $startChangeId + 1; |
674 | 674 | } else { |
@@ -41,352 +41,352 @@ discard block |
||
41 | 41 | use Icewind\Streams\RetryWrapper; |
42 | 42 | |
43 | 43 | set_include_path(get_include_path().PATH_SEPARATOR. |
44 | - \OC_App::getAppPath('files_external').'/3rdparty/google-api-php-client/src'); |
|
44 | + \OC_App::getAppPath('files_external').'/3rdparty/google-api-php-client/src'); |
|
45 | 45 | require_once 'Google/autoload.php'; |
46 | 46 | |
47 | 47 | class Google extends \OC\Files\Storage\Common { |
48 | 48 | |
49 | - private $client; |
|
50 | - private $id; |
|
51 | - private $service; |
|
52 | - private $driveFiles; |
|
53 | - |
|
54 | - // Google Doc mimetypes |
|
55 | - const FOLDER = 'application/vnd.google-apps.folder'; |
|
56 | - const DOCUMENT = 'application/vnd.google-apps.document'; |
|
57 | - const SPREADSHEET = 'application/vnd.google-apps.spreadsheet'; |
|
58 | - const DRAWING = 'application/vnd.google-apps.drawing'; |
|
59 | - const PRESENTATION = 'application/vnd.google-apps.presentation'; |
|
60 | - const MAP = 'application/vnd.google-apps.map'; |
|
61 | - |
|
62 | - public function __construct($params) { |
|
63 | - if (isset($params['configured']) && $params['configured'] === 'true' |
|
64 | - && isset($params['client_id']) && isset($params['client_secret']) |
|
65 | - && isset($params['token']) |
|
66 | - ) { |
|
67 | - $this->client = new \Google_Client(); |
|
68 | - $this->client->setClientId($params['client_id']); |
|
69 | - $this->client->setClientSecret($params['client_secret']); |
|
70 | - $this->client->setScopes(array('https://www.googleapis.com/auth/drive')); |
|
71 | - $this->client->setAccessToken($params['token']); |
|
72 | - // if curl isn't available we're likely to run into |
|
73 | - // https://github.com/google/google-api-php-client/issues/59 |
|
74 | - // - disable gzip to avoid it. |
|
75 | - if (!function_exists('curl_version') || !function_exists('curl_exec')) { |
|
76 | - $this->client->setClassConfig("Google_Http_Request", "disable_gzip", true); |
|
77 | - } |
|
78 | - // note: API connection is lazy |
|
79 | - $this->service = new \Google_Service_Drive($this->client); |
|
80 | - $token = json_decode($params['token'], true); |
|
81 | - $this->id = 'google::'.substr($params['client_id'], 0, 30).$token['created']; |
|
82 | - } else { |
|
83 | - throw new \Exception('Creating Google storage failed'); |
|
84 | - } |
|
85 | - } |
|
86 | - |
|
87 | - public function getId() { |
|
88 | - return $this->id; |
|
89 | - } |
|
90 | - |
|
91 | - /** |
|
92 | - * Get the Google_Service_Drive_DriveFile object for the specified path. |
|
93 | - * Returns false on failure. |
|
94 | - * @param string $path |
|
95 | - * @return \Google_Service_Drive_DriveFile|false |
|
96 | - */ |
|
97 | - private function getDriveFile($path) { |
|
98 | - // Remove leading and trailing slashes |
|
99 | - $path = trim($path, '/'); |
|
100 | - if ($path === '.') { |
|
101 | - $path = ''; |
|
102 | - } |
|
103 | - if (isset($this->driveFiles[$path])) { |
|
104 | - return $this->driveFiles[$path]; |
|
105 | - } else if ($path === '') { |
|
106 | - $root = $this->service->files->get('root'); |
|
107 | - $this->driveFiles[$path] = $root; |
|
108 | - return $root; |
|
109 | - } else { |
|
110 | - // Google Drive SDK does not have methods for retrieving files by path |
|
111 | - // Instead we must find the id of the parent folder of the file |
|
112 | - $parentId = $this->getDriveFile('')->getId(); |
|
113 | - $folderNames = explode('/', $path); |
|
114 | - $path = ''; |
|
115 | - // Loop through each folder of this path to get to the file |
|
116 | - foreach ($folderNames as $name) { |
|
117 | - // Reconstruct path from beginning |
|
118 | - if ($path === '') { |
|
119 | - $path .= $name; |
|
120 | - } else { |
|
121 | - $path .= '/'.$name; |
|
122 | - } |
|
123 | - if (isset($this->driveFiles[$path])) { |
|
124 | - $parentId = $this->driveFiles[$path]->getId(); |
|
125 | - } else { |
|
126 | - $q = "title='" . str_replace("'","\\'", $name) . "' and '" . str_replace("'","\\'", $parentId) . "' in parents and trashed = false"; |
|
127 | - $result = $this->service->files->listFiles(array('q' => $q))->getItems(); |
|
128 | - if (!empty($result)) { |
|
129 | - // Google Drive allows files with the same name, Nextcloud doesn't |
|
130 | - if (count($result) > 1) { |
|
131 | - $this->onDuplicateFileDetected($path); |
|
132 | - return false; |
|
133 | - } else { |
|
134 | - $file = current($result); |
|
135 | - $this->driveFiles[$path] = $file; |
|
136 | - $parentId = $file->getId(); |
|
137 | - } |
|
138 | - } else { |
|
139 | - // Google Docs have no extension in their title, so try without extension |
|
140 | - $pos = strrpos($path, '.'); |
|
141 | - if ($pos !== false) { |
|
142 | - $pathWithoutExt = substr($path, 0, $pos); |
|
143 | - $file = $this->getDriveFile($pathWithoutExt); |
|
144 | - if ($file && $this->isGoogleDocFile($file)) { |
|
145 | - // Switch cached Google_Service_Drive_DriveFile to the correct index |
|
146 | - unset($this->driveFiles[$pathWithoutExt]); |
|
147 | - $this->driveFiles[$path] = $file; |
|
148 | - $parentId = $file->getId(); |
|
149 | - } else { |
|
150 | - return false; |
|
151 | - } |
|
152 | - } else { |
|
153 | - return false; |
|
154 | - } |
|
155 | - } |
|
156 | - } |
|
157 | - } |
|
158 | - return $this->driveFiles[$path]; |
|
159 | - } |
|
160 | - } |
|
161 | - |
|
162 | - /** |
|
163 | - * Set the Google_Service_Drive_DriveFile object in the cache |
|
164 | - * @param string $path |
|
165 | - * @param \Google_Service_Drive_DriveFile|false $file |
|
166 | - */ |
|
167 | - private function setDriveFile($path, $file) { |
|
168 | - $path = trim($path, '/'); |
|
169 | - $this->driveFiles[$path] = $file; |
|
170 | - if ($file === false) { |
|
171 | - // Remove all children |
|
172 | - $len = strlen($path); |
|
173 | - foreach ($this->driveFiles as $key => $file) { |
|
174 | - if (substr($key, 0, $len) === $path) { |
|
175 | - unset($this->driveFiles[$key]); |
|
176 | - } |
|
177 | - } |
|
178 | - } |
|
179 | - } |
|
180 | - |
|
181 | - /** |
|
182 | - * Write a log message to inform about duplicate file names |
|
183 | - * @param string $path |
|
184 | - */ |
|
185 | - private function onDuplicateFileDetected($path) { |
|
186 | - $about = $this->service->about->get(); |
|
187 | - $user = $about->getName(); |
|
188 | - \OCP\Util::writeLog('files_external', |
|
189 | - 'Ignoring duplicate file name: '.$path.' on Google Drive for Google user: '.$user, |
|
190 | - \OCP\Util::INFO |
|
191 | - ); |
|
192 | - } |
|
193 | - |
|
194 | - /** |
|
195 | - * Generate file extension for a Google Doc, choosing Open Document formats for download |
|
196 | - * @param string $mimetype |
|
197 | - * @return string |
|
198 | - */ |
|
199 | - private function getGoogleDocExtension($mimetype) { |
|
200 | - if ($mimetype === self::DOCUMENT) { |
|
201 | - return 'odt'; |
|
202 | - } else if ($mimetype === self::SPREADSHEET) { |
|
203 | - return 'ods'; |
|
204 | - } else if ($mimetype === self::DRAWING) { |
|
205 | - return 'jpg'; |
|
206 | - } else if ($mimetype === self::PRESENTATION) { |
|
207 | - // Download as .odp is not available |
|
208 | - return 'pdf'; |
|
209 | - } else { |
|
210 | - return ''; |
|
211 | - } |
|
212 | - } |
|
213 | - |
|
214 | - /** |
|
215 | - * Returns whether the given drive file is a Google Doc file |
|
216 | - * |
|
217 | - * @param \Google_Service_Drive_DriveFile |
|
218 | - * |
|
219 | - * @return true if the file is a Google Doc file, false otherwise |
|
220 | - */ |
|
221 | - private function isGoogleDocFile($file) { |
|
222 | - return $this->getGoogleDocExtension($file->getMimeType()) !== ''; |
|
223 | - } |
|
224 | - |
|
225 | - public function mkdir($path) { |
|
226 | - if (!$this->is_dir($path)) { |
|
227 | - $parentFolder = $this->getDriveFile(dirname($path)); |
|
228 | - if ($parentFolder) { |
|
229 | - $folder = new \Google_Service_Drive_DriveFile(); |
|
230 | - $folder->setTitle(basename($path)); |
|
231 | - $folder->setMimeType(self::FOLDER); |
|
232 | - $parent = new \Google_Service_Drive_ParentReference(); |
|
233 | - $parent->setId($parentFolder->getId()); |
|
234 | - $folder->setParents(array($parent)); |
|
235 | - $result = $this->service->files->insert($folder); |
|
236 | - if ($result) { |
|
237 | - $this->setDriveFile($path, $result); |
|
238 | - } |
|
239 | - return (bool)$result; |
|
240 | - } |
|
241 | - } |
|
242 | - return false; |
|
243 | - } |
|
244 | - |
|
245 | - public function rmdir($path) { |
|
246 | - if (!$this->isDeletable($path)) { |
|
247 | - return false; |
|
248 | - } |
|
249 | - if (trim($path, '/') === '') { |
|
250 | - $dir = $this->opendir($path); |
|
251 | - if(is_resource($dir)) { |
|
252 | - while (($file = readdir($dir)) !== false) { |
|
253 | - if (!\OC\Files\Filesystem::isIgnoredDir($file)) { |
|
254 | - if (!$this->unlink($path.'/'.$file)) { |
|
255 | - return false; |
|
256 | - } |
|
257 | - } |
|
258 | - } |
|
259 | - closedir($dir); |
|
260 | - } |
|
261 | - $this->driveFiles = array(); |
|
262 | - return true; |
|
263 | - } else { |
|
264 | - return $this->unlink($path); |
|
265 | - } |
|
266 | - } |
|
267 | - |
|
268 | - public function opendir($path) { |
|
269 | - $folder = $this->getDriveFile($path); |
|
270 | - if ($folder) { |
|
271 | - $files = array(); |
|
272 | - $duplicates = array(); |
|
273 | - $pageToken = true; |
|
274 | - while ($pageToken) { |
|
275 | - $params = array(); |
|
276 | - if ($pageToken !== true) { |
|
277 | - $params['pageToken'] = $pageToken; |
|
278 | - } |
|
279 | - $params['q'] = "'" . str_replace("'","\\'", $folder->getId()) . "' in parents and trashed = false"; |
|
280 | - $children = $this->service->files->listFiles($params); |
|
281 | - foreach ($children->getItems() as $child) { |
|
282 | - $name = $child->getTitle(); |
|
283 | - // Check if this is a Google Doc i.e. no extension in name |
|
284 | - $extension = $child->getFileExtension(); |
|
285 | - if (empty($extension)) { |
|
286 | - if ($child->getMimeType() === self::MAP) { |
|
287 | - continue; // No method known to transfer map files, ignore it |
|
288 | - } else if ($child->getMimeType() !== self::FOLDER) { |
|
289 | - $name .= '.'.$this->getGoogleDocExtension($child->getMimeType()); |
|
290 | - } |
|
291 | - } |
|
292 | - if ($path === '') { |
|
293 | - $filepath = $name; |
|
294 | - } else { |
|
295 | - $filepath = $path.'/'.$name; |
|
296 | - } |
|
297 | - // Google Drive allows files with the same name, Nextcloud doesn't |
|
298 | - // Prevent opendir() from returning any duplicate files |
|
299 | - $key = array_search($name, $files); |
|
300 | - if ($key !== false || isset($duplicates[$filepath])) { |
|
301 | - if (!isset($duplicates[$filepath])) { |
|
302 | - $duplicates[$filepath] = true; |
|
303 | - $this->setDriveFile($filepath, false); |
|
304 | - unset($files[$key]); |
|
305 | - $this->onDuplicateFileDetected($filepath); |
|
306 | - } |
|
307 | - } else { |
|
308 | - // Cache the Google_Service_Drive_DriveFile for future use |
|
309 | - $this->setDriveFile($filepath, $child); |
|
310 | - $files[] = $name; |
|
311 | - } |
|
312 | - } |
|
313 | - $pageToken = $children->getNextPageToken(); |
|
314 | - } |
|
315 | - return IteratorDirectory::wrap($files); |
|
316 | - } else { |
|
317 | - return false; |
|
318 | - } |
|
319 | - } |
|
320 | - |
|
321 | - public function stat($path) { |
|
322 | - $file = $this->getDriveFile($path); |
|
323 | - if ($file) { |
|
324 | - $stat = array(); |
|
325 | - if ($this->filetype($path) === 'dir') { |
|
326 | - $stat['size'] = 0; |
|
327 | - } else { |
|
328 | - // Check if this is a Google Doc |
|
329 | - if ($this->isGoogleDocFile($file)) { |
|
330 | - // Return unknown file size |
|
331 | - $stat['size'] = \OCP\Files\FileInfo::SPACE_UNKNOWN; |
|
332 | - } else { |
|
333 | - $stat['size'] = $file->getFileSize(); |
|
334 | - } |
|
335 | - } |
|
336 | - $stat['atime'] = strtotime($file->getLastViewedByMeDate()); |
|
337 | - $stat['mtime'] = strtotime($file->getModifiedDate()); |
|
338 | - $stat['ctime'] = strtotime($file->getCreatedDate()); |
|
339 | - return $stat; |
|
340 | - } else { |
|
341 | - return false; |
|
342 | - } |
|
343 | - } |
|
344 | - |
|
345 | - public function filetype($path) { |
|
346 | - if ($path === '') { |
|
347 | - return 'dir'; |
|
348 | - } else { |
|
349 | - $file = $this->getDriveFile($path); |
|
350 | - if ($file) { |
|
351 | - if ($file->getMimeType() === self::FOLDER) { |
|
352 | - return 'dir'; |
|
353 | - } else { |
|
354 | - return 'file'; |
|
355 | - } |
|
356 | - } else { |
|
357 | - return false; |
|
358 | - } |
|
359 | - } |
|
360 | - } |
|
361 | - |
|
362 | - public function isUpdatable($path) { |
|
363 | - $file = $this->getDriveFile($path); |
|
364 | - if ($file) { |
|
365 | - return $file->getEditable(); |
|
366 | - } else { |
|
367 | - return false; |
|
368 | - } |
|
369 | - } |
|
370 | - |
|
371 | - public function file_exists($path) { |
|
372 | - return (bool)$this->getDriveFile($path); |
|
373 | - } |
|
374 | - |
|
375 | - public function unlink($path) { |
|
376 | - $file = $this->getDriveFile($path); |
|
377 | - if ($file) { |
|
378 | - $result = $this->service->files->trash($file->getId()); |
|
379 | - if ($result) { |
|
380 | - $this->setDriveFile($path, false); |
|
381 | - } |
|
382 | - return (bool)$result; |
|
383 | - } else { |
|
384 | - return false; |
|
385 | - } |
|
386 | - } |
|
387 | - |
|
388 | - public function rename($path1, $path2) { |
|
389 | - // Avoid duplicate files with the same name |
|
49 | + private $client; |
|
50 | + private $id; |
|
51 | + private $service; |
|
52 | + private $driveFiles; |
|
53 | + |
|
54 | + // Google Doc mimetypes |
|
55 | + const FOLDER = 'application/vnd.google-apps.folder'; |
|
56 | + const DOCUMENT = 'application/vnd.google-apps.document'; |
|
57 | + const SPREADSHEET = 'application/vnd.google-apps.spreadsheet'; |
|
58 | + const DRAWING = 'application/vnd.google-apps.drawing'; |
|
59 | + const PRESENTATION = 'application/vnd.google-apps.presentation'; |
|
60 | + const MAP = 'application/vnd.google-apps.map'; |
|
61 | + |
|
62 | + public function __construct($params) { |
|
63 | + if (isset($params['configured']) && $params['configured'] === 'true' |
|
64 | + && isset($params['client_id']) && isset($params['client_secret']) |
|
65 | + && isset($params['token']) |
|
66 | + ) { |
|
67 | + $this->client = new \Google_Client(); |
|
68 | + $this->client->setClientId($params['client_id']); |
|
69 | + $this->client->setClientSecret($params['client_secret']); |
|
70 | + $this->client->setScopes(array('https://www.googleapis.com/auth/drive')); |
|
71 | + $this->client->setAccessToken($params['token']); |
|
72 | + // if curl isn't available we're likely to run into |
|
73 | + // https://github.com/google/google-api-php-client/issues/59 |
|
74 | + // - disable gzip to avoid it. |
|
75 | + if (!function_exists('curl_version') || !function_exists('curl_exec')) { |
|
76 | + $this->client->setClassConfig("Google_Http_Request", "disable_gzip", true); |
|
77 | + } |
|
78 | + // note: API connection is lazy |
|
79 | + $this->service = new \Google_Service_Drive($this->client); |
|
80 | + $token = json_decode($params['token'], true); |
|
81 | + $this->id = 'google::'.substr($params['client_id'], 0, 30).$token['created']; |
|
82 | + } else { |
|
83 | + throw new \Exception('Creating Google storage failed'); |
|
84 | + } |
|
85 | + } |
|
86 | + |
|
87 | + public function getId() { |
|
88 | + return $this->id; |
|
89 | + } |
|
90 | + |
|
91 | + /** |
|
92 | + * Get the Google_Service_Drive_DriveFile object for the specified path. |
|
93 | + * Returns false on failure. |
|
94 | + * @param string $path |
|
95 | + * @return \Google_Service_Drive_DriveFile|false |
|
96 | + */ |
|
97 | + private function getDriveFile($path) { |
|
98 | + // Remove leading and trailing slashes |
|
99 | + $path = trim($path, '/'); |
|
100 | + if ($path === '.') { |
|
101 | + $path = ''; |
|
102 | + } |
|
103 | + if (isset($this->driveFiles[$path])) { |
|
104 | + return $this->driveFiles[$path]; |
|
105 | + } else if ($path === '') { |
|
106 | + $root = $this->service->files->get('root'); |
|
107 | + $this->driveFiles[$path] = $root; |
|
108 | + return $root; |
|
109 | + } else { |
|
110 | + // Google Drive SDK does not have methods for retrieving files by path |
|
111 | + // Instead we must find the id of the parent folder of the file |
|
112 | + $parentId = $this->getDriveFile('')->getId(); |
|
113 | + $folderNames = explode('/', $path); |
|
114 | + $path = ''; |
|
115 | + // Loop through each folder of this path to get to the file |
|
116 | + foreach ($folderNames as $name) { |
|
117 | + // Reconstruct path from beginning |
|
118 | + if ($path === '') { |
|
119 | + $path .= $name; |
|
120 | + } else { |
|
121 | + $path .= '/'.$name; |
|
122 | + } |
|
123 | + if (isset($this->driveFiles[$path])) { |
|
124 | + $parentId = $this->driveFiles[$path]->getId(); |
|
125 | + } else { |
|
126 | + $q = "title='" . str_replace("'","\\'", $name) . "' and '" . str_replace("'","\\'", $parentId) . "' in parents and trashed = false"; |
|
127 | + $result = $this->service->files->listFiles(array('q' => $q))->getItems(); |
|
128 | + if (!empty($result)) { |
|
129 | + // Google Drive allows files with the same name, Nextcloud doesn't |
|
130 | + if (count($result) > 1) { |
|
131 | + $this->onDuplicateFileDetected($path); |
|
132 | + return false; |
|
133 | + } else { |
|
134 | + $file = current($result); |
|
135 | + $this->driveFiles[$path] = $file; |
|
136 | + $parentId = $file->getId(); |
|
137 | + } |
|
138 | + } else { |
|
139 | + // Google Docs have no extension in their title, so try without extension |
|
140 | + $pos = strrpos($path, '.'); |
|
141 | + if ($pos !== false) { |
|
142 | + $pathWithoutExt = substr($path, 0, $pos); |
|
143 | + $file = $this->getDriveFile($pathWithoutExt); |
|
144 | + if ($file && $this->isGoogleDocFile($file)) { |
|
145 | + // Switch cached Google_Service_Drive_DriveFile to the correct index |
|
146 | + unset($this->driveFiles[$pathWithoutExt]); |
|
147 | + $this->driveFiles[$path] = $file; |
|
148 | + $parentId = $file->getId(); |
|
149 | + } else { |
|
150 | + return false; |
|
151 | + } |
|
152 | + } else { |
|
153 | + return false; |
|
154 | + } |
|
155 | + } |
|
156 | + } |
|
157 | + } |
|
158 | + return $this->driveFiles[$path]; |
|
159 | + } |
|
160 | + } |
|
161 | + |
|
162 | + /** |
|
163 | + * Set the Google_Service_Drive_DriveFile object in the cache |
|
164 | + * @param string $path |
|
165 | + * @param \Google_Service_Drive_DriveFile|false $file |
|
166 | + */ |
|
167 | + private function setDriveFile($path, $file) { |
|
168 | + $path = trim($path, '/'); |
|
169 | + $this->driveFiles[$path] = $file; |
|
170 | + if ($file === false) { |
|
171 | + // Remove all children |
|
172 | + $len = strlen($path); |
|
173 | + foreach ($this->driveFiles as $key => $file) { |
|
174 | + if (substr($key, 0, $len) === $path) { |
|
175 | + unset($this->driveFiles[$key]); |
|
176 | + } |
|
177 | + } |
|
178 | + } |
|
179 | + } |
|
180 | + |
|
181 | + /** |
|
182 | + * Write a log message to inform about duplicate file names |
|
183 | + * @param string $path |
|
184 | + */ |
|
185 | + private function onDuplicateFileDetected($path) { |
|
186 | + $about = $this->service->about->get(); |
|
187 | + $user = $about->getName(); |
|
188 | + \OCP\Util::writeLog('files_external', |
|
189 | + 'Ignoring duplicate file name: '.$path.' on Google Drive for Google user: '.$user, |
|
190 | + \OCP\Util::INFO |
|
191 | + ); |
|
192 | + } |
|
193 | + |
|
194 | + /** |
|
195 | + * Generate file extension for a Google Doc, choosing Open Document formats for download |
|
196 | + * @param string $mimetype |
|
197 | + * @return string |
|
198 | + */ |
|
199 | + private function getGoogleDocExtension($mimetype) { |
|
200 | + if ($mimetype === self::DOCUMENT) { |
|
201 | + return 'odt'; |
|
202 | + } else if ($mimetype === self::SPREADSHEET) { |
|
203 | + return 'ods'; |
|
204 | + } else if ($mimetype === self::DRAWING) { |
|
205 | + return 'jpg'; |
|
206 | + } else if ($mimetype === self::PRESENTATION) { |
|
207 | + // Download as .odp is not available |
|
208 | + return 'pdf'; |
|
209 | + } else { |
|
210 | + return ''; |
|
211 | + } |
|
212 | + } |
|
213 | + |
|
214 | + /** |
|
215 | + * Returns whether the given drive file is a Google Doc file |
|
216 | + * |
|
217 | + * @param \Google_Service_Drive_DriveFile |
|
218 | + * |
|
219 | + * @return true if the file is a Google Doc file, false otherwise |
|
220 | + */ |
|
221 | + private function isGoogleDocFile($file) { |
|
222 | + return $this->getGoogleDocExtension($file->getMimeType()) !== ''; |
|
223 | + } |
|
224 | + |
|
225 | + public function mkdir($path) { |
|
226 | + if (!$this->is_dir($path)) { |
|
227 | + $parentFolder = $this->getDriveFile(dirname($path)); |
|
228 | + if ($parentFolder) { |
|
229 | + $folder = new \Google_Service_Drive_DriveFile(); |
|
230 | + $folder->setTitle(basename($path)); |
|
231 | + $folder->setMimeType(self::FOLDER); |
|
232 | + $parent = new \Google_Service_Drive_ParentReference(); |
|
233 | + $parent->setId($parentFolder->getId()); |
|
234 | + $folder->setParents(array($parent)); |
|
235 | + $result = $this->service->files->insert($folder); |
|
236 | + if ($result) { |
|
237 | + $this->setDriveFile($path, $result); |
|
238 | + } |
|
239 | + return (bool)$result; |
|
240 | + } |
|
241 | + } |
|
242 | + return false; |
|
243 | + } |
|
244 | + |
|
245 | + public function rmdir($path) { |
|
246 | + if (!$this->isDeletable($path)) { |
|
247 | + return false; |
|
248 | + } |
|
249 | + if (trim($path, '/') === '') { |
|
250 | + $dir = $this->opendir($path); |
|
251 | + if(is_resource($dir)) { |
|
252 | + while (($file = readdir($dir)) !== false) { |
|
253 | + if (!\OC\Files\Filesystem::isIgnoredDir($file)) { |
|
254 | + if (!$this->unlink($path.'/'.$file)) { |
|
255 | + return false; |
|
256 | + } |
|
257 | + } |
|
258 | + } |
|
259 | + closedir($dir); |
|
260 | + } |
|
261 | + $this->driveFiles = array(); |
|
262 | + return true; |
|
263 | + } else { |
|
264 | + return $this->unlink($path); |
|
265 | + } |
|
266 | + } |
|
267 | + |
|
268 | + public function opendir($path) { |
|
269 | + $folder = $this->getDriveFile($path); |
|
270 | + if ($folder) { |
|
271 | + $files = array(); |
|
272 | + $duplicates = array(); |
|
273 | + $pageToken = true; |
|
274 | + while ($pageToken) { |
|
275 | + $params = array(); |
|
276 | + if ($pageToken !== true) { |
|
277 | + $params['pageToken'] = $pageToken; |
|
278 | + } |
|
279 | + $params['q'] = "'" . str_replace("'","\\'", $folder->getId()) . "' in parents and trashed = false"; |
|
280 | + $children = $this->service->files->listFiles($params); |
|
281 | + foreach ($children->getItems() as $child) { |
|
282 | + $name = $child->getTitle(); |
|
283 | + // Check if this is a Google Doc i.e. no extension in name |
|
284 | + $extension = $child->getFileExtension(); |
|
285 | + if (empty($extension)) { |
|
286 | + if ($child->getMimeType() === self::MAP) { |
|
287 | + continue; // No method known to transfer map files, ignore it |
|
288 | + } else if ($child->getMimeType() !== self::FOLDER) { |
|
289 | + $name .= '.'.$this->getGoogleDocExtension($child->getMimeType()); |
|
290 | + } |
|
291 | + } |
|
292 | + if ($path === '') { |
|
293 | + $filepath = $name; |
|
294 | + } else { |
|
295 | + $filepath = $path.'/'.$name; |
|
296 | + } |
|
297 | + // Google Drive allows files with the same name, Nextcloud doesn't |
|
298 | + // Prevent opendir() from returning any duplicate files |
|
299 | + $key = array_search($name, $files); |
|
300 | + if ($key !== false || isset($duplicates[$filepath])) { |
|
301 | + if (!isset($duplicates[$filepath])) { |
|
302 | + $duplicates[$filepath] = true; |
|
303 | + $this->setDriveFile($filepath, false); |
|
304 | + unset($files[$key]); |
|
305 | + $this->onDuplicateFileDetected($filepath); |
|
306 | + } |
|
307 | + } else { |
|
308 | + // Cache the Google_Service_Drive_DriveFile for future use |
|
309 | + $this->setDriveFile($filepath, $child); |
|
310 | + $files[] = $name; |
|
311 | + } |
|
312 | + } |
|
313 | + $pageToken = $children->getNextPageToken(); |
|
314 | + } |
|
315 | + return IteratorDirectory::wrap($files); |
|
316 | + } else { |
|
317 | + return false; |
|
318 | + } |
|
319 | + } |
|
320 | + |
|
321 | + public function stat($path) { |
|
322 | + $file = $this->getDriveFile($path); |
|
323 | + if ($file) { |
|
324 | + $stat = array(); |
|
325 | + if ($this->filetype($path) === 'dir') { |
|
326 | + $stat['size'] = 0; |
|
327 | + } else { |
|
328 | + // Check if this is a Google Doc |
|
329 | + if ($this->isGoogleDocFile($file)) { |
|
330 | + // Return unknown file size |
|
331 | + $stat['size'] = \OCP\Files\FileInfo::SPACE_UNKNOWN; |
|
332 | + } else { |
|
333 | + $stat['size'] = $file->getFileSize(); |
|
334 | + } |
|
335 | + } |
|
336 | + $stat['atime'] = strtotime($file->getLastViewedByMeDate()); |
|
337 | + $stat['mtime'] = strtotime($file->getModifiedDate()); |
|
338 | + $stat['ctime'] = strtotime($file->getCreatedDate()); |
|
339 | + return $stat; |
|
340 | + } else { |
|
341 | + return false; |
|
342 | + } |
|
343 | + } |
|
344 | + |
|
345 | + public function filetype($path) { |
|
346 | + if ($path === '') { |
|
347 | + return 'dir'; |
|
348 | + } else { |
|
349 | + $file = $this->getDriveFile($path); |
|
350 | + if ($file) { |
|
351 | + if ($file->getMimeType() === self::FOLDER) { |
|
352 | + return 'dir'; |
|
353 | + } else { |
|
354 | + return 'file'; |
|
355 | + } |
|
356 | + } else { |
|
357 | + return false; |
|
358 | + } |
|
359 | + } |
|
360 | + } |
|
361 | + |
|
362 | + public function isUpdatable($path) { |
|
363 | + $file = $this->getDriveFile($path); |
|
364 | + if ($file) { |
|
365 | + return $file->getEditable(); |
|
366 | + } else { |
|
367 | + return false; |
|
368 | + } |
|
369 | + } |
|
370 | + |
|
371 | + public function file_exists($path) { |
|
372 | + return (bool)$this->getDriveFile($path); |
|
373 | + } |
|
374 | + |
|
375 | + public function unlink($path) { |
|
376 | + $file = $this->getDriveFile($path); |
|
377 | + if ($file) { |
|
378 | + $result = $this->service->files->trash($file->getId()); |
|
379 | + if ($result) { |
|
380 | + $this->setDriveFile($path, false); |
|
381 | + } |
|
382 | + return (bool)$result; |
|
383 | + } else { |
|
384 | + return false; |
|
385 | + } |
|
386 | + } |
|
387 | + |
|
388 | + public function rename($path1, $path2) { |
|
389 | + // Avoid duplicate files with the same name |
|
390 | 390 | $testRegex = '/^.+\.ocTransferId\d+\.part$/'; |
391 | 391 | if (preg_match($testRegex, $path1)) { |
392 | 392 | if ($this->is_file($path2)) { |
@@ -399,339 +399,339 @@ discard block |
||
399 | 399 | } |
400 | 400 | } |
401 | 401 | |
402 | - $file = $this->getDriveFile($path1); |
|
403 | - if ($file) { |
|
404 | - $newFile = $this->getDriveFile($path2); |
|
405 | - if (dirname($path1) === dirname($path2)) { |
|
406 | - if ($newFile) { |
|
407 | - // rename to the name of the target file, could be an office file without extension |
|
408 | - $file->setTitle($newFile->getTitle()); |
|
409 | - } else { |
|
410 | - $file->setTitle(basename(($path2))); |
|
411 | - } |
|
412 | - } else { |
|
413 | - // Change file parent |
|
414 | - $parentFolder2 = $this->getDriveFile(dirname($path2)); |
|
415 | - if ($parentFolder2) { |
|
416 | - $parent = new \Google_Service_Drive_ParentReference(); |
|
417 | - $parent->setId($parentFolder2->getId()); |
|
418 | - $file->setParents(array($parent)); |
|
419 | - } else { |
|
420 | - return false; |
|
421 | - } |
|
422 | - } |
|
423 | - // We need to get the object for the existing file with the same |
|
424 | - // name (if there is one) before we do the patch. If oldfile |
|
425 | - // exists and is a directory we have to delete it before we |
|
426 | - // do the rename too. |
|
427 | - $oldfile = $this->getDriveFile($path2); |
|
428 | - if ($oldfile && $this->is_dir($path2)) { |
|
429 | - $this->rmdir($path2); |
|
430 | - $oldfile = false; |
|
431 | - } |
|
432 | - $result = $this->service->files->patch($file->getId(), $file); |
|
433 | - if ($result) { |
|
434 | - $this->setDriveFile($path1, false); |
|
435 | - $this->setDriveFile($path2, $result); |
|
436 | - if ($oldfile && $newFile) { |
|
437 | - // only delete if they have a different id (same id can happen for part files) |
|
438 | - if ($newFile->getId() !== $oldfile->getId()) { |
|
439 | - $this->service->files->delete($oldfile->getId()); |
|
440 | - } |
|
441 | - } |
|
442 | - } |
|
443 | - return (bool)$result; |
|
444 | - } else { |
|
445 | - return false; |
|
446 | - } |
|
447 | - } |
|
448 | - |
|
449 | - public function fopen($path, $mode) { |
|
450 | - $pos = strrpos($path, '.'); |
|
451 | - if ($pos !== false) { |
|
452 | - $ext = substr($path, $pos); |
|
453 | - } else { |
|
454 | - $ext = ''; |
|
455 | - } |
|
456 | - switch ($mode) { |
|
457 | - case 'r': |
|
458 | - case 'rb': |
|
459 | - $file = $this->getDriveFile($path); |
|
460 | - if ($file) { |
|
461 | - $exportLinks = $file->getExportLinks(); |
|
462 | - $mimetype = $this->getMimeType($path); |
|
463 | - $downloadUrl = null; |
|
464 | - if ($exportLinks && isset($exportLinks[$mimetype])) { |
|
465 | - $downloadUrl = $exportLinks[$mimetype]; |
|
466 | - } else { |
|
467 | - $downloadUrl = $file->getDownloadUrl(); |
|
468 | - } |
|
469 | - if (isset($downloadUrl)) { |
|
470 | - $request = new \Google_Http_Request($downloadUrl, 'GET', null, null); |
|
471 | - $httpRequest = $this->client->getAuth()->sign($request); |
|
472 | - // the library's service doesn't support streaming, so we use Guzzle instead |
|
473 | - $client = \OC::$server->getHTTPClientService()->newClient(); |
|
474 | - try { |
|
475 | - $response = $client->get($downloadUrl, [ |
|
476 | - 'headers' => $httpRequest->getRequestHeaders(), |
|
477 | - 'stream' => true, |
|
478 | - 'verify' => realpath(__DIR__ . '/../../../3rdparty/google-api-php-client/src/Google/IO/cacerts.pem'), |
|
479 | - ]); |
|
480 | - } catch (RequestException $e) { |
|
481 | - if(!is_null($e->getResponse())) { |
|
482 | - if ($e->getResponse()->getStatusCode() === 404) { |
|
483 | - return false; |
|
484 | - } else { |
|
485 | - throw $e; |
|
486 | - } |
|
487 | - } else { |
|
488 | - throw $e; |
|
489 | - } |
|
490 | - } |
|
491 | - |
|
492 | - $handle = $response->getBody(); |
|
493 | - return RetryWrapper::wrap($handle); |
|
494 | - } |
|
495 | - } |
|
496 | - return false; |
|
497 | - case 'w': |
|
498 | - case 'wb': |
|
499 | - case 'a': |
|
500 | - case 'ab': |
|
501 | - case 'r+': |
|
502 | - case 'w+': |
|
503 | - case 'wb+': |
|
504 | - case 'a+': |
|
505 | - case 'x': |
|
506 | - case 'x+': |
|
507 | - case 'c': |
|
508 | - case 'c+': |
|
509 | - $tmpFile = \OCP\Files::tmpFile($ext); |
|
510 | - if ($this->file_exists($path)) { |
|
511 | - $source = $this->fopen($path, 'rb'); |
|
512 | - file_put_contents($tmpFile, $source); |
|
513 | - } |
|
514 | - $handle = fopen($tmpFile, $mode); |
|
515 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
516 | - $this->writeBack($tmpFile, $path); |
|
517 | - }); |
|
518 | - } |
|
519 | - } |
|
520 | - |
|
521 | - public function writeBack($tmpFile, $path) { |
|
522 | - $parentFolder = $this->getDriveFile(dirname($path)); |
|
523 | - if ($parentFolder) { |
|
524 | - $mimetype = \OC::$server->getMimeTypeDetector()->detect($tmpFile); |
|
525 | - $params = array( |
|
526 | - 'mimeType' => $mimetype, |
|
527 | - 'uploadType' => 'media' |
|
528 | - ); |
|
529 | - $result = false; |
|
530 | - |
|
531 | - $chunkSizeBytes = 10 * 1024 * 1024; |
|
532 | - |
|
533 | - $useChunking = false; |
|
534 | - $size = filesize($tmpFile); |
|
535 | - if ($size > $chunkSizeBytes) { |
|
536 | - $useChunking = true; |
|
537 | - } else { |
|
538 | - $params['data'] = file_get_contents($tmpFile); |
|
539 | - } |
|
540 | - |
|
541 | - if ($this->file_exists($path)) { |
|
542 | - $file = $this->getDriveFile($path); |
|
543 | - $this->client->setDefer($useChunking); |
|
544 | - $request = $this->service->files->update($file->getId(), $file, $params); |
|
545 | - } else { |
|
546 | - $file = new \Google_Service_Drive_DriveFile(); |
|
547 | - $file->setTitle(basename($path)); |
|
548 | - $file->setMimeType($mimetype); |
|
549 | - $parent = new \Google_Service_Drive_ParentReference(); |
|
550 | - $parent->setId($parentFolder->getId()); |
|
551 | - $file->setParents(array($parent)); |
|
552 | - $this->client->setDefer($useChunking); |
|
553 | - $request = $this->service->files->insert($file, $params); |
|
554 | - } |
|
555 | - |
|
556 | - if ($useChunking) { |
|
557 | - // Create a media file upload to represent our upload process. |
|
558 | - $media = new \Google_Http_MediaFileUpload( |
|
559 | - $this->client, |
|
560 | - $request, |
|
561 | - 'text/plain', |
|
562 | - null, |
|
563 | - true, |
|
564 | - $chunkSizeBytes |
|
565 | - ); |
|
566 | - $media->setFileSize($size); |
|
567 | - |
|
568 | - // Upload the various chunks. $status will be false until the process is |
|
569 | - // complete. |
|
570 | - $status = false; |
|
571 | - $handle = fopen($tmpFile, 'rb'); |
|
572 | - while (!$status && !feof($handle)) { |
|
573 | - $chunk = fread($handle, $chunkSizeBytes); |
|
574 | - $status = $media->nextChunk($chunk); |
|
575 | - } |
|
576 | - |
|
577 | - // The final value of $status will be the data from the API for the object |
|
578 | - // that has been uploaded. |
|
579 | - $result = false; |
|
580 | - if ($status !== false) { |
|
581 | - $result = $status; |
|
582 | - } |
|
583 | - |
|
584 | - fclose($handle); |
|
585 | - } else { |
|
586 | - $result = $request; |
|
587 | - } |
|
588 | - |
|
589 | - // Reset to the client to execute requests immediately in the future. |
|
590 | - $this->client->setDefer(false); |
|
591 | - |
|
592 | - if ($result) { |
|
593 | - $this->setDriveFile($path, $result); |
|
594 | - } |
|
595 | - } |
|
596 | - } |
|
597 | - |
|
598 | - public function getMimeType($path) { |
|
599 | - $file = $this->getDriveFile($path); |
|
600 | - if ($file) { |
|
601 | - $mimetype = $file->getMimeType(); |
|
602 | - // Convert Google Doc mimetypes, choosing Open Document formats for download |
|
603 | - if ($mimetype === self::FOLDER) { |
|
604 | - return 'httpd/unix-directory'; |
|
605 | - } else if ($mimetype === self::DOCUMENT) { |
|
606 | - return 'application/vnd.oasis.opendocument.text'; |
|
607 | - } else if ($mimetype === self::SPREADSHEET) { |
|
608 | - return 'application/x-vnd.oasis.opendocument.spreadsheet'; |
|
609 | - } else if ($mimetype === self::DRAWING) { |
|
610 | - return 'image/jpeg'; |
|
611 | - } else if ($mimetype === self::PRESENTATION) { |
|
612 | - // Download as .odp is not available |
|
613 | - return 'application/pdf'; |
|
614 | - } else { |
|
615 | - // use extension-based detection, could be an encrypted file |
|
616 | - return parent::getMimeType($path); |
|
617 | - } |
|
618 | - } else { |
|
619 | - return false; |
|
620 | - } |
|
621 | - } |
|
622 | - |
|
623 | - public function free_space($path) { |
|
624 | - $about = $this->service->about->get(); |
|
625 | - return $about->getQuotaBytesTotal() - $about->getQuotaBytesUsed(); |
|
626 | - } |
|
627 | - |
|
628 | - public function touch($path, $mtime = null) { |
|
629 | - $file = $this->getDriveFile($path); |
|
630 | - $result = false; |
|
631 | - if ($file) { |
|
632 | - if (isset($mtime)) { |
|
633 | - // This is just RFC3339, but frustratingly, GDrive's API *requires* |
|
634 | - // the fractions portion be present, while no handy PHP constant |
|
635 | - // for RFC3339 or ISO8601 includes it. So we do it ourselves. |
|
636 | - $file->setModifiedDate(date('Y-m-d\TH:i:s.uP', $mtime)); |
|
637 | - $result = $this->service->files->patch($file->getId(), $file, array( |
|
638 | - 'setModifiedDate' => true, |
|
639 | - )); |
|
640 | - } else { |
|
641 | - $result = $this->service->files->touch($file->getId()); |
|
642 | - } |
|
643 | - } else { |
|
644 | - $parentFolder = $this->getDriveFile(dirname($path)); |
|
645 | - if ($parentFolder) { |
|
646 | - $file = new \Google_Service_Drive_DriveFile(); |
|
647 | - $file->setTitle(basename($path)); |
|
648 | - $parent = new \Google_Service_Drive_ParentReference(); |
|
649 | - $parent->setId($parentFolder->getId()); |
|
650 | - $file->setParents(array($parent)); |
|
651 | - $result = $this->service->files->insert($file); |
|
652 | - } |
|
653 | - } |
|
654 | - if ($result) { |
|
655 | - $this->setDriveFile($path, $result); |
|
656 | - } |
|
657 | - return (bool)$result; |
|
658 | - } |
|
659 | - |
|
660 | - public function test() { |
|
661 | - if ($this->free_space('')) { |
|
662 | - return true; |
|
663 | - } |
|
664 | - return false; |
|
665 | - } |
|
666 | - |
|
667 | - public function hasUpdated($path, $time) { |
|
668 | - $appConfig = \OC::$server->getAppConfig(); |
|
669 | - if ($this->is_file($path)) { |
|
670 | - return parent::hasUpdated($path, $time); |
|
671 | - } else { |
|
672 | - // Google Drive doesn't change modified times of folders when files inside are updated |
|
673 | - // Instead we use the Changes API to see if folders have been updated, and it's a pain |
|
674 | - $folder = $this->getDriveFile($path); |
|
675 | - if ($folder) { |
|
676 | - $result = false; |
|
677 | - $folderId = $folder->getId(); |
|
678 | - $startChangeId = $appConfig->getValue('files_external', $this->getId().'cId'); |
|
679 | - $params = array( |
|
680 | - 'includeDeleted' => true, |
|
681 | - 'includeSubscribed' => true, |
|
682 | - ); |
|
683 | - if (isset($startChangeId)) { |
|
684 | - $startChangeId = (int)$startChangeId; |
|
685 | - $largestChangeId = $startChangeId; |
|
686 | - $params['startChangeId'] = $startChangeId + 1; |
|
687 | - } else { |
|
688 | - $largestChangeId = 0; |
|
689 | - } |
|
690 | - $pageToken = true; |
|
691 | - while ($pageToken) { |
|
692 | - if ($pageToken !== true) { |
|
693 | - $params['pageToken'] = $pageToken; |
|
694 | - } |
|
695 | - $changes = $this->service->changes->listChanges($params); |
|
696 | - if ($largestChangeId === 0 || $largestChangeId === $startChangeId) { |
|
697 | - $largestChangeId = $changes->getLargestChangeId(); |
|
698 | - } |
|
699 | - if (isset($startChangeId)) { |
|
700 | - // Check if a file in this folder has been updated |
|
701 | - // There is no way to filter by folder at the API level... |
|
702 | - foreach ($changes->getItems() as $change) { |
|
703 | - $file = $change->getFile(); |
|
704 | - if ($file) { |
|
705 | - foreach ($file->getParents() as $parent) { |
|
706 | - if ($parent->getId() === $folderId) { |
|
707 | - $result = true; |
|
708 | - // Check if there are changes in different folders |
|
709 | - } else if ($change->getId() <= $largestChangeId) { |
|
710 | - // Decrement id so this change is fetched when called again |
|
711 | - $largestChangeId = $change->getId(); |
|
712 | - $largestChangeId--; |
|
713 | - } |
|
714 | - } |
|
715 | - } |
|
716 | - } |
|
717 | - $pageToken = $changes->getNextPageToken(); |
|
718 | - } else { |
|
719 | - // Assuming the initial scan just occurred and changes are negligible |
|
720 | - break; |
|
721 | - } |
|
722 | - } |
|
723 | - $appConfig->setValue('files_external', $this->getId().'cId', $largestChangeId); |
|
724 | - return $result; |
|
725 | - } |
|
726 | - } |
|
727 | - return false; |
|
728 | - } |
|
729 | - |
|
730 | - /** |
|
731 | - * check if curl is installed |
|
732 | - */ |
|
733 | - public static function checkDependencies() { |
|
734 | - return true; |
|
735 | - } |
|
402 | + $file = $this->getDriveFile($path1); |
|
403 | + if ($file) { |
|
404 | + $newFile = $this->getDriveFile($path2); |
|
405 | + if (dirname($path1) === dirname($path2)) { |
|
406 | + if ($newFile) { |
|
407 | + // rename to the name of the target file, could be an office file without extension |
|
408 | + $file->setTitle($newFile->getTitle()); |
|
409 | + } else { |
|
410 | + $file->setTitle(basename(($path2))); |
|
411 | + } |
|
412 | + } else { |
|
413 | + // Change file parent |
|
414 | + $parentFolder2 = $this->getDriveFile(dirname($path2)); |
|
415 | + if ($parentFolder2) { |
|
416 | + $parent = new \Google_Service_Drive_ParentReference(); |
|
417 | + $parent->setId($parentFolder2->getId()); |
|
418 | + $file->setParents(array($parent)); |
|
419 | + } else { |
|
420 | + return false; |
|
421 | + } |
|
422 | + } |
|
423 | + // We need to get the object for the existing file with the same |
|
424 | + // name (if there is one) before we do the patch. If oldfile |
|
425 | + // exists and is a directory we have to delete it before we |
|
426 | + // do the rename too. |
|
427 | + $oldfile = $this->getDriveFile($path2); |
|
428 | + if ($oldfile && $this->is_dir($path2)) { |
|
429 | + $this->rmdir($path2); |
|
430 | + $oldfile = false; |
|
431 | + } |
|
432 | + $result = $this->service->files->patch($file->getId(), $file); |
|
433 | + if ($result) { |
|
434 | + $this->setDriveFile($path1, false); |
|
435 | + $this->setDriveFile($path2, $result); |
|
436 | + if ($oldfile && $newFile) { |
|
437 | + // only delete if they have a different id (same id can happen for part files) |
|
438 | + if ($newFile->getId() !== $oldfile->getId()) { |
|
439 | + $this->service->files->delete($oldfile->getId()); |
|
440 | + } |
|
441 | + } |
|
442 | + } |
|
443 | + return (bool)$result; |
|
444 | + } else { |
|
445 | + return false; |
|
446 | + } |
|
447 | + } |
|
448 | + |
|
449 | + public function fopen($path, $mode) { |
|
450 | + $pos = strrpos($path, '.'); |
|
451 | + if ($pos !== false) { |
|
452 | + $ext = substr($path, $pos); |
|
453 | + } else { |
|
454 | + $ext = ''; |
|
455 | + } |
|
456 | + switch ($mode) { |
|
457 | + case 'r': |
|
458 | + case 'rb': |
|
459 | + $file = $this->getDriveFile($path); |
|
460 | + if ($file) { |
|
461 | + $exportLinks = $file->getExportLinks(); |
|
462 | + $mimetype = $this->getMimeType($path); |
|
463 | + $downloadUrl = null; |
|
464 | + if ($exportLinks && isset($exportLinks[$mimetype])) { |
|
465 | + $downloadUrl = $exportLinks[$mimetype]; |
|
466 | + } else { |
|
467 | + $downloadUrl = $file->getDownloadUrl(); |
|
468 | + } |
|
469 | + if (isset($downloadUrl)) { |
|
470 | + $request = new \Google_Http_Request($downloadUrl, 'GET', null, null); |
|
471 | + $httpRequest = $this->client->getAuth()->sign($request); |
|
472 | + // the library's service doesn't support streaming, so we use Guzzle instead |
|
473 | + $client = \OC::$server->getHTTPClientService()->newClient(); |
|
474 | + try { |
|
475 | + $response = $client->get($downloadUrl, [ |
|
476 | + 'headers' => $httpRequest->getRequestHeaders(), |
|
477 | + 'stream' => true, |
|
478 | + 'verify' => realpath(__DIR__ . '/../../../3rdparty/google-api-php-client/src/Google/IO/cacerts.pem'), |
|
479 | + ]); |
|
480 | + } catch (RequestException $e) { |
|
481 | + if(!is_null($e->getResponse())) { |
|
482 | + if ($e->getResponse()->getStatusCode() === 404) { |
|
483 | + return false; |
|
484 | + } else { |
|
485 | + throw $e; |
|
486 | + } |
|
487 | + } else { |
|
488 | + throw $e; |
|
489 | + } |
|
490 | + } |
|
491 | + |
|
492 | + $handle = $response->getBody(); |
|
493 | + return RetryWrapper::wrap($handle); |
|
494 | + } |
|
495 | + } |
|
496 | + return false; |
|
497 | + case 'w': |
|
498 | + case 'wb': |
|
499 | + case 'a': |
|
500 | + case 'ab': |
|
501 | + case 'r+': |
|
502 | + case 'w+': |
|
503 | + case 'wb+': |
|
504 | + case 'a+': |
|
505 | + case 'x': |
|
506 | + case 'x+': |
|
507 | + case 'c': |
|
508 | + case 'c+': |
|
509 | + $tmpFile = \OCP\Files::tmpFile($ext); |
|
510 | + if ($this->file_exists($path)) { |
|
511 | + $source = $this->fopen($path, 'rb'); |
|
512 | + file_put_contents($tmpFile, $source); |
|
513 | + } |
|
514 | + $handle = fopen($tmpFile, $mode); |
|
515 | + return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
516 | + $this->writeBack($tmpFile, $path); |
|
517 | + }); |
|
518 | + } |
|
519 | + } |
|
520 | + |
|
521 | + public function writeBack($tmpFile, $path) { |
|
522 | + $parentFolder = $this->getDriveFile(dirname($path)); |
|
523 | + if ($parentFolder) { |
|
524 | + $mimetype = \OC::$server->getMimeTypeDetector()->detect($tmpFile); |
|
525 | + $params = array( |
|
526 | + 'mimeType' => $mimetype, |
|
527 | + 'uploadType' => 'media' |
|
528 | + ); |
|
529 | + $result = false; |
|
530 | + |
|
531 | + $chunkSizeBytes = 10 * 1024 * 1024; |
|
532 | + |
|
533 | + $useChunking = false; |
|
534 | + $size = filesize($tmpFile); |
|
535 | + if ($size > $chunkSizeBytes) { |
|
536 | + $useChunking = true; |
|
537 | + } else { |
|
538 | + $params['data'] = file_get_contents($tmpFile); |
|
539 | + } |
|
540 | + |
|
541 | + if ($this->file_exists($path)) { |
|
542 | + $file = $this->getDriveFile($path); |
|
543 | + $this->client->setDefer($useChunking); |
|
544 | + $request = $this->service->files->update($file->getId(), $file, $params); |
|
545 | + } else { |
|
546 | + $file = new \Google_Service_Drive_DriveFile(); |
|
547 | + $file->setTitle(basename($path)); |
|
548 | + $file->setMimeType($mimetype); |
|
549 | + $parent = new \Google_Service_Drive_ParentReference(); |
|
550 | + $parent->setId($parentFolder->getId()); |
|
551 | + $file->setParents(array($parent)); |
|
552 | + $this->client->setDefer($useChunking); |
|
553 | + $request = $this->service->files->insert($file, $params); |
|
554 | + } |
|
555 | + |
|
556 | + if ($useChunking) { |
|
557 | + // Create a media file upload to represent our upload process. |
|
558 | + $media = new \Google_Http_MediaFileUpload( |
|
559 | + $this->client, |
|
560 | + $request, |
|
561 | + 'text/plain', |
|
562 | + null, |
|
563 | + true, |
|
564 | + $chunkSizeBytes |
|
565 | + ); |
|
566 | + $media->setFileSize($size); |
|
567 | + |
|
568 | + // Upload the various chunks. $status will be false until the process is |
|
569 | + // complete. |
|
570 | + $status = false; |
|
571 | + $handle = fopen($tmpFile, 'rb'); |
|
572 | + while (!$status && !feof($handle)) { |
|
573 | + $chunk = fread($handle, $chunkSizeBytes); |
|
574 | + $status = $media->nextChunk($chunk); |
|
575 | + } |
|
576 | + |
|
577 | + // The final value of $status will be the data from the API for the object |
|
578 | + // that has been uploaded. |
|
579 | + $result = false; |
|
580 | + if ($status !== false) { |
|
581 | + $result = $status; |
|
582 | + } |
|
583 | + |
|
584 | + fclose($handle); |
|
585 | + } else { |
|
586 | + $result = $request; |
|
587 | + } |
|
588 | + |
|
589 | + // Reset to the client to execute requests immediately in the future. |
|
590 | + $this->client->setDefer(false); |
|
591 | + |
|
592 | + if ($result) { |
|
593 | + $this->setDriveFile($path, $result); |
|
594 | + } |
|
595 | + } |
|
596 | + } |
|
597 | + |
|
598 | + public function getMimeType($path) { |
|
599 | + $file = $this->getDriveFile($path); |
|
600 | + if ($file) { |
|
601 | + $mimetype = $file->getMimeType(); |
|
602 | + // Convert Google Doc mimetypes, choosing Open Document formats for download |
|
603 | + if ($mimetype === self::FOLDER) { |
|
604 | + return 'httpd/unix-directory'; |
|
605 | + } else if ($mimetype === self::DOCUMENT) { |
|
606 | + return 'application/vnd.oasis.opendocument.text'; |
|
607 | + } else if ($mimetype === self::SPREADSHEET) { |
|
608 | + return 'application/x-vnd.oasis.opendocument.spreadsheet'; |
|
609 | + } else if ($mimetype === self::DRAWING) { |
|
610 | + return 'image/jpeg'; |
|
611 | + } else if ($mimetype === self::PRESENTATION) { |
|
612 | + // Download as .odp is not available |
|
613 | + return 'application/pdf'; |
|
614 | + } else { |
|
615 | + // use extension-based detection, could be an encrypted file |
|
616 | + return parent::getMimeType($path); |
|
617 | + } |
|
618 | + } else { |
|
619 | + return false; |
|
620 | + } |
|
621 | + } |
|
622 | + |
|
623 | + public function free_space($path) { |
|
624 | + $about = $this->service->about->get(); |
|
625 | + return $about->getQuotaBytesTotal() - $about->getQuotaBytesUsed(); |
|
626 | + } |
|
627 | + |
|
628 | + public function touch($path, $mtime = null) { |
|
629 | + $file = $this->getDriveFile($path); |
|
630 | + $result = false; |
|
631 | + if ($file) { |
|
632 | + if (isset($mtime)) { |
|
633 | + // This is just RFC3339, but frustratingly, GDrive's API *requires* |
|
634 | + // the fractions portion be present, while no handy PHP constant |
|
635 | + // for RFC3339 or ISO8601 includes it. So we do it ourselves. |
|
636 | + $file->setModifiedDate(date('Y-m-d\TH:i:s.uP', $mtime)); |
|
637 | + $result = $this->service->files->patch($file->getId(), $file, array( |
|
638 | + 'setModifiedDate' => true, |
|
639 | + )); |
|
640 | + } else { |
|
641 | + $result = $this->service->files->touch($file->getId()); |
|
642 | + } |
|
643 | + } else { |
|
644 | + $parentFolder = $this->getDriveFile(dirname($path)); |
|
645 | + if ($parentFolder) { |
|
646 | + $file = new \Google_Service_Drive_DriveFile(); |
|
647 | + $file->setTitle(basename($path)); |
|
648 | + $parent = new \Google_Service_Drive_ParentReference(); |
|
649 | + $parent->setId($parentFolder->getId()); |
|
650 | + $file->setParents(array($parent)); |
|
651 | + $result = $this->service->files->insert($file); |
|
652 | + } |
|
653 | + } |
|
654 | + if ($result) { |
|
655 | + $this->setDriveFile($path, $result); |
|
656 | + } |
|
657 | + return (bool)$result; |
|
658 | + } |
|
659 | + |
|
660 | + public function test() { |
|
661 | + if ($this->free_space('')) { |
|
662 | + return true; |
|
663 | + } |
|
664 | + return false; |
|
665 | + } |
|
666 | + |
|
667 | + public function hasUpdated($path, $time) { |
|
668 | + $appConfig = \OC::$server->getAppConfig(); |
|
669 | + if ($this->is_file($path)) { |
|
670 | + return parent::hasUpdated($path, $time); |
|
671 | + } else { |
|
672 | + // Google Drive doesn't change modified times of folders when files inside are updated |
|
673 | + // Instead we use the Changes API to see if folders have been updated, and it's a pain |
|
674 | + $folder = $this->getDriveFile($path); |
|
675 | + if ($folder) { |
|
676 | + $result = false; |
|
677 | + $folderId = $folder->getId(); |
|
678 | + $startChangeId = $appConfig->getValue('files_external', $this->getId().'cId'); |
|
679 | + $params = array( |
|
680 | + 'includeDeleted' => true, |
|
681 | + 'includeSubscribed' => true, |
|
682 | + ); |
|
683 | + if (isset($startChangeId)) { |
|
684 | + $startChangeId = (int)$startChangeId; |
|
685 | + $largestChangeId = $startChangeId; |
|
686 | + $params['startChangeId'] = $startChangeId + 1; |
|
687 | + } else { |
|
688 | + $largestChangeId = 0; |
|
689 | + } |
|
690 | + $pageToken = true; |
|
691 | + while ($pageToken) { |
|
692 | + if ($pageToken !== true) { |
|
693 | + $params['pageToken'] = $pageToken; |
|
694 | + } |
|
695 | + $changes = $this->service->changes->listChanges($params); |
|
696 | + if ($largestChangeId === 0 || $largestChangeId === $startChangeId) { |
|
697 | + $largestChangeId = $changes->getLargestChangeId(); |
|
698 | + } |
|
699 | + if (isset($startChangeId)) { |
|
700 | + // Check if a file in this folder has been updated |
|
701 | + // There is no way to filter by folder at the API level... |
|
702 | + foreach ($changes->getItems() as $change) { |
|
703 | + $file = $change->getFile(); |
|
704 | + if ($file) { |
|
705 | + foreach ($file->getParents() as $parent) { |
|
706 | + if ($parent->getId() === $folderId) { |
|
707 | + $result = true; |
|
708 | + // Check if there are changes in different folders |
|
709 | + } else if ($change->getId() <= $largestChangeId) { |
|
710 | + // Decrement id so this change is fetched when called again |
|
711 | + $largestChangeId = $change->getId(); |
|
712 | + $largestChangeId--; |
|
713 | + } |
|
714 | + } |
|
715 | + } |
|
716 | + } |
|
717 | + $pageToken = $changes->getNextPageToken(); |
|
718 | + } else { |
|
719 | + // Assuming the initial scan just occurred and changes are negligible |
|
720 | + break; |
|
721 | + } |
|
722 | + } |
|
723 | + $appConfig->setValue('files_external', $this->getId().'cId', $largestChangeId); |
|
724 | + return $result; |
|
725 | + } |
|
726 | + } |
|
727 | + return false; |
|
728 | + } |
|
729 | + |
|
730 | + /** |
|
731 | + * check if curl is installed |
|
732 | + */ |
|
733 | + public static function checkDependencies() { |
|
734 | + return true; |
|
735 | + } |
|
736 | 736 | |
737 | 737 | } |
@@ -370,6 +370,7 @@ |
||
370 | 370 | |
371 | 371 | /** |
372 | 372 | * write back temporary files |
373 | + * @param string $path |
|
373 | 374 | */ |
374 | 375 | function writeBack($tmpFile, $path) { |
375 | 376 | $this->addFile($path, $tmpFile); |
@@ -36,355 +36,355 @@ |
||
36 | 36 | use Icewind\Streams\CallbackWrapper; |
37 | 37 | |
38 | 38 | class TAR extends Archive { |
39 | - const PLAIN = 0; |
|
40 | - const GZIP = 1; |
|
41 | - const BZIP = 2; |
|
39 | + const PLAIN = 0; |
|
40 | + const GZIP = 1; |
|
41 | + const BZIP = 2; |
|
42 | 42 | |
43 | - private $fileList; |
|
44 | - private $cachedHeaders; |
|
43 | + private $fileList; |
|
44 | + private $cachedHeaders; |
|
45 | 45 | |
46 | - /** |
|
47 | - * @var \Archive_Tar tar |
|
48 | - */ |
|
49 | - private $tar = null; |
|
50 | - private $path; |
|
46 | + /** |
|
47 | + * @var \Archive_Tar tar |
|
48 | + */ |
|
49 | + private $tar = null; |
|
50 | + private $path; |
|
51 | 51 | |
52 | - /** |
|
53 | - * @param string $source |
|
54 | - */ |
|
55 | - function __construct($source) { |
|
56 | - $types = array(null, 'gz', 'bz2'); |
|
57 | - $this->path = $source; |
|
58 | - $this->tar = new \Archive_Tar($source, $types[self::getTarType($source)]); |
|
59 | - } |
|
52 | + /** |
|
53 | + * @param string $source |
|
54 | + */ |
|
55 | + function __construct($source) { |
|
56 | + $types = array(null, 'gz', 'bz2'); |
|
57 | + $this->path = $source; |
|
58 | + $this->tar = new \Archive_Tar($source, $types[self::getTarType($source)]); |
|
59 | + } |
|
60 | 60 | |
61 | - /** |
|
62 | - * try to detect the type of tar compression |
|
63 | - * |
|
64 | - * @param string $file |
|
65 | - * @return integer |
|
66 | - */ |
|
67 | - static public function getTarType($file) { |
|
68 | - if (strpos($file, '.')) { |
|
69 | - $extension = substr($file, strrpos($file, '.')); |
|
70 | - switch ($extension) { |
|
71 | - case '.gz': |
|
72 | - case '.tgz': |
|
73 | - return self::GZIP; |
|
74 | - case '.bz': |
|
75 | - case '.bz2': |
|
76 | - return self::BZIP; |
|
77 | - case '.tar': |
|
78 | - return self::PLAIN; |
|
79 | - default: |
|
80 | - return self::PLAIN; |
|
81 | - } |
|
82 | - } else { |
|
83 | - return self::PLAIN; |
|
84 | - } |
|
85 | - } |
|
61 | + /** |
|
62 | + * try to detect the type of tar compression |
|
63 | + * |
|
64 | + * @param string $file |
|
65 | + * @return integer |
|
66 | + */ |
|
67 | + static public function getTarType($file) { |
|
68 | + if (strpos($file, '.')) { |
|
69 | + $extension = substr($file, strrpos($file, '.')); |
|
70 | + switch ($extension) { |
|
71 | + case '.gz': |
|
72 | + case '.tgz': |
|
73 | + return self::GZIP; |
|
74 | + case '.bz': |
|
75 | + case '.bz2': |
|
76 | + return self::BZIP; |
|
77 | + case '.tar': |
|
78 | + return self::PLAIN; |
|
79 | + default: |
|
80 | + return self::PLAIN; |
|
81 | + } |
|
82 | + } else { |
|
83 | + return self::PLAIN; |
|
84 | + } |
|
85 | + } |
|
86 | 86 | |
87 | - /** |
|
88 | - * add an empty folder to the archive |
|
89 | - * |
|
90 | - * @param string $path |
|
91 | - * @return bool |
|
92 | - */ |
|
93 | - function addFolder($path) { |
|
94 | - $tmpBase = \OC::$server->getTempManager()->getTemporaryFolder(); |
|
95 | - if (substr($path, -1, 1) != '/') { |
|
96 | - $path .= '/'; |
|
97 | - } |
|
98 | - if ($this->fileExists($path)) { |
|
99 | - return false; |
|
100 | - } |
|
101 | - $parts = explode('/', $path); |
|
102 | - $folder = $tmpBase; |
|
103 | - foreach ($parts as $part) { |
|
104 | - $folder .= '/' . $part; |
|
105 | - if (!is_dir($folder)) { |
|
106 | - mkdir($folder); |
|
107 | - } |
|
108 | - } |
|
109 | - $result = $this->tar->addModify(array($tmpBase . $path), '', $tmpBase); |
|
110 | - rmdir($tmpBase . $path); |
|
111 | - $this->fileList = false; |
|
112 | - $this->cachedHeaders = false; |
|
113 | - return $result; |
|
114 | - } |
|
87 | + /** |
|
88 | + * add an empty folder to the archive |
|
89 | + * |
|
90 | + * @param string $path |
|
91 | + * @return bool |
|
92 | + */ |
|
93 | + function addFolder($path) { |
|
94 | + $tmpBase = \OC::$server->getTempManager()->getTemporaryFolder(); |
|
95 | + if (substr($path, -1, 1) != '/') { |
|
96 | + $path .= '/'; |
|
97 | + } |
|
98 | + if ($this->fileExists($path)) { |
|
99 | + return false; |
|
100 | + } |
|
101 | + $parts = explode('/', $path); |
|
102 | + $folder = $tmpBase; |
|
103 | + foreach ($parts as $part) { |
|
104 | + $folder .= '/' . $part; |
|
105 | + if (!is_dir($folder)) { |
|
106 | + mkdir($folder); |
|
107 | + } |
|
108 | + } |
|
109 | + $result = $this->tar->addModify(array($tmpBase . $path), '', $tmpBase); |
|
110 | + rmdir($tmpBase . $path); |
|
111 | + $this->fileList = false; |
|
112 | + $this->cachedHeaders = false; |
|
113 | + return $result; |
|
114 | + } |
|
115 | 115 | |
116 | - /** |
|
117 | - * add a file to the archive |
|
118 | - * |
|
119 | - * @param string $path |
|
120 | - * @param string $source either a local file or string data |
|
121 | - * @return bool |
|
122 | - */ |
|
123 | - function addFile($path, $source = '') { |
|
124 | - if ($this->fileExists($path)) { |
|
125 | - $this->remove($path); |
|
126 | - } |
|
127 | - if ($source and $source[0] == '/' and file_exists($source)) { |
|
128 | - $source = file_get_contents($source); |
|
129 | - } |
|
130 | - $result = $this->tar->addString($path, $source); |
|
131 | - $this->fileList = false; |
|
132 | - $this->cachedHeaders = false; |
|
133 | - return $result; |
|
134 | - } |
|
116 | + /** |
|
117 | + * add a file to the archive |
|
118 | + * |
|
119 | + * @param string $path |
|
120 | + * @param string $source either a local file or string data |
|
121 | + * @return bool |
|
122 | + */ |
|
123 | + function addFile($path, $source = '') { |
|
124 | + if ($this->fileExists($path)) { |
|
125 | + $this->remove($path); |
|
126 | + } |
|
127 | + if ($source and $source[0] == '/' and file_exists($source)) { |
|
128 | + $source = file_get_contents($source); |
|
129 | + } |
|
130 | + $result = $this->tar->addString($path, $source); |
|
131 | + $this->fileList = false; |
|
132 | + $this->cachedHeaders = false; |
|
133 | + return $result; |
|
134 | + } |
|
135 | 135 | |
136 | - /** |
|
137 | - * rename a file or folder in the archive |
|
138 | - * |
|
139 | - * @param string $source |
|
140 | - * @param string $dest |
|
141 | - * @return bool |
|
142 | - */ |
|
143 | - function rename($source, $dest) { |
|
144 | - //no proper way to delete, rename entire archive, rename file and remake archive |
|
145 | - $tmp = \OCP\Files::tmpFolder(); |
|
146 | - $this->tar->extract($tmp); |
|
147 | - rename($tmp . $source, $tmp . $dest); |
|
148 | - $this->tar = null; |
|
149 | - unlink($this->path); |
|
150 | - $types = array(null, 'gz', 'bz'); |
|
151 | - $this->tar = new \Archive_Tar($this->path, $types[self::getTarType($this->path)]); |
|
152 | - $this->tar->createModify(array($tmp), '', $tmp . '/'); |
|
153 | - $this->fileList = false; |
|
154 | - $this->cachedHeaders = false; |
|
155 | - return true; |
|
156 | - } |
|
136 | + /** |
|
137 | + * rename a file or folder in the archive |
|
138 | + * |
|
139 | + * @param string $source |
|
140 | + * @param string $dest |
|
141 | + * @return bool |
|
142 | + */ |
|
143 | + function rename($source, $dest) { |
|
144 | + //no proper way to delete, rename entire archive, rename file and remake archive |
|
145 | + $tmp = \OCP\Files::tmpFolder(); |
|
146 | + $this->tar->extract($tmp); |
|
147 | + rename($tmp . $source, $tmp . $dest); |
|
148 | + $this->tar = null; |
|
149 | + unlink($this->path); |
|
150 | + $types = array(null, 'gz', 'bz'); |
|
151 | + $this->tar = new \Archive_Tar($this->path, $types[self::getTarType($this->path)]); |
|
152 | + $this->tar->createModify(array($tmp), '', $tmp . '/'); |
|
153 | + $this->fileList = false; |
|
154 | + $this->cachedHeaders = false; |
|
155 | + return true; |
|
156 | + } |
|
157 | 157 | |
158 | - /** |
|
159 | - * @param string $file |
|
160 | - */ |
|
161 | - private function getHeader($file) { |
|
162 | - if (!$this->cachedHeaders) { |
|
163 | - $this->cachedHeaders = $this->tar->listContent(); |
|
164 | - } |
|
165 | - foreach ($this->cachedHeaders as $header) { |
|
166 | - if ($file == $header['filename'] |
|
167 | - or $file . '/' == $header['filename'] |
|
168 | - or '/' . $file . '/' == $header['filename'] |
|
169 | - or '/' . $file == $header['filename'] |
|
170 | - ) { |
|
171 | - return $header; |
|
172 | - } |
|
173 | - } |
|
174 | - return null; |
|
175 | - } |
|
158 | + /** |
|
159 | + * @param string $file |
|
160 | + */ |
|
161 | + private function getHeader($file) { |
|
162 | + if (!$this->cachedHeaders) { |
|
163 | + $this->cachedHeaders = $this->tar->listContent(); |
|
164 | + } |
|
165 | + foreach ($this->cachedHeaders as $header) { |
|
166 | + if ($file == $header['filename'] |
|
167 | + or $file . '/' == $header['filename'] |
|
168 | + or '/' . $file . '/' == $header['filename'] |
|
169 | + or '/' . $file == $header['filename'] |
|
170 | + ) { |
|
171 | + return $header; |
|
172 | + } |
|
173 | + } |
|
174 | + return null; |
|
175 | + } |
|
176 | 176 | |
177 | - /** |
|
178 | - * get the uncompressed size of a file in the archive |
|
179 | - * |
|
180 | - * @param string $path |
|
181 | - * @return int |
|
182 | - */ |
|
183 | - function filesize($path) { |
|
184 | - $stat = $this->getHeader($path); |
|
185 | - return $stat['size']; |
|
186 | - } |
|
177 | + /** |
|
178 | + * get the uncompressed size of a file in the archive |
|
179 | + * |
|
180 | + * @param string $path |
|
181 | + * @return int |
|
182 | + */ |
|
183 | + function filesize($path) { |
|
184 | + $stat = $this->getHeader($path); |
|
185 | + return $stat['size']; |
|
186 | + } |
|
187 | 187 | |
188 | - /** |
|
189 | - * get the last modified time of a file in the archive |
|
190 | - * |
|
191 | - * @param string $path |
|
192 | - * @return int |
|
193 | - */ |
|
194 | - function mtime($path) { |
|
195 | - $stat = $this->getHeader($path); |
|
196 | - return $stat['mtime']; |
|
197 | - } |
|
188 | + /** |
|
189 | + * get the last modified time of a file in the archive |
|
190 | + * |
|
191 | + * @param string $path |
|
192 | + * @return int |
|
193 | + */ |
|
194 | + function mtime($path) { |
|
195 | + $stat = $this->getHeader($path); |
|
196 | + return $stat['mtime']; |
|
197 | + } |
|
198 | 198 | |
199 | - /** |
|
200 | - * get the files in a folder |
|
201 | - * |
|
202 | - * @param string $path |
|
203 | - * @return array |
|
204 | - */ |
|
205 | - function getFolder($path) { |
|
206 | - $files = $this->getFiles(); |
|
207 | - $folderContent = array(); |
|
208 | - $pathLength = strlen($path); |
|
209 | - foreach ($files as $file) { |
|
210 | - if ($file[0] == '/') { |
|
211 | - $file = substr($file, 1); |
|
212 | - } |
|
213 | - if (substr($file, 0, $pathLength) == $path and $file != $path) { |
|
214 | - $result = substr($file, $pathLength); |
|
215 | - if ($pos = strpos($result, '/')) { |
|
216 | - $result = substr($result, 0, $pos + 1); |
|
217 | - } |
|
218 | - if (array_search($result, $folderContent) === false) { |
|
219 | - $folderContent[] = $result; |
|
220 | - } |
|
221 | - } |
|
222 | - } |
|
223 | - return $folderContent; |
|
224 | - } |
|
199 | + /** |
|
200 | + * get the files in a folder |
|
201 | + * |
|
202 | + * @param string $path |
|
203 | + * @return array |
|
204 | + */ |
|
205 | + function getFolder($path) { |
|
206 | + $files = $this->getFiles(); |
|
207 | + $folderContent = array(); |
|
208 | + $pathLength = strlen($path); |
|
209 | + foreach ($files as $file) { |
|
210 | + if ($file[0] == '/') { |
|
211 | + $file = substr($file, 1); |
|
212 | + } |
|
213 | + if (substr($file, 0, $pathLength) == $path and $file != $path) { |
|
214 | + $result = substr($file, $pathLength); |
|
215 | + if ($pos = strpos($result, '/')) { |
|
216 | + $result = substr($result, 0, $pos + 1); |
|
217 | + } |
|
218 | + if (array_search($result, $folderContent) === false) { |
|
219 | + $folderContent[] = $result; |
|
220 | + } |
|
221 | + } |
|
222 | + } |
|
223 | + return $folderContent; |
|
224 | + } |
|
225 | 225 | |
226 | - /** |
|
227 | - * get all files in the archive |
|
228 | - * |
|
229 | - * @return array |
|
230 | - */ |
|
231 | - function getFiles() { |
|
232 | - if ($this->fileList) { |
|
233 | - return $this->fileList; |
|
234 | - } |
|
235 | - if (!$this->cachedHeaders) { |
|
236 | - $this->cachedHeaders = $this->tar->listContent(); |
|
237 | - } |
|
238 | - $files = array(); |
|
239 | - foreach ($this->cachedHeaders as $header) { |
|
240 | - $files[] = $header['filename']; |
|
241 | - } |
|
242 | - $this->fileList = $files; |
|
243 | - return $files; |
|
244 | - } |
|
226 | + /** |
|
227 | + * get all files in the archive |
|
228 | + * |
|
229 | + * @return array |
|
230 | + */ |
|
231 | + function getFiles() { |
|
232 | + if ($this->fileList) { |
|
233 | + return $this->fileList; |
|
234 | + } |
|
235 | + if (!$this->cachedHeaders) { |
|
236 | + $this->cachedHeaders = $this->tar->listContent(); |
|
237 | + } |
|
238 | + $files = array(); |
|
239 | + foreach ($this->cachedHeaders as $header) { |
|
240 | + $files[] = $header['filename']; |
|
241 | + } |
|
242 | + $this->fileList = $files; |
|
243 | + return $files; |
|
244 | + } |
|
245 | 245 | |
246 | - /** |
|
247 | - * get the content of a file |
|
248 | - * |
|
249 | - * @param string $path |
|
250 | - * @return string |
|
251 | - */ |
|
252 | - function getFile($path) { |
|
253 | - return $this->tar->extractInString($path); |
|
254 | - } |
|
246 | + /** |
|
247 | + * get the content of a file |
|
248 | + * |
|
249 | + * @param string $path |
|
250 | + * @return string |
|
251 | + */ |
|
252 | + function getFile($path) { |
|
253 | + return $this->tar->extractInString($path); |
|
254 | + } |
|
255 | 255 | |
256 | - /** |
|
257 | - * extract a single file from the archive |
|
258 | - * |
|
259 | - * @param string $path |
|
260 | - * @param string $dest |
|
261 | - * @return bool |
|
262 | - */ |
|
263 | - function extractFile($path, $dest) { |
|
264 | - $tmp = \OCP\Files::tmpFolder(); |
|
265 | - if (!$this->fileExists($path)) { |
|
266 | - return false; |
|
267 | - } |
|
268 | - if ($this->fileExists('/' . $path)) { |
|
269 | - $success = $this->tar->extractList(array('/' . $path), $tmp); |
|
270 | - } else { |
|
271 | - $success = $this->tar->extractList(array($path), $tmp); |
|
272 | - } |
|
273 | - if ($success) { |
|
274 | - rename($tmp . $path, $dest); |
|
275 | - } |
|
276 | - \OCP\Files::rmdirr($tmp); |
|
277 | - return $success; |
|
278 | - } |
|
256 | + /** |
|
257 | + * extract a single file from the archive |
|
258 | + * |
|
259 | + * @param string $path |
|
260 | + * @param string $dest |
|
261 | + * @return bool |
|
262 | + */ |
|
263 | + function extractFile($path, $dest) { |
|
264 | + $tmp = \OCP\Files::tmpFolder(); |
|
265 | + if (!$this->fileExists($path)) { |
|
266 | + return false; |
|
267 | + } |
|
268 | + if ($this->fileExists('/' . $path)) { |
|
269 | + $success = $this->tar->extractList(array('/' . $path), $tmp); |
|
270 | + } else { |
|
271 | + $success = $this->tar->extractList(array($path), $tmp); |
|
272 | + } |
|
273 | + if ($success) { |
|
274 | + rename($tmp . $path, $dest); |
|
275 | + } |
|
276 | + \OCP\Files::rmdirr($tmp); |
|
277 | + return $success; |
|
278 | + } |
|
279 | 279 | |
280 | - /** |
|
281 | - * extract the archive |
|
282 | - * |
|
283 | - * @param string $dest |
|
284 | - * @return bool |
|
285 | - */ |
|
286 | - function extract($dest) { |
|
287 | - return $this->tar->extract($dest); |
|
288 | - } |
|
280 | + /** |
|
281 | + * extract the archive |
|
282 | + * |
|
283 | + * @param string $dest |
|
284 | + * @return bool |
|
285 | + */ |
|
286 | + function extract($dest) { |
|
287 | + return $this->tar->extract($dest); |
|
288 | + } |
|
289 | 289 | |
290 | - /** |
|
291 | - * check if a file or folder exists in the archive |
|
292 | - * |
|
293 | - * @param string $path |
|
294 | - * @return bool |
|
295 | - */ |
|
296 | - function fileExists($path) { |
|
297 | - $files = $this->getFiles(); |
|
298 | - if ((array_search($path, $files) !== false) or (array_search($path . '/', $files) !== false)) { |
|
299 | - return true; |
|
300 | - } else { |
|
301 | - $folderPath = $path; |
|
302 | - if (substr($folderPath, -1, 1) != '/') { |
|
303 | - $folderPath .= '/'; |
|
304 | - } |
|
305 | - $pathLength = strlen($folderPath); |
|
306 | - foreach ($files as $file) { |
|
307 | - if (strlen($file) > $pathLength and substr($file, 0, $pathLength) == $folderPath) { |
|
308 | - return true; |
|
309 | - } |
|
310 | - } |
|
311 | - } |
|
312 | - if ($path[0] != '/') { //not all programs agree on the use of a leading / |
|
313 | - return $this->fileExists('/' . $path); |
|
314 | - } else { |
|
315 | - return false; |
|
316 | - } |
|
317 | - } |
|
290 | + /** |
|
291 | + * check if a file or folder exists in the archive |
|
292 | + * |
|
293 | + * @param string $path |
|
294 | + * @return bool |
|
295 | + */ |
|
296 | + function fileExists($path) { |
|
297 | + $files = $this->getFiles(); |
|
298 | + if ((array_search($path, $files) !== false) or (array_search($path . '/', $files) !== false)) { |
|
299 | + return true; |
|
300 | + } else { |
|
301 | + $folderPath = $path; |
|
302 | + if (substr($folderPath, -1, 1) != '/') { |
|
303 | + $folderPath .= '/'; |
|
304 | + } |
|
305 | + $pathLength = strlen($folderPath); |
|
306 | + foreach ($files as $file) { |
|
307 | + if (strlen($file) > $pathLength and substr($file, 0, $pathLength) == $folderPath) { |
|
308 | + return true; |
|
309 | + } |
|
310 | + } |
|
311 | + } |
|
312 | + if ($path[0] != '/') { //not all programs agree on the use of a leading / |
|
313 | + return $this->fileExists('/' . $path); |
|
314 | + } else { |
|
315 | + return false; |
|
316 | + } |
|
317 | + } |
|
318 | 318 | |
319 | - /** |
|
320 | - * remove a file or folder from the archive |
|
321 | - * |
|
322 | - * @param string $path |
|
323 | - * @return bool |
|
324 | - */ |
|
325 | - function remove($path) { |
|
326 | - if (!$this->fileExists($path)) { |
|
327 | - return false; |
|
328 | - } |
|
329 | - $this->fileList = false; |
|
330 | - $this->cachedHeaders = false; |
|
331 | - //no proper way to delete, extract entire archive, delete file and remake archive |
|
332 | - $tmp = \OCP\Files::tmpFolder(); |
|
333 | - $this->tar->extract($tmp); |
|
334 | - \OCP\Files::rmdirr($tmp . $path); |
|
335 | - $this->tar = null; |
|
336 | - unlink($this->path); |
|
337 | - $this->reopen(); |
|
338 | - $this->tar->createModify(array($tmp), '', $tmp); |
|
339 | - return true; |
|
340 | - } |
|
319 | + /** |
|
320 | + * remove a file or folder from the archive |
|
321 | + * |
|
322 | + * @param string $path |
|
323 | + * @return bool |
|
324 | + */ |
|
325 | + function remove($path) { |
|
326 | + if (!$this->fileExists($path)) { |
|
327 | + return false; |
|
328 | + } |
|
329 | + $this->fileList = false; |
|
330 | + $this->cachedHeaders = false; |
|
331 | + //no proper way to delete, extract entire archive, delete file and remake archive |
|
332 | + $tmp = \OCP\Files::tmpFolder(); |
|
333 | + $this->tar->extract($tmp); |
|
334 | + \OCP\Files::rmdirr($tmp . $path); |
|
335 | + $this->tar = null; |
|
336 | + unlink($this->path); |
|
337 | + $this->reopen(); |
|
338 | + $this->tar->createModify(array($tmp), '', $tmp); |
|
339 | + return true; |
|
340 | + } |
|
341 | 341 | |
342 | - /** |
|
343 | - * get a file handler |
|
344 | - * |
|
345 | - * @param string $path |
|
346 | - * @param string $mode |
|
347 | - * @return resource |
|
348 | - */ |
|
349 | - function getStream($path, $mode) { |
|
350 | - if (strrpos($path, '.') !== false) { |
|
351 | - $ext = substr($path, strrpos($path, '.')); |
|
352 | - } else { |
|
353 | - $ext = ''; |
|
354 | - } |
|
355 | - $tmpFile = \OCP\Files::tmpFile($ext); |
|
356 | - if ($this->fileExists($path)) { |
|
357 | - $this->extractFile($path, $tmpFile); |
|
358 | - } elseif ($mode == 'r' or $mode == 'rb') { |
|
359 | - return false; |
|
360 | - } |
|
361 | - if ($mode == 'r' or $mode == 'rb') { |
|
362 | - return fopen($tmpFile, $mode); |
|
363 | - } else { |
|
364 | - $handle = fopen($tmpFile, $mode); |
|
365 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
366 | - $this->writeBack($tmpFile, $path); |
|
367 | - }); |
|
368 | - } |
|
369 | - } |
|
342 | + /** |
|
343 | + * get a file handler |
|
344 | + * |
|
345 | + * @param string $path |
|
346 | + * @param string $mode |
|
347 | + * @return resource |
|
348 | + */ |
|
349 | + function getStream($path, $mode) { |
|
350 | + if (strrpos($path, '.') !== false) { |
|
351 | + $ext = substr($path, strrpos($path, '.')); |
|
352 | + } else { |
|
353 | + $ext = ''; |
|
354 | + } |
|
355 | + $tmpFile = \OCP\Files::tmpFile($ext); |
|
356 | + if ($this->fileExists($path)) { |
|
357 | + $this->extractFile($path, $tmpFile); |
|
358 | + } elseif ($mode == 'r' or $mode == 'rb') { |
|
359 | + return false; |
|
360 | + } |
|
361 | + if ($mode == 'r' or $mode == 'rb') { |
|
362 | + return fopen($tmpFile, $mode); |
|
363 | + } else { |
|
364 | + $handle = fopen($tmpFile, $mode); |
|
365 | + return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
366 | + $this->writeBack($tmpFile, $path); |
|
367 | + }); |
|
368 | + } |
|
369 | + } |
|
370 | 370 | |
371 | - /** |
|
372 | - * write back temporary files |
|
373 | - */ |
|
374 | - function writeBack($tmpFile, $path) { |
|
375 | - $this->addFile($path, $tmpFile); |
|
376 | - unlink($tmpFile); |
|
377 | - } |
|
371 | + /** |
|
372 | + * write back temporary files |
|
373 | + */ |
|
374 | + function writeBack($tmpFile, $path) { |
|
375 | + $this->addFile($path, $tmpFile); |
|
376 | + unlink($tmpFile); |
|
377 | + } |
|
378 | 378 | |
379 | - /** |
|
380 | - * reopen the archive to ensure everything is written |
|
381 | - */ |
|
382 | - private function reopen() { |
|
383 | - if ($this->tar) { |
|
384 | - $this->tar->_close(); |
|
385 | - $this->tar = null; |
|
386 | - } |
|
387 | - $types = array(null, 'gz', 'bz'); |
|
388 | - $this->tar = new \Archive_Tar($this->path, $types[self::getTarType($this->path)]); |
|
389 | - } |
|
379 | + /** |
|
380 | + * reopen the archive to ensure everything is written |
|
381 | + */ |
|
382 | + private function reopen() { |
|
383 | + if ($this->tar) { |
|
384 | + $this->tar->_close(); |
|
385 | + $this->tar = null; |
|
386 | + } |
|
387 | + $types = array(null, 'gz', 'bz'); |
|
388 | + $this->tar = new \Archive_Tar($this->path, $types[self::getTarType($this->path)]); |
|
389 | + } |
|
390 | 390 | } |
@@ -101,13 +101,13 @@ discard block |
||
101 | 101 | $parts = explode('/', $path); |
102 | 102 | $folder = $tmpBase; |
103 | 103 | foreach ($parts as $part) { |
104 | - $folder .= '/' . $part; |
|
104 | + $folder .= '/'.$part; |
|
105 | 105 | if (!is_dir($folder)) { |
106 | 106 | mkdir($folder); |
107 | 107 | } |
108 | 108 | } |
109 | - $result = $this->tar->addModify(array($tmpBase . $path), '', $tmpBase); |
|
110 | - rmdir($tmpBase . $path); |
|
109 | + $result = $this->tar->addModify(array($tmpBase.$path), '', $tmpBase); |
|
110 | + rmdir($tmpBase.$path); |
|
111 | 111 | $this->fileList = false; |
112 | 112 | $this->cachedHeaders = false; |
113 | 113 | return $result; |
@@ -144,12 +144,12 @@ discard block |
||
144 | 144 | //no proper way to delete, rename entire archive, rename file and remake archive |
145 | 145 | $tmp = \OCP\Files::tmpFolder(); |
146 | 146 | $this->tar->extract($tmp); |
147 | - rename($tmp . $source, $tmp . $dest); |
|
147 | + rename($tmp.$source, $tmp.$dest); |
|
148 | 148 | $this->tar = null; |
149 | 149 | unlink($this->path); |
150 | 150 | $types = array(null, 'gz', 'bz'); |
151 | 151 | $this->tar = new \Archive_Tar($this->path, $types[self::getTarType($this->path)]); |
152 | - $this->tar->createModify(array($tmp), '', $tmp . '/'); |
|
152 | + $this->tar->createModify(array($tmp), '', $tmp.'/'); |
|
153 | 153 | $this->fileList = false; |
154 | 154 | $this->cachedHeaders = false; |
155 | 155 | return true; |
@@ -164,9 +164,9 @@ discard block |
||
164 | 164 | } |
165 | 165 | foreach ($this->cachedHeaders as $header) { |
166 | 166 | if ($file == $header['filename'] |
167 | - or $file . '/' == $header['filename'] |
|
168 | - or '/' . $file . '/' == $header['filename'] |
|
169 | - or '/' . $file == $header['filename'] |
|
167 | + or $file.'/' == $header['filename'] |
|
168 | + or '/'.$file.'/' == $header['filename'] |
|
169 | + or '/'.$file == $header['filename'] |
|
170 | 170 | ) { |
171 | 171 | return $header; |
172 | 172 | } |
@@ -265,13 +265,13 @@ discard block |
||
265 | 265 | if (!$this->fileExists($path)) { |
266 | 266 | return false; |
267 | 267 | } |
268 | - if ($this->fileExists('/' . $path)) { |
|
269 | - $success = $this->tar->extractList(array('/' . $path), $tmp); |
|
268 | + if ($this->fileExists('/'.$path)) { |
|
269 | + $success = $this->tar->extractList(array('/'.$path), $tmp); |
|
270 | 270 | } else { |
271 | 271 | $success = $this->tar->extractList(array($path), $tmp); |
272 | 272 | } |
273 | 273 | if ($success) { |
274 | - rename($tmp . $path, $dest); |
|
274 | + rename($tmp.$path, $dest); |
|
275 | 275 | } |
276 | 276 | \OCP\Files::rmdirr($tmp); |
277 | 277 | return $success; |
@@ -295,7 +295,7 @@ discard block |
||
295 | 295 | */ |
296 | 296 | function fileExists($path) { |
297 | 297 | $files = $this->getFiles(); |
298 | - if ((array_search($path, $files) !== false) or (array_search($path . '/', $files) !== false)) { |
|
298 | + if ((array_search($path, $files) !== false) or (array_search($path.'/', $files) !== false)) { |
|
299 | 299 | return true; |
300 | 300 | } else { |
301 | 301 | $folderPath = $path; |
@@ -310,7 +310,7 @@ discard block |
||
310 | 310 | } |
311 | 311 | } |
312 | 312 | if ($path[0] != '/') { //not all programs agree on the use of a leading / |
313 | - return $this->fileExists('/' . $path); |
|
313 | + return $this->fileExists('/'.$path); |
|
314 | 314 | } else { |
315 | 315 | return false; |
316 | 316 | } |
@@ -331,7 +331,7 @@ discard block |
||
331 | 331 | //no proper way to delete, extract entire archive, delete file and remake archive |
332 | 332 | $tmp = \OCP\Files::tmpFolder(); |
333 | 333 | $this->tar->extract($tmp); |
334 | - \OCP\Files::rmdirr($tmp . $path); |
|
334 | + \OCP\Files::rmdirr($tmp.$path); |
|
335 | 335 | $this->tar = null; |
336 | 336 | unlink($this->path); |
337 | 337 | $this->reopen(); |
@@ -362,7 +362,7 @@ discard block |
||
362 | 362 | return fopen($tmpFile, $mode); |
363 | 363 | } else { |
364 | 364 | $handle = fopen($tmpFile, $mode); |
365 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
365 | + return CallbackWrapper::wrap($handle, null, null, function() use ($path, $tmpFile) { |
|
366 | 366 | $this->writeBack($tmpFile, $path); |
367 | 367 | }); |
368 | 368 | } |
@@ -162,6 +162,9 @@ discard block |
||
162 | 162 | return true; |
163 | 163 | } |
164 | 164 | |
165 | + /** |
|
166 | + * @param string $path |
|
167 | + */ |
|
165 | 168 | private function rmObjects($path) { |
166 | 169 | $children = $this->getCache()->getFolderContents($path); |
167 | 170 | foreach ($children as $child) { |
@@ -364,6 +367,9 @@ discard block |
||
364 | 367 | return true; |
365 | 368 | } |
366 | 369 | |
370 | + /** |
|
371 | + * @param string $path |
|
372 | + */ |
|
367 | 373 | public function writeBack($tmpFile, $path) { |
368 | 374 | $stat = $this->stat($path); |
369 | 375 | if (empty($stat)) { |
@@ -31,374 +31,374 @@ |
||
31 | 31 | use OCP\Files\ObjectStore\IObjectStore; |
32 | 32 | |
33 | 33 | class ObjectStoreStorage extends \OC\Files\Storage\Common { |
34 | - /** |
|
35 | - * @var \OCP\Files\ObjectStore\IObjectStore $objectStore |
|
36 | - */ |
|
37 | - protected $objectStore; |
|
38 | - /** |
|
39 | - * @var string $id |
|
40 | - */ |
|
41 | - protected $id; |
|
42 | - /** |
|
43 | - * @var \OC\User\User $user |
|
44 | - */ |
|
45 | - protected $user; |
|
46 | - |
|
47 | - private $objectPrefix = 'urn:oid:'; |
|
48 | - |
|
49 | - public function __construct($params) { |
|
50 | - if (isset($params['objectstore']) && $params['objectstore'] instanceof IObjectStore) { |
|
51 | - $this->objectStore = $params['objectstore']; |
|
52 | - } else { |
|
53 | - throw new \Exception('missing IObjectStore instance'); |
|
54 | - } |
|
55 | - if (isset($params['storageid'])) { |
|
56 | - $this->id = 'object::store:' . $params['storageid']; |
|
57 | - } else { |
|
58 | - $this->id = 'object::store:' . $this->objectStore->getStorageId(); |
|
59 | - } |
|
60 | - if (isset($params['objectPrefix'])) { |
|
61 | - $this->objectPrefix = $params['objectPrefix']; |
|
62 | - } |
|
63 | - //initialize cache with root directory in cache |
|
64 | - if (!$this->is_dir('/')) { |
|
65 | - $this->mkdir('/'); |
|
66 | - } |
|
67 | - } |
|
68 | - |
|
69 | - public function mkdir($path) { |
|
70 | - $path = $this->normalizePath($path); |
|
71 | - |
|
72 | - if ($this->file_exists($path)) { |
|
73 | - return false; |
|
74 | - } |
|
75 | - |
|
76 | - $mTime = time(); |
|
77 | - $data = [ |
|
78 | - 'mimetype' => 'httpd/unix-directory', |
|
79 | - 'size' => 0, |
|
80 | - 'mtime' => $mTime, |
|
81 | - 'storage_mtime' => $mTime, |
|
82 | - 'permissions' => \OCP\Constants::PERMISSION_ALL, |
|
83 | - ]; |
|
84 | - if ($path === '') { |
|
85 | - //create root on the fly |
|
86 | - $data['etag'] = $this->getETag(''); |
|
87 | - $this->getCache()->put('', $data); |
|
88 | - return true; |
|
89 | - } else { |
|
90 | - // if parent does not exist, create it |
|
91 | - $parent = $this->normalizePath(dirname($path)); |
|
92 | - $parentType = $this->filetype($parent); |
|
93 | - if ($parentType === false) { |
|
94 | - if (!$this->mkdir($parent)) { |
|
95 | - // something went wrong |
|
96 | - return false; |
|
97 | - } |
|
98 | - } else if ($parentType === 'file') { |
|
99 | - // parent is a file |
|
100 | - return false; |
|
101 | - } |
|
102 | - // finally create the new dir |
|
103 | - $mTime = time(); // update mtime |
|
104 | - $data['mtime'] = $mTime; |
|
105 | - $data['storage_mtime'] = $mTime; |
|
106 | - $data['etag'] = $this->getETag($path); |
|
107 | - $this->getCache()->put($path, $data); |
|
108 | - return true; |
|
109 | - } |
|
110 | - } |
|
111 | - |
|
112 | - /** |
|
113 | - * @param string $path |
|
114 | - * @return string |
|
115 | - */ |
|
116 | - private function normalizePath($path) { |
|
117 | - $path = trim($path, '/'); |
|
118 | - //FIXME why do we sometimes get a path like 'files//username'? |
|
119 | - $path = str_replace('//', '/', $path); |
|
120 | - |
|
121 | - // dirname('/folder') returns '.' but internally (in the cache) we store the root as '' |
|
122 | - if (!$path || $path === '.') { |
|
123 | - $path = ''; |
|
124 | - } |
|
125 | - |
|
126 | - return $path; |
|
127 | - } |
|
128 | - |
|
129 | - /** |
|
130 | - * Object Stores use a NoopScanner because metadata is directly stored in |
|
131 | - * the file cache and cannot really scan the filesystem. The storage passed in is not used anywhere. |
|
132 | - * |
|
133 | - * @param string $path |
|
134 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner |
|
135 | - * @return \OC\Files\ObjectStore\NoopScanner |
|
136 | - */ |
|
137 | - public function getScanner($path = '', $storage = null) { |
|
138 | - if (!$storage) { |
|
139 | - $storage = $this; |
|
140 | - } |
|
141 | - if (!isset($this->scanner)) { |
|
142 | - $this->scanner = new NoopScanner($storage); |
|
143 | - } |
|
144 | - return $this->scanner; |
|
145 | - } |
|
146 | - |
|
147 | - public function getId() { |
|
148 | - return $this->id; |
|
149 | - } |
|
150 | - |
|
151 | - public function rmdir($path) { |
|
152 | - $path = $this->normalizePath($path); |
|
153 | - |
|
154 | - if (!$this->is_dir($path)) { |
|
155 | - return false; |
|
156 | - } |
|
157 | - |
|
158 | - $this->rmObjects($path); |
|
159 | - |
|
160 | - $this->getCache()->remove($path); |
|
161 | - |
|
162 | - return true; |
|
163 | - } |
|
164 | - |
|
165 | - private function rmObjects($path) { |
|
166 | - $children = $this->getCache()->getFolderContents($path); |
|
167 | - foreach ($children as $child) { |
|
168 | - if ($child['mimetype'] === 'httpd/unix-directory') { |
|
169 | - $this->rmObjects($child['path']); |
|
170 | - } else { |
|
171 | - $this->unlink($child['path']); |
|
172 | - } |
|
173 | - } |
|
174 | - } |
|
175 | - |
|
176 | - public function unlink($path) { |
|
177 | - $path = $this->normalizePath($path); |
|
178 | - $stat = $this->stat($path); |
|
179 | - |
|
180 | - if ($stat && isset($stat['fileid'])) { |
|
181 | - if ($stat['mimetype'] === 'httpd/unix-directory') { |
|
182 | - return $this->rmdir($path); |
|
183 | - } |
|
184 | - try { |
|
185 | - $this->objectStore->deleteObject($this->getURN($stat['fileid'])); |
|
186 | - } catch (\Exception $ex) { |
|
187 | - if ($ex->getCode() !== 404) { |
|
188 | - \OCP\Util::writeLog('objectstore', 'Could not delete object: ' . $ex->getMessage(), \OCP\Util::ERROR); |
|
189 | - return false; |
|
190 | - } else { |
|
191 | - //removing from cache is ok as it does not exist in the objectstore anyway |
|
192 | - } |
|
193 | - } |
|
194 | - $this->getCache()->remove($path); |
|
195 | - return true; |
|
196 | - } |
|
197 | - return false; |
|
198 | - } |
|
199 | - |
|
200 | - public function stat($path) { |
|
201 | - $path = $this->normalizePath($path); |
|
202 | - $cacheEntry = $this->getCache()->get($path); |
|
203 | - if ($cacheEntry instanceof CacheEntry) { |
|
204 | - return $cacheEntry->getData(); |
|
205 | - } else { |
|
206 | - return false; |
|
207 | - } |
|
208 | - } |
|
209 | - |
|
210 | - /** |
|
211 | - * Override this method if you need a different unique resource identifier for your object storage implementation. |
|
212 | - * The default implementations just appends the fileId to 'urn:oid:'. Make sure the URN is unique over all users. |
|
213 | - * You may need a mapping table to store your URN if it cannot be generated from the fileid. |
|
214 | - * |
|
215 | - * @param int $fileId the fileid |
|
216 | - * @return null|string the unified resource name used to identify the object |
|
217 | - */ |
|
218 | - protected function getURN($fileId) { |
|
219 | - if (is_numeric($fileId)) { |
|
220 | - return $this->objectPrefix . $fileId; |
|
221 | - } |
|
222 | - return null; |
|
223 | - } |
|
224 | - |
|
225 | - public function opendir($path) { |
|
226 | - $path = $this->normalizePath($path); |
|
227 | - |
|
228 | - try { |
|
229 | - $files = array(); |
|
230 | - $folderContents = $this->getCache()->getFolderContents($path); |
|
231 | - foreach ($folderContents as $file) { |
|
232 | - $files[] = $file['name']; |
|
233 | - } |
|
234 | - |
|
235 | - return IteratorDirectory::wrap($files); |
|
236 | - } catch (\Exception $e) { |
|
237 | - \OCP\Util::writeLog('objectstore', $e->getMessage(), \OCP\Util::ERROR); |
|
238 | - return false; |
|
239 | - } |
|
240 | - } |
|
241 | - |
|
242 | - public function filetype($path) { |
|
243 | - $path = $this->normalizePath($path); |
|
244 | - $stat = $this->stat($path); |
|
245 | - if ($stat) { |
|
246 | - if ($stat['mimetype'] === 'httpd/unix-directory') { |
|
247 | - return 'dir'; |
|
248 | - } |
|
249 | - return 'file'; |
|
250 | - } else { |
|
251 | - return false; |
|
252 | - } |
|
253 | - } |
|
254 | - |
|
255 | - public function fopen($path, $mode) { |
|
256 | - $path = $this->normalizePath($path); |
|
257 | - |
|
258 | - switch ($mode) { |
|
259 | - case 'r': |
|
260 | - case 'rb': |
|
261 | - $stat = $this->stat($path); |
|
262 | - if (is_array($stat)) { |
|
263 | - try { |
|
264 | - return $this->objectStore->readObject($this->getURN($stat['fileid'])); |
|
265 | - } catch (\Exception $ex) { |
|
266 | - \OCP\Util::writeLog('objectstore', 'Could not get object: ' . $ex->getMessage(), \OCP\Util::ERROR); |
|
267 | - return false; |
|
268 | - } |
|
269 | - } else { |
|
270 | - return false; |
|
271 | - } |
|
272 | - case 'w': |
|
273 | - case 'wb': |
|
274 | - case 'a': |
|
275 | - case 'ab': |
|
276 | - case 'r+': |
|
277 | - case 'w+': |
|
278 | - case 'wb+': |
|
279 | - case 'a+': |
|
280 | - case 'x': |
|
281 | - case 'x+': |
|
282 | - case 'c': |
|
283 | - case 'c+': |
|
284 | - if (strrpos($path, '.') !== false) { |
|
285 | - $ext = substr($path, strrpos($path, '.')); |
|
286 | - } else { |
|
287 | - $ext = ''; |
|
288 | - } |
|
289 | - $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext); |
|
290 | - if ($this->file_exists($path)) { |
|
291 | - $source = $this->fopen($path, 'r'); |
|
292 | - file_put_contents($tmpFile, $source); |
|
293 | - } |
|
294 | - $handle = fopen($tmpFile, $mode); |
|
295 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
296 | - $this->writeBack($tmpFile, $path); |
|
297 | - }); |
|
298 | - } |
|
299 | - return false; |
|
300 | - } |
|
301 | - |
|
302 | - public function file_exists($path) { |
|
303 | - $path = $this->normalizePath($path); |
|
304 | - return (bool)$this->stat($path); |
|
305 | - } |
|
306 | - |
|
307 | - public function rename($source, $target) { |
|
308 | - $source = $this->normalizePath($source); |
|
309 | - $target = $this->normalizePath($target); |
|
310 | - $this->remove($target); |
|
311 | - $this->getCache()->move($source, $target); |
|
312 | - $this->touch(dirname($target)); |
|
313 | - return true; |
|
314 | - } |
|
315 | - |
|
316 | - public function getMimeType($path) { |
|
317 | - $path = $this->normalizePath($path); |
|
318 | - $stat = $this->stat($path); |
|
319 | - if (is_array($stat)) { |
|
320 | - return $stat['mimetype']; |
|
321 | - } else { |
|
322 | - return false; |
|
323 | - } |
|
324 | - } |
|
325 | - |
|
326 | - public function touch($path, $mtime = null) { |
|
327 | - if (is_null($mtime)) { |
|
328 | - $mtime = time(); |
|
329 | - } |
|
330 | - |
|
331 | - $path = $this->normalizePath($path); |
|
332 | - $dirName = dirname($path); |
|
333 | - $parentExists = $this->is_dir($dirName); |
|
334 | - if (!$parentExists) { |
|
335 | - return false; |
|
336 | - } |
|
337 | - |
|
338 | - $stat = $this->stat($path); |
|
339 | - if (is_array($stat)) { |
|
340 | - // update existing mtime in db |
|
341 | - $stat['mtime'] = $mtime; |
|
342 | - $this->getCache()->update($stat['fileid'], $stat); |
|
343 | - } else { |
|
344 | - $mimeType = \OC::$server->getMimeTypeDetector()->detectPath($path); |
|
345 | - // create new file |
|
346 | - $stat = array( |
|
347 | - 'etag' => $this->getETag($path), |
|
348 | - 'mimetype' => $mimeType, |
|
349 | - 'size' => 0, |
|
350 | - 'mtime' => $mtime, |
|
351 | - 'storage_mtime' => $mtime, |
|
352 | - 'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE, |
|
353 | - ); |
|
354 | - $fileId = $this->getCache()->put($path, $stat); |
|
355 | - try { |
|
356 | - //read an empty file from memory |
|
357 | - $this->objectStore->writeObject($this->getURN($fileId), fopen('php://memory', 'r')); |
|
358 | - } catch (\Exception $ex) { |
|
359 | - $this->getCache()->remove($path); |
|
360 | - \OCP\Util::writeLog('objectstore', 'Could not create object: ' . $ex->getMessage(), \OCP\Util::ERROR); |
|
361 | - return false; |
|
362 | - } |
|
363 | - } |
|
364 | - return true; |
|
365 | - } |
|
366 | - |
|
367 | - public function writeBack($tmpFile, $path) { |
|
368 | - $stat = $this->stat($path); |
|
369 | - if (empty($stat)) { |
|
370 | - // create new file |
|
371 | - $stat = array( |
|
372 | - 'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE, |
|
373 | - ); |
|
374 | - } |
|
375 | - // update stat with new data |
|
376 | - $mTime = time(); |
|
377 | - $stat['size'] = filesize($tmpFile); |
|
378 | - $stat['mtime'] = $mTime; |
|
379 | - $stat['storage_mtime'] = $mTime; |
|
380 | - $stat['mimetype'] = \OC::$server->getMimeTypeDetector()->detect($tmpFile); |
|
381 | - $stat['etag'] = $this->getETag($path); |
|
382 | - |
|
383 | - $fileId = $this->getCache()->put($path, $stat); |
|
384 | - try { |
|
385 | - //upload to object storage |
|
386 | - $this->objectStore->writeObject($this->getURN($fileId), fopen($tmpFile, 'r')); |
|
387 | - } catch (\Exception $ex) { |
|
388 | - $this->getCache()->remove($path); |
|
389 | - \OCP\Util::writeLog('objectstore', 'Could not create object: ' . $ex->getMessage(), \OCP\Util::ERROR); |
|
390 | - throw $ex; // make this bubble up |
|
391 | - } |
|
392 | - } |
|
393 | - |
|
394 | - /** |
|
395 | - * external changes are not supported, exclusive access to the object storage is assumed |
|
396 | - * |
|
397 | - * @param string $path |
|
398 | - * @param int $time |
|
399 | - * @return false |
|
400 | - */ |
|
401 | - public function hasUpdated($path, $time) { |
|
402 | - return false; |
|
403 | - } |
|
34 | + /** |
|
35 | + * @var \OCP\Files\ObjectStore\IObjectStore $objectStore |
|
36 | + */ |
|
37 | + protected $objectStore; |
|
38 | + /** |
|
39 | + * @var string $id |
|
40 | + */ |
|
41 | + protected $id; |
|
42 | + /** |
|
43 | + * @var \OC\User\User $user |
|
44 | + */ |
|
45 | + protected $user; |
|
46 | + |
|
47 | + private $objectPrefix = 'urn:oid:'; |
|
48 | + |
|
49 | + public function __construct($params) { |
|
50 | + if (isset($params['objectstore']) && $params['objectstore'] instanceof IObjectStore) { |
|
51 | + $this->objectStore = $params['objectstore']; |
|
52 | + } else { |
|
53 | + throw new \Exception('missing IObjectStore instance'); |
|
54 | + } |
|
55 | + if (isset($params['storageid'])) { |
|
56 | + $this->id = 'object::store:' . $params['storageid']; |
|
57 | + } else { |
|
58 | + $this->id = 'object::store:' . $this->objectStore->getStorageId(); |
|
59 | + } |
|
60 | + if (isset($params['objectPrefix'])) { |
|
61 | + $this->objectPrefix = $params['objectPrefix']; |
|
62 | + } |
|
63 | + //initialize cache with root directory in cache |
|
64 | + if (!$this->is_dir('/')) { |
|
65 | + $this->mkdir('/'); |
|
66 | + } |
|
67 | + } |
|
68 | + |
|
69 | + public function mkdir($path) { |
|
70 | + $path = $this->normalizePath($path); |
|
71 | + |
|
72 | + if ($this->file_exists($path)) { |
|
73 | + return false; |
|
74 | + } |
|
75 | + |
|
76 | + $mTime = time(); |
|
77 | + $data = [ |
|
78 | + 'mimetype' => 'httpd/unix-directory', |
|
79 | + 'size' => 0, |
|
80 | + 'mtime' => $mTime, |
|
81 | + 'storage_mtime' => $mTime, |
|
82 | + 'permissions' => \OCP\Constants::PERMISSION_ALL, |
|
83 | + ]; |
|
84 | + if ($path === '') { |
|
85 | + //create root on the fly |
|
86 | + $data['etag'] = $this->getETag(''); |
|
87 | + $this->getCache()->put('', $data); |
|
88 | + return true; |
|
89 | + } else { |
|
90 | + // if parent does not exist, create it |
|
91 | + $parent = $this->normalizePath(dirname($path)); |
|
92 | + $parentType = $this->filetype($parent); |
|
93 | + if ($parentType === false) { |
|
94 | + if (!$this->mkdir($parent)) { |
|
95 | + // something went wrong |
|
96 | + return false; |
|
97 | + } |
|
98 | + } else if ($parentType === 'file') { |
|
99 | + // parent is a file |
|
100 | + return false; |
|
101 | + } |
|
102 | + // finally create the new dir |
|
103 | + $mTime = time(); // update mtime |
|
104 | + $data['mtime'] = $mTime; |
|
105 | + $data['storage_mtime'] = $mTime; |
|
106 | + $data['etag'] = $this->getETag($path); |
|
107 | + $this->getCache()->put($path, $data); |
|
108 | + return true; |
|
109 | + } |
|
110 | + } |
|
111 | + |
|
112 | + /** |
|
113 | + * @param string $path |
|
114 | + * @return string |
|
115 | + */ |
|
116 | + private function normalizePath($path) { |
|
117 | + $path = trim($path, '/'); |
|
118 | + //FIXME why do we sometimes get a path like 'files//username'? |
|
119 | + $path = str_replace('//', '/', $path); |
|
120 | + |
|
121 | + // dirname('/folder') returns '.' but internally (in the cache) we store the root as '' |
|
122 | + if (!$path || $path === '.') { |
|
123 | + $path = ''; |
|
124 | + } |
|
125 | + |
|
126 | + return $path; |
|
127 | + } |
|
128 | + |
|
129 | + /** |
|
130 | + * Object Stores use a NoopScanner because metadata is directly stored in |
|
131 | + * the file cache and cannot really scan the filesystem. The storage passed in is not used anywhere. |
|
132 | + * |
|
133 | + * @param string $path |
|
134 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner |
|
135 | + * @return \OC\Files\ObjectStore\NoopScanner |
|
136 | + */ |
|
137 | + public function getScanner($path = '', $storage = null) { |
|
138 | + if (!$storage) { |
|
139 | + $storage = $this; |
|
140 | + } |
|
141 | + if (!isset($this->scanner)) { |
|
142 | + $this->scanner = new NoopScanner($storage); |
|
143 | + } |
|
144 | + return $this->scanner; |
|
145 | + } |
|
146 | + |
|
147 | + public function getId() { |
|
148 | + return $this->id; |
|
149 | + } |
|
150 | + |
|
151 | + public function rmdir($path) { |
|
152 | + $path = $this->normalizePath($path); |
|
153 | + |
|
154 | + if (!$this->is_dir($path)) { |
|
155 | + return false; |
|
156 | + } |
|
157 | + |
|
158 | + $this->rmObjects($path); |
|
159 | + |
|
160 | + $this->getCache()->remove($path); |
|
161 | + |
|
162 | + return true; |
|
163 | + } |
|
164 | + |
|
165 | + private function rmObjects($path) { |
|
166 | + $children = $this->getCache()->getFolderContents($path); |
|
167 | + foreach ($children as $child) { |
|
168 | + if ($child['mimetype'] === 'httpd/unix-directory') { |
|
169 | + $this->rmObjects($child['path']); |
|
170 | + } else { |
|
171 | + $this->unlink($child['path']); |
|
172 | + } |
|
173 | + } |
|
174 | + } |
|
175 | + |
|
176 | + public function unlink($path) { |
|
177 | + $path = $this->normalizePath($path); |
|
178 | + $stat = $this->stat($path); |
|
179 | + |
|
180 | + if ($stat && isset($stat['fileid'])) { |
|
181 | + if ($stat['mimetype'] === 'httpd/unix-directory') { |
|
182 | + return $this->rmdir($path); |
|
183 | + } |
|
184 | + try { |
|
185 | + $this->objectStore->deleteObject($this->getURN($stat['fileid'])); |
|
186 | + } catch (\Exception $ex) { |
|
187 | + if ($ex->getCode() !== 404) { |
|
188 | + \OCP\Util::writeLog('objectstore', 'Could not delete object: ' . $ex->getMessage(), \OCP\Util::ERROR); |
|
189 | + return false; |
|
190 | + } else { |
|
191 | + //removing from cache is ok as it does not exist in the objectstore anyway |
|
192 | + } |
|
193 | + } |
|
194 | + $this->getCache()->remove($path); |
|
195 | + return true; |
|
196 | + } |
|
197 | + return false; |
|
198 | + } |
|
199 | + |
|
200 | + public function stat($path) { |
|
201 | + $path = $this->normalizePath($path); |
|
202 | + $cacheEntry = $this->getCache()->get($path); |
|
203 | + if ($cacheEntry instanceof CacheEntry) { |
|
204 | + return $cacheEntry->getData(); |
|
205 | + } else { |
|
206 | + return false; |
|
207 | + } |
|
208 | + } |
|
209 | + |
|
210 | + /** |
|
211 | + * Override this method if you need a different unique resource identifier for your object storage implementation. |
|
212 | + * The default implementations just appends the fileId to 'urn:oid:'. Make sure the URN is unique over all users. |
|
213 | + * You may need a mapping table to store your URN if it cannot be generated from the fileid. |
|
214 | + * |
|
215 | + * @param int $fileId the fileid |
|
216 | + * @return null|string the unified resource name used to identify the object |
|
217 | + */ |
|
218 | + protected function getURN($fileId) { |
|
219 | + if (is_numeric($fileId)) { |
|
220 | + return $this->objectPrefix . $fileId; |
|
221 | + } |
|
222 | + return null; |
|
223 | + } |
|
224 | + |
|
225 | + public function opendir($path) { |
|
226 | + $path = $this->normalizePath($path); |
|
227 | + |
|
228 | + try { |
|
229 | + $files = array(); |
|
230 | + $folderContents = $this->getCache()->getFolderContents($path); |
|
231 | + foreach ($folderContents as $file) { |
|
232 | + $files[] = $file['name']; |
|
233 | + } |
|
234 | + |
|
235 | + return IteratorDirectory::wrap($files); |
|
236 | + } catch (\Exception $e) { |
|
237 | + \OCP\Util::writeLog('objectstore', $e->getMessage(), \OCP\Util::ERROR); |
|
238 | + return false; |
|
239 | + } |
|
240 | + } |
|
241 | + |
|
242 | + public function filetype($path) { |
|
243 | + $path = $this->normalizePath($path); |
|
244 | + $stat = $this->stat($path); |
|
245 | + if ($stat) { |
|
246 | + if ($stat['mimetype'] === 'httpd/unix-directory') { |
|
247 | + return 'dir'; |
|
248 | + } |
|
249 | + return 'file'; |
|
250 | + } else { |
|
251 | + return false; |
|
252 | + } |
|
253 | + } |
|
254 | + |
|
255 | + public function fopen($path, $mode) { |
|
256 | + $path = $this->normalizePath($path); |
|
257 | + |
|
258 | + switch ($mode) { |
|
259 | + case 'r': |
|
260 | + case 'rb': |
|
261 | + $stat = $this->stat($path); |
|
262 | + if (is_array($stat)) { |
|
263 | + try { |
|
264 | + return $this->objectStore->readObject($this->getURN($stat['fileid'])); |
|
265 | + } catch (\Exception $ex) { |
|
266 | + \OCP\Util::writeLog('objectstore', 'Could not get object: ' . $ex->getMessage(), \OCP\Util::ERROR); |
|
267 | + return false; |
|
268 | + } |
|
269 | + } else { |
|
270 | + return false; |
|
271 | + } |
|
272 | + case 'w': |
|
273 | + case 'wb': |
|
274 | + case 'a': |
|
275 | + case 'ab': |
|
276 | + case 'r+': |
|
277 | + case 'w+': |
|
278 | + case 'wb+': |
|
279 | + case 'a+': |
|
280 | + case 'x': |
|
281 | + case 'x+': |
|
282 | + case 'c': |
|
283 | + case 'c+': |
|
284 | + if (strrpos($path, '.') !== false) { |
|
285 | + $ext = substr($path, strrpos($path, '.')); |
|
286 | + } else { |
|
287 | + $ext = ''; |
|
288 | + } |
|
289 | + $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext); |
|
290 | + if ($this->file_exists($path)) { |
|
291 | + $source = $this->fopen($path, 'r'); |
|
292 | + file_put_contents($tmpFile, $source); |
|
293 | + } |
|
294 | + $handle = fopen($tmpFile, $mode); |
|
295 | + return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
296 | + $this->writeBack($tmpFile, $path); |
|
297 | + }); |
|
298 | + } |
|
299 | + return false; |
|
300 | + } |
|
301 | + |
|
302 | + public function file_exists($path) { |
|
303 | + $path = $this->normalizePath($path); |
|
304 | + return (bool)$this->stat($path); |
|
305 | + } |
|
306 | + |
|
307 | + public function rename($source, $target) { |
|
308 | + $source = $this->normalizePath($source); |
|
309 | + $target = $this->normalizePath($target); |
|
310 | + $this->remove($target); |
|
311 | + $this->getCache()->move($source, $target); |
|
312 | + $this->touch(dirname($target)); |
|
313 | + return true; |
|
314 | + } |
|
315 | + |
|
316 | + public function getMimeType($path) { |
|
317 | + $path = $this->normalizePath($path); |
|
318 | + $stat = $this->stat($path); |
|
319 | + if (is_array($stat)) { |
|
320 | + return $stat['mimetype']; |
|
321 | + } else { |
|
322 | + return false; |
|
323 | + } |
|
324 | + } |
|
325 | + |
|
326 | + public function touch($path, $mtime = null) { |
|
327 | + if (is_null($mtime)) { |
|
328 | + $mtime = time(); |
|
329 | + } |
|
330 | + |
|
331 | + $path = $this->normalizePath($path); |
|
332 | + $dirName = dirname($path); |
|
333 | + $parentExists = $this->is_dir($dirName); |
|
334 | + if (!$parentExists) { |
|
335 | + return false; |
|
336 | + } |
|
337 | + |
|
338 | + $stat = $this->stat($path); |
|
339 | + if (is_array($stat)) { |
|
340 | + // update existing mtime in db |
|
341 | + $stat['mtime'] = $mtime; |
|
342 | + $this->getCache()->update($stat['fileid'], $stat); |
|
343 | + } else { |
|
344 | + $mimeType = \OC::$server->getMimeTypeDetector()->detectPath($path); |
|
345 | + // create new file |
|
346 | + $stat = array( |
|
347 | + 'etag' => $this->getETag($path), |
|
348 | + 'mimetype' => $mimeType, |
|
349 | + 'size' => 0, |
|
350 | + 'mtime' => $mtime, |
|
351 | + 'storage_mtime' => $mtime, |
|
352 | + 'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE, |
|
353 | + ); |
|
354 | + $fileId = $this->getCache()->put($path, $stat); |
|
355 | + try { |
|
356 | + //read an empty file from memory |
|
357 | + $this->objectStore->writeObject($this->getURN($fileId), fopen('php://memory', 'r')); |
|
358 | + } catch (\Exception $ex) { |
|
359 | + $this->getCache()->remove($path); |
|
360 | + \OCP\Util::writeLog('objectstore', 'Could not create object: ' . $ex->getMessage(), \OCP\Util::ERROR); |
|
361 | + return false; |
|
362 | + } |
|
363 | + } |
|
364 | + return true; |
|
365 | + } |
|
366 | + |
|
367 | + public function writeBack($tmpFile, $path) { |
|
368 | + $stat = $this->stat($path); |
|
369 | + if (empty($stat)) { |
|
370 | + // create new file |
|
371 | + $stat = array( |
|
372 | + 'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE, |
|
373 | + ); |
|
374 | + } |
|
375 | + // update stat with new data |
|
376 | + $mTime = time(); |
|
377 | + $stat['size'] = filesize($tmpFile); |
|
378 | + $stat['mtime'] = $mTime; |
|
379 | + $stat['storage_mtime'] = $mTime; |
|
380 | + $stat['mimetype'] = \OC::$server->getMimeTypeDetector()->detect($tmpFile); |
|
381 | + $stat['etag'] = $this->getETag($path); |
|
382 | + |
|
383 | + $fileId = $this->getCache()->put($path, $stat); |
|
384 | + try { |
|
385 | + //upload to object storage |
|
386 | + $this->objectStore->writeObject($this->getURN($fileId), fopen($tmpFile, 'r')); |
|
387 | + } catch (\Exception $ex) { |
|
388 | + $this->getCache()->remove($path); |
|
389 | + \OCP\Util::writeLog('objectstore', 'Could not create object: ' . $ex->getMessage(), \OCP\Util::ERROR); |
|
390 | + throw $ex; // make this bubble up |
|
391 | + } |
|
392 | + } |
|
393 | + |
|
394 | + /** |
|
395 | + * external changes are not supported, exclusive access to the object storage is assumed |
|
396 | + * |
|
397 | + * @param string $path |
|
398 | + * @param int $time |
|
399 | + * @return false |
|
400 | + */ |
|
401 | + public function hasUpdated($path, $time) { |
|
402 | + return false; |
|
403 | + } |
|
404 | 404 | } |
@@ -53,9 +53,9 @@ discard block |
||
53 | 53 | throw new \Exception('missing IObjectStore instance'); |
54 | 54 | } |
55 | 55 | if (isset($params['storageid'])) { |
56 | - $this->id = 'object::store:' . $params['storageid']; |
|
56 | + $this->id = 'object::store:'.$params['storageid']; |
|
57 | 57 | } else { |
58 | - $this->id = 'object::store:' . $this->objectStore->getStorageId(); |
|
58 | + $this->id = 'object::store:'.$this->objectStore->getStorageId(); |
|
59 | 59 | } |
60 | 60 | if (isset($params['objectPrefix'])) { |
61 | 61 | $this->objectPrefix = $params['objectPrefix']; |
@@ -185,7 +185,7 @@ discard block |
||
185 | 185 | $this->objectStore->deleteObject($this->getURN($stat['fileid'])); |
186 | 186 | } catch (\Exception $ex) { |
187 | 187 | if ($ex->getCode() !== 404) { |
188 | - \OCP\Util::writeLog('objectstore', 'Could not delete object: ' . $ex->getMessage(), \OCP\Util::ERROR); |
|
188 | + \OCP\Util::writeLog('objectstore', 'Could not delete object: '.$ex->getMessage(), \OCP\Util::ERROR); |
|
189 | 189 | return false; |
190 | 190 | } else { |
191 | 191 | //removing from cache is ok as it does not exist in the objectstore anyway |
@@ -217,7 +217,7 @@ discard block |
||
217 | 217 | */ |
218 | 218 | protected function getURN($fileId) { |
219 | 219 | if (is_numeric($fileId)) { |
220 | - return $this->objectPrefix . $fileId; |
|
220 | + return $this->objectPrefix.$fileId; |
|
221 | 221 | } |
222 | 222 | return null; |
223 | 223 | } |
@@ -263,7 +263,7 @@ discard block |
||
263 | 263 | try { |
264 | 264 | return $this->objectStore->readObject($this->getURN($stat['fileid'])); |
265 | 265 | } catch (\Exception $ex) { |
266 | - \OCP\Util::writeLog('objectstore', 'Could not get object: ' . $ex->getMessage(), \OCP\Util::ERROR); |
|
266 | + \OCP\Util::writeLog('objectstore', 'Could not get object: '.$ex->getMessage(), \OCP\Util::ERROR); |
|
267 | 267 | return false; |
268 | 268 | } |
269 | 269 | } else { |
@@ -292,7 +292,7 @@ discard block |
||
292 | 292 | file_put_contents($tmpFile, $source); |
293 | 293 | } |
294 | 294 | $handle = fopen($tmpFile, $mode); |
295 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
295 | + return CallbackWrapper::wrap($handle, null, null, function() use ($path, $tmpFile) { |
|
296 | 296 | $this->writeBack($tmpFile, $path); |
297 | 297 | }); |
298 | 298 | } |
@@ -301,7 +301,7 @@ discard block |
||
301 | 301 | |
302 | 302 | public function file_exists($path) { |
303 | 303 | $path = $this->normalizePath($path); |
304 | - return (bool)$this->stat($path); |
|
304 | + return (bool) $this->stat($path); |
|
305 | 305 | } |
306 | 306 | |
307 | 307 | public function rename($source, $target) { |
@@ -357,7 +357,7 @@ discard block |
||
357 | 357 | $this->objectStore->writeObject($this->getURN($fileId), fopen('php://memory', 'r')); |
358 | 358 | } catch (\Exception $ex) { |
359 | 359 | $this->getCache()->remove($path); |
360 | - \OCP\Util::writeLog('objectstore', 'Could not create object: ' . $ex->getMessage(), \OCP\Util::ERROR); |
|
360 | + \OCP\Util::writeLog('objectstore', 'Could not create object: '.$ex->getMessage(), \OCP\Util::ERROR); |
|
361 | 361 | return false; |
362 | 362 | } |
363 | 363 | } |
@@ -386,7 +386,7 @@ discard block |
||
386 | 386 | $this->objectStore->writeObject($this->getURN($fileId), fopen($tmpFile, 'r')); |
387 | 387 | } catch (\Exception $ex) { |
388 | 388 | $this->getCache()->remove($path); |
389 | - \OCP\Util::writeLog('objectstore', 'Could not create object: ' . $ex->getMessage(), \OCP\Util::ERROR); |
|
389 | + \OCP\Util::writeLog('objectstore', 'Could not create object: '.$ex->getMessage(), \OCP\Util::ERROR); |
|
390 | 390 | throw $ex; // make this bubble up |
391 | 391 | } |
392 | 392 | } |
@@ -102,7 +102,7 @@ |
||
102 | 102 | |
103 | 103 | /** |
104 | 104 | * @param \Icewind\SMB\Change $change |
105 | - * @return IChange|null |
|
105 | + * @return null|Change |
|
106 | 106 | */ |
107 | 107 | private function mapChange(\Icewind\SMB\Change $change) { |
108 | 108 | $path = $this->relativePath($change->getPath()); |
@@ -29,122 +29,122 @@ |
||
29 | 29 | use OCP\Files\Notify\INotifyHandler; |
30 | 30 | |
31 | 31 | class SMBNotifyHandler implements INotifyHandler { |
32 | - /** |
|
33 | - * @var \Icewind\SMB\INotifyHandler |
|
34 | - */ |
|
35 | - private $shareNotifyHandler; |
|
32 | + /** |
|
33 | + * @var \Icewind\SMB\INotifyHandler |
|
34 | + */ |
|
35 | + private $shareNotifyHandler; |
|
36 | 36 | |
37 | - /** |
|
38 | - * @var string |
|
39 | - */ |
|
40 | - private $root; |
|
37 | + /** |
|
38 | + * @var string |
|
39 | + */ |
|
40 | + private $root; |
|
41 | 41 | |
42 | - private $oldRenamePath = null; |
|
42 | + private $oldRenamePath = null; |
|
43 | 43 | |
44 | - /** |
|
45 | - * SMBNotifyHandler constructor. |
|
46 | - * |
|
47 | - * @param \Icewind\SMB\INotifyHandler $shareNotifyHandler |
|
48 | - * @param string $root |
|
49 | - */ |
|
50 | - public function __construct(\Icewind\SMB\INotifyHandler $shareNotifyHandler, $root) { |
|
51 | - $this->shareNotifyHandler = $shareNotifyHandler; |
|
52 | - $this->root = $root; |
|
53 | - } |
|
44 | + /** |
|
45 | + * SMBNotifyHandler constructor. |
|
46 | + * |
|
47 | + * @param \Icewind\SMB\INotifyHandler $shareNotifyHandler |
|
48 | + * @param string $root |
|
49 | + */ |
|
50 | + public function __construct(\Icewind\SMB\INotifyHandler $shareNotifyHandler, $root) { |
|
51 | + $this->shareNotifyHandler = $shareNotifyHandler; |
|
52 | + $this->root = $root; |
|
53 | + } |
|
54 | 54 | |
55 | - private function relativePath($fullPath) { |
|
56 | - if ($fullPath === $this->root) { |
|
57 | - return ''; |
|
58 | - } else if (substr($fullPath, 0, strlen($this->root)) === $this->root) { |
|
59 | - return substr($fullPath, strlen($this->root)); |
|
60 | - } else { |
|
61 | - return null; |
|
62 | - } |
|
63 | - } |
|
55 | + private function relativePath($fullPath) { |
|
56 | + if ($fullPath === $this->root) { |
|
57 | + return ''; |
|
58 | + } else if (substr($fullPath, 0, strlen($this->root)) === $this->root) { |
|
59 | + return substr($fullPath, strlen($this->root)); |
|
60 | + } else { |
|
61 | + return null; |
|
62 | + } |
|
63 | + } |
|
64 | 64 | |
65 | - public function listen(callable $callback) { |
|
66 | - $oldRenamePath = null; |
|
67 | - $this->shareNotifyHandler->listen(function (\Icewind\SMB\Change $shareChange) use ($callback) { |
|
68 | - $change = $this->mapChange($shareChange); |
|
69 | - if (!is_null($change)) { |
|
70 | - return $callback($change); |
|
71 | - } else { |
|
72 | - return true; |
|
73 | - } |
|
74 | - }); |
|
75 | - } |
|
65 | + public function listen(callable $callback) { |
|
66 | + $oldRenamePath = null; |
|
67 | + $this->shareNotifyHandler->listen(function (\Icewind\SMB\Change $shareChange) use ($callback) { |
|
68 | + $change = $this->mapChange($shareChange); |
|
69 | + if (!is_null($change)) { |
|
70 | + return $callback($change); |
|
71 | + } else { |
|
72 | + return true; |
|
73 | + } |
|
74 | + }); |
|
75 | + } |
|
76 | 76 | |
77 | - /** |
|
78 | - * Get all changes detected since the start of the notify process or the last call to getChanges |
|
79 | - * |
|
80 | - * @return IChange[] |
|
81 | - */ |
|
82 | - public function getChanges() { |
|
83 | - $shareChanges = $this->shareNotifyHandler->getChanges(); |
|
84 | - $changes = []; |
|
85 | - foreach ($shareChanges as $shareChange) { |
|
86 | - $change = $this->mapChange($shareChange); |
|
87 | - if ($change) { |
|
88 | - $changes[] = $change; |
|
89 | - } |
|
90 | - } |
|
91 | - return $changes; |
|
92 | - } |
|
77 | + /** |
|
78 | + * Get all changes detected since the start of the notify process or the last call to getChanges |
|
79 | + * |
|
80 | + * @return IChange[] |
|
81 | + */ |
|
82 | + public function getChanges() { |
|
83 | + $shareChanges = $this->shareNotifyHandler->getChanges(); |
|
84 | + $changes = []; |
|
85 | + foreach ($shareChanges as $shareChange) { |
|
86 | + $change = $this->mapChange($shareChange); |
|
87 | + if ($change) { |
|
88 | + $changes[] = $change; |
|
89 | + } |
|
90 | + } |
|
91 | + return $changes; |
|
92 | + } |
|
93 | 93 | |
94 | - /** |
|
95 | - * Stop listening for changes |
|
96 | - * |
|
97 | - * Note that any pending changes will be discarded |
|
98 | - */ |
|
99 | - public function stop() { |
|
100 | - $this->shareNotifyHandler->stop(); |
|
101 | - } |
|
94 | + /** |
|
95 | + * Stop listening for changes |
|
96 | + * |
|
97 | + * Note that any pending changes will be discarded |
|
98 | + */ |
|
99 | + public function stop() { |
|
100 | + $this->shareNotifyHandler->stop(); |
|
101 | + } |
|
102 | 102 | |
103 | - /** |
|
104 | - * @param \Icewind\SMB\Change $change |
|
105 | - * @return IChange|null |
|
106 | - */ |
|
107 | - private function mapChange(\Icewind\SMB\Change $change) { |
|
108 | - $path = $this->relativePath($change->getPath()); |
|
109 | - if (is_null($path)) { |
|
110 | - return null; |
|
111 | - } |
|
112 | - if ($change->getCode() === \Icewind\SMB\INotifyHandler::NOTIFY_RENAMED_OLD) { |
|
113 | - $this->oldRenamePath = $path; |
|
114 | - return null; |
|
115 | - } |
|
116 | - $type = $this->mapNotifyType($change->getCode()); |
|
117 | - if (is_null($type)) { |
|
118 | - return null; |
|
119 | - } |
|
120 | - if ($type === IChange::RENAMED) { |
|
121 | - if (!is_null($this->oldRenamePath)) { |
|
122 | - $result = new RenameChange($type, $this->oldRenamePath, $path); |
|
123 | - $this->oldRenamePath = null; |
|
124 | - } else { |
|
125 | - $result = null; |
|
126 | - } |
|
127 | - } else { |
|
128 | - $result = new Change($type, $path); |
|
129 | - } |
|
130 | - return $result; |
|
131 | - } |
|
103 | + /** |
|
104 | + * @param \Icewind\SMB\Change $change |
|
105 | + * @return IChange|null |
|
106 | + */ |
|
107 | + private function mapChange(\Icewind\SMB\Change $change) { |
|
108 | + $path = $this->relativePath($change->getPath()); |
|
109 | + if (is_null($path)) { |
|
110 | + return null; |
|
111 | + } |
|
112 | + if ($change->getCode() === \Icewind\SMB\INotifyHandler::NOTIFY_RENAMED_OLD) { |
|
113 | + $this->oldRenamePath = $path; |
|
114 | + return null; |
|
115 | + } |
|
116 | + $type = $this->mapNotifyType($change->getCode()); |
|
117 | + if (is_null($type)) { |
|
118 | + return null; |
|
119 | + } |
|
120 | + if ($type === IChange::RENAMED) { |
|
121 | + if (!is_null($this->oldRenamePath)) { |
|
122 | + $result = new RenameChange($type, $this->oldRenamePath, $path); |
|
123 | + $this->oldRenamePath = null; |
|
124 | + } else { |
|
125 | + $result = null; |
|
126 | + } |
|
127 | + } else { |
|
128 | + $result = new Change($type, $path); |
|
129 | + } |
|
130 | + return $result; |
|
131 | + } |
|
132 | 132 | |
133 | - private function mapNotifyType($smbType) { |
|
134 | - switch ($smbType) { |
|
135 | - case \Icewind\SMB\INotifyHandler::NOTIFY_ADDED: |
|
136 | - return IChange::ADDED; |
|
137 | - case \Icewind\SMB\INotifyHandler::NOTIFY_REMOVED: |
|
138 | - return IChange::REMOVED; |
|
139 | - case \Icewind\SMB\INotifyHandler::NOTIFY_MODIFIED: |
|
140 | - case \Icewind\SMB\INotifyHandler::NOTIFY_ADDED_STREAM: |
|
141 | - case \Icewind\SMB\INotifyHandler::NOTIFY_MODIFIED_STREAM: |
|
142 | - case \Icewind\SMB\INotifyHandler::NOTIFY_REMOVED_STREAM: |
|
143 | - return IChange::MODIFIED; |
|
144 | - case \Icewind\SMB\INotifyHandler::NOTIFY_RENAMED_NEW: |
|
145 | - return IChange::RENAMED; |
|
146 | - default: |
|
147 | - return null; |
|
148 | - } |
|
149 | - } |
|
133 | + private function mapNotifyType($smbType) { |
|
134 | + switch ($smbType) { |
|
135 | + case \Icewind\SMB\INotifyHandler::NOTIFY_ADDED: |
|
136 | + return IChange::ADDED; |
|
137 | + case \Icewind\SMB\INotifyHandler::NOTIFY_REMOVED: |
|
138 | + return IChange::REMOVED; |
|
139 | + case \Icewind\SMB\INotifyHandler::NOTIFY_MODIFIED: |
|
140 | + case \Icewind\SMB\INotifyHandler::NOTIFY_ADDED_STREAM: |
|
141 | + case \Icewind\SMB\INotifyHandler::NOTIFY_MODIFIED_STREAM: |
|
142 | + case \Icewind\SMB\INotifyHandler::NOTIFY_REMOVED_STREAM: |
|
143 | + return IChange::MODIFIED; |
|
144 | + case \Icewind\SMB\INotifyHandler::NOTIFY_RENAMED_NEW: |
|
145 | + return IChange::RENAMED; |
|
146 | + default: |
|
147 | + return null; |
|
148 | + } |
|
149 | + } |
|
150 | 150 | } |
@@ -64,7 +64,7 @@ |
||
64 | 64 | |
65 | 65 | public function listen(callable $callback) { |
66 | 66 | $oldRenamePath = null; |
67 | - $this->shareNotifyHandler->listen(function (\Icewind\SMB\Change $shareChange) use ($callback) { |
|
67 | + $this->shareNotifyHandler->listen(function(\Icewind\SMB\Change $shareChange) use ($callback) { |
|
68 | 68 | $change = $this->mapChange($shareChange); |
69 | 69 | if (!is_null($change)) { |
70 | 70 | return $callback($change); |
@@ -1063,7 +1063,7 @@ discard block |
||
1063 | 1063 | * @param string $app |
1064 | 1064 | * @param \OCP\IConfig $config |
1065 | 1065 | * @param \OCP\IL10N $l |
1066 | - * @return bool |
|
1066 | + * @return string |
|
1067 | 1067 | * |
1068 | 1068 | * @throws Exception if app is not compatible with this version of ownCloud |
1069 | 1069 | * @throws Exception if no app-name was specified |
@@ -1243,6 +1243,11 @@ discard block |
||
1243 | 1243 | } |
1244 | 1244 | } |
1245 | 1245 | |
1246 | + /** |
|
1247 | + * @param string $lang |
|
1248 | + * |
|
1249 | + * @return string |
|
1250 | + */ |
|
1246 | 1251 | protected static function findBestL10NOption($options, $lang) { |
1247 | 1252 | $fallback = $similarLangFallback = $englishFallback = false; |
1248 | 1253 |
@@ -60,1188 +60,1188 @@ |
||
60 | 60 | * upgrading and removing apps. |
61 | 61 | */ |
62 | 62 | class OC_App { |
63 | - static private $appVersion = []; |
|
64 | - static private $adminForms = array(); |
|
65 | - static private $personalForms = array(); |
|
66 | - static private $appInfo = array(); |
|
67 | - static private $appTypes = array(); |
|
68 | - static private $loadedApps = array(); |
|
69 | - static private $altLogin = array(); |
|
70 | - static private $alreadyRegistered = []; |
|
71 | - const officialApp = 200; |
|
72 | - |
|
73 | - /** |
|
74 | - * clean the appId |
|
75 | - * |
|
76 | - * @param string|boolean $app AppId that needs to be cleaned |
|
77 | - * @return string |
|
78 | - */ |
|
79 | - public static function cleanAppId($app) { |
|
80 | - return str_replace(array('\0', '/', '\\', '..'), '', $app); |
|
81 | - } |
|
82 | - |
|
83 | - /** |
|
84 | - * Check if an app is loaded |
|
85 | - * |
|
86 | - * @param string $app |
|
87 | - * @return bool |
|
88 | - */ |
|
89 | - public static function isAppLoaded($app) { |
|
90 | - return in_array($app, self::$loadedApps, true); |
|
91 | - } |
|
92 | - |
|
93 | - /** |
|
94 | - * loads all apps |
|
95 | - * |
|
96 | - * @param string[] | string | null $types |
|
97 | - * @return bool |
|
98 | - * |
|
99 | - * This function walks through the ownCloud directory and loads all apps |
|
100 | - * it can find. A directory contains an app if the file /appinfo/info.xml |
|
101 | - * exists. |
|
102 | - * |
|
103 | - * if $types is set, only apps of those types will be loaded |
|
104 | - */ |
|
105 | - public static function loadApps($types = null) { |
|
106 | - if (\OC::$server->getSystemConfig()->getValue('maintenance', false)) { |
|
107 | - return false; |
|
108 | - } |
|
109 | - // Load the enabled apps here |
|
110 | - $apps = self::getEnabledApps(); |
|
111 | - |
|
112 | - // Add each apps' folder as allowed class path |
|
113 | - foreach($apps as $app) { |
|
114 | - $path = self::getAppPath($app); |
|
115 | - if($path !== false) { |
|
116 | - self::registerAutoloading($app, $path); |
|
117 | - } |
|
118 | - } |
|
119 | - |
|
120 | - // prevent app.php from printing output |
|
121 | - ob_start(); |
|
122 | - foreach ($apps as $app) { |
|
123 | - if ((is_null($types) or self::isType($app, $types)) && !in_array($app, self::$loadedApps)) { |
|
124 | - self::loadApp($app); |
|
125 | - } |
|
126 | - } |
|
127 | - ob_end_clean(); |
|
128 | - |
|
129 | - return true; |
|
130 | - } |
|
131 | - |
|
132 | - /** |
|
133 | - * load a single app |
|
134 | - * |
|
135 | - * @param string $app |
|
136 | - */ |
|
137 | - public static function loadApp($app) { |
|
138 | - self::$loadedApps[] = $app; |
|
139 | - $appPath = self::getAppPath($app); |
|
140 | - if($appPath === false) { |
|
141 | - return; |
|
142 | - } |
|
143 | - |
|
144 | - // in case someone calls loadApp() directly |
|
145 | - self::registerAutoloading($app, $appPath); |
|
146 | - |
|
147 | - if (is_file($appPath . '/appinfo/app.php')) { |
|
148 | - \OC::$server->getEventLogger()->start('load_app_' . $app, 'Load app: ' . $app); |
|
149 | - self::requireAppFile($app); |
|
150 | - if (self::isType($app, array('authentication'))) { |
|
151 | - // since authentication apps affect the "is app enabled for group" check, |
|
152 | - // the enabled apps cache needs to be cleared to make sure that the |
|
153 | - // next time getEnableApps() is called it will also include apps that were |
|
154 | - // enabled for groups |
|
155 | - self::$enabledAppsCache = array(); |
|
156 | - } |
|
157 | - \OC::$server->getEventLogger()->end('load_app_' . $app); |
|
158 | - } |
|
159 | - |
|
160 | - $info = self::getAppInfo($app); |
|
161 | - if (!empty($info['activity']['filters'])) { |
|
162 | - foreach ($info['activity']['filters'] as $filter) { |
|
163 | - \OC::$server->getActivityManager()->registerFilter($filter); |
|
164 | - } |
|
165 | - } |
|
166 | - if (!empty($info['activity']['settings'])) { |
|
167 | - foreach ($info['activity']['settings'] as $setting) { |
|
168 | - \OC::$server->getActivityManager()->registerSetting($setting); |
|
169 | - } |
|
170 | - } |
|
171 | - if (!empty($info['activity']['providers'])) { |
|
172 | - foreach ($info['activity']['providers'] as $provider) { |
|
173 | - \OC::$server->getActivityManager()->registerProvider($provider); |
|
174 | - } |
|
175 | - } |
|
176 | - } |
|
177 | - |
|
178 | - /** |
|
179 | - * @internal |
|
180 | - * @param string $app |
|
181 | - * @param string $path |
|
182 | - */ |
|
183 | - public static function registerAutoloading($app, $path) { |
|
184 | - $key = $app . '-' . $path; |
|
185 | - if(isset(self::$alreadyRegistered[$key])) { |
|
186 | - return; |
|
187 | - } |
|
188 | - self::$alreadyRegistered[$key] = true; |
|
189 | - // Register on PSR-4 composer autoloader |
|
190 | - $appNamespace = \OC\AppFramework\App::buildAppNamespace($app); |
|
191 | - \OC::$server->registerNamespace($app, $appNamespace); |
|
192 | - \OC::$composerAutoloader->addPsr4($appNamespace . '\\', $path . '/lib/', true); |
|
193 | - if (defined('PHPUNIT_RUN') || defined('CLI_TEST_RUN')) { |
|
194 | - \OC::$composerAutoloader->addPsr4($appNamespace . '\\Tests\\', $path . '/tests/', true); |
|
195 | - } |
|
196 | - |
|
197 | - // Register on legacy autoloader |
|
198 | - \OC::$loader->addValidRoot($path); |
|
199 | - } |
|
200 | - |
|
201 | - /** |
|
202 | - * Load app.php from the given app |
|
203 | - * |
|
204 | - * @param string $app app name |
|
205 | - */ |
|
206 | - private static function requireAppFile($app) { |
|
207 | - try { |
|
208 | - // encapsulated here to avoid variable scope conflicts |
|
209 | - require_once $app . '/appinfo/app.php'; |
|
210 | - } catch (Error $ex) { |
|
211 | - \OC::$server->getLogger()->logException($ex); |
|
212 | - $blacklist = \OC::$server->getAppManager()->getAlwaysEnabledApps(); |
|
213 | - if (!in_array($app, $blacklist)) { |
|
214 | - self::disable($app); |
|
215 | - } |
|
216 | - } |
|
217 | - } |
|
218 | - |
|
219 | - /** |
|
220 | - * check if an app is of a specific type |
|
221 | - * |
|
222 | - * @param string $app |
|
223 | - * @param string|array $types |
|
224 | - * @return bool |
|
225 | - */ |
|
226 | - public static function isType($app, $types) { |
|
227 | - if (is_string($types)) { |
|
228 | - $types = array($types); |
|
229 | - } |
|
230 | - $appTypes = self::getAppTypes($app); |
|
231 | - foreach ($types as $type) { |
|
232 | - if (array_search($type, $appTypes) !== false) { |
|
233 | - return true; |
|
234 | - } |
|
235 | - } |
|
236 | - return false; |
|
237 | - } |
|
238 | - |
|
239 | - /** |
|
240 | - * get the types of an app |
|
241 | - * |
|
242 | - * @param string $app |
|
243 | - * @return array |
|
244 | - */ |
|
245 | - private static function getAppTypes($app) { |
|
246 | - //load the cache |
|
247 | - if (count(self::$appTypes) == 0) { |
|
248 | - self::$appTypes = \OC::$server->getAppConfig()->getValues(false, 'types'); |
|
249 | - } |
|
250 | - |
|
251 | - if (isset(self::$appTypes[$app])) { |
|
252 | - return explode(',', self::$appTypes[$app]); |
|
253 | - } else { |
|
254 | - return array(); |
|
255 | - } |
|
256 | - } |
|
257 | - |
|
258 | - /** |
|
259 | - * read app types from info.xml and cache them in the database |
|
260 | - */ |
|
261 | - public static function setAppTypes($app) { |
|
262 | - $appData = self::getAppInfo($app); |
|
263 | - if(!is_array($appData)) { |
|
264 | - return; |
|
265 | - } |
|
266 | - |
|
267 | - if (isset($appData['types'])) { |
|
268 | - $appTypes = implode(',', $appData['types']); |
|
269 | - } else { |
|
270 | - $appTypes = ''; |
|
271 | - $appData['types'] = []; |
|
272 | - } |
|
273 | - |
|
274 | - \OC::$server->getAppConfig()->setValue($app, 'types', $appTypes); |
|
275 | - |
|
276 | - if (\OC::$server->getAppManager()->hasProtectedAppType($appData['types'])) { |
|
277 | - $enabled = \OC::$server->getAppConfig()->getValue($app, 'enabled', 'yes'); |
|
278 | - if ($enabled !== 'yes' && $enabled !== 'no') { |
|
279 | - \OC::$server->getAppConfig()->setValue($app, 'enabled', 'yes'); |
|
280 | - } |
|
281 | - } |
|
282 | - } |
|
283 | - |
|
284 | - /** |
|
285 | - * check if app is shipped |
|
286 | - * |
|
287 | - * @param string $appId the id of the app to check |
|
288 | - * @return bool |
|
289 | - * |
|
290 | - * Check if an app that is installed is a shipped app or installed from the appstore. |
|
291 | - */ |
|
292 | - public static function isShipped($appId) { |
|
293 | - return \OC::$server->getAppManager()->isShipped($appId); |
|
294 | - } |
|
295 | - |
|
296 | - /** |
|
297 | - * get all enabled apps |
|
298 | - */ |
|
299 | - protected static $enabledAppsCache = array(); |
|
300 | - |
|
301 | - /** |
|
302 | - * Returns apps enabled for the current user. |
|
303 | - * |
|
304 | - * @param bool $forceRefresh whether to refresh the cache |
|
305 | - * @param bool $all whether to return apps for all users, not only the |
|
306 | - * currently logged in one |
|
307 | - * @return string[] |
|
308 | - */ |
|
309 | - public static function getEnabledApps($forceRefresh = false, $all = false) { |
|
310 | - if (!\OC::$server->getSystemConfig()->getValue('installed', false)) { |
|
311 | - return array(); |
|
312 | - } |
|
313 | - // in incognito mode or when logged out, $user will be false, |
|
314 | - // which is also the case during an upgrade |
|
315 | - $appManager = \OC::$server->getAppManager(); |
|
316 | - if ($all) { |
|
317 | - $user = null; |
|
318 | - } else { |
|
319 | - $user = \OC::$server->getUserSession()->getUser(); |
|
320 | - } |
|
321 | - |
|
322 | - if (is_null($user)) { |
|
323 | - $apps = $appManager->getInstalledApps(); |
|
324 | - } else { |
|
325 | - $apps = $appManager->getEnabledAppsForUser($user); |
|
326 | - } |
|
327 | - $apps = array_filter($apps, function ($app) { |
|
328 | - return $app !== 'files';//we add this manually |
|
329 | - }); |
|
330 | - sort($apps); |
|
331 | - array_unshift($apps, 'files'); |
|
332 | - return $apps; |
|
333 | - } |
|
334 | - |
|
335 | - /** |
|
336 | - * checks whether or not an app is enabled |
|
337 | - * |
|
338 | - * @param string $app app |
|
339 | - * @return bool |
|
340 | - * |
|
341 | - * This function checks whether or not an app is enabled. |
|
342 | - */ |
|
343 | - public static function isEnabled($app) { |
|
344 | - return \OC::$server->getAppManager()->isEnabledForUser($app); |
|
345 | - } |
|
346 | - |
|
347 | - /** |
|
348 | - * enables an app |
|
349 | - * |
|
350 | - * @param string $appId |
|
351 | - * @param array $groups (optional) when set, only these groups will have access to the app |
|
352 | - * @throws \Exception |
|
353 | - * @return void |
|
354 | - * |
|
355 | - * This function set an app as enabled in appconfig. |
|
356 | - */ |
|
357 | - public function enable($appId, |
|
358 | - $groups = null) { |
|
359 | - self::$enabledAppsCache = []; // flush |
|
360 | - |
|
361 | - // Check if app is already downloaded |
|
362 | - $installer = new Installer( |
|
363 | - \OC::$server->getAppFetcher(), |
|
364 | - \OC::$server->getHTTPClientService(), |
|
365 | - \OC::$server->getTempManager(), |
|
366 | - \OC::$server->getLogger(), |
|
367 | - \OC::$server->getConfig() |
|
368 | - ); |
|
369 | - $isDownloaded = $installer->isDownloaded($appId); |
|
370 | - |
|
371 | - if(!$isDownloaded) { |
|
372 | - $installer->downloadApp($appId); |
|
373 | - } |
|
374 | - |
|
375 | - $installer->installApp($appId); |
|
376 | - |
|
377 | - $appManager = \OC::$server->getAppManager(); |
|
378 | - if (!is_null($groups)) { |
|
379 | - $groupManager = \OC::$server->getGroupManager(); |
|
380 | - $groupsList = []; |
|
381 | - foreach ($groups as $group) { |
|
382 | - $groupItem = $groupManager->get($group); |
|
383 | - if ($groupItem instanceof \OCP\IGroup) { |
|
384 | - $groupsList[] = $groupManager->get($group); |
|
385 | - } |
|
386 | - } |
|
387 | - $appManager->enableAppForGroups($appId, $groupsList); |
|
388 | - } else { |
|
389 | - $appManager->enableApp($appId); |
|
390 | - } |
|
391 | - } |
|
392 | - |
|
393 | - /** |
|
394 | - * @param string $app |
|
395 | - * @return bool |
|
396 | - */ |
|
397 | - public static function removeApp($app) { |
|
398 | - if (self::isShipped($app)) { |
|
399 | - return false; |
|
400 | - } |
|
401 | - |
|
402 | - $installer = new Installer( |
|
403 | - \OC::$server->getAppFetcher(), |
|
404 | - \OC::$server->getHTTPClientService(), |
|
405 | - \OC::$server->getTempManager(), |
|
406 | - \OC::$server->getLogger(), |
|
407 | - \OC::$server->getConfig() |
|
408 | - ); |
|
409 | - return $installer->removeApp($app); |
|
410 | - } |
|
411 | - |
|
412 | - /** |
|
413 | - * This function set an app as disabled in appconfig. |
|
414 | - * |
|
415 | - * @param string $app app |
|
416 | - * @throws Exception |
|
417 | - */ |
|
418 | - public static function disable($app) { |
|
419 | - // flush |
|
420 | - self::$enabledAppsCache = array(); |
|
421 | - |
|
422 | - // run uninstall steps |
|
423 | - $appData = OC_App::getAppInfo($app); |
|
424 | - if (!is_null($appData)) { |
|
425 | - OC_App::executeRepairSteps($app, $appData['repair-steps']['uninstall']); |
|
426 | - } |
|
427 | - |
|
428 | - // emit disable hook - needed anymore ? |
|
429 | - \OC_Hook::emit('OC_App', 'pre_disable', array('app' => $app)); |
|
430 | - |
|
431 | - // finally disable it |
|
432 | - $appManager = \OC::$server->getAppManager(); |
|
433 | - $appManager->disableApp($app); |
|
434 | - } |
|
435 | - |
|
436 | - // This is private as well. It simply works, so don't ask for more details |
|
437 | - private static function proceedNavigation($list) { |
|
438 | - usort($list, function($a, $b) { |
|
439 | - if (isset($a['order']) && isset($b['order'])) { |
|
440 | - return ($a['order'] < $b['order']) ? -1 : 1; |
|
441 | - } else if (isset($a['order']) || isset($b['order'])) { |
|
442 | - return isset($a['order']) ? -1 : 1; |
|
443 | - } else { |
|
444 | - return ($a['name'] < $b['name']) ? -1 : 1; |
|
445 | - } |
|
446 | - }); |
|
447 | - |
|
448 | - $activeApp = OC::$server->getNavigationManager()->getActiveEntry(); |
|
449 | - foreach ($list as $index => &$navEntry) { |
|
450 | - if ($navEntry['id'] == $activeApp) { |
|
451 | - $navEntry['active'] = true; |
|
452 | - } else { |
|
453 | - $navEntry['active'] = false; |
|
454 | - } |
|
455 | - } |
|
456 | - unset($navEntry); |
|
457 | - |
|
458 | - return $list; |
|
459 | - } |
|
460 | - |
|
461 | - /** |
|
462 | - * Get the path where to install apps |
|
463 | - * |
|
464 | - * @return string|false |
|
465 | - */ |
|
466 | - public static function getInstallPath() { |
|
467 | - if (\OC::$server->getSystemConfig()->getValue('appstoreenabled', true) == false) { |
|
468 | - return false; |
|
469 | - } |
|
470 | - |
|
471 | - foreach (OC::$APPSROOTS as $dir) { |
|
472 | - if (isset($dir['writable']) && $dir['writable'] === true) { |
|
473 | - return $dir['path']; |
|
474 | - } |
|
475 | - } |
|
476 | - |
|
477 | - \OCP\Util::writeLog('core', 'No application directories are marked as writable.', \OCP\Util::ERROR); |
|
478 | - return null; |
|
479 | - } |
|
480 | - |
|
481 | - |
|
482 | - /** |
|
483 | - * search for an app in all app-directories |
|
484 | - * |
|
485 | - * @param string $appId |
|
486 | - * @return false|string |
|
487 | - */ |
|
488 | - public static function findAppInDirectories($appId) { |
|
489 | - $sanitizedAppId = self::cleanAppId($appId); |
|
490 | - if($sanitizedAppId !== $appId) { |
|
491 | - return false; |
|
492 | - } |
|
493 | - static $app_dir = array(); |
|
494 | - |
|
495 | - if (isset($app_dir[$appId])) { |
|
496 | - return $app_dir[$appId]; |
|
497 | - } |
|
498 | - |
|
499 | - $possibleApps = array(); |
|
500 | - foreach (OC::$APPSROOTS as $dir) { |
|
501 | - if (file_exists($dir['path'] . '/' . $appId)) { |
|
502 | - $possibleApps[] = $dir; |
|
503 | - } |
|
504 | - } |
|
505 | - |
|
506 | - if (empty($possibleApps)) { |
|
507 | - return false; |
|
508 | - } elseif (count($possibleApps) === 1) { |
|
509 | - $dir = array_shift($possibleApps); |
|
510 | - $app_dir[$appId] = $dir; |
|
511 | - return $dir; |
|
512 | - } else { |
|
513 | - $versionToLoad = array(); |
|
514 | - foreach ($possibleApps as $possibleApp) { |
|
515 | - $version = self::getAppVersionByPath($possibleApp['path']); |
|
516 | - if (empty($versionToLoad) || version_compare($version, $versionToLoad['version'], '>')) { |
|
517 | - $versionToLoad = array( |
|
518 | - 'dir' => $possibleApp, |
|
519 | - 'version' => $version, |
|
520 | - ); |
|
521 | - } |
|
522 | - } |
|
523 | - $app_dir[$appId] = $versionToLoad['dir']; |
|
524 | - return $versionToLoad['dir']; |
|
525 | - //TODO - write test |
|
526 | - } |
|
527 | - } |
|
528 | - |
|
529 | - /** |
|
530 | - * Get the directory for the given app. |
|
531 | - * If the app is defined in multiple directories, the first one is taken. (false if not found) |
|
532 | - * |
|
533 | - * @param string $appId |
|
534 | - * @return string|false |
|
535 | - */ |
|
536 | - public static function getAppPath($appId) { |
|
537 | - if ($appId === null || trim($appId) === '') { |
|
538 | - return false; |
|
539 | - } |
|
540 | - |
|
541 | - if (($dir = self::findAppInDirectories($appId)) != false) { |
|
542 | - return $dir['path'] . '/' . $appId; |
|
543 | - } |
|
544 | - return false; |
|
545 | - } |
|
546 | - |
|
547 | - /** |
|
548 | - * Get the path for the given app on the access |
|
549 | - * If the app is defined in multiple directories, the first one is taken. (false if not found) |
|
550 | - * |
|
551 | - * @param string $appId |
|
552 | - * @return string|false |
|
553 | - */ |
|
554 | - public static function getAppWebPath($appId) { |
|
555 | - if (($dir = self::findAppInDirectories($appId)) != false) { |
|
556 | - return OC::$WEBROOT . $dir['url'] . '/' . $appId; |
|
557 | - } |
|
558 | - return false; |
|
559 | - } |
|
560 | - |
|
561 | - /** |
|
562 | - * get the last version of the app from appinfo/info.xml |
|
563 | - * |
|
564 | - * @param string $appId |
|
565 | - * @param bool $useCache |
|
566 | - * @return string |
|
567 | - */ |
|
568 | - public static function getAppVersion($appId, $useCache = true) { |
|
569 | - if($useCache && isset(self::$appVersion[$appId])) { |
|
570 | - return self::$appVersion[$appId]; |
|
571 | - } |
|
572 | - |
|
573 | - $file = self::getAppPath($appId); |
|
574 | - self::$appVersion[$appId] = ($file !== false) ? self::getAppVersionByPath($file) : '0'; |
|
575 | - return self::$appVersion[$appId]; |
|
576 | - } |
|
577 | - |
|
578 | - /** |
|
579 | - * get app's version based on it's path |
|
580 | - * |
|
581 | - * @param string $path |
|
582 | - * @return string |
|
583 | - */ |
|
584 | - public static function getAppVersionByPath($path) { |
|
585 | - $infoFile = $path . '/appinfo/info.xml'; |
|
586 | - $appData = self::getAppInfo($infoFile, true); |
|
587 | - return isset($appData['version']) ? $appData['version'] : ''; |
|
588 | - } |
|
589 | - |
|
590 | - |
|
591 | - /** |
|
592 | - * Read all app metadata from the info.xml file |
|
593 | - * |
|
594 | - * @param string $appId id of the app or the path of the info.xml file |
|
595 | - * @param bool $path |
|
596 | - * @param string $lang |
|
597 | - * @return array|null |
|
598 | - * @note all data is read from info.xml, not just pre-defined fields |
|
599 | - */ |
|
600 | - public static function getAppInfo($appId, $path = false, $lang = null) { |
|
601 | - if ($path) { |
|
602 | - $file = $appId; |
|
603 | - } else { |
|
604 | - if ($lang === null && isset(self::$appInfo[$appId])) { |
|
605 | - return self::$appInfo[$appId]; |
|
606 | - } |
|
607 | - $appPath = self::getAppPath($appId); |
|
608 | - if($appPath === false) { |
|
609 | - return null; |
|
610 | - } |
|
611 | - $file = $appPath . '/appinfo/info.xml'; |
|
612 | - } |
|
613 | - |
|
614 | - $parser = new InfoParser(\OC::$server->getMemCacheFactory()->create('core.appinfo')); |
|
615 | - $data = $parser->parse($file); |
|
616 | - |
|
617 | - if (is_array($data)) { |
|
618 | - $data = OC_App::parseAppInfo($data, $lang); |
|
619 | - } |
|
620 | - if(isset($data['ocsid'])) { |
|
621 | - $storedId = \OC::$server->getConfig()->getAppValue($appId, 'ocsid'); |
|
622 | - if($storedId !== '' && $storedId !== $data['ocsid']) { |
|
623 | - $data['ocsid'] = $storedId; |
|
624 | - } |
|
625 | - } |
|
626 | - |
|
627 | - if ($lang === null) { |
|
628 | - self::$appInfo[$appId] = $data; |
|
629 | - } |
|
630 | - |
|
631 | - return $data; |
|
632 | - } |
|
633 | - |
|
634 | - /** |
|
635 | - * Returns the navigation |
|
636 | - * |
|
637 | - * @return array |
|
638 | - * |
|
639 | - * This function returns an array containing all entries added. The |
|
640 | - * entries are sorted by the key 'order' ascending. Additional to the keys |
|
641 | - * given for each app the following keys exist: |
|
642 | - * - active: boolean, signals if the user is on this navigation entry |
|
643 | - */ |
|
644 | - public static function getNavigation() { |
|
645 | - $entries = OC::$server->getNavigationManager()->getAll(); |
|
646 | - return self::proceedNavigation($entries); |
|
647 | - } |
|
648 | - |
|
649 | - /** |
|
650 | - * Returns the Settings Navigation |
|
651 | - * |
|
652 | - * @return string[] |
|
653 | - * |
|
654 | - * This function returns an array containing all settings pages added. The |
|
655 | - * entries are sorted by the key 'order' ascending. |
|
656 | - */ |
|
657 | - public static function getSettingsNavigation() { |
|
658 | - $entries = OC::$server->getNavigationManager()->getAll('settings'); |
|
659 | - return self::proceedNavigation($entries); |
|
660 | - } |
|
661 | - |
|
662 | - /** |
|
663 | - * get the id of loaded app |
|
664 | - * |
|
665 | - * @return string |
|
666 | - */ |
|
667 | - public static function getCurrentApp() { |
|
668 | - $request = \OC::$server->getRequest(); |
|
669 | - $script = substr($request->getScriptName(), strlen(OC::$WEBROOT) + 1); |
|
670 | - $topFolder = substr($script, 0, strpos($script, '/')); |
|
671 | - if (empty($topFolder)) { |
|
672 | - $path_info = $request->getPathInfo(); |
|
673 | - if ($path_info) { |
|
674 | - $topFolder = substr($path_info, 1, strpos($path_info, '/', 1) - 1); |
|
675 | - } |
|
676 | - } |
|
677 | - if ($topFolder == 'apps') { |
|
678 | - $length = strlen($topFolder); |
|
679 | - return substr($script, $length + 1, strpos($script, '/', $length + 1) - $length - 1); |
|
680 | - } else { |
|
681 | - return $topFolder; |
|
682 | - } |
|
683 | - } |
|
684 | - |
|
685 | - /** |
|
686 | - * @param string $type |
|
687 | - * @return array |
|
688 | - */ |
|
689 | - public static function getForms($type) { |
|
690 | - $forms = array(); |
|
691 | - switch ($type) { |
|
692 | - case 'admin': |
|
693 | - $source = self::$adminForms; |
|
694 | - break; |
|
695 | - case 'personal': |
|
696 | - $source = self::$personalForms; |
|
697 | - break; |
|
698 | - default: |
|
699 | - return array(); |
|
700 | - } |
|
701 | - foreach ($source as $form) { |
|
702 | - $forms[] = include $form; |
|
703 | - } |
|
704 | - return $forms; |
|
705 | - } |
|
706 | - |
|
707 | - /** |
|
708 | - * register an admin form to be shown |
|
709 | - * |
|
710 | - * @param string $app |
|
711 | - * @param string $page |
|
712 | - */ |
|
713 | - public static function registerAdmin($app, $page) { |
|
714 | - self::$adminForms[] = $app . '/' . $page . '.php'; |
|
715 | - } |
|
716 | - |
|
717 | - /** |
|
718 | - * register a personal form to be shown |
|
719 | - * @param string $app |
|
720 | - * @param string $page |
|
721 | - */ |
|
722 | - public static function registerPersonal($app, $page) { |
|
723 | - self::$personalForms[] = $app . '/' . $page . '.php'; |
|
724 | - } |
|
725 | - |
|
726 | - /** |
|
727 | - * @param array $entry |
|
728 | - */ |
|
729 | - public static function registerLogIn(array $entry) { |
|
730 | - self::$altLogin[] = $entry; |
|
731 | - } |
|
732 | - |
|
733 | - /** |
|
734 | - * @return array |
|
735 | - */ |
|
736 | - public static function getAlternativeLogIns() { |
|
737 | - return self::$altLogin; |
|
738 | - } |
|
739 | - |
|
740 | - /** |
|
741 | - * get a list of all apps in the apps folder |
|
742 | - * |
|
743 | - * @return array an array of app names (string IDs) |
|
744 | - * @todo: change the name of this method to getInstalledApps, which is more accurate |
|
745 | - */ |
|
746 | - public static function getAllApps() { |
|
747 | - |
|
748 | - $apps = array(); |
|
749 | - |
|
750 | - foreach (OC::$APPSROOTS as $apps_dir) { |
|
751 | - if (!is_readable($apps_dir['path'])) { |
|
752 | - \OCP\Util::writeLog('core', 'unable to read app folder : ' . $apps_dir['path'], \OCP\Util::WARN); |
|
753 | - continue; |
|
754 | - } |
|
755 | - $dh = opendir($apps_dir['path']); |
|
756 | - |
|
757 | - if (is_resource($dh)) { |
|
758 | - while (($file = readdir($dh)) !== false) { |
|
759 | - |
|
760 | - if ($file[0] != '.' and is_dir($apps_dir['path'] . '/' . $file) and is_file($apps_dir['path'] . '/' . $file . '/appinfo/info.xml')) { |
|
761 | - |
|
762 | - $apps[] = $file; |
|
763 | - } |
|
764 | - } |
|
765 | - } |
|
766 | - } |
|
767 | - |
|
768 | - return $apps; |
|
769 | - } |
|
770 | - |
|
771 | - /** |
|
772 | - * List all apps, this is used in apps.php |
|
773 | - * |
|
774 | - * @return array |
|
775 | - */ |
|
776 | - public function listAllApps() { |
|
777 | - $installedApps = OC_App::getAllApps(); |
|
778 | - |
|
779 | - //we don't want to show configuration for these |
|
780 | - $blacklist = \OC::$server->getAppManager()->getAlwaysEnabledApps(); |
|
781 | - $appList = array(); |
|
782 | - $langCode = \OC::$server->getL10N('core')->getLanguageCode(); |
|
783 | - $urlGenerator = \OC::$server->getURLGenerator(); |
|
784 | - |
|
785 | - foreach ($installedApps as $app) { |
|
786 | - if (array_search($app, $blacklist) === false) { |
|
787 | - |
|
788 | - $info = OC_App::getAppInfo($app, false, $langCode); |
|
789 | - if (!is_array($info)) { |
|
790 | - \OCP\Util::writeLog('core', 'Could not read app info file for app "' . $app . '"', \OCP\Util::ERROR); |
|
791 | - continue; |
|
792 | - } |
|
793 | - |
|
794 | - if (!isset($info['name'])) { |
|
795 | - \OCP\Util::writeLog('core', 'App id "' . $app . '" has no name in appinfo', \OCP\Util::ERROR); |
|
796 | - continue; |
|
797 | - } |
|
798 | - |
|
799 | - $enabled = \OC::$server->getAppConfig()->getValue($app, 'enabled', 'no'); |
|
800 | - $info['groups'] = null; |
|
801 | - if ($enabled === 'yes') { |
|
802 | - $active = true; |
|
803 | - } else if ($enabled === 'no') { |
|
804 | - $active = false; |
|
805 | - } else { |
|
806 | - $active = true; |
|
807 | - $info['groups'] = $enabled; |
|
808 | - } |
|
809 | - |
|
810 | - $info['active'] = $active; |
|
811 | - |
|
812 | - if (self::isShipped($app)) { |
|
813 | - $info['internal'] = true; |
|
814 | - $info['level'] = self::officialApp; |
|
815 | - $info['removable'] = false; |
|
816 | - } else { |
|
817 | - $info['internal'] = false; |
|
818 | - $info['removable'] = true; |
|
819 | - } |
|
820 | - |
|
821 | - $appPath = self::getAppPath($app); |
|
822 | - if($appPath !== false) { |
|
823 | - $appIcon = $appPath . '/img/' . $app . '.svg'; |
|
824 | - if (file_exists($appIcon)) { |
|
825 | - $info['preview'] = \OC::$server->getURLGenerator()->imagePath($app, $app . '.svg'); |
|
826 | - $info['previewAsIcon'] = true; |
|
827 | - } else { |
|
828 | - $appIcon = $appPath . '/img/app.svg'; |
|
829 | - if (file_exists($appIcon)) { |
|
830 | - $info['preview'] = \OC::$server->getURLGenerator()->imagePath($app, 'app.svg'); |
|
831 | - $info['previewAsIcon'] = true; |
|
832 | - } |
|
833 | - } |
|
834 | - } |
|
835 | - // fix documentation |
|
836 | - if (isset($info['documentation']) && is_array($info['documentation'])) { |
|
837 | - foreach ($info['documentation'] as $key => $url) { |
|
838 | - // If it is not an absolute URL we assume it is a key |
|
839 | - // i.e. admin-ldap will get converted to go.php?to=admin-ldap |
|
840 | - if (stripos($url, 'https://') !== 0 && stripos($url, 'http://') !== 0) { |
|
841 | - $url = $urlGenerator->linkToDocs($url); |
|
842 | - } |
|
843 | - |
|
844 | - $info['documentation'][$key] = $url; |
|
845 | - } |
|
846 | - } |
|
847 | - |
|
848 | - $info['version'] = OC_App::getAppVersion($app); |
|
849 | - $appList[] = $info; |
|
850 | - } |
|
851 | - } |
|
852 | - |
|
853 | - return $appList; |
|
854 | - } |
|
855 | - |
|
856 | - /** |
|
857 | - * Returns the internal app ID or false |
|
858 | - * @param string $ocsID |
|
859 | - * @return string|false |
|
860 | - */ |
|
861 | - public static function getInternalAppIdByOcs($ocsID) { |
|
862 | - if(is_numeric($ocsID)) { |
|
863 | - $idArray = \OC::$server->getAppConfig()->getValues(false, 'ocsid'); |
|
864 | - if(array_search($ocsID, $idArray)) { |
|
865 | - return array_search($ocsID, $idArray); |
|
866 | - } |
|
867 | - } |
|
868 | - return false; |
|
869 | - } |
|
870 | - |
|
871 | - public static function shouldUpgrade($app) { |
|
872 | - $versions = self::getAppVersions(); |
|
873 | - $currentVersion = OC_App::getAppVersion($app); |
|
874 | - if ($currentVersion && isset($versions[$app])) { |
|
875 | - $installedVersion = $versions[$app]; |
|
876 | - if (!version_compare($currentVersion, $installedVersion, '=')) { |
|
877 | - return true; |
|
878 | - } |
|
879 | - } |
|
880 | - return false; |
|
881 | - } |
|
882 | - |
|
883 | - /** |
|
884 | - * Adjust the number of version parts of $version1 to match |
|
885 | - * the number of version parts of $version2. |
|
886 | - * |
|
887 | - * @param string $version1 version to adjust |
|
888 | - * @param string $version2 version to take the number of parts from |
|
889 | - * @return string shortened $version1 |
|
890 | - */ |
|
891 | - private static function adjustVersionParts($version1, $version2) { |
|
892 | - $version1 = explode('.', $version1); |
|
893 | - $version2 = explode('.', $version2); |
|
894 | - // reduce $version1 to match the number of parts in $version2 |
|
895 | - while (count($version1) > count($version2)) { |
|
896 | - array_pop($version1); |
|
897 | - } |
|
898 | - // if $version1 does not have enough parts, add some |
|
899 | - while (count($version1) < count($version2)) { |
|
900 | - $version1[] = '0'; |
|
901 | - } |
|
902 | - return implode('.', $version1); |
|
903 | - } |
|
904 | - |
|
905 | - /** |
|
906 | - * Check whether the current ownCloud version matches the given |
|
907 | - * application's version requirements. |
|
908 | - * |
|
909 | - * The comparison is made based on the number of parts that the |
|
910 | - * app info version has. For example for ownCloud 6.0.3 if the |
|
911 | - * app info version is expecting version 6.0, the comparison is |
|
912 | - * made on the first two parts of the ownCloud version. |
|
913 | - * This means that it's possible to specify "requiremin" => 6 |
|
914 | - * and "requiremax" => 6 and it will still match ownCloud 6.0.3. |
|
915 | - * |
|
916 | - * @param string $ocVersion ownCloud version to check against |
|
917 | - * @param array $appInfo app info (from xml) |
|
918 | - * |
|
919 | - * @return boolean true if compatible, otherwise false |
|
920 | - */ |
|
921 | - public static function isAppCompatible($ocVersion, $appInfo) { |
|
922 | - $requireMin = ''; |
|
923 | - $requireMax = ''; |
|
924 | - if (isset($appInfo['dependencies']['nextcloud']['@attributes']['min-version'])) { |
|
925 | - $requireMin = $appInfo['dependencies']['nextcloud']['@attributes']['min-version']; |
|
926 | - } elseif (isset($appInfo['dependencies']['owncloud']['@attributes']['min-version'])) { |
|
927 | - $requireMin = $appInfo['dependencies']['owncloud']['@attributes']['min-version']; |
|
928 | - } else if (isset($appInfo['requiremin'])) { |
|
929 | - $requireMin = $appInfo['requiremin']; |
|
930 | - } else if (isset($appInfo['require'])) { |
|
931 | - $requireMin = $appInfo['require']; |
|
932 | - } |
|
933 | - |
|
934 | - if (isset($appInfo['dependencies']['nextcloud']['@attributes']['max-version'])) { |
|
935 | - $requireMax = $appInfo['dependencies']['nextcloud']['@attributes']['max-version']; |
|
936 | - } elseif (isset($appInfo['dependencies']['owncloud']['@attributes']['max-version'])) { |
|
937 | - $requireMax = $appInfo['dependencies']['owncloud']['@attributes']['max-version']; |
|
938 | - } else if (isset($appInfo['requiremax'])) { |
|
939 | - $requireMax = $appInfo['requiremax']; |
|
940 | - } |
|
941 | - |
|
942 | - if (is_array($ocVersion)) { |
|
943 | - $ocVersion = implode('.', $ocVersion); |
|
944 | - } |
|
945 | - |
|
946 | - if (!empty($requireMin) |
|
947 | - && version_compare(self::adjustVersionParts($ocVersion, $requireMin), $requireMin, '<') |
|
948 | - ) { |
|
949 | - |
|
950 | - return false; |
|
951 | - } |
|
952 | - |
|
953 | - if (!empty($requireMax) |
|
954 | - && version_compare(self::adjustVersionParts($ocVersion, $requireMax), $requireMax, '>') |
|
955 | - ) { |
|
956 | - return false; |
|
957 | - } |
|
958 | - |
|
959 | - return true; |
|
960 | - } |
|
961 | - |
|
962 | - /** |
|
963 | - * get the installed version of all apps |
|
964 | - */ |
|
965 | - public static function getAppVersions() { |
|
966 | - static $versions; |
|
967 | - |
|
968 | - if(!$versions) { |
|
969 | - $appConfig = \OC::$server->getAppConfig(); |
|
970 | - $versions = $appConfig->getValues(false, 'installed_version'); |
|
971 | - } |
|
972 | - return $versions; |
|
973 | - } |
|
974 | - |
|
975 | - /** |
|
976 | - * @param string $app |
|
977 | - * @param \OCP\IConfig $config |
|
978 | - * @param \OCP\IL10N $l |
|
979 | - * @return bool |
|
980 | - * |
|
981 | - * @throws Exception if app is not compatible with this version of ownCloud |
|
982 | - * @throws Exception if no app-name was specified |
|
983 | - */ |
|
984 | - public function installApp($app, |
|
985 | - \OCP\IConfig $config, |
|
986 | - \OCP\IL10N $l) { |
|
987 | - if ($app !== false) { |
|
988 | - // check if the app is compatible with this version of ownCloud |
|
989 | - $info = self::getAppInfo($app); |
|
990 | - if(!is_array($info)) { |
|
991 | - throw new \Exception( |
|
992 | - $l->t('App "%s" cannot be installed because appinfo file cannot be read.', |
|
993 | - [$info['name']] |
|
994 | - ) |
|
995 | - ); |
|
996 | - } |
|
997 | - |
|
998 | - $version = \OCP\Util::getVersion(); |
|
999 | - if (!self::isAppCompatible($version, $info)) { |
|
1000 | - throw new \Exception( |
|
1001 | - $l->t('App "%s" cannot be installed because it is not compatible with this version of the server.', |
|
1002 | - array($info['name']) |
|
1003 | - ) |
|
1004 | - ); |
|
1005 | - } |
|
1006 | - |
|
1007 | - // check for required dependencies |
|
1008 | - self::checkAppDependencies($config, $l, $info); |
|
1009 | - |
|
1010 | - $config->setAppValue($app, 'enabled', 'yes'); |
|
1011 | - if (isset($appData['id'])) { |
|
1012 | - $config->setAppValue($app, 'ocsid', $appData['id']); |
|
1013 | - } |
|
1014 | - |
|
1015 | - if(isset($info['settings']) && is_array($info['settings'])) { |
|
1016 | - $appPath = self::getAppPath($app); |
|
1017 | - self::registerAutoloading($app, $appPath); |
|
1018 | - \OC::$server->getSettingsManager()->setupSettings($info['settings']); |
|
1019 | - } |
|
1020 | - |
|
1021 | - \OC_Hook::emit('OC_App', 'post_enable', array('app' => $app)); |
|
1022 | - } else { |
|
1023 | - if(empty($appName) ) { |
|
1024 | - throw new \Exception($l->t("No app name specified")); |
|
1025 | - } else { |
|
1026 | - throw new \Exception($l->t("App '%s' could not be installed!", $appName)); |
|
1027 | - } |
|
1028 | - } |
|
1029 | - |
|
1030 | - return $app; |
|
1031 | - } |
|
1032 | - |
|
1033 | - /** |
|
1034 | - * update the database for the app and call the update script |
|
1035 | - * |
|
1036 | - * @param string $appId |
|
1037 | - * @return bool |
|
1038 | - */ |
|
1039 | - public static function updateApp($appId) { |
|
1040 | - $appPath = self::getAppPath($appId); |
|
1041 | - if($appPath === false) { |
|
1042 | - return false; |
|
1043 | - } |
|
1044 | - $appData = self::getAppInfo($appId); |
|
1045 | - self::executeRepairSteps($appId, $appData['repair-steps']['pre-migration']); |
|
1046 | - if (file_exists($appPath . '/appinfo/database.xml')) { |
|
1047 | - OC_DB::updateDbFromStructure($appPath . '/appinfo/database.xml'); |
|
1048 | - } |
|
1049 | - self::executeRepairSteps($appId, $appData['repair-steps']['post-migration']); |
|
1050 | - self::setupLiveMigrations($appId, $appData['repair-steps']['live-migration']); |
|
1051 | - unset(self::$appVersion[$appId]); |
|
1052 | - // run upgrade code |
|
1053 | - if (file_exists($appPath . '/appinfo/update.php')) { |
|
1054 | - self::loadApp($appId); |
|
1055 | - include $appPath . '/appinfo/update.php'; |
|
1056 | - } |
|
1057 | - self::registerAutoloading($appId, $appPath); |
|
1058 | - self::setupBackgroundJobs($appData['background-jobs']); |
|
1059 | - if(isset($appData['settings']) && is_array($appData['settings'])) { |
|
1060 | - \OC::$server->getSettingsManager()->setupSettings($appData['settings']); |
|
1061 | - } |
|
1062 | - |
|
1063 | - //set remote/public handlers |
|
1064 | - if (array_key_exists('ocsid', $appData)) { |
|
1065 | - \OC::$server->getConfig()->setAppValue($appId, 'ocsid', $appData['ocsid']); |
|
1066 | - } elseif(\OC::$server->getConfig()->getAppValue($appId, 'ocsid', null) !== null) { |
|
1067 | - \OC::$server->getConfig()->deleteAppValue($appId, 'ocsid'); |
|
1068 | - } |
|
1069 | - foreach ($appData['remote'] as $name => $path) { |
|
1070 | - \OC::$server->getConfig()->setAppValue('core', 'remote_' . $name, $appId . '/' . $path); |
|
1071 | - } |
|
1072 | - foreach ($appData['public'] as $name => $path) { |
|
1073 | - \OC::$server->getConfig()->setAppValue('core', 'public_' . $name, $appId . '/' . $path); |
|
1074 | - } |
|
1075 | - |
|
1076 | - self::setAppTypes($appId); |
|
1077 | - |
|
1078 | - $version = \OC_App::getAppVersion($appId); |
|
1079 | - \OC::$server->getAppConfig()->setValue($appId, 'installed_version', $version); |
|
1080 | - |
|
1081 | - \OC::$server->getEventDispatcher()->dispatch(ManagerEvent::EVENT_APP_UPDATE, new ManagerEvent( |
|
1082 | - ManagerEvent::EVENT_APP_UPDATE, $appId |
|
1083 | - )); |
|
1084 | - |
|
1085 | - return true; |
|
1086 | - } |
|
1087 | - |
|
1088 | - /** |
|
1089 | - * @param string $appId |
|
1090 | - * @param string[] $steps |
|
1091 | - * @throws \OC\NeedsUpdateException |
|
1092 | - */ |
|
1093 | - public static function executeRepairSteps($appId, array $steps) { |
|
1094 | - if (empty($steps)) { |
|
1095 | - return; |
|
1096 | - } |
|
1097 | - // load the app |
|
1098 | - self::loadApp($appId); |
|
1099 | - |
|
1100 | - $dispatcher = OC::$server->getEventDispatcher(); |
|
1101 | - |
|
1102 | - // load the steps |
|
1103 | - $r = new Repair([], $dispatcher); |
|
1104 | - foreach ($steps as $step) { |
|
1105 | - try { |
|
1106 | - $r->addStep($step); |
|
1107 | - } catch (Exception $ex) { |
|
1108 | - $r->emit('\OC\Repair', 'error', [$ex->getMessage()]); |
|
1109 | - \OC::$server->getLogger()->logException($ex); |
|
1110 | - } |
|
1111 | - } |
|
1112 | - // run the steps |
|
1113 | - $r->run(); |
|
1114 | - } |
|
1115 | - |
|
1116 | - public static function setupBackgroundJobs(array $jobs) { |
|
1117 | - $queue = \OC::$server->getJobList(); |
|
1118 | - foreach ($jobs as $job) { |
|
1119 | - $queue->add($job); |
|
1120 | - } |
|
1121 | - } |
|
1122 | - |
|
1123 | - /** |
|
1124 | - * @param string $appId |
|
1125 | - * @param string[] $steps |
|
1126 | - */ |
|
1127 | - private static function setupLiveMigrations($appId, array $steps) { |
|
1128 | - $queue = \OC::$server->getJobList(); |
|
1129 | - foreach ($steps as $step) { |
|
1130 | - $queue->add('OC\Migration\BackgroundRepair', [ |
|
1131 | - 'app' => $appId, |
|
1132 | - 'step' => $step]); |
|
1133 | - } |
|
1134 | - } |
|
1135 | - |
|
1136 | - /** |
|
1137 | - * @param string $appId |
|
1138 | - * @return \OC\Files\View|false |
|
1139 | - */ |
|
1140 | - public static function getStorage($appId) { |
|
1141 | - if (OC_App::isEnabled($appId)) { //sanity check |
|
1142 | - if (\OC::$server->getUserSession()->isLoggedIn()) { |
|
1143 | - $view = new \OC\Files\View('/' . OC_User::getUser()); |
|
1144 | - if (!$view->file_exists($appId)) { |
|
1145 | - $view->mkdir($appId); |
|
1146 | - } |
|
1147 | - return new \OC\Files\View('/' . OC_User::getUser() . '/' . $appId); |
|
1148 | - } else { |
|
1149 | - \OCP\Util::writeLog('core', 'Can\'t get app storage, app ' . $appId . ', user not logged in', \OCP\Util::ERROR); |
|
1150 | - return false; |
|
1151 | - } |
|
1152 | - } else { |
|
1153 | - \OCP\Util::writeLog('core', 'Can\'t get app storage, app ' . $appId . ' not enabled', \OCP\Util::ERROR); |
|
1154 | - return false; |
|
1155 | - } |
|
1156 | - } |
|
1157 | - |
|
1158 | - protected static function findBestL10NOption($options, $lang) { |
|
1159 | - $fallback = $similarLangFallback = $englishFallback = false; |
|
1160 | - |
|
1161 | - $lang = strtolower($lang); |
|
1162 | - $similarLang = $lang; |
|
1163 | - if (strpos($similarLang, '_')) { |
|
1164 | - // For "de_DE" we want to find "de" and the other way around |
|
1165 | - $similarLang = substr($lang, 0, strpos($lang, '_')); |
|
1166 | - } |
|
1167 | - |
|
1168 | - foreach ($options as $option) { |
|
1169 | - if (is_array($option)) { |
|
1170 | - if ($fallback === false) { |
|
1171 | - $fallback = $option['@value']; |
|
1172 | - } |
|
1173 | - |
|
1174 | - if (!isset($option['@attributes']['lang'])) { |
|
1175 | - continue; |
|
1176 | - } |
|
1177 | - |
|
1178 | - $attributeLang = strtolower($option['@attributes']['lang']); |
|
1179 | - if ($attributeLang === $lang) { |
|
1180 | - return $option['@value']; |
|
1181 | - } |
|
1182 | - |
|
1183 | - if ($attributeLang === $similarLang) { |
|
1184 | - $similarLangFallback = $option['@value']; |
|
1185 | - } else if (strpos($attributeLang, $similarLang . '_') === 0) { |
|
1186 | - if ($similarLangFallback === false) { |
|
1187 | - $similarLangFallback = $option['@value']; |
|
1188 | - } |
|
1189 | - } |
|
1190 | - } else { |
|
1191 | - $englishFallback = $option; |
|
1192 | - } |
|
1193 | - } |
|
1194 | - |
|
1195 | - if ($similarLangFallback !== false) { |
|
1196 | - return $similarLangFallback; |
|
1197 | - } else if ($englishFallback !== false) { |
|
1198 | - return $englishFallback; |
|
1199 | - } |
|
1200 | - return (string) $fallback; |
|
1201 | - } |
|
1202 | - |
|
1203 | - /** |
|
1204 | - * parses the app data array and enhanced the 'description' value |
|
1205 | - * |
|
1206 | - * @param array $data the app data |
|
1207 | - * @param string $lang |
|
1208 | - * @return array improved app data |
|
1209 | - */ |
|
1210 | - public static function parseAppInfo(array $data, $lang = null) { |
|
1211 | - |
|
1212 | - if ($lang && isset($data['name']) && is_array($data['name'])) { |
|
1213 | - $data['name'] = self::findBestL10NOption($data['name'], $lang); |
|
1214 | - } |
|
1215 | - if ($lang && isset($data['summary']) && is_array($data['summary'])) { |
|
1216 | - $data['summary'] = self::findBestL10NOption($data['summary'], $lang); |
|
1217 | - } |
|
1218 | - if ($lang && isset($data['description']) && is_array($data['description'])) { |
|
1219 | - $data['description'] = trim(self::findBestL10NOption($data['description'], $lang)); |
|
1220 | - } else if (isset($data['description']) && is_string($data['description'])) { |
|
1221 | - $data['description'] = trim($data['description']); |
|
1222 | - } else { |
|
1223 | - $data['description'] = ''; |
|
1224 | - } |
|
1225 | - |
|
1226 | - return $data; |
|
1227 | - } |
|
1228 | - |
|
1229 | - /** |
|
1230 | - * @param \OCP\IConfig $config |
|
1231 | - * @param \OCP\IL10N $l |
|
1232 | - * @param array $info |
|
1233 | - * @throws \Exception |
|
1234 | - */ |
|
1235 | - public static function checkAppDependencies($config, $l, $info) { |
|
1236 | - $dependencyAnalyzer = new DependencyAnalyzer(new Platform($config), $l); |
|
1237 | - $missing = $dependencyAnalyzer->analyze($info); |
|
1238 | - if (!empty($missing)) { |
|
1239 | - $missingMsg = join(PHP_EOL, $missing); |
|
1240 | - throw new \Exception( |
|
1241 | - $l->t('App "%s" cannot be installed because the following dependencies are not fulfilled: %s', |
|
1242 | - [$info['name'], $missingMsg] |
|
1243 | - ) |
|
1244 | - ); |
|
1245 | - } |
|
1246 | - } |
|
63 | + static private $appVersion = []; |
|
64 | + static private $adminForms = array(); |
|
65 | + static private $personalForms = array(); |
|
66 | + static private $appInfo = array(); |
|
67 | + static private $appTypes = array(); |
|
68 | + static private $loadedApps = array(); |
|
69 | + static private $altLogin = array(); |
|
70 | + static private $alreadyRegistered = []; |
|
71 | + const officialApp = 200; |
|
72 | + |
|
73 | + /** |
|
74 | + * clean the appId |
|
75 | + * |
|
76 | + * @param string|boolean $app AppId that needs to be cleaned |
|
77 | + * @return string |
|
78 | + */ |
|
79 | + public static function cleanAppId($app) { |
|
80 | + return str_replace(array('\0', '/', '\\', '..'), '', $app); |
|
81 | + } |
|
82 | + |
|
83 | + /** |
|
84 | + * Check if an app is loaded |
|
85 | + * |
|
86 | + * @param string $app |
|
87 | + * @return bool |
|
88 | + */ |
|
89 | + public static function isAppLoaded($app) { |
|
90 | + return in_array($app, self::$loadedApps, true); |
|
91 | + } |
|
92 | + |
|
93 | + /** |
|
94 | + * loads all apps |
|
95 | + * |
|
96 | + * @param string[] | string | null $types |
|
97 | + * @return bool |
|
98 | + * |
|
99 | + * This function walks through the ownCloud directory and loads all apps |
|
100 | + * it can find. A directory contains an app if the file /appinfo/info.xml |
|
101 | + * exists. |
|
102 | + * |
|
103 | + * if $types is set, only apps of those types will be loaded |
|
104 | + */ |
|
105 | + public static function loadApps($types = null) { |
|
106 | + if (\OC::$server->getSystemConfig()->getValue('maintenance', false)) { |
|
107 | + return false; |
|
108 | + } |
|
109 | + // Load the enabled apps here |
|
110 | + $apps = self::getEnabledApps(); |
|
111 | + |
|
112 | + // Add each apps' folder as allowed class path |
|
113 | + foreach($apps as $app) { |
|
114 | + $path = self::getAppPath($app); |
|
115 | + if($path !== false) { |
|
116 | + self::registerAutoloading($app, $path); |
|
117 | + } |
|
118 | + } |
|
119 | + |
|
120 | + // prevent app.php from printing output |
|
121 | + ob_start(); |
|
122 | + foreach ($apps as $app) { |
|
123 | + if ((is_null($types) or self::isType($app, $types)) && !in_array($app, self::$loadedApps)) { |
|
124 | + self::loadApp($app); |
|
125 | + } |
|
126 | + } |
|
127 | + ob_end_clean(); |
|
128 | + |
|
129 | + return true; |
|
130 | + } |
|
131 | + |
|
132 | + /** |
|
133 | + * load a single app |
|
134 | + * |
|
135 | + * @param string $app |
|
136 | + */ |
|
137 | + public static function loadApp($app) { |
|
138 | + self::$loadedApps[] = $app; |
|
139 | + $appPath = self::getAppPath($app); |
|
140 | + if($appPath === false) { |
|
141 | + return; |
|
142 | + } |
|
143 | + |
|
144 | + // in case someone calls loadApp() directly |
|
145 | + self::registerAutoloading($app, $appPath); |
|
146 | + |
|
147 | + if (is_file($appPath . '/appinfo/app.php')) { |
|
148 | + \OC::$server->getEventLogger()->start('load_app_' . $app, 'Load app: ' . $app); |
|
149 | + self::requireAppFile($app); |
|
150 | + if (self::isType($app, array('authentication'))) { |
|
151 | + // since authentication apps affect the "is app enabled for group" check, |
|
152 | + // the enabled apps cache needs to be cleared to make sure that the |
|
153 | + // next time getEnableApps() is called it will also include apps that were |
|
154 | + // enabled for groups |
|
155 | + self::$enabledAppsCache = array(); |
|
156 | + } |
|
157 | + \OC::$server->getEventLogger()->end('load_app_' . $app); |
|
158 | + } |
|
159 | + |
|
160 | + $info = self::getAppInfo($app); |
|
161 | + if (!empty($info['activity']['filters'])) { |
|
162 | + foreach ($info['activity']['filters'] as $filter) { |
|
163 | + \OC::$server->getActivityManager()->registerFilter($filter); |
|
164 | + } |
|
165 | + } |
|
166 | + if (!empty($info['activity']['settings'])) { |
|
167 | + foreach ($info['activity']['settings'] as $setting) { |
|
168 | + \OC::$server->getActivityManager()->registerSetting($setting); |
|
169 | + } |
|
170 | + } |
|
171 | + if (!empty($info['activity']['providers'])) { |
|
172 | + foreach ($info['activity']['providers'] as $provider) { |
|
173 | + \OC::$server->getActivityManager()->registerProvider($provider); |
|
174 | + } |
|
175 | + } |
|
176 | + } |
|
177 | + |
|
178 | + /** |
|
179 | + * @internal |
|
180 | + * @param string $app |
|
181 | + * @param string $path |
|
182 | + */ |
|
183 | + public static function registerAutoloading($app, $path) { |
|
184 | + $key = $app . '-' . $path; |
|
185 | + if(isset(self::$alreadyRegistered[$key])) { |
|
186 | + return; |
|
187 | + } |
|
188 | + self::$alreadyRegistered[$key] = true; |
|
189 | + // Register on PSR-4 composer autoloader |
|
190 | + $appNamespace = \OC\AppFramework\App::buildAppNamespace($app); |
|
191 | + \OC::$server->registerNamespace($app, $appNamespace); |
|
192 | + \OC::$composerAutoloader->addPsr4($appNamespace . '\\', $path . '/lib/', true); |
|
193 | + if (defined('PHPUNIT_RUN') || defined('CLI_TEST_RUN')) { |
|
194 | + \OC::$composerAutoloader->addPsr4($appNamespace . '\\Tests\\', $path . '/tests/', true); |
|
195 | + } |
|
196 | + |
|
197 | + // Register on legacy autoloader |
|
198 | + \OC::$loader->addValidRoot($path); |
|
199 | + } |
|
200 | + |
|
201 | + /** |
|
202 | + * Load app.php from the given app |
|
203 | + * |
|
204 | + * @param string $app app name |
|
205 | + */ |
|
206 | + private static function requireAppFile($app) { |
|
207 | + try { |
|
208 | + // encapsulated here to avoid variable scope conflicts |
|
209 | + require_once $app . '/appinfo/app.php'; |
|
210 | + } catch (Error $ex) { |
|
211 | + \OC::$server->getLogger()->logException($ex); |
|
212 | + $blacklist = \OC::$server->getAppManager()->getAlwaysEnabledApps(); |
|
213 | + if (!in_array($app, $blacklist)) { |
|
214 | + self::disable($app); |
|
215 | + } |
|
216 | + } |
|
217 | + } |
|
218 | + |
|
219 | + /** |
|
220 | + * check if an app is of a specific type |
|
221 | + * |
|
222 | + * @param string $app |
|
223 | + * @param string|array $types |
|
224 | + * @return bool |
|
225 | + */ |
|
226 | + public static function isType($app, $types) { |
|
227 | + if (is_string($types)) { |
|
228 | + $types = array($types); |
|
229 | + } |
|
230 | + $appTypes = self::getAppTypes($app); |
|
231 | + foreach ($types as $type) { |
|
232 | + if (array_search($type, $appTypes) !== false) { |
|
233 | + return true; |
|
234 | + } |
|
235 | + } |
|
236 | + return false; |
|
237 | + } |
|
238 | + |
|
239 | + /** |
|
240 | + * get the types of an app |
|
241 | + * |
|
242 | + * @param string $app |
|
243 | + * @return array |
|
244 | + */ |
|
245 | + private static function getAppTypes($app) { |
|
246 | + //load the cache |
|
247 | + if (count(self::$appTypes) == 0) { |
|
248 | + self::$appTypes = \OC::$server->getAppConfig()->getValues(false, 'types'); |
|
249 | + } |
|
250 | + |
|
251 | + if (isset(self::$appTypes[$app])) { |
|
252 | + return explode(',', self::$appTypes[$app]); |
|
253 | + } else { |
|
254 | + return array(); |
|
255 | + } |
|
256 | + } |
|
257 | + |
|
258 | + /** |
|
259 | + * read app types from info.xml and cache them in the database |
|
260 | + */ |
|
261 | + public static function setAppTypes($app) { |
|
262 | + $appData = self::getAppInfo($app); |
|
263 | + if(!is_array($appData)) { |
|
264 | + return; |
|
265 | + } |
|
266 | + |
|
267 | + if (isset($appData['types'])) { |
|
268 | + $appTypes = implode(',', $appData['types']); |
|
269 | + } else { |
|
270 | + $appTypes = ''; |
|
271 | + $appData['types'] = []; |
|
272 | + } |
|
273 | + |
|
274 | + \OC::$server->getAppConfig()->setValue($app, 'types', $appTypes); |
|
275 | + |
|
276 | + if (\OC::$server->getAppManager()->hasProtectedAppType($appData['types'])) { |
|
277 | + $enabled = \OC::$server->getAppConfig()->getValue($app, 'enabled', 'yes'); |
|
278 | + if ($enabled !== 'yes' && $enabled !== 'no') { |
|
279 | + \OC::$server->getAppConfig()->setValue($app, 'enabled', 'yes'); |
|
280 | + } |
|
281 | + } |
|
282 | + } |
|
283 | + |
|
284 | + /** |
|
285 | + * check if app is shipped |
|
286 | + * |
|
287 | + * @param string $appId the id of the app to check |
|
288 | + * @return bool |
|
289 | + * |
|
290 | + * Check if an app that is installed is a shipped app or installed from the appstore. |
|
291 | + */ |
|
292 | + public static function isShipped($appId) { |
|
293 | + return \OC::$server->getAppManager()->isShipped($appId); |
|
294 | + } |
|
295 | + |
|
296 | + /** |
|
297 | + * get all enabled apps |
|
298 | + */ |
|
299 | + protected static $enabledAppsCache = array(); |
|
300 | + |
|
301 | + /** |
|
302 | + * Returns apps enabled for the current user. |
|
303 | + * |
|
304 | + * @param bool $forceRefresh whether to refresh the cache |
|
305 | + * @param bool $all whether to return apps for all users, not only the |
|
306 | + * currently logged in one |
|
307 | + * @return string[] |
|
308 | + */ |
|
309 | + public static function getEnabledApps($forceRefresh = false, $all = false) { |
|
310 | + if (!\OC::$server->getSystemConfig()->getValue('installed', false)) { |
|
311 | + return array(); |
|
312 | + } |
|
313 | + // in incognito mode or when logged out, $user will be false, |
|
314 | + // which is also the case during an upgrade |
|
315 | + $appManager = \OC::$server->getAppManager(); |
|
316 | + if ($all) { |
|
317 | + $user = null; |
|
318 | + } else { |
|
319 | + $user = \OC::$server->getUserSession()->getUser(); |
|
320 | + } |
|
321 | + |
|
322 | + if (is_null($user)) { |
|
323 | + $apps = $appManager->getInstalledApps(); |
|
324 | + } else { |
|
325 | + $apps = $appManager->getEnabledAppsForUser($user); |
|
326 | + } |
|
327 | + $apps = array_filter($apps, function ($app) { |
|
328 | + return $app !== 'files';//we add this manually |
|
329 | + }); |
|
330 | + sort($apps); |
|
331 | + array_unshift($apps, 'files'); |
|
332 | + return $apps; |
|
333 | + } |
|
334 | + |
|
335 | + /** |
|
336 | + * checks whether or not an app is enabled |
|
337 | + * |
|
338 | + * @param string $app app |
|
339 | + * @return bool |
|
340 | + * |
|
341 | + * This function checks whether or not an app is enabled. |
|
342 | + */ |
|
343 | + public static function isEnabled($app) { |
|
344 | + return \OC::$server->getAppManager()->isEnabledForUser($app); |
|
345 | + } |
|
346 | + |
|
347 | + /** |
|
348 | + * enables an app |
|
349 | + * |
|
350 | + * @param string $appId |
|
351 | + * @param array $groups (optional) when set, only these groups will have access to the app |
|
352 | + * @throws \Exception |
|
353 | + * @return void |
|
354 | + * |
|
355 | + * This function set an app as enabled in appconfig. |
|
356 | + */ |
|
357 | + public function enable($appId, |
|
358 | + $groups = null) { |
|
359 | + self::$enabledAppsCache = []; // flush |
|
360 | + |
|
361 | + // Check if app is already downloaded |
|
362 | + $installer = new Installer( |
|
363 | + \OC::$server->getAppFetcher(), |
|
364 | + \OC::$server->getHTTPClientService(), |
|
365 | + \OC::$server->getTempManager(), |
|
366 | + \OC::$server->getLogger(), |
|
367 | + \OC::$server->getConfig() |
|
368 | + ); |
|
369 | + $isDownloaded = $installer->isDownloaded($appId); |
|
370 | + |
|
371 | + if(!$isDownloaded) { |
|
372 | + $installer->downloadApp($appId); |
|
373 | + } |
|
374 | + |
|
375 | + $installer->installApp($appId); |
|
376 | + |
|
377 | + $appManager = \OC::$server->getAppManager(); |
|
378 | + if (!is_null($groups)) { |
|
379 | + $groupManager = \OC::$server->getGroupManager(); |
|
380 | + $groupsList = []; |
|
381 | + foreach ($groups as $group) { |
|
382 | + $groupItem = $groupManager->get($group); |
|
383 | + if ($groupItem instanceof \OCP\IGroup) { |
|
384 | + $groupsList[] = $groupManager->get($group); |
|
385 | + } |
|
386 | + } |
|
387 | + $appManager->enableAppForGroups($appId, $groupsList); |
|
388 | + } else { |
|
389 | + $appManager->enableApp($appId); |
|
390 | + } |
|
391 | + } |
|
392 | + |
|
393 | + /** |
|
394 | + * @param string $app |
|
395 | + * @return bool |
|
396 | + */ |
|
397 | + public static function removeApp($app) { |
|
398 | + if (self::isShipped($app)) { |
|
399 | + return false; |
|
400 | + } |
|
401 | + |
|
402 | + $installer = new Installer( |
|
403 | + \OC::$server->getAppFetcher(), |
|
404 | + \OC::$server->getHTTPClientService(), |
|
405 | + \OC::$server->getTempManager(), |
|
406 | + \OC::$server->getLogger(), |
|
407 | + \OC::$server->getConfig() |
|
408 | + ); |
|
409 | + return $installer->removeApp($app); |
|
410 | + } |
|
411 | + |
|
412 | + /** |
|
413 | + * This function set an app as disabled in appconfig. |
|
414 | + * |
|
415 | + * @param string $app app |
|
416 | + * @throws Exception |
|
417 | + */ |
|
418 | + public static function disable($app) { |
|
419 | + // flush |
|
420 | + self::$enabledAppsCache = array(); |
|
421 | + |
|
422 | + // run uninstall steps |
|
423 | + $appData = OC_App::getAppInfo($app); |
|
424 | + if (!is_null($appData)) { |
|
425 | + OC_App::executeRepairSteps($app, $appData['repair-steps']['uninstall']); |
|
426 | + } |
|
427 | + |
|
428 | + // emit disable hook - needed anymore ? |
|
429 | + \OC_Hook::emit('OC_App', 'pre_disable', array('app' => $app)); |
|
430 | + |
|
431 | + // finally disable it |
|
432 | + $appManager = \OC::$server->getAppManager(); |
|
433 | + $appManager->disableApp($app); |
|
434 | + } |
|
435 | + |
|
436 | + // This is private as well. It simply works, so don't ask for more details |
|
437 | + private static function proceedNavigation($list) { |
|
438 | + usort($list, function($a, $b) { |
|
439 | + if (isset($a['order']) && isset($b['order'])) { |
|
440 | + return ($a['order'] < $b['order']) ? -1 : 1; |
|
441 | + } else if (isset($a['order']) || isset($b['order'])) { |
|
442 | + return isset($a['order']) ? -1 : 1; |
|
443 | + } else { |
|
444 | + return ($a['name'] < $b['name']) ? -1 : 1; |
|
445 | + } |
|
446 | + }); |
|
447 | + |
|
448 | + $activeApp = OC::$server->getNavigationManager()->getActiveEntry(); |
|
449 | + foreach ($list as $index => &$navEntry) { |
|
450 | + if ($navEntry['id'] == $activeApp) { |
|
451 | + $navEntry['active'] = true; |
|
452 | + } else { |
|
453 | + $navEntry['active'] = false; |
|
454 | + } |
|
455 | + } |
|
456 | + unset($navEntry); |
|
457 | + |
|
458 | + return $list; |
|
459 | + } |
|
460 | + |
|
461 | + /** |
|
462 | + * Get the path where to install apps |
|
463 | + * |
|
464 | + * @return string|false |
|
465 | + */ |
|
466 | + public static function getInstallPath() { |
|
467 | + if (\OC::$server->getSystemConfig()->getValue('appstoreenabled', true) == false) { |
|
468 | + return false; |
|
469 | + } |
|
470 | + |
|
471 | + foreach (OC::$APPSROOTS as $dir) { |
|
472 | + if (isset($dir['writable']) && $dir['writable'] === true) { |
|
473 | + return $dir['path']; |
|
474 | + } |
|
475 | + } |
|
476 | + |
|
477 | + \OCP\Util::writeLog('core', 'No application directories are marked as writable.', \OCP\Util::ERROR); |
|
478 | + return null; |
|
479 | + } |
|
480 | + |
|
481 | + |
|
482 | + /** |
|
483 | + * search for an app in all app-directories |
|
484 | + * |
|
485 | + * @param string $appId |
|
486 | + * @return false|string |
|
487 | + */ |
|
488 | + public static function findAppInDirectories($appId) { |
|
489 | + $sanitizedAppId = self::cleanAppId($appId); |
|
490 | + if($sanitizedAppId !== $appId) { |
|
491 | + return false; |
|
492 | + } |
|
493 | + static $app_dir = array(); |
|
494 | + |
|
495 | + if (isset($app_dir[$appId])) { |
|
496 | + return $app_dir[$appId]; |
|
497 | + } |
|
498 | + |
|
499 | + $possibleApps = array(); |
|
500 | + foreach (OC::$APPSROOTS as $dir) { |
|
501 | + if (file_exists($dir['path'] . '/' . $appId)) { |
|
502 | + $possibleApps[] = $dir; |
|
503 | + } |
|
504 | + } |
|
505 | + |
|
506 | + if (empty($possibleApps)) { |
|
507 | + return false; |
|
508 | + } elseif (count($possibleApps) === 1) { |
|
509 | + $dir = array_shift($possibleApps); |
|
510 | + $app_dir[$appId] = $dir; |
|
511 | + return $dir; |
|
512 | + } else { |
|
513 | + $versionToLoad = array(); |
|
514 | + foreach ($possibleApps as $possibleApp) { |
|
515 | + $version = self::getAppVersionByPath($possibleApp['path']); |
|
516 | + if (empty($versionToLoad) || version_compare($version, $versionToLoad['version'], '>')) { |
|
517 | + $versionToLoad = array( |
|
518 | + 'dir' => $possibleApp, |
|
519 | + 'version' => $version, |
|
520 | + ); |
|
521 | + } |
|
522 | + } |
|
523 | + $app_dir[$appId] = $versionToLoad['dir']; |
|
524 | + return $versionToLoad['dir']; |
|
525 | + //TODO - write test |
|
526 | + } |
|
527 | + } |
|
528 | + |
|
529 | + /** |
|
530 | + * Get the directory for the given app. |
|
531 | + * If the app is defined in multiple directories, the first one is taken. (false if not found) |
|
532 | + * |
|
533 | + * @param string $appId |
|
534 | + * @return string|false |
|
535 | + */ |
|
536 | + public static function getAppPath($appId) { |
|
537 | + if ($appId === null || trim($appId) === '') { |
|
538 | + return false; |
|
539 | + } |
|
540 | + |
|
541 | + if (($dir = self::findAppInDirectories($appId)) != false) { |
|
542 | + return $dir['path'] . '/' . $appId; |
|
543 | + } |
|
544 | + return false; |
|
545 | + } |
|
546 | + |
|
547 | + /** |
|
548 | + * Get the path for the given app on the access |
|
549 | + * If the app is defined in multiple directories, the first one is taken. (false if not found) |
|
550 | + * |
|
551 | + * @param string $appId |
|
552 | + * @return string|false |
|
553 | + */ |
|
554 | + public static function getAppWebPath($appId) { |
|
555 | + if (($dir = self::findAppInDirectories($appId)) != false) { |
|
556 | + return OC::$WEBROOT . $dir['url'] . '/' . $appId; |
|
557 | + } |
|
558 | + return false; |
|
559 | + } |
|
560 | + |
|
561 | + /** |
|
562 | + * get the last version of the app from appinfo/info.xml |
|
563 | + * |
|
564 | + * @param string $appId |
|
565 | + * @param bool $useCache |
|
566 | + * @return string |
|
567 | + */ |
|
568 | + public static function getAppVersion($appId, $useCache = true) { |
|
569 | + if($useCache && isset(self::$appVersion[$appId])) { |
|
570 | + return self::$appVersion[$appId]; |
|
571 | + } |
|
572 | + |
|
573 | + $file = self::getAppPath($appId); |
|
574 | + self::$appVersion[$appId] = ($file !== false) ? self::getAppVersionByPath($file) : '0'; |
|
575 | + return self::$appVersion[$appId]; |
|
576 | + } |
|
577 | + |
|
578 | + /** |
|
579 | + * get app's version based on it's path |
|
580 | + * |
|
581 | + * @param string $path |
|
582 | + * @return string |
|
583 | + */ |
|
584 | + public static function getAppVersionByPath($path) { |
|
585 | + $infoFile = $path . '/appinfo/info.xml'; |
|
586 | + $appData = self::getAppInfo($infoFile, true); |
|
587 | + return isset($appData['version']) ? $appData['version'] : ''; |
|
588 | + } |
|
589 | + |
|
590 | + |
|
591 | + /** |
|
592 | + * Read all app metadata from the info.xml file |
|
593 | + * |
|
594 | + * @param string $appId id of the app or the path of the info.xml file |
|
595 | + * @param bool $path |
|
596 | + * @param string $lang |
|
597 | + * @return array|null |
|
598 | + * @note all data is read from info.xml, not just pre-defined fields |
|
599 | + */ |
|
600 | + public static function getAppInfo($appId, $path = false, $lang = null) { |
|
601 | + if ($path) { |
|
602 | + $file = $appId; |
|
603 | + } else { |
|
604 | + if ($lang === null && isset(self::$appInfo[$appId])) { |
|
605 | + return self::$appInfo[$appId]; |
|
606 | + } |
|
607 | + $appPath = self::getAppPath($appId); |
|
608 | + if($appPath === false) { |
|
609 | + return null; |
|
610 | + } |
|
611 | + $file = $appPath . '/appinfo/info.xml'; |
|
612 | + } |
|
613 | + |
|
614 | + $parser = new InfoParser(\OC::$server->getMemCacheFactory()->create('core.appinfo')); |
|
615 | + $data = $parser->parse($file); |
|
616 | + |
|
617 | + if (is_array($data)) { |
|
618 | + $data = OC_App::parseAppInfo($data, $lang); |
|
619 | + } |
|
620 | + if(isset($data['ocsid'])) { |
|
621 | + $storedId = \OC::$server->getConfig()->getAppValue($appId, 'ocsid'); |
|
622 | + if($storedId !== '' && $storedId !== $data['ocsid']) { |
|
623 | + $data['ocsid'] = $storedId; |
|
624 | + } |
|
625 | + } |
|
626 | + |
|
627 | + if ($lang === null) { |
|
628 | + self::$appInfo[$appId] = $data; |
|
629 | + } |
|
630 | + |
|
631 | + return $data; |
|
632 | + } |
|
633 | + |
|
634 | + /** |
|
635 | + * Returns the navigation |
|
636 | + * |
|
637 | + * @return array |
|
638 | + * |
|
639 | + * This function returns an array containing all entries added. The |
|
640 | + * entries are sorted by the key 'order' ascending. Additional to the keys |
|
641 | + * given for each app the following keys exist: |
|
642 | + * - active: boolean, signals if the user is on this navigation entry |
|
643 | + */ |
|
644 | + public static function getNavigation() { |
|
645 | + $entries = OC::$server->getNavigationManager()->getAll(); |
|
646 | + return self::proceedNavigation($entries); |
|
647 | + } |
|
648 | + |
|
649 | + /** |
|
650 | + * Returns the Settings Navigation |
|
651 | + * |
|
652 | + * @return string[] |
|
653 | + * |
|
654 | + * This function returns an array containing all settings pages added. The |
|
655 | + * entries are sorted by the key 'order' ascending. |
|
656 | + */ |
|
657 | + public static function getSettingsNavigation() { |
|
658 | + $entries = OC::$server->getNavigationManager()->getAll('settings'); |
|
659 | + return self::proceedNavigation($entries); |
|
660 | + } |
|
661 | + |
|
662 | + /** |
|
663 | + * get the id of loaded app |
|
664 | + * |
|
665 | + * @return string |
|
666 | + */ |
|
667 | + public static function getCurrentApp() { |
|
668 | + $request = \OC::$server->getRequest(); |
|
669 | + $script = substr($request->getScriptName(), strlen(OC::$WEBROOT) + 1); |
|
670 | + $topFolder = substr($script, 0, strpos($script, '/')); |
|
671 | + if (empty($topFolder)) { |
|
672 | + $path_info = $request->getPathInfo(); |
|
673 | + if ($path_info) { |
|
674 | + $topFolder = substr($path_info, 1, strpos($path_info, '/', 1) - 1); |
|
675 | + } |
|
676 | + } |
|
677 | + if ($topFolder == 'apps') { |
|
678 | + $length = strlen($topFolder); |
|
679 | + return substr($script, $length + 1, strpos($script, '/', $length + 1) - $length - 1); |
|
680 | + } else { |
|
681 | + return $topFolder; |
|
682 | + } |
|
683 | + } |
|
684 | + |
|
685 | + /** |
|
686 | + * @param string $type |
|
687 | + * @return array |
|
688 | + */ |
|
689 | + public static function getForms($type) { |
|
690 | + $forms = array(); |
|
691 | + switch ($type) { |
|
692 | + case 'admin': |
|
693 | + $source = self::$adminForms; |
|
694 | + break; |
|
695 | + case 'personal': |
|
696 | + $source = self::$personalForms; |
|
697 | + break; |
|
698 | + default: |
|
699 | + return array(); |
|
700 | + } |
|
701 | + foreach ($source as $form) { |
|
702 | + $forms[] = include $form; |
|
703 | + } |
|
704 | + return $forms; |
|
705 | + } |
|
706 | + |
|
707 | + /** |
|
708 | + * register an admin form to be shown |
|
709 | + * |
|
710 | + * @param string $app |
|
711 | + * @param string $page |
|
712 | + */ |
|
713 | + public static function registerAdmin($app, $page) { |
|
714 | + self::$adminForms[] = $app . '/' . $page . '.php'; |
|
715 | + } |
|
716 | + |
|
717 | + /** |
|
718 | + * register a personal form to be shown |
|
719 | + * @param string $app |
|
720 | + * @param string $page |
|
721 | + */ |
|
722 | + public static function registerPersonal($app, $page) { |
|
723 | + self::$personalForms[] = $app . '/' . $page . '.php'; |
|
724 | + } |
|
725 | + |
|
726 | + /** |
|
727 | + * @param array $entry |
|
728 | + */ |
|
729 | + public static function registerLogIn(array $entry) { |
|
730 | + self::$altLogin[] = $entry; |
|
731 | + } |
|
732 | + |
|
733 | + /** |
|
734 | + * @return array |
|
735 | + */ |
|
736 | + public static function getAlternativeLogIns() { |
|
737 | + return self::$altLogin; |
|
738 | + } |
|
739 | + |
|
740 | + /** |
|
741 | + * get a list of all apps in the apps folder |
|
742 | + * |
|
743 | + * @return array an array of app names (string IDs) |
|
744 | + * @todo: change the name of this method to getInstalledApps, which is more accurate |
|
745 | + */ |
|
746 | + public static function getAllApps() { |
|
747 | + |
|
748 | + $apps = array(); |
|
749 | + |
|
750 | + foreach (OC::$APPSROOTS as $apps_dir) { |
|
751 | + if (!is_readable($apps_dir['path'])) { |
|
752 | + \OCP\Util::writeLog('core', 'unable to read app folder : ' . $apps_dir['path'], \OCP\Util::WARN); |
|
753 | + continue; |
|
754 | + } |
|
755 | + $dh = opendir($apps_dir['path']); |
|
756 | + |
|
757 | + if (is_resource($dh)) { |
|
758 | + while (($file = readdir($dh)) !== false) { |
|
759 | + |
|
760 | + if ($file[0] != '.' and is_dir($apps_dir['path'] . '/' . $file) and is_file($apps_dir['path'] . '/' . $file . '/appinfo/info.xml')) { |
|
761 | + |
|
762 | + $apps[] = $file; |
|
763 | + } |
|
764 | + } |
|
765 | + } |
|
766 | + } |
|
767 | + |
|
768 | + return $apps; |
|
769 | + } |
|
770 | + |
|
771 | + /** |
|
772 | + * List all apps, this is used in apps.php |
|
773 | + * |
|
774 | + * @return array |
|
775 | + */ |
|
776 | + public function listAllApps() { |
|
777 | + $installedApps = OC_App::getAllApps(); |
|
778 | + |
|
779 | + //we don't want to show configuration for these |
|
780 | + $blacklist = \OC::$server->getAppManager()->getAlwaysEnabledApps(); |
|
781 | + $appList = array(); |
|
782 | + $langCode = \OC::$server->getL10N('core')->getLanguageCode(); |
|
783 | + $urlGenerator = \OC::$server->getURLGenerator(); |
|
784 | + |
|
785 | + foreach ($installedApps as $app) { |
|
786 | + if (array_search($app, $blacklist) === false) { |
|
787 | + |
|
788 | + $info = OC_App::getAppInfo($app, false, $langCode); |
|
789 | + if (!is_array($info)) { |
|
790 | + \OCP\Util::writeLog('core', 'Could not read app info file for app "' . $app . '"', \OCP\Util::ERROR); |
|
791 | + continue; |
|
792 | + } |
|
793 | + |
|
794 | + if (!isset($info['name'])) { |
|
795 | + \OCP\Util::writeLog('core', 'App id "' . $app . '" has no name in appinfo', \OCP\Util::ERROR); |
|
796 | + continue; |
|
797 | + } |
|
798 | + |
|
799 | + $enabled = \OC::$server->getAppConfig()->getValue($app, 'enabled', 'no'); |
|
800 | + $info['groups'] = null; |
|
801 | + if ($enabled === 'yes') { |
|
802 | + $active = true; |
|
803 | + } else if ($enabled === 'no') { |
|
804 | + $active = false; |
|
805 | + } else { |
|
806 | + $active = true; |
|
807 | + $info['groups'] = $enabled; |
|
808 | + } |
|
809 | + |
|
810 | + $info['active'] = $active; |
|
811 | + |
|
812 | + if (self::isShipped($app)) { |
|
813 | + $info['internal'] = true; |
|
814 | + $info['level'] = self::officialApp; |
|
815 | + $info['removable'] = false; |
|
816 | + } else { |
|
817 | + $info['internal'] = false; |
|
818 | + $info['removable'] = true; |
|
819 | + } |
|
820 | + |
|
821 | + $appPath = self::getAppPath($app); |
|
822 | + if($appPath !== false) { |
|
823 | + $appIcon = $appPath . '/img/' . $app . '.svg'; |
|
824 | + if (file_exists($appIcon)) { |
|
825 | + $info['preview'] = \OC::$server->getURLGenerator()->imagePath($app, $app . '.svg'); |
|
826 | + $info['previewAsIcon'] = true; |
|
827 | + } else { |
|
828 | + $appIcon = $appPath . '/img/app.svg'; |
|
829 | + if (file_exists($appIcon)) { |
|
830 | + $info['preview'] = \OC::$server->getURLGenerator()->imagePath($app, 'app.svg'); |
|
831 | + $info['previewAsIcon'] = true; |
|
832 | + } |
|
833 | + } |
|
834 | + } |
|
835 | + // fix documentation |
|
836 | + if (isset($info['documentation']) && is_array($info['documentation'])) { |
|
837 | + foreach ($info['documentation'] as $key => $url) { |
|
838 | + // If it is not an absolute URL we assume it is a key |
|
839 | + // i.e. admin-ldap will get converted to go.php?to=admin-ldap |
|
840 | + if (stripos($url, 'https://') !== 0 && stripos($url, 'http://') !== 0) { |
|
841 | + $url = $urlGenerator->linkToDocs($url); |
|
842 | + } |
|
843 | + |
|
844 | + $info['documentation'][$key] = $url; |
|
845 | + } |
|
846 | + } |
|
847 | + |
|
848 | + $info['version'] = OC_App::getAppVersion($app); |
|
849 | + $appList[] = $info; |
|
850 | + } |
|
851 | + } |
|
852 | + |
|
853 | + return $appList; |
|
854 | + } |
|
855 | + |
|
856 | + /** |
|
857 | + * Returns the internal app ID or false |
|
858 | + * @param string $ocsID |
|
859 | + * @return string|false |
|
860 | + */ |
|
861 | + public static function getInternalAppIdByOcs($ocsID) { |
|
862 | + if(is_numeric($ocsID)) { |
|
863 | + $idArray = \OC::$server->getAppConfig()->getValues(false, 'ocsid'); |
|
864 | + if(array_search($ocsID, $idArray)) { |
|
865 | + return array_search($ocsID, $idArray); |
|
866 | + } |
|
867 | + } |
|
868 | + return false; |
|
869 | + } |
|
870 | + |
|
871 | + public static function shouldUpgrade($app) { |
|
872 | + $versions = self::getAppVersions(); |
|
873 | + $currentVersion = OC_App::getAppVersion($app); |
|
874 | + if ($currentVersion && isset($versions[$app])) { |
|
875 | + $installedVersion = $versions[$app]; |
|
876 | + if (!version_compare($currentVersion, $installedVersion, '=')) { |
|
877 | + return true; |
|
878 | + } |
|
879 | + } |
|
880 | + return false; |
|
881 | + } |
|
882 | + |
|
883 | + /** |
|
884 | + * Adjust the number of version parts of $version1 to match |
|
885 | + * the number of version parts of $version2. |
|
886 | + * |
|
887 | + * @param string $version1 version to adjust |
|
888 | + * @param string $version2 version to take the number of parts from |
|
889 | + * @return string shortened $version1 |
|
890 | + */ |
|
891 | + private static function adjustVersionParts($version1, $version2) { |
|
892 | + $version1 = explode('.', $version1); |
|
893 | + $version2 = explode('.', $version2); |
|
894 | + // reduce $version1 to match the number of parts in $version2 |
|
895 | + while (count($version1) > count($version2)) { |
|
896 | + array_pop($version1); |
|
897 | + } |
|
898 | + // if $version1 does not have enough parts, add some |
|
899 | + while (count($version1) < count($version2)) { |
|
900 | + $version1[] = '0'; |
|
901 | + } |
|
902 | + return implode('.', $version1); |
|
903 | + } |
|
904 | + |
|
905 | + /** |
|
906 | + * Check whether the current ownCloud version matches the given |
|
907 | + * application's version requirements. |
|
908 | + * |
|
909 | + * The comparison is made based on the number of parts that the |
|
910 | + * app info version has. For example for ownCloud 6.0.3 if the |
|
911 | + * app info version is expecting version 6.0, the comparison is |
|
912 | + * made on the first two parts of the ownCloud version. |
|
913 | + * This means that it's possible to specify "requiremin" => 6 |
|
914 | + * and "requiremax" => 6 and it will still match ownCloud 6.0.3. |
|
915 | + * |
|
916 | + * @param string $ocVersion ownCloud version to check against |
|
917 | + * @param array $appInfo app info (from xml) |
|
918 | + * |
|
919 | + * @return boolean true if compatible, otherwise false |
|
920 | + */ |
|
921 | + public static function isAppCompatible($ocVersion, $appInfo) { |
|
922 | + $requireMin = ''; |
|
923 | + $requireMax = ''; |
|
924 | + if (isset($appInfo['dependencies']['nextcloud']['@attributes']['min-version'])) { |
|
925 | + $requireMin = $appInfo['dependencies']['nextcloud']['@attributes']['min-version']; |
|
926 | + } elseif (isset($appInfo['dependencies']['owncloud']['@attributes']['min-version'])) { |
|
927 | + $requireMin = $appInfo['dependencies']['owncloud']['@attributes']['min-version']; |
|
928 | + } else if (isset($appInfo['requiremin'])) { |
|
929 | + $requireMin = $appInfo['requiremin']; |
|
930 | + } else if (isset($appInfo['require'])) { |
|
931 | + $requireMin = $appInfo['require']; |
|
932 | + } |
|
933 | + |
|
934 | + if (isset($appInfo['dependencies']['nextcloud']['@attributes']['max-version'])) { |
|
935 | + $requireMax = $appInfo['dependencies']['nextcloud']['@attributes']['max-version']; |
|
936 | + } elseif (isset($appInfo['dependencies']['owncloud']['@attributes']['max-version'])) { |
|
937 | + $requireMax = $appInfo['dependencies']['owncloud']['@attributes']['max-version']; |
|
938 | + } else if (isset($appInfo['requiremax'])) { |
|
939 | + $requireMax = $appInfo['requiremax']; |
|
940 | + } |
|
941 | + |
|
942 | + if (is_array($ocVersion)) { |
|
943 | + $ocVersion = implode('.', $ocVersion); |
|
944 | + } |
|
945 | + |
|
946 | + if (!empty($requireMin) |
|
947 | + && version_compare(self::adjustVersionParts($ocVersion, $requireMin), $requireMin, '<') |
|
948 | + ) { |
|
949 | + |
|
950 | + return false; |
|
951 | + } |
|
952 | + |
|
953 | + if (!empty($requireMax) |
|
954 | + && version_compare(self::adjustVersionParts($ocVersion, $requireMax), $requireMax, '>') |
|
955 | + ) { |
|
956 | + return false; |
|
957 | + } |
|
958 | + |
|
959 | + return true; |
|
960 | + } |
|
961 | + |
|
962 | + /** |
|
963 | + * get the installed version of all apps |
|
964 | + */ |
|
965 | + public static function getAppVersions() { |
|
966 | + static $versions; |
|
967 | + |
|
968 | + if(!$versions) { |
|
969 | + $appConfig = \OC::$server->getAppConfig(); |
|
970 | + $versions = $appConfig->getValues(false, 'installed_version'); |
|
971 | + } |
|
972 | + return $versions; |
|
973 | + } |
|
974 | + |
|
975 | + /** |
|
976 | + * @param string $app |
|
977 | + * @param \OCP\IConfig $config |
|
978 | + * @param \OCP\IL10N $l |
|
979 | + * @return bool |
|
980 | + * |
|
981 | + * @throws Exception if app is not compatible with this version of ownCloud |
|
982 | + * @throws Exception if no app-name was specified |
|
983 | + */ |
|
984 | + public function installApp($app, |
|
985 | + \OCP\IConfig $config, |
|
986 | + \OCP\IL10N $l) { |
|
987 | + if ($app !== false) { |
|
988 | + // check if the app is compatible with this version of ownCloud |
|
989 | + $info = self::getAppInfo($app); |
|
990 | + if(!is_array($info)) { |
|
991 | + throw new \Exception( |
|
992 | + $l->t('App "%s" cannot be installed because appinfo file cannot be read.', |
|
993 | + [$info['name']] |
|
994 | + ) |
|
995 | + ); |
|
996 | + } |
|
997 | + |
|
998 | + $version = \OCP\Util::getVersion(); |
|
999 | + if (!self::isAppCompatible($version, $info)) { |
|
1000 | + throw new \Exception( |
|
1001 | + $l->t('App "%s" cannot be installed because it is not compatible with this version of the server.', |
|
1002 | + array($info['name']) |
|
1003 | + ) |
|
1004 | + ); |
|
1005 | + } |
|
1006 | + |
|
1007 | + // check for required dependencies |
|
1008 | + self::checkAppDependencies($config, $l, $info); |
|
1009 | + |
|
1010 | + $config->setAppValue($app, 'enabled', 'yes'); |
|
1011 | + if (isset($appData['id'])) { |
|
1012 | + $config->setAppValue($app, 'ocsid', $appData['id']); |
|
1013 | + } |
|
1014 | + |
|
1015 | + if(isset($info['settings']) && is_array($info['settings'])) { |
|
1016 | + $appPath = self::getAppPath($app); |
|
1017 | + self::registerAutoloading($app, $appPath); |
|
1018 | + \OC::$server->getSettingsManager()->setupSettings($info['settings']); |
|
1019 | + } |
|
1020 | + |
|
1021 | + \OC_Hook::emit('OC_App', 'post_enable', array('app' => $app)); |
|
1022 | + } else { |
|
1023 | + if(empty($appName) ) { |
|
1024 | + throw new \Exception($l->t("No app name specified")); |
|
1025 | + } else { |
|
1026 | + throw new \Exception($l->t("App '%s' could not be installed!", $appName)); |
|
1027 | + } |
|
1028 | + } |
|
1029 | + |
|
1030 | + return $app; |
|
1031 | + } |
|
1032 | + |
|
1033 | + /** |
|
1034 | + * update the database for the app and call the update script |
|
1035 | + * |
|
1036 | + * @param string $appId |
|
1037 | + * @return bool |
|
1038 | + */ |
|
1039 | + public static function updateApp($appId) { |
|
1040 | + $appPath = self::getAppPath($appId); |
|
1041 | + if($appPath === false) { |
|
1042 | + return false; |
|
1043 | + } |
|
1044 | + $appData = self::getAppInfo($appId); |
|
1045 | + self::executeRepairSteps($appId, $appData['repair-steps']['pre-migration']); |
|
1046 | + if (file_exists($appPath . '/appinfo/database.xml')) { |
|
1047 | + OC_DB::updateDbFromStructure($appPath . '/appinfo/database.xml'); |
|
1048 | + } |
|
1049 | + self::executeRepairSteps($appId, $appData['repair-steps']['post-migration']); |
|
1050 | + self::setupLiveMigrations($appId, $appData['repair-steps']['live-migration']); |
|
1051 | + unset(self::$appVersion[$appId]); |
|
1052 | + // run upgrade code |
|
1053 | + if (file_exists($appPath . '/appinfo/update.php')) { |
|
1054 | + self::loadApp($appId); |
|
1055 | + include $appPath . '/appinfo/update.php'; |
|
1056 | + } |
|
1057 | + self::registerAutoloading($appId, $appPath); |
|
1058 | + self::setupBackgroundJobs($appData['background-jobs']); |
|
1059 | + if(isset($appData['settings']) && is_array($appData['settings'])) { |
|
1060 | + \OC::$server->getSettingsManager()->setupSettings($appData['settings']); |
|
1061 | + } |
|
1062 | + |
|
1063 | + //set remote/public handlers |
|
1064 | + if (array_key_exists('ocsid', $appData)) { |
|
1065 | + \OC::$server->getConfig()->setAppValue($appId, 'ocsid', $appData['ocsid']); |
|
1066 | + } elseif(\OC::$server->getConfig()->getAppValue($appId, 'ocsid', null) !== null) { |
|
1067 | + \OC::$server->getConfig()->deleteAppValue($appId, 'ocsid'); |
|
1068 | + } |
|
1069 | + foreach ($appData['remote'] as $name => $path) { |
|
1070 | + \OC::$server->getConfig()->setAppValue('core', 'remote_' . $name, $appId . '/' . $path); |
|
1071 | + } |
|
1072 | + foreach ($appData['public'] as $name => $path) { |
|
1073 | + \OC::$server->getConfig()->setAppValue('core', 'public_' . $name, $appId . '/' . $path); |
|
1074 | + } |
|
1075 | + |
|
1076 | + self::setAppTypes($appId); |
|
1077 | + |
|
1078 | + $version = \OC_App::getAppVersion($appId); |
|
1079 | + \OC::$server->getAppConfig()->setValue($appId, 'installed_version', $version); |
|
1080 | + |
|
1081 | + \OC::$server->getEventDispatcher()->dispatch(ManagerEvent::EVENT_APP_UPDATE, new ManagerEvent( |
|
1082 | + ManagerEvent::EVENT_APP_UPDATE, $appId |
|
1083 | + )); |
|
1084 | + |
|
1085 | + return true; |
|
1086 | + } |
|
1087 | + |
|
1088 | + /** |
|
1089 | + * @param string $appId |
|
1090 | + * @param string[] $steps |
|
1091 | + * @throws \OC\NeedsUpdateException |
|
1092 | + */ |
|
1093 | + public static function executeRepairSteps($appId, array $steps) { |
|
1094 | + if (empty($steps)) { |
|
1095 | + return; |
|
1096 | + } |
|
1097 | + // load the app |
|
1098 | + self::loadApp($appId); |
|
1099 | + |
|
1100 | + $dispatcher = OC::$server->getEventDispatcher(); |
|
1101 | + |
|
1102 | + // load the steps |
|
1103 | + $r = new Repair([], $dispatcher); |
|
1104 | + foreach ($steps as $step) { |
|
1105 | + try { |
|
1106 | + $r->addStep($step); |
|
1107 | + } catch (Exception $ex) { |
|
1108 | + $r->emit('\OC\Repair', 'error', [$ex->getMessage()]); |
|
1109 | + \OC::$server->getLogger()->logException($ex); |
|
1110 | + } |
|
1111 | + } |
|
1112 | + // run the steps |
|
1113 | + $r->run(); |
|
1114 | + } |
|
1115 | + |
|
1116 | + public static function setupBackgroundJobs(array $jobs) { |
|
1117 | + $queue = \OC::$server->getJobList(); |
|
1118 | + foreach ($jobs as $job) { |
|
1119 | + $queue->add($job); |
|
1120 | + } |
|
1121 | + } |
|
1122 | + |
|
1123 | + /** |
|
1124 | + * @param string $appId |
|
1125 | + * @param string[] $steps |
|
1126 | + */ |
|
1127 | + private static function setupLiveMigrations($appId, array $steps) { |
|
1128 | + $queue = \OC::$server->getJobList(); |
|
1129 | + foreach ($steps as $step) { |
|
1130 | + $queue->add('OC\Migration\BackgroundRepair', [ |
|
1131 | + 'app' => $appId, |
|
1132 | + 'step' => $step]); |
|
1133 | + } |
|
1134 | + } |
|
1135 | + |
|
1136 | + /** |
|
1137 | + * @param string $appId |
|
1138 | + * @return \OC\Files\View|false |
|
1139 | + */ |
|
1140 | + public static function getStorage($appId) { |
|
1141 | + if (OC_App::isEnabled($appId)) { //sanity check |
|
1142 | + if (\OC::$server->getUserSession()->isLoggedIn()) { |
|
1143 | + $view = new \OC\Files\View('/' . OC_User::getUser()); |
|
1144 | + if (!$view->file_exists($appId)) { |
|
1145 | + $view->mkdir($appId); |
|
1146 | + } |
|
1147 | + return new \OC\Files\View('/' . OC_User::getUser() . '/' . $appId); |
|
1148 | + } else { |
|
1149 | + \OCP\Util::writeLog('core', 'Can\'t get app storage, app ' . $appId . ', user not logged in', \OCP\Util::ERROR); |
|
1150 | + return false; |
|
1151 | + } |
|
1152 | + } else { |
|
1153 | + \OCP\Util::writeLog('core', 'Can\'t get app storage, app ' . $appId . ' not enabled', \OCP\Util::ERROR); |
|
1154 | + return false; |
|
1155 | + } |
|
1156 | + } |
|
1157 | + |
|
1158 | + protected static function findBestL10NOption($options, $lang) { |
|
1159 | + $fallback = $similarLangFallback = $englishFallback = false; |
|
1160 | + |
|
1161 | + $lang = strtolower($lang); |
|
1162 | + $similarLang = $lang; |
|
1163 | + if (strpos($similarLang, '_')) { |
|
1164 | + // For "de_DE" we want to find "de" and the other way around |
|
1165 | + $similarLang = substr($lang, 0, strpos($lang, '_')); |
|
1166 | + } |
|
1167 | + |
|
1168 | + foreach ($options as $option) { |
|
1169 | + if (is_array($option)) { |
|
1170 | + if ($fallback === false) { |
|
1171 | + $fallback = $option['@value']; |
|
1172 | + } |
|
1173 | + |
|
1174 | + if (!isset($option['@attributes']['lang'])) { |
|
1175 | + continue; |
|
1176 | + } |
|
1177 | + |
|
1178 | + $attributeLang = strtolower($option['@attributes']['lang']); |
|
1179 | + if ($attributeLang === $lang) { |
|
1180 | + return $option['@value']; |
|
1181 | + } |
|
1182 | + |
|
1183 | + if ($attributeLang === $similarLang) { |
|
1184 | + $similarLangFallback = $option['@value']; |
|
1185 | + } else if (strpos($attributeLang, $similarLang . '_') === 0) { |
|
1186 | + if ($similarLangFallback === false) { |
|
1187 | + $similarLangFallback = $option['@value']; |
|
1188 | + } |
|
1189 | + } |
|
1190 | + } else { |
|
1191 | + $englishFallback = $option; |
|
1192 | + } |
|
1193 | + } |
|
1194 | + |
|
1195 | + if ($similarLangFallback !== false) { |
|
1196 | + return $similarLangFallback; |
|
1197 | + } else if ($englishFallback !== false) { |
|
1198 | + return $englishFallback; |
|
1199 | + } |
|
1200 | + return (string) $fallback; |
|
1201 | + } |
|
1202 | + |
|
1203 | + /** |
|
1204 | + * parses the app data array and enhanced the 'description' value |
|
1205 | + * |
|
1206 | + * @param array $data the app data |
|
1207 | + * @param string $lang |
|
1208 | + * @return array improved app data |
|
1209 | + */ |
|
1210 | + public static function parseAppInfo(array $data, $lang = null) { |
|
1211 | + |
|
1212 | + if ($lang && isset($data['name']) && is_array($data['name'])) { |
|
1213 | + $data['name'] = self::findBestL10NOption($data['name'], $lang); |
|
1214 | + } |
|
1215 | + if ($lang && isset($data['summary']) && is_array($data['summary'])) { |
|
1216 | + $data['summary'] = self::findBestL10NOption($data['summary'], $lang); |
|
1217 | + } |
|
1218 | + if ($lang && isset($data['description']) && is_array($data['description'])) { |
|
1219 | + $data['description'] = trim(self::findBestL10NOption($data['description'], $lang)); |
|
1220 | + } else if (isset($data['description']) && is_string($data['description'])) { |
|
1221 | + $data['description'] = trim($data['description']); |
|
1222 | + } else { |
|
1223 | + $data['description'] = ''; |
|
1224 | + } |
|
1225 | + |
|
1226 | + return $data; |
|
1227 | + } |
|
1228 | + |
|
1229 | + /** |
|
1230 | + * @param \OCP\IConfig $config |
|
1231 | + * @param \OCP\IL10N $l |
|
1232 | + * @param array $info |
|
1233 | + * @throws \Exception |
|
1234 | + */ |
|
1235 | + public static function checkAppDependencies($config, $l, $info) { |
|
1236 | + $dependencyAnalyzer = new DependencyAnalyzer(new Platform($config), $l); |
|
1237 | + $missing = $dependencyAnalyzer->analyze($info); |
|
1238 | + if (!empty($missing)) { |
|
1239 | + $missingMsg = join(PHP_EOL, $missing); |
|
1240 | + throw new \Exception( |
|
1241 | + $l->t('App "%s" cannot be installed because the following dependencies are not fulfilled: %s', |
|
1242 | + [$info['name'], $missingMsg] |
|
1243 | + ) |
|
1244 | + ); |
|
1245 | + } |
|
1246 | + } |
|
1247 | 1247 | } |
@@ -110,9 +110,9 @@ discard block |
||
110 | 110 | $apps = self::getEnabledApps(); |
111 | 111 | |
112 | 112 | // Add each apps' folder as allowed class path |
113 | - foreach($apps as $app) { |
|
113 | + foreach ($apps as $app) { |
|
114 | 114 | $path = self::getAppPath($app); |
115 | - if($path !== false) { |
|
115 | + if ($path !== false) { |
|
116 | 116 | self::registerAutoloading($app, $path); |
117 | 117 | } |
118 | 118 | } |
@@ -137,15 +137,15 @@ discard block |
||
137 | 137 | public static function loadApp($app) { |
138 | 138 | self::$loadedApps[] = $app; |
139 | 139 | $appPath = self::getAppPath($app); |
140 | - if($appPath === false) { |
|
140 | + if ($appPath === false) { |
|
141 | 141 | return; |
142 | 142 | } |
143 | 143 | |
144 | 144 | // in case someone calls loadApp() directly |
145 | 145 | self::registerAutoloading($app, $appPath); |
146 | 146 | |
147 | - if (is_file($appPath . '/appinfo/app.php')) { |
|
148 | - \OC::$server->getEventLogger()->start('load_app_' . $app, 'Load app: ' . $app); |
|
147 | + if (is_file($appPath.'/appinfo/app.php')) { |
|
148 | + \OC::$server->getEventLogger()->start('load_app_'.$app, 'Load app: '.$app); |
|
149 | 149 | self::requireAppFile($app); |
150 | 150 | if (self::isType($app, array('authentication'))) { |
151 | 151 | // since authentication apps affect the "is app enabled for group" check, |
@@ -154,7 +154,7 @@ discard block |
||
154 | 154 | // enabled for groups |
155 | 155 | self::$enabledAppsCache = array(); |
156 | 156 | } |
157 | - \OC::$server->getEventLogger()->end('load_app_' . $app); |
|
157 | + \OC::$server->getEventLogger()->end('load_app_'.$app); |
|
158 | 158 | } |
159 | 159 | |
160 | 160 | $info = self::getAppInfo($app); |
@@ -181,17 +181,17 @@ discard block |
||
181 | 181 | * @param string $path |
182 | 182 | */ |
183 | 183 | public static function registerAutoloading($app, $path) { |
184 | - $key = $app . '-' . $path; |
|
185 | - if(isset(self::$alreadyRegistered[$key])) { |
|
184 | + $key = $app.'-'.$path; |
|
185 | + if (isset(self::$alreadyRegistered[$key])) { |
|
186 | 186 | return; |
187 | 187 | } |
188 | 188 | self::$alreadyRegistered[$key] = true; |
189 | 189 | // Register on PSR-4 composer autoloader |
190 | 190 | $appNamespace = \OC\AppFramework\App::buildAppNamespace($app); |
191 | 191 | \OC::$server->registerNamespace($app, $appNamespace); |
192 | - \OC::$composerAutoloader->addPsr4($appNamespace . '\\', $path . '/lib/', true); |
|
192 | + \OC::$composerAutoloader->addPsr4($appNamespace.'\\', $path.'/lib/', true); |
|
193 | 193 | if (defined('PHPUNIT_RUN') || defined('CLI_TEST_RUN')) { |
194 | - \OC::$composerAutoloader->addPsr4($appNamespace . '\\Tests\\', $path . '/tests/', true); |
|
194 | + \OC::$composerAutoloader->addPsr4($appNamespace.'\\Tests\\', $path.'/tests/', true); |
|
195 | 195 | } |
196 | 196 | |
197 | 197 | // Register on legacy autoloader |
@@ -206,7 +206,7 @@ discard block |
||
206 | 206 | private static function requireAppFile($app) { |
207 | 207 | try { |
208 | 208 | // encapsulated here to avoid variable scope conflicts |
209 | - require_once $app . '/appinfo/app.php'; |
|
209 | + require_once $app.'/appinfo/app.php'; |
|
210 | 210 | } catch (Error $ex) { |
211 | 211 | \OC::$server->getLogger()->logException($ex); |
212 | 212 | $blacklist = \OC::$server->getAppManager()->getAlwaysEnabledApps(); |
@@ -260,7 +260,7 @@ discard block |
||
260 | 260 | */ |
261 | 261 | public static function setAppTypes($app) { |
262 | 262 | $appData = self::getAppInfo($app); |
263 | - if(!is_array($appData)) { |
|
263 | + if (!is_array($appData)) { |
|
264 | 264 | return; |
265 | 265 | } |
266 | 266 | |
@@ -324,8 +324,8 @@ discard block |
||
324 | 324 | } else { |
325 | 325 | $apps = $appManager->getEnabledAppsForUser($user); |
326 | 326 | } |
327 | - $apps = array_filter($apps, function ($app) { |
|
328 | - return $app !== 'files';//we add this manually |
|
327 | + $apps = array_filter($apps, function($app) { |
|
328 | + return $app !== 'files'; //we add this manually |
|
329 | 329 | }); |
330 | 330 | sort($apps); |
331 | 331 | array_unshift($apps, 'files'); |
@@ -368,7 +368,7 @@ discard block |
||
368 | 368 | ); |
369 | 369 | $isDownloaded = $installer->isDownloaded($appId); |
370 | 370 | |
371 | - if(!$isDownloaded) { |
|
371 | + if (!$isDownloaded) { |
|
372 | 372 | $installer->downloadApp($appId); |
373 | 373 | } |
374 | 374 | |
@@ -487,7 +487,7 @@ discard block |
||
487 | 487 | */ |
488 | 488 | public static function findAppInDirectories($appId) { |
489 | 489 | $sanitizedAppId = self::cleanAppId($appId); |
490 | - if($sanitizedAppId !== $appId) { |
|
490 | + if ($sanitizedAppId !== $appId) { |
|
491 | 491 | return false; |
492 | 492 | } |
493 | 493 | static $app_dir = array(); |
@@ -498,7 +498,7 @@ discard block |
||
498 | 498 | |
499 | 499 | $possibleApps = array(); |
500 | 500 | foreach (OC::$APPSROOTS as $dir) { |
501 | - if (file_exists($dir['path'] . '/' . $appId)) { |
|
501 | + if (file_exists($dir['path'].'/'.$appId)) { |
|
502 | 502 | $possibleApps[] = $dir; |
503 | 503 | } |
504 | 504 | } |
@@ -539,7 +539,7 @@ discard block |
||
539 | 539 | } |
540 | 540 | |
541 | 541 | if (($dir = self::findAppInDirectories($appId)) != false) { |
542 | - return $dir['path'] . '/' . $appId; |
|
542 | + return $dir['path'].'/'.$appId; |
|
543 | 543 | } |
544 | 544 | return false; |
545 | 545 | } |
@@ -553,7 +553,7 @@ discard block |
||
553 | 553 | */ |
554 | 554 | public static function getAppWebPath($appId) { |
555 | 555 | if (($dir = self::findAppInDirectories($appId)) != false) { |
556 | - return OC::$WEBROOT . $dir['url'] . '/' . $appId; |
|
556 | + return OC::$WEBROOT.$dir['url'].'/'.$appId; |
|
557 | 557 | } |
558 | 558 | return false; |
559 | 559 | } |
@@ -566,7 +566,7 @@ discard block |
||
566 | 566 | * @return string |
567 | 567 | */ |
568 | 568 | public static function getAppVersion($appId, $useCache = true) { |
569 | - if($useCache && isset(self::$appVersion[$appId])) { |
|
569 | + if ($useCache && isset(self::$appVersion[$appId])) { |
|
570 | 570 | return self::$appVersion[$appId]; |
571 | 571 | } |
572 | 572 | |
@@ -582,7 +582,7 @@ discard block |
||
582 | 582 | * @return string |
583 | 583 | */ |
584 | 584 | public static function getAppVersionByPath($path) { |
585 | - $infoFile = $path . '/appinfo/info.xml'; |
|
585 | + $infoFile = $path.'/appinfo/info.xml'; |
|
586 | 586 | $appData = self::getAppInfo($infoFile, true); |
587 | 587 | return isset($appData['version']) ? $appData['version'] : ''; |
588 | 588 | } |
@@ -605,10 +605,10 @@ discard block |
||
605 | 605 | return self::$appInfo[$appId]; |
606 | 606 | } |
607 | 607 | $appPath = self::getAppPath($appId); |
608 | - if($appPath === false) { |
|
608 | + if ($appPath === false) { |
|
609 | 609 | return null; |
610 | 610 | } |
611 | - $file = $appPath . '/appinfo/info.xml'; |
|
611 | + $file = $appPath.'/appinfo/info.xml'; |
|
612 | 612 | } |
613 | 613 | |
614 | 614 | $parser = new InfoParser(\OC::$server->getMemCacheFactory()->create('core.appinfo')); |
@@ -617,9 +617,9 @@ discard block |
||
617 | 617 | if (is_array($data)) { |
618 | 618 | $data = OC_App::parseAppInfo($data, $lang); |
619 | 619 | } |
620 | - if(isset($data['ocsid'])) { |
|
620 | + if (isset($data['ocsid'])) { |
|
621 | 621 | $storedId = \OC::$server->getConfig()->getAppValue($appId, 'ocsid'); |
622 | - if($storedId !== '' && $storedId !== $data['ocsid']) { |
|
622 | + if ($storedId !== '' && $storedId !== $data['ocsid']) { |
|
623 | 623 | $data['ocsid'] = $storedId; |
624 | 624 | } |
625 | 625 | } |
@@ -711,7 +711,7 @@ discard block |
||
711 | 711 | * @param string $page |
712 | 712 | */ |
713 | 713 | public static function registerAdmin($app, $page) { |
714 | - self::$adminForms[] = $app . '/' . $page . '.php'; |
|
714 | + self::$adminForms[] = $app.'/'.$page.'.php'; |
|
715 | 715 | } |
716 | 716 | |
717 | 717 | /** |
@@ -720,7 +720,7 @@ discard block |
||
720 | 720 | * @param string $page |
721 | 721 | */ |
722 | 722 | public static function registerPersonal($app, $page) { |
723 | - self::$personalForms[] = $app . '/' . $page . '.php'; |
|
723 | + self::$personalForms[] = $app.'/'.$page.'.php'; |
|
724 | 724 | } |
725 | 725 | |
726 | 726 | /** |
@@ -749,7 +749,7 @@ discard block |
||
749 | 749 | |
750 | 750 | foreach (OC::$APPSROOTS as $apps_dir) { |
751 | 751 | if (!is_readable($apps_dir['path'])) { |
752 | - \OCP\Util::writeLog('core', 'unable to read app folder : ' . $apps_dir['path'], \OCP\Util::WARN); |
|
752 | + \OCP\Util::writeLog('core', 'unable to read app folder : '.$apps_dir['path'], \OCP\Util::WARN); |
|
753 | 753 | continue; |
754 | 754 | } |
755 | 755 | $dh = opendir($apps_dir['path']); |
@@ -757,7 +757,7 @@ discard block |
||
757 | 757 | if (is_resource($dh)) { |
758 | 758 | while (($file = readdir($dh)) !== false) { |
759 | 759 | |
760 | - if ($file[0] != '.' and is_dir($apps_dir['path'] . '/' . $file) and is_file($apps_dir['path'] . '/' . $file . '/appinfo/info.xml')) { |
|
760 | + if ($file[0] != '.' and is_dir($apps_dir['path'].'/'.$file) and is_file($apps_dir['path'].'/'.$file.'/appinfo/info.xml')) { |
|
761 | 761 | |
762 | 762 | $apps[] = $file; |
763 | 763 | } |
@@ -787,12 +787,12 @@ discard block |
||
787 | 787 | |
788 | 788 | $info = OC_App::getAppInfo($app, false, $langCode); |
789 | 789 | if (!is_array($info)) { |
790 | - \OCP\Util::writeLog('core', 'Could not read app info file for app "' . $app . '"', \OCP\Util::ERROR); |
|
790 | + \OCP\Util::writeLog('core', 'Could not read app info file for app "'.$app.'"', \OCP\Util::ERROR); |
|
791 | 791 | continue; |
792 | 792 | } |
793 | 793 | |
794 | 794 | if (!isset($info['name'])) { |
795 | - \OCP\Util::writeLog('core', 'App id "' . $app . '" has no name in appinfo', \OCP\Util::ERROR); |
|
795 | + \OCP\Util::writeLog('core', 'App id "'.$app.'" has no name in appinfo', \OCP\Util::ERROR); |
|
796 | 796 | continue; |
797 | 797 | } |
798 | 798 | |
@@ -819,13 +819,13 @@ discard block |
||
819 | 819 | } |
820 | 820 | |
821 | 821 | $appPath = self::getAppPath($app); |
822 | - if($appPath !== false) { |
|
823 | - $appIcon = $appPath . '/img/' . $app . '.svg'; |
|
822 | + if ($appPath !== false) { |
|
823 | + $appIcon = $appPath.'/img/'.$app.'.svg'; |
|
824 | 824 | if (file_exists($appIcon)) { |
825 | - $info['preview'] = \OC::$server->getURLGenerator()->imagePath($app, $app . '.svg'); |
|
825 | + $info['preview'] = \OC::$server->getURLGenerator()->imagePath($app, $app.'.svg'); |
|
826 | 826 | $info['previewAsIcon'] = true; |
827 | 827 | } else { |
828 | - $appIcon = $appPath . '/img/app.svg'; |
|
828 | + $appIcon = $appPath.'/img/app.svg'; |
|
829 | 829 | if (file_exists($appIcon)) { |
830 | 830 | $info['preview'] = \OC::$server->getURLGenerator()->imagePath($app, 'app.svg'); |
831 | 831 | $info['previewAsIcon'] = true; |
@@ -859,9 +859,9 @@ discard block |
||
859 | 859 | * @return string|false |
860 | 860 | */ |
861 | 861 | public static function getInternalAppIdByOcs($ocsID) { |
862 | - if(is_numeric($ocsID)) { |
|
862 | + if (is_numeric($ocsID)) { |
|
863 | 863 | $idArray = \OC::$server->getAppConfig()->getValues(false, 'ocsid'); |
864 | - if(array_search($ocsID, $idArray)) { |
|
864 | + if (array_search($ocsID, $idArray)) { |
|
865 | 865 | return array_search($ocsID, $idArray); |
866 | 866 | } |
867 | 867 | } |
@@ -965,7 +965,7 @@ discard block |
||
965 | 965 | public static function getAppVersions() { |
966 | 966 | static $versions; |
967 | 967 | |
968 | - if(!$versions) { |
|
968 | + if (!$versions) { |
|
969 | 969 | $appConfig = \OC::$server->getAppConfig(); |
970 | 970 | $versions = $appConfig->getValues(false, 'installed_version'); |
971 | 971 | } |
@@ -987,7 +987,7 @@ discard block |
||
987 | 987 | if ($app !== false) { |
988 | 988 | // check if the app is compatible with this version of ownCloud |
989 | 989 | $info = self::getAppInfo($app); |
990 | - if(!is_array($info)) { |
|
990 | + if (!is_array($info)) { |
|
991 | 991 | throw new \Exception( |
992 | 992 | $l->t('App "%s" cannot be installed because appinfo file cannot be read.', |
993 | 993 | [$info['name']] |
@@ -1012,7 +1012,7 @@ discard block |
||
1012 | 1012 | $config->setAppValue($app, 'ocsid', $appData['id']); |
1013 | 1013 | } |
1014 | 1014 | |
1015 | - if(isset($info['settings']) && is_array($info['settings'])) { |
|
1015 | + if (isset($info['settings']) && is_array($info['settings'])) { |
|
1016 | 1016 | $appPath = self::getAppPath($app); |
1017 | 1017 | self::registerAutoloading($app, $appPath); |
1018 | 1018 | \OC::$server->getSettingsManager()->setupSettings($info['settings']); |
@@ -1020,7 +1020,7 @@ discard block |
||
1020 | 1020 | |
1021 | 1021 | \OC_Hook::emit('OC_App', 'post_enable', array('app' => $app)); |
1022 | 1022 | } else { |
1023 | - if(empty($appName) ) { |
|
1023 | + if (empty($appName)) { |
|
1024 | 1024 | throw new \Exception($l->t("No app name specified")); |
1025 | 1025 | } else { |
1026 | 1026 | throw new \Exception($l->t("App '%s' could not be installed!", $appName)); |
@@ -1038,39 +1038,39 @@ discard block |
||
1038 | 1038 | */ |
1039 | 1039 | public static function updateApp($appId) { |
1040 | 1040 | $appPath = self::getAppPath($appId); |
1041 | - if($appPath === false) { |
|
1041 | + if ($appPath === false) { |
|
1042 | 1042 | return false; |
1043 | 1043 | } |
1044 | 1044 | $appData = self::getAppInfo($appId); |
1045 | 1045 | self::executeRepairSteps($appId, $appData['repair-steps']['pre-migration']); |
1046 | - if (file_exists($appPath . '/appinfo/database.xml')) { |
|
1047 | - OC_DB::updateDbFromStructure($appPath . '/appinfo/database.xml'); |
|
1046 | + if (file_exists($appPath.'/appinfo/database.xml')) { |
|
1047 | + OC_DB::updateDbFromStructure($appPath.'/appinfo/database.xml'); |
|
1048 | 1048 | } |
1049 | 1049 | self::executeRepairSteps($appId, $appData['repair-steps']['post-migration']); |
1050 | 1050 | self::setupLiveMigrations($appId, $appData['repair-steps']['live-migration']); |
1051 | 1051 | unset(self::$appVersion[$appId]); |
1052 | 1052 | // run upgrade code |
1053 | - if (file_exists($appPath . '/appinfo/update.php')) { |
|
1053 | + if (file_exists($appPath.'/appinfo/update.php')) { |
|
1054 | 1054 | self::loadApp($appId); |
1055 | - include $appPath . '/appinfo/update.php'; |
|
1055 | + include $appPath.'/appinfo/update.php'; |
|
1056 | 1056 | } |
1057 | 1057 | self::registerAutoloading($appId, $appPath); |
1058 | 1058 | self::setupBackgroundJobs($appData['background-jobs']); |
1059 | - if(isset($appData['settings']) && is_array($appData['settings'])) { |
|
1059 | + if (isset($appData['settings']) && is_array($appData['settings'])) { |
|
1060 | 1060 | \OC::$server->getSettingsManager()->setupSettings($appData['settings']); |
1061 | 1061 | } |
1062 | 1062 | |
1063 | 1063 | //set remote/public handlers |
1064 | 1064 | if (array_key_exists('ocsid', $appData)) { |
1065 | 1065 | \OC::$server->getConfig()->setAppValue($appId, 'ocsid', $appData['ocsid']); |
1066 | - } elseif(\OC::$server->getConfig()->getAppValue($appId, 'ocsid', null) !== null) { |
|
1066 | + } elseif (\OC::$server->getConfig()->getAppValue($appId, 'ocsid', null) !== null) { |
|
1067 | 1067 | \OC::$server->getConfig()->deleteAppValue($appId, 'ocsid'); |
1068 | 1068 | } |
1069 | 1069 | foreach ($appData['remote'] as $name => $path) { |
1070 | - \OC::$server->getConfig()->setAppValue('core', 'remote_' . $name, $appId . '/' . $path); |
|
1070 | + \OC::$server->getConfig()->setAppValue('core', 'remote_'.$name, $appId.'/'.$path); |
|
1071 | 1071 | } |
1072 | 1072 | foreach ($appData['public'] as $name => $path) { |
1073 | - \OC::$server->getConfig()->setAppValue('core', 'public_' . $name, $appId . '/' . $path); |
|
1073 | + \OC::$server->getConfig()->setAppValue('core', 'public_'.$name, $appId.'/'.$path); |
|
1074 | 1074 | } |
1075 | 1075 | |
1076 | 1076 | self::setAppTypes($appId); |
@@ -1140,17 +1140,17 @@ discard block |
||
1140 | 1140 | public static function getStorage($appId) { |
1141 | 1141 | if (OC_App::isEnabled($appId)) { //sanity check |
1142 | 1142 | if (\OC::$server->getUserSession()->isLoggedIn()) { |
1143 | - $view = new \OC\Files\View('/' . OC_User::getUser()); |
|
1143 | + $view = new \OC\Files\View('/'.OC_User::getUser()); |
|
1144 | 1144 | if (!$view->file_exists($appId)) { |
1145 | 1145 | $view->mkdir($appId); |
1146 | 1146 | } |
1147 | - return new \OC\Files\View('/' . OC_User::getUser() . '/' . $appId); |
|
1147 | + return new \OC\Files\View('/'.OC_User::getUser().'/'.$appId); |
|
1148 | 1148 | } else { |
1149 | - \OCP\Util::writeLog('core', 'Can\'t get app storage, app ' . $appId . ', user not logged in', \OCP\Util::ERROR); |
|
1149 | + \OCP\Util::writeLog('core', 'Can\'t get app storage, app '.$appId.', user not logged in', \OCP\Util::ERROR); |
|
1150 | 1150 | return false; |
1151 | 1151 | } |
1152 | 1152 | } else { |
1153 | - \OCP\Util::writeLog('core', 'Can\'t get app storage, app ' . $appId . ' not enabled', \OCP\Util::ERROR); |
|
1153 | + \OCP\Util::writeLog('core', 'Can\'t get app storage, app '.$appId.' not enabled', \OCP\Util::ERROR); |
|
1154 | 1154 | return false; |
1155 | 1155 | } |
1156 | 1156 | } |
@@ -1182,9 +1182,9 @@ discard block |
||
1182 | 1182 | |
1183 | 1183 | if ($attributeLang === $similarLang) { |
1184 | 1184 | $similarLangFallback = $option['@value']; |
1185 | - } else if (strpos($attributeLang, $similarLang . '_') === 0) { |
|
1185 | + } else if (strpos($attributeLang, $similarLang.'_') === 0) { |
|
1186 | 1186 | if ($similarLangFallback === false) { |
1187 | - $similarLangFallback = $option['@value']; |
|
1187 | + $similarLangFallback = $option['@value']; |
|
1188 | 1188 | } |
1189 | 1189 | } |
1190 | 1190 | } else { |
@@ -1219,7 +1219,7 @@ discard block |
||
1219 | 1219 | $data['description'] = trim(self::findBestL10NOption($data['description'], $lang)); |
1220 | 1220 | } else if (isset($data['description']) && is_string($data['description'])) { |
1221 | 1221 | $data['description'] = trim($data['description']); |
1222 | - } else { |
|
1222 | + } else { |
|
1223 | 1223 | $data['description'] = ''; |
1224 | 1224 | } |
1225 | 1225 |
@@ -31,7 +31,7 @@ |
||
31 | 31 | * Creates a Folder that represents a non-existing path |
32 | 32 | * |
33 | 33 | * @param string $path path |
34 | - * @return string non-existing node class |
|
34 | + * @return NonExistingFile non-existing node class |
|
35 | 35 | */ |
36 | 36 | protected function createNonExistingNode($path) { |
37 | 37 | return new NonExistingFile($this->root, $this->view, $path); |
@@ -29,113 +29,113 @@ |
||
29 | 29 | use OCP\Files\NotPermittedException; |
30 | 30 | |
31 | 31 | class File extends Node implements \OCP\Files\File { |
32 | - /** |
|
33 | - * Creates a Folder that represents a non-existing path |
|
34 | - * |
|
35 | - * @param string $path path |
|
36 | - * @return string non-existing node class |
|
37 | - */ |
|
38 | - protected function createNonExistingNode($path) { |
|
39 | - return new NonExistingFile($this->root, $this->view, $path); |
|
40 | - } |
|
32 | + /** |
|
33 | + * Creates a Folder that represents a non-existing path |
|
34 | + * |
|
35 | + * @param string $path path |
|
36 | + * @return string non-existing node class |
|
37 | + */ |
|
38 | + protected function createNonExistingNode($path) { |
|
39 | + return new NonExistingFile($this->root, $this->view, $path); |
|
40 | + } |
|
41 | 41 | |
42 | - /** |
|
43 | - * @return string |
|
44 | - * @throws \OCP\Files\NotPermittedException |
|
45 | - */ |
|
46 | - public function getContent() { |
|
47 | - if ($this->checkPermissions(\OCP\Constants::PERMISSION_READ)) { |
|
48 | - /** |
|
49 | - * @var \OC\Files\Storage\Storage $storage; |
|
50 | - */ |
|
51 | - return $this->view->file_get_contents($this->path); |
|
52 | - } else { |
|
53 | - throw new NotPermittedException(); |
|
54 | - } |
|
55 | - } |
|
42 | + /** |
|
43 | + * @return string |
|
44 | + * @throws \OCP\Files\NotPermittedException |
|
45 | + */ |
|
46 | + public function getContent() { |
|
47 | + if ($this->checkPermissions(\OCP\Constants::PERMISSION_READ)) { |
|
48 | + /** |
|
49 | + * @var \OC\Files\Storage\Storage $storage; |
|
50 | + */ |
|
51 | + return $this->view->file_get_contents($this->path); |
|
52 | + } else { |
|
53 | + throw new NotPermittedException(); |
|
54 | + } |
|
55 | + } |
|
56 | 56 | |
57 | - /** |
|
58 | - * @param string $data |
|
59 | - * @throws \OCP\Files\NotPermittedException |
|
60 | - */ |
|
61 | - public function putContent($data) { |
|
62 | - if ($this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE)) { |
|
63 | - $this->sendHooks(array('preWrite')); |
|
64 | - $this->view->file_put_contents($this->path, $data); |
|
65 | - $this->fileInfo = null; |
|
66 | - $this->sendHooks(array('postWrite')); |
|
67 | - } else { |
|
68 | - throw new NotPermittedException(); |
|
69 | - } |
|
70 | - } |
|
57 | + /** |
|
58 | + * @param string $data |
|
59 | + * @throws \OCP\Files\NotPermittedException |
|
60 | + */ |
|
61 | + public function putContent($data) { |
|
62 | + if ($this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE)) { |
|
63 | + $this->sendHooks(array('preWrite')); |
|
64 | + $this->view->file_put_contents($this->path, $data); |
|
65 | + $this->fileInfo = null; |
|
66 | + $this->sendHooks(array('postWrite')); |
|
67 | + } else { |
|
68 | + throw new NotPermittedException(); |
|
69 | + } |
|
70 | + } |
|
71 | 71 | |
72 | - /** |
|
73 | - * @param string $mode |
|
74 | - * @return resource |
|
75 | - * @throws \OCP\Files\NotPermittedException |
|
76 | - */ |
|
77 | - public function fopen($mode) { |
|
78 | - $preHooks = array(); |
|
79 | - $postHooks = array(); |
|
80 | - $requiredPermissions = \OCP\Constants::PERMISSION_READ; |
|
81 | - switch ($mode) { |
|
82 | - case 'r+': |
|
83 | - case 'rb+': |
|
84 | - case 'w+': |
|
85 | - case 'wb+': |
|
86 | - case 'x+': |
|
87 | - case 'xb+': |
|
88 | - case 'a+': |
|
89 | - case 'ab+': |
|
90 | - case 'w': |
|
91 | - case 'wb': |
|
92 | - case 'x': |
|
93 | - case 'xb': |
|
94 | - case 'a': |
|
95 | - case 'ab': |
|
96 | - $preHooks[] = 'preWrite'; |
|
97 | - $postHooks[] = 'postWrite'; |
|
98 | - $requiredPermissions |= \OCP\Constants::PERMISSION_UPDATE; |
|
99 | - break; |
|
100 | - } |
|
72 | + /** |
|
73 | + * @param string $mode |
|
74 | + * @return resource |
|
75 | + * @throws \OCP\Files\NotPermittedException |
|
76 | + */ |
|
77 | + public function fopen($mode) { |
|
78 | + $preHooks = array(); |
|
79 | + $postHooks = array(); |
|
80 | + $requiredPermissions = \OCP\Constants::PERMISSION_READ; |
|
81 | + switch ($mode) { |
|
82 | + case 'r+': |
|
83 | + case 'rb+': |
|
84 | + case 'w+': |
|
85 | + case 'wb+': |
|
86 | + case 'x+': |
|
87 | + case 'xb+': |
|
88 | + case 'a+': |
|
89 | + case 'ab+': |
|
90 | + case 'w': |
|
91 | + case 'wb': |
|
92 | + case 'x': |
|
93 | + case 'xb': |
|
94 | + case 'a': |
|
95 | + case 'ab': |
|
96 | + $preHooks[] = 'preWrite'; |
|
97 | + $postHooks[] = 'postWrite'; |
|
98 | + $requiredPermissions |= \OCP\Constants::PERMISSION_UPDATE; |
|
99 | + break; |
|
100 | + } |
|
101 | 101 | |
102 | - if ($this->checkPermissions($requiredPermissions)) { |
|
103 | - $this->sendHooks($preHooks); |
|
104 | - $result = $this->view->fopen($this->path, $mode); |
|
105 | - $this->sendHooks($postHooks); |
|
106 | - return $result; |
|
107 | - } else { |
|
108 | - throw new NotPermittedException(); |
|
109 | - } |
|
110 | - } |
|
102 | + if ($this->checkPermissions($requiredPermissions)) { |
|
103 | + $this->sendHooks($preHooks); |
|
104 | + $result = $this->view->fopen($this->path, $mode); |
|
105 | + $this->sendHooks($postHooks); |
|
106 | + return $result; |
|
107 | + } else { |
|
108 | + throw new NotPermittedException(); |
|
109 | + } |
|
110 | + } |
|
111 | 111 | |
112 | - public function delete() { |
|
113 | - if ($this->checkPermissions(\OCP\Constants::PERMISSION_DELETE)) { |
|
114 | - $this->sendHooks(array('preDelete')); |
|
115 | - $fileInfo = $this->getFileInfo(); |
|
116 | - $this->view->unlink($this->path); |
|
117 | - $nonExisting = new NonExistingFile($this->root, $this->view, $this->path, $fileInfo); |
|
118 | - $this->root->emit('\OC\Files', 'postDelete', array($nonExisting)); |
|
119 | - $this->exists = false; |
|
120 | - $this->fileInfo = null; |
|
121 | - } else { |
|
122 | - throw new NotPermittedException(); |
|
123 | - } |
|
124 | - } |
|
112 | + public function delete() { |
|
113 | + if ($this->checkPermissions(\OCP\Constants::PERMISSION_DELETE)) { |
|
114 | + $this->sendHooks(array('preDelete')); |
|
115 | + $fileInfo = $this->getFileInfo(); |
|
116 | + $this->view->unlink($this->path); |
|
117 | + $nonExisting = new NonExistingFile($this->root, $this->view, $this->path, $fileInfo); |
|
118 | + $this->root->emit('\OC\Files', 'postDelete', array($nonExisting)); |
|
119 | + $this->exists = false; |
|
120 | + $this->fileInfo = null; |
|
121 | + } else { |
|
122 | + throw new NotPermittedException(); |
|
123 | + } |
|
124 | + } |
|
125 | 125 | |
126 | - /** |
|
127 | - * @param string $type |
|
128 | - * @param bool $raw |
|
129 | - * @return string |
|
130 | - */ |
|
131 | - public function hash($type, $raw = false) { |
|
132 | - return $this->view->hash($type, $this->path, $raw); |
|
133 | - } |
|
126 | + /** |
|
127 | + * @param string $type |
|
128 | + * @param bool $raw |
|
129 | + * @return string |
|
130 | + */ |
|
131 | + public function hash($type, $raw = false) { |
|
132 | + return $this->view->hash($type, $this->path, $raw); |
|
133 | + } |
|
134 | 134 | |
135 | - /** |
|
136 | - * @inheritdoc |
|
137 | - */ |
|
138 | - public function getChecksum() { |
|
139 | - return $this->getFileInfo()->getChecksum(); |
|
140 | - } |
|
135 | + /** |
|
136 | + * @inheritdoc |
|
137 | + */ |
|
138 | + public function getChecksum() { |
|
139 | + return $this->getFileInfo()->getChecksum(); |
|
140 | + } |
|
141 | 141 | } |