mailtrain/routes/campaigns.js

'use strict';

let express = require('express');
let router = new express.Router();
let lists = require('../lib/models/lists');
let fields = require('../lib/models/fields');
let templates = require('../lib/models/templates');
let campaigns = require('../lib/models/campaigns');
let settings = require('../lib/models/settings');
let tools = require('../lib/tools');
let striptags = require('striptags');
let passport = require('../lib/passport');
let htmlescape = require('escape-html');

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('campaigns');
    next();
});

router.get('/', (req, res) => {
    res.render('campaigns/campaigns', {
        title: 'Campaigns'
    });
});

router.get('/create', passport.csrfProtection, (req, res) => {
    let data = tools.convertKeys(req.query, {
        skip: ['layout']
    });

    if (/^\d+:\d+$/.test(data.list)) {
        data.segment = Number(data.list.split(':').pop());
        data.list = Number(data.list.split(':').shift());
    }

    settings.list(['defaultFrom', 'defaultAddress', 'defaultSubject'], (err, configItems) => {
        if (err) {
            req.flash('danger', err.message || err);
            return res.redirect('/');
        }

        lists.quicklist((err, listItems) => {
            if (err) {
                req.flash('danger', err.message || err);
                return res.redirect('/');
            }

            if (Number(data.list)) {
                listItems.forEach(list => {
                    list.segments.forEach(segment => {
                        if (segment.id === data.segment) {
                            segment.selected = true;
                        }
                    });
                    if (list.id === data.list && !data.segment) {
                        list.selected = true;
                    }
                });
            }

            templates.quicklist((err, templateItems) => {
                if (err) {
                    req.flash('danger', err.message || err);
                    return res.redirect('/');
                }

                if (Number(data.template)) {
                    templateItems.forEach(item => {
                        if (item.id === Number(data.template)) {
                            item.selected = true;
                        }
                    });
                }

                data.csrfToken = req.csrfToken();
                data.listItems = listItems;
                data.templateItems = templateItems;

                data.from = data.from || configItems.defaultFrom;
                data.address = data.address || configItems.defaultAddress;
                data.subject = data.subject || configItems.defaultSubject;

                let view;
                switch (req.query.type) {
                    case 'rss':
                        view = 'campaigns/create-rss';
                        break;
                    default:
                        view = 'campaigns/create';
                }
                res.render(view, data);
            });
        });
    });
});

router.post('/create', passport.parseForm, passport.csrfProtection, (req, res) => {
    campaigns.create(req.body, false, (err, id) => {
        if (err || !id) {
            req.flash('danger', err && err.message || err || 'Could not create campaign');
            return res.redirect('/campaigns/create?' + tools.queryParams(req.body));
        }
        req.flash('success', 'Campaign “' + req.body.name + '” created');
        res.redirect('/campaigns/view/' + id);
    });
});

router.get('/edit/:id', passport.csrfProtection, (req, res, next) => {
    campaigns.get(req.params.id, false, (err, campaign) => {
        if (err || !campaign) {
            req.flash('danger', err && err.message || err || 'Could not find campaign with specified ID');
            return res.redirect('/campaigns');
        }

        settings.list(['disableWysiwyg'], (err, configItems) => {
            if (err) {
                return next(err);
            }

            lists.quicklist((err, listItems) => {
                if (err) {
                    req.flash('danger', err.message || err);
                    return res.redirect('/');
                }

                if (Number(campaign.list)) {
                    listItems.forEach(list => {
                        list.segments.forEach(segment => {
                            if (segment.id === campaign.segment) {
                                segment.selected = true;
                            }
                        });
                        if (list.id === campaign.list && !campaign.segment) {
                            list.selected = true;
                        }
                    });
                }

                campaign.csrfToken = req.csrfToken();
                campaign.listItems = listItems;
                campaign.useEditor = true;

                campaign.disableWysiwyg = configItems.disableWysiwyg;
                campaign.showGeneral = req.query.tab === 'general' || !req.query.tab;
                campaign.showTemplate = req.query.tab === 'template';

                let view;
                switch (campaign.type) {
                    case 2: //rss
                        view = 'campaigns/edit-rss';
                        break;
                    case 1:
                    default:
                        view = 'campaigns/edit';
                }

                lists.get(campaign.list, (err, list) => {
                    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);
                    });
                });
            });
        });
    });
});

router.post('/edit', passport.parseForm, passport.csrfProtection, (req, res) => {
    campaigns.update(req.body.id, req.body, (err, updated) => {
        if (err) {
            req.flash('danger', err.message || err);
        } else if (updated) {
            req.flash('success', 'Campaign settings updated');
        } else {
            req.flash('info', 'Campaign settings not updated');
        }

        if (req.body.id) {
            return res.redirect('/campaigns/view/' + encodeURIComponent(req.body.id));
        } else {
            return res.redirect('/campaigns');
        }
    });
});

router.post('/delete', passport.parseForm, passport.csrfProtection, (req, res) => {
    campaigns.delete(req.body.id, (err, deleted) => {
        if (err) {
            req.flash('danger', err && err.message || err);
        } else if (deleted) {
            req.flash('success', 'Campaign deleted');
        } else {
            req.flash('info', 'Could not delete specified campaign');
        }

        return res.redirect('/campaigns');
    });
});

router.post('/ajax', (req, res) => {
    campaigns.filter(req.body, Number(req.query.parent) || false, (err, data, total, filteredTotal) => {
        if (err) {
            return res.json({
                error: err.message || err,
                data: []
            });
        }

        let getStatusText = data => {
            switch (data.status) {
                case 1:
                    return 'Idling';
                case 2:
                    if (data.scheduled && data.scheduled > new Date()) {
                        return 'Scheduled';
                    }
                    return 'Sending';
                case 3:
                    return 'Finished';
                case 4:
                    return 'Paused';
                case 5:
                    return 'Inactive';
                case 6:
                    return 'Active';
            }
            return 'Other';
        };

        res.json({
            draw: req.body.draw,
            recordsTotal: total,
            recordsFiltered: filteredTotal,
            data: data.map((row, i) => [
                (Number(req.body.start) || 0) + 1 + i,
                '<span class="glyphicon glyphicon-inbox" aria-hidden="true"></span> <a href="/campaigns/view/' + row.id + '">' + htmlescape(row.name || '') + '</a>',
                htmlescape(striptags(row.description) || ''),
                getStatusText(row),
                '<span class="datestring" data-date="' + row.created.toISOString() + '" title="' + row.created.toISOString() + '">' + row.created.toISOString() + '</span>'
            ].concat('<span class="glyphicon glyphicon-wrench" aria-hidden="true"></span><a href="/campaigns/edit/' + row.id + '">Edit</a>'))
        });
    });
});

router.get('/view/:id', passport.csrfProtection, (req, res) => {
    campaigns.get(req.params.id, true, (err, campaign) => {
        if (err || !campaign) {
            req.flash('danger', err && err.message || err || 'Could not find campaign with specified ID');
            return res.redirect('/campaigns');
        }

        lists.get(campaign.list, (err, list) => {
            if (err || !campaign) {
                req.flash('danger', err && err.message || err);
                return res.redirect('/campaigns');
            }

            campaign.csrfToken = req.csrfToken();
            campaign.list = list;

            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) * 100) : 0;
            campaign.clicksRate = campaign.delivered ? Math.round((campaign.clicks / campaign.delivered) * 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) + '…';
                    }
                    return link;
                });
                campaign.showOverview = !req.query.tab || req.query.tab === 'overview';
                campaign.showLinks = req.query.tab === 'links';
                res.render('campaigns/view', campaign);
            });

        });
    });
});

router.get('/clicked/:id/:linkId', passport.csrfProtection, (req, res) => {
    campaigns.get(req.params.id, true, (err, campaign) => {
        if (err || !campaign) {
            req.flash('danger', err && err.message || err || 'Could not find campaign with specified ID');
            return res.redirect('/campaigns');
        }

        lists.get(campaign.list, (err, list) => {
            if (err || !campaign) {
                req.flash('danger', err && err.message || err);
                return res.redirect('/campaigns');
            }

            campaign.csrfToken = req.csrfToken();
            campaign.list = list;

            // show only messages that weren't bounced as delivered
            campaign.delivered = campaign.delivered - campaign.bounced;

            campaigns.getLinks(campaign.id, req.params.linkId, (err, links) => {
                if (err) {
                    // ignore
                }
                let index = 0;
                campaign.link = (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;
                }).shift();
                campaign.showOverview = true;
                res.render('campaigns/clicked', campaign);
            });

        });
    });
});

router.post('/clicked/ajax/:id/:linkId', (req, res) => {
    let linkId = Number(req.params.linkId) || 0;

    campaigns.get(req.params.id, true, (err, campaign) => {
        if (err || !campaign) {
            return res.json({
                error: err && err.message || err || 'Campaign not found',
                data: []
            });
        }

        let columns = ['#', 'email', 'first_name', 'last_name', 'campaign_tracker__' + campaign.id + '`.`created', 'count'];
        campaigns.filterClickedSubscribers(campaign, linkId, req.body, columns, (err, data, total, filteredTotal) => {
            if (err) {
                return res.json({
                    error: err.message || err,
                    data: []
                });
            }

            res.json({
                draw: req.body.draw,
                recordsTotal: total,
                recordsFiltered: filteredTotal,
                data: data.map((row, i) => [
                    (Number(req.body.start) || 0) + 1 + i,
                    htmlescape(row.email || ''),
                    htmlescape(row.firstName || ''),
                    htmlescape(row.lastName || ''),
                    row.created && row.created.toISOString ? '<span class="datestring" data-date="' + row.created.toISOString() + '" title="' + row.created.toISOString() + '">' + row.created.toISOString() + '</span>' : 'N/A',
                    row.count,
                    '<span class="glyphicon glyphicon-wrench" aria-hidden="true"></span><a href="/lists/subscription/' + campaign.list + '/edit/' + row.cid + '">Edit</a>'
                ])
            });
        });
    });
});

router.post('/delete', passport.parseForm, passport.csrfProtection, (req, res) => {
    campaigns.delete(req.body.id, (err, deleted) => {
        if (err) {
            req.flash('danger', err && err.message || err);
        } else if (deleted) {
            req.flash('success', 'Campaign deleted');
        } else {
            req.flash('info', 'Could not delete specified campaign');
        }

        return res.redirect('/campaigns');
    });
});

router.post('/send', passport.parseForm, passport.csrfProtection, (req, res) => {
    let delayHours = Math.max(Number(req.body['delay-hours']) || 0, 0);
    let delayMinutes = Math.max(Number(req.body['delay-minutes']) || 0, 0);
    let scheduled = new Date(Date.now() + delayHours * 3600 * 1000 + delayMinutes * 60 * 1000);

    campaigns.send(req.body.id, scheduled, (err, scheduled) => {
        if (err) {
            req.flash('danger', err && err.message || err);
        } else if (scheduled) {
            req.flash('success', 'Scheduled sending');
        } else {
            req.flash('info', 'Could not schedule sending');
        }

        return res.redirect('/campaigns/view/' + encodeURIComponent(req.body.id));
    });
});

router.post('/resume', passport.parseForm, passport.csrfProtection, (req, res) => {
    campaigns.send(req.body.id, false, (err, scheduled) => {
        if (err) {
            req.flash('danger', err && err.message || err);
        } else if (scheduled) {
            req.flash('success', 'Sending resumed');
        } else {
            req.flash('info', 'Could not resume sending');
        }

        return res.redirect('/campaigns/view/' + encodeURIComponent(req.body.id));
    });
});

router.post('/reset', passport.parseForm, passport.csrfProtection, (req, res) => {
    campaigns.reset(req.body.id, (err, reset) => {
        if (err) {
            req.flash('danger', err && err.message || err);
        } else if (reset) {
            req.flash('success', 'Sending reset');
        } else {
            req.flash('info', 'Could not reset sending');
        }

        return res.redirect('/campaigns/view/' + encodeURIComponent(req.body.id));
    });
});

router.post('/pause', passport.parseForm, passport.csrfProtection, (req, res) => {
    campaigns.pause(req.body.id, (err, reset) => {
        if (err) {
            req.flash('danger', err && err.message || err);
        } else if (reset) {
            req.flash('success', 'Sending paused');
        } else {
            req.flash('info', 'Could not pause sending');
        }

        return res.redirect('/campaigns/view/' + encodeURIComponent(req.body.id));
    });
});

router.post('/activate', passport.parseForm, passport.csrfProtection, (req, res) => {
    campaigns.activate(req.body.id, (err, reset) => {
        if (err) {
            req.flash('danger', err && err.message || err);
        } else if (reset) {
            req.flash('success', 'Sending activated');
        } else {
            req.flash('info', 'Could not activate sending');
        }

        return res.redirect('/campaigns/view/' + encodeURIComponent(req.body.id));
    });
});

router.post('/inactivate', passport.parseForm, passport.csrfProtection, (req, res) => {
    campaigns.inactivate(req.body.id, (err, reset) => {
        if (err) {
            req.flash('danger', err && err.message || err);
        } else if (reset) {
            req.flash('success', 'Sending paused');
        } else {
            req.flash('info', 'Could not pause sending');
        }

        return res.redirect('/campaigns/view/' + encodeURIComponent(req.body.id));
    });
});

module.exports = router;