${user.name} moved ` + + `${card.name} ` + + `from ${action.data.fromList.name} to ${action.data.toList.name} ` + + `on ${board.name}
`, + }; + + break; + case Action.Types.COMMENT_CARD: + emailData = { + subject: `${user.name} left a new comment to ${card.name} on ${board.name}`, + html: + `${user.name} left a new comment to ` + + `${card.name} ` + + `on ${board.name}
` + + `${action.data.text}
`, + }; + + break; + default: + return; + } + + await sails.helpers.utils.sendEmail.with({ + ...emailData, + to: notifiableUser.email, + }); +}; + module.exports = { inputs: { values: { @@ -21,6 +57,18 @@ module.exports = { custom: valuesValidator, required: true, }, + user: { + type: 'ref', + required: true, + }, + board: { + type: 'ref', + required: true, + }, + card: { + type: 'ref', + required: true, + }, }, async fn(inputs) { @@ -40,6 +88,17 @@ module.exports = { item: notification, }); + if (sails.hooks.smtp.isActive()) { + let notifiableUser; + if (values.user) { + notifiableUser = values.user; + } else { + notifiableUser = await sails.helpers.users.getOne(notification.userId); + } + + buildAndSendEmail(inputs.user, inputs.board, inputs.card, values.action, notifiableUser); + } + return notification; }, }; diff --git a/server/api/helpers/users/get-or-create-one-using-oidc.js b/server/api/helpers/users/get-or-create-one-using-oidc.js index 6d1c49f..2186c09 100644 --- a/server/api/helpers/users/get-or-create-one-using-oidc.js +++ b/server/api/helpers/users/get-or-create-one-using-oidc.js @@ -38,7 +38,10 @@ module.exports = { throw 'invalidCodeOrNonce'; } - if (!userInfo.email || !userInfo.name) { + if ( + !userInfo[sails.config.custom.oidcEmailAttribute] || + !userInfo[sails.config.custom.oidcNameAttribute] + ) { throw 'missingValues'; } @@ -56,12 +59,14 @@ module.exports = { const values = { isAdmin, - email: userInfo.email, + email: userInfo[sails.config.custom.oidcEmailAttribute], isSso: true, - name: userInfo.name, - username: userInfo.preferred_username, + name: userInfo[sails.config.custom.oidcNameAttribute], subscribeToOwnCards: false, }; + if (!sails.config.custom.oidcIgnoreUsername) { + values.username = userInfo[sails.config.custom.oidcUsernameAttribute]; + } let user; // This whole block technically needs to be executed in a transaction @@ -95,7 +100,10 @@ module.exports = { }); } - const updateFieldKeys = ['email', 'isSso', 'name', 'username']; + const updateFieldKeys = ['email', 'isSso', 'name']; + if (!sails.config.custom.oidcIgnoreUsername) { + updateFieldKeys.push('username'); + } if (!sails.config.custom.oidcIgnoreRoles) { updateFieldKeys.push('isAdmin'); } diff --git a/server/api/helpers/utils/send-email.js b/server/api/helpers/utils/send-email.js new file mode 100644 index 0000000..02593f8 --- /dev/null +++ b/server/api/helpers/utils/send-email.js @@ -0,0 +1,31 @@ +module.exports = { + inputs: { + to: { + type: 'string', + required: true, + }, + subject: { + type: 'string', + required: true, + }, + html: { + type: 'string', + required: true, + }, + }, + + async fn(inputs) { + const transporter = sails.hooks.smtp.getTransporter(); // TODO: check if active? + + try { + const info = await transporter.sendMail({ + ...inputs, + from: sails.config.custom.smtpFrom, + }); + + sails.log.info(`Email sent: ${info.messageId}`); + } catch (error) { + sails.log.error(`Error sending email: ${error}`); + } + }, +}; diff --git a/server/api/helpers/utils/send-slack-message.js b/server/api/helpers/utils/send-slack-message.js new file mode 100644 index 0000000..510ae1b --- /dev/null +++ b/server/api/helpers/utils/send-slack-message.js @@ -0,0 +1,53 @@ +const POST_MESSAGE_API_URL = 'https://slack.com/api/chat.postMessage'; + +module.exports = { + inputs: { + markdown: { + type: 'string', + required: true, + }, + }, + + async fn(inputs) { + const headers = { + Authorization: `Bearer ${sails.config.custom.slackBotToken}`, + 'Content-Type': 'application/json; charset=utf-8', + }; + + const body = { + blocks: [ + { + type: 'section', + text: { + type: 'mrkdwn', + text: inputs.markdown, + }, + }, + ], + channel: sails.config.custom.slackChannelId, + }; + + let response; + try { + response = await fetch(POST_MESSAGE_API_URL, { + headers, + method: 'POST', + body: JSON.stringify(body), + }); + } catch (error) { + sails.log.error(`Error sending to Slack: ${error}`); + return; + } + + if (!response.ok) { + sails.log.error(`Error sending to Slack: ${response.error}`); + return; + } + + const responseJson = await response.json(); + + if (!responseJson.ok) { + sails.log.error(`Error sending to Slack: ${responseJson.error}`); + } + }, +}; diff --git a/server/api/hooks/current-user/index.js b/server/api/hooks/current-user/index.js index dd29595..1d3214f 100644 --- a/server/api/hooks/current-user/index.js +++ b/server/api/hooks/current-user/index.js @@ -61,6 +61,7 @@ module.exports = function defineCurrentUserHook(sails) { }); if (req.isSocket) { + sails.sockets.join(req, `@accessToken:${accessToken}`); sails.sockets.join(req, `@user:${currentUser.id}`); } } diff --git a/server/api/hooks/oidc/index.js b/server/api/hooks/oidc/index.js index 05d9d0b..6dbeddd 100644 --- a/server/api/hooks/oidc/index.js +++ b/server/api/hooks/oidc/index.js @@ -1,6 +1,14 @@ const openidClient = require('openid-client'); -module.exports = function oidcServiceHook(sails) { +/** + * oidc hook + * + * @description :: A hook definition. Extends Sails by adding shadow routes, implicit actions, + * and/or initialization logic. + * @docs :: https://sailsjs.com/docs/concepts/extending-sails/hooks + */ + +module.exports = function defineOidcHook(sails) { let client = null; return { @@ -9,17 +17,20 @@ module.exports = function oidcServiceHook(sails) { */ async initialize() { - if (sails.config.custom.oidcIssuer) { - const issuer = await openidClient.Issuer.discover(sails.config.custom.oidcIssuer); - - client = new issuer.Client({ - client_id: sails.config.custom.oidcClientId, - client_secret: sails.config.custom.oidcClientSecret, - redirect_uris: [sails.config.custom.oidcRedirectUri], - response_types: ['code'], - }); - sails.log.info('OIDC hook has been loaded successfully'); + if (!sails.config.custom.oidcIssuer) { + return; } + + sails.log.info('Initializing custom hook (`oidc`)'); + + const issuer = await openidClient.Issuer.discover(sails.config.custom.oidcIssuer); + + client = new issuer.Client({ + client_id: sails.config.custom.oidcClientId, + client_secret: sails.config.custom.oidcClientSecret, + redirect_uris: [sails.config.custom.oidcRedirectUri], + response_types: ['code'], + }); }, getClient() { diff --git a/server/api/hooks/smtp/index.js b/server/api/hooks/smtp/index.js new file mode 100644 index 0000000..d6ce84f --- /dev/null +++ b/server/api/hooks/smtp/index.js @@ -0,0 +1,46 @@ +const nodemailer = require('nodemailer'); + +/** + * smtp hook + * + * @description :: A hook definition. Extends Sails by adding shadow routes, implicit actions, + * and/or initialization logic. + * @docs :: https://sailsjs.com/docs/concepts/extending-sails/hooks + */ + +module.exports = function defineSmtpHook(sails) { + let transporter = null; + + return { + /** + * Runs when this Sails app loads/lifts. + */ + + async initialize() { + if (!sails.config.custom.smtpHost) { + return; + } + + sails.log.info('Initializing custom hook (`smtp`)'); + + transporter = nodemailer.createTransport({ + pool: true, + host: sails.config.custom.smtpHost, + port: sails.config.custom.smtpPort, + secure: sails.config.custom.smtpSecure, + auth: sails.config.custom.smtpUser && { + user: sails.config.custom.smtpUser, + pass: sails.config.custom.smtpPassword, + }, + }); + }, + + getTransporter() { + return transporter; + }, + + isActive() { + return transporter !== null; + }, + }; +}; diff --git a/server/api/hooks/watcher/index.js b/server/api/hooks/watcher/index.js new file mode 100644 index 0000000..835b1e8 --- /dev/null +++ b/server/api/hooks/watcher/index.js @@ -0,0 +1,38 @@ +/** + * watcher hook + * + * @description :: A hook definition. Extends Sails by adding shadow routes, implicit actions, + * and/or initialization logic. + * @docs :: https://sailsjs.com/docs/concepts/extending-sails/hooks + */ + +module.exports = function defineWatcherHook(sails) { + const checkSocketConnectionsToLogout = () => { + Object.keys(sails.io.sockets.adapter.rooms).forEach((room) => { + if (!room.startsWith('@accessToken:')) { + return; + } + + const accessToken = room.split(':')[1]; + + try { + sails.helpers.utils.verifyToken(accessToken); + } catch (error) { + sails.sockets.broadcast(room, 'logout'); + sails.sockets.leaveAll(room); + } + }); + }; + + return { + /** + * Runs when this Sails app loads/lifts. + */ + + async initialize() { + sails.log.info('Initializing custom hook (`watcher`)'); + + setInterval(checkSocketConnectionsToLogout, 60 * 1000); + }, + }; +}; diff --git a/server/api/models/User.js b/server/api/models/User.js index 9bf8a29..1d87531 100755 --- a/server/api/models/User.js +++ b/server/api/models/User.js @@ -116,6 +116,7 @@ module.exports = { ..._.omit(this, ['password', 'isSso', 'avatar', 'passwordChangedAt']), isLocked: this.isSso || isDefaultAdmin, isRoleLocked: (this.isSso && !sails.config.custom.oidcIgnoreRoles) || isDefaultAdmin, + isUsernameLocked: (this.isSso && !sails.config.custom.oidcIgnoreUsername) || isDefaultAdmin, isDeletionLocked: isDefaultAdmin, avatarUrl: this.avatar && diff --git a/server/config/custom.js b/server/config/custom.js index cbbc89b..ac344d0 100644 --- a/server/config/custom.js +++ b/server/config/custom.js @@ -31,18 +31,34 @@ module.exports.custom = { attachmentsPath: path.join(sails.config.appPath, 'private', 'attachments'), attachmentsUrl: `${process.env.BASE_URL}/attachments`, - defaultAdminEmail: process.env.DEFAULT_ADMIN_EMAIL, + defaultAdminEmail: + process.env.DEFAULT_ADMIN_EMAIL && process.env.DEFAULT_ADMIN_EMAIL.toLowerCase(), oidcIssuer: process.env.OIDC_ISSUER, oidcClientId: process.env.OIDC_CLIENT_ID, oidcClientSecret: process.env.OIDC_CLIENT_SECRET, oidcScopes: process.env.OIDC_SCOPES || 'openid email profile', oidcAdminRoles: process.env.OIDC_ADMIN_ROLES ? process.env.OIDC_ADMIN_ROLES.split(',') : [], + oidcEmailAttribute: process.env.OIDC_EMAIL_ATTRIBUTE || 'email', + oidcNameAttribute: process.env.OIDC_NAME_ATTRIBUTE || 'name', + oidcUsernameAttribute: process.env.OIDC_USERNAME_ATTRIBUTE || 'preferred_username', oidcRolesAttribute: process.env.OIDC_ROLES_ATTRIBUTE || 'groups', + oidcIgnoreUsername: process.env.OIDC_IGNORE_USERNAME === 'true', oidcIgnoreRoles: process.env.OIDC_IGNORE_ROLES === 'true', + oidcEnforced: process.env.OIDC_ENFORCED === 'true', // TODO: move client base url to environment variable? oidcRedirectUri: `${ sails.config.environment === 'production' ? process.env.BASE_URL : 'http://localhost:3000' }/oidc-callback`, + + smtpHost: process.env.SMTP_HOST, + smtpPort: process.env.SMTP_PORT || 587, + smtpSecure: process.env.SMTP_SECURE === 'true', + smtpUser: process.env.SMTP_USER, + smtpPassword: process.env.SMTP_PASSWORD, + smtpFrom: process.env.SMTP_FROM, + + slackBotToken: process.env.SLACK_BOT_TOKEN, + slackChannelId: process.env.SLACK_CHANNEL_ID, }; diff --git a/server/config/routes.js b/server/config/routes.js index 77f5c43..8b88df5 100644 --- a/server/config/routes.js +++ b/server/config/routes.js @@ -55,6 +55,7 @@ module.exports.routes = { 'POST /api/lists/:listId/cards': 'cards/create', 'GET /api/cards/:id': 'cards/show', 'PATCH /api/cards/:id': 'cards/update', + 'POST /api/cards/:id/duplicate': 'cards/duplicate', 'DELETE /api/cards/:id': 'cards/delete', 'POST /api/cards/:cardId/memberships': 'card-memberships/create', 'DELETE /api/cards/:cardId/memberships': 'card-memberships/delete', diff --git a/server/db/seeds/default.js b/server/db/seeds/default.js index 137cf56..19c2e53 100644 --- a/server/db/seeds/default.js +++ b/server/db/seeds/default.js @@ -13,7 +13,7 @@ const buildData = () => { data.name = process.env.DEFAULT_ADMIN_NAME; } if (process.env.DEFAULT_ADMIN_USERNAME) { - data.username = process.env.DEFAULT_ADMIN_USERNAME; + data.username = process.env.DEFAULT_ADMIN_USERNAME.toLowerCase(); } return data; @@ -24,16 +24,17 @@ exports.seed = async (knex) => { return; } + const email = process.env.DEFAULT_ADMIN_EMAIL.toLowerCase(); const data = buildData(); try { await knex('user_account').insert({ ...data, - email: process.env.DEFAULT_ADMIN_EMAIL, + email, subscribeToOwnCards: false, createdAt: new Date().toISOString(), }); } catch (error) { - await knex('user_account').update(data).where('email', process.env.DEFAULT_ADMIN_EMAIL); + await knex('user_account').update(data).where('email', email); } }; diff --git a/server/package-lock.json b/server/package-lock.json index 05527a7..93453a8 100644 --- a/server/package-lock.json +++ b/server/package-lock.json @@ -15,6 +15,7 @@ "lodash": "^4.17.21", "moment": "^2.29.4", "move-file": "^2.1.0", + "nodemailer": "^6.9.12", "openid-client": "^5.6.1", "rimraf": "^5.0.5", "sails": "^1.5.7", @@ -5257,6 +5258,14 @@ } } }, + "node_modules/nodemailer": { + "version": "6.9.12", + "resolved": "https://registry.npmjs.org/nodemailer/-/nodemailer-6.9.12.tgz", + "integrity": "sha512-pnLo7g37Br3jXbF0bl5DekBJihm2q+3bB3l2o/B060sWmb5l+VqeScAQCBqaQ+5ezRZFzW5SciZNGdRDEbq89w==", + "engines": { + "node": ">=6.0.0" + } + }, "node_modules/nodemon": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/nodemon/-/nodemon-3.0.1.tgz", @@ -12852,6 +12861,11 @@ "whatwg-url": "^5.0.0" } }, + "nodemailer": { + "version": "6.9.12", + "resolved": "https://registry.npmjs.org/nodemailer/-/nodemailer-6.9.12.tgz", + "integrity": "sha512-pnLo7g37Br3jXbF0bl5DekBJihm2q+3bB3l2o/B060sWmb5l+VqeScAQCBqaQ+5ezRZFzW5SciZNGdRDEbq89w==" + }, "nodemon": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/nodemon/-/nodemon-3.0.1.tgz", diff --git a/server/package.json b/server/package.json index 59bb2f7..67fc5e0 100644 --- a/server/package.json +++ b/server/package.json @@ -36,6 +36,7 @@ "lodash": "^4.17.21", "moment": "^2.29.4", "move-file": "^2.1.0", + "nodemailer": "^6.9.12", "openid-client": "^5.6.1", "rimraf": "^5.0.5", "sails": "^1.5.7", diff --git a/start.sh b/start.sh index 5e10d63..440950c 100755 --- a/start.sh +++ b/start.sh @@ -1,4 +1,2 @@ #!/bin/bash -set -e -node db/init.js -exec node app.js --prod $@ +export NODE_ENV=production && set -e && node db/init.js && node app.js --prod