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

Added initial support for trigger based automation

Browse source
This commit is contained in:
Andris Reinman 2016-06-03 13:15:33 +03:00
parent cc1c70d57f
commit b16209f23e
36 changed files with 2025 additions and 263 deletions
Download patch file Download diff file Expand all files Collapse all files

4
routes/archive.js
View file

@ -58,13 +58,13 @@ router.get('/:campaign/:list/:subscription', (req, res, next) => {
req.flash('danger', err.message || err);
return res.redirect('/');
}
/*
if (!mail && !req.user) {
err = new Error('Not Found');
err.status = 404;
return next(err);
}
*/
let renderAndShow = (html, renderTags) => {
// rewrite links to count clicks

246
routes/campaigns.js
View file

@ -90,6 +90,9 @@ router.get('/create', passport.csrfProtection, (req, res) => {
case 'rss':
view = 'campaigns/create-rss';
break;
case 'triggered':
view = 'campaigns/create-triggered';
break;
default:
view = 'campaigns/create';
}
@ -151,6 +154,9 @@ router.get('/edit/:id', passport.csrfProtection, (req, res, next) => {
let view;
switch (campaign.type) {
case 4: //triggered
view = 'campaigns/edit-triggered';
break;
case 2: //rss
view = 'campaigns/edit-rss';
break;
@ -159,55 +165,72 @@ router.get('/edit/:id', passport.csrfProtection, (req, res, next) => {
view = 'campaigns/edit';
}
lists.get(campaign.list, (err, list) => {
let getList = (listId, callback) => {
lists.get(listId, (err, list) => {
if (err) {
return callback(err);
}
if (!list) {
return callback(new Error('Selected list not found'));
}
fields.list(list.id, (err, fieldList) => {
if (err && !fieldList) {
fieldList = [];
}
let mergeTags = [
// keep indentation
{
key: 'LINK_UNSUBSCRIBE',
value: 'URL that points to the preferences page of the subscriber'
}, {
key: 'LINK_PREFERENCES',
value: 'URL that points to the unsubscribe page'
}, {
key: 'LINK_BROWSER',
value: 'URL to preview the message in a browser'
}, {
key: 'FIRST_NAME',
value: 'First name'
}, {
key: 'LAST_NAME',
value: 'Last name'
}, {
key: 'FULL_NAME',
value: 'Full name (first and last name combined)'
}, {
key: 'SUBSCRIPTION_ID',
value: 'Unique ID that identifies the recipient'
}, {
key: 'LIST_ID',
value: 'Unique ID that identifies the list used for this campaign'
}, {
key: 'CAMPAIGN_ID',
value: 'Unique ID that identifies current campaign'
}
];
fieldList.forEach(field => {
mergeTags.push({
key: field.key,
value: field.name
});
});
return callback(null, list, mergeTags);
});
});
};
getList(campaign.list, (err, list, mergeTags) => {
if (err) {
req.flash('danger', err.message || err);
return res.redirect('/');
}
if (!list) {
req.flash('danger', 'Selected list does not exist');
res.render(view, campaign);
return;
}
fields.list(list.id, (err, fieldList) => {
if (err && !fieldList) {
fieldList = [];
}
let mergeTags = [
// indent
{
key: 'LINK_UNSUBSCRIBE',
value: 'URL that points to the preferences page of the subscriber'
}, {
key: 'LINK_PREFERENCES',
value: 'URL that points to the unsubscribe page'
}, {
key: 'LINK_BROWSER',
value: 'URL to preview the message in a browser'
}, {
key: 'FIRST_NAME',
value: 'First name'
}, {
key: 'LAST_NAME',
value: 'Last name'
}, {
key: 'FULL_NAME',
value: 'Full name (first and last name combined)'
}
];
fieldList.forEach(field => {
mergeTags.push({
key: field.key,
value: field.name
});
});
campaign.mergeTags = mergeTags;
res.render(view, campaign);
});
campaign.mergeTags = mergeTags;
res.render(view, campaign);
});
});
});
@ -298,61 +321,74 @@ router.get('/view/:id', passport.csrfProtection, (req, res) => {
return res.redirect('/campaigns');
}
lists.get(campaign.list, (err, list) => {
if (err || !campaign) {
let getList = (listId, callback) => {
lists.get(listId, (err, list) => {
if (err) {
return callback(err);
}
if (!list) {
return callback(new Error('Selected list not found'));
}
subscriptions.listTestUsers(listId, (err, testUsers) => {
if (err || !testUsers) {
testUsers = [];
}
return callback(null, list, testUsers);
});
});
};
getList(campaign.list, (err, list, testUsers) => {
if (err) {
req.flash('danger', err && err.message || err);
return res.redirect('/campaigns');
}
campaign.csrfToken = req.csrfToken();
campaign.list = list;
campaign.testUsers = testUsers;
subscriptions.listTestUsers(list.id, (err, testUsers) => {
if (err || !testUsers) {
testUsers = [];
campaign.isIdling = campaign.status === 1;
campaign.isSending = campaign.status === 2;
campaign.isFinished = campaign.status === 3;
campaign.isPaused = campaign.status === 4;
campaign.isInactive = campaign.status === 5;
campaign.isActive = campaign.status === 6;
campaign.isNormal = campaign.type === 1 || campaign.type === 3;
campaign.isRss = campaign.type === 2;
campaign.isTriggered = campaign.type === 4;
campaign.isScheduled = campaign.scheduled && campaign.scheduled > new Date();
// show only messages that weren't bounced as delivered
campaign.delivered = campaign.delivered - campaign.bounced;
campaign.openRate = campaign.delivered ? Math.round((campaign.opened / campaign.delivered) * 10000) / 100 : 0;
campaign.clicksRate = campaign.delivered ? Math.round((campaign.clicks / campaign.delivered) * 10000) / 100 : 0;
campaign.bounceRate = campaign.delivered ? Math.round((campaign.bounced / campaign.delivered) * 10000) / 100 : 0;
campaign.complaintRate = campaign.delivered ? Math.round((campaign.complained / campaign.delivered) * 10000) / 100 : 0;
campaign.unsubscribeRate = campaign.delivered ? Math.round((campaign.unsubscribed / campaign.delivered) * 10000) / 100 : 0;
campaigns.getLinks(campaign.id, (err, links) => {
if (err) {
// ignore
}
campaign.testUsers = testUsers;
campaign.isIdling = campaign.status === 1;
campaign.isSending = campaign.status === 2;
campaign.isFinished = campaign.status === 3;
campaign.isPaused = campaign.status === 4;
campaign.isInactive = campaign.status === 5;
campaign.isActive = campaign.status === 6;
campaign.isNormal = campaign.type === 1 || campaign.type === 3;
campaign.isRss = campaign.type === 2;
campaign.isScheduled = campaign.scheduled && campaign.scheduled > new Date();
// show only messages that weren't bounced as delivered
campaign.delivered = campaign.delivered - campaign.bounced;
campaign.openRate = campaign.delivered ? Math.round((campaign.opened / campaign.delivered) * 10000) / 100 : 0;
campaign.clicksRate = campaign.delivered ? Math.round((campaign.clicks / campaign.delivered) * 10000) / 100 : 0;
campaign.bounceRate = campaign.delivered ? Math.round((campaign.bounced / campaign.delivered) * 10000) / 100 : 0;
campaign.complaintRate = campaign.delivered ? Math.round((campaign.complained / campaign.delivered) * 10000) / 100 : 0;
campaign.unsubscribeRate = campaign.delivered ? Math.round((campaign.unsubscribed / campaign.delivered) * 10000) / 100 : 0;
campaigns.getLinks(campaign.id, (err, links) => {
if (err) {
// ignore
let index = 0;
campaign.links = (links || []).map(link => {
link.index = ++index;
link.totalPercentage = campaign.delivered ? Math.round(((link.clicks / campaign.delivered) * 100) * 1000) / 1000 : 0;
link.relPercentage = campaign.clicks ? Math.round(((link.clicks / campaign.clicks) * 100) * 1000) / 1000 : 0;
link.short = link.url.replace(/^https?:\/\/(www.)?/i, '');
if (link.short > 63) {
link.short = link.short.substr(0, 60) + '…';
}
let index = 0;
campaign.links = (links || []).map(link => {
link.index = ++index;
link.totalPercentage = campaign.delivered ? Math.round(((link.clicks / campaign.delivered) * 100) * 1000) / 1000 : 0;
link.relPercentage = campaign.clicks ? Math.round(((link.clicks / campaign.clicks) * 100) * 1000) / 1000 : 0;
link.short = link.url.replace(/^https?:\/\/(www.)?/i, '');
if (link.short > 63) {
link.short = link.short.substr(0, 60) + '…';
}
return link;
});
campaign.showOverview = !req.query.tab || req.query.tab === 'overview';
campaign.showLinks = req.query.tab === 'links';
res.render('campaigns/view', campaign);
return link;
});
campaign.showOverview = !req.query.tab || req.query.tab === 'overview';
campaign.showLinks = req.query.tab === 'links';
res.render('campaigns/view', campaign);
});
});
});
@ -423,8 +459,20 @@ router.get('/status/:id/:status', passport.csrfProtection, (req, res) => {
return res.redirect('/campaigns');
}
lists.get(campaign.list, (err, list) => {
if (err || !campaign) {
let getList = (listId, callback) => {
lists.get(listId, (err, list) => {
if (err) {
return callback(err);
}
if (!list) {
return callback(new Error('Selected list not found'));
}
return callback(null, list);
});
};
getList(campaign.list, (err, list) => {
if (err) {
req.flash('danger', err && err.message || err);
return res.redirect('/campaigns');
}
@ -449,8 +497,20 @@ router.get('/clicked/:id/:linkId', passport.csrfProtection, (req, res) => {
return res.redirect('/campaigns');
}
lists.get(campaign.list, (err, list) => {
if (err || !campaign) {
let getList = (listId, callback) => {
lists.get(listId, (err, list) => {
if (err) {
return callback(err);
}
if (!list) {
return callback(new Error('Selected list not found'));
}
return callback(null, list);
});
};
getList(campaign.list, (err, list) => {
if (err) {
req.flash('danger', err && err.message || err);
return res.redirect('/campaigns');
}

30
routes/links.js
View file

@ -30,12 +30,28 @@ router.get('/:campaign/:list/:subscription', (req, res) => {
res.end(trackImg);
});
router.get('/:campaign/:list/:subscription/:link', (req, res, next) => {
links.resolve(req.params.campaign, req.params.link, (err, linkId, url) => {
router.get('/:campaign/:list/:subscription/:link', (req, res) => {
let notFound = () => {
res.status(404);
return res.render('archive/view', {
layout: 'archive/layout',
message: 'Oops, we couldn\'t find a link for the URL you clicked',
campaign: {
subject: 'Error 404'
}
});
};
links.resolve(req.params.link, (err, linkId, url) => {
if (err) {
req.flash('danger', err.message || err);
return res.redirect('/');
}
if (!linkId || !url) {
log.error('Redirect', 'Unresolved URL: <%s>', req.url);
return notFound();
}
links.countClick(req.ip, req.params.campaign, req.params.list, req.params.subscription, linkId, (err, status) => {
if (err) {
log.error('Redirect', err.stack || err);
@ -58,9 +74,8 @@ router.get('/:campaign/:list/:subscription/:link', (req, res, next) => {
}
if (!list) {
err = new Error('Not Found');
err.status = 404;
return next(err);
log.error('Redirect', 'Could not resolve list for merge tags: <%s>', req.url);
return notFound();
}
settings.get('serviceUrl', (err, serviceUrl) => {
@ -76,9 +91,8 @@ router.get('/:campaign/:list/:subscription/:link', (req, res, next) => {
}
if (!subscription) {
err = new Error('Not Found');
err.status = 404;
return next(err);
log.error('Redirect', 'Could not resolve subscription for merge tags: <%s>', req.url);
return notFound();
}
url = tools.formatMessage(serviceUrl, {

26
routes/lists.js
View file

@ -1,5 +1,6 @@
'use strict';
let config = require('config');
let openpgp = require('openpgp');
let passport = require('../lib/passport');
let express = require('express');
@ -13,9 +14,30 @@ let htmlescape = require('escape-html');
let multer = require('multer');
let os = require('os');
let humanize = require('humanize');
let uploads = multer({
dest: os.tmpdir()
let mkdirp = require('mkdirp');
let pathlib = require('path');
let log = require('npmlog');
let uploadStorage = multer.diskStorage({
destination: (req, file, callback) => {
log.verbose('tmpdir', os.tmpdir());
let tmp = config.www.tmpdir || os.tmpdir();
let dir = pathlib.join(tmp, 'mailtrain');
mkdirp(dir, err => {
if (err) {
log.error('Upload', err);
log.verbose('Upload', 'Storing upload to <%s>', tmp);
return callback(null, tmp);
}
log.verbose('Upload', 'Storing upload to <%s>', dir);
callback(null, dir);
});
}
});
let uploads = multer({
storage: uploadStorage
});
let csvparse = require('csv-parse');
let fs = require('fs');
let moment = require('moment-timezone');

87
routes/settings.js
View file

@ -11,7 +11,7 @@ let url = require('url');
let settings = require('../lib/models/settings');
let allowedKeys = ['service_url', 'smtp_hostname', 'smtp_port', 'smtp_encryption', 'smtp_disable_auth', 'smtp_user', 'smtp_pass', 'admin_email', 'smtp_log', 'smtp_max_connections', 'smtp_max_messages', 'smtp_self_signed', 'default_from', 'default_address', 'default_subject', 'default_homepage', 'default_postaddress', 'default_sender', 'verp_hostname', 'verp_use', 'disable_wysiwyg', 'pgp_private_key', 'pgp_passphrase', 'ua_code'];
let allowedKeys = ['service_url', 'smtp_hostname', 'smtp_port', 'smtp_encryption', 'smtp_disable_auth', 'smtp_user', 'smtp_pass', 'admin_email', 'smtp_log', 'smtp_max_connections', 'smtp_max_messages', 'smtp_self_signed', 'default_from', 'default_address', 'default_subject', 'default_homepage', 'default_postaddress', 'default_sender', 'verp_hostname', 'verp_use', 'disable_wysiwyg', 'pgp_private_key', 'pgp_passphrase', 'ua_code', 'shoutout'];
router.all('/*', (req, res, next) => {
if (!req.user) {
@ -57,58 +57,51 @@ router.post('/update', passport.parseForm, passport.csrfProtection, (req, res) =
let data = tools.convertKeys(req.body);
tools.validateEmail(data.adminEmail, false, err => {
if (err) {
req.flash('danger', err && err.message || err);
let keys = [];
let values = [];
Object.keys(data).forEach(key => {
let value = data[key].trim();
key = tools.toDbKey(key);
// ensure trailing slash for service home page
if (key === 'service_url' && value && !/\/$/.test(value)) {
value = value + '/';
}
if (allowedKeys.indexOf(key) >= 0) {
keys.push(key);
values.push(value);
}
});
// checkboxs are not included in value listing if left unchecked
['smtp_log', 'smtp_self_signed', 'smtp_disable_auth', 'verp_use', 'disable_wysiwyg'].forEach(key => {
if (keys.indexOf(key) < 0) {
keys.push(key);
values.push('');
}
});
let i = 0;
let storeSettings = () => {
if (i >= keys.length) {
mailer.update();
req.flash('success', 'Settings updated');
return res.redirect('/settings');
}
let key = keys[i];
let value = values[i];
i++;
let keys = [];
let values = [];
Object.keys(data).forEach(key => {
let value = data[key].trim();
key = tools.toDbKey(key);
// ensure trailing slash for service home page
if (key === 'service_url' && value && !/\/$/.test(value)) {
value = value + '/';
}
if (allowedKeys.indexOf(key) >= 0) {
keys.push(key);
values.push(value);
}
});
// checkboxs are not included in value listing if left unchecked
['smtp_log', 'smtp_self_signed', 'smtp_disable_auth', 'verp_use', 'disable_wysiwyg'].forEach(key => {
if (keys.indexOf(key) < 0) {
keys.push(key);
values.push('');
}
});
let i = 0;
let storeSettings = () => {
if (i >= keys.length) {
mailer.update();
req.flash('success', 'Settings updated');
settings.set(key, value, err => {
if (err) {
req.flash('danger', err && err.message || err);
return res.redirect('/settings');
}
let key = keys[i];
let value = values[i];
i++;
storeSettings();
});
};
settings.set(key, value, err => {
if (err) {
req.flash('danger', err && err.message || err);
return res.redirect('/settings');
}
storeSettings();
});
};
storeSettings();
});
storeSettings();
});
router.post('/smtp-verify', passport.parseForm, passport.csrfProtection, (req, res) => {

235
routes/triggers.js Normal file
View file

@ -0,0 +1,235 @@
'use strict';
let express = require('express');
let router = new express.Router();
let triggers = require('../lib/models/triggers');
let campaigns = require('../lib/models/campaigns');
let lists = require('../lib/models/lists');
let fields = require('../lib/models/fields');
let striptags = require('striptags');
let passport = require('../lib/passport');
let tools = require('../lib/tools');
router.all('/*', (req, res, next) => {
if (!req.user) {
req.flash('danger', 'Need to be logged in to access restricted content');
return res.redirect('/users/login?next=' + encodeURIComponent(req.originalUrl));
}
res.setSelectedMenu('triggers');
next();
});
router.get('/', (req, res) => {
triggers.list((err, rows) => {
if (err) {
req.flash('danger', err.message || err);
return res.redirect('/');
}
res.render('triggers/triggers', {
rows: rows.map((row, i) => {
row.index = i + 1;
row.description = striptags(row.description);
return row;
})
});
});
});
router.get('/create-select', passport.csrfProtection, (req, res, next) => {
let data = tools.convertKeys(req.query, {
skip: ['layout']
});
data.csrfToken = req.csrfToken();
lists.quicklist((err, listItems) => {
if (err) {
return next(err);
}
data.listItems = listItems;
res.render('triggers/create-select', data);
});
});
router.post('/create-select', passport.parseForm, passport.csrfProtection, (req, res) => {
if (!req.body.list) {
req.flash('danger', 'Could not find selected list');
return res.redirect('/triggers/create-select');
}
res.redirect('/triggers/' + encodeURIComponent(req.body.list) + '/create');
});
router.get('/:listId/create', passport.csrfProtection, (req, res, next) => {
let data = tools.convertKeys(req.query, {
skip: ['layout']
});
data.csrfToken = req.csrfToken();
data.days = Math.max(Number(data.days) || 1, 1);
lists.get(req.params.listId, (err, list) => {
if (err || !list) {
req.flash('danger', err && err.message || err || 'Could not find selected list');
return res.redirect('/triggers/create-select');
}
fields.list(list.id, (err, fieldList) => {
if (err && !fieldList) {
fieldList = [];
}
data.columns = triggers.defaultColumns.concat(fieldList.filter(field => fields.genericTypes[field.type] === 'date')).map(field => ({
column: field.column,
name: field.name,
selected: data.column === field.column
}));
campaigns.list(0, 300, (err, campaignList) => {
if (err) {
return next(err);
}
data.sourceCampaigns = (campaignList || []).filter(campaign => campaign.list === list.id).map(campaign => ({
id: campaign.id,
name: campaign.name,
selected: Number(data.sourceCampaign) === campaign.id
}));
data.destCampaigns = (campaignList || []).filter(campaign => campaign.list === list.id && campaign.type === 4).map(campaign => ({
id: campaign.id,
name: campaign.name,
selected: Number(data.destCampaign) === campaign.id
}));
data.list = list;
data.isSubscription = data.rule === 'subscription' || !data.rule;
data.isCampaign = data.rule === 'campaign';
data.campaignOptions = triggers.defaultCampaignEvents.map(evt => ({
option: evt.option,
name: evt.name,
selected: Number(data.sourceCampaign) === evt.option
}));
data.isSend = true;
res.render('triggers/create', data);
});
});
});
});
router.post('/create', passport.parseForm, passport.csrfProtection, (req, res) => {
triggers.create(req.body, (err, id) => {
if (err || !id) {
req.flash('danger', err && err.message || err || 'Could not create trigger');
if (req.body.list) {
return res.redirect('/triggers/' + encodeURIComponent(req.body.list) + '/create?' + tools.queryParams(req.body));
} else {
return res.redirect('/triggers');
}
}
req.flash('success', 'Trigger “' + req.body.name + '” created');
res.redirect('/triggers');
});
});
router.get('/edit/:id', passport.csrfProtection, (req, res, next) => {
triggers.get(req.params.id, (err, trigger) => {
if (err || !trigger) {
req.flash('danger', err && err.message || err || 'Could not find campaign with specified ID');
return res.redirect('/campaigns');
}
trigger.csrfToken = req.csrfToken();
trigger.days = Math.round(trigger.seconds / (24 * 3600));
lists.get(trigger.list, (err, list) => {
if (err || !list) {
req.flash('danger', err && err.message || err || 'Could not find selected list');
return res.redirect('/triggers');
}
fields.list(list.id, (err, fieldList) => {
if (err && !fieldList) {
fieldList = [];
}
campaigns.list(0, 300, (err, campaignList) => {
if (err) {
return next(err);
}
trigger.sourceCampaigns = (campaignList || []).filter(campaign => campaign.list === list.id).map(campaign => ({
id: campaign.id,
name: campaign.name,
selected: Number(trigger.sourceCampaign) === campaign.id
}));
trigger.destCampaigns = (campaignList || []).filter(campaign => campaign.list === list.id && campaign.type === 4).map(campaign => ({
id: campaign.id,
name: campaign.name,
selected: Number(trigger.destCampaign) === campaign.id
}));
trigger.list = list;
trigger.isSubscription = trigger.rule === 'subscription' || !trigger.rule;
trigger.isCampaign = trigger.rule === 'campaign';
trigger.columns = triggers.defaultColumns.concat(fieldList.filter(field => fields.genericTypes[field.type] === 'date')).map(field => ({
column: field.column,
name: field.name,
selected: trigger.isSubscription && trigger.column === field.column
}));
trigger.campaignOptions = triggers.defaultCampaignEvents.map(evt => ({
option: evt.option,
name: evt.name,
selected: trigger.isCampaign && trigger.column === evt.option
}));
if (trigger.rule !== 'subscription') {
trigger.column = null;
}
trigger.isSend = true;
res.render('triggers/edit', trigger);
});
});
});
});
});
router.post('/edit', passport.parseForm, passport.csrfProtection, (req, res) => {
triggers.update(req.body.id, req.body, (err, updated) => {
if (err) {
req.flash('danger', err.message || err);
return res.redirect('/triggers/edit/' + encodeURIComponent(req.body.id));
} else if (updated) {
req.flash('success', 'Trigger settings updated');
} else {
req.flash('info', 'Trigger settings not updated');
}
return res.redirect('/triggers');
});
});
router.post('/delete', passport.parseForm, passport.csrfProtection, (req, res) => {
triggers.delete(req.body.id, (err, deleted) => {
if (err) {
req.flash('danger', err && err.message || err);
} else if (deleted) {
req.flash('success', 'Trigger deleted');
} else {
req.flash('info', 'Could not delete specified trigger');
}
return res.redirect('/triggers');
});
});
module.exports = router;