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

Custom Forms

Browse source
This commit is contained in:
witzig 2017-03-19 13:36:57 +01:00
parent 5332c81739
commit 2e50fbc8ae
67 changed files with 3335 additions and 34834 deletions
Download patch file Download diff file Expand all files Collapse all files

5
lib/models/fields.js
View file

@ -405,6 +405,7 @@ module.exports.getRow = (fieldList, values, useDate, showAll, onlyExisting) => {
case 'longtext':
{
let item = {
id: field.id,
type: field.type,
name: field.name,
column: field.column,
@ -434,6 +435,7 @@ module.exports.getRow = (fieldList, values, useDate, showAll, onlyExisting) => {
}
let item = {
id: field.id,
type: field.type,
name: field.name,
column: field.column,
@ -449,6 +451,7 @@ module.exports.getRow = (fieldList, values, useDate, showAll, onlyExisting) => {
case 'number':
{
let item = {
id: field.id,
type: field.type,
name: field.name,
column: field.column,
@ -466,6 +469,7 @@ module.exports.getRow = (fieldList, values, useDate, showAll, onlyExisting) => {
case 'checkbox':
{
let item = {
id: field.id,
type: field.type,
name: field.name,
visible: !!field.visible,
@ -556,6 +560,7 @@ module.exports.getRow = (fieldList, values, useDate, showAll, onlyExisting) => {
}
let item = {
id: field.id,
type: field.type,
name: field.name,
column: field.column,

283
lib/models/forms.js Normal file
View file

@ -0,0 +1,283 @@
'use strict';
let db = require('../db');
let fs = require('fs');
let path = require('path');
let tools = require('../tools');
let mjml = require('mjml');
let _ = require('../translate')._;
let allowedKeys = [
'name',
'description',
'fields_shown_on_subscribe',
'fields_shown_on_manage',
'layout',
'form_input_style',
'mail_confirm_html',
'mail_confirm_text',
'mail_subscription_confirmed_html',
'mail_subscription_confirmed_text',
'mail_unsubscribe_confirmed_html',
'mail_unsubscribe_confirmed_text',
'web_confirm_notice',
'web_manage_address',
'web_manage',
'web_subscribe',
'web_subscribed',
'web_unsubscribe_notice',
'web_unsubscribe',
'web_updated_notice'
];
module.exports.list = (listId, callback) => {
listId = Number(listId) || 0;
if (listId < 1) {
return callback(new Error(_('Missing List ID')));
}
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
let query = 'SELECT * FROM custom_forms WHERE list=? ORDER BY id';
connection.query(query, [listId], (err, rows) => {
connection.release();
if (err) {
return callback(err);
}
let formList = rows && rows.map(row => tools.convertKeys(row)) || [];
return callback(null, formList);
});
});
};
module.exports.get = (id, callback) => {
id = Number(id) || 0;
if (id < 1) {
return callback(new Error(_('Missing Form ID')));
}
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
let query = 'SELECT * FROM custom_forms WHERE id=? LIMIT 1';
connection.query(query, [id], (err, rows) => {
connection.release();
if (err) {
return callback(err);
}
let form = rows && rows[0] && tools.convertKeys(rows[0]) || false;
return callback(null, form);
});
});
};
module.exports.create = (listId, form, callback) => {
listId = Number(listId) || 0;
if (listId < 1) {
return callback(new Error(_('Missing Form ID')));
}
form = tools.convertKeys(form);
form = setDefaultValues(form);
form.name = (form.name || '').toString().trim();
if (!form.name) {
return callback(new Error(_('Form Name must be set')));
}
let keys = ['list'];
let values = [listId];
Object.keys(form).forEach(key => {
let value = form[key].trim();
key = tools.toDbKey(key);
if (allowedKeys.indexOf(key) >= 0) {
keys.push(key);
values.push(value);
}
});
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
let query = 'INSERT INTO custom_forms (' + keys.join(', ') + ') VALUES (' + values.map(() => '?').join(',') + ')';
connection.query(query, values, (err, result) => {
connection.release();
if (err) {
return callback(err);
}
let formId = result && result.insertId || false;
return callback(null, formId);
});
});
};
module.exports.update = (id, updates, callback) => {
updates = updates || {};
id = Number(id) || 0;
updates = tools.convertKeys(updates);
if (id < 1) {
return callback(new Error(_('Missing Form ID')));
}
if (!(updates.name || '').toString().trim()) {
return callback(new Error(_('Form Name must be set')));
}
let keys = [];
let values = [];
Object.keys(updates).forEach(key => {
let value = typeof updates[key] === 'string' ? updates[key].trim() : updates[key];
key = tools.toDbKey(key);
if (allowedKeys.indexOf(key) >= 0) {
keys.push(key);
values.push(value);
}
});
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
values.push(id);
connection.query('UPDATE custom_forms SET ' + keys.map(key => '`' + key + '`=?').join(', ') + ' WHERE id=? LIMIT 1', values, (err, result) => {
connection.release();
if (err) {
return callback(err);
}
// Save then validate, as otherwise their work get's lost ...
err = testForMjmlErrors(keys, values);
if (err) {
return callback(err);
}
return callback(null, result && result.affectedRows || false);
});
});
};
module.exports.delete = (formId, callback) => {
formId = Number(formId) || 0;
if (formId < 1) {
return callback(new Error(_('Missing Form ID')));
}
db.getConnection((err, connection) => {
if (err) {
return callback(err);
}
let query = 'SELECT * FROM custom_forms WHERE id=? LIMIT 1';
connection.query(query, [formId], (err, rows) => {
if (err) {
connection.release();
return callback(err);
}
if (!rows || !rows.length) {
connection.release();
return callback(new Error(_('Custom form not found')));
}
connection.query('DELETE FROM custom_forms WHERE id=? LIMIT 1', [formId], err => {
if (err) {
connection.release();
return callback(err);
}
return callback(null, true);
});
});
});
};
function setDefaultValues(form) {
let getContents = fileName => {
try {
let basePath = path.join(__dirname, '..', '..');
let template = fs.readFileSync(path.join(basePath, fileName), 'utf8');
return template.replace(/\{\{#translate\}\}(.*?)\{\{\/translate\}\}/g, (m, s) => _(s));
} catch (err) {
return false;
}
};
allowedKeys.forEach(key => {
let modelKey = tools.fromDbKey(key);
let base = 'views/subscription/' + key.replace(/_/g, '-');
if (key.startsWith('mail') || key.startsWith('web')) {
form[modelKey] = getContents(base + '.mjml.hbs') || getContents(base + '.hbs') || '';
}
});
form.layout = getContents('views/subscription/layout.mjml.hbs') || '';
form.formInputStyle = getContents('public/subscription/form-input-style.css') || '@import url(/subscription/form-input-style.css);';
return form;
}
function testForMjmlErrors(keys, values) {
let testLayout = '<mjml><mj-body><mj-container>{{{body}}}</mj-container></mj-body></mjml>';
let isInvalidMjml = (template, layout = testLayout) => {
let source = layout.replace(/\{\{\{body\}\}\}/g, template);
let compiled;
try {
compiled = mjml.mjml2html(source);
} catch (err) {
return err;
}
if (compiled.errors.length) {
return compiled.errors[0].message || compiled.errors[0];
}
return null;
};
let errors = [];
keys.forEach((key, index) => {
if (key.startsWith('mail_') || key.startsWith('web_')) {
let template = values[index];
let err = isInvalidMjml(template);
err && errors.push(key + ': ' + (err.message || err));
if (key === 'mail_confirm_html' && !template.includes('{{confirmUrl}}')) {
errors.push(key + ': Missing {{confirmUrl}}');
}
} else if (key === 'layout') {
let layout = values[index];
let err = isInvalidMjml('', layout);
err && errors.push('layout: ' + (err.message || err));
!layout.includes('{{{body}}}') && errors.push('layout: {{{body}}} not found');
}
});
if (errors.length) {
errors.forEach((err, index) => {
errors[index] = (index + 1) + ') ' + err;
});
return 'Please Fix These Errors:\n\n' + errors.join('\n');
}
return null;
}

2
lib/models/lists.js
View file

@ -6,7 +6,7 @@ let shortid = require('shortid');
let segments = require('./segments');
let _ = require('../translate')._;
let allowedKeys = ['description'];
let allowedKeys = ['description', 'default_form'];
module.exports.list = (start, limit, callback) => {
db.getConnection((err, connection) => {

67
lib/models/subscriptions.js
View file

@ -3,6 +3,7 @@
let db = require('../db');
let shortid = require('shortid');
let tools = require('../tools');
let helpers = require('../helpers');
let fields = require('./fields');
let geoip = require('geoip-ultralight');
let segments = require('./segments');
@ -210,7 +211,7 @@ module.exports.addConfirmation = (list, email, optInIp, data, callback) => {
}
});
settings.list(['defaultHomepage', 'defaultFrom', 'defaultAddress', 'serviceUrl'], (err, configItems) => {
settings.list(['defaultHomepage', 'defaultFrom', 'defaultAddress', 'defaultPostaddress', 'serviceUrl'], (err, configItems) => {
if (err) {
return callback(err);
}
@ -221,35 +222,55 @@ module.exports.addConfirmation = (list, email, optInIp, data, callback) => {
return;
}
mailer.sendMail({
from: {
name: configItems.defaultFrom,
address: configItems.defaultAddress
},
to: {
name: [].concat(data.firstName || []).concat(data.lastName || []).join(' '),
address: email
},
subject: util.format(_('%s: Please Confirm Subscription'), list.name),
encryptionKeys
}, {
html: 'emails/confirm-html.hbs',
text: 'emails/confirm-text.hbs',
data: {
title: list.name,
contactAddress: configItems.defaultAddress,
confirmUrl: urllib.resolve(configItems.serviceUrl, '/subscription/subscribe/' + cid)
}
}, err => {
let sendMail = (html, text) => {
mailer.sendMail({
from: {
name: configItems.defaultFrom,
address: configItems.defaultAddress
},
to: {
name: [].concat(data.firstName || []).concat(data.lastName || []).join(' '),
address: email
},
subject: util.format(_('%s: Please Confirm Subscription'), list.name),
encryptionKeys
}, {
html,
text,
data: {
title: list.name,
contactAddress: configItems.defaultAddress,
defaultPostaddress: configItems.defaultPostaddress,
confirmUrl: urllib.resolve(configItems.serviceUrl, '/subscription/subscribe/' + cid)
}
}, err => {
if (err) {
log.error('Subscription', err.stack);
}
});
};
let text = {
template: 'subscription/mail-confirm-text.hbs'
};
let html = {
template: 'subscription/mail-confirm-html.mjml.hbs',
layout: 'subscription/layout.mjml.hbs',
type: 'mjml'
};
helpers.injectCustomFormTemplates(list.defaultForm, { text, html }, (err, tmpl) => {
if (err) {
log.error('Subscription', err.stack);
return sendMail(html, text);
}
sendMail(tmpl.html, tmpl.text);
});
});
return callback(null, cid);
});
});
});
});
});