Remove old import file

[MAILPOET-1809]
This commit is contained in:
Pavel Dohnal
2019-07-01 10:45:16 +02:00
committed by M. Shull
parent 1fed7fec55
commit b42a89719c
4 changed files with 780 additions and 760 deletions

View File

@ -0,0 +1,763 @@
import ReactDOM from 'react-dom';
import React from 'react';
import Backbone from 'backbone';
import _ from 'underscore';
import jQuery from 'jquery';
import 'asyncqueue';
import MailPoet from 'mailpoet';
import Handlebars from 'handlebars';
import Moment from 'moment';
import StepInputValidation from './import/step_input_validation.jsx';
import StepMethodSelection from './import/step_method_selection.jsx';
import StepResults from './import/step_results.jsx';
const SUBSCRIBERS_LIMIT_FOR_VALIDATION = 500;
function getDataManipulationPreviousStepLink(importData) {
if (importData === undefined) {
return 'step_method_selection';
}
if (importData.subscribersCount === undefined) {
return 'step_method_selection';
}
if (importData.subscribersCount < SUBSCRIBERS_LIMIT_FOR_VALIDATION) {
return 'step_method_selection';
}
return 'step_input_validation';
}
jQuery(document).ready(() => {
if (!jQuery('#mailpoet_subscribers_import').length) {
return;
}
jQuery('input[name="select_method"]').attr('checked', false);
// configure router
const router = new (Backbone.Router.extend({
routes: {
'': 'home',
step_method_selection: 'step_method_selection',
step_input_validation: 'step_input_validation',
step_data_manipulation: 'step_data_manipulation',
step_results: 'step_results',
},
home() {
this.navigate('step_method_selection', { trigger: true });
},
}))();
function showCurrentStep() {
MailPoet.Notice.hide();
MailPoet.Modal.loading(false);
jQuery('#mailpoet_subscribers_import > div[id^="step"]').hide();
jQuery(window.location.hash).show();
}
router.on('route:step_method_selection', () => {
showCurrentStep();
const container = document.getElementById('step_method_selection');
if (container) {
ReactDOM.render(
<StepMethodSelection
navigate={router.navigate}
/>,
container
);
}
});
router.on('route:step_input_validation', () => {
if (typeof (window.importData.step_method_selection) === 'undefined') {
router.navigate('step_method_selection', { trigger: true });
return;
}
showCurrentStep();
const container = document.getElementById('step_input_validation');
if (container) {
ReactDOM.render(
<StepInputValidation
navigate={router.navigate}
importData={window.importData.step_method_selection}
/>,
container
);
}
});
router.on('route:step_data_manipulation', () => {
let fillerPosition;
let importResults;
let duplicates;
if (typeof (window.importData.step_method_selection) === 'undefined') {
router.navigate('step_method_selection', { trigger: true });
return;
}
// define reusable variables
const nextStepButton = jQuery('#next_step');
const previousStepButton = jQuery('#return_to_previous');
// create a copy of subscribers object for further manipulation
const subscribers = jQuery.extend(true, {}, window.importData.step_method_selection);
const subscribersDataTemplate = Handlebars.compile(jQuery('#subscribers_data_template').html());
const subscribersDataTemplatePartial = Handlebars.compile(jQuery('#subscribers_data_template_partial').html());
const subscribersDataParseResultsTemplate = Handlebars.compile(jQuery('#subscribers_data_parse_results_template').html());
const segmentSelectElement = jQuery('#mailpoet_segments_select');
const maxRowsToShow = 10;
const filler = '. . .';
// create an array of filler data with the same number of
// elements as in the subscribers' data row
const fillerArray = Array(...new Array(subscribers.subscribers[0].length))
.map(String.prototype.valueOf, filler);
showCurrentStep();
function toggleNextStepButton(condition) {
const disabled = 'button-disabled';
if (condition === 'on') {
nextStepButton.removeClass(disabled);
return;
}
nextStepButton.addClass(disabled);
}
// hide previous statistics/import results
jQuery('#subscribers_data_parse_results:visible').html('');
jQuery('#subscribers_data_import_results:visible').hide();
// show parse statistics if any duplicate/invalid records were found
if (subscribers.invalid.length || subscribers.duplicate.length || subscribers.role.length) {
// count repeating e-mails inside duplicate array and present them in
// 'email (xN)' format
duplicates = {};
subscribers.duplicate.forEach((subscriberEmail) => {
duplicates[subscriberEmail] = (duplicates[subscriberEmail] || 0) + 1;
});
subscribers.duplicate = [];
Object.keys(duplicates).forEach((email) => {
if (duplicates[email] > 1) {
subscribers.duplicate.push(`${email} (x${duplicates[email]})`);
} else {
subscribers.duplicate.push(email);
}
});
importResults = {
notice: MailPoet.I18n.t('importNoticeSkipped').replace(
'%1$s',
`<strong>${subscribers.invalid.length + subscribers.duplicate.length + subscribers.role.length}</strong>`
),
invalid: (subscribers.invalid.length)
? MailPoet.I18n.t('importNoticeInvalid')
.replace('%1$s', `<strong>${subscribers.invalid.length.toLocaleString()}</strong>`)
.replace('%2$s', subscribers.invalid.join(', '))
: null,
duplicate: (subscribers.duplicate.length)
? MailPoet.I18n.t('importNoticeDuplicate')
.replace('%1$s', `<strong>${subscribers.duplicate.length}</strong>`)
.replace('%2$s', subscribers.duplicate.join(', '))
: null,
role: (subscribers.role.length)
? MailPoet.I18n.t('importNoticeRoleBased')
.replace('%1$s', `<strong>${subscribers.role.length.toLocaleString()}</strong>`)
.replace('%2$s', subscribers.role.join(', '))
.replace(
/\[link](.+)\[\/link]/,
'<a href="https://kb.mailpoet.com/article/270-role-based-email-addresses-are-not-allowed" target="_blank" rel="noopener noreferrer">$1</a>'
)
: null,
};
jQuery('#subscribers_data_parse_results').html(
subscribersDataParseResultsTemplate(importResults)
);
}
jQuery('.mailpoet_subscribers_data_parse_results_details_show')
.click(function detailsClick() {
const details = jQuery('.mailpoet_subscribers_data_parse_results_details');
details.toggle();
jQuery(this).text((details.is(':visible'))
? MailPoet.I18n.t('hideDetails')
: MailPoet.I18n.t('showDetails'));
});
// show available segments
if (window.mailpoetSegments.length) {
jQuery('.mailpoet_segments').show();
} else {
jQuery('.mailpoet_no_segments').show();
}
function enableSegmentSelection(segments) {
if (segmentSelectElement.data('select2')) {
segmentSelectElement
.html('')
.select2('destroy');
toggleNextStepButton('off');
}
segmentSelectElement
.select2({
data: segments,
width: '20em',
templateResult(item) {
const i = item;
i.subscriberCount = parseInt(i.subscriberCount, 10);
return `${i.name} (${i.subscriberCount.toLocaleString()})`;
},
templateSelection(item) {
const i = item;
i.subscriberCount = parseInt(i.subscriberCount, 10);
return `${i.name} (${i.subscriberCount.toLocaleString()})`;
},
})
.change((event) => {
const segmentSelectionNotice = jQuery('[data-id="notice_segmentSelection"]');
if (!event.currentTarget.value) {
if (!segmentSelectionNotice.length) {
MailPoet.Notice.error(MailPoet.I18n.t('segmentSelectionRequired'), {
static: true,
scroll: true,
id: 'notice_segmentSelection',
hideClose: true,
});
}
toggleNextStepButton('off');
} else {
jQuery('[data-id="notice_segmentSelection"]').remove();
if (!jQuery('.mailpoet_notice.error:visible').length) {
toggleNextStepButton('on');
}
}
});
}
jQuery('.mailpoet_create_segment').click(() => {
MailPoet.Modal.popup({
title: MailPoet.I18n.t('addNewList'),
template: jQuery('#new_segment_template').html(),
});
jQuery('#new_segment_name').keypress((e) => {
if (e.which === 13) {
jQuery('#new_segment_process').click();
}
});
jQuery('#new_segment_process').click(() => {
const segmentName = jQuery('#new_segment_name').val().trim();
const segmentDescription = jQuery('#new_segment_description').val().trim();
MailPoet.Ajax.post({
api_version: window.mailpoet_api_version,
endpoint: 'ImportExport',
action: 'addSegment',
data: {
name: segmentName,
description: segmentDescription,
},
}).done((response) => {
let selectedValues;
window.mailpoetSegments.push({
id: response.data.id,
name: response.data.name,
subscriberCount: 0,
});
selectedValues = segmentSelectElement.val();
if (selectedValues === null) {
selectedValues = [response.data.id];
} else {
selectedValues.push(response.data.id);
}
enableSegmentSelection(window.mailpoetSegments);
segmentSelectElement.val(selectedValues).trigger('change');
jQuery('.mailpoet_segments:hidden').show();
jQuery('.mailpoet_no_segments:visible').hide();
MailPoet.Modal.close();
}).fail((response) => {
if (response.errors.length > 0) {
MailPoet.Notice.hide();
MailPoet.Notice.error(
response.errors.map(error => error.message),
{ positionAfter: '#new_segment_name' }
);
}
});
});
jQuery('#new_segment_cancel').click(() => {
MailPoet.Modal.close();
});
});
// register partial template that will contain subscribers data
Handlebars.registerPartial(
'subscribers_data_template_partial',
subscribersDataTemplatePartial
);
// autodetect column types
Handlebars.registerHelper(
'show_and_match_columns',
(helperSubscribers, options) => {
const displayedColumns = [];
const displayedColumnsIds = [];
let columnData;
let columnId;
let headerName;
let headerNameMatch;
// go through all elements of the first row in subscribers data
Object
.keys(helperSubscribers.subscribers[0])
.forEach((i) => {
columnData = helperSubscribers.subscribers[0][i];
columnId = 'ignore'; // set default column type
// if the column is not undefined and has a valid e-mail, set type as email
if (columnData % 1 !== 0 && window.mailpoet_email_regex.test(columnData)) {
columnId = 'email';
} else if (helperSubscribers.header) {
headerName = helperSubscribers.header[i];
headerNameMatch = window.mailpoetColumns.map(el => el.name).indexOf(headerName);
// set column type using header
if (headerNameMatch !== -1) {
columnId = window.mailpoetColumns[headerNameMatch].id;
} else if (headerName) { // set column type using header name
if (/first|first name|given name/i.test(headerName)) {
columnId = 'first_name';
} else if (/last|last name/i.test(headerName)) {
columnId = 'last_name';
}
}
}
// make sure the column id has not been previously selected
// (e.g., subscriber_first_name shouldn't be autodetected twice),
// except for "ignore"
columnId = (columnId !== 'ignore'
&& displayedColumnsIds.indexOf(columnId) === -1)
? columnId
: 'ignore';
displayedColumns[i] = { column_id: columnId };
displayedColumnsIds.push(columnId);
});
return options.fn(displayedColumns);
}
);
// sanitize unsafe data
Handlebars.registerHelper('sanitize_data', data => ((data instanceof Handlebars.SafeString)
? data
: new Handlebars.SafeString(Handlebars.Utils.escapeExpression(data))));
// start array index from 1
Handlebars.registerHelper('calculate_index', (rawIndex) => {
const index = parseInt(rawIndex, 10);
// display filler data (e.g., ellipsis) if we've reached the maximum number of rows and
// subscribers count is greater than the maximum number of rows we're displaying
if (index === maxRowsToShow && subscribers.subscribersCount > (maxRowsToShow + 1)) {
fillerPosition = index;
return filler;
}
if (index === (subscribers.subscribers.length - 1)) {
// if we're on the last line, show the total count of subscribers data
return subscribers.subscribersCount.toLocaleString();
}
return index + 1;
});
// reduce subscribers object if the total length is greater than the
// maximum number of defined rows
if (subscribers.subscribersCount > (maxRowsToShow + 1)) {
subscribers.subscribers.splice(
maxRowsToShow, subscribers.subscribersCount - (maxRowsToShow + 1),
fillerArray
);
}
// filter subscribers' data to detect dates, emails, etc.
function filterSubscribers() {
const subscribersClone = jQuery.extend(true, {}, subscribers);
let preventNextStep = false;
jQuery(
'[data-id="notice_invalidEmail"], [data-id="notice_invalidDate"]'
)
.remove();
const displayedColumns = jQuery.map(
jQuery('.mailpoet_subscribers_column_data_match'), (element, elementIndex) => {
const columnId = jQuery(element).data('column-id');
const validationRule = jQuery(element).data('validation-rule');
jQuery(element).val(columnId).trigger('change');
return {
id: columnId,
index: elementIndex,
validationRule,
element,
};
}
);
// iterate through the object of mailpoet columns
jQuery.map(window.mailpoetColumns, (column) => {
let firstRowData;
let validationRule;
let testedFormat;
let allowedDateFormats;
// check if the column id matches the selected id of one of the
// subscriber's data columns
const matchedColumn = _.find(
displayedColumns,
data => data.id === column.id
);
// EMAIL filter: if the first value in the column doesn't have a valid
// email, hide the next button
if (column.id === 'email') {
if (!window.mailpoet_email_regex.test(
subscribersClone.subscribers[0][matchedColumn.index]
)
) {
preventNextStep = true;
if (!jQuery('[data-id="notice_invalidEmail"]').length) {
MailPoet.Notice.error(MailPoet.I18n.t('columnContainsInvalidElement'), {
static: true,
scroll: true,
hideClose: true,
id: 'invalidEmail',
});
}
} else {
MailPoet.Notice.hide('invalidEmail');
}
}
// DATE filter: if column type is date, check if we can recognize it
if (column.type === 'date' && matchedColumn) {
allowedDateFormats = [
Moment.ISO_8601,
'YYYY/MM/DD',
'MM/DD/YYYY',
'DD/MM/YYYY',
'YYYY/MM/DD',
'YYYY/DD/MM',
'MM/YYYY',
'YYYY/MM',
'YYYY',
];
firstRowData = subscribersClone.subscribers[0][matchedColumn.index];
validationRule = false;
// check if date exists
if (firstRowData.trim() === '') {
subscribersClone.subscribers[0][matchedColumn.index] = `<span class="mailpoet_data_match mailpoet_import_error" title="${MailPoet.I18n.t('noDateFieldMatch')}">${MailPoet.I18n.t('emptyFirstRowDate')}</span> `;
preventNextStep = true;
} else {
Object.keys(allowedDateFormats).forEach((format) => {
testedFormat = allowedDateFormats[format];
if (Moment(firstRowData, testedFormat, true).isValid()) {
validationRule = (typeof (testedFormat) === 'function')
? 'datetime'
: testedFormat;
// set validation on the column element
jQuery(matchedColumn.element).data('validation-rule', validationRule);
return;
}
if (validationRule === 'datetime') {
validationRule = Moment.ISO_8601;
}
});
}
jQuery.map(subscribersClone.subscribers, (dataSubscribers, index) => {
const data = dataSubscribers;
const rowData = data[matchedColumn.index];
const date = Moment(rowData, testedFormat, true);
if (index === fillerPosition || rowData.trim() === '') return;
// validate date
if (date.isValid()) {
data[matchedColumn.index] = new Handlebars.SafeString(
`${Handlebars.Utils.escapeExpression(data[matchedColumn.index])}<span class="mailpoet_data_match" title="${MailPoet.I18n.t('verifyDateMatch')}">${MailPoet.Date.format(date)}</span> `
);
} else {
data[matchedColumn.index] = new Handlebars.SafeString(
`${Handlebars.Utils.escapeExpression(data[matchedColumn.index])}<span class="mailpoet_data_match mailpoet_import_error" title="${MailPoet.I18n.t('noDateFieldMatch')}">${new Handlebars.SafeString(MailPoet.I18n.t('dateMatchError'))}</span> `
);
preventNextStep = true;
}
});
if (preventNextStep && !jQuery('.mailpoet_invalidDate').length) {
MailPoet.Notice.error(MailPoet.I18n.t('columnContainsInvalidDate'), {
static: true,
scroll: true,
hideClose: true,
id: 'invalidDate',
});
}
}
});
// refresh table with susbcribers' data
jQuery('#subscribers_data > table > tbody')
.html(subscribersDataTemplatePartial(subscribersClone));
if (preventNextStep) {
toggleNextStepButton('off');
} else if (!jQuery('.mailpoet_notice.error:visible').length
&& segmentSelectElement.val()) {
toggleNextStepButton('on');
}
}
// render template
jQuery('#subscribers_data > table').html(subscribersDataTemplate(subscribers));
// filter displayed data
jQuery('select.mailpoet_subscribers_column_data_match')
.select2({
data: window.mailpoetColumnsSelect2,
width: '15em',
templateResult(item) {
return item.name;
},
templateSelection(item) {
return item.name;
},
})
.on('select2:selecting', (selectEvent) => {
const selectElement = selectEvent.currentTarget;
const selectedOptionId = selectEvent.params.args.data.id;
// CREATE CUSTOM FIELD
if (selectedOptionId === 'create') {
selectEvent.preventDefault();
jQuery(selectElement).select2('close');
MailPoet.Modal.popup({
title: MailPoet.I18n.t('addNewField'),
template: jQuery('#form_template_field_form').html(),
});
jQuery('#form_field_new').parsley().on('form:submit', () => {
// get data
const data = jQuery('#form_field_new').mailpoetSerializeObject();
// save custom field
MailPoet.Ajax.post({
api_version: window.mailpoet_api_version,
endpoint: 'customFields',
action: 'save',
data,
}).done((response) => {
const newColumnData = {
id: response.data.id,
name: response.data.name,
type: response.data.type,
params: response.data.params,
custom: true,
};
// if this is the first custom column, create an "optgroup"
if (window.mailpoetColumnsSelect2.length === 2) {
window.mailpoetColumnsSelect2.push({
name: MailPoet.I18n.t('userColumns'),
children: [],
});
}
window.mailpoetColumnsSelect2[2].children.push(newColumnData);
window.mailpoetColumns.push(newColumnData);
jQuery('select.mailpoet_subscribers_column_data_match')
.each(() => {
jQuery(selectElement)
.html('')
.select2('destroy')
.select2({
data: window.mailpoetColumnsSelect2,
width: '15em',
templateResult(item) {
return item.name;
},
templateSelection(item) {
return item.name;
},
});
});
jQuery(selectElement).data('column-id', newColumnData.id);
jQuery(selectElement).data('validation-rule', false);
filterSubscribers();
// close popup
MailPoet.Modal.close();
}).fail((response) => {
if (response.errors.length > 0) {
MailPoet.Notice.error(
response.errors.map(error => error.message),
{ positionAfter: '#field_name' }
);
}
});
return false;
});
} else {
// CHANGE COLUMN
// check for duplicate values in all select options
jQuery('select.mailpoet_subscribers_column_data_match')
.each(() => {
const element = selectElement;
const elementId = jQuery(element).val();
// if another column has the same value and it's not an 'ignore',
// prompt user
if (elementId === selectedOptionId
&& elementId !== 'ignore') {
if (confirm(`${MailPoet.I18n.t('selectedValueAlreadyMatched')} ${MailPoet.I18n.t('confirmCorrespondingColumn')}`)) { // eslint-disable-line
jQuery(element).data('column-id', 'ignore');
} else {
selectEvent.preventDefault();
jQuery(selectElement).select2('close');
}
}
});
}
})
.on('select2:select', (selectEvent) => {
const selectElement = selectEvent.currentTarget;
const selectedOptionId = selectEvent.params.data.id;
jQuery(selectElement).data('column-id', selectedOptionId);
filterSubscribers();
});
previousStepButton.off().on('click', () => {
router.navigate(
getDataManipulationPreviousStepLink(window.importData.step_method_selection),
{ trigger: true }
);
});
nextStepButton.off().on('click', (event) => {
const columns = {};
const queue = new jQuery.AsyncQueue();
let batchNumber = 0;
const batchSize = 2000;
const timestamp = Date.now() / 1000;
const clickImportResults = {
created: 0,
updated: 0,
errors: [],
segments: [],
};
if (jQuery(event.currentTarget).hasClass('button-disabled')) {
return;
}
MailPoet.Modal.loading(true);
const splitSubscribers = (localSubscribers, size) => (
localSubscribers.reduce((res, item, index) => {
if (index % size === 0) {
res.push([]);
}
res[res.length - 1].push(item);
return res;
}, [])
);
const clickSubscribers = splitSubscribers(
window.importData.step_method_selection.subscribers,
batchSize
);
_.each(jQuery('select.mailpoet_subscribers_column_data_match'),
(column, columnIndex) => {
const columnId = jQuery(column).data('column-id');
const validationRule = jQuery(column).data('validation-rule');
if (columnId === 'ignore') {
return;
}
columns[columnId] = { index: columnIndex, validation_rule: validationRule };
});
_.each(clickSubscribers, () => {
queue.add((addQueue) => {
addQueue.pause();
MailPoet.Ajax.post({
api_version: window.mailpoet_api_version,
endpoint: 'ImportExport',
action: 'processImport',
data: JSON.stringify({
columns,
subscribers: clickSubscribers[batchNumber],
timestamp,
segments: segmentSelectElement.val(),
updateSubscribers: (jQuery(':radio[name="subscriber_update_option"]:checked').val() === 'yes'),
}),
}).done((response) => {
const added = response.data.added_to_segment_with_welcome_notification;
clickImportResults.created += response.data.created;
clickImportResults.updated += response.data.updated;
clickImportResults.segments = response.data.segments;
clickImportResults.added_to_segment_with_welcome_notification = added;
addQueue.run();
}).fail((response) => {
MailPoet.Modal.loading(false);
if (response.errors.length > 0) {
MailPoet.Notice.error(
response.errors.map(error => error.message),
{ scroll: true }
);
}
});
batchNumber += 1;
});
});
queue.run();
queue.onComplete(() => {
MailPoet.Modal.loading(false);
if (
clickImportResults.errors.length > 0
&& !clickImportResults.updated
&& !clickImportResults.created
) {
MailPoet.Notice.error(_.flatten(clickImportResults.errors));
} else {
window.mailpoetSegments = clickImportResults.segments;
clickImportResults.segments = _.map(segmentSelectElement.select2('data'),
data => data.name);
window.importData.step_data_manipulation = clickImportResults;
enableSegmentSelection(window.mailpoetSegments);
router.navigate('step_results', { trigger: true });
}
});
});
filterSubscribers();
enableSegmentSelection(window.mailpoetSegments);
});
router.on('route:step_results', () => {
if (typeof (window.importData.step_data_manipulation) === 'undefined') {
router.navigate('step_data_manipulation', { trigger: true });
return;
}
showCurrentStep();
MailPoet.trackEvent('Subscribers import finished', {
'Subscribers created': window.importData.step_data_manipulation.created,
'Subscribers updated': window.importData.step_data_manipulation.updated,
'MailPoet Free version': window.mailpoet_version,
});
const container = document.getElementById('step_results');
if (container) {
ReactDOM.render(
<StepResults
navigate={router.navigate}
errors={window.importData.step_data_manipulation.errors}
createdSubscribers={window.importData.step_data_manipulation.created}
updatedSubscribers={window.importData.step_data_manipulation.updated}
segments={window.importData.step_data_manipulation.segments}
addedToSegmentWithWelcomeNotification={
window
.importData
.step_data_manipulation
.added_to_segment_with_welcome_notification
}
/>,
container
);
}
// reset previous step's data so that coming back to this step is prevented
window.importData.step_method_selection = undefined;
window.importData.step_data_manipulation = undefined;
});
if (!Backbone.History.started) {
Backbone.history.start();
}
});

View File

@ -1,763 +1,18 @@
import ReactDOM from 'react-dom';
import React from 'react';
import Backbone from 'backbone';
import _ from 'underscore';
import jQuery from 'jquery';
import 'asyncqueue';
import MailPoet from 'mailpoet';
import Handlebars from 'handlebars';
import Moment from 'moment';
import StepInputValidation from './import/step_input_validation.jsx';
import ReactDOM from 'react-dom';
import { HashRouter, Switch, Route, Redirect } from 'react-router-dom';
import StepMethodSelection from './import/step_method_selection.jsx';
import StepResults from './import/step_results.jsx';
const SUBSCRIBERS_LIMIT_FOR_VALIDATION = 500;
const container = document.getElementById('import_container');
function getDataManipulationPreviousStepLink(importData) {
if (importData === undefined) {
return 'step_method_selection';
}
if (importData.subscribersCount === undefined) {
return 'step_method_selection';
}
if (importData.subscribersCount < SUBSCRIBERS_LIMIT_FOR_VALIDATION) {
return 'step_method_selection';
}
return 'step_input_validation';
if (container) {
ReactDOM.render((
<HashRouter>
<Switch>
<Route path="/step_method_selection" component={StepMethodSelection} />
<Route path="*" render={() => <Redirect to="/step_method_selection" />} />
</Switch>
</HashRouter>
), container);
}
jQuery(document).ready(() => {
if (!jQuery('#mailpoet_subscribers_import').length) {
return;
}
jQuery('input[name="select_method"]').attr('checked', false);
// configure router
const router = new (Backbone.Router.extend({
routes: {
'': 'home',
step_method_selection: 'step_method_selection',
step_input_validation: 'step_input_validation',
step_data_manipulation: 'step_data_manipulation',
step_results: 'step_results',
},
home() {
this.navigate('step_method_selection', { trigger: true });
},
}))();
function showCurrentStep() {
MailPoet.Notice.hide();
MailPoet.Modal.loading(false);
jQuery('#mailpoet_subscribers_import > div[id^="step"]').hide();
jQuery(window.location.hash).show();
}
router.on('route:step_method_selection', () => {
showCurrentStep();
const container = document.getElementById('step_method_selection');
if (container) {
ReactDOM.render(
<StepMethodSelection
navigate={router.navigate}
/>,
container
);
}
});
router.on('route:step_input_validation', () => {
if (typeof (window.importData.step_method_selection) === 'undefined') {
router.navigate('step_method_selection', { trigger: true });
return;
}
showCurrentStep();
const container = document.getElementById('step_input_validation');
if (container) {
ReactDOM.render(
<StepInputValidation
navigate={router.navigate}
importData={window.importData.step_method_selection}
/>,
container
);
}
});
router.on('route:step_data_manipulation', () => {
let fillerPosition;
let importResults;
let duplicates;
if (typeof (window.importData.step_method_selection) === 'undefined') {
router.navigate('step_method_selection', { trigger: true });
return;
}
// define reusable variables
const nextStepButton = jQuery('#next_step');
const previousStepButton = jQuery('#return_to_previous');
// create a copy of subscribers object for further manipulation
const subscribers = jQuery.extend(true, {}, window.importData.step_method_selection);
const subscribersDataTemplate = Handlebars.compile(jQuery('#subscribers_data_template').html());
const subscribersDataTemplatePartial = Handlebars.compile(jQuery('#subscribers_data_template_partial').html());
const subscribersDataParseResultsTemplate = Handlebars.compile(jQuery('#subscribers_data_parse_results_template').html());
const segmentSelectElement = jQuery('#mailpoet_segments_select');
const maxRowsToShow = 10;
const filler = '. . .';
// create an array of filler data with the same number of
// elements as in the subscribers' data row
const fillerArray = Array(...new Array(subscribers.subscribers[0].length))
.map(String.prototype.valueOf, filler);
showCurrentStep();
function toggleNextStepButton(condition) {
const disabled = 'button-disabled';
if (condition === 'on') {
nextStepButton.removeClass(disabled);
return;
}
nextStepButton.addClass(disabled);
}
// hide previous statistics/import results
jQuery('#subscribers_data_parse_results:visible').html('');
jQuery('#subscribers_data_import_results:visible').hide();
// show parse statistics if any duplicate/invalid records were found
if (subscribers.invalid.length || subscribers.duplicate.length || subscribers.role.length) {
// count repeating e-mails inside duplicate array and present them in
// 'email (xN)' format
duplicates = {};
subscribers.duplicate.forEach((subscriberEmail) => {
duplicates[subscriberEmail] = (duplicates[subscriberEmail] || 0) + 1;
});
subscribers.duplicate = [];
Object.keys(duplicates).forEach((email) => {
if (duplicates[email] > 1) {
subscribers.duplicate.push(`${email} (x${duplicates[email]})`);
} else {
subscribers.duplicate.push(email);
}
});
importResults = {
notice: MailPoet.I18n.t('importNoticeSkipped').replace(
'%1$s',
`<strong>${subscribers.invalid.length + subscribers.duplicate.length + subscribers.role.length}</strong>`
),
invalid: (subscribers.invalid.length)
? MailPoet.I18n.t('importNoticeInvalid')
.replace('%1$s', `<strong>${subscribers.invalid.length.toLocaleString()}</strong>`)
.replace('%2$s', subscribers.invalid.join(', '))
: null,
duplicate: (subscribers.duplicate.length)
? MailPoet.I18n.t('importNoticeDuplicate')
.replace('%1$s', `<strong>${subscribers.duplicate.length}</strong>`)
.replace('%2$s', subscribers.duplicate.join(', '))
: null,
role: (subscribers.role.length)
? MailPoet.I18n.t('importNoticeRoleBased')
.replace('%1$s', `<strong>${subscribers.role.length.toLocaleString()}</strong>`)
.replace('%2$s', subscribers.role.join(', '))
.replace(
/\[link](.+)\[\/link]/,
'<a href="https://kb.mailpoet.com/article/270-role-based-email-addresses-are-not-allowed" target="_blank" rel="noopener noreferrer">$1</a>'
)
: null,
};
jQuery('#subscribers_data_parse_results').html(
subscribersDataParseResultsTemplate(importResults)
);
}
jQuery('.mailpoet_subscribers_data_parse_results_details_show')
.click(function detailsClick() {
const details = jQuery('.mailpoet_subscribers_data_parse_results_details');
details.toggle();
jQuery(this).text((details.is(':visible'))
? MailPoet.I18n.t('hideDetails')
: MailPoet.I18n.t('showDetails'));
});
// show available segments
if (window.mailpoetSegments.length) {
jQuery('.mailpoet_segments').show();
} else {
jQuery('.mailpoet_no_segments').show();
}
function enableSegmentSelection(segments) {
if (segmentSelectElement.data('select2')) {
segmentSelectElement
.html('')
.select2('destroy');
toggleNextStepButton('off');
}
segmentSelectElement
.select2({
data: segments,
width: '20em',
templateResult(item) {
const i = item;
i.subscriberCount = parseInt(i.subscriberCount, 10);
return `${i.name} (${i.subscriberCount.toLocaleString()})`;
},
templateSelection(item) {
const i = item;
i.subscriberCount = parseInt(i.subscriberCount, 10);
return `${i.name} (${i.subscriberCount.toLocaleString()})`;
},
})
.change((event) => {
const segmentSelectionNotice = jQuery('[data-id="notice_segmentSelection"]');
if (!event.currentTarget.value) {
if (!segmentSelectionNotice.length) {
MailPoet.Notice.error(MailPoet.I18n.t('segmentSelectionRequired'), {
static: true,
scroll: true,
id: 'notice_segmentSelection',
hideClose: true,
});
}
toggleNextStepButton('off');
} else {
jQuery('[data-id="notice_segmentSelection"]').remove();
if (!jQuery('.mailpoet_notice.error:visible').length) {
toggleNextStepButton('on');
}
}
});
}
jQuery('.mailpoet_create_segment').click(() => {
MailPoet.Modal.popup({
title: MailPoet.I18n.t('addNewList'),
template: jQuery('#new_segment_template').html(),
});
jQuery('#new_segment_name').keypress((e) => {
if (e.which === 13) {
jQuery('#new_segment_process').click();
}
});
jQuery('#new_segment_process').click(() => {
const segmentName = jQuery('#new_segment_name').val().trim();
const segmentDescription = jQuery('#new_segment_description').val().trim();
MailPoet.Ajax.post({
api_version: window.mailpoet_api_version,
endpoint: 'ImportExport',
action: 'addSegment',
data: {
name: segmentName,
description: segmentDescription,
},
}).done((response) => {
let selectedValues;
window.mailpoetSegments.push({
id: response.data.id,
name: response.data.name,
subscriberCount: 0,
});
selectedValues = segmentSelectElement.val();
if (selectedValues === null) {
selectedValues = [response.data.id];
} else {
selectedValues.push(response.data.id);
}
enableSegmentSelection(window.mailpoetSegments);
segmentSelectElement.val(selectedValues).trigger('change');
jQuery('.mailpoet_segments:hidden').show();
jQuery('.mailpoet_no_segments:visible').hide();
MailPoet.Modal.close();
}).fail((response) => {
if (response.errors.length > 0) {
MailPoet.Notice.hide();
MailPoet.Notice.error(
response.errors.map(error => error.message),
{ positionAfter: '#new_segment_name' }
);
}
});
});
jQuery('#new_segment_cancel').click(() => {
MailPoet.Modal.close();
});
});
// register partial template that will contain subscribers data
Handlebars.registerPartial(
'subscribers_data_template_partial',
subscribersDataTemplatePartial
);
// autodetect column types
Handlebars.registerHelper(
'show_and_match_columns',
(helperSubscribers, options) => {
const displayedColumns = [];
const displayedColumnsIds = [];
let columnData;
let columnId;
let headerName;
let headerNameMatch;
// go through all elements of the first row in subscribers data
Object
.keys(helperSubscribers.subscribers[0])
.forEach((i) => {
columnData = helperSubscribers.subscribers[0][i];
columnId = 'ignore'; // set default column type
// if the column is not undefined and has a valid e-mail, set type as email
if (columnData % 1 !== 0 && window.mailpoet_email_regex.test(columnData)) {
columnId = 'email';
} else if (helperSubscribers.header) {
headerName = helperSubscribers.header[i];
headerNameMatch = window.mailpoetColumns.map(el => el.name).indexOf(headerName);
// set column type using header
if (headerNameMatch !== -1) {
columnId = window.mailpoetColumns[headerNameMatch].id;
} else if (headerName) { // set column type using header name
if (/first|first name|given name/i.test(headerName)) {
columnId = 'first_name';
} else if (/last|last name/i.test(headerName)) {
columnId = 'last_name';
}
}
}
// make sure the column id has not been previously selected
// (e.g., subscriber_first_name shouldn't be autodetected twice),
// except for "ignore"
columnId = (columnId !== 'ignore'
&& displayedColumnsIds.indexOf(columnId) === -1)
? columnId
: 'ignore';
displayedColumns[i] = { column_id: columnId };
displayedColumnsIds.push(columnId);
});
return options.fn(displayedColumns);
}
);
// sanitize unsafe data
Handlebars.registerHelper('sanitize_data', data => ((data instanceof Handlebars.SafeString)
? data
: new Handlebars.SafeString(Handlebars.Utils.escapeExpression(data))));
// start array index from 1
Handlebars.registerHelper('calculate_index', (rawIndex) => {
const index = parseInt(rawIndex, 10);
// display filler data (e.g., ellipsis) if we've reached the maximum number of rows and
// subscribers count is greater than the maximum number of rows we're displaying
if (index === maxRowsToShow && subscribers.subscribersCount > (maxRowsToShow + 1)) {
fillerPosition = index;
return filler;
}
if (index === (subscribers.subscribers.length - 1)) {
// if we're on the last line, show the total count of subscribers data
return subscribers.subscribersCount.toLocaleString();
}
return index + 1;
});
// reduce subscribers object if the total length is greater than the
// maximum number of defined rows
if (subscribers.subscribersCount > (maxRowsToShow + 1)) {
subscribers.subscribers.splice(
maxRowsToShow, subscribers.subscribersCount - (maxRowsToShow + 1),
fillerArray
);
}
// filter subscribers' data to detect dates, emails, etc.
function filterSubscribers() {
const subscribersClone = jQuery.extend(true, {}, subscribers);
let preventNextStep = false;
jQuery(
'[data-id="notice_invalidEmail"], [data-id="notice_invalidDate"]'
)
.remove();
const displayedColumns = jQuery.map(
jQuery('.mailpoet_subscribers_column_data_match'), (element, elementIndex) => {
const columnId = jQuery(element).data('column-id');
const validationRule = jQuery(element).data('validation-rule');
jQuery(element).val(columnId).trigger('change');
return {
id: columnId,
index: elementIndex,
validationRule,
element,
};
}
);
// iterate through the object of mailpoet columns
jQuery.map(window.mailpoetColumns, (column) => {
let firstRowData;
let validationRule;
let testedFormat;
let allowedDateFormats;
// check if the column id matches the selected id of one of the
// subscriber's data columns
const matchedColumn = _.find(
displayedColumns,
data => data.id === column.id
);
// EMAIL filter: if the first value in the column doesn't have a valid
// email, hide the next button
if (column.id === 'email') {
if (!window.mailpoet_email_regex.test(
subscribersClone.subscribers[0][matchedColumn.index]
)
) {
preventNextStep = true;
if (!jQuery('[data-id="notice_invalidEmail"]').length) {
MailPoet.Notice.error(MailPoet.I18n.t('columnContainsInvalidElement'), {
static: true,
scroll: true,
hideClose: true,
id: 'invalidEmail',
});
}
} else {
MailPoet.Notice.hide('invalidEmail');
}
}
// DATE filter: if column type is date, check if we can recognize it
if (column.type === 'date' && matchedColumn) {
allowedDateFormats = [
Moment.ISO_8601,
'YYYY/MM/DD',
'MM/DD/YYYY',
'DD/MM/YYYY',
'YYYY/MM/DD',
'YYYY/DD/MM',
'MM/YYYY',
'YYYY/MM',
'YYYY',
];
firstRowData = subscribersClone.subscribers[0][matchedColumn.index];
validationRule = false;
// check if date exists
if (firstRowData.trim() === '') {
subscribersClone.subscribers[0][matchedColumn.index] = `<span class="mailpoet_data_match mailpoet_import_error" title="${MailPoet.I18n.t('noDateFieldMatch')}">${MailPoet.I18n.t('emptyFirstRowDate')}</span> `;
preventNextStep = true;
} else {
Object.keys(allowedDateFormats).forEach((format) => {
testedFormat = allowedDateFormats[format];
if (Moment(firstRowData, testedFormat, true).isValid()) {
validationRule = (typeof (testedFormat) === 'function')
? 'datetime'
: testedFormat;
// set validation on the column element
jQuery(matchedColumn.element).data('validation-rule', validationRule);
return;
}
if (validationRule === 'datetime') {
validationRule = Moment.ISO_8601;
}
});
}
jQuery.map(subscribersClone.subscribers, (dataSubscribers, index) => {
const data = dataSubscribers;
const rowData = data[matchedColumn.index];
const date = Moment(rowData, testedFormat, true);
if (index === fillerPosition || rowData.trim() === '') return;
// validate date
if (date.isValid()) {
data[matchedColumn.index] = new Handlebars.SafeString(
`${Handlebars.Utils.escapeExpression(data[matchedColumn.index])}<span class="mailpoet_data_match" title="${MailPoet.I18n.t('verifyDateMatch')}">${MailPoet.Date.format(date)}</span> `
);
} else {
data[matchedColumn.index] = new Handlebars.SafeString(
`${Handlebars.Utils.escapeExpression(data[matchedColumn.index])}<span class="mailpoet_data_match mailpoet_import_error" title="${MailPoet.I18n.t('noDateFieldMatch')}">${new Handlebars.SafeString(MailPoet.I18n.t('dateMatchError'))}</span> `
);
preventNextStep = true;
}
});
if (preventNextStep && !jQuery('.mailpoet_invalidDate').length) {
MailPoet.Notice.error(MailPoet.I18n.t('columnContainsInvalidDate'), {
static: true,
scroll: true,
hideClose: true,
id: 'invalidDate',
});
}
}
});
// refresh table with susbcribers' data
jQuery('#subscribers_data > table > tbody')
.html(subscribersDataTemplatePartial(subscribersClone));
if (preventNextStep) {
toggleNextStepButton('off');
} else if (!jQuery('.mailpoet_notice.error:visible').length
&& segmentSelectElement.val()) {
toggleNextStepButton('on');
}
}
// render template
jQuery('#subscribers_data > table').html(subscribersDataTemplate(subscribers));
// filter displayed data
jQuery('select.mailpoet_subscribers_column_data_match')
.select2({
data: window.mailpoetColumnsSelect2,
width: '15em',
templateResult(item) {
return item.name;
},
templateSelection(item) {
return item.name;
},
})
.on('select2:selecting', (selectEvent) => {
const selectElement = selectEvent.currentTarget;
const selectedOptionId = selectEvent.params.args.data.id;
// CREATE CUSTOM FIELD
if (selectedOptionId === 'create') {
selectEvent.preventDefault();
jQuery(selectElement).select2('close');
MailPoet.Modal.popup({
title: MailPoet.I18n.t('addNewField'),
template: jQuery('#form_template_field_form').html(),
});
jQuery('#form_field_new').parsley().on('form:submit', () => {
// get data
const data = jQuery('#form_field_new').mailpoetSerializeObject();
// save custom field
MailPoet.Ajax.post({
api_version: window.mailpoet_api_version,
endpoint: 'customFields',
action: 'save',
data,
}).done((response) => {
const newColumnData = {
id: response.data.id,
name: response.data.name,
type: response.data.type,
params: response.data.params,
custom: true,
};
// if this is the first custom column, create an "optgroup"
if (window.mailpoetColumnsSelect2.length === 2) {
window.mailpoetColumnsSelect2.push({
name: MailPoet.I18n.t('userColumns'),
children: [],
});
}
window.mailpoetColumnsSelect2[2].children.push(newColumnData);
window.mailpoetColumns.push(newColumnData);
jQuery('select.mailpoet_subscribers_column_data_match')
.each(() => {
jQuery(selectElement)
.html('')
.select2('destroy')
.select2({
data: window.mailpoetColumnsSelect2,
width: '15em',
templateResult(item) {
return item.name;
},
templateSelection(item) {
return item.name;
},
});
});
jQuery(selectElement).data('column-id', newColumnData.id);
jQuery(selectElement).data('validation-rule', false);
filterSubscribers();
// close popup
MailPoet.Modal.close();
}).fail((response) => {
if (response.errors.length > 0) {
MailPoet.Notice.error(
response.errors.map(error => error.message),
{ positionAfter: '#field_name' }
);
}
});
return false;
});
} else {
// CHANGE COLUMN
// check for duplicate values in all select options
jQuery('select.mailpoet_subscribers_column_data_match')
.each(() => {
const element = selectElement;
const elementId = jQuery(element).val();
// if another column has the same value and it's not an 'ignore',
// prompt user
if (elementId === selectedOptionId
&& elementId !== 'ignore') {
if (confirm(`${MailPoet.I18n.t('selectedValueAlreadyMatched')} ${MailPoet.I18n.t('confirmCorrespondingColumn')}`)) { // eslint-disable-line
jQuery(element).data('column-id', 'ignore');
} else {
selectEvent.preventDefault();
jQuery(selectElement).select2('close');
}
}
});
}
})
.on('select2:select', (selectEvent) => {
const selectElement = selectEvent.currentTarget;
const selectedOptionId = selectEvent.params.data.id;
jQuery(selectElement).data('column-id', selectedOptionId);
filterSubscribers();
});
previousStepButton.off().on('click', () => {
router.navigate(
getDataManipulationPreviousStepLink(window.importData.step_method_selection),
{ trigger: true }
);
});
nextStepButton.off().on('click', (event) => {
const columns = {};
const queue = new jQuery.AsyncQueue();
let batchNumber = 0;
const batchSize = 2000;
const timestamp = Date.now() / 1000;
const clickImportResults = {
created: 0,
updated: 0,
errors: [],
segments: [],
};
if (jQuery(event.currentTarget).hasClass('button-disabled')) {
return;
}
MailPoet.Modal.loading(true);
const splitSubscribers = (localSubscribers, size) => (
localSubscribers.reduce((res, item, index) => {
if (index % size === 0) {
res.push([]);
}
res[res.length - 1].push(item);
return res;
}, [])
);
const clickSubscribers = splitSubscribers(
window.importData.step_method_selection.subscribers,
batchSize
);
_.each(jQuery('select.mailpoet_subscribers_column_data_match'),
(column, columnIndex) => {
const columnId = jQuery(column).data('column-id');
const validationRule = jQuery(column).data('validation-rule');
if (columnId === 'ignore') {
return;
}
columns[columnId] = { index: columnIndex, validation_rule: validationRule };
});
_.each(clickSubscribers, () => {
queue.add((addQueue) => {
addQueue.pause();
MailPoet.Ajax.post({
api_version: window.mailpoet_api_version,
endpoint: 'ImportExport',
action: 'processImport',
data: JSON.stringify({
columns,
subscribers: clickSubscribers[batchNumber],
timestamp,
segments: segmentSelectElement.val(),
updateSubscribers: (jQuery(':radio[name="subscriber_update_option"]:checked').val() === 'yes'),
}),
}).done((response) => {
const added = response.data.added_to_segment_with_welcome_notification;
clickImportResults.created += response.data.created;
clickImportResults.updated += response.data.updated;
clickImportResults.segments = response.data.segments;
clickImportResults.added_to_segment_with_welcome_notification = added;
addQueue.run();
}).fail((response) => {
MailPoet.Modal.loading(false);
if (response.errors.length > 0) {
MailPoet.Notice.error(
response.errors.map(error => error.message),
{ scroll: true }
);
}
});
batchNumber += 1;
});
});
queue.run();
queue.onComplete(() => {
MailPoet.Modal.loading(false);
if (
clickImportResults.errors.length > 0
&& !clickImportResults.updated
&& !clickImportResults.created
) {
MailPoet.Notice.error(_.flatten(clickImportResults.errors));
} else {
window.mailpoetSegments = clickImportResults.segments;
clickImportResults.segments = _.map(segmentSelectElement.select2('data'),
data => data.name);
window.importData.step_data_manipulation = clickImportResults;
enableSegmentSelection(window.mailpoetSegments);
router.navigate('step_results', { trigger: true });
}
});
});
filterSubscribers();
enableSegmentSelection(window.mailpoetSegments);
});
router.on('route:step_results', () => {
if (typeof (window.importData.step_data_manipulation) === 'undefined') {
router.navigate('step_data_manipulation', { trigger: true });
return;
}
showCurrentStep();
MailPoet.trackEvent('Subscribers import finished', {
'Subscribers created': window.importData.step_data_manipulation.created,
'Subscribers updated': window.importData.step_data_manipulation.updated,
'MailPoet Free version': window.mailpoet_version,
});
const container = document.getElementById('step_results');
if (container) {
ReactDOM.render(
<StepResults
navigate={router.navigate}
errors={window.importData.step_data_manipulation.errors}
createdSubscribers={window.importData.step_data_manipulation.created}
updatedSubscribers={window.importData.step_data_manipulation.updated}
segments={window.importData.step_data_manipulation.segments}
addedToSegmentWithWelcomeNotification={
window
.importData
.step_data_manipulation
.added_to_segment_with_welcome_notification
}
/>,
container
);
}
// reset previous step's data so that coming back to this step is prevented
window.importData.step_method_selection = undefined;
window.importData.step_data_manipulation = undefined;
});
if (!Backbone.History.started) {
Backbone.history.start();
}
});

View File

@ -49,7 +49,7 @@ function StepMethodSelection({
};
return (
<>
<div className="mailpoet_method_selection_step">
<SelectMethod
activeMethod={method}
onMethodChange={setMethod}
@ -87,7 +87,7 @@ function StepMethodSelection({
/>
) : null
}
</>
</div>
);
}

View File

@ -15,6 +15,7 @@
<% include 'subscribers/importExport/import/step_data_manipulation.html' %>
<!-- STEP 4: results -->
<% include 'subscribers/importExport/import/step_results.html' %>
<div id="import_container"></div>
</div>
<%= stylesheet('importExport.css') %>
@ -33,6 +34,7 @@
</script>
<% endblock %>
<% block translations %>
<%= localize({
'noMailChimpLists': __('No active lists found'),