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,127 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+/**
+ * @swagger
+ * /users/{id}:
+ *   get:
+ *     summary: Get user details
+ *     description: Retrieves a user. Use 'me' as ID to get the current user.
+ *     tags:
+ *       - Users
+ *     operationId: getUser
+ *     parameters:
+ *       - name: id
+ *         in: path
+ *         required: true
+ *         description: ID of the user or 'me' for current user
+ *         schema:
+ *           type: string
+ *           example: "1357158568008091264"
+ *       - name: subscribe
+ *         in: query
+ *         required: false
+ *         description: Whether to subscribe to real-time updates for this user (only for socket connections)
+ *         schema:
+ *           type: boolean
+ *           example: true
+ *     responses:
+ *       200:
+ *         description: User details retrieved successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - item
+ *                 - included
+ *               properties:
+ *                 item:
+ *                   $ref: '#/components/schemas/User'
+ *                 included:
+ *                   type: object
+ *                   required:
+ *                     - notificationServices
+ *                   properties:
+ *                     notificationServices:
+ *                       type: array
+ *                       description: Related notification services (for current user)
+ *                       items:
+ *                         $ref: '#/components/schemas/NotificationService'
+ *       400:
+ *         $ref: '#/components/responses/ValidationError'
+ *       401:
+ *         $ref: '#/components/responses/Unauthorized'
+ *       404:
+ *         $ref: '#/components/responses/NotFound'
+ */
+
+const { ID_REGEX, MAX_STRING_ID, isIdInRange } = require('../../../utils/validators');
+
+const Errors = {
+  USER_NOT_FOUND: {
+    userNotFound: 'User not found',
+  },
+};
+
+const CURRENT_USER_ID = 'me';
+
+const ID_OR_CURRENT_USER_ID_REGEX = new RegExp(`${ID_REGEX.source}|^${CURRENT_USER_ID}$`);
+
+const isCurrentUserIdOrIdInRange = (value) => value === CURRENT_USER_ID || isIdInRange(value);
+
+module.exports = {
+  inputs: {
+    id: {
+      type: 'string',
+      maxLength: MAX_STRING_ID.length,
+      regex: ID_OR_CURRENT_USER_ID_REGEX,
+      custom: isCurrentUserIdOrIdInRange,
+      required: true,
+    },
+    subscribe: {
+      type: 'boolean',
+    },
+  },
+
+  exits: {
+    userNotFound: {
+      responseType: 'notFound',
+    },
+  },
+
+  async fn(inputs) {
+    const { currentUser } = this.req;
+
+    let user;
+    let notificationServices = [];
+
+    if (inputs.id === CURRENT_USER_ID || inputs.id === currentUser.id) {
+      user = currentUser;
+      notificationServices = await NotificationService.qm.getByUserId(currentUser.id);
+
+      if (inputs.subscribe && this.req.isSocket) {
+        sails.sockets.join(this.req, `user:${user.id}`);
+      }
+    } else {
+      if (!sails.helpers.users.isAdminOrProjectOwner(currentUser)) {
+        throw Errors.USER_NOT_FOUND; // Forbidden
+      }
+
+      user = await User.qm.getOneById(inputs.id);
+
+      if (!user) {
+        throw Errors.USER_NOT_FOUND;
+      }
+    }
+
+    return {
+      item: sails.helpers.users.presentOne(user, currentUser),
+      included: {
+        notificationServices,
+      },
+    };
+  },
+};