nextcloud / server

lib/private/Files/SetupManager.php

Indentation +543 added lines, -543 removed lines

@@ -55,549 +55,549 @@
 use Psr\Log\LoggerInterface;
 
 class SetupManager {
-	private bool $rootSetup = false;
-	// List of users for which at least one mount is setup
-	private array $setupUsers = [];
-	// List of users for which all mounts are setup
-	private array $setupUsersComplete = [];
-	/** @var array<string, string[]> */
-	private array $setupUserMountProviders = [];
-	private ICache $cache;
-	private bool $listeningForProviders;
-	private array $fullSetupRequired = [];
-	private bool $setupBuiltinWrappersDone = false;
-	private bool $forceFullSetup = false;
-
-	public function __construct(
-		private IEventLogger $eventLogger,
-		private MountProviderCollection $mountProviderCollection,
-		private IMountManager $mountManager,
-		private IUserManager $userManager,
-		private IEventDispatcher $eventDispatcher,
-		private IUserMountCache $userMountCache,
-		private ILockdownManager $lockdownManager,
-		private IUserSession $userSession,
-		ICacheFactory $cacheFactory,
-		private LoggerInterface $logger,
-		private IConfig $config,
-		private ShareDisableChecker $shareDisableChecker,
-		private IAppManager $appManager,
-	) {
-		$this->cache = $cacheFactory->createDistributed('setupmanager::');
-		$this->listeningForProviders = false;
-		$this->forceFullSetup = $this->config->getSystemValueBool('debug.force-full-fs-setup');
-
-		$this->setupListeners();
-	}
-
-	private function isSetupStarted(IUser $user): bool {
-		return in_array($user->getUID(), $this->setupUsers, true);
-	}
-
-	public function isSetupComplete(IUser $user): bool {
-		return in_array($user->getUID(), $this->setupUsersComplete, true);
-	}
-
-	private function setupBuiltinWrappers() {
-		if ($this->setupBuiltinWrappersDone) {
-			return;
-		}
-		$this->setupBuiltinWrappersDone = true;
-
-		// load all filesystem apps before, so no setup-hook gets lost
-		$this->appManager->loadApps(['filesystem']);
-		$prevLogging = Filesystem::logWarningWhenAddingStorageWrapper(false);
-
-		Filesystem::addStorageWrapper('mount_options', function ($mountPoint, IStorage $storage, IMountPoint $mount) {
-			if ($storage->instanceOfStorage(Common::class)) {
-				$options = array_merge($mount->getOptions(), ['mount_point' => $mountPoint]);
-				$storage->setMountOptions($options);
-			}
-			return $storage;
-		});
-
-		$reSharingEnabled = Share::isResharingAllowed();
-		$user = $this->userSession->getUser();
-		$sharingEnabledForUser = $user ? !$this->shareDisableChecker->sharingDisabledForUser($user->getUID()) : true;
-		Filesystem::addStorageWrapper(
-			'sharing_mask',
-			function ($mountPoint, IStorage $storage, IMountPoint $mount) use ($reSharingEnabled, $sharingEnabledForUser) {
-				$sharingEnabledForMount = $mount->getOption('enable_sharing', true);
-				$isShared = $mount instanceof ISharedMountPoint;
-				if (!$sharingEnabledForMount || !$sharingEnabledForUser || (!$reSharingEnabled && $isShared)) {
-					return new PermissionsMask([
-						'storage' => $storage,
-						'mask' => Constants::PERMISSION_ALL - Constants::PERMISSION_SHARE,
-					]);
-				}
-				return $storage;
-			}
-		);
-
-		// install storage availability wrapper, before most other wrappers
-		Filesystem::addStorageWrapper('oc_availability', function ($mountPoint, IStorage $storage, IMountPoint $mount) {
-			$externalMount = $mount instanceof ExternalMountPoint || $mount instanceof Mount;
-			if ($externalMount && !$storage->isLocal()) {
-				return new Availability(['storage' => $storage]);
-			}
-			return $storage;
-		});
-
-		Filesystem::addStorageWrapper('oc_encoding', function ($mountPoint, IStorage $storage, IMountPoint $mount) {
-			if ($mount->getOption('encoding_compatibility', false) && !$mount instanceof SharedMount) {
-				return new Encoding(['storage' => $storage]);
-			}
-			return $storage;
-		});
-
-		$quotaIncludeExternal = $this->config->getSystemValue('quota_include_external_storage', false);
-		Filesystem::addStorageWrapper('oc_quota', function ($mountPoint, $storage, IMountPoint $mount) use ($quotaIncludeExternal) {
-			// set up quota for home storages, even for other users
-			// which can happen when using sharing
-			if ($mount instanceof HomeMountPoint) {
-				$user = $mount->getUser();
-				return new Quota(['storage' => $storage, 'quotaCallback' => function () use ($user) {
-					return $user->getQuotaBytes();
-				}, 'root' => 'files', 'include_external_storage' => $quotaIncludeExternal]);
-			}
-
-			return $storage;
-		});
-
-		Filesystem::addStorageWrapper('readonly', function ($mountPoint, IStorage $storage, IMountPoint $mount) {
-			/*
+    private bool $rootSetup = false;
+    // List of users for which at least one mount is setup
+    private array $setupUsers = [];
+    // List of users for which all mounts are setup
+    private array $setupUsersComplete = [];
+    /** @var array<string, string[]> */
+    private array $setupUserMountProviders = [];
+    private ICache $cache;
+    private bool $listeningForProviders;
+    private array $fullSetupRequired = [];
+    private bool $setupBuiltinWrappersDone = false;
+    private bool $forceFullSetup = false;
+
+    public function __construct(
+        private IEventLogger $eventLogger,
+        private MountProviderCollection $mountProviderCollection,
+        private IMountManager $mountManager,
+        private IUserManager $userManager,
+        private IEventDispatcher $eventDispatcher,
+        private IUserMountCache $userMountCache,
+        private ILockdownManager $lockdownManager,
+        private IUserSession $userSession,
+        ICacheFactory $cacheFactory,
+        private LoggerInterface $logger,
+        private IConfig $config,
+        private ShareDisableChecker $shareDisableChecker,
+        private IAppManager $appManager,
+    ) {
+        $this->cache = $cacheFactory->createDistributed('setupmanager::');
+        $this->listeningForProviders = false;
+        $this->forceFullSetup = $this->config->getSystemValueBool('debug.force-full-fs-setup');
+
+        $this->setupListeners();
+    }
+
+    private function isSetupStarted(IUser $user): bool {
+        return in_array($user->getUID(), $this->setupUsers, true);
+    }
+
+    public function isSetupComplete(IUser $user): bool {
+        return in_array($user->getUID(), $this->setupUsersComplete, true);
+    }
+
+    private function setupBuiltinWrappers() {
+        if ($this->setupBuiltinWrappersDone) {
+            return;
+        }
+        $this->setupBuiltinWrappersDone = true;
+
+        // load all filesystem apps before, so no setup-hook gets lost
+        $this->appManager->loadApps(['filesystem']);
+        $prevLogging = Filesystem::logWarningWhenAddingStorageWrapper(false);
+
+        Filesystem::addStorageWrapper('mount_options', function ($mountPoint, IStorage $storage, IMountPoint $mount) {
+            if ($storage->instanceOfStorage(Common::class)) {
+                $options = array_merge($mount->getOptions(), ['mount_point' => $mountPoint]);
+                $storage->setMountOptions($options);
+            }
+            return $storage;
+        });
+
+        $reSharingEnabled = Share::isResharingAllowed();
+        $user = $this->userSession->getUser();
+        $sharingEnabledForUser = $user ? !$this->shareDisableChecker->sharingDisabledForUser($user->getUID()) : true;
+        Filesystem::addStorageWrapper(
+            'sharing_mask',
+            function ($mountPoint, IStorage $storage, IMountPoint $mount) use ($reSharingEnabled, $sharingEnabledForUser) {
+                $sharingEnabledForMount = $mount->getOption('enable_sharing', true);
+                $isShared = $mount instanceof ISharedMountPoint;
+                if (!$sharingEnabledForMount || !$sharingEnabledForUser || (!$reSharingEnabled && $isShared)) {
+                    return new PermissionsMask([
+                        'storage' => $storage,
+                        'mask' => Constants::PERMISSION_ALL - Constants::PERMISSION_SHARE,
+                    ]);
+                }
+                return $storage;
+            }
+        );
+
+        // install storage availability wrapper, before most other wrappers
+        Filesystem::addStorageWrapper('oc_availability', function ($mountPoint, IStorage $storage, IMountPoint $mount) {
+            $externalMount = $mount instanceof ExternalMountPoint || $mount instanceof Mount;
+            if ($externalMount && !$storage->isLocal()) {
+                return new Availability(['storage' => $storage]);
+            }
+            return $storage;
+        });
+
+        Filesystem::addStorageWrapper('oc_encoding', function ($mountPoint, IStorage $storage, IMountPoint $mount) {
+            if ($mount->getOption('encoding_compatibility', false) && !$mount instanceof SharedMount) {
+                return new Encoding(['storage' => $storage]);
+            }
+            return $storage;
+        });
+
+        $quotaIncludeExternal = $this->config->getSystemValue('quota_include_external_storage', false);
+        Filesystem::addStorageWrapper('oc_quota', function ($mountPoint, $storage, IMountPoint $mount) use ($quotaIncludeExternal) {
+            // set up quota for home storages, even for other users
+            // which can happen when using sharing
+            if ($mount instanceof HomeMountPoint) {
+                $user = $mount->getUser();
+                return new Quota(['storage' => $storage, 'quotaCallback' => function () use ($user) {
+                    return $user->getQuotaBytes();
+                }, 'root' => 'files', 'include_external_storage' => $quotaIncludeExternal]);
+            }
+
+            return $storage;
+        });
+
+        Filesystem::addStorageWrapper('readonly', function ($mountPoint, IStorage $storage, IMountPoint $mount) {
+            /*
 			 * Do not allow any operations that modify the storage
 			 */
-			if ($mount->getOption('readonly', false)) {
-				return new PermissionsMask([
-					'storage' => $storage,
-					'mask' => Constants::PERMISSION_ALL & ~(
-						Constants::PERMISSION_UPDATE
-						| Constants::PERMISSION_CREATE
-						| Constants::PERMISSION_DELETE
-					),
-				]);
-			}
-			return $storage;
-		});
-
-		Filesystem::logWarningWhenAddingStorageWrapper($prevLogging);
-	}
-
-	/**
-	 * Setup the full filesystem for the specified user
-	 */
-	public function setupForUser(IUser $user): void {
-		if ($this->isSetupComplete($user)) {
-			return;
-		}
-		$this->setupUsersComplete[] = $user->getUID();
-
-		$this->eventLogger->start('fs:setup:user:full', 'Setup full filesystem for user');
-
-		if (!isset($this->setupUserMountProviders[$user->getUID()])) {
-			$this->setupUserMountProviders[$user->getUID()] = [];
-		}
-
-		$previouslySetupProviders = $this->setupUserMountProviders[$user->getUID()];
-
-		$this->setupForUserWith($user, function () use ($user) {
-			$this->mountProviderCollection->addMountForUser($user, $this->mountManager, function (
-				IMountProvider $provider,
-			) use ($user) {
-				return !in_array(get_class($provider), $this->setupUserMountProviders[$user->getUID()]);
-			});
-		});
-		$this->afterUserFullySetup($user, $previouslySetupProviders);
-		$this->eventLogger->end('fs:setup:user:full');
-	}
-
-	/**
-	 * part of the user setup that is run only once per user
-	 */
-	private function oneTimeUserSetup(IUser $user) {
-		if ($this->isSetupStarted($user)) {
-			return;
-		}
-		$this->setupUsers[] = $user->getUID();
-
-		$this->setupRoot();
-
-		$this->eventLogger->start('fs:setup:user:onetime', 'Onetime filesystem for user');
-
-		$this->setupBuiltinWrappers();
-
-		$prevLogging = Filesystem::logWarningWhenAddingStorageWrapper(false);
-
-		// TODO remove hook
-		OC_Hook::emit('OC_Filesystem', 'preSetup', ['user' => $user->getUID()]);
-
-		$event = new BeforeFileSystemSetupEvent($user);
-		$this->eventDispatcher->dispatchTyped($event);
-
-		Filesystem::logWarningWhenAddingStorageWrapper($prevLogging);
-
-		$userDir = '/' . $user->getUID() . '/files';
-
-		Filesystem::initInternal($userDir);
-
-		if ($this->lockdownManager->canAccessFilesystem()) {
-			$this->eventLogger->start('fs:setup:user:home', 'Setup home filesystem for user');
-			// home mounts are handled separate since we need to ensure this is mounted before we call the other mount providers
-			$homeMount = $this->mountProviderCollection->getHomeMountForUser($user);
-			$this->mountManager->addMount($homeMount);
-
-			if ($homeMount->getStorageRootId() === -1) {
-				$this->eventLogger->start('fs:setup:user:home:scan', 'Scan home filesystem for user');
-				$homeMount->getStorage()->mkdir('');
-				$homeMount->getStorage()->getScanner()->scan('');
-				$this->eventLogger->end('fs:setup:user:home:scan');
-			}
-			$this->eventLogger->end('fs:setup:user:home');
-		} else {
-			$this->mountManager->addMount(new MountPoint(
-				new NullStorage([]),
-				'/' . $user->getUID()
-			));
-			$this->mountManager->addMount(new MountPoint(
-				new NullStorage([]),
-				'/' . $user->getUID() . '/files'
-			));
-			$this->setupUsersComplete[] = $user->getUID();
-		}
-
-		$this->listenForNewMountProviders();
-
-		$this->eventLogger->end('fs:setup:user:onetime');
-	}
-
-	/**
-	 * Final housekeeping after a user has been fully setup
-	 */
-	private function afterUserFullySetup(IUser $user, array $previouslySetupProviders): void {
-		$this->eventLogger->start('fs:setup:user:full:post', 'Housekeeping after user is setup');
-		$userRoot = '/' . $user->getUID() . '/';
-		$mounts = $this->mountManager->getAll();
-		$mounts = array_filter($mounts, function (IMountPoint $mount) use ($userRoot) {
-			return str_starts_with($mount->getMountPoint(), $userRoot);
-		});
-		$allProviders = array_map(function (IMountProvider|IHomeMountProvider|IRootMountProvider $provider) {
-			return get_class($provider);
-		}, array_merge(
-			$this->mountProviderCollection->getProviders(),
-			$this->mountProviderCollection->getHomeProviders(),
-			$this->mountProviderCollection->getRootProviders(),
-		));
-		$newProviders = array_diff($allProviders, $previouslySetupProviders);
-		$mounts = array_filter($mounts, function (IMountPoint $mount) use ($previouslySetupProviders) {
-			return !in_array($mount->getMountProvider(), $previouslySetupProviders);
-		});
-		$this->userMountCache->registerMounts($user, $mounts, $newProviders);
-
-		$cacheDuration = $this->config->getSystemValueInt('fs_mount_cache_duration', 5 * 60);
-		if ($cacheDuration > 0) {
-			$this->cache->set($user->getUID(), true, $cacheDuration);
-			$this->fullSetupRequired[$user->getUID()] = false;
-		}
-		$this->eventLogger->end('fs:setup:user:full:post');
-	}
-
-	/**
-	 * @param IUser $user
-	 * @param IMountPoint $mounts
-	 * @return void
-	 * @throws \OCP\HintException
-	 * @throws \OC\ServerNotAvailableException
-	 */
-	private function setupForUserWith(IUser $user, callable $mountCallback): void {
-		$this->oneTimeUserSetup($user);
-
-		if ($this->lockdownManager->canAccessFilesystem()) {
-			$mountCallback();
-		}
-		$this->eventLogger->start('fs:setup:user:post-init-mountpoint', 'post_initMountPoints legacy hook');
-		\OC_Hook::emit('OC_Filesystem', 'post_initMountPoints', ['user' => $user->getUID()]);
-		$this->eventLogger->end('fs:setup:user:post-init-mountpoint');
-
-		$userDir = '/' . $user->getUID() . '/files';
-		$this->eventLogger->start('fs:setup:user:setup-hook', 'setup legacy hook');
-		OC_Hook::emit('OC_Filesystem', 'setup', ['user' => $user->getUID(), 'user_dir' => $userDir]);
-		$this->eventLogger->end('fs:setup:user:setup-hook');
-	}
-
-	/**
-	 * Set up the root filesystem
-	 */
-	public function setupRoot(): void {
-		//setting up the filesystem twice can only lead to trouble
-		if ($this->rootSetup) {
-			return;
-		}
-
-		$this->setupBuiltinWrappers();
-
-		$this->rootSetup = true;
-
-		$this->eventLogger->start('fs:setup:root', 'Setup root filesystem');
-
-		$rootMounts = $this->mountProviderCollection->getRootMounts();
-		foreach ($rootMounts as $rootMountProvider) {
-			$this->mountManager->addMount($rootMountProvider);
-		}
-
-		$this->eventLogger->end('fs:setup:root');
-	}
-
-	/**
-	 * Get the user to setup for a path or `null` if the root needs to be setup
-	 *
-	 * @param string $path
-	 * @return IUser|null
-	 */
-	private function getUserForPath(string $path) {
-		if (str_starts_with($path, '/__groupfolders')) {
-			return null;
-		} elseif (substr_count($path, '/') < 2) {
-			if ($user = $this->userSession->getUser()) {
-				return $user;
-			} else {
-				return null;
-			}
-		} elseif (str_starts_with($path, '/appdata_' . \OC_Util::getInstanceId()) || str_starts_with($path, '/files_external/')) {
-			return null;
-		} else {
-			[, $userId] = explode('/', $path);
-		}
-
-		return $this->userManager->get($userId);
-	}
-
-	/**
-	 * Set up the filesystem for the specified path
-	 */
-	public function setupForPath(string $path, bool $includeChildren = false): void {
-		$user = $this->getUserForPath($path);
-		if (!$user) {
-			$this->setupRoot();
-			return;
-		}
-
-		if ($this->isSetupComplete($user)) {
-			return;
-		}
-
-		if ($this->fullSetupRequired($user)) {
-			$this->setupForUser($user);
-			return;
-		}
-
-		// for the user's home folder, and includes children we need everything always
-		if (rtrim($path) === '/' . $user->getUID() . '/files' && $includeChildren) {
-			$this->setupForUser($user);
-			return;
-		}
-
-		if (!isset($this->setupUserMountProviders[$user->getUID()])) {
-			$this->setupUserMountProviders[$user->getUID()] = [];
-		}
-		$setupProviders = &$this->setupUserMountProviders[$user->getUID()];
-		$currentProviders = [];
-
-		try {
-			$cachedMount = $this->userMountCache->getMountForPath($user, $path);
-		} catch (NotFoundException $e) {
-			$this->setupForUser($user);
-			return;
-		}
-
-		$this->oneTimeUserSetup($user);
-
-		$this->eventLogger->start('fs:setup:user:path', "Setup $path filesystem for user");
-		$this->eventLogger->start('fs:setup:user:path:find', "Find mountpoint for $path");
-
-		$mounts = [];
-		if (!in_array($cachedMount->getMountProvider(), $setupProviders)) {
-			$currentProviders[] = $cachedMount->getMountProvider();
-			if ($cachedMount->getMountProvider()) {
-				$setupProviders[] = $cachedMount->getMountProvider();
-				$mounts = $this->mountProviderCollection->getUserMountsForProviderClasses($user, [$cachedMount->getMountProvider()]);
-			} else {
-				$this->logger->debug('mount at ' . $cachedMount->getMountPoint() . ' has no provider set, performing full setup');
-				$this->eventLogger->end('fs:setup:user:path:find');
-				$this->setupForUser($user);
-				$this->eventLogger->end('fs:setup:user:path');
-				return;
-			}
-		}
-
-		if ($includeChildren) {
-			$subCachedMounts = $this->userMountCache->getMountsInPath($user, $path);
-			$this->eventLogger->end('fs:setup:user:path:find');
-
-			$needsFullSetup = array_reduce($subCachedMounts, function (bool $needsFullSetup, ICachedMountInfo $cachedMountInfo) {
-				return $needsFullSetup || $cachedMountInfo->getMountProvider() === '';
-			}, false);
-
-			if ($needsFullSetup) {
-				$this->logger->debug('mount has no provider set, performing full setup');
-				$this->setupForUser($user);
-				$this->eventLogger->end('fs:setup:user:path');
-				return;
-			} else {
-				foreach ($subCachedMounts as $cachedMount) {
-					if (!in_array($cachedMount->getMountProvider(), $setupProviders)) {
-						$currentProviders[] = $cachedMount->getMountProvider();
-						$setupProviders[] = $cachedMount->getMountProvider();
-						$mounts = array_merge($mounts, $this->mountProviderCollection->getUserMountsForProviderClasses($user, [$cachedMount->getMountProvider()]));
-					}
-				}
-			}
-		} else {
-			$this->eventLogger->end('fs:setup:user:path:find');
-		}
-
-		if (count($mounts)) {
-			$this->userMountCache->registerMounts($user, $mounts, $currentProviders);
-			$this->setupForUserWith($user, function () use ($mounts) {
-				array_walk($mounts, [$this->mountManager, 'addMount']);
-			});
-		} elseif (!$this->isSetupStarted($user)) {
-			$this->oneTimeUserSetup($user);
-		}
-		$this->eventLogger->end('fs:setup:user:path');
-	}
-
-	private function fullSetupRequired(IUser $user): bool {
-		if ($this->forceFullSetup) {
-			return true;
-		}
-
-		// we perform a "cached" setup only after having done the full setup recently
-		// this is also used to trigger a full setup after handling events that are likely
-		// to change the available mounts
-		if (!isset($this->fullSetupRequired[$user->getUID()])) {
-			$this->fullSetupRequired[$user->getUID()] = !$this->cache->get($user->getUID());
-		}
-		return $this->fullSetupRequired[$user->getUID()];
-	}
-
-	/**
-	 * @param string $path
-	 * @param string[] $providers
-	 */
-	public function setupForProvider(string $path, array $providers): void {
-		$user = $this->getUserForPath($path);
-		if (!$user) {
-			$this->setupRoot();
-			return;
-		}
-
-		if ($this->isSetupComplete($user)) {
-			return;
-		}
-
-		if ($this->fullSetupRequired($user)) {
-			$this->setupForUser($user);
-			return;
-		}
-
-		$this->eventLogger->start('fs:setup:user:providers', 'Setup filesystem for ' . implode(', ', $providers));
-
-		$this->oneTimeUserSetup($user);
-
-		// home providers are always used
-		$providers = array_filter($providers, function (string $provider) {
-			return !is_subclass_of($provider, IHomeMountProvider::class);
-		});
-
-		if (in_array('', $providers)) {
-			$this->setupForUser($user);
-			return;
-		}
-		$setupProviders = $this->setupUserMountProviders[$user->getUID()] ?? [];
-
-		$providers = array_diff($providers, $setupProviders);
-		if (count($providers) === 0) {
-			if (!$this->isSetupStarted($user)) {
-				$this->oneTimeUserSetup($user);
-			}
-			$this->eventLogger->end('fs:setup:user:providers');
-			return;
-		} else {
-			$this->setupUserMountProviders[$user->getUID()] = array_merge($setupProviders, $providers);
-			$mounts = $this->mountProviderCollection->getUserMountsForProviderClasses($user, $providers);
-		}
-
-		$this->userMountCache->registerMounts($user, $mounts, $providers);
-		$this->setupForUserWith($user, function () use ($mounts) {
-			array_walk($mounts, [$this->mountManager, 'addMount']);
-		});
-		$this->eventLogger->end('fs:setup:user:providers');
-	}
-
-	public function tearDown() {
-		$this->setupUsers = [];
-		$this->setupUsersComplete = [];
-		$this->setupUserMountProviders = [];
-		$this->fullSetupRequired = [];
-		$this->rootSetup = false;
-		$this->mountManager->clear();
-		$this->eventDispatcher->dispatchTyped(new FilesystemTornDownEvent());
-	}
-
-	/**
-	 * Get mounts from mount providers that are registered after setup
-	 */
-	private function listenForNewMountProviders() {
-		if (!$this->listeningForProviders) {
-			$this->listeningForProviders = true;
-			$this->mountProviderCollection->listen('\OC\Files\Config', 'registerMountProvider', function (
-				IMountProvider $provider,
-			) {
-				foreach ($this->setupUsers as $userId) {
-					$user = $this->userManager->get($userId);
-					if ($user) {
-						$mounts = $provider->getMountsForUser($user, Filesystem::getLoader());
-						array_walk($mounts, [$this->mountManager, 'addMount']);
-					}
-				}
-			});
-		}
-	}
-
-	private function setupListeners() {
-		// note that this event handling is intentionally pessimistic
-		// clearing the cache to often is better than not enough
-
-		$this->eventDispatcher->addListener(UserAddedEvent::class, function (UserAddedEvent $event) {
-			$this->cache->remove($event->getUser()->getUID());
-		});
-		$this->eventDispatcher->addListener(UserRemovedEvent::class, function (UserRemovedEvent $event) {
-			$this->cache->remove($event->getUser()->getUID());
-		});
-		$this->eventDispatcher->addListener(ShareCreatedEvent::class, function (ShareCreatedEvent $event) {
-			$this->cache->remove($event->getShare()->getSharedWith());
-		});
-		$this->eventDispatcher->addListener(InvalidateMountCacheEvent::class, function (InvalidateMountCacheEvent $event,
-		) {
-			if ($user = $event->getUser()) {
-				$this->cache->remove($user->getUID());
-			} else {
-				$this->cache->clear();
-			}
-		});
-
-		$genericEvents = [
-			'OCA\Circles\Events\CreatingCircleEvent',
-			'OCA\Circles\Events\DestroyingCircleEvent',
-			'OCA\Circles\Events\AddingCircleMemberEvent',
-			'OCA\Circles\Events\RemovingCircleMemberEvent',
-		];
-
-		foreach ($genericEvents as $genericEvent) {
-			$this->eventDispatcher->addListener($genericEvent, function ($event) {
-				$this->cache->clear();
-			});
-		}
-	}
+            if ($mount->getOption('readonly', false)) {
+                return new PermissionsMask([
+                    'storage' => $storage,
+                    'mask' => Constants::PERMISSION_ALL & ~(
+                        Constants::PERMISSION_UPDATE
+                        | Constants::PERMISSION_CREATE
+                        | Constants::PERMISSION_DELETE
+                    ),
+                ]);
+            }
+            return $storage;
+        });
+
+        Filesystem::logWarningWhenAddingStorageWrapper($prevLogging);
+    }
+
+    /**
+     * Setup the full filesystem for the specified user
+     */
+    public function setupForUser(IUser $user): void {
+        if ($this->isSetupComplete($user)) {
+            return;
+        }
+        $this->setupUsersComplete[] = $user->getUID();
+
+        $this->eventLogger->start('fs:setup:user:full', 'Setup full filesystem for user');
+
+        if (!isset($this->setupUserMountProviders[$user->getUID()])) {
+            $this->setupUserMountProviders[$user->getUID()] = [];
+        }
+
+        $previouslySetupProviders = $this->setupUserMountProviders[$user->getUID()];
+
+        $this->setupForUserWith($user, function () use ($user) {
+            $this->mountProviderCollection->addMountForUser($user, $this->mountManager, function (
+                IMountProvider $provider,
+            ) use ($user) {
+                return !in_array(get_class($provider), $this->setupUserMountProviders[$user->getUID()]);
+            });
+        });
+        $this->afterUserFullySetup($user, $previouslySetupProviders);
+        $this->eventLogger->end('fs:setup:user:full');
+    }
+
+    /**
+     * part of the user setup that is run only once per user
+     */
+    private function oneTimeUserSetup(IUser $user) {
+        if ($this->isSetupStarted($user)) {
+            return;
+        }
+        $this->setupUsers[] = $user->getUID();
+
+        $this->setupRoot();
+
+        $this->eventLogger->start('fs:setup:user:onetime', 'Onetime filesystem for user');
+
+        $this->setupBuiltinWrappers();
+
+        $prevLogging = Filesystem::logWarningWhenAddingStorageWrapper(false);
+
+        // TODO remove hook
+        OC_Hook::emit('OC_Filesystem', 'preSetup', ['user' => $user->getUID()]);
+
+        $event = new BeforeFileSystemSetupEvent($user);
+        $this->eventDispatcher->dispatchTyped($event);
+
+        Filesystem::logWarningWhenAddingStorageWrapper($prevLogging);
+
+        $userDir = '/' . $user->getUID() . '/files';
+
+        Filesystem::initInternal($userDir);
+
+        if ($this->lockdownManager->canAccessFilesystem()) {
+            $this->eventLogger->start('fs:setup:user:home', 'Setup home filesystem for user');
+            // home mounts are handled separate since we need to ensure this is mounted before we call the other mount providers
+            $homeMount = $this->mountProviderCollection->getHomeMountForUser($user);
+            $this->mountManager->addMount($homeMount);
+
+            if ($homeMount->getStorageRootId() === -1) {
+                $this->eventLogger->start('fs:setup:user:home:scan', 'Scan home filesystem for user');
+                $homeMount->getStorage()->mkdir('');
+                $homeMount->getStorage()->getScanner()->scan('');
+                $this->eventLogger->end('fs:setup:user:home:scan');
+            }
+            $this->eventLogger->end('fs:setup:user:home');
+        } else {
+            $this->mountManager->addMount(new MountPoint(
+                new NullStorage([]),
+                '/' . $user->getUID()
+            ));
+            $this->mountManager->addMount(new MountPoint(
+                new NullStorage([]),
+                '/' . $user->getUID() . '/files'
+            ));
+            $this->setupUsersComplete[] = $user->getUID();
+        }
+
+        $this->listenForNewMountProviders();
+
+        $this->eventLogger->end('fs:setup:user:onetime');
+    }
+
+    /**
+     * Final housekeeping after a user has been fully setup
+     */
+    private function afterUserFullySetup(IUser $user, array $previouslySetupProviders): void {
+        $this->eventLogger->start('fs:setup:user:full:post', 'Housekeeping after user is setup');
+        $userRoot = '/' . $user->getUID() . '/';
+        $mounts = $this->mountManager->getAll();
+        $mounts = array_filter($mounts, function (IMountPoint $mount) use ($userRoot) {
+            return str_starts_with($mount->getMountPoint(), $userRoot);
+        });
+        $allProviders = array_map(function (IMountProvider|IHomeMountProvider|IRootMountProvider $provider) {
+            return get_class($provider);
+        }, array_merge(
+            $this->mountProviderCollection->getProviders(),
+            $this->mountProviderCollection->getHomeProviders(),
+            $this->mountProviderCollection->getRootProviders(),
+        ));
+        $newProviders = array_diff($allProviders, $previouslySetupProviders);
+        $mounts = array_filter($mounts, function (IMountPoint $mount) use ($previouslySetupProviders) {
+            return !in_array($mount->getMountProvider(), $previouslySetupProviders);
+        });
+        $this->userMountCache->registerMounts($user, $mounts, $newProviders);
+
+        $cacheDuration = $this->config->getSystemValueInt('fs_mount_cache_duration', 5 * 60);
+        if ($cacheDuration > 0) {
+            $this->cache->set($user->getUID(), true, $cacheDuration);
+            $this->fullSetupRequired[$user->getUID()] = false;
+        }
+        $this->eventLogger->end('fs:setup:user:full:post');
+    }
+
+    /**
+     * @param IUser $user
+     * @param IMountPoint $mounts
+     * @return void
+     * @throws \OCP\HintException
+     * @throws \OC\ServerNotAvailableException
+     */
+    private function setupForUserWith(IUser $user, callable $mountCallback): void {
+        $this->oneTimeUserSetup($user);
+
+        if ($this->lockdownManager->canAccessFilesystem()) {
+            $mountCallback();
+        }
+        $this->eventLogger->start('fs:setup:user:post-init-mountpoint', 'post_initMountPoints legacy hook');
+        \OC_Hook::emit('OC_Filesystem', 'post_initMountPoints', ['user' => $user->getUID()]);
+        $this->eventLogger->end('fs:setup:user:post-init-mountpoint');
+
+        $userDir = '/' . $user->getUID() . '/files';
+        $this->eventLogger->start('fs:setup:user:setup-hook', 'setup legacy hook');
+        OC_Hook::emit('OC_Filesystem', 'setup', ['user' => $user->getUID(), 'user_dir' => $userDir]);
+        $this->eventLogger->end('fs:setup:user:setup-hook');
+    }
+
+    /**
+     * Set up the root filesystem
+     */
+    public function setupRoot(): void {
+        //setting up the filesystem twice can only lead to trouble
+        if ($this->rootSetup) {
+            return;
+        }
+
+        $this->setupBuiltinWrappers();
+
+        $this->rootSetup = true;
+
+        $this->eventLogger->start('fs:setup:root', 'Setup root filesystem');
+
+        $rootMounts = $this->mountProviderCollection->getRootMounts();
+        foreach ($rootMounts as $rootMountProvider) {
+            $this->mountManager->addMount($rootMountProvider);
+        }
+
+        $this->eventLogger->end('fs:setup:root');
+    }
+
+    /**
+     * Get the user to setup for a path or `null` if the root needs to be setup
+     *
+     * @param string $path
+     * @return IUser|null
+     */
+    private function getUserForPath(string $path) {
+        if (str_starts_with($path, '/__groupfolders')) {
+            return null;
+        } elseif (substr_count($path, '/') < 2) {
+            if ($user = $this->userSession->getUser()) {
+                return $user;
+            } else {
+                return null;
+            }
+        } elseif (str_starts_with($path, '/appdata_' . \OC_Util::getInstanceId()) || str_starts_with($path, '/files_external/')) {
+            return null;
+        } else {
+            [, $userId] = explode('/', $path);
+        }
+
+        return $this->userManager->get($userId);
+    }
+
+    /**
+     * Set up the filesystem for the specified path
+     */
+    public function setupForPath(string $path, bool $includeChildren = false): void {
+        $user = $this->getUserForPath($path);
+        if (!$user) {
+            $this->setupRoot();
+            return;
+        }
+
+        if ($this->isSetupComplete($user)) {
+            return;
+        }
+
+        if ($this->fullSetupRequired($user)) {
+            $this->setupForUser($user);
+            return;
+        }
+
+        // for the user's home folder, and includes children we need everything always
+        if (rtrim($path) === '/' . $user->getUID() . '/files' && $includeChildren) {
+            $this->setupForUser($user);
+            return;
+        }
+
+        if (!isset($this->setupUserMountProviders[$user->getUID()])) {
+            $this->setupUserMountProviders[$user->getUID()] = [];
+        }
+        $setupProviders = &$this->setupUserMountProviders[$user->getUID()];
+        $currentProviders = [];
+
+        try {
+            $cachedMount = $this->userMountCache->getMountForPath($user, $path);
+        } catch (NotFoundException $e) {
+            $this->setupForUser($user);
+            return;
+        }
+
+        $this->oneTimeUserSetup($user);
+
+        $this->eventLogger->start('fs:setup:user:path', "Setup $path filesystem for user");
+        $this->eventLogger->start('fs:setup:user:path:find', "Find mountpoint for $path");
+
+        $mounts = [];
+        if (!in_array($cachedMount->getMountProvider(), $setupProviders)) {
+            $currentProviders[] = $cachedMount->getMountProvider();
+            if ($cachedMount->getMountProvider()) {
+                $setupProviders[] = $cachedMount->getMountProvider();
+                $mounts = $this->mountProviderCollection->getUserMountsForProviderClasses($user, [$cachedMount->getMountProvider()]);
+            } else {
+                $this->logger->debug('mount at ' . $cachedMount->getMountPoint() . ' has no provider set, performing full setup');
+                $this->eventLogger->end('fs:setup:user:path:find');
+                $this->setupForUser($user);
+                $this->eventLogger->end('fs:setup:user:path');
+                return;
+            }
+        }
+
+        if ($includeChildren) {
+            $subCachedMounts = $this->userMountCache->getMountsInPath($user, $path);
+            $this->eventLogger->end('fs:setup:user:path:find');
+
+            $needsFullSetup = array_reduce($subCachedMounts, function (bool $needsFullSetup, ICachedMountInfo $cachedMountInfo) {
+                return $needsFullSetup || $cachedMountInfo->getMountProvider() === '';
+            }, false);
+
+            if ($needsFullSetup) {
+                $this->logger->debug('mount has no provider set, performing full setup');
+                $this->setupForUser($user);
+                $this->eventLogger->end('fs:setup:user:path');
+                return;
+            } else {
+                foreach ($subCachedMounts as $cachedMount) {
+                    if (!in_array($cachedMount->getMountProvider(), $setupProviders)) {
+                        $currentProviders[] = $cachedMount->getMountProvider();
+                        $setupProviders[] = $cachedMount->getMountProvider();
+                        $mounts = array_merge($mounts, $this->mountProviderCollection->getUserMountsForProviderClasses($user, [$cachedMount->getMountProvider()]));
+                    }
+                }
+            }
+        } else {
+            $this->eventLogger->end('fs:setup:user:path:find');
+        }
+
+        if (count($mounts)) {
+            $this->userMountCache->registerMounts($user, $mounts, $currentProviders);
+            $this->setupForUserWith($user, function () use ($mounts) {
+                array_walk($mounts, [$this->mountManager, 'addMount']);
+            });
+        } elseif (!$this->isSetupStarted($user)) {
+            $this->oneTimeUserSetup($user);
+        }
+        $this->eventLogger->end('fs:setup:user:path');
+    }
+
+    private function fullSetupRequired(IUser $user): bool {
+        if ($this->forceFullSetup) {
+            return true;
+        }
+
+        // we perform a "cached" setup only after having done the full setup recently
+        // this is also used to trigger a full setup after handling events that are likely
+        // to change the available mounts
+        if (!isset($this->fullSetupRequired[$user->getUID()])) {
+            $this->fullSetupRequired[$user->getUID()] = !$this->cache->get($user->getUID());
+        }
+        return $this->fullSetupRequired[$user->getUID()];
+    }
+
+    /**
+     * @param string $path
+     * @param string[] $providers
+     */
+    public function setupForProvider(string $path, array $providers): void {
+        $user = $this->getUserForPath($path);
+        if (!$user) {
+            $this->setupRoot();
+            return;
+        }
+
+        if ($this->isSetupComplete($user)) {
+            return;
+        }
+
+        if ($this->fullSetupRequired($user)) {
+            $this->setupForUser($user);
+            return;
+        }
+
+        $this->eventLogger->start('fs:setup:user:providers', 'Setup filesystem for ' . implode(', ', $providers));
+
+        $this->oneTimeUserSetup($user);
+
+        // home providers are always used
+        $providers = array_filter($providers, function (string $provider) {
+            return !is_subclass_of($provider, IHomeMountProvider::class);
+        });
+
+        if (in_array('', $providers)) {
+            $this->setupForUser($user);
+            return;
+        }
+        $setupProviders = $this->setupUserMountProviders[$user->getUID()] ?? [];
+
+        $providers = array_diff($providers, $setupProviders);
+        if (count($providers) === 0) {
+            if (!$this->isSetupStarted($user)) {
+                $this->oneTimeUserSetup($user);
+            }
+            $this->eventLogger->end('fs:setup:user:providers');
+            return;
+        } else {
+            $this->setupUserMountProviders[$user->getUID()] = array_merge($setupProviders, $providers);
+            $mounts = $this->mountProviderCollection->getUserMountsForProviderClasses($user, $providers);
+        }
+
+        $this->userMountCache->registerMounts($user, $mounts, $providers);
+        $this->setupForUserWith($user, function () use ($mounts) {
+            array_walk($mounts, [$this->mountManager, 'addMount']);
+        });
+        $this->eventLogger->end('fs:setup:user:providers');
+    }
+
+    public function tearDown() {
+        $this->setupUsers = [];
+        $this->setupUsersComplete = [];
+        $this->setupUserMountProviders = [];
+        $this->fullSetupRequired = [];
+        $this->rootSetup = false;
+        $this->mountManager->clear();
+        $this->eventDispatcher->dispatchTyped(new FilesystemTornDownEvent());
+    }
+
+    /**
+     * Get mounts from mount providers that are registered after setup
+     */
+    private function listenForNewMountProviders() {
+        if (!$this->listeningForProviders) {
+            $this->listeningForProviders = true;
+            $this->mountProviderCollection->listen('\OC\Files\Config', 'registerMountProvider', function (
+                IMountProvider $provider,
+            ) {
+                foreach ($this->setupUsers as $userId) {
+                    $user = $this->userManager->get($userId);
+                    if ($user) {
+                        $mounts = $provider->getMountsForUser($user, Filesystem::getLoader());
+                        array_walk($mounts, [$this->mountManager, 'addMount']);
+                    }
+                }
+            });
+        }
+    }
+
+    private function setupListeners() {
+        // note that this event handling is intentionally pessimistic
+        // clearing the cache to often is better than not enough
+
+        $this->eventDispatcher->addListener(UserAddedEvent::class, function (UserAddedEvent $event) {
+            $this->cache->remove($event->getUser()->getUID());
+        });
+        $this->eventDispatcher->addListener(UserRemovedEvent::class, function (UserRemovedEvent $event) {
+            $this->cache->remove($event->getUser()->getUID());
+        });
+        $this->eventDispatcher->addListener(ShareCreatedEvent::class, function (ShareCreatedEvent $event) {
+            $this->cache->remove($event->getShare()->getSharedWith());
+        });
+        $this->eventDispatcher->addListener(InvalidateMountCacheEvent::class, function (InvalidateMountCacheEvent $event,
+        ) {
+            if ($user = $event->getUser()) {
+                $this->cache->remove($user->getUID());
+            } else {
+                $this->cache->clear();
+            }
+        });
+
+        $genericEvents = [
+            'OCA\Circles\Events\CreatingCircleEvent',
+            'OCA\Circles\Events\DestroyingCircleEvent',
+            'OCA\Circles\Events\AddingCircleMemberEvent',
+            'OCA\Circles\Events\RemovingCircleMemberEvent',
+        ];
+
+        foreach ($genericEvents as $genericEvent) {
+            $this->eventDispatcher->addListener($genericEvent, function ($event) {
+                $this->cache->clear();
+            });
+        }
+    }
 }

Spacing +31 added lines, -31 removed lines

@@ -108,7 +108,7 @@ 
 		$this->appManager->loadApps(['filesystem']);
 		$prevLogging = Filesystem::logWarningWhenAddingStorageWrapper(false);
 
-		Filesystem::addStorageWrapper('mount_options', function ($mountPoint, IStorage $storage, IMountPoint $mount) {
+		Filesystem::addStorageWrapper('mount_options', function($mountPoint, IStorage $storage, IMountPoint $mount) {
 			if ($storage->instanceOfStorage(Common::class)) {
 				$options = array_merge($mount->getOptions(), ['mount_point' => $mountPoint]);
 				$storage->setMountOptions($options);
@@ -121,7 +121,7 @@ 
 		$sharingEnabledForUser = $user ? !$this->shareDisableChecker->sharingDisabledForUser($user->getUID()) : true;
 		Filesystem::addStorageWrapper(
 			'sharing_mask',
-			function ($mountPoint, IStorage $storage, IMountPoint $mount) use ($reSharingEnabled, $sharingEnabledForUser) {
+			function($mountPoint, IStorage $storage, IMountPoint $mount) use ($reSharingEnabled, $sharingEnabledForUser) {
 				$sharingEnabledForMount = $mount->getOption('enable_sharing', true);
 				$isShared = $mount instanceof ISharedMountPoint;
 				if (!$sharingEnabledForMount || !$sharingEnabledForUser || (!$reSharingEnabled && $isShared)) {
@@ -135,7 +135,7 @@ 
 		);
 
 		// install storage availability wrapper, before most other wrappers
-		Filesystem::addStorageWrapper('oc_availability', function ($mountPoint, IStorage $storage, IMountPoint $mount) {
+		Filesystem::addStorageWrapper('oc_availability', function($mountPoint, IStorage $storage, IMountPoint $mount) {
 			$externalMount = $mount instanceof ExternalMountPoint || $mount instanceof Mount;
 			if ($externalMount && !$storage->isLocal()) {
 				return new Availability(['storage' => $storage]);
@@ -143,7 +143,7 @@ 
 			return $storage;
 		});
 
-		Filesystem::addStorageWrapper('oc_encoding', function ($mountPoint, IStorage $storage, IMountPoint $mount) {
+		Filesystem::addStorageWrapper('oc_encoding', function($mountPoint, IStorage $storage, IMountPoint $mount) {
 			if ($mount->getOption('encoding_compatibility', false) && !$mount instanceof SharedMount) {
 				return new Encoding(['storage' => $storage]);
 			}
@@ -151,12 +151,12 @@ 
 		});
 
 		$quotaIncludeExternal = $this->config->getSystemValue('quota_include_external_storage', false);
-		Filesystem::addStorageWrapper('oc_quota', function ($mountPoint, $storage, IMountPoint $mount) use ($quotaIncludeExternal) {
+		Filesystem::addStorageWrapper('oc_quota', function($mountPoint, $storage, IMountPoint $mount) use ($quotaIncludeExternal) {
 			// set up quota for home storages, even for other users
 			// which can happen when using sharing
 			if ($mount instanceof HomeMountPoint) {
 				$user = $mount->getUser();
-				return new Quota(['storage' => $storage, 'quotaCallback' => function () use ($user) {
+				return new Quota(['storage' => $storage, 'quotaCallback' => function() use ($user) {
 					return $user->getQuotaBytes();
 				}, 'root' => 'files', 'include_external_storage' => $quotaIncludeExternal]);
 			}
@@ -164,7 +164,7 @@ 
 			return $storage;
 		});
 
-		Filesystem::addStorageWrapper('readonly', function ($mountPoint, IStorage $storage, IMountPoint $mount) {
+		Filesystem::addStorageWrapper('readonly', function($mountPoint, IStorage $storage, IMountPoint $mount) {
 			/*
 			 * Do not allow any operations that modify the storage
 			 */
@@ -201,8 +201,8 @@ 
 
 		$previouslySetupProviders = $this->setupUserMountProviders[$user->getUID()];
 
-		$this->setupForUserWith($user, function () use ($user) {
-			$this->mountProviderCollection->addMountForUser($user, $this->mountManager, function (
+		$this->setupForUserWith($user, function() use ($user) {
+			$this->mountProviderCollection->addMountForUser($user, $this->mountManager, function(
 				IMountProvider $provider,
 			) use ($user) {
 				return !in_array(get_class($provider), $this->setupUserMountProviders[$user->getUID()]);
@@ -237,7 +237,7 @@ 
 
 		Filesystem::logWarningWhenAddingStorageWrapper($prevLogging);
 
-		$userDir = '/' . $user->getUID() . '/files';
+		$userDir = '/'.$user->getUID().'/files';
 
 		Filesystem::initInternal($userDir);
 
@@ -257,11 +257,11 @@ 
 		} else {
 			$this->mountManager->addMount(new MountPoint(
 				new NullStorage([]),
-				'/' . $user->getUID()
+				'/'.$user->getUID()
 			));
 			$this->mountManager->addMount(new MountPoint(
 				new NullStorage([]),
-				'/' . $user->getUID() . '/files'
+				'/'.$user->getUID().'/files'
 			));
 			$this->setupUsersComplete[] = $user->getUID();
 		}
@@ -276,12 +276,12 @@ 
 	 */
 	private function afterUserFullySetup(IUser $user, array $previouslySetupProviders): void {
 		$this->eventLogger->start('fs:setup:user:full:post', 'Housekeeping after user is setup');
-		$userRoot = '/' . $user->getUID() . '/';
+		$userRoot = '/'.$user->getUID().'/';
 		$mounts = $this->mountManager->getAll();
-		$mounts = array_filter($mounts, function (IMountPoint $mount) use ($userRoot) {
+		$mounts = array_filter($mounts, function(IMountPoint $mount) use ($userRoot) {
 			return str_starts_with($mount->getMountPoint(), $userRoot);
 		});
-		$allProviders = array_map(function (IMountProvider|IHomeMountProvider|IRootMountProvider $provider) {
+		$allProviders = array_map(function(IMountProvider | IHomeMountProvider | IRootMountProvider $provider) {
 			return get_class($provider);
 		}, array_merge(
 			$this->mountProviderCollection->getProviders(),
@@ -289,7 +289,7 @@ 
 			$this->mountProviderCollection->getRootProviders(),
 		));
 		$newProviders = array_diff($allProviders, $previouslySetupProviders);
-		$mounts = array_filter($mounts, function (IMountPoint $mount) use ($previouslySetupProviders) {
+		$mounts = array_filter($mounts, function(IMountPoint $mount) use ($previouslySetupProviders) {
 			return !in_array($mount->getMountProvider(), $previouslySetupProviders);
 		});
 		$this->userMountCache->registerMounts($user, $mounts, $newProviders);
@@ -319,7 +319,7 @@ 
 		\OC_Hook::emit('OC_Filesystem', 'post_initMountPoints', ['user' => $user->getUID()]);
 		$this->eventLogger->end('fs:setup:user:post-init-mountpoint');
 
-		$userDir = '/' . $user->getUID() . '/files';
+		$userDir = '/'.$user->getUID().'/files';
 		$this->eventLogger->start('fs:setup:user:setup-hook', 'setup legacy hook');
 		OC_Hook::emit('OC_Filesystem', 'setup', ['user' => $user->getUID(), 'user_dir' => $userDir]);
 		$this->eventLogger->end('fs:setup:user:setup-hook');
@@ -363,7 +363,7 @@ 
 			} else {
 				return null;
 			}
-		} elseif (str_starts_with($path, '/appdata_' . \OC_Util::getInstanceId()) || str_starts_with($path, '/files_external/')) {
+		} elseif (str_starts_with($path, '/appdata_'.\OC_Util::getInstanceId()) || str_starts_with($path, '/files_external/')) {
 			return null;
 		} else {
 			[, $userId] = explode('/', $path);
@@ -392,7 +392,7 @@ 
 		}
 
 		// for the user's home folder, and includes children we need everything always
-		if (rtrim($path) === '/' . $user->getUID() . '/files' && $includeChildren) {
+		if (rtrim($path) === '/'.$user->getUID().'/files' && $includeChildren) {
 			$this->setupForUser($user);
 			return;
 		}
@@ -422,7 +422,7 @@ 
 				$setupProviders[] = $cachedMount->getMountProvider();
 				$mounts = $this->mountProviderCollection->getUserMountsForProviderClasses($user, [$cachedMount->getMountProvider()]);
 			} else {
-				$this->logger->debug('mount at ' . $cachedMount->getMountPoint() . ' has no provider set, performing full setup');
+				$this->logger->debug('mount at '.$cachedMount->getMountPoint().' has no provider set, performing full setup');
 				$this->eventLogger->end('fs:setup:user:path:find');
 				$this->setupForUser($user);
 				$this->eventLogger->end('fs:setup:user:path');
@@ -434,7 +434,7 @@ 
 			$subCachedMounts = $this->userMountCache->getMountsInPath($user, $path);
 			$this->eventLogger->end('fs:setup:user:path:find');
 
-			$needsFullSetup = array_reduce($subCachedMounts, function (bool $needsFullSetup, ICachedMountInfo $cachedMountInfo) {
+			$needsFullSetup = array_reduce($subCachedMounts, function(bool $needsFullSetup, ICachedMountInfo $cachedMountInfo) {
 				return $needsFullSetup || $cachedMountInfo->getMountProvider() === '';
 			}, false);
 
@@ -458,7 +458,7 @@ 
 
 		if (count($mounts)) {
 			$this->userMountCache->registerMounts($user, $mounts, $currentProviders);
-			$this->setupForUserWith($user, function () use ($mounts) {
+			$this->setupForUserWith($user, function() use ($mounts) {
 				array_walk($mounts, [$this->mountManager, 'addMount']);
 			});
 		} elseif (!$this->isSetupStarted($user)) {
@@ -501,12 +501,12 @@ 
 			return;
 		}
 
-		$this->eventLogger->start('fs:setup:user:providers', 'Setup filesystem for ' . implode(', ', $providers));
+		$this->eventLogger->start('fs:setup:user:providers', 'Setup filesystem for '.implode(', ', $providers));
 
 		$this->oneTimeUserSetup($user);
 
 		// home providers are always used
-		$providers = array_filter($providers, function (string $provider) {
+		$providers = array_filter($providers, function(string $provider) {
 			return !is_subclass_of($provider, IHomeMountProvider::class);
 		});
 
@@ -529,7 +529,7 @@ 
 		}
 
 		$this->userMountCache->registerMounts($user, $mounts, $providers);
-		$this->setupForUserWith($user, function () use ($mounts) {
+		$this->setupForUserWith($user, function() use ($mounts) {
 			array_walk($mounts, [$this->mountManager, 'addMount']);
 		});
 		$this->eventLogger->end('fs:setup:user:providers');
@@ -551,7 +551,7 @@ 
 	private function listenForNewMountProviders() {
 		if (!$this->listeningForProviders) {
 			$this->listeningForProviders = true;
-			$this->mountProviderCollection->listen('\OC\Files\Config', 'registerMountProvider', function (
+			$this->mountProviderCollection->listen('\OC\Files\Config', 'registerMountProvider', function(
 				IMountProvider $provider,
 			) {
 				foreach ($this->setupUsers as $userId) {
@@ -569,16 +569,16 @@ 
 		// note that this event handling is intentionally pessimistic
 		// clearing the cache to often is better than not enough
 
-		$this->eventDispatcher->addListener(UserAddedEvent::class, function (UserAddedEvent $event) {
+		$this->eventDispatcher->addListener(UserAddedEvent::class, function(UserAddedEvent $event) {
 			$this->cache->remove($event->getUser()->getUID());
 		});
-		$this->eventDispatcher->addListener(UserRemovedEvent::class, function (UserRemovedEvent $event) {
+		$this->eventDispatcher->addListener(UserRemovedEvent::class, function(UserRemovedEvent $event) {
 			$this->cache->remove($event->getUser()->getUID());
 		});
-		$this->eventDispatcher->addListener(ShareCreatedEvent::class, function (ShareCreatedEvent $event) {
+		$this->eventDispatcher->addListener(ShareCreatedEvent::class, function(ShareCreatedEvent $event) {
 			$this->cache->remove($event->getShare()->getSharedWith());
 		});
-		$this->eventDispatcher->addListener(InvalidateMountCacheEvent::class, function (InvalidateMountCacheEvent $event,
+		$this->eventDispatcher->addListener(InvalidateMountCacheEvent::class, function(InvalidateMountCacheEvent $event,
 		) {
 			if ($user = $event->getUser()) {
 				$this->cache->remove($user->getUID());
@@ -595,7 +595,7 @@ 
 		];
 
 		foreach ($genericEvents as $genericEvent) {
-			$this->eventDispatcher->addListener($genericEvent, function ($event) {
+			$this->eventDispatcher->addListener($genericEvent, function($event) {
 				$this->cache->clear();
 			});
 		}

lib/private/Files/SetupManagerFactory.php

Indentation +37 added lines, -37 removed lines

@@ -23,43 +23,43 @@
 use Psr\Log\LoggerInterface;
 
 class SetupManagerFactory {
-	private ?SetupManager $setupManager;
+    private ?SetupManager $setupManager;
 
-	public function __construct(
-		private IEventLogger $eventLogger,
-		private IMountProviderCollection $mountProviderCollection,
-		private IUserManager $userManager,
-		private IEventDispatcher $eventDispatcher,
-		private IUserMountCache $userMountCache,
-		private ILockdownManager $lockdownManager,
-		private IUserSession $userSession,
-		private ICacheFactory $cacheFactory,
-		private LoggerInterface $logger,
-		private IConfig $config,
-		private ShareDisableChecker $shareDisableChecker,
-		private IAppManager $appManager,
-	) {
-		$this->setupManager = null;
-	}
+    public function __construct(
+        private IEventLogger $eventLogger,
+        private IMountProviderCollection $mountProviderCollection,
+        private IUserManager $userManager,
+        private IEventDispatcher $eventDispatcher,
+        private IUserMountCache $userMountCache,
+        private ILockdownManager $lockdownManager,
+        private IUserSession $userSession,
+        private ICacheFactory $cacheFactory,
+        private LoggerInterface $logger,
+        private IConfig $config,
+        private ShareDisableChecker $shareDisableChecker,
+        private IAppManager $appManager,
+    ) {
+        $this->setupManager = null;
+    }
 
-	public function create(IMountManager $mountManager): SetupManager {
-		if (!$this->setupManager) {
-			$this->setupManager = new SetupManager(
-				$this->eventLogger,
-				$this->mountProviderCollection,
-				$mountManager,
-				$this->userManager,
-				$this->eventDispatcher,
-				$this->userMountCache,
-				$this->lockdownManager,
-				$this->userSession,
-				$this->cacheFactory,
-				$this->logger,
-				$this->config,
-				$this->shareDisableChecker,
-				$this->appManager,
-			);
-		}
-		return $this->setupManager;
-	}
+    public function create(IMountManager $mountManager): SetupManager {
+        if (!$this->setupManager) {
+            $this->setupManager = new SetupManager(
+                $this->eventLogger,
+                $this->mountProviderCollection,
+                $mountManager,
+                $this->userManager,
+                $this->eventDispatcher,
+                $this->userMountCache,
+                $this->lockdownManager,
+                $this->userSession,
+                $this->cacheFactory,
+                $this->logger,
+                $this->config,
+                $this->shareDisableChecker,
+                $this->appManager,
+            );
+        }
+        return $this->setupManager;
+    }
 }

core/Command/Db/ConvertType.php

Indentation +428 added lines, -428 removed lines

@@ -34,432 +34,432 @@
 use function preg_quote;
 
 class ConvertType extends Command implements CompletionAwareInterface {
-	protected array $columnTypes = [];
-
-	public function __construct(
-		protected IConfig $config,
-		protected ConnectionFactory $connectionFactory,
-		protected IAppManager $appManager,
-	) {
-		parent::__construct();
-	}
-
-	protected function configure() {
-		$this
-			->setName('db:convert-type')
-			->setDescription('Convert the Nextcloud database to the newly configured one')
-			->addArgument(
-				'type',
-				InputArgument::REQUIRED,
-				'the type of the database to convert to'
-			)
-			->addArgument(
-				'username',
-				InputArgument::REQUIRED,
-				'the username of the database to convert to'
-			)
-			->addArgument(
-				'hostname',
-				InputArgument::REQUIRED,
-				'the hostname of the database to convert to'
-			)
-			->addArgument(
-				'database',
-				InputArgument::REQUIRED,
-				'the name of the database to convert to'
-			)
-			->addOption(
-				'port',
-				null,
-				InputOption::VALUE_REQUIRED,
-				'the port of the database to convert to'
-			)
-			->addOption(
-				'password',
-				null,
-				InputOption::VALUE_REQUIRED,
-				'the password of the database to convert to. Will be asked when not specified. Can also be passed via stdin.'
-			)
-			->addOption(
-				'clear-schema',
-				null,
-				InputOption::VALUE_NONE,
-				'remove all tables from the destination database'
-			)
-			->addOption(
-				'all-apps',
-				null,
-				InputOption::VALUE_NONE,
-				'whether to create schema for all apps instead of only installed apps'
-			)
-			->addOption(
-				'chunk-size',
-				null,
-				InputOption::VALUE_REQUIRED,
-				'the maximum number of database rows to handle in a single query, bigger tables will be handled in chunks of this size. Lower this if the process runs out of memory during conversion.',
-				'1000'
-			)
-		;
-	}
-
-	protected function validateInput(InputInterface $input, OutputInterface $output) {
-		$type = $this->connectionFactory->normalizeType($input->getArgument('type'));
-		if ($type === 'sqlite3') {
-			throw new \InvalidArgumentException(
-				'Converting to SQLite (sqlite3) is currently not supported.'
-			);
-		}
-		if ($type === $this->config->getSystemValue('dbtype', '')) {
-			throw new \InvalidArgumentException(sprintf(
-				'Can not convert from %1$s to %1$s.',
-				$type
-			));
-		}
-		if ($type === 'oci' && $input->getOption('clear-schema')) {
-			// Doctrine unconditionally tries (at least in version 2.3)
-			// to drop sequence triggers when dropping a table, even though
-			// such triggers may not exist. This results in errors like
-			// "ORA-04080: trigger 'OC_STORAGES_AI_PK' does not exist".
-			throw new \InvalidArgumentException(
-				'The --clear-schema option is not supported when converting to Oracle (oci).'
-			);
-		}
-	}
-
-	protected function readPassword(InputInterface $input, OutputInterface $output) {
-		// Explicitly specified password
-		if ($input->getOption('password')) {
-			return;
-		}
-
-		// Read from stdin. stream_set_blocking is used to prevent blocking
-		// when nothing is passed via stdin.
-		stream_set_blocking(STDIN, 0);
-		$password = file_get_contents('php://stdin');
-		stream_set_blocking(STDIN, 1);
-		if (trim($password) !== '') {
-			$input->setOption('password', $password);
-			return;
-		}
-
-		// Read password by interacting
-		if ($input->isInteractive()) {
-			/** @var QuestionHelper $helper */
-			$helper = $this->getHelper('question');
-			$question = new Question('What is the database password (press <enter> for none)? ');
-			$question->setHidden(true);
-			$question->setHiddenFallback(false);
-			$password = $helper->ask($input, $output, $question);
-			if ($password === null) {
-				$password = ''; // possibly unnecessary
-			}
-			$input->setOption('password', $password);
-			return;
-		}
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$this->validateInput($input, $output);
-		$this->readPassword($input, $output);
-
-		/** @var Connection $fromDB */
-		$fromDB = Server::get(Connection::class);
-		$toDB = $this->getToDBConnection($input, $output);
-
-		if ($input->getOption('clear-schema')) {
-			$this->clearSchema($toDB, $input, $output);
-		}
-
-		$this->createSchema($fromDB, $toDB, $input, $output);
-
-		$toTables = $this->getTables($toDB);
-		$fromTables = $this->getTables($fromDB);
-
-		// warn/fail if there are more tables in 'from' database
-		$extraFromTables = array_diff($fromTables, $toTables);
-		if (!empty($extraFromTables)) {
-			$output->writeln('<comment>The following tables will not be converted:</comment>');
-			$output->writeln($extraFromTables);
-			if (!$input->getOption('all-apps')) {
-				$output->writeln('<comment>Please note that tables belonging to disabled (but not removed) apps</comment>');
-				$output->writeln('<comment>can be included by specifying the --all-apps option.</comment>');
-			}
-
-			$continueConversion = !$input->isInteractive(); // assume yes for --no-interaction and no otherwise.
-			$question = new ConfirmationQuestion('Continue with the conversion (y/n)? [n] ', $continueConversion);
-
-			/** @var QuestionHelper $helper */
-			$helper = $this->getHelper('question');
-
-			if (!$helper->ask($input, $output, $question)) {
-				return 1;
-			}
-		}
-		$intersectingTables = array_intersect($toTables, $fromTables);
-		$this->convertDB($fromDB, $toDB, $intersectingTables, $input, $output);
-		return 0;
-	}
-
-	protected function createSchema(Connection $fromDB, Connection $toDB, InputInterface $input, OutputInterface $output) {
-		$output->writeln('<info>Creating schema in new database</info>');
-
-		$fromMS = new MigrationService('core', $fromDB);
-		$currentMigration = $fromMS->getMigration('current');
-		if ($currentMigration !== '0') {
-			$toMS = new MigrationService('core', $toDB);
-			$toMS->migrate($currentMigration);
-		}
-
-		$apps = $input->getOption('all-apps')
-			? $this->appManager->getAllAppsInAppsFolders()
-			: $this->appManager->getEnabledApps();
-		foreach ($apps as $app) {
-			$output->writeln('<info> - ' . $app . '</info>');
-			// Make sure autoloading works...
-			$this->appManager->loadApp($app);
-			$fromMS = new MigrationService($app, $fromDB);
-			$currentMigration = $fromMS->getMigration('current');
-			if ($currentMigration !== '0') {
-				$toMS = new MigrationService($app, $toDB);
-				$toMS->migrate($currentMigration, true);
-			}
-		}
-	}
-
-	protected function getToDBConnection(InputInterface $input, OutputInterface $output) {
-		$type = $input->getArgument('type');
-		$connectionParams = $this->connectionFactory->createConnectionParams(type: $type);
-		$connectionParams = array_merge($connectionParams, [
-			'host' => $input->getArgument('hostname'),
-			'user' => $input->getArgument('username'),
-			'password' => $input->getOption('password'),
-			'dbname' => $input->getArgument('database'),
-		]);
-
-		// parse port
-		if ($input->getOption('port')) {
-			$connectionParams['port'] = $input->getOption('port');
-		}
-
-		// parse hostname for unix socket
-		if (preg_match('/^(.+)(:(\d+|[^:]+))?$/', $input->getArgument('hostname'), $matches)) {
-			$connectionParams['host'] = $matches[1];
-			if (isset($matches[3])) {
-				if (is_numeric($matches[3])) {
-					$connectionParams['port'] = $matches[3];
-				} else {
-					$connectionParams['unix_socket'] = $matches[3];
-				}
-			}
-		}
-
-		return $this->connectionFactory->getConnection($type, $connectionParams);
-	}
-
-	protected function clearSchema(Connection $db, InputInterface $input, OutputInterface $output) {
-		$toTables = $this->getTables($db);
-		if (!empty($toTables)) {
-			$output->writeln('<info>Clearing schema in new database</info>');
-		}
-		foreach ($toTables as $table) {
-			$db->createSchemaManager()->dropTable($table);
-		}
-	}
-
-	protected function getTables(Connection $db) {
-		$db->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
-			/** @var string|AbstractAsset $asset */
-			$filterExpression = '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
-			if ($asset instanceof AbstractAsset) {
-				return preg_match($filterExpression, $asset->getName()) !== false;
-			}
-			return preg_match($filterExpression, $asset) !== false;
-		});
-		return $db->createSchemaManager()->listTableNames();
-	}
-
-	/**
-	 * @param Connection $fromDB
-	 * @param Connection $toDB
-	 * @param Table $table
-	 * @param InputInterface $input
-	 * @param OutputInterface $output
-	 */
-	protected function copyTable(Connection $fromDB, Connection $toDB, Table $table, InputInterface $input, OutputInterface $output) {
-		if ($table->getName() === $toDB->getPrefix() . 'migrations') {
-			$output->writeln('<comment>Skipping migrations table because it was already filled by running the migrations</comment>');
-			return;
-		}
-
-		$chunkSize = (int)$input->getOption('chunk-size');
-
-		$query = $fromDB->getQueryBuilder();
-		$query->automaticTablePrefix(false);
-		$query->select($query->func()->count('*', 'num_entries'))
-			->from($table->getName());
-		$result = $query->executeQuery();
-		$count = $result->fetchOne();
-		$result->closeCursor();
-
-		$numChunks = ceil($count / $chunkSize);
-		if ($numChunks > 1) {
-			$output->writeln('chunked query, ' . $numChunks . ' chunks');
-		}
-
-		$progress = new ProgressBar($output, $count);
-		$progress->setFormat('very_verbose');
-		$progress->start();
-		$redraw = $count > $chunkSize ? 100 : ($count > 100 ? 5 : 1);
-		$progress->setRedrawFrequency($redraw);
-
-		$query = $fromDB->getQueryBuilder();
-		$query->automaticTablePrefix(false);
-		$query->select('*')
-			->from($table->getName())
-			->setMaxResults($chunkSize);
-
-		try {
-			$orderColumns = $table->getPrimaryKeyColumns();
-		} catch (Exception $e) {
-			$orderColumns = $table->getColumns();
-		}
-
-		foreach ($orderColumns as $column) {
-			$query->addOrderBy($column->getName());
-		}
-
-		$insertQuery = $toDB->getQueryBuilder();
-		$insertQuery->automaticTablePrefix(false);
-		$insertQuery->insert($table->getName());
-		$parametersCreated = false;
-
-		for ($chunk = 0; $chunk < $numChunks; $chunk++) {
-			$query->setFirstResult($chunk * $chunkSize);
-
-			$result = $query->executeQuery();
-
-			try {
-				$toDB->beginTransaction();
-
-				while ($row = $result->fetch()) {
-					$progress->advance();
-					if (!$parametersCreated) {
-						foreach ($row as $key => $value) {
-							$insertQuery->setValue($key, $insertQuery->createParameter($key));
-						}
-						$parametersCreated = true;
-					}
-
-					foreach ($row as $key => $value) {
-						$type = $this->getColumnType($table, $key);
-						if ($type !== false) {
-							$insertQuery->setParameter($key, $value, $type);
-						} else {
-							$insertQuery->setParameter($key, $value);
-						}
-					}
-					$insertQuery->execute();
-				}
-				$result->closeCursor();
-
-				$toDB->commit();
-			} catch (\Throwable $e) {
-				$toDB->rollBack();
-				throw $e;
-			}
-		}
-
-		$progress->finish();
-		$output->writeln('');
-	}
-
-	protected function getColumnType(Table $table, $columnName) {
-		$tableName = $table->getName();
-		if (isset($this->columnTypes[$tableName][$columnName])) {
-			return $this->columnTypes[$tableName][$columnName];
-		}
-
-		$type = $table->getColumn($columnName)->getType()->getName();
-
-		switch ($type) {
-			case Types::BLOB:
-			case Types::TEXT:
-				$this->columnTypes[$tableName][$columnName] = IQueryBuilder::PARAM_LOB;
-				break;
-			case Types::BOOLEAN:
-				$this->columnTypes[$tableName][$columnName] = IQueryBuilder::PARAM_BOOL;
-				break;
-			default:
-				$this->columnTypes[$tableName][$columnName] = false;
-		}
-
-		return $this->columnTypes[$tableName][$columnName];
-	}
-
-	protected function convertDB(Connection $fromDB, Connection $toDB, array $tables, InputInterface $input, OutputInterface $output) {
-		$this->config->setSystemValue('maintenance', true);
-		$schema = $fromDB->createSchema();
-
-		try {
-			// copy table rows
-			foreach ($tables as $table) {
-				$output->writeln('<info> - ' . $table . '</info>');
-				$this->copyTable($fromDB, $toDB, $schema->getTable($table), $input, $output);
-			}
-			if ($input->getArgument('type') === 'pgsql') {
-				$tools = new PgSqlTools($this->config);
-				$tools->resynchronizeDatabaseSequences($toDB);
-			}
-			// save new database config
-			$this->saveDBInfo($input);
-		} catch (\Exception $e) {
-			$this->config->setSystemValue('maintenance', false);
-			throw $e;
-		}
-		$this->config->setSystemValue('maintenance', false);
-	}
-
-	protected function saveDBInfo(InputInterface $input) {
-		$type = $input->getArgument('type');
-		$username = $input->getArgument('username');
-		$dbHost = $input->getArgument('hostname');
-		$dbName = $input->getArgument('database');
-		$password = $input->getOption('password');
-		if ($input->getOption('port')) {
-			$dbHost .= ':' . $input->getOption('port');
-		}
-
-		$this->config->setSystemValues([
-			'dbtype' => $type,
-			'dbname' => $dbName,
-			'dbhost' => $dbHost,
-			'dbuser' => $username,
-			'dbpassword' => $password,
-		]);
-	}
-
-	/**
-	 * Return possible values for the named option
-	 *
-	 * @param string $optionName
-	 * @param CompletionContext $context
-	 * @return string[]
-	 */
-	public function completeOptionValues($optionName, CompletionContext $context) {
-		return [];
-	}
-
-	/**
-	 * Return possible values for the named argument
-	 *
-	 * @param string $argumentName
-	 * @param CompletionContext $context
-	 * @return string[]
-	 */
-	public function completeArgumentValues($argumentName, CompletionContext $context) {
-		if ($argumentName === 'type') {
-			return ['mysql', 'oci', 'pgsql'];
-		}
-		return [];
-	}
+    protected array $columnTypes = [];
+
+    public function __construct(
+        protected IConfig $config,
+        protected ConnectionFactory $connectionFactory,
+        protected IAppManager $appManager,
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure() {
+        $this
+            ->setName('db:convert-type')
+            ->setDescription('Convert the Nextcloud database to the newly configured one')
+            ->addArgument(
+                'type',
+                InputArgument::REQUIRED,
+                'the type of the database to convert to'
+            )
+            ->addArgument(
+                'username',
+                InputArgument::REQUIRED,
+                'the username of the database to convert to'
+            )
+            ->addArgument(
+                'hostname',
+                InputArgument::REQUIRED,
+                'the hostname of the database to convert to'
+            )
+            ->addArgument(
+                'database',
+                InputArgument::REQUIRED,
+                'the name of the database to convert to'
+            )
+            ->addOption(
+                'port',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'the port of the database to convert to'
+            )
+            ->addOption(
+                'password',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'the password of the database to convert to. Will be asked when not specified. Can also be passed via stdin.'
+            )
+            ->addOption(
+                'clear-schema',
+                null,
+                InputOption::VALUE_NONE,
+                'remove all tables from the destination database'
+            )
+            ->addOption(
+                'all-apps',
+                null,
+                InputOption::VALUE_NONE,
+                'whether to create schema for all apps instead of only installed apps'
+            )
+            ->addOption(
+                'chunk-size',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'the maximum number of database rows to handle in a single query, bigger tables will be handled in chunks of this size. Lower this if the process runs out of memory during conversion.',
+                '1000'
+            )
+        ;
+    }
+
+    protected function validateInput(InputInterface $input, OutputInterface $output) {
+        $type = $this->connectionFactory->normalizeType($input->getArgument('type'));
+        if ($type === 'sqlite3') {
+            throw new \InvalidArgumentException(
+                'Converting to SQLite (sqlite3) is currently not supported.'
+            );
+        }
+        if ($type === $this->config->getSystemValue('dbtype', '')) {
+            throw new \InvalidArgumentException(sprintf(
+                'Can not convert from %1$s to %1$s.',
+                $type
+            ));
+        }
+        if ($type === 'oci' && $input->getOption('clear-schema')) {
+            // Doctrine unconditionally tries (at least in version 2.3)
+            // to drop sequence triggers when dropping a table, even though
+            // such triggers may not exist. This results in errors like
+            // "ORA-04080: trigger 'OC_STORAGES_AI_PK' does not exist".
+            throw new \InvalidArgumentException(
+                'The --clear-schema option is not supported when converting to Oracle (oci).'
+            );
+        }
+    }
+
+    protected function readPassword(InputInterface $input, OutputInterface $output) {
+        // Explicitly specified password
+        if ($input->getOption('password')) {
+            return;
+        }
+
+        // Read from stdin. stream_set_blocking is used to prevent blocking
+        // when nothing is passed via stdin.
+        stream_set_blocking(STDIN, 0);
+        $password = file_get_contents('php://stdin');
+        stream_set_blocking(STDIN, 1);
+        if (trim($password) !== '') {
+            $input->setOption('password', $password);
+            return;
+        }
+
+        // Read password by interacting
+        if ($input->isInteractive()) {
+            /** @var QuestionHelper $helper */
+            $helper = $this->getHelper('question');
+            $question = new Question('What is the database password (press <enter> for none)? ');
+            $question->setHidden(true);
+            $question->setHiddenFallback(false);
+            $password = $helper->ask($input, $output, $question);
+            if ($password === null) {
+                $password = ''; // possibly unnecessary
+            }
+            $input->setOption('password', $password);
+            return;
+        }
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        $this->validateInput($input, $output);
+        $this->readPassword($input, $output);
+
+        /** @var Connection $fromDB */
+        $fromDB = Server::get(Connection::class);
+        $toDB = $this->getToDBConnection($input, $output);
+
+        if ($input->getOption('clear-schema')) {
+            $this->clearSchema($toDB, $input, $output);
+        }
+
+        $this->createSchema($fromDB, $toDB, $input, $output);
+
+        $toTables = $this->getTables($toDB);
+        $fromTables = $this->getTables($fromDB);
+
+        // warn/fail if there are more tables in 'from' database
+        $extraFromTables = array_diff($fromTables, $toTables);
+        if (!empty($extraFromTables)) {
+            $output->writeln('<comment>The following tables will not be converted:</comment>');
+            $output->writeln($extraFromTables);
+            if (!$input->getOption('all-apps')) {
+                $output->writeln('<comment>Please note that tables belonging to disabled (but not removed) apps</comment>');
+                $output->writeln('<comment>can be included by specifying the --all-apps option.</comment>');
+            }
+
+            $continueConversion = !$input->isInteractive(); // assume yes for --no-interaction and no otherwise.
+            $question = new ConfirmationQuestion('Continue with the conversion (y/n)? [n] ', $continueConversion);
+
+            /** @var QuestionHelper $helper */
+            $helper = $this->getHelper('question');
+
+            if (!$helper->ask($input, $output, $question)) {
+                return 1;
+            }
+        }
+        $intersectingTables = array_intersect($toTables, $fromTables);
+        $this->convertDB($fromDB, $toDB, $intersectingTables, $input, $output);
+        return 0;
+    }
+
+    protected function createSchema(Connection $fromDB, Connection $toDB, InputInterface $input, OutputInterface $output) {
+        $output->writeln('<info>Creating schema in new database</info>');
+
+        $fromMS = new MigrationService('core', $fromDB);
+        $currentMigration = $fromMS->getMigration('current');
+        if ($currentMigration !== '0') {
+            $toMS = new MigrationService('core', $toDB);
+            $toMS->migrate($currentMigration);
+        }
+
+        $apps = $input->getOption('all-apps')
+            ? $this->appManager->getAllAppsInAppsFolders()
+            : $this->appManager->getEnabledApps();
+        foreach ($apps as $app) {
+            $output->writeln('<info> - ' . $app . '</info>');
+            // Make sure autoloading works...
+            $this->appManager->loadApp($app);
+            $fromMS = new MigrationService($app, $fromDB);
+            $currentMigration = $fromMS->getMigration('current');
+            if ($currentMigration !== '0') {
+                $toMS = new MigrationService($app, $toDB);
+                $toMS->migrate($currentMigration, true);
+            }
+        }
+    }
+
+    protected function getToDBConnection(InputInterface $input, OutputInterface $output) {
+        $type = $input->getArgument('type');
+        $connectionParams = $this->connectionFactory->createConnectionParams(type: $type);
+        $connectionParams = array_merge($connectionParams, [
+            'host' => $input->getArgument('hostname'),
+            'user' => $input->getArgument('username'),
+            'password' => $input->getOption('password'),
+            'dbname' => $input->getArgument('database'),
+        ]);
+
+        // parse port
+        if ($input->getOption('port')) {
+            $connectionParams['port'] = $input->getOption('port');
+        }
+
+        // parse hostname for unix socket
+        if (preg_match('/^(.+)(:(\d+|[^:]+))?$/', $input->getArgument('hostname'), $matches)) {
+            $connectionParams['host'] = $matches[1];
+            if (isset($matches[3])) {
+                if (is_numeric($matches[3])) {
+                    $connectionParams['port'] = $matches[3];
+                } else {
+                    $connectionParams['unix_socket'] = $matches[3];
+                }
+            }
+        }
+
+        return $this->connectionFactory->getConnection($type, $connectionParams);
+    }
+
+    protected function clearSchema(Connection $db, InputInterface $input, OutputInterface $output) {
+        $toTables = $this->getTables($db);
+        if (!empty($toTables)) {
+            $output->writeln('<info>Clearing schema in new database</info>');
+        }
+        foreach ($toTables as $table) {
+            $db->createSchemaManager()->dropTable($table);
+        }
+    }
+
+    protected function getTables(Connection $db) {
+        $db->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
+            /** @var string|AbstractAsset $asset */
+            $filterExpression = '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
+            if ($asset instanceof AbstractAsset) {
+                return preg_match($filterExpression, $asset->getName()) !== false;
+            }
+            return preg_match($filterExpression, $asset) !== false;
+        });
+        return $db->createSchemaManager()->listTableNames();
+    }
+
+    /**
+     * @param Connection $fromDB
+     * @param Connection $toDB
+     * @param Table $table
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     */
+    protected function copyTable(Connection $fromDB, Connection $toDB, Table $table, InputInterface $input, OutputInterface $output) {
+        if ($table->getName() === $toDB->getPrefix() . 'migrations') {
+            $output->writeln('<comment>Skipping migrations table because it was already filled by running the migrations</comment>');
+            return;
+        }
+
+        $chunkSize = (int)$input->getOption('chunk-size');
+
+        $query = $fromDB->getQueryBuilder();
+        $query->automaticTablePrefix(false);
+        $query->select($query->func()->count('*', 'num_entries'))
+            ->from($table->getName());
+        $result = $query->executeQuery();
+        $count = $result->fetchOne();
+        $result->closeCursor();
+
+        $numChunks = ceil($count / $chunkSize);
+        if ($numChunks > 1) {
+            $output->writeln('chunked query, ' . $numChunks . ' chunks');
+        }
+
+        $progress = new ProgressBar($output, $count);
+        $progress->setFormat('very_verbose');
+        $progress->start();
+        $redraw = $count > $chunkSize ? 100 : ($count > 100 ? 5 : 1);
+        $progress->setRedrawFrequency($redraw);
+
+        $query = $fromDB->getQueryBuilder();
+        $query->automaticTablePrefix(false);
+        $query->select('*')
+            ->from($table->getName())
+            ->setMaxResults($chunkSize);
+
+        try {
+            $orderColumns = $table->getPrimaryKeyColumns();
+        } catch (Exception $e) {
+            $orderColumns = $table->getColumns();
+        }
+
+        foreach ($orderColumns as $column) {
+            $query->addOrderBy($column->getName());
+        }
+
+        $insertQuery = $toDB->getQueryBuilder();
+        $insertQuery->automaticTablePrefix(false);
+        $insertQuery->insert($table->getName());
+        $parametersCreated = false;
+
+        for ($chunk = 0; $chunk < $numChunks; $chunk++) {
+            $query->setFirstResult($chunk * $chunkSize);
+
+            $result = $query->executeQuery();
+
+            try {
+                $toDB->beginTransaction();
+
+                while ($row = $result->fetch()) {
+                    $progress->advance();
+                    if (!$parametersCreated) {
+                        foreach ($row as $key => $value) {
+                            $insertQuery->setValue($key, $insertQuery->createParameter($key));
+                        }
+                        $parametersCreated = true;
+                    }
+
+                    foreach ($row as $key => $value) {
+                        $type = $this->getColumnType($table, $key);
+                        if ($type !== false) {
+                            $insertQuery->setParameter($key, $value, $type);
+                        } else {
+                            $insertQuery->setParameter($key, $value);
+                        }
+                    }
+                    $insertQuery->execute();
+                }
+                $result->closeCursor();
+
+                $toDB->commit();
+            } catch (\Throwable $e) {
+                $toDB->rollBack();
+                throw $e;
+            }
+        }
+
+        $progress->finish();
+        $output->writeln('');
+    }
+
+    protected function getColumnType(Table $table, $columnName) {
+        $tableName = $table->getName();
+        if (isset($this->columnTypes[$tableName][$columnName])) {
+            return $this->columnTypes[$tableName][$columnName];
+        }
+
+        $type = $table->getColumn($columnName)->getType()->getName();
+
+        switch ($type) {
+            case Types::BLOB:
+            case Types::TEXT:
+                $this->columnTypes[$tableName][$columnName] = IQueryBuilder::PARAM_LOB;
+                break;
+            case Types::BOOLEAN:
+                $this->columnTypes[$tableName][$columnName] = IQueryBuilder::PARAM_BOOL;
+                break;
+            default:
+                $this->columnTypes[$tableName][$columnName] = false;
+        }
+
+        return $this->columnTypes[$tableName][$columnName];
+    }
+
+    protected function convertDB(Connection $fromDB, Connection $toDB, array $tables, InputInterface $input, OutputInterface $output) {
+        $this->config->setSystemValue('maintenance', true);
+        $schema = $fromDB->createSchema();
+
+        try {
+            // copy table rows
+            foreach ($tables as $table) {
+                $output->writeln('<info> - ' . $table . '</info>');
+                $this->copyTable($fromDB, $toDB, $schema->getTable($table), $input, $output);
+            }
+            if ($input->getArgument('type') === 'pgsql') {
+                $tools = new PgSqlTools($this->config);
+                $tools->resynchronizeDatabaseSequences($toDB);
+            }
+            // save new database config
+            $this->saveDBInfo($input);
+        } catch (\Exception $e) {
+            $this->config->setSystemValue('maintenance', false);
+            throw $e;
+        }
+        $this->config->setSystemValue('maintenance', false);
+    }
+
+    protected function saveDBInfo(InputInterface $input) {
+        $type = $input->getArgument('type');
+        $username = $input->getArgument('username');
+        $dbHost = $input->getArgument('hostname');
+        $dbName = $input->getArgument('database');
+        $password = $input->getOption('password');
+        if ($input->getOption('port')) {
+            $dbHost .= ':' . $input->getOption('port');
+        }
+
+        $this->config->setSystemValues([
+            'dbtype' => $type,
+            'dbname' => $dbName,
+            'dbhost' => $dbHost,
+            'dbuser' => $username,
+            'dbpassword' => $password,
+        ]);
+    }
+
+    /**
+     * Return possible values for the named option
+     *
+     * @param string $optionName
+     * @param CompletionContext $context
+     * @return string[]
+     */
+    public function completeOptionValues($optionName, CompletionContext $context) {
+        return [];
+    }
+
+    /**
+     * Return possible values for the named argument
+     *
+     * @param string $argumentName
+     * @param CompletionContext $context
+     * @return string[]
+     */
+    public function completeArgumentValues($argumentName, CompletionContext $context) {
+        if ($argumentName === 'type') {
+            return ['mysql', 'oci', 'pgsql'];
+        }
+        return [];
+    }
 }

Spacing +8 added lines, -8 removed lines

@@ -214,7 +214,7 @@ 
 			? $this->appManager->getAllAppsInAppsFolders()
 			: $this->appManager->getEnabledApps();
 		foreach ($apps as $app) {
-			$output->writeln('<info> - ' . $app . '</info>');
+			$output->writeln('<info> - '.$app.'</info>');
 			// Make sure autoloading works...
 			$this->appManager->loadApp($app);
 			$fromMS = new MigrationService($app, $fromDB);
@@ -267,9 +267,9 @@ 
 	}
 
 	protected function getTables(Connection $db) {
-		$db->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
+		$db->getConfiguration()->setSchemaAssetsFilter(function($asset) {
 			/** @var string|AbstractAsset $asset */
-			$filterExpression = '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
+			$filterExpression = '/^'.preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')).'/';
 			if ($asset instanceof AbstractAsset) {
 				return preg_match($filterExpression, $asset->getName()) !== false;
 			}
@@ -286,12 +286,12 @@ 
 	 * @param OutputInterface $output
 	 */
 	protected function copyTable(Connection $fromDB, Connection $toDB, Table $table, InputInterface $input, OutputInterface $output) {
-		if ($table->getName() === $toDB->getPrefix() . 'migrations') {
+		if ($table->getName() === $toDB->getPrefix().'migrations') {
 			$output->writeln('<comment>Skipping migrations table because it was already filled by running the migrations</comment>');
 			return;
 		}
 
-		$chunkSize = (int)$input->getOption('chunk-size');
+		$chunkSize = (int) $input->getOption('chunk-size');
 
 		$query = $fromDB->getQueryBuilder();
 		$query->automaticTablePrefix(false);
@@ -303,7 +303,7 @@ 
 
 		$numChunks = ceil($count / $chunkSize);
 		if ($numChunks > 1) {
-			$output->writeln('chunked query, ' . $numChunks . ' chunks');
+			$output->writeln('chunked query, '.$numChunks.' chunks');
 		}
 
 		$progress = new ProgressBar($output, $count);
@@ -403,7 +403,7 @@ 
 		try {
 			// copy table rows
 			foreach ($tables as $table) {
-				$output->writeln('<info> - ' . $table . '</info>');
+				$output->writeln('<info> - '.$table.'</info>');
 				$this->copyTable($fromDB, $toDB, $schema->getTable($table), $input, $output);
 			}
 			if ($input->getArgument('type') === 'pgsql') {
@@ -426,7 +426,7 @@ 
 		$dbName = $input->getArgument('database');
 		$password = $input->getOption('password');
 		if ($input->getOption('port')) {
-			$dbHost .= ':' . $input->getOption('port');
+			$dbHost .= ':'.$input->getOption('port');
 		}
 
 		$this->config->setSystemValues([

apps/user_status/tests/bootstrap.php

Indentation +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
 use OCP\Server;
 
 if (!defined('PHPUNIT_RUN')) {
-	define('PHPUNIT_RUN', 1);
+    define('PHPUNIT_RUN', 1);
 }
 
 require_once __DIR__ . '/../../../lib/base.php';

Spacing +2 added lines, -2 removed lines

@@ -14,7 +14,7 @@
 	define('PHPUNIT_RUN', 1);
 }
 
-require_once __DIR__ . '/../../../lib/base.php';
-require_once __DIR__ . '/../../../tests/autoload.php';
+require_once __DIR__.'/../../../lib/base.php';
+require_once __DIR__.'/../../../tests/autoload.php';
 
 Server::get(IAppManager::class)->loadApp('user_status');

apps/dav/lib/AppInfo/Application.php

Indentation +146 added lines, -146 removed lines

@@ -103,180 +103,180 @@
 use function is_null;
 
 class Application extends App implements IBootstrap {
-	public const APP_ID = 'dav';
+    public const APP_ID = 'dav';
 
-	public function __construct() {
-		parent::__construct(self::APP_ID);
-	}
+    public function __construct() {
+        parent::__construct(self::APP_ID);
+    }
 
-	public function register(IRegistrationContext $context): void {
-		$context->registerServiceAlias('CardDAVSyncService', SyncService::class);
-		$context->registerService(AppCalendarPlugin::class, function (ContainerInterface $c) {
-			return new AppCalendarPlugin(
-				$c->get(ICalendarManager::class),
-				$c->get(LoggerInterface::class)
-			);
-		});
+    public function register(IRegistrationContext $context): void {
+        $context->registerServiceAlias('CardDAVSyncService', SyncService::class);
+        $context->registerService(AppCalendarPlugin::class, function (ContainerInterface $c) {
+            return new AppCalendarPlugin(
+                $c->get(ICalendarManager::class),
+                $c->get(LoggerInterface::class)
+            );
+        });
 
-		/*
+        /*
 		 * Register capabilities
 		 */
-		$context->registerCapability(Capabilities::class);
+        $context->registerCapability(Capabilities::class);
 
-		/*
+        /*
 		 * Register Search Providers
 		 */
-		$context->registerSearchProvider(ContactsSearchProvider::class);
-		$context->registerSearchProvider(EventsSearchProvider::class);
-		$context->registerSearchProvider(TasksSearchProvider::class);
+        $context->registerSearchProvider(ContactsSearchProvider::class);
+        $context->registerSearchProvider(EventsSearchProvider::class);
+        $context->registerSearchProvider(TasksSearchProvider::class);
 
-		/**
-		 * Register event listeners
-		 */
-		$context->registerEventListener(AddMissingIndicesEvent::class, AddMissingIndicesListener::class);
+        /**
+         * Register event listeners
+         */
+        $context->registerEventListener(AddMissingIndicesEvent::class, AddMissingIndicesListener::class);
 
-		$context->registerEventListener(CalendarCreatedEvent::class, ActivityUpdaterListener::class);
-		$context->registerEventListener(CalendarDeletedEvent::class, ActivityUpdaterListener::class);
-		$context->registerEventListener(CalendarDeletedEvent::class, CalendarObjectReminderUpdaterListener::class);
-		$context->registerEventListener(CalendarDeletedEvent::class, CalendarDeletionDefaultUpdaterListener::class);
-		$context->registerEventListener(CalendarMovedToTrashEvent::class, ActivityUpdaterListener::class);
-		$context->registerEventListener(CalendarMovedToTrashEvent::class, CalendarObjectReminderUpdaterListener::class);
-		$context->registerEventListener(CalendarUpdatedEvent::class, ActivityUpdaterListener::class);
-		$context->registerEventListener(CalendarRestoredEvent::class, ActivityUpdaterListener::class);
-		$context->registerEventListener(CalendarRestoredEvent::class, CalendarObjectReminderUpdaterListener::class);
-		$context->registerEventListener(CalendarObjectCreatedEvent::class, ActivityUpdaterListener::class);
-		$context->registerEventListener(CalendarObjectCreatedEvent::class, CalendarContactInteractionListener::class);
-		$context->registerEventListener(CalendarObjectCreatedEvent::class, CalendarObjectReminderUpdaterListener::class);
-		$context->registerEventListener(CalendarObjectUpdatedEvent::class, ActivityUpdaterListener::class);
-		$context->registerEventListener(CalendarObjectUpdatedEvent::class, CalendarContactInteractionListener::class);
-		$context->registerEventListener(CalendarObjectUpdatedEvent::class, CalendarObjectReminderUpdaterListener::class);
-		$context->registerEventListener(CalendarObjectDeletedEvent::class, ActivityUpdaterListener::class);
-		$context->registerEventListener(CalendarObjectDeletedEvent::class, CalendarObjectReminderUpdaterListener::class);
-		$context->registerEventListener(CalendarObjectMovedEvent::class, ActivityUpdaterListener::class);
-		$context->registerEventListener(CalendarObjectMovedEvent::class, CalendarObjectReminderUpdaterListener::class);
-		$context->registerEventListener(CalendarObjectMovedToTrashEvent::class, ActivityUpdaterListener::class);
-		$context->registerEventListener(CalendarObjectMovedToTrashEvent::class, CalendarObjectReminderUpdaterListener::class);
-		$context->registerEventListener(CalendarObjectRestoredEvent::class, ActivityUpdaterListener::class);
-		$context->registerEventListener(CalendarObjectRestoredEvent::class, CalendarObjectReminderUpdaterListener::class);
-		$context->registerEventListener(CalendarShareUpdatedEvent::class, CalendarContactInteractionListener::class);
-		$context->registerEventListener(CalendarPublishedEvent::class, CalendarPublicationListener::class);
-		$context->registerEventListener(CalendarUnpublishedEvent::class, CalendarPublicationListener::class);
-		$context->registerEventListener(CalendarShareUpdatedEvent::class, CalendarShareUpdateListener::class);
+        $context->registerEventListener(CalendarCreatedEvent::class, ActivityUpdaterListener::class);
+        $context->registerEventListener(CalendarDeletedEvent::class, ActivityUpdaterListener::class);
+        $context->registerEventListener(CalendarDeletedEvent::class, CalendarObjectReminderUpdaterListener::class);
+        $context->registerEventListener(CalendarDeletedEvent::class, CalendarDeletionDefaultUpdaterListener::class);
+        $context->registerEventListener(CalendarMovedToTrashEvent::class, ActivityUpdaterListener::class);
+        $context->registerEventListener(CalendarMovedToTrashEvent::class, CalendarObjectReminderUpdaterListener::class);
+        $context->registerEventListener(CalendarUpdatedEvent::class, ActivityUpdaterListener::class);
+        $context->registerEventListener(CalendarRestoredEvent::class, ActivityUpdaterListener::class);
+        $context->registerEventListener(CalendarRestoredEvent::class, CalendarObjectReminderUpdaterListener::class);
+        $context->registerEventListener(CalendarObjectCreatedEvent::class, ActivityUpdaterListener::class);
+        $context->registerEventListener(CalendarObjectCreatedEvent::class, CalendarContactInteractionListener::class);
+        $context->registerEventListener(CalendarObjectCreatedEvent::class, CalendarObjectReminderUpdaterListener::class);
+        $context->registerEventListener(CalendarObjectUpdatedEvent::class, ActivityUpdaterListener::class);
+        $context->registerEventListener(CalendarObjectUpdatedEvent::class, CalendarContactInteractionListener::class);
+        $context->registerEventListener(CalendarObjectUpdatedEvent::class, CalendarObjectReminderUpdaterListener::class);
+        $context->registerEventListener(CalendarObjectDeletedEvent::class, ActivityUpdaterListener::class);
+        $context->registerEventListener(CalendarObjectDeletedEvent::class, CalendarObjectReminderUpdaterListener::class);
+        $context->registerEventListener(CalendarObjectMovedEvent::class, ActivityUpdaterListener::class);
+        $context->registerEventListener(CalendarObjectMovedEvent::class, CalendarObjectReminderUpdaterListener::class);
+        $context->registerEventListener(CalendarObjectMovedToTrashEvent::class, ActivityUpdaterListener::class);
+        $context->registerEventListener(CalendarObjectMovedToTrashEvent::class, CalendarObjectReminderUpdaterListener::class);
+        $context->registerEventListener(CalendarObjectRestoredEvent::class, ActivityUpdaterListener::class);
+        $context->registerEventListener(CalendarObjectRestoredEvent::class, CalendarObjectReminderUpdaterListener::class);
+        $context->registerEventListener(CalendarShareUpdatedEvent::class, CalendarContactInteractionListener::class);
+        $context->registerEventListener(CalendarPublishedEvent::class, CalendarPublicationListener::class);
+        $context->registerEventListener(CalendarUnpublishedEvent::class, CalendarPublicationListener::class);
+        $context->registerEventListener(CalendarShareUpdatedEvent::class, CalendarShareUpdateListener::class);
 
-		$context->registerEventListener(SubscriptionCreatedEvent::class, SubscriptionListener::class);
-		$context->registerEventListener(SubscriptionDeletedEvent::class, SubscriptionListener::class);
+        $context->registerEventListener(SubscriptionCreatedEvent::class, SubscriptionListener::class);
+        $context->registerEventListener(SubscriptionDeletedEvent::class, SubscriptionListener::class);
 
 
-		$context->registerEventListener(AddressBookCreatedEvent::class, AddressbookListener::class);
-		$context->registerEventListener(AddressBookDeletedEvent::class, AddressbookListener::class);
-		$context->registerEventListener(AddressBookUpdatedEvent::class, AddressbookListener::class);
-		$context->registerEventListener(AddressBookShareUpdatedEvent::class, AddressbookListener::class);
-		$context->registerEventListener(CardCreatedEvent::class, CardListener::class);
-		$context->registerEventListener(CardDeletedEvent::class, CardListener::class);
-		$context->registerEventListener(CardUpdatedEvent::class, CardListener::class);
-		$context->registerEventListener(CardCreatedEvent::class, BirthdayListener::class);
-		$context->registerEventListener(CardDeletedEvent::class, BirthdayListener::class);
-		$context->registerEventListener(CardUpdatedEvent::class, BirthdayListener::class);
-		$context->registerEventListener(CardDeletedEvent::class, ClearPhotoCacheListener::class);
-		$context->registerEventListener(CardUpdatedEvent::class, ClearPhotoCacheListener::class);
-		$context->registerEventListener(TrustedServerRemovedEvent::class, TrustedServerRemovedListener::class);
+        $context->registerEventListener(AddressBookCreatedEvent::class, AddressbookListener::class);
+        $context->registerEventListener(AddressBookDeletedEvent::class, AddressbookListener::class);
+        $context->registerEventListener(AddressBookUpdatedEvent::class, AddressbookListener::class);
+        $context->registerEventListener(AddressBookShareUpdatedEvent::class, AddressbookListener::class);
+        $context->registerEventListener(CardCreatedEvent::class, CardListener::class);
+        $context->registerEventListener(CardDeletedEvent::class, CardListener::class);
+        $context->registerEventListener(CardUpdatedEvent::class, CardListener::class);
+        $context->registerEventListener(CardCreatedEvent::class, BirthdayListener::class);
+        $context->registerEventListener(CardDeletedEvent::class, BirthdayListener::class);
+        $context->registerEventListener(CardUpdatedEvent::class, BirthdayListener::class);
+        $context->registerEventListener(CardDeletedEvent::class, ClearPhotoCacheListener::class);
+        $context->registerEventListener(CardUpdatedEvent::class, ClearPhotoCacheListener::class);
+        $context->registerEventListener(TrustedServerRemovedEvent::class, TrustedServerRemovedListener::class);
 
-		$context->registerEventListener(BeforePreferenceDeletedEvent::class, UserPreferenceListener::class);
-		$context->registerEventListener(BeforePreferenceSetEvent::class, UserPreferenceListener::class);
+        $context->registerEventListener(BeforePreferenceDeletedEvent::class, UserPreferenceListener::class);
+        $context->registerEventListener(BeforePreferenceSetEvent::class, UserPreferenceListener::class);
 
-		$context->registerEventListener(OutOfOfficeChangedEvent::class, OutOfOfficeListener::class);
-		$context->registerEventListener(OutOfOfficeClearedEvent::class, OutOfOfficeListener::class);
-		$context->registerEventListener(OutOfOfficeScheduledEvent::class, OutOfOfficeListener::class);
+        $context->registerEventListener(OutOfOfficeChangedEvent::class, OutOfOfficeListener::class);
+        $context->registerEventListener(OutOfOfficeClearedEvent::class, OutOfOfficeListener::class);
+        $context->registerEventListener(OutOfOfficeScheduledEvent::class, OutOfOfficeListener::class);
 
-		$context->registerEventListener(UserFirstTimeLoggedInEvent::class, UserEventsListener::class);
-		$context->registerEventListener(UserIdAssignedEvent::class, UserEventsListener::class);
-		$context->registerEventListener(BeforeUserIdUnassignedEvent::class, UserEventsListener::class);
-		$context->registerEventListener(UserIdUnassignedEvent::class, UserEventsListener::class);
-		$context->registerEventListener(BeforeUserDeletedEvent::class, UserEventsListener::class);
-		$context->registerEventListener(UserDeletedEvent::class, UserEventsListener::class);
-		$context->registerEventListener(UserCreatedEvent::class, UserEventsListener::class);
-		$context->registerEventListener(UserChangedEvent::class, UserEventsListener::class);
-		$context->registerEventListener(UserUpdatedEvent::class, UserEventsListener::class);
+        $context->registerEventListener(UserFirstTimeLoggedInEvent::class, UserEventsListener::class);
+        $context->registerEventListener(UserIdAssignedEvent::class, UserEventsListener::class);
+        $context->registerEventListener(BeforeUserIdUnassignedEvent::class, UserEventsListener::class);
+        $context->registerEventListener(UserIdUnassignedEvent::class, UserEventsListener::class);
+        $context->registerEventListener(BeforeUserDeletedEvent::class, UserEventsListener::class);
+        $context->registerEventListener(UserDeletedEvent::class, UserEventsListener::class);
+        $context->registerEventListener(UserCreatedEvent::class, UserEventsListener::class);
+        $context->registerEventListener(UserChangedEvent::class, UserEventsListener::class);
+        $context->registerEventListener(UserUpdatedEvent::class, UserEventsListener::class);
 
-		$context->registerNotifierService(Notifier::class);
+        $context->registerNotifierService(Notifier::class);
 
-		$context->registerCalendarProvider(CalendarProvider::class);
-		$context->registerCalendarProvider(CachedSubscriptionProvider::class);
+        $context->registerCalendarProvider(CalendarProvider::class);
+        $context->registerCalendarProvider(CachedSubscriptionProvider::class);
 
-		$context->registerUserMigrator(CalendarMigrator::class);
-		$context->registerUserMigrator(ContactsMigrator::class);
+        $context->registerUserMigrator(CalendarMigrator::class);
+        $context->registerUserMigrator(ContactsMigrator::class);
 
-		$context->registerSetupCheck(NeedsSystemAddressBookSync::class);
-		$context->registerSetupCheck(WebdavEndpoint::class);
+        $context->registerSetupCheck(NeedsSystemAddressBookSync::class);
+        $context->registerSetupCheck(WebdavEndpoint::class);
 
-		// register admin settings form and listener(s)
-		$context->registerDeclarativeSettings(SystemAddressBookSettings::class);
-		$context->registerEventListener(DeclarativeSettingsGetValueEvent::class, DavAdminSettingsListener::class);
-		$context->registerEventListener(DeclarativeSettingsSetValueEvent::class, DavAdminSettingsListener::class);
+        // register admin settings form and listener(s)
+        $context->registerDeclarativeSettings(SystemAddressBookSettings::class);
+        $context->registerEventListener(DeclarativeSettingsGetValueEvent::class, DavAdminSettingsListener::class);
+        $context->registerEventListener(DeclarativeSettingsSetValueEvent::class, DavAdminSettingsListener::class);
 
-	}
+    }
 
-	public function boot(IBootContext $context): void {
-		// Load all dav apps
-		$context->getServerContainer()->get(IAppManager::class)->loadApps(['dav']);
+    public function boot(IBootContext $context): void {
+        // Load all dav apps
+        $context->getServerContainer()->get(IAppManager::class)->loadApps(['dav']);
 
-		$context->injectFn($this->registerContactsManager(...));
-		$context->injectFn($this->registerCalendarManager(...));
-		$context->injectFn($this->registerCalendarReminders(...));
-	}
+        $context->injectFn($this->registerContactsManager(...));
+        $context->injectFn($this->registerCalendarManager(...));
+        $context->injectFn($this->registerCalendarReminders(...));
+    }
 
-	public function registerContactsManager(IContactsManager $cm, IAppContainer $container): void {
-		$cm->register(function () use ($container, $cm): void {
-			$user = Server::get(IUserSession::class)->getUser();
-			if (!is_null($user)) {
-				$this->setupContactsProvider($cm, $container, $user->getUID());
-			} else {
-				$this->setupSystemContactsProvider($cm, $container);
-			}
-		});
-	}
+    public function registerContactsManager(IContactsManager $cm, IAppContainer $container): void {
+        $cm->register(function () use ($container, $cm): void {
+            $user = Server::get(IUserSession::class)->getUser();
+            if (!is_null($user)) {
+                $this->setupContactsProvider($cm, $container, $user->getUID());
+            } else {
+                $this->setupSystemContactsProvider($cm, $container);
+            }
+        });
+    }
 
-	private function setupContactsProvider(IContactsManager $contactsManager,
-		IAppContainer $container,
-		string $userID): void {
-		/** @var ContactsManager $cm */
-		$cm = $container->query(ContactsManager::class);
-		$urlGenerator = $container->getServer()->getURLGenerator();
-		$cm->setupContactsProvider($contactsManager, $userID, $urlGenerator);
-	}
+    private function setupContactsProvider(IContactsManager $contactsManager,
+        IAppContainer $container,
+        string $userID): void {
+        /** @var ContactsManager $cm */
+        $cm = $container->query(ContactsManager::class);
+        $urlGenerator = $container->getServer()->getURLGenerator();
+        $cm->setupContactsProvider($contactsManager, $userID, $urlGenerator);
+    }
 
-	private function setupSystemContactsProvider(IContactsManager $contactsManager, IAppContainer $container): void {
-		/** @var ContactsManager $cm */
-		$cm = $container->query(ContactsManager::class);
-		$urlGenerator = $container->getServer()->getURLGenerator();
-		$cm->setupSystemContactsProvider($contactsManager, null, $urlGenerator);
-	}
+    private function setupSystemContactsProvider(IContactsManager $contactsManager, IAppContainer $container): void {
+        /** @var ContactsManager $cm */
+        $cm = $container->query(ContactsManager::class);
+        $urlGenerator = $container->getServer()->getURLGenerator();
+        $cm->setupSystemContactsProvider($contactsManager, null, $urlGenerator);
+    }
 
-	public function registerCalendarManager(ICalendarManager $calendarManager,
-		IAppContainer $container): void {
-		$calendarManager->register(function () use ($container, $calendarManager): void {
-			$user = Server::get(IUserSession::class)->getUser();
-			if ($user !== null) {
-				$this->setupCalendarProvider($calendarManager, $container, $user->getUID());
-			}
-		});
-	}
+    public function registerCalendarManager(ICalendarManager $calendarManager,
+        IAppContainer $container): void {
+        $calendarManager->register(function () use ($container, $calendarManager): void {
+            $user = Server::get(IUserSession::class)->getUser();
+            if ($user !== null) {
+                $this->setupCalendarProvider($calendarManager, $container, $user->getUID());
+            }
+        });
+    }
 
-	private function setupCalendarProvider(ICalendarManager $calendarManager,
-		IAppContainer $container,
-		$userId) {
-		$cm = $container->query(CalendarManager::class);
-		$cm->setupCalendarProvider($calendarManager, $userId);
-	}
+    private function setupCalendarProvider(ICalendarManager $calendarManager,
+        IAppContainer $container,
+        $userId) {
+        $cm = $container->query(CalendarManager::class);
+        $cm->setupCalendarProvider($calendarManager, $userId);
+    }
 
-	public function registerCalendarReminders(NotificationProviderManager $manager,
-		LoggerInterface $logger): void {
-		try {
-			$manager->registerProvider(AudioProvider::class);
-			$manager->registerProvider(EmailProvider::class);
-			$manager->registerProvider(PushProvider::class);
-		} catch (Throwable $ex) {
-			$logger->error($ex->getMessage(), ['exception' => $ex]);
-		}
-	}
+    public function registerCalendarReminders(NotificationProviderManager $manager,
+        LoggerInterface $logger): void {
+        try {
+            $manager->registerProvider(AudioProvider::class);
+            $manager->registerProvider(EmailProvider::class);
+            $manager->registerProvider(PushProvider::class);
+        } catch (Throwable $ex) {
+            $logger->error($ex->getMessage(), ['exception' => $ex]);
+        }
+    }
 }

apps/dav/tests/unit/bootstrap.php

Indentation +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
 use OCP\Server;
 
 if (!defined('PHPUNIT_RUN')) {
-	define('PHPUNIT_RUN', 1);
+    define('PHPUNIT_RUN', 1);
 }
 
 require_once __DIR__ . '/../../../../lib/base.php';

Spacing +2 added lines, -2 removed lines

@@ -15,7 +15,7 @@
 	define('PHPUNIT_RUN', 1);
 }
 
-require_once __DIR__ . '/../../../../lib/base.php';
-require_once __DIR__ . '/../../../../tests/autoload.php';
+require_once __DIR__.'/../../../../lib/base.php';
+require_once __DIR__.'/../../../../tests/autoload.php';
 
 Server::get(IAppManager::class)->loadApp('dav');

apps/user_ldap/tests/Integration/ExceptionOnLostConnection.php

Indentation +137 added lines, -137 removed lines

@@ -23,143 +23,143 @@
  *
  */
 class ExceptionOnLostConnection {
-	/** @var string */
-	private $ldapHost;
-
-	/** @var LDAP */
-	private $ldap;
-
-	/** @var bool */
-	private $originalProxyState;
-
-	/**
-	 * @param string $toxiProxyHost host of toxiproxy as url, like http://localhost:8474
-	 * @param string $toxiProxyName name of the LDAP proxy service as configured in toxiProxy
-	 * @param string $ldapBase any valid LDAP base DN
-	 * @param null $ldapBindDN optional, bind DN if anonymous bind is not possible
-	 * @param null $ldapBindPwd optional
-	 */
-	public function __construct(
-		private $toxiProxyHost,
-		private $toxiProxyName,
-		private $ldapBase,
-		private $ldapBindDN = null,
-		private $ldapBindPwd = null,
-	) {
-		$this->setUp();
-	}
-
-	/**
-	 * destructor
-	 */
-	public function __destruct() {
-		$this->cleanUp();
-	}
-
-	/**
-	 * prepares everything for the test run. Includes loading Nextcloud and
-	 * the LDAP backend, as well as getting information about toxiproxy.
-	 * Also creates an instance of the LDAP class, the testee
-	 *
-	 * @throws \Exception
-	 */
-	public function setUp(): void {
-		require_once __DIR__ . '/../../../../lib/base.php';
-		Server::get(IAppManager::class)->loadApps(['user_ldap']);
-
-		$ch = $this->getCurl();
-		$proxyInfoJson = curl_exec($ch);
-		$this->checkCurlResult($ch, $proxyInfoJson);
-		$proxyInfo = json_decode($proxyInfoJson, true);
-		$this->originalProxyState = $proxyInfo['enabled'];
-		$this->ldapHost = 'ldap://' . $proxyInfo['listen']; // contains port as well
-
-		$this->ldap = new LDAP();
-	}
-
-	/**
-	 * restores original state of the LDAP proxy, if necessary
-	 */
-	public function cleanUp() {
-		if ($this->originalProxyState === true) {
-			$this->setProxyState(true);
-		}
-	}
-
-	/**
-	 * runs the test and prints the result. Exit code is 0 if successful, 1 on
-	 * fail
-	 */
-	public function run() {
-		if ($this->originalProxyState === false) {
-			$this->setProxyState(true);
-		}
-		//host contains port, 2nd parameter will be ignored
-		$cr = $this->ldap->connect($this->ldapHost, 0);
-		$this->ldap->bind($cr, $this->ldapBindDN, $this->ldapBindPwd);
-		$this->ldap->search($cr, $this->ldapBase, 'objectClass=*', ['dn'], true, 5);
-
-		// disable LDAP, will cause lost connection
-		$this->setProxyState(false);
-		try {
-			$this->ldap->search($cr, $this->ldapBase, 'objectClass=*', ['dn'], true, 5);
-		} catch (ServerNotAvailableException $e) {
-			print('Test PASSED' . PHP_EOL);
-			exit(0);
-		}
-		print('Test FAILED' . PHP_EOL);
-		exit(1);
-	}
-
-	/**
-	 * tests whether a curl operation ran successfully. If not, an exception
-	 * is thrown
-	 *
-	 * @param resource|\CurlHandle $ch
-	 * @param mixed $result
-	 * @throws \Exception
-	 */
-	private function checkCurlResult($ch, $result) {
-		if ($result === false) {
-			$error = curl_error($ch);
-			curl_close($ch);
-			throw new \Exception($error);
-		}
-	}
-
-	/**
-	 * enables or disabled the LDAP proxy service in toxiproxy
-	 *
-	 * @param bool $isEnabled whether is should be enabled or disables
-	 * @throws \Exception
-	 */
-	private function setProxyState($isEnabled) {
-		if (!is_bool($isEnabled)) {
-			throw new \InvalidArgumentException('Bool expected');
-		}
-		$postData = json_encode(['enabled' => $isEnabled]);
-		$ch = $this->getCurl();
-		curl_setopt($ch, CURLOPT_POST, true);
-		curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
-		curl_setopt($ch, CURLOPT_HTTPHEADER, [
-			'Content-Type: application/json',
-			'Content-Length: ' . strlen($postData)]
-		);
-		$recvd = curl_exec($ch);
-		$this->checkCurlResult($ch, $recvd);
-	}
-
-	/**
-	 * initializes a curl handler towards the toxiproxy LDAP proxy service
-	 * @return resource|\CurlHandle
-	 */
-	private function getCurl() {
-		$ch = curl_init();
-		curl_setopt($ch, CURLOPT_URL, $this->toxiProxyHost . '/proxies/' . $this->toxiProxyName);
-		curl_setopt($ch, CURLOPT_HEADER, false);
-		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-		return $ch;
-	}
+    /** @var string */
+    private $ldapHost;
+
+    /** @var LDAP */
+    private $ldap;
+
+    /** @var bool */
+    private $originalProxyState;
+
+    /**
+     * @param string $toxiProxyHost host of toxiproxy as url, like http://localhost:8474
+     * @param string $toxiProxyName name of the LDAP proxy service as configured in toxiProxy
+     * @param string $ldapBase any valid LDAP base DN
+     * @param null $ldapBindDN optional, bind DN if anonymous bind is not possible
+     * @param null $ldapBindPwd optional
+     */
+    public function __construct(
+        private $toxiProxyHost,
+        private $toxiProxyName,
+        private $ldapBase,
+        private $ldapBindDN = null,
+        private $ldapBindPwd = null,
+    ) {
+        $this->setUp();
+    }
+
+    /**
+     * destructor
+     */
+    public function __destruct() {
+        $this->cleanUp();
+    }
+
+    /**
+     * prepares everything for the test run. Includes loading Nextcloud and
+     * the LDAP backend, as well as getting information about toxiproxy.
+     * Also creates an instance of the LDAP class, the testee
+     *
+     * @throws \Exception
+     */
+    public function setUp(): void {
+        require_once __DIR__ . '/../../../../lib/base.php';
+        Server::get(IAppManager::class)->loadApps(['user_ldap']);
+
+        $ch = $this->getCurl();
+        $proxyInfoJson = curl_exec($ch);
+        $this->checkCurlResult($ch, $proxyInfoJson);
+        $proxyInfo = json_decode($proxyInfoJson, true);
+        $this->originalProxyState = $proxyInfo['enabled'];
+        $this->ldapHost = 'ldap://' . $proxyInfo['listen']; // contains port as well
+
+        $this->ldap = new LDAP();
+    }
+
+    /**
+     * restores original state of the LDAP proxy, if necessary
+     */
+    public function cleanUp() {
+        if ($this->originalProxyState === true) {
+            $this->setProxyState(true);
+        }
+    }
+
+    /**
+     * runs the test and prints the result. Exit code is 0 if successful, 1 on
+     * fail
+     */
+    public function run() {
+        if ($this->originalProxyState === false) {
+            $this->setProxyState(true);
+        }
+        //host contains port, 2nd parameter will be ignored
+        $cr = $this->ldap->connect($this->ldapHost, 0);
+        $this->ldap->bind($cr, $this->ldapBindDN, $this->ldapBindPwd);
+        $this->ldap->search($cr, $this->ldapBase, 'objectClass=*', ['dn'], true, 5);
+
+        // disable LDAP, will cause lost connection
+        $this->setProxyState(false);
+        try {
+            $this->ldap->search($cr, $this->ldapBase, 'objectClass=*', ['dn'], true, 5);
+        } catch (ServerNotAvailableException $e) {
+            print('Test PASSED' . PHP_EOL);
+            exit(0);
+        }
+        print('Test FAILED' . PHP_EOL);
+        exit(1);
+    }
+
+    /**
+     * tests whether a curl operation ran successfully. If not, an exception
+     * is thrown
+     *
+     * @param resource|\CurlHandle $ch
+     * @param mixed $result
+     * @throws \Exception
+     */
+    private function checkCurlResult($ch, $result) {
+        if ($result === false) {
+            $error = curl_error($ch);
+            curl_close($ch);
+            throw new \Exception($error);
+        }
+    }
+
+    /**
+     * enables or disabled the LDAP proxy service in toxiproxy
+     *
+     * @param bool $isEnabled whether is should be enabled or disables
+     * @throws \Exception
+     */
+    private function setProxyState($isEnabled) {
+        if (!is_bool($isEnabled)) {
+            throw new \InvalidArgumentException('Bool expected');
+        }
+        $postData = json_encode(['enabled' => $isEnabled]);
+        $ch = $this->getCurl();
+        curl_setopt($ch, CURLOPT_POST, true);
+        curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
+        curl_setopt($ch, CURLOPT_HTTPHEADER, [
+            'Content-Type: application/json',
+            'Content-Length: ' . strlen($postData)]
+        );
+        $recvd = curl_exec($ch);
+        $this->checkCurlResult($ch, $recvd);
+    }
+
+    /**
+     * initializes a curl handler towards the toxiproxy LDAP proxy service
+     * @return resource|\CurlHandle
+     */
+    private function getCurl() {
+        $ch = curl_init();
+        curl_setopt($ch, CURLOPT_URL, $this->toxiProxyHost . '/proxies/' . $this->toxiProxyName);
+        curl_setopt($ch, CURLOPT_HEADER, false);
+        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+        return $ch;
+    }
 }
 
 $test = new ExceptionOnLostConnection('http://localhost:8474', 'ldap', 'dc=owncloud,dc=bzoc');

Spacing +6 added lines, -6 removed lines

@@ -64,7 +64,7 @@ 
 	 * @throws \Exception
 	 */
 	public function setUp(): void {
-		require_once __DIR__ . '/../../../../lib/base.php';
+		require_once __DIR__.'/../../../../lib/base.php';
 		Server::get(IAppManager::class)->loadApps(['user_ldap']);
 
 		$ch = $this->getCurl();
@@ -72,7 +72,7 @@ 
 		$this->checkCurlResult($ch, $proxyInfoJson);
 		$proxyInfo = json_decode($proxyInfoJson, true);
 		$this->originalProxyState = $proxyInfo['enabled'];
-		$this->ldapHost = 'ldap://' . $proxyInfo['listen']; // contains port as well
+		$this->ldapHost = 'ldap://'.$proxyInfo['listen']; // contains port as well
 
 		$this->ldap = new LDAP();
 	}
@@ -104,10 +104,10 @@ 
 		try {
 			$this->ldap->search($cr, $this->ldapBase, 'objectClass=*', ['dn'], true, 5);
 		} catch (ServerNotAvailableException $e) {
-			print('Test PASSED' . PHP_EOL);
+			print('Test PASSED'.PHP_EOL);
 			exit(0);
 		}
-		print('Test FAILED' . PHP_EOL);
+		print('Test FAILED'.PHP_EOL);
 		exit(1);
 	}
 
@@ -143,7 +143,7 @@ 
 		curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
 		curl_setopt($ch, CURLOPT_HTTPHEADER, [
 			'Content-Type: application/json',
-			'Content-Length: ' . strlen($postData)]
+			'Content-Length: '.strlen($postData)]
 		);
 		$recvd = curl_exec($ch);
 		$this->checkCurlResult($ch, $recvd);
@@ -155,7 +155,7 @@ 
 	 */
 	private function getCurl() {
 		$ch = curl_init();
-		curl_setopt($ch, CURLOPT_URL, $this->toxiProxyHost . '/proxies/' . $this->toxiProxyName);
+		curl_setopt($ch, CURLOPT_URL, $this->toxiProxyHost.'/proxies/'.$this->toxiProxyName);
 		curl_setopt($ch, CURLOPT_HEADER, false);
 		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
 		return $ch;

ocs/v1.php

Indentation +36 added lines, -36 removed lines

@@ -29,11 +29,11 @@ 
 use Symfony\Component\Routing\Exception\ResourceNotFoundException;
 
 if (Util::needUpgrade()
-	|| Server::get(IConfig::class)->getSystemValueBool('maintenance')) {
-	// since the behavior of apps or remotes are unpredictable during
-	// an upgrade, return a 503 directly
-	ApiHelper::respond(503, 'Service unavailable', ['X-Nextcloud-Maintenance-Mode' => '1'], 503);
-	exit;
+    || Server::get(IConfig::class)->getSystemValueBool('maintenance')) {
+    // since the behavior of apps or remotes are unpredictable during
+    // an upgrade, return a 503 directly
+    ApiHelper::respond(503, 'Service unavailable', ['X-Nextcloud-Maintenance-Mode' => '1'], 503);
+    exit;
 }
 
 
@@ -41,45 +41,45 @@ 
  * Try the appframework routes
  */
 try {
-	$appManager = Server::get(IAppManager::class);
-	$appManager->loadApps(['session']);
-	$appManager->loadApps(['authentication']);
-	$appManager->loadApps(['extended_authentication']);
+    $appManager = Server::get(IAppManager::class);
+    $appManager->loadApps(['session']);
+    $appManager->loadApps(['authentication']);
+    $appManager->loadApps(['extended_authentication']);
 
-	// load all apps to get all api routes properly setup
-	// FIXME: this should ideally appear after handleLogin but will cause
-	// side effects in existing apps
-	$appManager->loadApps();
+    // load all apps to get all api routes properly setup
+    // FIXME: this should ideally appear after handleLogin but will cause
+    // side effects in existing apps
+    $appManager->loadApps();
 
-	$request = Server::get(IRequest::class);
-	$request->throwDecodingExceptionIfAny();
+    $request = Server::get(IRequest::class);
+    $request->throwDecodingExceptionIfAny();
 
-	if (!Server::get(IUserSession::class)->isLoggedIn()) {
-		OC::handleLogin($request);
-	}
+    if (!Server::get(IUserSession::class)->isLoggedIn()) {
+        OC::handleLogin($request);
+    }
 
-	Server::get(Router::class)->match('/ocsapp' . $request->getRawPathInfo());
+    Server::get(Router::class)->match('/ocsapp' . $request->getRawPathInfo());
 } catch (MaxDelayReached $ex) {
-	ApiHelper::respond(Http::STATUS_TOO_MANY_REQUESTS, $ex->getMessage());
+    ApiHelper::respond(Http::STATUS_TOO_MANY_REQUESTS, $ex->getMessage());
 } catch (ResourceNotFoundException $e) {
-	$txt = 'Invalid query, please check the syntax. API specifications are here:'
-		. ' http://www.freedesktop.org/wiki/Specifications/open-collaboration-services.' . "\n";
-	ApiHelper::respond(OCSController::RESPOND_NOT_FOUND, $txt);
+    $txt = 'Invalid query, please check the syntax. API specifications are here:'
+        . ' http://www.freedesktop.org/wiki/Specifications/open-collaboration-services.' . "\n";
+    ApiHelper::respond(OCSController::RESPOND_NOT_FOUND, $txt);
 } catch (MethodNotAllowedException $e) {
-	ApiHelper::setContentType();
-	http_response_code(405);
+    ApiHelper::setContentType();
+    http_response_code(405);
 } catch (LoginException $e) {
-	ApiHelper::respond(OCSController::RESPOND_UNAUTHORISED, 'Unauthorised');
+    ApiHelper::respond(OCSController::RESPOND_UNAUTHORISED, 'Unauthorised');
 } catch (\Exception $e) {
-	Server::get(LoggerInterface::class)->error($e->getMessage(), ['exception' => $e]);
+    Server::get(LoggerInterface::class)->error($e->getMessage(), ['exception' => $e]);
 
-	$txt = 'Internal Server Error' . "\n";
-	try {
-		if (Server::get(SystemConfig::class)->getValue('debug', false)) {
-			$txt .= $e->getMessage();
-		}
-	} catch (\Throwable $e) {
-		// Just to be save
-	}
-	ApiHelper::respond(OCSController::RESPOND_SERVER_ERROR, $txt);
+    $txt = 'Internal Server Error' . "\n";
+    try {
+        if (Server::get(SystemConfig::class)->getValue('debug', false)) {
+            $txt .= $e->getMessage();
+        }
+    } catch (\Throwable $e) {
+        // Just to be save
+    }
+    ApiHelper::respond(OCSController::RESPOND_SERVER_ERROR, $txt);
 }

Spacing +5 added lines, -5 removed lines

@@ -8,8 +8,8 @@ 
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-require_once __DIR__ . '/../lib/versioncheck.php';
-require_once __DIR__ . '/../lib/base.php';
+require_once __DIR__.'/../lib/versioncheck.php';
+require_once __DIR__.'/../lib/base.php';
 
 use OC\OCS\ApiHelper;
 use OC\Route\Router;
@@ -58,12 +58,12 @@ 
 		OC::handleLogin($request);
 	}
 
-	Server::get(Router::class)->match('/ocsapp' . $request->getRawPathInfo());
+	Server::get(Router::class)->match('/ocsapp'.$request->getRawPathInfo());
 } catch (MaxDelayReached $ex) {
 	ApiHelper::respond(Http::STATUS_TOO_MANY_REQUESTS, $ex->getMessage());
 } catch (ResourceNotFoundException $e) {
 	$txt = 'Invalid query, please check the syntax. API specifications are here:'
-		. ' http://www.freedesktop.org/wiki/Specifications/open-collaboration-services.' . "\n";
+		. ' http://www.freedesktop.org/wiki/Specifications/open-collaboration-services.'."\n";
 	ApiHelper::respond(OCSController::RESPOND_NOT_FOUND, $txt);
 } catch (MethodNotAllowedException $e) {
 	ApiHelper::setContentType();
@@ -73,7 +73,7 @@ 
 } catch (\Exception $e) {
 	Server::get(LoggerInterface::class)->error($e->getMessage(), ['exception' => $e]);
 
-	$txt = 'Internal Server Error' . "\n";
+	$txt = 'Internal Server Error'."\n";
 	try {
 		if (Server::get(SystemConfig::class)->getValue('debug', false)) {
 			$txt .= $e->getMessage();

tests/lib/Traits/EncryptionTrait.php

Indentation +95 added lines, -95 removed lines

@@ -27,99 +27,99 @@
  * Enables encryption
  */
 trait EncryptionTrait {
-	// from MountProviderTrait
-	abstract protected function registerStorageWrapper($name, $wrapper);
-
-	// from phpunit
-	abstract protected static function markTestSkipped(string $message = ''): void;
-	abstract protected static function assertTrue($condition, string $message = ''): void;
-
-	private $encryptionWasEnabled;
-
-	private $originalEncryptionModule;
-
-	/** @var IUserManager */
-	private $userManager;
-	/** @var SetupManager */
-	private $setupManager;
-
-	/**
-	 * @var IConfig
-	 */
-	private $config;
-
-	/**
-	 * @var Application
-	 */
-	private $encryptionApp;
-
-	protected function loginWithEncryption($user = '') {
-		\OC_Util::tearDownFS();
-		\OC_User::setUserId('');
-		// needed for fully logout
-		Server::get(IUserSession::class)->setUser(null);
-
-		$this->setupManager->tearDown();
-
-		\OC_User::setUserId($user);
-		$this->postLogin();
-		\OC_Util::setupFS($user);
-		if ($this->userManager->userExists($user)) {
-			\OC::$server->getUserFolder($user);
-		}
-	}
-
-	protected function setupForUser($name, $password) {
-		$this->setupManager->tearDown();
-		$this->setupManager->setupForUser($this->userManager->get($name));
-
-		$container = $this->encryptionApp->getContainer();
-		/** @var KeyManager $keyManager */
-		$keyManager = $container->query(KeyManager::class);
-		/** @var Setup $userSetup */
-		$userSetup = $container->query(Setup::class);
-		$userSetup->setupUser($name, $password);
-		$encryptionManager = $container->query(IManager::class);
-		$this->encryptionApp->setUp($encryptionManager);
-		$keyManager->init($name, $password);
-	}
-
-	protected function postLogin() {
-		$encryptionWrapper = new EncryptionWrapper(
-			new ArrayCache(),
-			Server::get(\OCP\Encryption\IManager::class),
-			Server::get(LoggerInterface::class)
-		);
-
-		$this->registerStorageWrapper('oc_encryption', [$encryptionWrapper, 'wrapStorage']);
-	}
-
-	protected function setUpEncryptionTrait() {
-		$isReady = Server::get(\OCP\Encryption\IManager::class)->isReady();
-		if (!$isReady) {
-			$this->markTestSkipped('Encryption not ready');
-		}
-
-		$this->userManager = Server::get(IUserManager::class);
-		$this->setupManager = Server::get(SetupManager::class);
-
-		Server::get(IAppManager::class)->loadApp('encryption');
-
-		$this->encryptionApp = new Application([], $isReady);
-
-		$this->config = Server::get(IConfig::class);
-		$this->encryptionWasEnabled = $this->config->getAppValue('core', 'encryption_enabled', 'no');
-		$this->originalEncryptionModule = $this->config->getAppValue('core', 'default_encryption_module');
-		$this->config->setAppValue('core', 'default_encryption_module', Encryption::ID);
-		$this->config->setAppValue('core', 'encryption_enabled', 'yes');
-		$this->assertTrue(Server::get(\OCP\Encryption\IManager::class)->isEnabled());
-	}
-
-	protected function tearDownEncryptionTrait() {
-		if ($this->config) {
-			$this->config->setAppValue('core', 'encryption_enabled', $this->encryptionWasEnabled);
-			$this->config->setAppValue('core', 'default_encryption_module', $this->originalEncryptionModule);
-			$this->config->deleteAppValue('encryption', 'useMasterKey');
-		}
-	}
+    // from MountProviderTrait
+    abstract protected function registerStorageWrapper($name, $wrapper);
+
+    // from phpunit
+    abstract protected static function markTestSkipped(string $message = ''): void;
+    abstract protected static function assertTrue($condition, string $message = ''): void;
+
+    private $encryptionWasEnabled;
+
+    private $originalEncryptionModule;
+
+    /** @var IUserManager */
+    private $userManager;
+    /** @var SetupManager */
+    private $setupManager;
+
+    /**
+     * @var IConfig
+     */
+    private $config;
+
+    /**
+     * @var Application
+     */
+    private $encryptionApp;
+
+    protected function loginWithEncryption($user = '') {
+        \OC_Util::tearDownFS();
+        \OC_User::setUserId('');
+        // needed for fully logout
+        Server::get(IUserSession::class)->setUser(null);
+
+        $this->setupManager->tearDown();
+
+        \OC_User::setUserId($user);
+        $this->postLogin();
+        \OC_Util::setupFS($user);
+        if ($this->userManager->userExists($user)) {
+            \OC::$server->getUserFolder($user);
+        }
+    }
+
+    protected function setupForUser($name, $password) {
+        $this->setupManager->tearDown();
+        $this->setupManager->setupForUser($this->userManager->get($name));
+
+        $container = $this->encryptionApp->getContainer();
+        /** @var KeyManager $keyManager */
+        $keyManager = $container->query(KeyManager::class);
+        /** @var Setup $userSetup */
+        $userSetup = $container->query(Setup::class);
+        $userSetup->setupUser($name, $password);
+        $encryptionManager = $container->query(IManager::class);
+        $this->encryptionApp->setUp($encryptionManager);
+        $keyManager->init($name, $password);
+    }
+
+    protected function postLogin() {
+        $encryptionWrapper = new EncryptionWrapper(
+            new ArrayCache(),
+            Server::get(\OCP\Encryption\IManager::class),
+            Server::get(LoggerInterface::class)
+        );
+
+        $this->registerStorageWrapper('oc_encryption', [$encryptionWrapper, 'wrapStorage']);
+    }
+
+    protected function setUpEncryptionTrait() {
+        $isReady = Server::get(\OCP\Encryption\IManager::class)->isReady();
+        if (!$isReady) {
+            $this->markTestSkipped('Encryption not ready');
+        }
+
+        $this->userManager = Server::get(IUserManager::class);
+        $this->setupManager = Server::get(SetupManager::class);
+
+        Server::get(IAppManager::class)->loadApp('encryption');
+
+        $this->encryptionApp = new Application([], $isReady);
+
+        $this->config = Server::get(IConfig::class);
+        $this->encryptionWasEnabled = $this->config->getAppValue('core', 'encryption_enabled', 'no');
+        $this->originalEncryptionModule = $this->config->getAppValue('core', 'default_encryption_module');
+        $this->config->setAppValue('core', 'default_encryption_module', Encryption::ID);
+        $this->config->setAppValue('core', 'encryption_enabled', 'yes');
+        $this->assertTrue(Server::get(\OCP\Encryption\IManager::class)->isEnabled());
+    }
+
+    protected function tearDownEncryptionTrait() {
+        if ($this->config) {
+            $this->config->setAppValue('core', 'encryption_enabled', $this->encryptionWasEnabled);
+            $this->config->setAppValue('core', 'default_encryption_module', $this->originalEncryptionModule);
+            $this->config->deleteAppValue('encryption', 'useMasterKey');
+        }
+    }
 }