Respect quota + add background job

Fix #930

Signed-off-by: Carl Schwan <[email protected]>

README.md

@@ -46,7 +46,7 @@ Group folders can be configured on the command line (cli) using the `occ` comman
 
 - `occ groupfolders:create <name>` &rarr; create a group folder
 - `occ groupfolders:delete <folder_id> [-f|--force]` &rarr; delete a group folder and all its contents
-- `occ groupfolders:expire` &rarr; trigger file version expiration (see [Nextcloud docs](https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/file_versioning.html) for details)
+- `occ groupfolders:expire` &rarr; trigger file version and trashbin expiration (see [Nextcloud docs for versionning](https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/file_versioning.html) and [Nextcloud docs for the trash bin](https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/trashbin_configuration.html) for details)
 - `occ groupfolders:group <folder_id> <group_id> [-d|--delete] [write|share|delete]` &rarr; assign groups and their rights to a group folder
 - `occ groupfolders:list` &rarr; list configured group folders
 - `occ groupfolders:permissions` &rarr; configure advanced permissions (see below for details)

lib/AppInfo/Application.php

@@ -23,6 +23,7 @@
 
 use OCA\Files\Event\LoadAdditionalScriptsEvent;
 use OCA\Files_Sharing\Event\BeforeTemplateRenderedEvent;
+use OCA\Files_Trashbin\Expiration;
 use OCA\GroupFolders\ACL\ACLManagerFactory;
 use OCA\GroupFolders\ACL\RuleManager;
 use OCA\GroupFolders\ACL\UserMapping\IUserMappingManager;
@@ -87,7 +88,8 @@ public function register(IRegistrationContext $context): void {
 				$c->get(TrashManager::class),
 				$c->get('GroupAppFolder'),
 				$c->get(MountProvider::class),
-				$c->get(ACLManagerFactory::class)
+				$c->get(ACLManagerFactory::class),
+				$c->getServer()->getRootFolder(),
 				$c->get(VersionsBackend::class)
 			);
 		});
@@ -103,9 +105,9 @@ public function register(IRegistrationContext $context): void {
 		$context->registerService(ExpireGroupVersions::class, function (IAppContainer $c) {
 			if (interface_exists('OCA\Files_Versions\Versions\IVersionBackend')) {
 				return new ExpireGroupVersions(
-					$c->get(GroupVersionsExpireManager::class)
 					$c->get(GroupVersionsExpireManager::class),
-					$c->get(TrashBackend::class)
+					$c->get(TrashBackend::class),
+					$c->get(Expiration::class)
 				);
 			}
 			return new ExpireGroupVersionsPlaceholder();
@@ -114,7 +116,9 @@ public function register(IRegistrationContext $context): void {
 		$context->registerService(\OCA\GroupFolders\BackgroundJob\ExpireGroupVersions::class, function (IAppContainer $c) {
 			if (interface_exists('OCA\Files_Versions\Versions\IVersionBackend')) {
 				return new \OCA\GroupFolders\BackgroundJob\ExpireGroupVersions(
-					$c->get(GroupVersionsExpireManager::class)
+					$c->get(GroupVersionsExpireManager::class),
+					$c->get(TrashBackend::class),
+					$c->get(Expiration::class)
 				);
 			}
 			return new \OCA\GroupFolders\BackgroundJob\ExpireGroupVersionsPlaceholder();

lib/BackgroundJob/ExpireGroupVersions.php

@@ -22,20 +22,35 @@
 namespace OCA\GroupFolders\BackgroundJob;
 
 use OCA\GroupFolders\Versions\GroupVersionsExpireManager;
+use OCA\Files_Trashbin\Expiration;
 
 class ExpireGroupVersions extends \OC\BackgroundJob\TimedJob {
 	const ITEMS_PER_SESSION = 1000;
 
+	/** @var GroupVersionsExpireManager */
 	private $expireManager;
 
-	public function __construct(GroupVersionsExpireManager $expireManager) {
+	/** @var TrashBackend */
+	private $trashBackend;
+
+	/** @var Expiration */
+	private $expiration;
+
+	public function __construct(
+		GroupVersionsExpireManager $expireManager,
+		TrashBackend $trashBackend,
+		Expiration $expiration
+	) {
 		// Run once per hour
 		$this->setInterval(60 * 60);
 
 		$this->expireManager = $expireManager;
+		$this->trashBackend = $trashBackend;
+		$this->expiration = $expiration;
 	}
 
 	protected function run($argument) {
 		$this->expireManager->expireAll();
+		$this->trashBackend->expire($this->expiration);
 	}
 }

lib/Command/ExpireGroupVersions.php

@@ -30,14 +30,24 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class ExpireGroupVersions extends Base {
+	/** @var GroupVersionsExpireManager */
 	private $expireManager;
 
+	/** @var TrashBackend */
 	private $trashBackend;
 
-	public function __construct(GroupVersionsExpireManager $expireManager, TrashBackend $trashBackend) {
+	/** @var Expiration */
+	private $expiration;
+
+	public function __construct(
+		GroupVersionsExpireManager $expireManager,
+		TrashBackend $trashBackend,
+		Expiration $expiration
+	) {
 		parent::__construct();
 		$this->expireManager = $expireManager;
 		$this->trashBackend = $trashBackend;
+		$this->expiration = $expiration;
 	}
 
 	protected function configure() {
@@ -62,7 +72,7 @@ protected function execute(InputInterface $input, OutputInterface $output) {
 		});
 
 
-		list($count, $size) = $this->trashBackend->expire(\OC::$server->get(Expiration::class));
+		list($count, $size) = $this->trashBackend->expire($this->expiration);
 		$output->writeln("<info>Removed $count expired trashbin items</info>");
 
 		$this->expireManager->expireAll();

lib/Folder/FolderManager.php

@@ -117,7 +117,7 @@ private function joinQueryWithFileCache(IQueryBuilder $query, int $rootStorageId
 	/**
 	 * @return (array|bool|int|mixed)[][]
 	 *
-	 * @psalm-return array<int, array{id: int, mount_point: mixed, groups: array<empty, empty>|array<array-key, int>, quota: int, size: int|mixed, acl: bool, manage: mixed}>
+	 * @psalm-return array<int, array{id: int, mount_point: mixed, groups: array<empty, empty>|array<array-key, int>, quota: int, size: int, acl: bool, manage: mixed}>
 	 * @throws Exception
 	 */
 	public function getAllFoldersWithSize(int $rootStorageId): array {
@@ -142,7 +142,7 @@ public function getAllFoldersWithSize(int $rootStorageId): array {
 				'mount_point' => $row['mount_point'],
 				'groups' => $applicableMap[$id] ?? [],
 				'quota' => (int)$row['quota'],
-				'size' => $row['size'] ? $row['size'] : 0,
+				'size' => $row['size'] ? (int)$row['size'] : 0,
 				'acl' => (bool)$row['acl'],
 				'manage' => $this->getManageAcl($mappings)
 			];

lib/Trash/TrashBackend.php

@@ -37,6 +37,7 @@
 use OCP\Files\NotFoundException;
 use OCP\Files\NotPermittedException;
 use OCP\Files\Storage\IStorage;
+use OCP\Files\IRootFolder;
 use OCP\IUser;
 
 class TrashBackend implements ITrashBackend {
@@ -58,12 +59,16 @@ class TrashBackend implements ITrashBackend {
 	/** @var VersionsBackend */
 	private $versionsBackend;
 
+    /** @var IRootFolder */
+	private $rootFolder;
+
 	public function __construct(
 		FolderManager $folderManager,
 		TrashManager $trashManager,
 		Folder $appFolder,
 		MountProvider $mountProvider,
 		ACLManagerFactory $aclManagerFactory,
+		IRootFolder $rootFolder,
 		VersionsBackend $versionsBackend
 	) {
 		$this->folderManager = $folderManager;
@@ -72,6 +77,7 @@ public function __construct(
 		$this->mountProvider = $mountProvider;
 		$this->aclManagerFactory = $aclManagerFactory;
 		$this->versionsBackend = $versionsBackend;
+		$this->rootFolder = $rootFolder;
 	}
 
 	public function listTrashRoot(IUser $user): array {
@@ -349,15 +355,25 @@ public function cleanTrashFolder(int $folderid) {
 	public function expire(Expiration $expiration): array {
 		$size = 0;
 		$count = 0;
-		$folders = $this->folderManager->getAllFolders();
+		$folders = $this->folderManager->getAllFoldersWithSize($this->rootFolder->getMountPoint()->getNumericStorageId());
 		foreach ($folders as $folder) {
 			$folderId = $folder['id'];
 			$trashItems = $this->trashManager->listTrashForFolders([$folderId]);
+
+			// calculate size of trash items
+			$sizeInTrash = 0;
 			$trashFolder = $this->getTrashFolder($folderId);
+			$nodes = []; // cache
 			foreach ($trashItems as $groupTrashItem) {
-				if ($expiration->isExpired($groupTrashItem['deleted_time'])) {
+				$nodeName = $groupTrashItem['name'] . '.d' . $groupTrashItem['deleted_time'];
+				$nodes[$nodeName] = $node = $trashFolder->get($nodeName);
+				$sizeInTrash += $node->getSize();
+			}
+			foreach ($trashItems as $groupTrashItem) {
+				if ($expiration->isExpired($groupTrashItem['deleted_time'], $folder['quota'] < ($folder['size'] + $sizeInTrash))) {
 					try {
-						$node = $trashFolder->get($groupTrashItem['name'] . '.d' . $groupTrashItem['deleted_time']);
+						$nodeName = $groupTrashItem['name'] . '.d' . $groupTrashItem['deleted_time'];
+						$node = $nodes[$nodeName];
 						$size += $node->getSize();
 						$count += 1;
 					} catch (NotFoundException $e) {
@@ -369,7 +385,9 @@ public function expire(Expiration $expiration): array {
 					}
 					$node->getStorage()->getCache()->remove($node->getInternalPath());
 					$this->trashManager->removeItem($folderId, $groupTrashItem['name'], $groupTrashItem['deleted_time']);
-					$this->versionsBackend->deleteAllVersionsForFile($folderId, $groupTrashItem['file_id']);
+					if (!is_null($groupTrashItem['file_id'])) {
+						$this->versionsBackend->deleteAllVersionsForFile($folderId, $groupTrashItem['file_id']);
+					}
 				} else {
 					break;
 				}

tests/psalm-baseline.xml

@@ -7,18 +7,13 @@
     </MissingDependency>
   </file>
   <file src="lib/AppInfo/Application.php">
-    <MissingDependency occurrences="13">
+    <MissingDependency occurrences="17">
       <code>$c-&gt;getServer()-&gt;getRootFolder()</code>
       <code>ExpireGroupVersions</code>
-      <code>ExpireGroupVersions</code>
       <code>ExpireGroupVersionsPlaceholder</code>
       <code>GroupVersionsExpireManager</code>
-      <code>GroupVersionsExpireManager</code>
-      <code>TrashBackend</code>
       <code>TrashBackend</code>
       <code>VersionsBackend</code>
-      <code>VersionsBackend</code>
-      <code>\OCA\GroupFolders\BackgroundJob\ExpireGroupVersions</code>
       <code>\OCA\GroupFolders\BackgroundJob\ExpireGroupVersions</code>
       <code>\OCA\GroupFolders\BackgroundJob\ExpireGroupVersionsPlaceholder</code>
     </MissingDependency>
@@ -67,9 +62,6 @@
       <code>GroupFolderStorage</code>
       <code>GroupMountPoint</code>
     </MissingDependency>
-    <UndefinedDocblockClass occurrences="1">
-      <code>$this-&gt;mountProviderCollection-&gt;getHomeMountForUser($user)-&gt;getStorage()</code>
-    </UndefinedDocblockClass>
   </file>
   <file src="lib/Versions/ExpireManager.php">
     <TypeDoesNotContainType occurrences="2">