Files
planka/server/api/controllers/file-attachments/download.js
2025-09-08 18:25:26 +02:00

137 lines
3.5 KiB
JavaScript

/*!
* Copyright (c) 2024 PLANKA Software GmbH
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /attachments/{id}/download:
* get:
* summary: Download file attachment
* description: Downloads a file attachment. Requires access to the card.
* tags:
* - File Attachments
* parameters:
* - name: id
* in: path
* required: true
* description: ID of the file attachment to download
* schema:
* type: string
* example: 1357158568008091264
* responses:
* 200:
* description: File attachment content returned successfully
* content:
* application/octet-stream:
* schema:
* type: string
* format: binary
* image/*:
* schema:
* type: string
* format: binary
* headers:
* Content-Disposition:
* schema:
* type: string
* description: Attachment disposition with filename
* Content-Type:
* schema:
* type: string
* description: MIME type of the file
* 400:
* $ref: '#/components/responses/ValidationError'
* 401:
* $ref: '#/components/responses/Unauthorized'
* 404:
* $ref: '#/components/responses/NotFound'
*/
const { idInput } = require('../../../utils/inputs');
const Errors = {
FILE_ATTACHMENT_NOT_FOUND: {
fileAttachmentNotFound: 'File attachment not found',
},
};
const INLINE_MIME_TYPES_SET = new Set([
'application/pdf',
'audio/mpeg',
'audio/wav',
'audio/ogg',
'audio/opus',
'audio/mp4',
'audio/x-aac',
'video/mp4',
'video/ogg',
'video/webm',
]);
module.exports = {
inputs: {
id: {
...idInput,
required: true,
},
},
exits: {
fileAttachmentNotFound: {
responseType: 'notFound',
},
},
async fn(inputs, exits) {
const { currentUser } = this.req;
const { attachment, board, project } = await sails.helpers.attachments
.getPathToProjectById(inputs.id)
.intercept('pathNotFound', () => Errors.FILE_ATTACHMENT_NOT_FOUND);
if (attachment.type !== Attachment.Types.FILE) {
throw Errors.FILE_ATTACHMENT_NOT_FOUND;
}
if (currentUser.role !== User.Roles.ADMIN || project.ownerProjectManagerId) {
const isProjectManager = await sails.helpers.users.isProjectManager(
currentUser.id,
project.id,
);
if (!isProjectManager) {
const boardMembership = await BoardMembership.qm.getOneByBoardIdAndUserId(
board.id,
currentUser.id,
);
if (!boardMembership) {
throw Errors.FILE_ATTACHMENT_NOT_FOUND; // Forbidden
}
}
}
const fileManager = sails.hooks['file-manager'].getInstance();
let readStream;
try {
readStream = await fileManager.read(
`${sails.config.custom.attachmentsPathSegment}/${attachment.data.uploadedFileId}/${attachment.data.filename}`,
);
} catch (error) {
throw Errors.FILE_ATTACHMENT_NOT_FOUND;
}
if (attachment.data.mimeType) {
this.res.type(attachment.data.mimeType);
}
if (!INLINE_MIME_TYPES_SET.has(attachment.data.mimeType) && !attachment.data.image) {
this.res.set('Content-Disposition', 'attachment');
}
this.res.set('Cache-Control', 'private, max-age=900'); // TODO: move to config
return exits.success(readStream);
},
};