Skip to content

High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.

Add a `Preview` option to the campaign archive tab. Closes #2245.

Kailash Nadhed700d7a3362
diff --git a/cmd/campaigns.go b/cmd/campaigns.go
index 9c730a28..09993fff 100644
--- a/cmd/campaigns.go
+++ b/cmd/campaigns.go
@@ -195,6 +195,44 @@ func (a *App) PreviewCampaign(c echo.Context) error {
return c.HTML(http.StatusOK, string(msg.Body()))
}
+// PreviewCampaignArchive renders the public campaign archives page.
+func (a *App) PreviewCampaignArchive(c echo.Context) error {
+ // Get the campaign ID.
+ id := getID(c)
+
+ // Check if the user has access to the campaign.
+ if err := a.checkCampaignPerm(auth.PermTypeGet, id, c); err != nil {
+ return err
+ }
+
+ // Fetch the campaign body from the DB.
+ tplID, _ := strconv.Atoi(c.FormValue("template_id"))
+ camp, err := a.core.GetCampaignForPreview(id, tplID)
+ if err != nil {
+ return err
+ }
+
+ camp.ArchiveMeta = json.RawMessage([]byte(c.FormValue("archive_meta")))
+
+ // "Compile" the campaign template with appropriate data.
+ res, err := a.compileArchiveCampaigns([]models.Campaign{camp})
+ if err != nil {
+ return c.Render(http.StatusInternalServerError, tplMessage,
+ makeMsgTpl(a.i18n.T("public.errorTitle"), "", a.i18n.Ts("public.errorFetchingCampaign")))
+ }
+
+ // Render the campaign body.
+ out := res[0].Campaign
+ msg, err := a.manager.NewCampaignMessage(out, res[0].Subscriber)
+ if err != nil {
+ a.log.Printf("error rendering campaign: %v", err)
+ return c.Render(http.StatusInternalServerError, tplMessage,
+ makeMsgTpl(a.i18n.T("public.errorTitle"), "", a.i18n.Ts("public.errorFetchingCampaign")))
+ }
+
+ return c.HTML(http.StatusOK, string(msg.Body()))
+}
+
// CampaignContent handles campaign content (body) format conversions.
func (a *App) CampaignContent(c echo.Context) error {
var camp campContentReq
diff --git a/cmd/handlers.go b/cmd/handlers.go
index d05a462b..f3aa6b51 100644
--- a/cmd/handlers.go
+++ b/cmd/handlers.go
@@ -150,6 +150,7 @@ func initHTTPHandlers(e *echo.Echo, a *App) {
g.GET("/api/campaigns/:id", pm(hasID(a.GetCampaign), "campaigns:get_all", "campaigns:get"))
g.GET("/api/campaigns/analytics/:type", pm(a.GetCampaignViewAnalytics, "campaigns:get_analytics"))
g.GET("/api/campaigns/:id/preview", pm(hasID(a.PreviewCampaign), "campaigns:get_all", "campaigns:get"))
+ g.POST("/api/campaigns/:id/preview/archive", pm(hasID(a.PreviewCampaignArchive), "campaigns:get_all", "campaigns:get"))
g.POST("/api/campaigns/:id/preview", pm(hasID(a.PreviewCampaign), "campaigns:get_all", "campaigns:get"))
g.POST("/api/campaigns/:id/content", pm(hasID(a.CampaignContent), "campaigns:manage_all", "campaigns:manage"))
g.POST("/api/campaigns/:id/text", pm(hasID(a.PreviewCampaign), "campaigns:get"))
diff --git a/frontend/cypress/e2e/campaigns.cy.js b/frontend/cypress/e2e/campaigns.cy.js
index e299c9a8..fc892877 100644
--- a/frontend/cypress/e2e/campaigns.cy.js
+++ b/frontend/cypress/e2e/campaigns.cy.js
@@ -289,6 +289,7 @@ describe('Campaigns', () => {
} else if (c === 'visual') {
cy.wait(200);
cy.get('iframe').then((el) => {
+ cy.wait(200);
cy.wrap(el.contents()).find('table td').click();
cy.wait(200);
cy.wrap(el.contents()).find('textarea').eq(0).type(plainBody);
diff --git a/frontend/src/components/CampaignPreview.vue b/frontend/src/components/CampaignPreview.vue
index 632d1d6b..8ca99204 100644
--- a/frontend/src/components/CampaignPreview.vue
+++ b/frontend/src/components/CampaignPreview.vue
@@ -13,7 +13,8 @@
<input v-if="templateId" type="hidden" name="template_id" :value="templateId" />
<input v-if="contentType" type="hidden" name="content_type" :value="contentType" />
<input v-if="templateType" type="hidden" name="template_type" :value="templateType" />
- <input type="hidden" name="body" :value="body" />
+ <input v-if="archiveMeta" type="hidden" name="archive_meta" :value="archiveMeta" />
+ <input v-if="body" type="hidden" name="body" :value="body" />
</form>
<iframe id="iframe" name="iframe" ref="iframe" :title="title" :src="isPost ? 'about:blank' : previewURL"
@@ -48,9 +49,12 @@ export default {
// campaign | tx.
templateType: { type: String, default: '' },
+ archiveMeta: { type: String, default: null },
+
body: { type: String, default: '' },
contentType: { type: String, default: '' },
templateId: { type: [Number, null], default: null },
+ isArchive: { type: Boolean, default: false },
},
data() {
@@ -80,7 +84,7 @@ export default {
let uri = 'about:blank';
if (this.type === 'campaign') {
- uri = uris.previewCampaign;
+ uri = this.isArchive ? uris.previewCampaignArchive : uris.previewCampaign;
} else if (this.type === 'template') {
if (this.id) {
uri = uris.previewTemplate;
diff --git a/frontend/src/constants.js b/frontend/src/constants.js
index 7aff23d3..708928d7 100644
--- a/frontend/src/constants.js
+++ b/frontend/src/constants.js
@@ -28,6 +28,7 @@ const baseURL = import.meta.env.BASE_URL.replace(/\/$/, '');
export const uris = Object.freeze({
previewCampaign: '/api/campaigns/:id/preview',
+ previewCampaignArchive: '/api/campaigns/:id/preview/archive',
previewTemplate: '/api/templates/:id/preview',
previewRawTemplate: '/api/templates/preview',
exportSubscribers: '/api/subscribers/export',
diff --git a/frontend/src/views/Campaign.vue b/frontend/src/views/Campaign.vue
index 31dee5f9..739eca13 100644
--- a/frontend/src/views/Campaign.vue
+++ b/frontend/src/views/Campaign.vue
@@ -240,21 +240,23 @@
</div>
</b-field>
</div>
- <div class="column is-8 has-text-right">
- <b-field v-if="!canEdit && canArchive">
- <b-button @click="onUpdateCampaignArchive" :loading="loading.campaigns" type="is-primary"
- icon-left="content-save-outline" data-cy="btn-save">
- {{ $t('globals.buttons.saveChanges') }}
- </b-button>
+ <div class="column is-8">
+ <b-field grouped position="is-right">
+ <b-field v-if="!canEdit && canArchive">
+ <b-button @click="onUpdateCampaignArchive" :loading="loading.campaigns" type="is-primary"
+ icon-left="content-save-outline" data-cy="btn-save">
+ {{ $t('globals.buttons.saveChanges') }}
+ </b-button>
+ </b-field>
</b-field>
</div>
</div>
<div class="columns">
- <div class="column is-8">
+ <div class="column is-6">
<b-field :label="$tc('globals.terms.template')" label-position="on-border">
<b-select :placeholder="$tc('globals.terms.template')" v-model="form.archiveTemplateId" name="template"
- :disabled="!canArchive || !form.archive" required>
+ :disabled="!canArchive || !form.archive || form.content.contentType === 'visual'" required>
<template v-for="t in templates">
<option v-if="t.type === 'campaign'" :value="t.id" :key="t.id">
{{ t.name }}
@@ -264,9 +266,19 @@
</b-field>
</div>
- <div class="column has-text-right">
- <a v-if="!this.form.archiveMetaStr || this.form.archiveMetaStr === '{}'" class="button is-primary"
- href="#" @click.prevent="onFillArchiveMeta" aria-label="{}"><b-icon icon="code" /></a>
+ <div class="column is-6">
+ <b-field grouped position="is-right">
+ <b-field v-if="form.archive && (!this.form.archiveMetaStr || this.form.archiveMetaStr === '{}')">
+ <a class="button is-primary" href="#" @click.prevent="onFillArchiveMeta" aria-label="{}"><b-icon
+ icon="code" /></a>
+ </b-field>
+ <b-field v-if="form.archive">
+ <b-button @click="onToggleArchivePreview" type="is-primary" icon-left="file-find-outline"
+ data-cy="btn-preview">
+ {{ $t('campaigns.preview') }}
+ </b-button>
+ </b-field>
+ </b-field>
</div>
</div>
<b-field>
@@ -292,6 +304,10 @@
</section>
</div>
</b-modal>
+
+ <campaign-preview v-if="isPreviewingArchive" @close="onToggleArchivePreview" type="campaign" :id="data.id"
+ :archive-meta="form.archiveMetaStr" :title="data.title" :content-type="data.contentType"
+ :template-id="form.archiveTemplateId" is-post is-archive />
</section>
</template>
@@ -305,6 +321,7 @@ import CopyText from '../components/CopyText.vue';
import Editor from '../components/Editor.vue';
import ListSelector from '../components/ListSelector.vue';
import Media from './Media.vue';
+import CampaignPreview from '../components/CampaignPreview.vue';
export default Vue.extend({
components: {
@@ -312,6 +329,7 @@ export default Vue.extend({
Editor,
Media,
CopyText,
+ CampaignPreview,
},
data() {
@@ -329,6 +347,7 @@ export default Vue.extend({
isHeadersVisible: false,
isAttachFieldVisible: false,
isAttachModalOpen: false,
+ isPreviewingArchive: false,
activeTab: 'campaign',
data: {},
@@ -373,6 +392,10 @@ export default Vue.extend({
return dayjs(s).format('YYYY-MM-DD HH:mm');
},
+ onToggleArchivePreview() {
+ this.isPreviewingArchive = !this.isPreviewingArchive;
+ },
+
onAddAltBody() {
this.form.altbody = htmlToPlainText(this.form.content.body);
},
@@ -446,8 +469,6 @@ export default Vue.extend({
this.$utils.toast(e.toString(), 'is-danger');
return;
}
- } else {
- this.form.archiveMeta = {};
}
switch (typ) {