📁 #2652 added download drive item as a zip archive (#2679)

* added download drive item as a zip archive

* added docs

* tweaks

Author: rezk2ll

Documentation/docs/internal-documentation/backend-services/documents/rest-apis.md

@@ -221,3 +221,21 @@ Used to create a drive item version
 ### Success Response
 
 **Code** : `200 OK`
+
+## zip download
+
+Used to create a zip archive containing the requested drive items ( files and folders ).
+
+**URL** : `/internal/services/documents/v1/companies/:company_id/item/:id/download/zip`
+
+**Method** : `POST`
+
+**Auth required** : Yes
+
+**Data constraints**
+
+```javascript
+{
+  items: string[]
+}
+```

twake/backend/node/package.json

@@ -53,6 +53,7 @@
     "@babel/preset-typescript": "^7.10.4",
     "@types/amqp-connection-manager": "^2.0.10",
     "@types/analytics-node": "^3.1.5",
+    "@types/archiver": "^5.3.1",
     "@types/bcrypt": "^5.0.0",
     "@types/busboy": "^0.2.3",
     "@types/chai": "^4.2.12",
@@ -118,6 +119,7 @@
     "amqp-connection-manager": "^3.7.0",
     "amqplib": "^0.8.0",
     "analytics-node": "^5.0.0",
+    "archiver": "^5.3.1",
     "axios": "^0.21.3",
     "bcrypt": "^5.0.1",
     "cassandra-driver": "^4.6.0",

twake/backend/node/src/services/documents/services/index.ts

@@ -9,6 +9,7 @@ import { DriveFile, TYPE } from "../entities/drive-file";
 import { FileVersion, TYPE as FileVersionType } from "../entities/file-version";
 import { CompanyExecutionContext, DriveItemDetails, RootType, TrashType } from "../types";
 import {
+  addDriveItemToArchive,
   calculateItemSize,
   checkAccess,
   getDefaultDriveItem,
@@ -17,6 +18,8 @@ import {
   updateItemSize,
 } from "../utils";
 
+import archiver from "archiver";
+
 export class DocumentsService {
   version: "1";
   repository: Repository<DriveFile>;
@@ -74,7 +77,7 @@ export class DocumentsService {
 
     //Check access to entity
     try {
-      const hasAccess = checkAccess(id, entity, "read", this.repository, context);
+      const hasAccess = await checkAccess(id, entity, "read", this.repository, context);
       if (!hasAccess) {
         this.logger.error("user does not have access drive item ", id);
         throw Error("user does not have access to this item");
@@ -161,7 +164,13 @@ export class DocumentsService {
       const driveItem = getDefaultDriveItem(content, context);
       const driveItemVersion = getDefaultDriveItemVersion(version, context);
 
-      const hasAccess = checkAccess(driveItem.parent_id, null, "write", this.repository, context);
+      const hasAccess = await checkAccess(
+        driveItem.parent_id,
+        null,
+        "write",
+        this.repository,
+        context,
+      );
       if (!hasAccess) {
         this.logger.error("user does not have access drive item parent", driveItem.parent_id);
         throw Error("user does not have access to this item parent");
@@ -174,6 +183,7 @@ export class DocumentsService {
         driveItem.extension = file.metadata.name.split(".").pop();
         driveItemVersion.filename = driveItemVersion.filename || file.metadata.name;
         driveItemVersion.file_size = file.upload_data.size;
+        driveItemVersion.file_id = file.id;
       }
 
       await this.fileVersionRepository.save(driveItemVersion);
@@ -209,7 +219,7 @@ export class DocumentsService {
     }
 
     try {
-      const hasAccess = checkAccess(id, null, "write", this.repository, context);
+      const hasAccess = await checkAccess(id, null, "write", this.repository, context);
 
       if (!hasAccess) {
         this.logger.error("user does not have access drive item ", id);
@@ -296,7 +306,7 @@ export class DocumentsService {
       }
 
       try {
-        if (!checkAccess(item.id, item, "write", this.repository, context)) {
+        if (!(await checkAccess(item.id, item, "write", this.repository, context))) {
           this.logger.error("user does not have access drive item ", id);
           throw Error("user does not have access to this item");
         }
@@ -372,7 +382,7 @@ export class DocumentsService {
     }
 
     try {
-      const hasAccess = checkAccess(id, null, "write", this.repository, context);
+      const hasAccess = await checkAccess(id, null, "write", this.repository, context);
       if (!hasAccess) {
         this.logger.error("user does not have access drive item ", id);
         throw Error("user does not have access to this item");
@@ -408,4 +418,43 @@ export class DocumentsService {
       throw new CrudException("Failed to create Drive item version", 500);
     }
   };
+
+  /**
+   * Creates a zip archive containing the drive items.
+   *
+   * @param {string[]} ids - the drive item list
+   * @param {CompanyExecutionContext} context - the execution context
+   * @returns {Promise<archiver.Archiver>} the created archive.
+   */
+  createZip = async (
+    ids: string[] = [],
+    context: CompanyExecutionContext,
+  ): Promise<archiver.Archiver> => {
+    if (!context) {
+      this.logger.error("invalid execution context");
+      return null;
+    }
+
+    const archive = archiver("zip", {
+      zlib: { level: 9 },
+    });
+
+    await Promise.all(
+      ids.map(async id => {
+        if (!(await checkAccess(id, null, "read", this.repository, context))) {
+          this.logger.warn(`not enough permissions to download ${id}, skipping`);
+          return;
+        }
+
+        try {
+          await addDriveItemToArchive(id, null, archive, this.repository, context);
+        } catch (error) {
+          this.logger.warn("failed to add item to archive", error);
+          throw new Error("Failed to add item to archive");
+        }
+      }),
+    );
+
+    return archive;
+  };
 }

twake/backend/node/src/services/documents/types.ts

@@ -6,6 +6,14 @@ export interface CompanyExecutionContext extends ExecutionContext {
   company: { id: string };
 }
 
+export type RequestParams = {
+  company_id: string;
+};
+
+export type ItemRequestParams = RequestParams & {
+  id: string;
+};
+
 export type DriveItemDetails = {
   path: DriveFile[];
   item?: DriveFile;
@@ -18,3 +26,7 @@ export type publicAccessLevel = "write" | "read" | "none";
 
 export type RootType = "root";
 export type TrashType = "trash";
+
+export type DownloadZipBodyRequest = {
+  items: string[];
+};

twake/backend/node/src/services/documents/utils.ts

@@ -11,6 +11,7 @@ import crypto from "crypto";
 import { FileVersion } from "./entities/file-version";
 import globalResolver from "../global-resolver";
 import Repository from "../../core/platform/services/database/services/orm/repository/repository";
+import archiver from "archiver";
 
 /**
  * Returns the default DriveFile object using existing data
@@ -23,28 +24,31 @@ export const getDefaultDriveItem = (
   item: Partial<DriveFile>,
   context: CompanyExecutionContext,
 ): DriveFile => {
-  const defaultDriveItem = merge(new DriveFile(), {
+  const defaultDriveItem = merge<DriveFile, Partial<DriveFile>>(new DriveFile(), {
     company_id: context.company.id,
     added: item.added || new Date().getTime().toString(),
     creator: item.creator || context.user.id,
     is_directory: item.is_directory || false,
     is_in_trash: false,
     last_user: item.last_user || context.user.id,
     last_modified: new Date().getTime().toString(),
-    parent_id: item.parent_id || "",
+    parent_id: item.parent_id || "root",
     root_group_folder: item.root_group_folder || "",
     attachements: item.attachements || [],
     content_keywords: item.content_keywords || "",
     description: item.description || "",
     access_info: item.access_info || {
-      authorized_entities: [
+      entities: [
         {
           id: context.user.id,
           type: "user",
+          level: "write",
         },
       ],
-      unauthorized_entities: [],
-      public_access_token: generateAccessToken(),
+      public: {
+        level: "read",
+        token: generateAccessToken(),
+      },
     },
     detached_file: item.detached_file || false,
     extension: item.extension || "",
@@ -366,3 +370,49 @@ export const checkAccess = async (
     throw Error(error);
   }
 };
+
+/**
+ * Adds drive items to an archive recursively
+ *
+ * @param {string} id - the drive item id
+ * @param {DriveFile | null } entity - the drive item entity
+ * @param {archiver.Archiver} archive - the archive
+ * @param {Repository<DriveFile>} repository - the repository
+ * @param {CompanyExecutionContext} context - the execution context
+ * @param {string} prefix - folder prefix
+ * @returns {Promise<void>}
+ */
+export const addDriveItemToArchive = async (
+  id: string,
+  entity: DriveFile | null,
+  archive: archiver.Archiver,
+  repository: Repository<DriveFile>,
+  context: CompanyExecutionContext,
+  prefix?: string,
+): Promise<void> => {
+  const item = entity || (await repository.findOne({ id, company_id: context.company.id }));
+
+  if (!item) {
+    throw Error("item not found");
+  }
+
+  if (!item.is_directory) {
+    const file_id = item.last_version_cache.file_id;
+    const file = await globalResolver.services.files.download(file_id, context);
+
+    if (!file) {
+      throw Error("file not found");
+    }
+
+    archive.append(file.file, { name: file.name, prefix: prefix ?? "" });
+  } else {
+    const items = await repository.find({
+      parent_id: item.id,
+      company_id: context.company.id,
+    });
+
+    items.getEntities().forEach(child => {
+      addDriveItemToArchive(child.id, child, archive, repository, context, `${item.name}/`);
+    });
+  }
+};

twake/backend/node/src/services/documents/web/controllers/documents.ts

@@ -1,4 +1,4 @@
-import { FastifyRequest } from "fastify";
+import { FastifyReply, FastifyRequest } from "fastify";
 import { logger } from "../../../../core/platform/framework";
 import { CrudException } from "../../../../core/platform/framework/api/crud-service";
 import { File } from "../../../../services/files/entities/file";
@@ -7,15 +7,13 @@ import globalResolver from "../../../../services/global-resolver";
 import { PaginationQueryParameters } from "../../../../utils/types";
 import { DriveFile } from "../../entities/drive-file";
 import { FileVersion } from "../../entities/file-version";
-import { CompanyExecutionContext, DriveItemDetails } from "../../types";
-
-type RequestParams = {
-  company_id: string;
-};
-
-type ItemRequestParams = RequestParams & {
-  id: string;
-};
+import {
+  CompanyExecutionContext,
+  DownloadZipBodyRequest,
+  DriveItemDetails,
+  ItemRequestParams,
+  RequestParams,
+} from "../../types";
 
 export class DocumentsController {
   /**
@@ -104,9 +102,10 @@ export class DocumentsController {
   };
 
   /**
+   * Update drive item
    *
    * @param {FastifyRequest} request
-   * @returns
+   * @returns {Promise<DriveFile>}
    */
   update = async (
     request: FastifyRequest<{ Params: ItemRequestParams; Body: Partial<DriveFile> }>,
@@ -118,6 +117,12 @@ export class DocumentsController {
     return await globalResolver.services.documents.update(id, update, context);
   };
 
+  /**
+   * Create a drive file version.
+   *
+   * @param {FastifyRequest} request
+   * @returns {Promise<FileVersion>}
+   */
   createVersion = async (
     request: FastifyRequest<{ Params: ItemRequestParams; Body: Partial<FileVersion> }>,
   ): Promise<FileVersion> => {
@@ -127,6 +132,39 @@ export class DocumentsController {
 
     return await globalResolver.services.documents.createVersion(id, version, context);
   };
+
+  /**
+   * Downloads a zip archive containing the drive items.
+   *
+   * @param {FastifyRequest} request
+   * @param {FastifyReply} reply
+   */
+  downloadZip = async (
+    request: FastifyRequest<{ Params: RequestParams; Body: DownloadZipBodyRequest }>,
+    reply: FastifyReply,
+  ): Promise<void> => {
+    const context = getCompanyExecutionContext(request);
+    const ids = request.body.items;
+
+    try {
+      const archive = await globalResolver.services.documents.createZip(ids, context);
+
+      archive.on("finish", () => {
+        reply.status(200);
+      });
+
+      archive.on("error", () => {
+        reply.internalServerError();
+      });
+
+      archive.pipe(reply.raw);
+
+      archive.finalize();
+    } catch (error) {
+      logger.error("failed to send zip file", error);
+      throw new CrudException("Failed to create zip file", 500);
+    }
+  };
 }
 
 /**

twake/backend/node/src/services/documents/web/routes.ts

@@ -1,6 +1,6 @@
 import { FastifyInstance, FastifyPluginCallback } from "fastify";
 import { DocumentsController } from "./controllers";
-import { createDocumentSchema, createVersionSchema } from "./schemas";
+import { createDocumentSchema, createVersionSchema, downloadZipSchema } from "./schemas";
 
 const serviceUrl = "/companies/:company_id/item";
 
@@ -44,6 +44,14 @@ const routes: FastifyPluginCallback = (fastify: FastifyInstance, _options, next)
     handler: documentsController.createVersion.bind(documentsController),
   });
 
+  fastify.route({
+    method: "POST",
+    url: `${serviceUrl}/download/zip`,
+    preValidation: [fastify.authenticate],
+    schema: downloadZipSchema,
+    handler: documentsController.downloadZip.bind(documentsController),
+  });
+
   return next();
 };