Added initial support for trigger based automation

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

View file

@ -21,7 +21,7 @@ module.exports.list = (start, limit, callback) => {
return callback(err);
}
connection.query('SELECT SQL_CALC_FOUND_ROWS * FROM campaigns ORDER BY name LIMIT ? OFFSET ?', [limit, start], (err, rows) => {
connection.query('SELECT SQL_CALC_FOUND_ROWS * FROM campaigns ORDER BY scheduled DESC LIMIT ? OFFSET ?', [limit, start], (err, rows) => {
if (err) {
connection.release();
return callback(err);
@ -122,8 +122,8 @@ module.exports.filter = (request, parent, callback) => {
processQuery({
// only find normal and RSS parent campaigns at this point
where: '`type` IN (?,?)',
values: [1, 2]
where: '`type` IN (?,?,?)',
values: [1, 2, 4]
});
}
};
@ -428,6 +428,9 @@ module.exports.create = (campaign, opts, callback) => {
}
switch ((campaign.type || '').toString().trim().toLowerCase()) {
case 'triggered':
campaign.type = 4;
break;
case 'rss':
campaign.type = 2;
break;
@ -453,13 +456,26 @@ module.exports.create = (campaign, opts, callback) => {
return callback(new Error('RSS URL must be set and needs to be a valid URL'));
}
lists.get(campaign.list, (err, list) => {
let getList = (listId, callback) => {
if (campaign.type === 4) {
return callback(null, false);
}
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 => {
if (err) {
return callback(err);
}
if (!list) {
return callback(new Error('Selected list not found'));
}
let keys = ['name', 'type'];
let values = [name, campaign.type];
@ -474,6 +490,11 @@ module.exports.create = (campaign, opts, callback) => {
values.push(2, opts.parent);
}
if (campaign.type === 4) {
keys.push('status');
values.push(6); // active
}
let create = next => {
Object.keys(campaign).forEach(key => {
let value = typeof campaign[key] === 'number' ? campaign[key] : (campaign[key] || '').toString().trim();
@ -623,13 +644,22 @@ module.exports.update = (id, updates, callback) => {
campaign.segment = 0;
}
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'));
}
return callback(null, list);
});
};
getList(campaign.list, err => {
if (err) {
return callback(err);
}
if (!list) {
return callback(new Error('Selected list not found'));
}
let keys = ['name'];
let values = [name];
@ -728,27 +758,19 @@ module.exports.delete = (id, callback) => {
}
connection.query('DELETE FROM campaigns WHERE id=? LIMIT 1', [id], (err, result) => {
connection.release();
if (err) {
connection.release();
return callback(err);
}
let affected = result && result.affectedRows || 0;
connection.query('DELETE FROM links WHERE campaign=?', [id], err => {
connection.release();
removeCampaignTables(id, err => {
if (err) {
return callback(err);
}
removeCampaignTables(id, err => {
if (err) {
return callback(err);
}
caches.cache.delete('sender queue');
return callback(null, affected);
});
caches.cache.delete('sender queue');
return callback(null, affected);
});
});
});
@ -841,7 +863,7 @@ module.exports.reset = (id, callback) => {
}
caches.cache.delete('sender queue');
connection.query('DELETE FROM links WHERE campaign=?', [id], err => {
connection.query('UPDATE links SET `clicks`=0 WHERE campaign=?', [id], err => {
if (err) {
connection.release();
return callback(err);

View file

@ -11,32 +11,25 @@ let lists = require('./lists');
let log = require('npmlog');
let urllib = require('url');
let he = require('he');
module.exports.resolve = (campaignCid, linkCid, callback) => {
campaigns.getByCid(campaignCid, (err, campaign) => {
module.exports.resolve = (linkCid, callback) => {
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
if (!campaign) {
return callback('Campaign not found');
}
db.getConnection((err, connection) => {
let query = 'SELECT id, url FROM links WHERE `cid`=? LIMIT 1';
connection.query(query, [linkCid], (err, rows) => {
connection.release();
if (err) {
return callback(err);
}
let query = 'SELECT id, url FROM links WHERE `campaign`=? AND `cid`=? LIMIT 1';
connection.query(query, [campaign.id, linkCid], (err, rows) => {
connection.release();
if (err) {
return callback(err);
}
if (rows && rows.length) {
return callback(null, rows[0].id, rows[0].url);
}
if (rows && rows.length) {
return callback(null, rows[0].id, rows[0].url);
}
return callback(null, false);
});
return callback(null, false);
});
});
};
@ -46,6 +39,9 @@ module.exports.countClick = (remoteIp, campaignCid, listCid, subscriptionCid, li
if (err) {
return callback(err);
}
if(!data){
return callback(null, false);
}
db.getConnection((err, connection) => {
if (err) {
return callback(err);
@ -295,7 +291,9 @@ module.exports.updateLinks = (campaign, list, subscription, serviceUrl, message,
return replaceUrls();
}
module.exports.add(urlItem.value, campaign.id, (err, linkId, cid) => {
module.exports.add(he.decode(urlItem.value, {
isAttributeValue: true
}), campaign.id, (err, linkId, cid) => {
if (err) {
log.error('Link', err.stack);
return storeNext();

369
lib/models/triggers.js Normal file
View file

@ -0,0 +1,369 @@
'use strict';
let tools = require('../tools');
let db = require('../db');
let lists = require('./lists');
let util = require('util');
module.exports.defaultColumns = [{
column: 'created',
name: 'Sign up date',
type: 'date'
}, {
column: 'latest_open',
name: 'Latest open',
type: 'date'
}, {
column: 'latest_click',
name: 'Latest click',
type: 'date'
}];
module.exports.defaultCampaignEvents = [{
option: 'delivered',
name: 'Delivered'
}, {
option: 'opened',
name: 'Has Opened'
}, {
option: 'clicked',
name: 'Has Clicked'
}, {
option: 'not_opened',
name: 'Not Opened'
}, {
option: 'not_clicked',
name: 'Not Clicked'
}];
let defaultColumnMap = {};
let defaultEventMap = {};
module.exports.defaultColumns.forEach(col => defaultColumnMap[col.column] = col.name);
module.exports.defaultCampaignEvents.forEach(evt => defaultEventMap[evt.option] = evt.name);
module.exports.list = callback => {
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
let tableFields = [
'`triggers`.`id` AS `id`',
'`triggers`.`name` AS `name`',
'`triggers`.`description` AS `description`',
'`triggers`.`enabled` AS `enabled`',
'`triggers`.`list` AS `list`',
'`lists`.`name` AS `list_name`',
'`source`.`id` AS `source_campaign`',
'`source`.`name` AS `source_campaign_name`',
'`dest`.`id` AS `dest_campaign`',
'`dest`.`name` AS `dest_campaign_name`',
'`custom_fields`.`id` AS `column_id`',
'`triggers`.`column` AS `column`',
'`custom_fields`.`name` AS `column_name`',
'`triggers`.`rule` AS `rule`',
'`triggers`.`seconds` AS `seconds`',
'`triggers`.`created` AS `created`'
];
let query = 'SELECT ' + tableFields.join(', ') + ' FROM `triggers` LEFT JOIN `campaigns` `source` ON `source`.`id`=`triggers`.`source_campaign` LEFT JOIN `campaigns` `dest` ON `dest`.`id`=`triggers`.`dest_campaign` LEFT JOIN `lists` ON `lists`.`id`=`triggers`.`list` LEFT JOIN `custom_fields` ON `custom_fields`.`list` = `triggers`.`list` AND `custom_fields`.`column`=`triggers`.`column` ORDER BY `triggers`.`name`';
connection.query(query, (err, rows) => {
connection.release();
if (err) {
return callback(err);
}
let triggers = (rows || []).map(tools.convertKeys).map(row => {
if (row.rule === 'subscription' && row.column && !row.columnName) {
row.columnName = defaultColumnMap[row.column];
}
let days = Math.round(row.seconds / (24 * 3600));
row.formatted = util.format('%s days after %s', days, row.rule === 'subscription' ? row.columnName : (util.format('%s <a href="/campaigns/view/%s">%s</a>', defaultEventMap[row.column], row.sourceCampaign, row.sourceCampaignName)));
return row;
});
return callback(null, triggers);
});
});
};
module.exports.getQuery = (id, callback) => {
module.exports.get(id, (err, trigger) => {
if (err) {
return callback(err);
}
let limit = 300;
let treshold = 3600 * 24; // time..NOW..time+24h
let intervalQuery = (column, seconds, treshold) => column + ' <= NOW() - INTERVAL ' + seconds + ' SECOND AND ' + column + ' >= NOW() - INTERVAL ' + (treshold + seconds) + ' SECOND';
let query = false;
switch (trigger.rule) {
case 'subscription':
query = 'SELECT id FROM `subscription__' + trigger.list + '` subscription WHERE ' + intervalQuery('`' + trigger.column + '`', trigger.seconds, treshold) + ' AND id NOT IN (SELECT subscription FROM `trigger__' + id + '` triggertable WHERE triggertable.`list` = ' + trigger.list + ' AND triggertable.`subscription` = subscription.`id`) LIMIT ' + limit;
break;
case 'campaign':
switch (trigger.column) {
case 'delivered':
query = 'SELECT subscription.id AS id FROM `subscription__' + trigger.list + '` subscription LEFT JOIN `campaign__' + trigger.sourceCampaign + '` campaign ON campaign.list=' + trigger.list + ' AND subscription.id=campaign.subscription WHERE campaign.status=1 AND ' + intervalQuery('`campaign`.`created`', trigger.seconds, treshold) + ' AND subscription.id NOT IN (SELECT subscription FROM `trigger__' + id + '` triggertable WHERE triggertable.`list` = ' + trigger.list + ' AND triggertable.`subscription` = subscription.`id`) LIMIT ' + limit;
break;
case 'not_clicked':
query = 'SELECT subscription.id AS id FROM `subscription__' + trigger.list + '` subscription LEFT JOIN `campaign__' + trigger.sourceCampaign + '` campaign ON campaign.list=' + trigger.list + ' AND subscription.id=campaign.subscription LEFT JOIN `campaign_tracker__' + trigger.sourceCampaign + '` tracker ON tracker.list=campaign.list AND tracker.subscriber=subscription.id AND tracker.link=0 WHERE campaign.status=1 AND ' + intervalQuery('`campaign`.`created`', trigger.seconds, treshold) + ' AND tracker.created IS NULL AND subscription.id NOT IN (SELECT subscription FROM `trigger__' + id + '` triggertable WHERE triggertable.`list` = ' + trigger.list + ' AND triggertable.`subscription` = subscription.`id`) LIMIT ' + limit;
break;
case 'not_opened':
query = 'SELECT subscription.id AS id FROM `subscription__' + trigger.list + '` subscription LEFT JOIN `campaign__' + trigger.sourceCampaign + '` campaign ON campaign.list=' + trigger.list + ' AND subscription.id=campaign.subscription LEFT JOIN `campaign_tracker__' + trigger.sourceCampaign + '` tracker ON tracker.list=campaign.list AND tracker.subscriber=subscription.id AND tracker.link=-1 WHERE campaign.status=1 AND ' + intervalQuery('`campaign`.`created`', trigger.seconds, treshold) + ' AND tracker.created IS NULL AND subscription.id NOT IN (SELECT subscription FROM `trigger__' + id + '` triggertable WHERE triggertable.`list` = ' + trigger.list + ' AND triggertable.`subscription` = subscription.`id`) LIMIT ' + limit;
break;
case 'clicked':
query = 'SELECT subscription.id AS id FROM `subscription__' + trigger.list + '` subscription LEFT JOIN `campaign__' + trigger.sourceCampaign + '` campaign ON campaign.list=' + trigger.list + ' AND subscription.id=campaign.subscription LEFT JOIN `campaign_tracker__' + trigger.sourceCampaign + '` tracker ON tracker.list=campaign.list AND tracker.subscriber=subscription.id AND tracker.link=0 WHERE campaign.status=1 AND ' + intervalQuery('`tracker`.`created`', trigger.seconds, treshold) + ' AND subscription.id NOT IN (SELECT subscription FROM `trigger__' + id + '` triggertable WHERE triggertable.`list` = ' + trigger.list + ' AND triggertable.`subscription` = subscription.`id`) LIMIT ' + limit;
break;
case 'opened':
query = 'SELECT subscription.id AS id FROM `subscription__' + trigger.list + '` subscription LEFT JOIN `campaign__' + trigger.sourceCampaign + '` campaign ON campaign.list=' + trigger.list + ' AND subscription.id=campaign.subscription LEFT JOIN `campaign_tracker__' + trigger.sourceCampaign + '` tracker ON tracker.list=campaign.list AND tracker.subscriber=subscription.id AND tracker.link=-1 WHERE campaign.status=1 AND ' + intervalQuery('`tracker`.`created`', trigger.seconds, treshold) + ' AND subscription.id NOT IN (SELECT subscription FROM `trigger__' + id + '` triggertable WHERE triggertable.`list` = ' + trigger.list + ' AND triggertable.`subscription` = subscription.`id`) LIMIT ' + limit;
break;
}
break;
}
callback(null, query);
});
};
module.exports.get = (id, callback) => {
id = Number(id) || 0;
if (id < 1) {
return callback(new Error('Missing Trigger ID'));
}
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
connection.query('SELECT * FROM triggers WHERE id=?', [id], (err, rows) => {
connection.release();
if (err) {
return callback(err);
}
if (!rows || !rows.length) {
return callback(null, false);
}
let trigger = tools.convertKeys(rows[0]);
return callback(null, trigger);
});
});
};
module.exports.create = (trigger, callback) => {
trigger = tools.convertKeys(trigger);
let name = (trigger.name || '').toString().trim();
let description = (trigger.description || '').toString().trim();
let listId = Number(trigger.list) || 0;
let seconds = (Number(trigger.days) || 0) * 24 * 3600;
let rule = (trigger.rule || '').toString().toLowerCase().trim();
let destCampaign = Number(trigger.destCampaign) || 0;
let sourceCampaign = null;
let column;
if (!listId) {
return callback(new Error('Missing or invalid list ID'));
}
if (seconds < 0) {
return callback(new Error('Days in the past are not allowed'));
}
if (!rule || ['campaign', 'subscription'].indexOf(rule) < 0) {
return callback(new Error('Missing or invalid trigger rule'));
}
switch (rule) {
case 'subscription':
column = (trigger.column || '').toString().toLowerCase().trim();
if (!column) {
return callback(new Error('Invalid subscription configuration'));
}
break;
case 'campaign':
column = (trigger.campaignOption || '').toString().toLowerCase().trim();
sourceCampaign = Number(trigger.sourceCampaign) || 0;
if (!column || !sourceCampaign) {
return callback(new Error('Invalid campaign configuration'));
}
if (sourceCampaign === destCampaign) {
return callback(new Error('A campaing can not be a target for itself'));
}
break;
default:
return callback(new Error('Missing or invalid trigger rule'));
}
lists.get(listId, (err, list) => {
if (err) {
return callback(err);
}
if (!list) {
return callback(new Error('Missing or invalid list ID'));
}
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
let keys = ['name', 'description', 'list', 'source_campaign', 'rule', 'column', 'seconds', 'dest_campaign', 'last_check'];
let values = [name, description, list.id, sourceCampaign, rule, column, seconds, destCampaign];
let query = 'INSERT INTO `triggers` (`' + keys.join('`, `') + '`) VALUES (' + values.map(() => '?').join(', ') + ', NOW())';
connection.query(query, values, (err, result) => {
connection.release();
if (err) {
return callback(err);
}
let id = result && result.insertId;
if (!id) {
return callback(new Error('Could not store trigger row'));
}
createTriggerTable(id, err => {
if (err) {
return callback(err);
}
return callback(null, id);
});
});
});
});
};
module.exports.update = (id, trigger, callback) => {
id = Number(id) || 0;
if (id < 1) {
return callback(new Error('Missing or invalid Trigger ID'));
}
trigger = tools.convertKeys(trigger);
let name = (trigger.name || '').toString().trim();
let description = (trigger.description || '').toString().trim();
let enabled = trigger.enabled ? 1 : 0;
let seconds = (Number(trigger.days) || 0) * 24 * 3600;
let rule = (trigger.rule || '').toString().toLowerCase().trim();
let destCampaign = Number(trigger.destCampaign) || 0;
let sourceCampaign = null;
let column;
if (seconds < 0) {
return callback(new Error('Days in the past are not allowed'));
}
if (!rule || ['campaign', 'subscription'].indexOf(rule) < 0) {
return callback(new Error('Missing or invalid trigger rule'));
}
switch (rule) {
case 'subscription':
column = (trigger.column || '').toString().toLowerCase().trim();
if (!column) {
return callback(new Error('Invalid subscription configuration'));
}
break;
case 'campaign':
column = (trigger.campaignOption || '').toString().toLowerCase().trim();
sourceCampaign = Number(trigger.sourceCampaign) || 0;
if (!column || !sourceCampaign) {
return callback(new Error('Invalid campaign configuration'));
}
if (sourceCampaign === destCampaign) {
return callback(new Error('A campaing can not be a target for itself'));
}
break;
default:
return callback(new Error('Missing or invalid trigger rule'));
}
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
let keys = ['name', 'description', 'enabled', 'source_campaign', 'rule', 'column', 'seconds', 'dest_campaign'];
let values = [name, description, enabled, sourceCampaign, rule, column, seconds, destCampaign];
let query = 'UPDATE `triggers` SET ' + keys.map(key => '`' + key + '`=?').join(', ') + ' WHERE `id`=? LIMIT 1';
connection.query(query, values.concat(id), (err, result) => {
connection.release();
if (err) {
return callback(err);
}
return callback(null, result && result.affectedRows);
});
});
};
module.exports.delete = (id, callback) => {
id = Number(id) || 0;
if (id < 1) {
return callback(new Error('Missing Trigger ID'));
}
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
connection.query('DELETE FROM triggers WHERE id=? LIMIT 1', [id], (err, result) => {
if (err) {
connection.release();
return callback(err);
}
let affected = result && result.affectedRows || 0;
removeTriggerTable(id, err => {
if (err) {
return callback(err);
}
return callback(null, affected);
});
});
});
};
function createTriggerTable(id, callback) {
let query = 'CREATE TABLE `trigger__' + id + '` LIKE `trigger`';
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
connection.query(query, err => {
connection.release();
if (err) {
return callback(err);
}
return callback(null, true);
});
});
}
function removeTriggerTable(id, callback) {
let query = 'DROP TABLE IF EXISTS `trigger__' + id + '`';
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
connection.query(query, err => {
connection.release();
if (err) {
return callback(err);
}
return callback(null, true);
});
});
}