New project structure

Beta of extract.js for extracting english locale

server/lib/tools.js

@@ -0,0 +1,193 @@
+'use strict';
+
+const util = require('util');
+const isemail = require('isemail');
+const path = require('path');
+const {getPublicUrl} = require('./urls');
+
+const bluebird = require('bluebird');
+
+const hasher = require('node-object-hash')();
+
+const mjml = require('mjml');
+const mjml2html = mjml.default;
+
+const hbs = require('hbs');
+const juice = require('juice');
+const he = require('he');
+
+const fs = require('fs-extra');
+
+const { JSDOM } = require('jsdom');
+const { tUI, tLog } = require('./translate');
+
+
+const templates = new Map();
+
+async function getTemplate(template) {
+    if (!template) {
+        return false;
+    }
+
+    const key = (typeof template === 'object') ? hasher.hash(template) : template;
+
+    if (templates.has(key)) {
+        return templates.get(key);
+    }
+
+    let source;
+    if (typeof template === 'object') {
+        source = await mergeTemplateIntoLayout(template.template, template.layout);
+    } else {
+        source = await fs.readFile(path.join(__dirname, '..', 'views', template), 'utf-8');
+    }
+
+    if (template.type === 'mjml') {
+        const compiled = mjml2html(source);
+
+        if (compiled.errors.length) {
+            throw new Error(compiled.errors[0].message || compiled.errors[0]);
+        }
+
+        source = compiled.html;
+    }
+
+    const renderer = hbs.handlebars.compile(source);
+    templates.set(key, renderer);
+
+    return renderer;
+}
+
+
+async function mergeTemplateIntoLayout(template, layout) {
+    layout = layout || '{{{body}}}';
+
+    async function readFile(relPath) {
+        return await fs.readFile(path.join(__dirname, '..', 'views', relPath), 'utf-8');
+    }
+
+    // Please dont end your custom messages with .hbs ...
+    if (layout.endsWith('.hbs')) {
+        layout = await readFile(layout);
+    }
+
+    if (template.endsWith('.hbs')) {
+        template = await readFile(template);
+    }
+
+    const source = layout.replace(/\{\{\{body\}\}\}/g, template);
+    return source;
+}
+
+async function validateEmail(address) {
+    const result = await new Promise(resolve => {
+        const result = isemail.validate(address, {
+            checkDNS: true,
+            errorLevel: 1
+        }, resolve);
+    });
+
+    return result;
+}
+
+function validateEmailGetMessage(result, address, language) {
+    let t;
+    if (language) {
+        t = (key, args) => tUI(key, language, args);
+    } else {
+        t = (key, args) => tLog(key, args);
+    }
+
+    if (result !== 0) {
+        switch (result) {
+            case 5:
+                return t('addressCheck.mxNotFound', {email: address});
+            case 6:
+                return t('addressCheck.domainNotFound', {email: address});
+            case 12:
+                return t('addressCheck.domainRequired', {email: address});
+            default:
+                return t('invalidEmailGeneric', {email: address});
+        }
+    }
+}
+
+function formatMessage(campaign, list, subscription, mergeTags, message, isHTML) {
+    const links = getMessageLinks(campaign, list, subscription);
+
+    const getValue = key => {
+        key = (key || '').toString().toUpperCase().trim();
+        if (links.hasOwnProperty(key)) {
+            return links[key];
+        }
+        if (mergeTags.hasOwnProperty(key)) {
+            const value = (mergeTags[key] || '').toString();
+            const containsHTML = /<[a-z][\s\S]*>/.test(value);
+            return isHTML ? he.encode((containsHTML ? value : value.replace(/(?:\r\n|\r|\n)/g, '<br/>')), {
+                useNamedReferences: true,
+                allowUnsafeSymbols: true
+            }) : (containsHTML ? htmlToText.fromString(value) : value);
+        }
+        return false;
+    };
+
+    return message.replace(/\[([a-z0-9_]+)(?:\/([^\]]+))?\]/ig, (match, identifier, fallback) => {
+        let value = getValue(identifier);
+        if (value === false) {
+            return match;
+        }
+        value = (value || fallback || '').trim();
+        return value;
+    });
+}
+
+async function prepareHtml(html) {
+    if (!(html || '').toString().trim()) {
+        return false;
+    }
+
+    const { window } = new JSDOM(html);
+
+    const head = window.document.querySelector('head');
+    let hasCharsetTag = false;
+    const metaTags = window.document.querySelectorAll('meta');
+    if (metaTags) {
+        for (let i = 0; i < metaTags.length; i++) {
+            if (metaTags[i].hasAttribute('charset')) {
+                metaTags[i].setAttribute('charset', 'utf-8');
+                hasCharsetTag = true;
+                break;
+            }
+        }
+    }
+    if (!hasCharsetTag) {
+        const charsetTag = window.document.createElement('meta');
+        charsetTag.setAttribute('charset', 'utf-8');
+        head.appendChild(charsetTag);
+    }
+    const preparedHtml = '<!doctype html><html>' + window.document.documentElement.innerHTML + '</html>';
+
+    return juice(preparedHtml);
+}
+
+function getMessageLinks(campaign, list, subscription) {
+    return {
+        LINK_UNSUBSCRIBE: getPublicUrl('/subscription/' + list.cid + '/unsubscribe/' + subscription.cid + '?c=' + campaign.cid),
+        LINK_PREFERENCES: getPublicUrl('/subscription/' + list.cid + '/manage/' + subscription.cid),
+        LINK_BROWSER: getPublicUrl('/archive/' + campaign.cid + '/' + list.cid + '/' + subscription.cid),
+        CAMPAIGN_ID: campaign.cid,
+        LIST_ID: list.cid,
+        SUBSCRIPTION_ID: subscription.cid
+    };
+}
+
+module.exports = {
+    validateEmail,
+    validateEmailGetMessage,
+    mergeTemplateIntoLayout,
+    getTemplate,
+    prepareHtml,
+    getMessageLinks,
+    formatMessage
+};
+