Merge pull request #6349 from LibreSign/backport/6347/stable32

[stable32] feat: delete empty folders and respect checkbox

Author: vitormattos

lib/Controller/FileController.php

@@ -668,6 +668,7 @@ private function extractFileName(array $fileData): string {
 	 * This will delete the file and all data
 	 *
 	 * @param integer $fileId LibreSign file ID
+	 * @param boolean $deleteFile Whether to delete the physical file from Nextcloud (default: true)
 	 * @return DataResponse<Http::STATUS_OK, array{message: string}, array{}>|DataResponse<Http::STATUS_UNAUTHORIZED, array{message: string}, array{}>|DataResponse<Http::STATUS_UNPROCESSABLE_ENTITY, array{action: integer, errors: list<array{message: string, title?: string}>}, array{}>
 	 *
 	 * 200: OK
@@ -678,7 +679,7 @@ private function extractFileName(array $fileData): string {
 	#[NoCSRFRequired]
 	#[RequireManager]
 	#[ApiRoute(verb: 'DELETE', url: '/api/{apiVersion}/file/file_id/{fileId}', requirements: ['apiVersion' => '(v1)'])]
-	public function deleteAllRequestSignatureUsingFileId(int $fileId): DataResponse {
+	public function deleteAllRequestSignatureUsingFileId(int $fileId, bool $deleteFile = true): DataResponse {
 		try {
 			$data = [
 				'userManager' => $this->userSession->getUser(),
@@ -687,7 +688,7 @@ public function deleteAllRequestSignatureUsingFileId(int $fileId): DataResponse
 				]
 			];
 			$this->validateHelper->validateExistingFile($data);
-			$this->fileService->delete($fileId);
+			$this->fileService->delete($fileId, $deleteFile);
 		} catch (\Throwable $th) {
 			return new DataResponse(
 				[

lib/Service/FileService.php

@@ -570,15 +570,15 @@ private function computeEnvelopeSignersProgress(): void {
 		);
 	}
 
-	public function delete(int $fileId): void {
+	public function delete(int $fileId, bool $deleteFile = true): void {
 		$file = $this->fileMapper->getById($fileId);
 
 		$this->decrementEnvelopeFilesCountIfNeeded($file);
 
 		if ($file->getNodeType() === 'envelope') {
 			$childrenFiles = $this->fileMapper->getChildrenFiles($file->getId());
 			foreach ($childrenFiles as $childFile) {
-				$this->delete($childFile->getId());
+				$this->delete($childFile->getId(), $deleteFile);
 			}
 		}
 
@@ -590,14 +590,33 @@ public function delete(int $fileId): void {
 		}
 		$this->idDocsMapper->deleteByFileId($file->getId());
 		$this->fileMapper->delete($file);
-		if ($file->getSignedNodeId()) {
-			$signedNextcloudFile = $this->folderService->getFileByNodeId($file->getSignedNodeId());
-			$signedNextcloudFile->delete();
+		if ($deleteFile) {
+			if ($file->getSignedNodeId()) {
+				$signedNextcloudFile = $this->folderService->getFileByNodeId($file->getSignedNodeId());
+				$parentFolder = $signedNextcloudFile->getParent();
+				$signedNextcloudFile->delete();
+				$this->deleteEmptyFolder($parentFolder);
+			}
+			try {
+				$nextcloudFile = $this->folderService->getFileByNodeId($file->getNodeId());
+				$parentFolder = $nextcloudFile->getParent();
+				$nextcloudFile->delete();
+				$this->deleteEmptyFolder($parentFolder);
+			} catch (NotFoundException) {
+			}
 		}
+	}
+
+	private function deleteEmptyFolder(\OCP\Files\Folder $folder): void {
 		try {
-			$nextcloudFile = $this->folderService->getFileByNodeId($file->getNodeId());
-			$nextcloudFile->delete();
-		} catch (NotFoundException) {
+			$contents = $folder->getDirectoryListing();
+			if (count($contents) === 0) {
+				$folder->delete();
+			}
+		} catch (\Exception $e) {
+			$this->logger->debug('Could not delete empty folder: ' . $e->getMessage(), [
+				'exception' => $e,
+			]);
 		}
 	}
 

openapi-full.json

@@ -5201,6 +5201,19 @@
                             "format": "int64"
                         }
                     },
+                    {
+                        "name": "deleteFile",
+                        "in": "query",
+                        "description": "Whether to delete the physical file from Nextcloud (default: true)",
+                        "schema": {
+                            "type": "integer",
+                            "default": 1,
+                            "enum": [
+                                0,
+                                1
+                            ]
+                        }
+                    },
                     {
                         "name": "OCS-APIRequest",
                         "in": "header",

openapi.json

@@ -5051,6 +5051,19 @@
                             "format": "int64"
                         }
                     },
+                    {
+                        "name": "deleteFile",
+                        "in": "query",
+                        "description": "Whether to delete the physical file from Nextcloud (default: true)",
+                        "schema": {
+                            "type": "integer",
+                            "default": 1,
+                            "enum": [
+                                0,
+                                1
+                            ]
+                        }
+                    },
                     {
                         "name": "OCS-APIRequest",
                         "in": "header",

src/store/files.js

@@ -354,9 +354,10 @@ export const useFilesStore = function(...args) {
 					const url = deleteFile
 						? '/apps/libresign/api/v1/file/file_id/{fileId}'
 						: '/apps/libresign/api/v1/sign/file_id/{fileId}'
+					const params = deleteFile ? { deleteFile: true } : {}
 					await axios.delete(generateOcsUrl(url, {
 						fileId: file.id,
-					}))
+					}), { params })
 						.then(() => {
 							if (this.selectedNodeId === file.nodeId) {
 								const sidebarStore = useSidebarStore()

src/types/openapi/openapi-full.ts

@@ -3473,7 +3473,10 @@ export interface operations {
     };
     "file-delete-all-request-signature-using-file-id": {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description Whether to delete the physical file from Nextcloud (default: true) */
+                deleteFile?: 0 | 1;
+            };
             header: {
                 /** @description Required to be true for the API request to pass */
                 "OCS-APIRequest": boolean;

src/types/openapi/openapi.ts

@@ -2995,7 +2995,10 @@ export interface operations {
     };
     "file-delete-all-request-signature-using-file-id": {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description Whether to delete the physical file from Nextcloud (default: true) */
+                deleteFile?: 0 | 1;
+            };
             header: {
                 /** @description Required to be true for the API request to pass */
                 "OCS-APIRequest": boolean;