Fixed small bugs connected with changing Mosaico template for an existing campaign/template.

Added new merge tags:
- LINK_PUBLIC_SUBSCRIBE
- LIST_ID_<index>
- PUBLIC_LIST_ID_<index>

Among others, this allows mixing private and public lists in a campaign and have the subscribe link to always point to the first/n-th public list even for subscribers in private lists.

Author: bures

client/src/Home.js

@@ -25,7 +25,7 @@ export default class List extends Component {
         return (
             <div>
                 <h2>{t('mailtrain2')}</h2>
-                <div>{t('build') + ' 2021-05-24-1621'}</div>
+                <div>{t('build') + ' 2021-05-25-0915'}</div>
                 <p>{mailtrainConfig.shoutout}</p>
             </div>
         );

client/src/campaigns/Content.js

@@ -139,10 +139,12 @@ export default class CustomContent extends Component {
     localValidateFormValues(state) {
         const t = this.props.t;
 
+        for (const key of state.keys()) {
+            state.setIn([key, 'error'], null);
+        }
+
         if (!state.getIn(['data_sourceCustom_tag_language', 'value'])) {
             state.setIn(['data_sourceCustom_tag_language', 'error'], t('tagLanguageMustBeSelected'));
-        } else {
-            state.setIn(['data_sourceCustom_tag_language', 'error'], null);
         }
 
         const customTemplateTypeKey = state.getIn(['data_sourceCustom_type', 'value']);

client/src/lib/sandboxed-mosaico-root.js

@@ -35,6 +35,11 @@ class MosaicoSandbox extends Component {
     }
 
     async exportState(method, params) {
+        if (!this.viewModel) {
+            // If something fails (e.g. the mosaico template does not exists, the viewModel is not defined
+            return null;
+        }
+
         const trustedUrlBase = getTrustedUrl();
         const sandboxUrlBase = getSandboxUrl();
         const publicUrlBase = getPublicUrl();

client/src/templates/helpers.js

@@ -713,6 +713,14 @@ export function getEditForm(owner, typeKey, prefix = '') {
                         </tr>
                         </thead>
                         <tbody>
+                        <tr>
+                            <th scope="row">
+                                {tg('LINK_PUBLIC_SUBSCRIBE')}
+                            </th>
+                            <td>
+                                <Trans>URL that points to the subscribe page of the first list in the campaign that allows public subscriptions</Trans>
+                            </td>
+                        </tr>
                         <tr>
                             <th scope="row">
                                 {tg('LINK_UNSUBSCRIBE')}
@@ -758,7 +766,23 @@ export function getEditForm(owner, typeKey, prefix = '') {
                                 {tg('LIST_ID')}
                             </th>
                             <td>
-                                <Trans i18nKey="uniqueIdThatIdentifiesTheListUsedForThis">Unique ID that identifies the list used for this campaign</Trans>
+                                <Trans i18nKey="uniqueIdThatIdentifiesTheListUsedForThis">Unique ID that identifies the list to which the target subscriber belongs</Trans>
+                            </td>
+                        </tr>
+                        <tr>
+                            <th scope="row">
+                                {tg('LIST_ID_<index>')}
+                            </th>
+                            <td>
+                                <Trans>Unique ID that identifies the list. The <code>index</code> is 0-based index of the list in the campaign. <code>LIST_ID_0</code> thus means the first list in the campaign.</Trans>
+                            </td>
+                        </tr>
+                        <tr>
+                            <th scope="row">
+                                {tg('PUBLIC_LIST_ID_<index>')}
+                            </th>
+                            <td>
+                                <Trans>The same as above, but only taking into account the lists for which public subscribe is enabled. <code>PUBLIC_LIST_ID_0</code> thus means the first public list in the campaign.</Trans>
                             </td>
                         </tr>
                         <tr>

mvis/ivis-core

@@ -89,24 +89,31 @@ class MessageSender {
                 this.useVerpSenderHeader = this.useVerp && !this.sendConfiguration.verp_disable_sender_header;
 
 
+                // These IFs are not mutually exclusive because there are situations when listId is provided, but we want to collect all lists of the campaign
+                // in order to support tags like LINK_PUBLIC_SUBSCRIBE, LIST_ID_<index>, PUBLIC_LIST_ID_<index>
                 if (settings.listId) {
                     const list = await lists.getByIdTx(tx, contextHelpers.getAdminContext(), settings.listId);
                     this.listsById.set(list.id, list);
                     this.listsByCid.set(list.cid, list);
                     this.listsFieldsGrouped.set(list.id, await fields.listGroupedTx(tx, list.id));
+                }
 
-                } else if (settings.listCid) {
+                if (settings.listCid && !this.listsByCid.has(settings.listCid)) {
                     const list = await lists.getByCidTx(tx, contextHelpers.getAdminContext(), settings.listCid);
                     this.listsById.set(list.id, list);
                     this.listsByCid.set(list.cid, list);
                     this.listsFieldsGrouped.set(list.id, await fields.listGroupedTx(tx, list.id));
 
-                } else if (this.campaign && this.campaign.lists) {
+                }
+
+                if (this.campaign && this.campaign.lists) {
                     for (const listSpec of this.campaign.lists) {
-                        const list = await lists.getByIdTx(tx, contextHelpers.getAdminContext(), listSpec.list);
-                        this.listsById.set(list.id, list);
-                        this.listsByCid.set(list.cid, list);
-                        this.listsFieldsGrouped.set(list.id, await fields.listGroupedTx(tx, list.id));
+                        if (!this.listsById.has(listSpec.list)) {
+                            const list = await lists.getByIdTx(tx, contextHelpers.getAdminContext(), listSpec.list);
+                            this.listsById.set(list.id, list);
+                            this.listsByCid.set(list.cid, list);
+                            this.listsFieldsGrouped.set(list.id, await fields.listGroupedTx(tx, list.id));
+                        }
                     }
                 }
 
@@ -196,7 +203,7 @@ class MessageSender {
             renderTags = true;
 
         } else if (campaign && campaign.source === CampaignSource.URL) {
-            const form = tools.getMessageLinks(campaign, list, subscriptionGrouped);
+            const form = tools.getMessageLinks(campaign, this.listsById, list, subscriptionGrouped);
             for (const key in mergeTags) {
                 form[key] = mergeTags[key];
             }
@@ -245,20 +252,20 @@ class MessageSender {
 
 
         if (renderTags) {
-            if (this.campaign) {
-                html = await links.updateLinks(html, this.tagLanguage, mergeTags, campaign, list, subscriptionGrouped);
+            if (campaign) {
+                html = await links.updateLinks(html, this.tagLanguage, mergeTags, campaign, this.listsById, list, subscriptionGrouped);
             }
 
             // When no list and subscriptionGrouped is provided, formatCampaignTemplate works the same way as formatTemplate
-            html = tools.formatCampaignTemplate(html, this.tagLanguage, mergeTags, true, campaign, list, subscriptionGrouped);
+            html = tools.formatCampaignTemplate(html, this.tagLanguage, mergeTags, true, campaign, this.listsById, list, subscriptionGrouped);
         }
 
         const generateText = !(text || '').trim();
         if (generateText) {
             text = htmlToText.fromString(html, {wordwrap: 130});
         } else {
             // When no list and subscriptionGrouped is provided, formatCampaignTemplate works the same way as formatTemplate
-            text = tools.formatCampaignTemplate(text, this.tagLanguage, mergeTags, false, campaign, list, subscriptionGrouped)
+            text = tools.formatCampaignTemplate(text, this.tagLanguage, mergeTags, false, campaign, this.listsById, list, subscriptionGrouped)
         }
 
         return {
@@ -348,19 +355,19 @@ class MessageSender {
             let listUnsubscribe = null;
             if (!list.listunsubscribe_disabled) {
                 listUnsubscribe = campaign && campaign.unsubscribe_url
-                    ? tools.formatCampaignTemplate(campaign.unsubscribe_url, this.tagLanguage, mergeTags, false, campaign, list, subscriptionGrouped)
+                    ? tools.formatCampaignTemplate(campaign.unsubscribe_url, this.tagLanguage, mergeTags, false, campaign, this.listsById, list, subscriptionGrouped)
                     : getPublicUrl('/subscription/' + list.cid + '/unsubscribe/' + subscriptionGrouped.cid);
             }
 
             to = {
-                name: list.to_name === null ? undefined : tools.formatCampaignTemplate(list.to_name, toNameTagLangauge, mergeTags, false, campaign, list, subscriptionGrouped),
+                name: list.to_name === null ? undefined : tools.formatCampaignTemplate(list.to_name, toNameTagLangauge, mergeTags, false, campaign, this.listsById, list, subscriptionGrouped),
                 address: subscriptionGrouped.email
             };
 
             subject = this.subject;
 
             if (this.tagLanguage) {
-                subject = tools.formatCampaignTemplate(this.subject, this.tagLanguage, mergeTags, false, campaign, list, subscriptionGrouped);
+                subject = tools.formatCampaignTemplate(this.subject, this.tagLanguage, mergeTags, false, campaign, this.listsById, list, subscriptionGrouped);
             }
 
             headers = {

server/lib/message-sender.js

@@ -144,8 +144,8 @@ function validateEmailGetMessage(result, address, language) {
     }
 }
 
-function formatCampaignTemplate(source, tagLanguage, mergeTags, isHTML, campaign, list, subscription) {
-    const links = getMessageLinks(campaign, list, subscription);
+function formatCampaignTemplate(source, tagLanguage, mergeTags, isHTML, campaign, campaignListsById, list, subscription) {
+    const links = getMessageLinks(campaign, campaignListsById, list, subscription);
     mergeTags = {...mergeTags, ...links};
     return formatTemplate(source, tagLanguage, mergeTags, isHTML);
 }
@@ -227,13 +227,32 @@ async function prepareHtml(html) {
     return juice(preparedHtml);
 }
 
-function getMessageLinks(campaign, list, subscription) {
+function getMessageLinks(campaign, campaignListsById, list, subscription) {
     const result = {};
 
     if (list && subscription) {
         if (campaign) {
             result.LINK_UNSUBSCRIBE = getPublicUrl('/subscription/' + list.cid + '/unsubscribe/' + subscription.cid + '?c=' + campaign.cid);
             result.LINK_BROWSER = getPublicUrl('/archive/' + campaign.cid + '/' + list.cid + '/' + subscription.cid);
+
+            if (campaign.lists) {
+                let cpgListIdx = 0;
+                let cpgPublicListIdx = 0;
+                for (const cpgListSpec of campaign.lists) {
+                    const cpgList = campaignListsById.get(cpgListSpec.list);
+
+                    result[`LIST_ID_${cpgListIdx}`] = cpgList.cid;
+                    cpgListIdx += 1;
+
+                    if (cpgList.public_subscribe) {
+                        if (!result.LINK_PUBLIC_SUBSCRIBE) {
+                            result.LINK_PUBLIC_SUBSCRIBE = getPublicUrl('/subscription/' + cpgList.cid)
+                        }
+                        result[`PUBLIC_LIST_ID_${cpgPublicListIdx}`] = cpgList.cid;
+                        cpgPublicListIdx += 1;
+                    }
+                }
+            }
         } else {
             result.LINK_UNSUBSCRIBE = getPublicUrl('/subscription/' + list.cid + '/unsubscribe/' + subscription.cid);
         }

server/lib/tools.js

@@ -140,7 +140,7 @@ async function addOrGet(campaignId, url) {
     }
 }
 
-async function updateLinks(source, tagLanguage, mergeTags, campaign, list, subscription) {
+async function updateLinks(source, tagLanguage, mergeTags, campaign, campaignListsById, list, subscription) {
     if ((campaign.open_tracking_disabled && campaign.click_tracking_disabled) || !source || !source.trim()) {
         // tracking is disabled, do not modify the message
         return source;
@@ -173,7 +173,7 @@ async function updateLinks(source, tagLanguage, mergeTags, campaign, list, subsc
         const urls = new Map(); // url -> {id, cid} (as returned by add)
         for (const url of urlsToBeReplaced) {
             // url might include variables, need to rewrite those just as we do with message content
-            const expanedUrl = encodeURI(tools.formatCampaignTemplate(url, tagLanguage, mergeTags, false, campaign, list, subscription));
+            const expanedUrl = encodeURI(tools.formatCampaignTemplate(url, tagLanguage, mergeTags, false, campaign, campaignListsById, list, subscription));
             const link = await addOrGet(campaign.id, expanedUrl);
             urls.set(url, link);
         }