* @author Daniel Kesselberg * @author Frédéric Fortier * @author Joas Schilling * @author Morris Jobke * @author Robin Appelman * @author Roeland Jago Douma * @author Vincent Petry * * @license AGPL-3.0 * * This code is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License, version 3, * as published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License, version 3, * along with this program. If not, see * */ namespace OCA\Files_Sharing; use OC\Files\Filesystem; use OC\Files\Mount\MountPoint; use OC\Files\Mount\MoveableMount; use OC\Files\View; use OCP\Cache\CappedMemoryCache; use OCP\EventDispatcher\IEventDispatcher; use OCP\Files\Events\InvalidateMountCacheEvent; use OCP\Files\Storage\IStorageFactory; use OCP\ICache; use OCP\IUser; use OCP\Share\Events\VerifyMountPointEvent; use Psr\Log\LoggerInterface; /** * Shared mount points can be moved by the user */ class SharedMount extends MountPoint implements MoveableMount, ISharedMountPoint { /** * @var \OCA\Files_Sharing\SharedStorage $storage */ protected $storage = null; /** * @var \OC\Files\View */ private $recipientView; private IUser $user; /** @var \OCP\Share\IShare */ private $superShare; /** @var \OCP\Share\IShare[] */ private $groupedShares; private IEventDispatcher $eventDispatcher; private ICache $cache; public function __construct( $storage, array $mountpoints, $arguments, IStorageFactory $loader, View $recipientView, CappedMemoryCache $folderExistCache, IEventDispatcher $eventDispatcher, IUser $user, ICache $cache ) { $this->user = $user; $this->recipientView = $recipientView; $this->eventDispatcher = $eventDispatcher; $this->cache = $cache; $this->superShare = $arguments['superShare']; $this->groupedShares = $arguments['groupedShares']; $newMountPoint = $this->verifyMountPoint($this->superShare, $mountpoints, $folderExistCache); $absMountPoint = '/' . $user->getUID() . '/files' . $newMountPoint; parent::__construct($storage, $absMountPoint, $arguments, $loader, null, null, MountProvider::class); } /** * check if the parent folder exists otherwise move the mount point up * * @param \OCP\Share\IShare $share * @param SharedMount[] $mountpoints * @param CappedMemoryCache $folderExistCache * @return string */ private function verifyMountPoint( \OCP\Share\IShare $share, array $mountpoints, CappedMemoryCache $folderExistCache ) { $cacheKey = $this->user->getUID() . '/' . $share->getId() . '/' . $share->getTarget(); $cached = $this->cache->get($cacheKey); if ($cached !== null) { return $cached; } $mountPoint = basename($share->getTarget()); $parent = dirname($share->getTarget()); $event = new VerifyMountPointEvent($share, $this->recipientView, $parent); $this->eventDispatcher->dispatchTyped($event); $parent = $event->getParent(); $cached = $folderExistCache->get($parent); if ($cached) { $parentExists = $cached; } else { $parentExists = $this->recipientView->is_dir($parent); $folderExistCache->set($parent, $parentExists); } if (!$parentExists) { $parent = Helper::getShareFolder($this->recipientView, $this->user->getUID()); } $newMountPoint = $this->generateUniqueTarget( \OC\Files\Filesystem::normalizePath($parent . '/' . $mountPoint), $this->recipientView, $mountpoints ); if ($newMountPoint !== $share->getTarget()) { $this->updateFileTarget($newMountPoint, $share); } $this->cache->set($cacheKey, $newMountPoint, 60 * 60); return $newMountPoint; } /** * update fileTarget in the database if the mount point changed * * @param string $newPath * @param \OCP\Share\IShare $share * @return bool */ private function updateFileTarget($newPath, &$share) { $share->setTarget($newPath); foreach ($this->groupedShares as $tmpShare) { $tmpShare->setTarget($newPath); \OC::$server->getShareManager()->moveShare($tmpShare, $this->user->getUID()); } $this->eventDispatcher->dispatchTyped(new InvalidateMountCacheEvent($this->user)); } /** * @param string $path * @param View $view * @param SharedMount[] $mountpoints * @return mixed */ private function generateUniqueTarget($path, $view, array $mountpoints) { $pathinfo = pathinfo($path); $ext = isset($pathinfo['extension']) ? '.' . $pathinfo['extension'] : ''; $name = $pathinfo['filename']; $dir = $pathinfo['dirname']; $i = 2; $absolutePath = $this->recipientView->getAbsolutePath($path) . '/'; while ($view->file_exists($path) || isset($mountpoints[$absolutePath])) { $path = Filesystem::normalizePath($dir . '/' . $name . ' (' . $i . ')' . $ext); $absolutePath = $this->recipientView->getAbsolutePath($path) . '/'; $i++; } return $path; } /** * Format a path to be relative to the /user/files/ directory * * @param string $path the absolute path * @return string e.g. turns '/admin/files/test.txt' into '/test.txt' * @throws \OCA\Files_Sharing\Exceptions\BrokenPath */ protected function stripUserFilesPath($path) { $trimmed = ltrim($path, '/'); $split = explode('/', $trimmed); // it is not a file relative to data/user/files if (count($split) < 3 || $split[1] !== 'files') { \OCP\Server::get(LoggerInterface::class)->error('Can not strip userid and "files/" from path: ' . $path, ['app' => 'files_sharing']); throw new \OCA\Files_Sharing\Exceptions\BrokenPath('Path does not start with /user/files', 10); } // skip 'user' and 'files' $sliced = array_slice($split, 2); $relPath = implode('/', $sliced); return '/' . $relPath; } /** * Move the mount point to $target * * @param string $target the target mount point * @return bool */ public function moveMount($target) { $relTargetPath = $this->stripUserFilesPath($target); $share = $this->storage->getShare(); $result = true; try { $this->updateFileTarget($relTargetPath, $share); $this->setMountPoint($target); $this->storage->setMountPoint($relTargetPath); } catch (\Exception $e) { \OCP\Server::get(LoggerInterface::class)->error( 'Could not rename mount point for shared folder "' . $this->getMountPoint() . '" to "' . $target . '"', [ 'app' => 'files_sharing', 'exception' => $e, ] ); } return $result; } /** * Remove the mount points * * @return bool */ public function removeMount() { $mountManager = \OC\Files\Filesystem::getMountManager(); /** @var \OCA\Files_Sharing\SharedStorage $storage */ $storage = $this->getStorage(); $result = $storage->unshareStorage(); $mountManager->removeMount($this->mountPoint); return $result; } /** * @return \OCP\Share\IShare */ public function getShare() { return $this->superShare; } /** * @return \OCP\Share\IShare[] */ public function getGroupedShares(): array { return $this->groupedShares; } /** * Get the file id of the root of the storage * * @return int */ public function getStorageRootId() { return $this->getShare()->getNodeId(); } /** * @return int */ public function getNumericStorageId() { if (!is_null($this->getShare()->getNodeCacheEntry())) { return $this->getShare()->getNodeCacheEntry()->getStorageId(); } else { $builder = \OC::$server->getDatabaseConnection()->getQueryBuilder(); $query = $builder->select('storage') ->from('filecache') ->where($builder->expr()->eq('fileid', $builder->createNamedParameter($this->getStorageRootId()))); $result = $query->execute(); $row = $result->fetch(); $result->closeCursor(); if ($row) { return (int)$row['storage']; } return -1; } } public function getMountType() { return 'shared'; } }