Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-02-03 23:00:14 -05:00
Code Issues Activity

🏗Added host config limits for member emails (#11439)

Browse source 
no issue

Introduces host limits config for allowing email limits with members.
This commit is contained in:
Rishabh Garg 2019-12-17 19:24:27 +05:30 • committed by GitHub
parent 169daead1f
commit 160ef2976a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 65 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

98
core/server/api/canary/posts.js
View file

@ -2,8 +2,11 @@ const models = require('../../models');
const common = require('../../lib/common');
const urlUtils = require('../../lib/url-utils');
const {mega} = require('../../services/mega');
const membersService = require('../../services/members');
const allowedIncludes = ['tags', 'authors', 'authors.roles', 'email'];
const unsafeAttrs = ['status', 'authors', 'visibility'];
const _ = require('lodash');
const config = require('../../config');
module.exports = {
docName: 'posts',
@ -142,50 +145,63 @@ module.exports = {
permissions: {
unsafeAttrs: unsafeAttrs
},
query(frame) {
return models.Post.edit(frame.data.posts[0], frame.options)
.then(async (model) => {
if (!model.get('send_email_when_published')) {
return model;
}
const postPublished = model.wasChanged() && (model.get('status') === 'published') && (model.previous('status') !== 'published');
if (postPublished) {
let postEmail = model.relations.email;
if (!postEmail) {
const email = await mega.addEmail(model, frame.options);
model.set('email', email);
} else if (postEmail && postEmail.get('status') === 'failed') {
const email = await mega.retryFailedEmail(postEmail);
model.set('email', email);
async query(frame) {
/**Check host limits for members when send email is true*/
const membersHostLimit = config.get('host_settings:limits:members');
if (frame.options.send_email_when_published && membersHostLimit) {
const allowedMembersLimit = membersHostLimit.max;
const hostUpgradeLink = config.get('host_settings:limits').upgrade_url;
const knexOptions = _.pick(frame.options, ['transacting', 'forUpdate']);
const {members} = await membersService.api.members.list(Object.assign(knexOptions, {filter: 'subscribed:true'}, {limit: 'all'}));
if (members.length > allowedMembersLimit) {
throw new common.errors.HostLimitError({
message: `Your current plan allows you to send email to up to ${allowedMembersLimit} members, but you currently have ${members.length} members`,
help: hostUpgradeLink,
errorDetails: {
limit: allowedMembersLimit,
total: members.length
}
}
});
}
}
return model;
})
.then((model) => {
if (
model.get('status') === 'published' && model.wasChanged() ||
model.get('status') === 'draft' && model.previous('status') === 'published'
) {
this.headers.cacheInvalidate = true;
} else if (
model.get('status') === 'draft' && model.previous('status') !== 'published' ||
model.get('status') === 'scheduled' && model.wasChanged()
) {
this.headers.cacheInvalidate = {
value: urlUtils.urlFor({
relativeUrl: urlUtils.urlJoin('/p', model.get('uuid'), '/')
})
};
} else {
this.headers.cacheInvalidate = false;
}
let model = await models.Post.edit(frame.data.posts[0], frame.options);
return model;
});
/**Handle newsletter email */
if (model.get('send_email_when_published')) {
const postPublished = model.wasChanged() && (model.get('status') === 'published') && (model.previous('status') !== 'published');
if (postPublished) {
let postEmail = model.relations.email;
if (!postEmail) {
const email = await mega.addEmail(model, frame.options);
model.set('email', email);
} else if (postEmail && postEmail.get('status') === 'failed') {
const email = await mega.retryFailedEmail(postEmail);
model.set('email', email);
}
}
}
/**Handle cache invalidation */
if (
model.get('status') === 'published' && model.wasChanged() ||
model.get('status') === 'draft' && model.previous('status') === 'published'
) {
this.headers.cacheInvalidate = true;
} else if (
model.get('status') === 'draft' && model.previous('status') !== 'published' ||
model.get('status') === 'scheduled' && model.wasChanged()
) {
this.headers.cacheInvalidate = {
value: urlUtils.urlFor({
relativeUrl: urlUtils.urlJoin('/p', model.get('uuid'), '/')
})
};
} else {
this.headers.cacheInvalidate = false;
}
return model;
}
},

7
core/server/lib/common/errors.js
View file

@ -55,6 +55,13 @@ const ghostErrors = {
errorType: 'UpdateCollisionError'
}, options));
},
HostLimitError: function HostLimitError(options) {
GhostError.call(this, merge({
errorType: 'HostLimitError',
hideStack: true,
statusCode: 403
}, options));
},
HelperWarning: function HelperWarning(options) {
GhostError.call(this, merge({
errorType: 'HelperWarning',

1
core/server/translations/en.json
View file

@ -464,6 +464,7 @@
"DatabaseVersionError": "Database version compatibility error, cannot {action}.",
"EmailError": "Error sending email!",
"ThemeValidationError": "Theme validation error, cannot {action}.",
"HostLimitError": "Host Limit error, cannot {action}.",
"DisabledFeatureError": "Theme validation error, the {{{helperName}}} helper is not available. Cannot {action}.",
"UpdateCollisionError": "Saving failed! Someone else is editing this post."
}