wildduck/lib/api/domainaliases.js
2024-06-02 11:25:59 +03:00

565 lines
19 KiB
JavaScript

'use strict';
const Joi = require('joi');
const MongoPaging = require('mongo-cursor-pagination');
const ObjectId = require('mongodb').ObjectId;
const tools = require('../tools');
const roles = require('../roles');
const { nextPageCursorSchema, previousPageCursorSchema, pageNrSchema, sessSchema, sessIPSchema } = require('../schemas');
const { publish, DOMAINALIAS_CREATED, DOMAINALIAS_DELETED } = require('../events');
const { successRes, totalRes, pageRes, previousCursorRes, nextCursorRes } = require('../schemas/response/general-schemas');
module.exports = (db, server) => {
server.get(
{
name: 'domainaliases',
path: '/domainaliases',
tags: ['DomainAliases'],
summary: 'List registered Domain Aliases',
validationObjs: {
requestBody: {},
pathParams: {},
queryParams: {
query: Joi.string().trim().empty('').max(255).description('Partial match of a Domain Alias or Domain name'),
limit: Joi.number().default(20).min(1).max(250).description('How many records to return'),
next: nextPageCursorSchema,
previous: previousPageCursorSchema,
page: pageNrSchema,
sess: sessSchema,
ip: sessIPSchema
},
response: {
200: {
description: 'Success',
model: Joi.object({
success: successRes,
total: totalRes,
page: pageRes,
previousCursor: previousCursorRes,
nextCursor: nextCursorRes,
results: Joi.array()
.items(
Joi.object({
id: Joi.string().required().description('ID of the Domain Alias'),
alias: Joi.string().required().description('Domain Alias'),
domain: Joi.string().required().description('The domain this alias applies to')
}).$_setFlag('objectName', 'GetDomainAliasesResult')
)
.required()
.description('Aliases listing')
})
}
}
}
},
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,
allowUnknown: true
});
if (result.error) {
res.status(400);
return res.json({
error: result.error.message,
code: 'InputValidationError',
details: tools.validationErrors(result)
});
}
// permissions check
req.validate(roles.can(req.role).readAny('domainaliases'));
let query = result.value.query;
let limit = result.value.limit;
let page = result.value.page;
let pageNext = result.value.next;
let pagePrevious = result.value.previous;
let filter = query
? {
$or: [
{
alias: {
$regex: tools.escapeRegexStr(query),
$options: ''
}
},
{
domain: {
$regex: tools.escapeRegexStr(query),
$options: ''
}
}
]
}
: {};
let total = await db.users.collection('domainaliases').countDocuments(filter);
let opts = {
limit,
query: filter,
fields: {
// FIXME: hack to keep alias in response
alias: true,
// FIXME: MongoPaging inserts fields value as second argument to col.find()
projection: {
_id: true,
alias: true,
domain: true
}
},
paginatedField: 'alias',
sortAscending: true
};
if (pageNext) {
opts.next = pageNext;
} else if ((!page || page > 1) && pagePrevious) {
opts.previous = pagePrevious;
}
let listing;
try {
listing = await MongoPaging.find(db.users.collection('domainaliases'), opts);
} catch (err) {
res.status(500);
return res.json({
error: 'MongoDB Error: ' + err.message,
code: 'InternalDatabaseError'
});
}
if (!listing.hasPrevious) {
page = 1;
}
let response = {
success: true,
query,
total,
page,
previousCursor: listing.hasPrevious ? listing.previous : false,
nextCursor: listing.hasNext ? listing.next : false,
results: (listing.results || []).map(domainData => ({
id: domainData._id.toString(),
alias: domainData.alias,
domain: domainData.domain
}))
};
return res.json(response);
})
);
server.post(
{
path: '/domainaliases',
tags: ['DomainAliases'],
summary: 'Create new Domain Alias',
description: 'Add a new Alias for a Domain. This allows to accept mail on username@domain and username@alias',
validationObjs: {
requestBody: {
alias: Joi.string()
.max(255)
//.hostname()
.required()
.description('Domain Alias'),
domain: Joi.string()
.max(255)
//.hostname()
.required()
.description('Domain name this Alias applies to'),
sess: sessSchema,
ip: sessIPSchema
},
queryParams: {},
pathParams: {},
response: {
200: {
description: 'Success',
model: Joi.object({ success: successRes, id: Joi.string().required().description('ID of the Domain Alias') })
}
}
}
},
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)
});
}
// permissions check
req.validate(roles.can(req.role).createAny('domainaliases'));
let alias = tools.normalizeDomain(req.params.alias);
let domain = tools.normalizeDomain(req.params.domain);
let aliasData;
try {
aliasData = await db.users.collection('domainaliases').findOne(
{
alias
},
{
projection: { _id: 1 }
}
);
} catch (err) {
res.status(500);
return res.json({
error: 'MongoDB Error: ' + err.message,
code: 'InternalDatabaseError'
});
}
if (aliasData) {
res.status(400);
return res.json({
error: 'This domain alias already exists',
code: 'AliasExists'
});
}
let r;
try {
// insert alias address to email address registry
r = await db.users.collection('domainaliases').insertOne({
alias,
domain,
created: new Date()
});
} catch (err) {
res.status(500);
return res.json({
error: 'MongoDB Error: ' + err.message,
code: 'InternalDatabaseError'
});
}
let insertId = r.insertedId;
await publish(db.redis, {
ev: DOMAINALIAS_CREATED,
domainalias: insertId,
alias,
domain
});
return res.json({
success: !!insertId,
id: insertId
});
})
);
server.get(
{
path: '/domainaliases/resolve/:alias',
tags: ['DomainAliases'],
summary: 'Resolve ID for a domain alias',
validationObjs: {
requestBody: {},
pathParams: {
alias: Joi.string()
.max(255)
//.hostname()
.required()
.description('Alias domain')
},
queryParams: {
sess: sessSchema,
ip: sessIPSchema
},
response: {
200: {
description: 'Success',
model: Joi.object({ success: successRes, id: Joi.string().required().description('Unique ID (24 byte hex)') })
}
}
}
},
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)
});
}
// permissions check
req.validate(roles.can(req.role).readAny('domainaliases'));
let alias = tools.normalizeDomain(result.value.alias);
let aliasData;
try {
aliasData = await db.users.collection('domainaliases').findOne(
{
alias
},
{
projection: { _id: 1 }
}
);
} catch (err) {
res.status(500);
return res.json({
error: 'MongoDB Error: ' + err.message,
code: 'InternalDatabaseError'
});
}
if (!aliasData) {
res.status(404);
return res.json({
error: 'This alias does not exist',
code: 'AliasNotFound'
});
}
return res.json({
success: true,
id: aliasData._id.toString()
});
})
);
server.get(
{
path: '/domainaliases/:alias',
tags: ['DomainAliases'],
summary: 'Request Alias information',
validationObjs: {
requestBody: {},
queryParams: {
sess: sessSchema,
ip: sessIPSchema
},
pathParams: {
alias: Joi.string().hex().lowercase().length(24).required().description('ID of the Alias')
},
response: {
200: {
description: 'Success',
model: Joi.object({
success: successRes,
id: Joi.string().required().description('ID of the Alias'),
alias: Joi.string().required().description('Alias domain'),
domain: Joi.string().required().description('Alias target'),
created: Joi.date().required().description('Datestring of the time the alias was created')
})
}
}
}
},
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)
});
}
// permissions check
req.validate(roles.can(req.role).readAny('domainaliases'));
let alias = new ObjectId(result.value.alias);
let aliasData;
try {
aliasData = await db.users.collection('domainaliases').findOne({
_id: alias
});
} catch (err) {
res.status(500);
return res.json({
error: 'MongoDB Error: ' + err.message,
code: 'InternalDatabaseError'
});
}
if (!aliasData) {
res.status(404);
return res.json({
error: 'Invalid or unknown alias',
code: 'AliasNotFound'
});
}
return res.json({
success: true,
id: aliasData._id.toString(),
alias: aliasData.alias,
domain: aliasData.domain,
created: aliasData.created
});
})
);
server.del(
{
path: '/domainaliases/:alias',
tags: ['DomainAliases'],
summary: 'Delete an Alias',
validationObjs: {
requestBody: {},
pathParams: { alias: Joi.string().hex().lowercase().length(24).required().description('ID of the Alias') },
queryParams: {
sess: sessSchema,
ip: sessIPSchema
},
response: { 200: { description: 'Success', model: Joi.object({ success: successRes }) } }
}
},
tools.responseWrapper(async (req, res) => {
res.charSet('utf-8');
const schema = Joi.object().keys({
alias: Joi.string().hex().lowercase().length(24).required(),
sess: sessSchema,
ip: sessIPSchema
});
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)
});
}
// permissions check
req.validate(roles.can(req.role).deleteAny('domainaliases'));
let alias = new ObjectId(result.value.alias);
let aliasData;
try {
aliasData = await db.users.collection('domainaliases').findOne(
{
_id: alias
},
{
projection: { _id: 1 }
}
);
} catch (err) {
res.status(500);
return res.json({
error: 'MongoDB Error: ' + err.message,
code: 'InternalDatabaseError'
});
}
if (!aliasData) {
res.status(404);
return res.json({
error: 'Invalid or unknown email alias identifier',
code: 'AliasNotFound'
});
}
let r;
try {
// delete address from email address registry
r = await db.users.collection('domainaliases').deleteOne({
_id: alias
});
} catch (err) {
res.status(500);
return res.json({
error: 'MongoDB Error: ' + err.message,
code: 'InternalDatabaseError'
});
}
if (r.deletedCount) {
await publish(db.redis, {
ev: DOMAINALIAS_DELETED,
domainalias: alias,
alias: aliasData.alias,
domain: aliasData.domain
});
}
return res.json({
success: !!r.deletedCount
});
})
);
};