feat: mark homefolder as overwritten when an external storage mounted…

… at / exists Signed-off-by: Robin Appelman <[email protected]>
nextcloud · Feb 28, 2025 · 1b40100 · 1b40100
1 parent c426b9c
commit 1b40100
Show file tree

Hide file tree

Showing 12 changed files with 88 additions and 13 deletions.
diff --git a/apps/files_external/appinfo/info.xml b/apps/files_external/appinfo/info.xml
@@ -14,7 +14,7 @@ This application enables administrators to configure connections to external sto
 
 External storage can be configured using the GUI or at the command line. This second option provides the administration with more flexibility for configuring bulk external storage mounts and setting mount priorities. More information is available in the external storage GUI documentation and the external storage Configuration File documentation.
 	</description>
-	<version>1.24.0</version>
+	<version>1.25.0</version>
 	<licence>agpl</licence>
 	<author>Robin Appelman</author>
 	<author>Michael Gapczynski</author>

diff --git a/apps/files_external/composer/composer/autoload_classmap.php b/apps/files_external/composer/composer/autoload_classmap.php
@@ -106,6 +106,7 @@
     'OCA\\Files_External\\Migration\\Version1011Date20200630192246' => $baseDir . '/../lib/Migration/Version1011Date20200630192246.php',
     'OCA\\Files_External\\Migration\\Version1015Date20211104103506' => $baseDir . '/../lib/Migration/Version1015Date20211104103506.php',
     'OCA\\Files_External\\Migration\\Version1016Date20220324154536' => $baseDir . '/../lib/Migration/Version1016Date20220324154536.php',
+    'OCA\\Files_External\\Migration\\Version1025Date20250228162604' => $baseDir . '/../lib/Migration/Version1025Date20250228162604.php',
     'OCA\\Files_External\\Migration\\Version22000Date20210216084416' => $baseDir . '/../lib/Migration/Version22000Date20210216084416.php',
     'OCA\\Files_External\\MountConfig' => $baseDir . '/../lib/MountConfig.php',
     'OCA\\Files_External\\NotFoundException' => $baseDir . '/../lib/NotFoundException.php',

diff --git a/apps/files_external/composer/composer/autoload_static.php b/apps/files_external/composer/composer/autoload_static.php
@@ -121,6 +121,7 @@ class ComposerStaticInitFiles_External
         'OCA\\Files_External\\Migration\\Version1011Date20200630192246' => __DIR__ . '/..' . '/../lib/Migration/Version1011Date20200630192246.php',
         'OCA\\Files_External\\Migration\\Version1015Date20211104103506' => __DIR__ . '/..' . '/../lib/Migration/Version1015Date20211104103506.php',
         'OCA\\Files_External\\Migration\\Version1016Date20220324154536' => __DIR__ . '/..' . '/../lib/Migration/Version1016Date20220324154536.php',
+        'OCA\\Files_External\\Migration\\Version1025Date20250228162604' => __DIR__ . '/..' . '/../lib/Migration/Version1025Date20250228162604.php',
         'OCA\\Files_External\\Migration\\Version22000Date20210216084416' => __DIR__ . '/..' . '/../lib/Migration/Version22000Date20210216084416.php',
         'OCA\\Files_External\\MountConfig' => __DIR__ . '/..' . '/../lib/MountConfig.php',
         'OCA\\Files_External\\NotFoundException' => __DIR__ . '/..' . '/../lib/NotFoundException.php',

diff --git a/apps/files_external/lib/Migration/Version1025Date20250228162604.php b/apps/files_external/lib/Migration/Version1025Date20250228162604.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Files_External\Migration;
+
+use Closure;
+use OCA\Files_External\Service\DBConfigService;
+use OCP\DB\ISchemaWrapper;
+use OCP\IAppConfig;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+/**
+ * Check for any external storage overwriting the home folder
+ */
+class Version1025Date20250228162604 extends SimpleMigrationStep {
+	public function __construct(
+		private DBConfigService $dbConfig,
+		private IAppConfig $appConfig,
+	) {
+	}
+
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure(): ISchemaWrapper $schemaClosure
+	 * @param array $options
+	 */
+	public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void {
+		if ($this->dbConfig->hasHomeFolderOverwriteMount()) {
+			$this->appConfig->setValueBool('files', 'homeFolderOverwritten', true);
+		}
+	}
+}
diff --git a/apps/files_external/lib/Service/DBConfigService.php b/apps/files_external/lib/Service/DBConfigService.php
@@ -4,6 +4,7 @@
  * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
  * SPDX-License-Identifier: AGPL-3.0-only
  */
+
 namespace OCA\Files_External\Service;
 
 use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
@@ -63,16 +64,16 @@ public function getMountsForUser($userId, $groupIds) {
 			->where($builder->expr()->orX(
 				$builder->expr()->andX( // global mounts
 					$builder->expr()->eq('a.type', $builder->createNamedParameter(self::APPLICABLE_TYPE_GLOBAL, IQueryBuilder::PARAM_INT)),
-					$builder->expr()->isNull('a.value')
+					$builder->expr()->isNull('a.value'),
 				),
 				$builder->expr()->andX( // mounts for user
 					$builder->expr()->eq('a.type', $builder->createNamedParameter(self::APPLICABLE_TYPE_USER, IQueryBuilder::PARAM_INT)),
-					$builder->expr()->eq('a.value', $builder->createNamedParameter($userId))
+					$builder->expr()->eq('a.value', $builder->createNamedParameter($userId)),
 				),
 				$builder->expr()->andX( // mounts for group
 					$builder->expr()->eq('a.type', $builder->createNamedParameter(self::APPLICABLE_TYPE_GROUP, IQueryBuilder::PARAM_INT)),
-					$builder->expr()->in('a.value', $builder->createNamedParameter($groupIds, IQueryBuilder::PARAM_STR_ARRAY))
-				)
+					$builder->expr()->in('a.value', $builder->createNamedParameter($groupIds, IQueryBuilder::PARAM_STR_ARRAY)),
+				),
 			));
 
 		return $this->getMountsFromQuery($query);
@@ -93,8 +94,8 @@ protected function modifyMountsOnDelete(string $applicableId, int $applicableTyp
 			->leftJoin('a', 'external_applicable', 'b', $builder->expr()->eq('a.mount_id', 'b.mount_id'))
 			->where($builder->expr()->andX(
 				$builder->expr()->eq('b.type', $builder->createNamedParameter($applicableType, IQueryBuilder::PARAM_INT)),
-				$builder->expr()->eq('b.value', $builder->createNamedParameter($applicableId))
-			)
+				$builder->expr()->eq('b.value', $builder->createNamedParameter($applicableId)),
+			),
 			)
 			->groupBy(['a.mount_id']);
 		$stmt = $query->executeQuery();
@@ -226,7 +227,7 @@ public function addMount($mountPoint, $storageBackend, $authBackend, $priority,
 				'storage_backend' => $builder->createNamedParameter($storageBackend, IQueryBuilder::PARAM_STR),
 				'auth_backend' => $builder->createNamedParameter($authBackend, IQueryBuilder::PARAM_STR),
 				'priority' => $builder->createNamedParameter($priority, IQueryBuilder::PARAM_INT),
-				'type' => $builder->createNamedParameter($type, IQueryBuilder::PARAM_INT)
+				'type' => $builder->createNamedParameter($type, IQueryBuilder::PARAM_INT),
 			]);
 		$query->executeStatement();
 		return $query->getLastInsertId();
@@ -497,4 +498,19 @@ private function decryptValue($value) {
 			return $value;
 		}
 	}
+
+	/**
+	 * Check if any mountpoint is configured that overwrite the home folder
+	 *
+	 * @return bool
+	 */
+	public function hasHomeFolderOverwriteMount(): bool {
+		$builder = $this->connection->getQueryBuilder();
+		$query = $builder->select('mount_id')
+			->from('external_mounts')
+			->where($builder->expr()->eq('mount_point', $builder->createNamedParameter('/')))
+			->setMaxResults(1);
+		$result = $query->executeQuery();
+		return (bool)$result->fetchColumn();
+	}
 }
diff --git a/apps/files_external/lib/Service/StoragesService.php b/apps/files_external/lib/Service/StoragesService.php
@@ -19,6 +19,7 @@
 use OCP\Files\Config\IUserMountCache;
 use OCP\Files\Events\InvalidateMountCacheEvent;
 use OCP\Files\StorageNotAvailableException;
+use OCP\IAppConfig;
 use OCP\Server;
 use OCP\Util;
 use Psr\Log\LoggerInterface;
@@ -39,6 +40,7 @@ public function __construct(
 		protected DBConfigService $dbConfig,
 		protected IUserMountCache $userMountCache,
 		protected IEventDispatcher $eventDispatcher,
+		protected IAppConfig $appConfig,
 	) {
 	}
 
@@ -424,6 +426,10 @@ public function updateStorage(StorageConfig $updatedStorage) {
 			}
 		}
 
+		if ($this->dbConfig->hasHomeFolderOverwriteMount()) {
+			$this->appConfig->setValueBool('files', 'homeFolderOverwritten', true);
+		}
+
 		return $this->getStorage($id);
 	}
 

diff --git a/apps/files_external/lib/Service/UserGlobalStoragesService.php b/apps/files_external/lib/Service/UserGlobalStoragesService.php
@@ -9,6 +9,7 @@
 use OCA\Files_External\Lib\StorageConfig;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\Config\IUserMountCache;
+use OCP\IAppConfig;
 use OCP\IGroupManager;
 use OCP\IUser;
 use OCP\IUserSession;
@@ -35,8 +36,9 @@ public function __construct(
 		protected IGroupManager $groupManager,
 		IUserMountCache $userMountCache,
 		IEventDispatcher $eventDispatcher,
+		IAppConfig $appConfig,
 	) {
-		parent::__construct($backendService, $dbConfig, $userMountCache, $eventDispatcher);
+		parent::__construct($backendService, $dbConfig, $userMountCache, $eventDispatcher, $appConfig);
 		$this->userSession = $userSession;
 	}
 

diff --git a/apps/files_external/lib/Service/UserStoragesService.php b/apps/files_external/lib/Service/UserStoragesService.php
@@ -12,6 +12,7 @@
 use OCA\Files_External\NotFoundException;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\Config\IUserMountCache;
+use OCP\IAppConfig;
 use OCP\IUserSession;
 
 /**
@@ -36,9 +37,10 @@ public function __construct(
 		IUserSession $userSession,
 		IUserMountCache $userMountCache,
 		IEventDispatcher $eventDispatcher,
+		IAppConfig $appConfig,
 	) {
 		$this->userSession = $userSession;
-		parent::__construct($backendService, $dbConfig, $userMountCache, $eventDispatcher);
+		parent::__construct($backendService, $dbConfig, $userMountCache, $eventDispatcher, $appConfig);
 	}
 
 	protected function readDBConfig() {

diff --git a/apps/files_external/tests/Service/GlobalStoragesServiceTest.php b/apps/files_external/tests/Service/GlobalStoragesServiceTest.php
@@ -17,7 +17,7 @@
 class GlobalStoragesServiceTest extends StoragesServiceTest {
 	protected function setUp(): void {
 		parent::setUp();
-		$this->service = new GlobalStoragesService($this->backendService, $this->dbConfig, $this->mountCache, $this->eventDispatcher);
+		$this->service = new GlobalStoragesService($this->backendService, $this->dbConfig, $this->mountCache, $this->eventDispatcher, $this->appConfig);
 	}
 
 	protected function tearDown(): void {

diff --git a/apps/files_external/tests/Service/StoragesServiceTest.php b/apps/files_external/tests/Service/StoragesServiceTest.php
@@ -25,6 +25,7 @@
 use OCP\Files\Config\IUserMountCache;
 use OCP\Files\Mount\IMountPoint;
 use OCP\Files\Storage\IStorage;
+use OCP\IAppConfig;
 use OCP\IConfig;
 use OCP\IDBConnection;
 use OCP\IUser;
@@ -86,6 +87,10 @@ abstract class StoragesServiceTest extends \Test\TestCase {
 	 * @var \PHPUnit\Framework\MockObject\MockObject|IEventDispatcher
 	 */
 	protected IEventDispatcher $eventDispatcher;
+	/**
+	 * @var \PHPUnit\Framework\MockObject\MockObject|IAppConfig
+	 */
+	protected IAppConfig $appConfig;
 
 	protected function setUp(): void {
 		parent::setUp();
@@ -100,6 +105,7 @@ protected function setUp(): void {
 
 		$this->mountCache = $this->createMock(IUserMountCache::class);
 		$this->eventDispatcher = $this->createMock(IEventDispatcher::class);
+		$this->appConfig = $this->createMock(IAppConfig::class);
 
 		// prepare BackendService mock
 		$this->backendService =

diff --git a/apps/files_external/tests/Service/UserGlobalStoragesServiceTest.php b/apps/files_external/tests/Service/UserGlobalStoragesServiceTest.php
@@ -84,6 +84,7 @@ protected function setUp(): void {
 			$this->groupManager,
 			$this->mountCache,
 			$this->eventDispatcher,
+			$this->appConfig,
 		);
 	}
 

diff --git a/apps/files_external/tests/Service/UserStoragesServiceTest.php b/apps/files_external/tests/Service/UserStoragesServiceTest.php
@@ -37,7 +37,7 @@ class UserStoragesServiceTest extends StoragesServiceTest {
 	protected function setUp(): void {
 		parent::setUp();
 
-		$this->globalStoragesService = new GlobalStoragesService($this->backendService, $this->dbConfig, $this->mountCache, $this->eventDispatcher);
+		$this->globalStoragesService = new GlobalStoragesService($this->backendService, $this->dbConfig, $this->mountCache, $this->eventDispatcher, $this->appConfig);
 
 		$this->userId = $this->getUniqueID('user_');
 		$this->createUser($this->userId, $this->userId);
@@ -50,7 +50,7 @@ protected function setUp(): void {
 			->method('getUser')
 			->willReturn($this->user);
 
-		$this->service = new UserStoragesService($this->backendService, $this->dbConfig, $userSession, $this->mountCache, $this->eventDispatcher);
+		$this->service = new UserStoragesService($this->backendService, $this->dbConfig, $userSession, $this->mountCache, $this->eventDispatcher, $this->appConfig);
 	}
 
 	private function makeTestStorageData() {