mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-30 14:22:07 +03:00
322664a145
refs https://github.com/TryGhost/Team/issues/581 refs https://github.com/TryGhost/Team/issues/582 When publishing a post via the API it was possible to send it using `?email_recipient_filter=all/free/paid` which allowed you to send to members only based on their payment status which is quite limiting for some sites. This PR updates the `?email_recipient_filter` query param to support Ghost's `?filter` param syntax which enables more specific recipient lists, eg: `?email_recipient_filter=status:free` = free members only `?email_recipient_filter=status:paid` = paid members only `?email_recipient_filter=label:vip` = members that have the `vip` label attached `?email_recipient_filter=status:paid,label:vip` = paid members and members that have the `vip` label attached The older `free/paid` values are still supported by the API for backwards compatibility. - updates `Post` and `Email` models to transform legacy `free` and `paid` values to their NQL equivalents on read/write - lets us not worry about supporting legacy values elsewhere in the code - cleanup migration to transform all rows slated for 5.0 - removes schema and API `isIn` validations for recipient filters so allow free-form filters - updates posts API input serializers to transform `free` and `paid` values in the `?email_recipient_filter` param to their NQL equivalents for backwards compatibility - updates Post API controllers `edit` methods to run a query using the supplied filter to verify that it's valid - updates `mega` service to use the filter directly when selecting recipients
93 lines
2.4 KiB
JavaScript
93 lines
2.4 KiB
JavaScript
const uuid = require('uuid');
|
|
const ghostBookshelf = require('./base');
|
|
|
|
const Email = ghostBookshelf.Model.extend({
|
|
tableName: 'emails',
|
|
|
|
defaults: function defaults() {
|
|
return {
|
|
uuid: uuid.v4(),
|
|
status: 'pending',
|
|
recipient_filter: 'status:-free',
|
|
track_opens: false,
|
|
delivered_count: 0,
|
|
opened_count: 0,
|
|
failed_count: 0
|
|
};
|
|
},
|
|
|
|
parse() {
|
|
const attrs = ghostBookshelf.Model.prototype.parse.apply(this, arguments);
|
|
|
|
// update legacy recipient_filter values to proper NQL
|
|
if (attrs.recipient_filter === 'free') {
|
|
attrs.recipient_filter = 'status:free';
|
|
}
|
|
if (attrs.recipient_filter === 'paid') {
|
|
attrs.recipient_filter = 'status:-free';
|
|
}
|
|
|
|
return attrs;
|
|
},
|
|
|
|
formatOnWrite(attrs) {
|
|
// update legacy recipient_filter values to proper NQL
|
|
if (attrs.recipient_filter === 'free') {
|
|
attrs.recipient_filter = 'status:free';
|
|
}
|
|
if (attrs.recipient_filter === 'paid') {
|
|
attrs.recipient_filter = 'status:-free';
|
|
}
|
|
|
|
return attrs;
|
|
},
|
|
|
|
post() {
|
|
return this.belongsTo('Post', 'post_id');
|
|
},
|
|
|
|
emailBatches() {
|
|
return this.hasMany('EmailBatch', 'email_id');
|
|
},
|
|
|
|
recipients() {
|
|
return this.hasMany('EmailRecipient', 'email_id');
|
|
},
|
|
|
|
emitChange: function emitChange(event, options) {
|
|
const eventToTrigger = 'email' + '.' + event;
|
|
ghostBookshelf.Model.prototype.emitChange.bind(this)(this, eventToTrigger, options);
|
|
},
|
|
|
|
onCreated: function onCreated(model, attrs, options) {
|
|
ghostBookshelf.Model.prototype.onCreated.apply(this, arguments);
|
|
|
|
model.emitChange('added', options);
|
|
},
|
|
|
|
onUpdated: function onUpdated(model, attrs, options) {
|
|
ghostBookshelf.Model.prototype.onUpdated.apply(this, arguments);
|
|
|
|
model.emitChange('edited', options);
|
|
},
|
|
|
|
onDestroyed: function onDestroyed(model, options) {
|
|
ghostBookshelf.Model.prototype.onDestroyed.apply(this, arguments);
|
|
|
|
model.emitChange('deleted', options);
|
|
}
|
|
}, {
|
|
post() {
|
|
return this.belongsTo('Post');
|
|
}
|
|
});
|
|
|
|
const Emails = ghostBookshelf.Collection.extend({
|
|
model: Email
|
|
});
|
|
|
|
module.exports = {
|
|
Email: ghostBookshelf.model('Email', Email),
|
|
Emails: ghostBookshelf.collection('Emails', Emails)
|
|
};
|