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

Merge pull request #203 from larrabee/blacklist

Browse source 
Add blacklist function
This commit is contained in:
Andris Reinman 2017-04-13 10:13:25 +03:00 committed by GitHub
commit d143a52cfd
14 changed files with 486 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
app.js
View file

@ -36,6 +36,7 @@ let webhooks = require('./routes/webhooks');
let subscription = require('./routes/subscription');
let archive = require('./routes/archive');
let api = require('./routes/api');
let blacklist = require('./routes/blacklist');
let editorapi = require('./routes/editorapi');
let grapejs = require('./routes/grapejs');
let mosaico = require('./routes/mosaico');
@ -207,6 +208,7 @@ app.use('/lists', lists);
app.use('/templates', templates);
app.use('/campaigns', campaigns);
app.use('/settings', settings);
app.use('/blacklist', blacklist);
app.use('/links', links);
app.use('/fields', fields);
app.use('/forms', forms);

86
lib/models/blacklist.js Normal file
View file

@ -0,0 +1,86 @@
'use strict';
let db = require('../db');
module.exports.get = (start, limit, search, callback) => {
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
search = '%' + search + '%';
connection.query('SELECT SQL_CALC_FOUND_ROWS `email` FROM blacklist WHERE `email` LIKE ? ORDER BY `email` LIMIT ? OFFSET ?', [search, limit, start], (err, rows) => {
if (err) {
return callback(err);
}
connection.query('SELECT FOUND_ROWS() AS total', (err, total) => {
connection.release();
if (err) {
return callback(err);
}
let emails = [];
rows.forEach(email => {
emails.push(email.email);
});
return callback(null, emails, total && total[0] && total[0].total);
});
});
});
};
module.exports.add = (email, callback) => {
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
connection.query('INSERT IGNORE INTO `blacklist` (`email`) VALUES(?)', email, err => {
if (err) {
return callback(err);
}
connection.release();
return callback(null, null);
});
});
};
module.exports.delete = (email, callback) => {
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
connection.query('DELETE FROM `blacklist` WHERE `email`=?', email, err => {
if (err) {
return callback(err);
}
connection.release();
return callback(null, null);
});
});
};
module.exports.isblacklisted = (email, callback) => {
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
connection.query('SELECT `email` FROM blacklist WHERE `email`=?', email, (err, rows) => {
if (err) {
return callback(err);
}
connection.release();
if (rows.length > 0) {
return callback(null, true);
} else {
return callback(null, false);
}
});
});
};

2
meta.json
View file

@ -1,3 +1,3 @@
{
"schemaVersion": 24
"schemaVersion": 25
}

80
routes/api.js
View file

@ -3,6 +3,7 @@
let users = require('../lib/models/users');
let lists = require('../lib/models/lists');
let fields = require('../lib/models/fields');
let blacklist = require('../lib/models/blacklist');
let subscriptions = require('../lib/models/subscriptions');
let tools = require('../lib/tools');
let express = require('express');
@ -326,4 +327,83 @@ router.post('/field/:listId', (req, res) => {
});
});
router.post('/blacklist/add', (req, res) => {
let input = {};
Object.keys(req.body).forEach(key => {
input[(key || '').toString().trim().toUpperCase()] = (req.body[key] || '').toString().trim();
});
if (!(input.EMAIL) || (input.EMAIL === '')) {
res.status(500);
return res.json({
error: 'EMAIL argument are required',
data: []
});
}
blacklist.add(input.EMAIL, (err) =>{
if (err) {
res.status(500);
return res.json({
error: err.message || err,
data: []
});
}
res.status(200);
res.json({
data: []
});
});
});
router.post('/blacklist/delete', (req, res) => {
let input = {};
Object.keys(req.body).forEach(key => {
input[(key || '').toString().trim().toUpperCase()] = (req.body[key] || '').toString().trim();
});
if (!(input.EMAIL) || (input.EMAIL === '')) {
res.status(500);
return res.json({
error: 'EMAIL argument are required',
data: []
});
}
blacklist.delete(input.EMAIL, (err) =>{
if (err) {
res.status(500);
return res.json({
error: err.message || err,
data: []
});
}
res.status(200);
res.json({
data: []
});
});
});
router.get('/blacklist/get', (req, res) => {
let start = parseInt(req.query.start || 0, 10);
let limit = parseInt(req.query.limit || 10000, 10);
let search = req.query.search || '';
blacklist.get(start, limit, search, (err, data, total) => {
if (err) {
res.status(500);
return res.json({
error: err.message || err,
data: []
});
}
res.status(200);
res.json({
data: {
total: total,
start: start,
limit: limit,
emails: data
}
});
});
});
module.exports = router;

68
routes/blacklist.js Normal file
View file

@ -0,0 +1,68 @@
'use strict';
let express = require('express');
let router = new express.Router();
let passport = require('../lib/passport');
let htmlescape = require('escape-html');
let blacklist = require('../lib/models/blacklist');
let tools = require('../lib/tools');
let helpers = require('../lib/helpers');
let _ = require('../lib/translate')._;
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('blacklist');
next();
});
router.get('/', passport.csrfProtection, (req, res) => {
res.render('blacklist', {csrfToken: req.csrfToken()});
});
router.post('/ajax/', (req, res) => {
let start = parseInt(req.body.start || 0, 10);
let limit = parseInt(req.body.length || 50, 10);
let search = req.body.search.value || '';
blacklist.get(start, limit, search, (err, data, total) => {
if (err) {
req.flash('danger', err.message || err);
return res.redirect('/');
}
res.json({
draw: req.body.draw,
recordsTotal: total,
recordsFiltered: total,
data: data.map((row, i) => [
(Number(req.body.start) || 0) + 1 + i,
htmlescape(row),
'<button class="btn btn-danger btn-sm" onclick="document.getElementById(\'delete-email-input\').value = \'' + row + '\'; document.getElementById(\'delete-email-form\').submit();">Delete</button>'
])
});
});
});
router.post('/ajax/add', passport.csrfProtection, (req, res) => {
let email = req.body.email;
blacklist.add(email, (err) => {
if (err) {
req.flash('danger', err.message || err);
return res.redirect(req.body.next);
}
return res.redirect(req.body.next)
});
});
router.post('/ajax/delete', passport.csrfProtection, (req, res) => {
let email = req.body.email;
blacklist.delete(email, (err) => {
if (err) {
req.flash('danger', err.message || err);
return res.redirect(req.body.next);
}
return res.redirect(req.body.next);
});
});
module.exports = router;

3
routes/campaigns.js
View file

@ -425,6 +425,9 @@ router.get('/status/:id/:status', passport.csrfProtection, (req, res) => {
case 'complained':
status = 4;
break;
case 'blacklisted':
status = 5;
break;
default:
req.flash('danger', _('Unknown status selector'));
return res.redirect('/campaigns');

34
services/sender.js
View file

@ -8,6 +8,7 @@ let mailer = require('../lib/mailer');
let campaigns = require('../lib/models/campaigns');
let segments = require('../lib/models/segments');
let lists = require('../lib/models/lists');
let blacklist = require('../lib/models/blacklist');
let fields = require('../lib/models/fields');
let settings = require('../lib/models/settings');
let links = require('../lib/models/links');
@ -491,6 +492,13 @@ let sendLoop = () => {
return;
}
blacklist.isblacklisted(mail.to.address, (err, blacklisted) => {
if (err) {
log.error('Mail', err);
setTimeout(getNext, mailing_timeout);
return;
}
if (!blacklisted) {
let tryCount = 0;
let trySend = () => {
tryCount++;
@ -538,6 +546,32 @@ let sendLoop = () => {
};
setImmediate(trySend);
setImmediate(() => mailer.transport.checkThrottling(getNext));
} else {
db.getConnection((err, connection) => {
if (err) {
log.error('Mail', err);
return;
}
let query = 'UPDATE `campaigns` SET `blacklisted`=`blacklisted`+1 WHERE id=? LIMIT 1';
connection.query(query, [message.campaignId], err => {
if (err) {
log.error('Mail', err);
}
let query = 'UPDATE `campaign__' + message.campaignId + '` SET status=?, response=?, response_id=?, updated=NOW() WHERE id=? LIMIT 1';
connection.query(query, [5, 'blacklisted', 'blacklisted', message.id], err => {
connection.release();
if (err) {
log.error('Mail', err);
}
});
});
});
}
});
});
});
};

17
setup/sql/upgrade-00025.sql Normal file
View file

@ -0,0 +1,17 @@
# Header section
# Define incrementing schema version number
SET @schema_version = '25';
# Create table to store global blacklist
CREATE TABLE `blacklist` (
`email` varchar(255) NOT NULL,
PRIMARY KEY (`email`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
#Alter table campaigns
ALTER TABLE `campaigns` ADD COLUMN `blacklisted` int(11) unsigned NOT NULL DEFAULT '0' AFTER `delivered`;
# Footer section
LOCK TABLES `settings` WRITE;
INSERT INTO `settings` (`key`, `value`) VALUES('db_schema_version', @schema_version) ON DUPLICATE KEY UPDATE `value`=@schema_version;
UNLOCK TABLES;

38
views/blacklist.hbs Normal file
View file

@ -0,0 +1,38 @@
<ol class="breadcrumb">
<li><a href="/">{{#translate}}Home{{/translate}}</a></li>
<li class="active">{{#translate}}Blacklist{{/translate}}</li>
</ol>
<h2>{{#translate}}Blacklist{{/translate}}</h2>
<form class="form-horizontal" method="post" action="/blacklist/ajax/add">
<input type="hidden" name="_csrf" value="{{csrfToken}}">
<input type="hidden" name="next" value="/blacklist">
<div class="col-sm-4">
<input type="text" class="form-control input-md" name="email" id="add-email-input" value="" placeholder="{{#translate}}Add email to blacklist{{/translate}}">
</div>
<button type="submit" class="btn btn-success"><span class="glyphicon glyphicon-plus" aria-hidden="true"></span>{{#translate}}Add{{/translate}}</button>
</form>
<form class="form-horizontal" id="delete-email-form" method="post" action="/blacklist/ajax/delete">
<input type="hidden" name="_csrf" value="{{csrfToken}}">
<input type="hidden" name="next" value="/blacklist">
<input type="hidden" name="email" id="delete-email-input" value="">
</form>
<hr>
<div class="table-responsive">
<table data-topic-url="/blacklist" data-sort-column="1" data-sort-order="desc" class="table table-bordered table-hover data-table-ajax display nowrap" width="100%" data-row-sort="0,1,0">
<thead>
<th class="col-md-1">
#
</th>
<th>
{{#translate}}Email{{/translate}}
</th>
<th class="col-md-1">
&nbsp;
</th>
</thead>
</table>
</div>

54
views/campaigns/blacklisted.hbs Normal file
View file

@ -0,0 +1,54 @@
<ol class="breadcrumb">
<li><a href="/">{{#translate}}Home{{/translate}}</a></li>
<li><a href="/campaigns">{{#translate}}Campaigns{{/translate}}</a></li>
{{#if parent}}
<li><a href="/campaigns/view/{{parent.id}}">{{parent.name}}</a></li>
{{/if}}
<li><a href="/campaigns/view/{{id}}">{{name}}</a></li>
<li class="active">{{#translate}}Blacklisted info{{/translate}}</li>
</ol>
<h2><span class="glyphicon glyphicon-inbox" aria-hidden="true"></span> {{name}} <small>{{#translate}}Blacklisted info{{/translate}}</small> <a class="btn btn-default btn-xs" href="/campaigns/view/{{id}}?tab=overview" role="button"><span class="glyphicon glyphicon-arrow-left" aria-hidden="true"></span> {{#translate}}View campaign{{/translate}}</a></h2>
<hr>
{{#if description}}
<div class="well well-sm">{{{description}}}</div>
{{/if}}
<div class="table-responsive">
<div class="panel panel-info">
<!-- Default panel contents -->
<div class="panel-heading">{{#translate}}Subscribers who blacklisted by global blacklist:{{/translate}}</div>
<div class="panel-body">
<div class="table-responsive">
<table data-topic-url="/campaigns/status" data-topic-id="{{id}}/5" data-sort-column="1" data-sort-order="asc" class="table table-bordered table-hover data-table-ajax display nowrap" width="100%" data-row-sort="0,1,1,1,0,1,0">
<thead>
<tr>
<th class="col-md-1">
#
</th>
<th>
{{#translate}}Address{{/translate}}
</th>
<th>
{{#translate}}First Name{{/translate}}
</th>
<th>
{{#translate}}Last Name{{/translate}}
</th>
<th>
{{#translate}}Reason{{/translate}}
</th>
<th>
{{#translate}}Time{{/translate}}
</th>
<th></th>
</tr>
</thead>
</table>
</div>
</div>
</div>
</div>

7
views/campaigns/view.hbs
View file

@ -130,6 +130,13 @@
</div>
</dd>
<dt>{{#translate}}Blacklisted{{/translate}} <a href="/campaigns/status/{{id}}/blacklisted" title="{{#translate}}List subscribers who blacklisted by global blacklist{{/translate}}"><span class="glyphicon glyphicon-zoom-in" aria-hidden="true"></span></a></dt>
<dd>
<div style="margin-bottom: 20px;">
{{blacklisted}}
</div>
</dd>
<dt>{{#translate}}Bounced{{/translate}} <a href="/campaigns/status/{{id}}/bounced" title="{{#translate}}List subscribers who bounced{{/translate}}"><span class="glyphicon glyphicon-zoom-in" aria-hidden="true"></span></a></dt>
<dd>
<div class="progress">

5
views/layout.hbs
View file

@ -82,6 +82,11 @@
<span class="glyphicon glyphicon-cog" aria-hidden="true"></span> {{#translate}}Settings{{/translate}}
</a>
</li>
<li>
<a href="/blacklist">
<span class="glyphicon glyphicon-ban-circle" aria-hidden="true"></span> {{#translate}}Blacklist{{/translate}}
</a>
</li>
<li>
<a href="/users/api">
<span class="glyphicon glyphicon-retweet" aria-hidden="true"></span> {{#translate}}API{{/translate}}

7
views/lists/subscription/edit.hbs
View file

@ -17,6 +17,12 @@
<input type="hidden" name="cid" value="{{cid}}">
</form>
<form method="post" id="subscriber-blacklist" action="/blacklist/ajax/add">
<input type="hidden" name="_csrf" value="{{csrfToken}}">
<input type="hidden" name="email" value="{{email}}">
<input type="hidden" name="next" value="/lists/view/{{list.id}}">
</form>
<form method="post" class="delete-form" id="subscriber-delete" action="/lists/subscription/delete">
<input type="hidden" name="_csrf" value="{{csrfToken}}">
<input type="hidden" name="list" value="{{list.id}}">
@ -166,6 +172,7 @@
<div class="form-group">
<div class="col-sm-offset-2 col-sm-10">
<div class="pull-right">
<button type="submit" form="subscriber-blacklist" class="btn btn-danger"><span class="glyphicon glyphicon-ban-circle"></span>{{#translate}}Blacklist{{/translate}}</button>
{{#if isSubscribed}}
<button type="submit" form="subscriber-unsubscribe" class="btn btn-default"><i class="glyphicon glyphicon-ban-circle"></i> {{#translate}}Unsubscribe{{/translate}}</button>
{{/if}}

71
views/users/api.hbs
View file

@ -142,10 +142,32 @@
<pre>curl -XPOST {{serviceUrl}}api/delete/B16uVTdW?access_token={{accessToken}} \
--data 'EMAIL=test@example.com'</pre>
<h3>POST /api/field/:listId – {{#translate}}Add new custom field{{/translate}}</h3>
<h3>GET /api/blacklist/get – {{#translate}}Get list of blacklisted emails{{/translate}}</h3>
<p>
{{#translate}}This API call creates a new custom field for a list.{{/translate}}
{{#translate}}This API call get list of blacklisted emails.{{/translate}}
</p>
<p>
<strong>GET</strong> {{#translate}}arguments{{/translate}}
</p>
<ul>
<li><strong>access_token</strong> – {{#translate}}your personal access token{{/translate}}
<li><strong>start</strong> – {{#translate}}Start position{{/translate}} (<em>{{#translate}}optional, default 0{{/translate}}</em>)</li>
<li><strong>limit</strong> – {{#translate}}limit emails count in response{{/translate}} (<em>{{#translate}}optional, default 10000{{/translate}}</em>)</li>
<li><strong>search</strong> – {{#translate}}filter by part of email{{/translate}} (<em>{{#translate}}optional, default ''{{/translate}}</em>)</li>
</ul>
<p>
<strong>{{#translate}}Example{{/translate}}</strong>
</p>
<pre>curl -XGET '{{serviceUrl}}api/blacklist/get?access_token={{accessToken}}&limit=10&start=10&search=gmail' </pre>
<h3>POST /api/blacklist/add – {{#translate}}Add email to blacklist{{/translate}}</h3>
<p>
{{#translate}}This API call either add emails to blacklist{{/translate}}
</p>
<p>
@ -159,24 +181,39 @@
<strong>POST</strong> {{#translate}}arguments{{/translate}}
</p>
<ul>
<li><strong>NAME</strong> – {{#translate}}field name{{/translate}} (<em>{{#translate}}required{{/translate}}</em>)</li>
<li><strong>TYPE</strong> – {{#translate}}one of the following types:{{/translate}}
<ul>
{{#each allowedTypes}}
<li>
<strong>{{type}}</strong> {{description}}
</li>
{{/each}}
</ul>
</li>
<li><strong>GROUP</strong> – {{#translate}}If the type is 'option' then you also need to specify the parent element ID{{/translate}}</li>
<li><strong>GROUP_TEMPLATE</strong> – {{#translate}}Template for the group element. If not set, then values of the elements are joined with commas{{/translate}}</li>
<li><strong>VISIBLE</strong> – yes/no, {{#translate}}if not visible then the subscriber can not view or modify this value at the profile page{{/translate}}</li>
<li><strong>EMAIL</strong> – {{#translate}}email address{{/translate}} (<em>{{#translate}}required{{/translate}}</em>)</li>
</ul>
<p>
<strong>{{#translate}}Example{{/translate}}</strong>
</p>
<pre>curl -XPOST {{serviceUrl}}api/field/B16uVTdW?access_token={{accessToken}} \
--data 'NAME=Birthday&amp;TYPE=birthday-us&amp;VISIBLE=yes'</pre>
<pre>curl -XPOST '{{serviceUrl}}api/blacklist/add?access_token={{accessToken}}' \
--data 'EMAIL=test@example.com&amp;'</pre>
<h3>POST /api/blacklist/delete – {{#translate}}Delete email from blacklist{{/translate}}</h3>
<p>
{{#translate}}This API call either delete emails from blacklist{{/translate}}
</p>
<p>
<strong>GET</strong> {{#translate}}arguments{{/translate}}
</p>
<ul>
<li><strong>access_token</strong> – {{#translate}}your personal access token{{/translate}}
</ul>
<p>
<strong>POST</strong> {{#translate}}arguments{{/translate}}
</p>
<ul>
<li><strong>EMAIL</strong> – {{#translate}}email address{{/translate}} (<em>{{#translate}}required{{/translate}}</em>)</li>
</ul>
<p>
<strong>{{#translate}}Example{{/translate}}</strong>
</p>
<pre>curl -XPOST '{{serviceUrl}}api/blacklist/delete?access_token={{accessToken}}' \
--data 'EMAIL=test@example.com&amp;'</pre>