simple-file-controller.ts

/**
 *  SudoSOS back-end API service.
 *  Copyright (C) 2024  Study association GEWIS
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published
 *  by the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 *  @license
 */

/**
 * This is the module page of the simple-file-controller.
 *
 * @module internal/files
 */

import log4js, { Logger } from 'log4js';
import { Response } from 'express';
import { UploadedFile } from 'express-fileupload';
import BaseController, { BaseControllerOptions } from './base-controller';
import Policy from './policy';
import { RequestWithToken } from '../middleware/token-middleware';
import FileService from '../service/file-service';
import SimpleFileRequest from './request/simple-file-request';
import putFileInResponse from '../files/response';

/**
 * This is a mock-controller since there is no actual use for this controller in sudoSOS.
 * This controller allows you to upload files to the server and retrieve them, however
 * in actual production environment we only want to upload files with associations.
 *
 * For example, the product controller would use the file-service to upload files.
 */
export default class SimpleFileController extends BaseController {
  private logger: Logger = log4js.getLogger('SimpleFileController');

  private fileService: FileService;

  /**
   * Creates a new product controller instance.
   * @param options - The options passed to the base controller.
   */
  public constructor(options: BaseControllerOptions) {
    super(options);
    this.logger.level = process.env.LOG_LEVEL;
    this.fileService = new FileService();
  }

  /**
   * @inheritDoc
   */
  getPolicy(): Policy {
    return {
      '/': {
        POST: {
          body: { modelName: 'SimpleFileRequest' },
          policy: async (req) => this.roleManager.can(req.token.roles, 'create', 'all', 'SimpleFile', ['*']),
          handler: this.uploadFile.bind(this),
        },
      },
      '/:id(\\d+)': {
        GET: {
          policy: async (req) => this.roleManager.can(req.token.roles, 'get', 'all', 'SimpleFile', ['*']),
          handler: this.downloadFile.bind(this),
        },
        DELETE: {
          policy: async (req) => this.roleManager.can(req.token.roles, 'delete', 'all', 'SimpleFile', ['*']),
          handler: this.deleteFile.bind(this),
        },
      },
    };
  }


  /**
   * @typedef {object} FileUpload
   * @property {string} name.required - The name of the file
   * @property {string} file - file - binary
   */

  /**
   * POST /files
   * @summary Upload a file with the given name.
   * @operationId createFile
   * @tags files - Operations of the simple files controller
   * @consumes multipart/form-data
   * @param {FileUpload} request.body.required - simple file - multipart/form-data
   * @security JWT
   * @return {SimpleFileResponse} 200 - The uploaded file entity
   * @return {string} 400 - Validation error
   * @return {string} 500 - Internal server error
   */
  public async uploadFile(req: RequestWithToken, res: Response): Promise<void> {
    this.logger.trace('Upload simple file by user', req.token.user);
    const { body, files } = req;

    if (!req.files || Object.keys(files).length !== 1) {
      res.status(400).send('No file or too many files were uploaded');
      return;
    }
    if (files.file === undefined) {
      res.status(400).send("No file is uploaded in the 'file' field");
      return;
    }

    // handle request
    try {
      res.json(await this.fileService.uploadSimpleFile(
        req.token.user, files.file as UploadedFile, body as SimpleFileRequest,
      ));
    } catch (error) {
      this.logger.error('Could not upload file:', error);
      res.status(500).json('Internal server error');
    }
  }

  /**
   * GET /files/{id}
   * @summary Download a file with the given id.
   * @operationId getFile
   * @tags files - Operations of the simple files controller
   * @param {integer} id.path.required - The id of the file which should be downloaded
   * @security JWT
   * @return {string} 200 - The requested file
   * @return {string} 404 - File not found
   * @return {string} 500 - Internal server error
   */
  public async downloadFile(req: RequestWithToken, res: Response): Promise<void> {
    const { id } = req.params;
    this.logger.trace('Download simple file', id, ' by user', req.token.user);

    try {
      const fileInfo = await this.fileService.getSimpleFile(Number.parseInt(id, 10));
      if (fileInfo === undefined) {
        res.status(404);
      }

      const { file, data } = fileInfo;
      putFileInResponse(res, file, data);
    } catch (error) {
      this.logger.error('Could not download file:', error);
      res.status(500).json('Internal server error');
    }
  }

  /**
   * DELETE /files/{id}
   * @summary Delete the file with the given id.
   * @operationId deleteFile
   * @tags files - Operations of the simple files controller
   * @param {integer} id.path.required - The id of the file which should be deleted
   * @security JWT
   * @return 204 - Success
   * @return {string} 404 - File not found
   * @return {string} 500 - Internal server error
   */
  public async deleteFile(req: RequestWithToken, res: Response): Promise<void> {
    const { id } = req.params;
    this.logger.trace('Download simple file', id, 'by user', req.token.user);

    try {
      await this.fileService.deleteSimpleFile(Number.parseInt(id, 10));
      res.status(204);
      res.send();
    } catch (error) {
      this.logger.error('Could not delete file:', error);
      res.status(500).json('Internal server error');
    }
  }
}