public/mailtrain
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Release candidate of the selectable unsubscription

Browse source 
Implemented the resubscription process - i.e. pre-filling in the form when the subscription link is clicked in the unsubscription notice.
This commit is contained in:
Tomas Bures 2017-05-04 17:42:46 -04:00
parent bd4961366f
commit a6d25e668b
12 changed files with 238 additions and 194 deletions
Download patch file Download diff file Expand all files Collapse all files

2
languages/de_DE.po
View file

@ -4030,7 +4030,7 @@ msgstr ""
"Bestätigung" "Bestätigung"
#: routes/subscription.js:730 #: routes/subscription.js:730
msgid "%s: Unsubscribe Confirmed" msgid "%s: Unsubscription Confirmed"
msgstr "%s: Abmeldungen Bestätigt" msgstr "%s: Abmeldungen Bestätigt"
#: routes/subscription.js:777 routes/subscription.js:793 #: routes/subscription.js:777 routes/subscription.js:793

2
lib/helpers.js
View file

@ -98,7 +98,7 @@ function filterCustomFields(customFieldsIn = [], fieldIds = [], method = 'includ
id: 'email', id: 'email',
name: 'Email Address', name: 'Email Address',
type: 'Email', type: 'Email',
typeSubsciptionEmail: true typeSubscriptionEmail: true
}, { }, {
id: 'firstname', id: 'firstname',
name: 'First Name', name: 'First Name',

16
lib/models/campaigns.js
View file

@ -1054,13 +1054,13 @@ module.exports.updateMessage = (message, status, updateSubscription, callback) =
let statusCode; let statusCode;
if (status === 'unsubscribed') { if (status === 'unsubscribed') {
statusCode = 2; statusCode = subscriptions.Status.UNSUBSCRIBED;
} } else if (status === 'bounced') {
if (status === 'bounced') { statusCode = subscriptions.Status.BOUNCED;
statusCode = 3; } else if (status === 'complained') {
} statusCode = subscriptions.Status.COMPLAINED;
if (status === 'complained') { } else {
statusCode = 4; return callback(new Error(_('Unrecognized message status')));
} }
let query = 'UPDATE `campaigns` SET `' + status + '`=`' + status + '`+1 WHERE id=? LIMIT 1'; let query = 'UPDATE `campaigns` SET `' + status + '`=`' + status + '`+1 WHERE id=? LIMIT 1';
@ -1074,7 +1074,7 @@ module.exports.updateMessage = (message, status, updateSubscription, callback) =
} }
if (updateSubscription) { if (updateSubscription) {
subscriptions.changeStatus(message.list, message.subscription, statusCode === 2 ? message.campaign : false, statusCode, callback); subscriptions.changeStatus(message.list, message.subscription, statusCode === subscriptions.Status.UNSUBSCRIBED ? message.campaign : false, statusCode, callback);
} else { } else {
return callback(null, true); return callback(null, true);
} }

4
lib/models/confirmations.js
View file

@ -16,14 +16,14 @@ module.exports.addConfirmation = (listId, action, ip, data, callback) => {
} }
let query = 'INSERT INTO confirmations (cid, list, action, ip, data) VALUES (?,?,?,?,?)'; let query = 'INSERT INTO confirmations (cid, list, action, ip, data) VALUES (?,?,?,?,?)';
connection.query(query, [cid, list, action, ip, JSON.stringify(data || {})], (err, result) => { connection.query(query, [cid, listId, action, ip, JSON.stringify(data || {})], (err, result) => {
connection.release(); connection.release();
if (err) { if (err) {
return callback(err); return callback(err);
} }
if (!result || !result.affectedRows) { if (!result || !result.affectedRows) {
return callback(null, false); return callback(new Error(_('Could not store confirmation data')));
} }
return callback(null, cid); return callback(null, cid);

3
lib/models/reports.js
View file

@ -13,7 +13,8 @@ const ReportState = {
SCHEDULED: 0, SCHEDULED: 0,
PROCESSING: 1, PROCESSING: 1,
FINISHED: 2, FINISHED: 2,
FAILED: 3 FAILED: 3,
MAX: 4
}; };
module.exports.ReportState = ReportState; module.exports.ReportState = ReportState;

2
lib/models/settings.js
View file

@ -15,6 +15,8 @@ function listValues(filter, callback) {
filter = false; filter = false;
} }
// TODO: It would be good to cache the settings. It feels awkward to always go to DB to retrieve something what is essentially a constant
filter = [].concat(filter || []).map(key => tools.toDbKey(key)); filter = [].concat(filter || []).map(key => tools.toDbKey(key));
db.getConnection((err, connection) => { db.getConnection((err, connection) => {

51
lib/models/subscriptions.js
View file

@ -12,6 +12,16 @@ let _ = require('../translate')._;
let util = require('util'); let util = require('util');
let tableHelpers = require('../table-helpers'); let tableHelpers = require('../table-helpers');
const Status = {
SUBSCRIBED: 1,
UNSUBSCRIBED: 2,
BOUNCED: 3,
COMPLAINED: 4,
MAX: 5
};
module.exports.Status = Status;
module.exports.list = (listId, start, limit, callback) => { module.exports.list = (listId, start, limit, callback) => {
listId = Number(listId) || 0; listId = Number(listId) || 0;
if (!listId) { if (!listId) {
@ -152,19 +162,19 @@ module.exports.insert = (listId, meta, subscriptionData, callback) => {
let entryId = existing ? existing.id : false; let entryId = existing ? existing.id : false;
meta.cid = existing ? rows[0].cid : meta.cid; meta.cid = existing ? rows[0].cid : meta.cid;
meta.status = meta.status || (existing ? existing.status : 1); meta.status = meta.status || (existing ? existing.status : Status.SUBSCRIBED);
let statusChange = !existing || existing.status !== meta.status; let statusChange = !existing || existing.status !== meta.status;
let statusDirection; let statusDirection;
if (existing && !meta.partial) { if (existing && existing.status === Status.SUBSCRIBED && !meta.partial) {
return helpers.rollbackAndReleaseConnection(connection, new Error(_('Email address already registered')), callback); return helpers.rollbackAndReleaseConnection(connection, () => callback(new Error(_('Email address already registered'))));
} }
if (statusChange) { if (statusChange) {
keys.push('status', 'status_change'); keys.push('status', 'status_change');
values.push(meta.status, new Date()); values.push(meta.status, new Date());
statusDirection = !existing ? (meta.status === 1 ? '+' : false) : (existing.status === 1 ? '-' : '+'); statusDirection = !existing ? (meta.status === Status.SUBSCRIBED ? '+' : false) : (existing.status === Status.SUBSCRIBED ? '-' : '+');
} }
if (!keys.length) { if (!keys.length) {
@ -458,8 +468,8 @@ module.exports.changeStatus = (listId, id, campaignId, status, callback) => {
return helpers.rollbackAndReleaseConnection(connection, () => callback(null, true)); return helpers.rollbackAndReleaseConnection(connection, () => callback(null, true));
} }
if (statusChange && oldStatus === 1 || status === 1) { if (statusChange && oldStatus === Status.SUBSCRIBED || status === Status.SUBSCRIBED) {
statusDirection = status === 1 ? '+' : '-'; statusDirection = status === Status.SUBSCRIBED ? '+' : '-';
} }
connection.query('UPDATE `subscription__' + listId + '` SET `status`=?, `status_change`=NOW() WHERE id=? LIMIT 1', [status, id], err => { connection.query('UPDATE `subscription__' + listId + '` SET `status`=?, `status_change`=NOW() WHERE id=? LIMIT 1', [status, id], err => {
@ -483,7 +493,7 @@ module.exports.changeStatus = (listId, id, campaignId, status, callback) => {
} }
// status change is not related to a campaign or it marks message as bounced etc. // status change is not related to a campaign or it marks message as bounced etc.
if (!campaignId || status > 2) { if (!campaignId || status !== Status.SUBSCRIBED) {
return connection.commit(err => { return connection.commit(err => {
if (err) { if (err) {
return helpers.rollbackAndReleaseConnection(connection, () => callback(err)); return helpers.rollbackAndReleaseConnection(connection, () => callback(err));
@ -512,7 +522,7 @@ module.exports.changeStatus = (listId, id, campaignId, status, callback) => {
} }
// we should see only unsubscribe events here but you never know // we should see only unsubscribe events here but you never know
connection.query('UPDATE `campaigns` SET `unsubscribed`=`unsubscribed`' + (status === 2 ? '+' : '-') + '1 WHERE `cid`=? LIMIT 1', [campaignId], err => { connection.query('UPDATE `campaigns` SET `unsubscribed`=`unsubscribed`' + (status === Status.UNSUBSCRIBED ? '+' : '-') + '1 WHERE `cid`=? LIMIT 1', [campaignId], err => {
if (err) { if (err) {
return helpers.rollbackAndReleaseConnection(connection, () => callback(err)); return helpers.rollbackAndReleaseConnection(connection, () => callback(err));
} }
@ -583,7 +593,7 @@ module.exports.delete = (listId, cid, callback) => {
return helpers.rollbackAndReleaseConnection(connection, () => callback(err)); return helpers.rollbackAndReleaseConnection(connection, () => callback(err));
} }
if (subscription.status !== 1) { if (subscription.status !== Status.SUBSCRIBED) {
return connection.commit(err => { return connection.commit(err => {
if (err) { if (err) {
return helpers.rollbackAndReleaseConnection(connection, () => callback(err)); return helpers.rollbackAndReleaseConnection(connection, () => callback(err));
@ -679,11 +689,10 @@ module.exports.updateImport = (listId, importId, data, callback) => {
connection.release(); connection.release();
return callback(null, affected); return callback(null, affected);
}); });
return; } else {
connection.release();
return callback(null, affected);
} }
connection.release();
return callback(null, affected);
}); });
}); });
}; };
@ -816,7 +825,7 @@ module.exports.updateAddressCheck = (list, cid, emailNew, ip, callback) => {
return callback(err); return callback(err);
} }
let query = 'SELECT * FROM `subscription__' + list.id + '` WHERE `cid`=? LIMIT 1'; let query = 'SELECT * FROM `subscription__' + list.id + '` WHERE `cid`=? AND `status`=' + Status.SUBSCRIBED + ' LIMIT 1';
let args = [cid]; let args = [cid];
connection.query(query, args, (err, rows) => { connection.query(query, args, (err, rows) => {
if (err) { if (err) {
@ -835,7 +844,7 @@ module.exports.updateAddressCheck = (list, cid, emailNew, ip, callback) => {
let old = rows[0]; let old = rows[0];
let query = 'SELECT `id` FROM `subscription__' + list.id + '` WHERE `email`=? AND `cid`<>? AND `status`=1 LIMIT 1'; let query = 'SELECT `id` FROM `subscription__' + list.id + '` WHERE `email`=? AND `cid`<>? AND `status`=' + Status.SUBSCRIBED + ' LIMIT 1';
let args = [emailNew, cid]; let args = [emailNew, cid];
connection.query(query, args, (err, rows) => { connection.query(query, args, (err, rows) => {
connection.release(); connection.release();
@ -870,7 +879,7 @@ module.exports.updateAddress = (listId, subscriptionId, emailNew, callback) => {
return callback(err); return callback(err);
} }
let query = 'SELECT `id` FROM `subscription__' + listId + '` WHERE `email`=? AND `id`<>? AND `status`=1 LIMIT 1'; let query = 'SELECT `id` FROM `subscription__' + listId + '` WHERE `email`=? AND `id`<>? AND `status`=' + Status.SUBSCRIBED + ' LIMIT 1';
let args = [emailNew, subscriptionId]; let args = [emailNew, subscriptionId];
connection.query(query, args, (err, rows) => { connection.query(query, args, (err, rows) => {
if (err) { if (err) {
@ -878,7 +887,7 @@ module.exports.updateAddress = (listId, subscriptionId, emailNew, callback) => {
} }
if (rows && rows.length > 0) { if (rows && rows.length > 0) {
return helpers.rollbackAndReleaseConnection(connection, new Error(_('Email address already registered')), callback); return helpers.rollbackAndReleaseConnection(connection, () => callback(new Error(_('Email address already registered'))));
} }
let query = 'DELETE FROM `subscription__' + listId + '` WHERE `email`=? AND `id`<>?'; let query = 'DELETE FROM `subscription__' + listId + '` WHERE `email`=? AND `id`<>?';
@ -888,13 +897,17 @@ module.exports.updateAddress = (listId, subscriptionId, emailNew, callback) => {
return helpers.rollbackAndReleaseConnection(connection, () => callback(err)); return helpers.rollbackAndReleaseConnection(connection, () => callback(err));
} }
let query = 'UPDATE `subscription__' + listId + '` SET `email`=? WHERE `id`=? LIMIT 1'; let query = 'UPDATE `subscription__' + listId + '` SET `email`=? WHERE `id`=? AND `status`=' + Status.SUBSCRIBED + ' LIMIT 1';
let args = [emailNew, subscriptionId]; let args = [emailNew, subscriptionId];
connection.query(query, args, err => { connection.query(query, args, (err, result) => {
if (err) { if (err) {
return helpers.rollbackAndReleaseConnection(connection, () => callback(err)); return helpers.rollbackAndReleaseConnection(connection, () => callback(err));
} }
if (!result || !result.affectedRows) {
return helpers.rollbackAndReleaseConnection(connection, () => callback(new Error(_('Subscription not found in this list'))));
}
return connection.commit(err => { return connection.commit(err => {
if (err) { if (err) {
return helpers.rollbackAndReleaseConnection(connection, () => callback(err)); return helpers.rollbackAndReleaseConnection(connection, () => callback(err));

135
lib/subscription-mail-helpers.js
View file

@ -2,7 +2,6 @@
const log = require('npmlog'); const log = require('npmlog');
const config = require('config'); const config = require('config');
let db = require('./db');
let fields = require('./models/fields'); let fields = require('./models/fields');
let settings = require('./models/settings'); let settings = require('./models/settings');
let mailer = require('./mailer'); let mailer = require('./mailer');
@ -28,7 +27,7 @@ function sendSubscriptionConfirmed(list, email, subscription, callback) {
unsubscribeUrl: '/subscription/' + list.cid + '/unsubscribe/' + subscription.cid unsubscribeUrl: '/subscription/' + list.cid + '/unsubscribe/' + subscription.cid
}; };
subscriptions.sendMail(list, email, 'subscription-confirmed', _('%s: Subscription Confirmed'), relativeUrls, {}, data.subscriptionData, callback); sendMail(list, email, 'subscription-confirmed', _('%s: Subscription Confirmed'), relativeUrls, {}, subscription, callback);
} }
function sendAlreadySubscribed(list, email, subscription, callback) { function sendAlreadySubscribed(list, email, subscription, callback) {
@ -39,7 +38,7 @@ function sendAlreadySubscribed(list, email, subscription, callback) {
preferencesUrl: '/subscription/' + list.cid + '/manage/' + subscription.cid, preferencesUrl: '/subscription/' + list.cid + '/manage/' + subscription.cid,
unsubscribeUrl: '/subscription/' + list.cid + '/unsubscribe/' + subscription.cid unsubscribeUrl: '/subscription/' + list.cid + '/unsubscribe/' + subscription.cid
}; };
module.exports.sendMail(list, email, 'already-subscribed', _('%s: Email Address Already Registered'), relativeUrls, mailOpts, subscription, callback); sendMail(list, email, 'already-subscribed', _('%s: Email Address Already Registered'), relativeUrls, mailOpts, subscription, callback);
} }
function sendConfirmAddressChange(list, email, cid, subscription, callback) { function sendConfirmAddressChange(list, email, cid, subscription, callback) {
@ -49,7 +48,7 @@ function sendConfirmAddressChange(list, email, cid, subscription, callback) {
const relativeUrls = { const relativeUrls = {
confirmUrl: '/subscription/confirm/' + cid confirmUrl: '/subscription/confirm/' + cid
}; };
module.exports.sendMail(list, email, 'confirm-address-change', _('%s: Please Confirm Email Change in Subscription'), relativeUrls, mailOpts, subscription, callback); sendMail(list, email, 'confirm-address-change', _('%s: Please Confirm Email Change in Subscription'), relativeUrls, mailOpts, subscription, callback);
} }
function sendConfirmSubscription(list, email, cid, subscription, callback) { function sendConfirmSubscription(list, email, cid, subscription, callback) {
@ -59,7 +58,7 @@ function sendConfirmSubscription(list, email, cid, subscription, callback) {
const relativeUrls = { const relativeUrls = {
confirmUrl: '/subscription/confirm/' + cid confirmUrl: '/subscription/confirm/' + cid
}; };
module.exports.sendMail(list, email, 'confirm-subscription', _('%s: Please Confirm Subscription'), relativeUrls, mailOpts, subscription, callback); sendMail(list, email, 'confirm-subscription', _('%s: Please Confirm Subscription'), relativeUrls, mailOpts, subscription, callback);
} }
function sendConfirmUnsubscription(list, email, cid, subscription, callback) { function sendConfirmUnsubscription(list, email, cid, subscription, callback) {
@ -69,98 +68,92 @@ function sendConfirmUnsubscription(list, email, cid, subscription, callback) {
const relativeUrls = { const relativeUrls = {
confirmUrl: '/subscription/confirm/' + cid confirmUrl: '/subscription/confirm/' + cid
}; };
module.exports.sendMail(list, email, 'confirm-unsubscription', _('%s: Please Confirm Unsubscription'), relativeUrls, mailOpts, subscription, callback); sendMail(list, email, 'confirm-unsubscription', _('%s: Please Confirm Unsubscription'), relativeUrls, mailOpts, subscription, callback);
} }
function sendUnsubscriptionConfirmed(list, email, subscription, callback) { function sendUnsubscriptionConfirmed(list, email, subscription, callback) {
const relativeUrls = { const relativeUrls = {
subscribeUrl: '/subscription/' + list.cid + '?cid=' + subscription.cid subscribeUrl: '/subscription/' + list.cid + '?cid=' + subscription.cid
}; };
subscriptions.sendMail(list, email, 'unsubscription-confirmed', _('%s: Unsubscribe Confirmed'), relativeUrls, {}, subscription, callback); sendMail(list, email, 'unsubscription-confirmed', _('%s: Unsubscription Confirmed'), relativeUrls, {}, subscription, callback);
} }
function sendMail(list, email, template, subject, relativeUrls, mailOpts, subscription, callback) { function sendMail(list, email, template, subject, relativeUrls, mailOpts, subscription, callback) {
db.getConnection((err, connection) => { fields.list(list.id, (err, fieldList) => {
if (err) { if (err) {
return callback(err); return callback(err);
} }
fields.list(list.id, (err, fieldList) => { let encryptionKeys = [];
fields.getRow(fieldList, subscription).forEach(field => {
if (field.type === 'gpg' && field.value) {
encryptionKeys.push(field.value.trim());
}
});
settings.list(['defaultHomepage', 'defaultFrom', 'defaultAddress', 'defaultPostaddress', 'serviceUrl', 'disableConfirmations'], (err, configItems) => {
if (err) { if (err) {
return callback(err); return callback(err);
} }
let encryptionKeys = []; if (!mailOpts.ignoreDisableConfirmations && configItems.disableConfirmations) {
fields.getRow(fieldList, subscription).forEach(field => { return;
if (field.type === 'gpg' && field.value) { }
encryptionKeys.push(field.value.trim());
}
});
settings.list(['defaultHomepage', 'defaultFrom', 'defaultAddress', 'defaultPostaddress', 'serviceUrl', 'disableConfirmations'], (err, configItems) => { const data = {
if (err) { title: list.name,
return callback(err); homepage: configItems.defaultHomepage || configItems.serviceUrl,
} contactAddress: configItems.defaultAddress,
defaultPostaddress: configItems.defaultPostaddress,
};
if (!mailOpts.ignoreDisableConfirmations && configItems.disableConfirmations) { for (let relativeUrlKey in relativeUrls) {
return; data[relativeUrlKey] = urllib.resolve(configItems.serviceUrl, relativeUrls[relativeUrlKey]);
} }
const data = { function sendMail(html, text) {
title: list.name, mailer.sendMail({
homepage: configItems.defaultHomepage || configItems.serviceUrl, from: {
contactAddress: configItems.defaultAddress, name: configItems.defaultFrom,
defaultPostaddress: configItems.defaultPostaddress, address: configItems.defaultAddress
}; },
to: {
for (let relativeUrlKey in relativeUrls) { name: [].concat(subscription.firstName || []).concat(subscription.lastName || []).join(' '),
data[relativeUrlKey] = urllib.resolve(configItems.serviceUrl, relativeUrls[relativeUrlKey]); address: email
} },
subject: util.format(subject, list.name),
function sendMail(html, text) { encryptionKeys
mailer.sendMail({ }, {
from: { html,
name: configItems.defaultFrom, text,
address: configItems.defaultAddress data
}, }, err => {
to: {
name: [].concat(subscription.firstName || []).concat(subscription.lastName || []).join(' '),
address: email
},
subject: util.format(subject, list.name),
encryptionKeys
}, {
html,
text,
data
}, err => {
if (err) {
log.error('Subscription', err);
}
});
}
let text = {
template: 'subscription/mail-' + template + '-text.hbs'
};
let html = {
template: 'subscription/mail-' + template + '-html.mjml.hbs',
layout: 'subscription/layout.mjml.hbs',
type: 'mjml'
};
helpers.injectCustomFormTemplates(list.defaultForm, { text, html }, (err, tmpl) => {
if (err) { if (err) {
return sendMail(html, text); log.error('Subscription', err);
} }
sendMail(tmpl.html, tmpl.text);
}); });
}
return callback(); let text = {
template: 'subscription/mail-' + template + '-text.hbs'
};
let html = {
template: 'subscription/mail-' + template + '-html.mjml.hbs',
layout: 'subscription/layout.mjml.hbs',
type: 'mjml'
};
helpers.injectCustomFormTemplates(list.defaultForm, { text, html }, (err, tmpl) => {
if (err) {
return sendMail(html, text);
}
sendMail(tmpl.html, tmpl.text);
}); });
return callback();
}); });
}); });
} }

210
routes/subscription.js
View file

@ -47,7 +47,7 @@ let corsOrCsrfProtection = (req, res, next) => {
router.get('/confirm/:cid', (req, res, next) => { router.get('/confirm/:cid', (req, res, next) => {
confirmations.takeConfirmation(req.params.cid, (err, confirmation) => { confirmations.takeConfirmation(req.params.cid, (err, confirmation) => {
if (!err && !subscription) { if (!err && !confirmation) {
err = new Error(_('Selected subscription not found')); err = new Error(_('Selected subscription not found'));
err.status = 404; err.status = 404;
} }
@ -79,7 +79,7 @@ router.get('/confirm/:cid', (req, res, next) => {
return next(err); return next(err);
} }
subscriptions.getById(list.id, subscriptionId, (err, subscription) => { subscriptions.getById(list.id, data.subscriptionId, (err, subscription) => {
if (err) { if (err) {
return next(err); return next(err);
} }
@ -89,7 +89,8 @@ router.get('/confirm/:cid', (req, res, next) => {
return next(err); return next(err);
} }
res.redirect('/subscription/' + list.cid + '/manage-address/' + subscription.cid); req.flash('info', _('Email address changed'));
res.redirect('/subscription/' + list.cid + '/manage/' + subscription.cid);
}); });
}); });
}); });
@ -101,7 +102,7 @@ router.get('/confirm/:cid', (req, res, next) => {
email: data.email, email: data.email,
optInIp: confirmation.ip, optInIp: confirmation.ip,
optInCountry, optInCountry,
status: 1 status: subscriptions.Status.SUBSCRIBED
}; };
subscriptions.insert(list.id, meta, data.subscriptionData, (err, result) => { subscriptions.insert(list.id, meta, data.subscriptionData, (err, result) => {
@ -129,7 +130,7 @@ router.get('/confirm/:cid', (req, res, next) => {
}); });
} else if (confirmation.action === 'unsubscribe') { } else if (confirmation.action === 'unsubscribe') {
subscriptions.changeStatus(list.id, confirmation.data.subscriptionId, confirmation.data.campaignId, 2, (err, found) => { subscriptions.changeStatus(list.id, confirmation.data.subscriptionId, confirmation.data.campaignId, subscriptions.Status.UNSUBSCRIBED, (err, found) => {
if (err) { if (err) {
return next(err); return next(err);
} }
@ -146,7 +147,7 @@ router.get('/confirm/:cid', (req, res, next) => {
return next(err); return next(err);
} }
res.redirect('/subscription/' + req.params.lcid + '/unsubscribed-notice'); res.redirect('/subscription/' + list.cid + '/unsubscribed-notice');
}); });
}); });
}); });
@ -171,7 +172,7 @@ router.get('/:cid', passport.csrfProtection, (req, res, next) => {
return next(err); return next(err);
} }
// FIXME: process subscriber cid param for resubscription requests // TODO: process subscriber cid param for resubscription requests
let data = tools.convertKeys(req.query, { let data = tools.convertKeys(req.query, {
skip: ['layout'] skip: ['layout']
@ -181,51 +182,74 @@ router.get('/:cid', passport.csrfProtection, (req, res, next) => {
data.cid = list.cid; data.cid = list.cid;
data.csrfToken = req.csrfToken(); data.csrfToken = req.csrfToken();
fields.list(list.id, (err, fieldList) => {
if (err && !fieldList) {
fieldList = [];
}
data.customFields = fields.getRow(fieldList, data); function nextStep() {
data.useEditor = true; fields.list(list.id, (err, fieldList) => {
if (err && !fieldList) {
settings.list(['pgpPrivateKey', 'defaultAddress', 'defaultPostaddress'], (err, configItems) => { fieldList = [];
if (err) {
return next(err);
} }
data.hasPubkey = !!configItems.pgpPrivateKey;
data.defaultAddress = configItems.defaultAddress;
data.defaultPostaddress = configItems.defaultPostaddress;
data.template = { data.customFields = fields.getRow(fieldList, data);
template: 'subscription/web-subscribe.mjml.hbs', data.useEditor = true;
layout: 'subscription/layout.mjml.hbs'
};
helpers.injectCustomFormData(req.query.fid || list.defaultForm, 'subscription/web-subscribe', data, (err, data) => { settings.list(['pgpPrivateKey', 'defaultAddress', 'defaultPostaddress'], (err, configItems) => {
if (err) { if (err) {
return next(err); return next(err);
} }
data.hasPubkey = !!configItems.pgpPrivateKey;
data.defaultAddress = configItems.defaultAddress;
data.defaultPostaddress = configItems.defaultPostaddress;
helpers.getMjmlTemplate(data.template, (err, htmlRenderer) => { data.template = {
template: 'subscription/web-subscribe.mjml.hbs',
layout: 'subscription/layout.mjml.hbs'
};
helpers.injectCustomFormData(req.query.fid || list.defaultForm, 'subscription/web-subscribe', data, (err, data) => {
if (err) { if (err) {
return next(err); return next(err);
} }
helpers.captureFlashMessages(req, res, (err, flash) => { helpers.getMjmlTemplate(data.template, (err, htmlRenderer) => {
if (err) { if (err) {
return next(err); return next(err);
} }
data.isWeb = true; helpers.captureFlashMessages(req, res, (err, flash) => {
data.needsJsWarning = true; if (err) {
data.flashMessages = flash; return next(err);
res.send(htmlRenderer(data)); }
data.isWeb = true;
data.needsJsWarning = true;
data.flashMessages = flash;
res.send(htmlRenderer(data));
});
}); });
}); });
}); });
}); });
}); }
const ucid = req.query.cid;
if (ucid) {
subscriptions.get(list.id, ucid, (err, subscription) => {
if (err) {
return next(err);
}
for (let key in subscription) {
if (!(key in data)) {
data[key] = subscription[key];
}
}
nextStep();
});
} else {
nextStep();
}
}); });
}); });
@ -360,14 +384,14 @@ router.post('/:cid/subscribe', passport.parseForm, corsOrCsrfProtection, (req, r
subscriptionData[key] = (req.body[key] || '').toString().trim(); subscriptionData[key] = (req.body[key] || '').toString().trim();
} }
}); });
subscriptionData = tools.convertKeys(data); subscriptionData = tools.convertKeys(subscriptionData);
subscriptions.getByEmail(list.id, email, (err, subscription) => { subscriptions.getByEmail(list.id, email, (err, subscription) => {
if (err) { if (err) {
return req.xhr ? sendJsonError(err) : next(err); return req.xhr ? sendJsonError(err) : next(err);
} }
if (subscription) { if (subscription && subscription.status === subscriptions.Status.SUBSCRIBED) {
mailHelpers.sendAlreadySubscribed(list, email, subscription, (err) => { mailHelpers.sendAlreadySubscribed(list, email, subscription, (err) => {
if (err) { if (err) {
return req.xhr ? sendJsonError(err) : next(err); return req.xhr ? sendJsonError(err) : next(err);
@ -381,10 +405,6 @@ router.post('/:cid/subscribe', passport.parseForm, corsOrCsrfProtection, (req, r
}; };
confirmations.addConfirmation(list.id, 'subscribe', req.ip, data, (err, confirmCid) => { confirmations.addConfirmation(list.id, 'subscribe', req.ip, data, (err, confirmCid) => {
if (!err && !confirmCid) {
err = new Error(_('Could not store confirmation data'));
}
if (err) { if (err) {
if (req.xhr) { if (req.xhr) {
return sendJsonError(err); return sendJsonError(err);
@ -406,7 +426,7 @@ router.post('/:cid/subscribe', passport.parseForm, corsOrCsrfProtection, (req, r
log.info('Subscription', 'Confirmation message for %s marked to be skipped (%s)', email, JSON.stringify(data)); log.info('Subscription', 'Confirmation message for %s marked to be skipped (%s)', email, JSON.stringify(data));
sendWebResponse(); sendWebResponse();
} else { } else {
sendConfirmSubscription(list, email, confirmCid, data, (err) => { mailHelpers.sendConfirmSubscription(list, email, confirmCid, data, (err) => {
if (err) { if (err) {
return req.xhr ? sendJsonError(err) : sendWebResponse(err); return req.xhr ? sendJsonError(err) : sendWebResponse(err);
} }
@ -436,8 +456,8 @@ router.get('/:lcid/manage/:ucid', passport.csrfProtection, (req, res, next) => {
return next(err); return next(err);
} }
subscriptions.get(list.id, req.params.ucid, (err, subscription) => { subscriptions.get(list.id, req.params.ucid, (err, subscription) => {
if (!err && !subscription) { if (!err && (!subscription || subscription.status !== subscriptions.Status.SUBSCRIBED)) {
err = new Error(_('Subscription not found from this list')); err = new Error(_('Subscription not found in this list'));
err.status = 404; err.status = 404;
} }
@ -507,13 +527,22 @@ router.post('/:lcid/manage', passport.parseForm, passport.csrfProtection, (req,
return next(err); return next(err);
} }
subscriptions.update(list.id, req.body.cid, req.body, false, err => { subscriptions.get(list.id, req.body.cid, (err, subscription) => {
if (err) { if (!err && (!subscription || subscription.status !== subscriptions.Status.SUBSCRIBED)) {
req.flash('danger', err.message || err); err = new Error(_('Subscription not found in this list'));
log.error('Subscription', err); err.status = 404;
return res.redirect('/subscription/' + encodeURIComponent(req.params.lcid) + '/manage/' + encodeURIComponent(req.body.cid) + '?' + tools.queryParams(req.body));
} }
res.redirect('/subscription/' + req.params.lcid + '/updated-notice');
if (err) {
return next(err);
}
subscriptions.update(list.id, subscription.cid, req.body, false, err => {
if (err) {
return next(err);
}
res.redirect('/subscription/' + req.params.lcid + '/updated-notice');
});
}); });
}); });
}); });
@ -535,8 +564,8 @@ router.get('/:lcid/manage-address/:ucid', passport.csrfProtection, (req, res, ne
} }
subscriptions.get(list.id, req.params.ucid, (err, subscription) => { subscriptions.get(list.id, req.params.ucid, (err, subscription) => {
if (!err && !subscription) { if (!err && (!subscription || subscription.status !== subscriptions.Status.SUBSCRIBED)) {
err = new Error(_('Subscription not found from this list')); err = new Error(_('Subscription not found in this list'));
err.status = 404; err.status = 404;
} }
@ -589,48 +618,52 @@ router.post('/:lcid/manage-address', passport.parseForm, passport.csrfProtection
return next(err); return next(err);
} }
const emailNew = (req.body.emailNew || '').toString().trim(); let bodyData = tools.convertKeys(req.body); // This is here to convert "email-new" to "emailNew"
const emailOld = (bodyData.email || '').toString().trim();
const emailNew = (bodyData.emailNew || '').toString().trim();
subscriptions.updateAddressCheck(list, req.body.cid, emailNew, req.ip, (err, subscription, newEmailAvailable) => { if (emailOld === emailNew) {
if (err) { req.flash('info', _('Nothing seems to be changed'));
req.flash('danger', err.message || err); res.redirect('/subscription/' + req.params.lcid + '/manage/' + req.body.cid);
log.error('Subscription', err);
return res.redirect('/subscription/' + encodeURIComponent(req.params.lcid) + '/manage-address/' + encodeURIComponent(req.body.cid) + '?' + tools.queryParams(req.body));
}
function sendWebResponse(err) { } else {
subscriptions.updateAddressCheck(list, req.body.cid, emailNew, req.ip, (err, subscription, newEmailAvailable) => {
if (err) { if (err) {
return next(err); return next(err);
} }
req.flash('info', _('An email with further instructions has been sent to the provided address')); function sendWebResponse(err) {
res.redirect('/subscription/' + req.params.lcid + '/manage/' + req.body.cid);
}
if (newEmailAvailable) {
const data = {
subscriptionId: subscription.id,
emailNew
};
confirmations.addConfirmation(list.id, 'change-address', req.ip, data, err => {
if (err) { if (err) {
return next(err); return next(err);
} }
mailHelpers.sendConfirmAddressChange(list, emailNew, subscription, sendWebResponse); req.flash('info', _('An email with further instructions has been sent to the provided address'));
}); res.redirect('/subscription/' + req.params.lcid + '/manage/' + req.body.cid);
}
} else { if (newEmailAvailable) {
mailHelpers.sendAlreadySubscribed(list, emailNew, subscription, sendWebResponse); const data = {
} subscriptionId: subscription.id,
}); emailNew
};
confirmations.addConfirmation(list.id, 'change-address', req.ip, data, (err, confirmCid) => {
if (err) {
return next(err);
}
mailHelpers.sendConfirmAddressChange(list, emailNew, confirmCid, subscription, sendWebResponse);
});
} else {
mailHelpers.sendAlreadySubscribed(list, emailNew, subscription, sendWebResponse);
}
});
}
}); });
}); });
router.get('/:lcid/unsubscribe/:ucid', passport.csrfProtection, (req, res, next) => { router.get('/:lcid/unsubscribe/:ucid', passport.csrfProtection, (req, res, next) => {
// FIXME: handle different subscription options. The one below is currently "One-step with unsubscribe form"
lists.getByCid(req.params.lcid, (err, list) => { lists.getByCid(req.params.lcid, (err, list) => {
if (!err && !list) { if (!err && !list) {
err = new Error(_('Selected list not found')); err = new Error(_('Selected list not found'));
@ -647,7 +680,7 @@ router.get('/:lcid/unsubscribe/:ucid', passport.csrfProtection, (req, res, next)
} }
subscriptions.get(list.id, req.params.ucid, (err, subscription) => { subscriptions.get(list.id, req.params.ucid, (err, subscription) => {
if (!err && !subscription) { if (!err && (!subscription || subscription.status !== subscriptions.Status.SUBSCRIBED)) {
err = new Error(_('Subscription not found in this list')); err = new Error(_('Subscription not found in this list'));
err.status = 404; err.status = 404;
} }
@ -657,7 +690,8 @@ router.get('/:lcid/unsubscribe/:ucid', passport.csrfProtection, (req, res, next)
} }
if (list.unsubscriptionMode === lists.UnsubscriptionMode.ONE_STEP_WITH_FORM || if (req.query.formTest ||
list.unsubscriptionMode === lists.UnsubscriptionMode.ONE_STEP_WITH_FORM ||
list.unsubscriptionMode === lists.UnsubscriptionMode.TWO_STEP_WITH_FORM) { list.unsubscriptionMode === lists.UnsubscriptionMode.TWO_STEP_WITH_FORM) {
subscription.lcid = req.params.lcid; subscription.lcid = req.params.lcid;
@ -695,7 +729,7 @@ router.get('/:lcid/unsubscribe/:ucid', passport.csrfProtection, (req, res, next)
}); });
}); });
} else { // UnsubscriptionMode.ONE_STEP || UnsubscriptionMode.TWO_STEP || UnsubscriptionMode.MANUAL } else { // UnsubscriptionMode.ONE_STEP || UnsubscriptionMode.TWO_STEP || UnsubscriptionMode.MANUAL
handleUnsubscribe(list, subscription, res); handleUnsubscribe(list, subscription, req.query.c, req.ip, res, next);
} }
}); });
}); });
@ -716,7 +750,7 @@ router.post('/:lcid/unsubscribe', passport.parseForm, passport.csrfProtection, (
const campaignId = (req.body.campaign || '').toString().trim() || false; const campaignId = (req.body.campaign || '').toString().trim() || false;
subscriptions.get(list.id, req.body.ucid, (err, subscription) => { subscriptions.get(list.id, req.body.ucid, (err, subscription) => {
if (!err && !subscription) { if (!err && (!subscription || subscription.status !== subscriptions.Status.SUBSCRIBED)) {
err = new Error(_('Subscription not found in this list')); err = new Error(_('Subscription not found in this list'));
err.status = 404; err.status = 404;
} }
@ -725,12 +759,12 @@ router.post('/:lcid/unsubscribe', passport.parseForm, passport.csrfProtection, (
return next(err); return next(err);
} }
handleUnsubscribe(list, subscription, res); handleUnsubscribe(list, subscription, campaignId, req.ip, res, next);
}); });
}); });
}); });
function handleUnsubscribe(list, subscription, res) { function handleUnsubscribe(list, subscription, campaignId, ip, res, next) {
if (list.unsubscriptionMode === lists.UnsubscriptionMode.TWO_STEP || if (list.unsubscriptionMode === lists.UnsubscriptionMode.TWO_STEP ||
list.unsubscriptionMode === lists.UnsubscriptionMode.TWO_STEP_WITH_FORM) { list.unsubscriptionMode === lists.UnsubscriptionMode.TWO_STEP_WITH_FORM) {
@ -739,28 +773,24 @@ function handleUnsubscribe(list, subscription, res) {
campaignId campaignId
}; };
confirmations.addConfirmation(list.id, 'unsubscribe', req.ip, data, (err, confirmCid) => { confirmations.addConfirmation(list.id, 'unsubscribe', ip, data, (err, confirmCid) => {
if (!err && !confirmCid) {
err = new Error(_('Could not store confirmation data'));
}
if (err) { if (err) {
return next(err); return next(err);
} }
mailHelpers.sendConfirmUnsubscription(list, subscription.email, subscription, err => { mailHelpers.sendConfirmUnsubscription(list, subscription.email, confirmCid, subscription, err => {
if (err) { if (err) {
return next(err); return next(err);
} }
res.redirect('/subscription/' + list.cid + '/unsubscribed-notice'); res.redirect('/subscription/' + list.cid + '/confirm-unsubscription-notice');
}); });
}); });
} else if (list.unsubscriptionMode === lists.UnsubscriptionMode.ONE_STEP || } else if (list.unsubscriptionMode === lists.UnsubscriptionMode.ONE_STEP ||
list.unsubscriptionMode === lists.UnsubscriptionMode.ONE_STEP_WITH_FORM) { list.unsubscriptionMode === lists.UnsubscriptionMode.ONE_STEP_WITH_FORM) {
subscriptions.changeStatus(subscription.id, list.id, campaignId, 2, (err, found) => { subscriptions.changeStatus(list.id, subscription.id, campaignId, subscriptions.Status.UNSUBSCRIBED, (err, found) => {
if (err) { if (err) {
return next(err); return next(err);
} }

4
views/lists/forms/edit.hbs
View file

@ -55,7 +55,11 @@
<a href="/subscription/{{list.cid}}/updated-notice?fid={{form.id}}" target="_blank">{{#translate}}Updated Notice{{/translate}}</a> <a href="/subscription/{{list.cid}}/updated-notice?fid={{form.id}}" target="_blank">{{#translate}}Updated Notice{{/translate}}</a>
| |
<a href="/subscription/{{list.cid}}/unsubscribed-notice?fid={{form.id}}" target="_blank">{{#translate}}Unsubscribed Notice{{/translate}}</a> <a href="/subscription/{{list.cid}}/unsubscribed-notice?fid={{form.id}}" target="_blank">{{#translate}}Unsubscribed Notice{{/translate}}</a>
|
<a href="/subscription/{{list.cid}}/manual-unsubscribe-notice?fid={{form.id}}" target="_blank">{{#translate}}Manual Unsubscribe Notice{{/translate}}</a>
{{#if testUsers}} {{#if testUsers}}
|
<a href="/subscription/{{list.cid}}/unsubscribe/{{testUsers.0.cid}}?fid={{form.id}}&formTest=1" target="_blank">{{#translate}}Unsubscribe{{/translate}}</a>
| |
<a href="/subscription/{{list.cid}}/manage/{{testUsers.0.cid}}?fid={{form.id}}" target="_blank">{{#translate}}Manage{{/translate}}</a> <a href="/subscription/{{list.cid}}/manage/{{testUsers.0.cid}}?fid={{form.id}}" target="_blank">{{#translate}}Manage{{/translate}}</a>
| |

2
views/subscription/partials/subscription-custom-fields.hbs
View file

@ -1,6 +1,6 @@
{{#each customFields}} {{#each customFields}}
{{#if typeSubsciptionEmail}} {{#if typeSubscriptionEmail}}
<div class="form-group email"> <div class="form-group email">
<label for="email">{{#translate}}Email Address{{/translate}}</label> <label for="email">{{#translate}}Email Address{{/translate}}</label>
{{#if ../isManagePreferences}} {{#if ../isManagePreferences}}

1
views/subscription/partials/subscription-subscribe-form.hbs
View file

@ -10,6 +10,7 @@
<input type="hidden" class="tz-detect" name="tz" id="tz" value="{{tz}}"> <input type="hidden" class="tz-detect" name="tz" id="tz" value="{{tz}}">
<input type="hidden" name="address" value=""> <input type="hidden" name="address" value="">
<input type="hidden" name="sub" id="sub" value=""> <input type="hidden" name="sub" id="sub" value="">
<input type="hidden" name="ucid" value="{{ucid}}">
{{> subscription_custom_fields}} {{> subscription_custom_fields}}