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

Halfway through extending subscriptions by selectable unsubscription process. Also contains changes towards better handling of scenarios when address is already subscribed.

Browse source
This commit is contained in:
Tomas Bures 2017-04-30 10:51:47 -04:00
parent b0d51c7dad
commit 3783d7c2ce
27 changed files with 727 additions and 431 deletions
Download patch file Download diff file Expand all files Collapse all files

337
lib/models/subscriptions.js
View file

@ -88,108 +88,109 @@ module.exports.filter = (listId, request, columns, segmentId, callback) => {
};
module.exports.addConfirmation = (list, email, optInIp, data, callback) => {
module.exports.addConfirmation = (list, email, ip, data, callback) => {
let cid = shortid.generate();
tools.validateEmail(email, false, err => {
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
db.getConnection((err, connection) => {
let query = 'INSERT INTO confirmations (cid, list, email, ip, data) VALUES (?,?,?,?,?)';
connection.query(query, [cid, list.id, email, ip, JSON.stringify(data || {})], (err, result) => {
connection.release();
if (err) {
return callback(err);
}
let query = 'INSERT INTO confirmations (cid, list, email, opt_in_ip, data) VALUES (?,?,?,?,?)';
connection.query(query, [cid, list.id, email, optInIp, JSON.stringify(data || {})], (err, result) => {
connection.release();
if (!result || !result.affectedRows) {
return callback(null, false);
}
fields.list(list.id, (err, fieldList) => {
if (err) {
return callback(err);
}
if (!result || !result.affectedRows) {
return callback(null, false);
}
let encryptionKeys = [];
fields.getRow(fieldList, data).forEach(field => {
if (field.type === 'gpg' && field.value) {
encryptionKeys.push(field.value.trim());
}
});
fields.list(list.id, (err, fieldList) => {
settings.list(['defaultHomepage', 'defaultFrom', 'defaultAddress', 'defaultPostaddress', 'serviceUrl'], (err, configItems) => {
if (err) {
return callback(err);
}
let encryptionKeys = [];
fields.getRow(fieldList, data).forEach(field => {
if (field.type === 'gpg' && field.value) {
encryptionKeys.push(field.value.trim());
}
});
settings.list(['defaultHomepage', 'defaultFrom', 'defaultAddress', 'defaultPostaddress', 'serviceUrl'], (err, configItems) => {
if (err) {
return callback(err);
setImmediate(() => {
if (data._skip) {
log.info('Subscription', 'Confirmation message for %s marked to be skipped (%s)', email, JSON.stringify(data));
return;
}
setImmediate(() => {
if (data._skip) {
log.info('Subscription', 'Confirmation message for %s marked to be skipped (%s)', email, JSON.stringify(data));
return;
// FIXME - move to router
const mailOpts = {
subject: _('%s: Please Confirm Subscription'),
confirmUrlRoute: '/subscription/confirm/',
templateType: 'subscription'
};
let sendMail = (html, text) => {
mailer.sendMail({
from: {
name: configItems.defaultFrom,
address: configItems.defaultAddress
},
to: {
name: [].concat(data.firstName || []).concat(data.lastName || []).join(' '),
address: email
},
subject: util.format(mailOpts.subject, list.name),
encryptionKeys
}, {
html,
text,
data: {
title: list.name,
contactAddress: configItems.defaultAddress,
defaultPostaddress: configItems.defaultPostaddress,
confirmUrl: urllib.resolve(configItems.serviceUrl, mailOpts.confirmUrlRoute + cid)
}
}, err => {
if (err) {
log.error('Subscription', err);
}
});
};
let text = {
template: 'subscription/mail-confirm-' + mailOpts.templateType + '-text.hbs'
};
let html = {
template: 'subscription/mail-confirm-' + mailOpts.templateType + '-html.mjml.hbs',
layout: 'subscription/layout.mjml.hbs',
type: 'mjml'
};
helpers.injectCustomFormTemplates(list.defaultForm, { text, html }, (err, tmpl) => {
if (err) {
return sendMail(html, text);
}
let sendMail = (html, text) => {
mailer.sendMail({
from: {
name: configItems.defaultFrom,
address: configItems.defaultAddress
},
to: {
name: [].concat(data.firstName || []).concat(data.lastName || []).join(' '),
address: email
},
subject: util.format(_('%s: Please Confirm Subscription'), list.name),
encryptionKeys
}, {
html,
text,
data: {
title: list.name,
contactAddress: configItems.defaultAddress,
defaultPostaddress: configItems.defaultPostaddress,
confirmUrl: urllib.resolve(configItems.serviceUrl, '/subscription/subscribe/' + cid)
}
}, err => {
if (err) {
log.error('Subscription', err);
}
});
};
let text = {
template: 'subscription/mail-confirm-text.hbs'
};
let html = {
template: 'subscription/mail-confirm-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);
});
sendMail(tmpl.html, tmpl.text);
});
return callback(null, cid);
});
return callback(null, cid);
});
});
});
});
};
module.exports.subscribe = (cid, optInIp, callback) => {
module.exports.processConfirmation = (cid, ip, callback) => {
db.getConnection((err, connection) => {
if (err) {
return callback(err);
@ -215,7 +216,11 @@ module.exports.subscribe = (cid, optInIp, callback) => {
subscription = {};
}
if (subscription.action === 'update' && subscription.subscriber) {
if (subscription._action === 'update') {
if (!subscription.subscriber) { // Something went terribly wrong and we don't have data that we have originally provided
return callback(new Error(_('Subscriber info corrupted or missing')));
}
// update email address instead of adding new
db.getConnection((err, connection) => {
if (err) {
@ -230,45 +235,57 @@ module.exports.subscribe = (cid, optInIp, callback) => {
}
connection.query('DELETE FROM confirmations WHERE `cid`=? LIMIT 1', [cid], () => {
connection.release();
// reload full data from db in case it was an update, not insert
return module.exports.getById(listId, subscription.subscriber, callback);
return module.exports.getById(listId, subscription.subscriber, (err, subscriptionData) => {
return callback(err, subscriptionData, subscription._action);
});
});
});
});
return;
}
subscription.cid = cid;
subscription.list = listId;
subscription.email = email;
} else if (subscription._action === 'unsubscribe') {
// TODO
return;
let optInCountry = geoip.lookupCountry(optInIp) || null;
module.exports.insert(listId, {
email,
cid,
optInIp,
optInCountry,
status: 1
}, subscription, (err, result) => {
if (err) {
return callback(err);
}
} else if (subscription._action === 'subscribe') {
subscription.cid = cid;
subscription.list = listId;
subscription.email = email;
if (!result.entryId) {
return callback(new Error(_('Could not save subscription')));
}
db.getConnection((err, connection) => {
let optInCountry = geoip.lookupCountry(ip) || null;
module.exports.insert(listId, {
email,
cid,
optInIp: ip,
optInCountry,
status: 1
}, subscription, (err, result) => {
if (err) {
return callback(err);
}
connection.query('DELETE FROM confirmations WHERE `cid`=? LIMIT 1', [cid], () => {
connection.release();
// reload full data from db in case it was an update, not insert
return module.exports.getById(listId, result.entryId, callback);
if (!result.entryId) {
return callback(new Error(_('Could not save subscription')));
}
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
connection.query('DELETE FROM confirmations WHERE `cid`=? LIMIT 1', [cid], () => {
connection.release();
// reload full data from db in case it was an update, not insert
return module.exports.getById(listId, result.entryId, (err, subscriptionData) => {
return callback(err, subscriptionData, subscription._action);
});
});
});
});
});
} else {
return callback(new Error(util.format(_('Subscription request corrupted - action: %s'), subscription._action)));
}
});
});
};
@ -307,6 +324,7 @@ module.exports.insert = (listId, meta, subscription, callback) => {
}
});
// FIXME - see issue #218
fields.getValues(fields.getRow(fieldList, subscription, true, true, !!meta.partial), true).forEach(field => {
keys.push(field.key);
values.push(field.value);
@ -377,6 +395,8 @@ module.exports.insert = (listId, meta, subscription, callback) => {
queryArgs = values.concat(existing.id);
query = 'UPDATE `subscription__' + listId + '` SET ' + keys.map(key => '`' + key + '`=?') + ' WHERE id=? LIMIT 1';
}
console.log(query);
console.log(queryArgs);
connection.query(query, queryArgs, (err, result) => {
if (err) {
@ -1076,7 +1096,7 @@ module.exports.listImports = (listId, callback) => {
};
module.exports.updateAddress = (list, cid, updates, optInIp, callback) => {
module.exports.updateAddress = (list, cid, updates, ip, callback) => {
updates = tools.convertKeys(updates);
cid = (cid || '').toString().trim();
@ -1128,11 +1148,13 @@ module.exports.updateAddress = (list, cid, updates, optInIp, callback) => {
}
if (rows && rows[0] && rows[0].id) {
return callback(new Error(_('This address is already registered by someone else')));
}
module.exports.addConfirmation(list, emailNew, optInIp, {
action: 'update',
module.exports.addConfirmation(list, emailNew, ip, {
_action: 'update',
cid,
subscriber: old.id,
emailOld: old.email
@ -1142,3 +1164,114 @@ module.exports.updateAddress = (list, cid, updates, optInIp, callback) => {
});
});
};
module.exports.sendMail = (listId, email, template, subject, mailOpts, subscription, callback) => {
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
lists.get(listId, (err, list) => {
if (!err && !list) {
err = new Error(_('Selected list not found'));
err.status = 404;
}
if (err) {
return next(err);
}
fields.list(list.id, (err, fieldList) => {
if (err) {
return callback(err);
}
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'], (err, configItems) => {
if (err) {
return callback(err);
}
const data = {
title: list.name,
contactAddress: configItems.defaultAddress,
defaultPostaddress: configItems.defaultPostaddress,
};
if (mailOpts.confirmUrlRoute) {
data.confirmUrl = urllib.resolve(configItems.serviceUrl, mailOpts.confirmUrlRoute + cid)
}
function sendMail(html, text) {
mailer.sendMail({
from: {
name: configItems.defaultFrom,
address: configItems.defaultAddress
},
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) {
return sendMail(html, text);
}
sendMail(tmpl.html, tmpl.text);
});
return callback(null, cid);
});
});
});
});
};
/*
FIXME
function getUnsubscriptionMode = (listId, start, limit, callback) => {
listId = Number(listId) || 0;
if (!listId) {
return callback(new Error('Missing List ID'));
}
tableHelpers.list('subscription__' + listId, ['*'], 'email', null, start, limit, (err, rows, total) => {
if (!err) {
rows = rows.map(row => tools.convertKeys(row));
}
return callback(err, rows, total);
});
};
*/