import Planka upstream

2026-07-18 11:48:22 +08:00
commit c26fd3b190
1564 changed files with 214813 additions and 0 deletions
@@ -0,0 +1,140 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+/**
+ * @swagger
+ * /comments/{id}:
+ *   patch:
+ *     summary: Update comment
+ *     description: Updates a comment. Only the author of the comment can update it.
+ *     tags:
+ *       - Comments
+ *     operationId: updateComments
+ *     parameters:
+ *       - name: id
+ *         in: path
+ *         required: true
+ *         description: ID of the comment to update
+ *         schema:
+ *           type: string
+ *           example: "1357158568008091264"
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               text:
+ *                 type: string
+ *                 maxLength: 1048576
+ *                 description: Content of the comment
+ *                 example: This task is almost complete...
+ *     responses:
+ *       200:
+ *         description: Comment updated successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - item
+ *               properties:
+ *                 item:
+ *                   $ref: '#/components/schemas/Comment'
+ *       400:
+ *         $ref: '#/components/responses/ValidationError'
+ *       401:
+ *         $ref: '#/components/responses/Unauthorized'
+ *       403:
+ *         $ref: '#/components/responses/Forbidden'
+ *       404:
+ *         $ref: '#/components/responses/NotFound'
+ */
+
+const { idInput } = require('../../../utils/inputs');
+
+const Errors = {
+  NOT_ENOUGH_RIGHTS: {
+    notEnoughRights: 'Not enough rights',
+  },
+  COMMENT_NOT_FOUND: {
+    commentNotFound: 'Comment not found',
+  },
+};
+
+module.exports = {
+  inputs: {
+    id: {
+      ...idInput,
+      required: true,
+    },
+    text: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 1048576,
+    },
+  },
+
+  exits: {
+    notEnoughRights: {
+      responseType: 'forbidden',
+    },
+    commentNotFound: {
+      responseType: 'notFound',
+    },
+  },
+
+  async fn(inputs) {
+    const { currentUser } = this.req;
+
+    const pathToProject = await sails.helpers.comments
+      .getPathToProjectById(inputs.id)
+      .intercept('pathNotFound', () => Errors.COMMENT_NOT_FOUND);
+
+    let { comment } = pathToProject;
+    const { card, list, board, project } = pathToProject;
+
+    if (comment.userId !== currentUser.id) {
+      throw Errors.COMMENT_NOT_FOUND; // Forbidden
+    }
+
+    const boardMembership = await BoardMembership.qm.getOneByBoardIdAndUserId(
+      board.id,
+      currentUser.id,
+    );
+
+    if (!boardMembership) {
+      throw Errors.COMMENT_NOT_FOUND; // Forbidden
+    }
+
+    if (boardMembership.role !== BoardMembership.Roles.EDITOR) {
+      if (!boardMembership.canComment) {
+        throw Errors.NOT_ENOUGH_RIGHTS;
+      }
+    }
+
+    const values = _.pick(inputs, ['text']);
+
+    comment = await sails.helpers.comments.updateOne.with({
+      values,
+      project,
+      board,
+      list,
+      card,
+      record: comment,
+      actorUser: currentUser,
+      request: this.req,
+    });
+
+    if (!comment) {
+      throw Errors.COMMENT_NOT_FOUND;
+    }
+
+    return {
+      item: comment,
+    };
+  },
+};