fix(addressregister): ZMS-268: add new addressregister endpoint to disable an entry or edit it (#873)

* add new addressregister endpoint to disable an entry or edit it

* readOwn,readAny -> createOwn, createAny for addressregister updates. Fix indexes. Make query more constraint

* remove unused indexes

Author: NickOvt

indexes.yaml

@@ -413,11 +413,19 @@ indexes:
 
     - collection: addressregister
       index:
-          name: by_name
+          name: by_user_disabled_partial
           key:
               user: 1
-              name: 1
               updated: -1
+          partialFilterExpression:
+              disabled: false
+
+    - collection: addressregister
+      index:
+          name: by_user_disabled
+          key:
+              user: 1
+              disabled: 1
 
     # indexes for deleted messages
     - collection: archived

lib/api/addresses.js

@@ -1413,7 +1413,8 @@ module.exports = (db, server, userHandler, settingsHandler) => {
                                         $options: 'i'
                                     }
                                 }
-                            ]
+                            ],
+                            disabled: false // get addresses that are not disabled
                         },
                         {
                             sort: { updated: -1 },
@@ -1460,6 +1461,142 @@ module.exports = (db, server, userHandler, settingsHandler) => {
         })
     );
 
+    server.put(
+        {
+            path: '/users/:user/addressregister/:id',
+            summary: 'Update an address in the addressregister',
+            name: 'updateAddressAddressregister',
+            tags: ['Addresses'],
+            validationObjs: {
+                requestBody: {
+                    disabled: booleanSchema
+                        .required()
+                        .description(
+                            'Disable the address in the register. Disabled addresses are not updated on email receival and sending. Disabled addresses are not included in the response for listing addresses in the register.'
+                        ),
+                    name: Joi.string().max(255).description('Address header name')
+                },
+                queryParams: {
+                    sess: sessSchema,
+                    ip: sessIPSchema
+                },
+                pathParams: {
+                    user: userId,
+                    id: addressId
+                },
+                response: {
+                    200: {
+                        description: 'Success',
+                        model: Joi.object({
+                            success: successRes
+                        }).$_setFlag('objectName', 'SuccessResponse')
+                    }
+                }
+            }
+        },
+        tools.responseWrapper(async (req, res) => {
+            res.charSet('utf-8');
+
+            const { pathParams, requestBody, queryParams } = req.route.spec.validationObjs;
+
+            const schema = Joi.object({
+                ...pathParams,
+                ...queryParams,
+                ...requestBody
+            });
+
+            const result = schema.validate(req.params, {
+                abortEarly: false,
+                convert: true
+            });
+
+            if (result.error) {
+                res.status(400);
+                return res.json({
+                    error: result.error.message,
+                    code: 'InputValidationError',
+                    details: tools.validationErrors(result)
+                });
+            }
+
+            let user = new ObjectId(result.value.user);
+            let addressId = new ObjectId(result.value.id);
+
+            // permissions check
+            if (req.user && req.user === result.value.user) {
+                req.validate(roles.can(req.role).createOwn('addresses'));
+            } else {
+                req.validate(roles.can(req.role).createAny('addresses'));
+            }
+
+            let userData;
+            try {
+                userData = await db.users.collection('users').findOne(
+                    {
+                        _id: user
+                    },
+                    {
+                        projection: {
+                            _id: true
+                        }
+                    }
+                );
+            } catch (err) {
+                res.status(500);
+                return res.json({
+                    error: 'MongoDB Error: ' + err.message,
+                    code: 'InternalDatabaseError'
+                });
+            }
+
+            if (!userData) {
+                res.status(404);
+                return res.json({
+                    error: 'This user does not exist',
+                    code: 'UserNotFound'
+                });
+            }
+
+            const update = {
+                disabled: result.value.disabled,
+                updated: new Date()
+            };
+
+            if (result.value.name) {
+                update.name = result.value.name;
+                try {
+                    // try to decode
+                    update.name = libmime.decodeWords(update.name);
+                } catch {
+                    // ignore
+                }
+            }
+
+            let response;
+            try {
+                response = await db.database.collection('addressregister').updateOne(
+                    {
+                        user: userData._id,
+                        _id: addressId
+                    },
+                    {
+                        $set: update
+                    }
+                );
+            } catch (err) {
+                res.status(500);
+                return res.json({
+                    error: 'MongoDB Error: ' + err.message,
+                    code: 'InternalDatabaseError'
+                });
+            }
+
+            return res.json({
+                success: !!response.matchedCount
+            });
+        })
+    );
+
     server.post(
         {
             path: '/addresses/forwarded',

lib/message-handler.js

@@ -170,14 +170,16 @@ class MessageHandler {
                 await this.database.collection('addressregister').findOneAndUpdate(
                     {
                         user,
-                        addrview: addr.addrview
+                        addrview: addr.addrview,
+                        disabled: false // if disabled then do not update
                     },
                     {
                         $set: updates,
                         $setOnInsert: {
                             user,
                             address: addr.address,
-                            addrview: addr.addrview
+                            addrview: addr.addrview,
+                            disabled: false
                         }
                     },
                     { upsert: true, projection: { _id: true } }