Add support for publishing full content in public archive RSS feed bo…

…dy (knadh#1262) - Introduces a new option on the settings UI to optionally publish the full campaign body in public archive RSS feeds. Closes knadh#1033 Co-authored-by: Kailash Nadh <[email protected]>
bhansa · Apr 8, 2023 · 476d5be · 476d5be
1 parent 146e8e7
commit 476d5be
Show file tree

Hide file tree

Showing 34 changed files with 176 additions and 43 deletions.
diff --git a/cmd/archive.go b/cmd/archive.go
@@ -16,6 +16,7 @@ import (
 type campArchive struct {
 	UUID      string    `json:"uuid"`
 	Subject   string    `json:"subject"`
+	Content   string    `json:"content"`
 	CreatedAt null.Time `json:"created_at"`
 	SendAt    null.Time `json:"send_at"`
 	URL       string    `json:"url"`
@@ -28,7 +29,7 @@ func handleGetCampaignArchives(c echo.Context) error {
 		pg  = app.paginator.NewFromURL(c.Request().URL.Query())
 	)
 
-	camps, total, err := getCampaignArchives(pg.Offset, pg.Limit, app)
+	camps, total, err := getCampaignArchives(pg.Offset, pg.Limit, false, app)
 	if err != nil {
 		return err
 	}
@@ -51,11 +52,12 @@ func handleGetCampaignArchives(c echo.Context) error {
 // handleGetCampaignArchivesFeed renders the public campaign archives RSS feed.
 func handleGetCampaignArchivesFeed(c echo.Context) error {
 	var (
-		app = c.Get("app").(*App)
-		pg  = app.paginator.NewFromURL(c.Request().URL.Query())
+		app             = c.Get("app").(*App)
+		pg              = app.paginator.NewFromURL(c.Request().URL.Query())
+		showFullContent = app.constants.EnablePublicArchiveRSSContent
 	)
 
-	camps, _, err := getCampaignArchives(pg.Offset, pg.Limit, app)
+	camps, _, err := getCampaignArchives(pg.Offset, pg.Limit, showFullContent, app)
 	if err != nil {
 		return err
 	}
@@ -71,6 +73,7 @@ func handleGetCampaignArchivesFeed(c echo.Context) error {
 		out = append(out, &feeds.Item{
 			Title:   c.Subject,
 			Link:    &feeds.Link{Href: c.URL},
+			Content: c.Content,
 			Created: pubDate,
 		})
 	}
@@ -97,7 +100,7 @@ func handleCampaignArchivesPage(c echo.Context) error {
 		pg  = app.paginator.NewFromURL(c.Request().URL.Query())
 	)
 
-	out, total, err := getCampaignArchives(pg.Offset, pg.Limit, app)
+	out, total, err := getCampaignArchives(pg.Offset, pg.Limit, false, app)
 	if err != nil {
 		return err
 	}
@@ -158,7 +161,28 @@ func handleCampaignArchivePage(c echo.Context) error {
 	return c.HTML(http.StatusOK, string(msg.Body()))
 }
 
-func getCampaignArchives(offset, limit int, app *App) ([]campArchive, int, error) {
+// handleCampaignArchivePageLatest renders the latest public campaign.
+func handleCampaignArchivePageLatest(c echo.Context) error {
+	var (
+		app = c.Get("app").(*App)
+	)
+
+	camps, _, err := getCampaignArchives(0, 1, true, app)
+	if err != nil {
+		return err
+	}
+
+	if len(camps) == 0 {
+		return c.Render(http.StatusNotFound, tplMessage,
+			makeMsgTpl(app.i18n.T("public.notFoundTitle"), "", app.i18n.T("public.campaignNotFound")))
+	}
+
+	camp := camps[0]
+
+	return c.HTML(http.StatusOK, camp.Content)
+}
+
+func getCampaignArchives(offset, limit int, renderBody bool, app *App) ([]campArchive, int, error) {
 	pubCamps, total, err := app.core.GetArchivedCampaigns(offset, limit)
 	if err != nil {
 		return []campArchive{}, total, echo.NewHTTPError(http.StatusInternalServerError, app.i18n.T("public.errorFetchingCampaign"))
@@ -172,13 +196,24 @@ func getCampaignArchives(offset, limit int, app *App) ([]campArchive, int, error
 	out := make([]campArchive, 0, len(msgs))
 	for _, m := range msgs {
 		camp := m.Campaign
-		out = append(out, campArchive{
+
+		archive := campArchive{
 			UUID:      camp.UUID,
 			Subject:   camp.Subject,
 			CreatedAt: camp.CreatedAt,
 			SendAt:    camp.SendAt,
 			URL:       app.constants.ArchiveURL + "/" + camp.UUID,
-		})
+		}
+
+		if renderBody {
+			msg, err := app.manager.NewCampaignMessage(camp, m.Subscriber)
+			if err != nil {
+				return []campArchive{}, total, err
+			}
+			archive.Content = string(msg.Body())
+		}
+
+		out = append(out, archive)
 	}
 
 	return out, total, nil

diff --git a/cmd/handlers.go b/cmd/handlers.go
@@ -202,6 +202,7 @@ func initHTTPHandlers(e *echo.Echo, app *App) {
 		e.GET("/archive", handleCampaignArchivesPage)
 		e.GET("/archive.xml", handleGetCampaignArchivesFeed)
 		e.GET("/archive/:uuid", handleCampaignArchivePage)
+		e.GET("/archive/latest", handleCampaignArchivePageLatest)
 	}
 
 	e.GET("/public/custom.css", serveCustomApperance("public.custom_css"))

diff --git a/cmd/init.go b/cmd/init.go
@@ -59,6 +59,7 @@ type constants struct {
 	NotifyEmails          []string `koanf:"notify_emails"`
 	EnablePublicSubPage   bool     `koanf:"enable_public_subscription_page"`
 	EnablePublicArchive   bool     `koanf:"enable_public_archive"`
+	EnablePublicArchiveRSSContent      bool     `koanf:"enable_public_archive_rss_content"`
 	SendOptinConfirmation bool     `koanf:"send_optin_confirmation"`
 	Lang                  string   `koanf:"lang"`
 	DBBatchSize           int      `koanf:"batch_size"`

diff --git a/cmd/upgrade.go b/cmd/upgrade.go
@@ -35,6 +35,7 @@ var migList = []migFunc{
 	{"v2.2.0", migrations.V2_2_0},
 	{"v2.3.0", migrations.V2_3_0},
 	{"v2.4.0", migrations.V2_4_0},
+	{"v2.5.0", migrations.V2_5_0},
 }
 
 // upgrade upgrades the database to the current version by running SQL migration files

diff --git a/frontend/src/views/settings/general.vue b/frontend/src/views/settings/general.vue
@@ -43,27 +43,45 @@
     </b-field>
 
     <hr />
-    <div class="columns">
-      <div class="column is-4">
-        <b-field :label="$t('settings.general.enablePublicSubPage')"
-          :message="$t('settings.general.enablePublicSubPageHelp')">
-          <b-switch v-model="data['app.enable_public_subscription_page']"
-              name="app.enable_public_subscription_page" />
-        </b-field>
-      </div>
-      <div class="column is-4">
-        <b-field :label="$t('settings.general.enablePublicArchive')"
-          :message="$t('settings.general.enablePublicArchiveHelp')">
-          <b-switch v-model="data['app.enable_public_archive']"
-              name="app.enable_public_archive" />
-        </b-field>
+
+    <div>
+      <h2 class="is-size-4 mb-5">{{ $tc('globals.terms.subscriptions', 2) }}</h2>
+      <div class="columns">
+        <div class="column is-4">
+          <b-field :label="$t('settings.general.enablePublicSubPage')"
+            :message="$t('settings.general.enablePublicSubPageHelp')">
+            <b-switch v-model="data['app.enable_public_subscription_page']"
+                name="app.enable_public_subscription_page" />
+          </b-field>
+        </div>
+        <div class="column is-4">
+          <b-field :label="$t('settings.general.sendOptinConfirm')"
+            :message="$t('settings.general.sendOptinConfirmHelp')">
+            <b-switch v-model="data['app.send_optin_confirmation']"
+                name="app.send_optin_confirmation" />
+          </b-field>
+        </div>
       </div>
-      <div class="column is-4">
-        <b-field :label="$t('settings.general.sendOptinConfirm')"
-          :message="$t('settings.general.sendOptinConfirmHelp')">
-          <b-switch v-model="data['app.send_optin_confirmation']"
-              name="app.send_optin_confirmation" />
-        </b-field>
+    </div>
+    <hr />
+
+    <div>
+      <h2 class="is-size-4 mb-5">{{ $t('campaigns.archive') }}</h2>
+      <div class="columns">
+        <div class="column is-4">
+          <b-field :label="$t('settings.general.enablePublicArchive')"
+            :message="$t('settings.general.enablePublicArchiveHelp')">
+            <b-switch v-model="data['app.enable_public_archive']"
+                name="app.enable_public_archive" />
+          </b-field>
+        </div>
+        <div class="column is-4">
+          <b-field :label="$t('settings.general.enablePublicArchiveRSSContent')"
+            :message="$t('settings.general.enablePublicArchiveRSSContentHelp')">
+            <b-switch v-model="data['app.enable_public_archive_rss_content']"
+                name="app.enable_public_archive_rss_content" />
+          </b-field>
+        </div>
       </div>
     </div>
 

diff --git a/i18n/ca.json b/i18n/ca.json
@@ -377,6 +377,8 @@
     "settings.general.checkUpdatesHelp": "Comprova periòdicament si hi ha noves versions d'aplicacions i notifica-ho.",
     "settings.general.enablePublicArchive": "Enable public mailing list archive page",
     "settings.general.enablePublicArchiveHelp": "Publica les campanyes on arxivar està habilitat en el lloc web públic.",
+    "settings.general.enablePublicArchiveRSSContent": "Show full content in RSS feed",
+    "settings.general.enablePublicArchiveRSSContentHelp": "Show full e-mail content in the RSS feed. If disabled, only the title and link elements are shown.",
     "settings.general.enablePublicSubPage": "Activa la pàgina de subscripció pública",
     "settings.general.enablePublicSubPageHelp": "Mostra una pàgina de subscripció pública amb totes les llistes públiques perquè la gent es subscrigui.",
     "settings.general.faviconURL": "Favicon URL",

diff --git a/i18n/cs-cz.json b/i18n/cs-cz.json
@@ -377,6 +377,8 @@
     "settings.general.checkUpdatesHelp": "Pravidelně kontrolovat nová vydání aplikace a upozornit.",
     "settings.general.enablePublicArchive": "Enable public mailing list archive page",
     "settings.general.enablePublicArchiveHelp": "Zveřejnit kampaně, pro které je povolena archivace na veřejné web stránce.",
+    "settings.general.enablePublicArchiveRSSContent": "Show full content in RSS feed",
+    "settings.general.enablePublicArchiveRSSContentHelp": "Show full e-mail content in the RSS feed. If disabled, only the title and link elements are shown.",
     "settings.general.enablePublicSubPage": "Povolit veřejnou stránku odběru",
     "settings.general.enablePublicSubPageHelp": "Zobrazit veřejnou stránku odběru se všemi veřejnými seznamy pro lidi k odběru.",
     "settings.general.faviconURL": "Adresa URL ikony favicon",

diff --git a/i18n/cy.json b/i18n/cy.json
@@ -377,6 +377,8 @@
     "settings.general.checkUpdatesHelp": "Gwirio ar gyfer apiau newydd sy'n cael eu rhyddhau o bryd i'w gilydd.",
     "settings.general.enablePublicArchive": "Galluogi archif rhestr bostio gyhoeddus",
     "settings.general.enablePublicArchiveHelp": "Cyhoeddi ymgyrchoedd lle mae archifo wedi'i alluogi ar y wefan gyhoeddus.",
+    "settings.general.enablePublicArchiveRSSContent": "Show full content in RSS feed",
+    "settings.general.enablePublicArchiveRSSContentHelp": "Show full e-mail content in the RSS feed. If disabled, only the title and link elements are shown.",
     "settings.general.enablePublicSubPage": "Galluogi tudalen tanysgrifio gyhoeddus",
     "settings.general.enablePublicSubPageHelp": "Dangos tudalen tanysgrifio gyhoeddus gyda'r holl restrau cyhoeddus y gall pobl danysgrifio iddynt.",
     "settings.general.faviconURL": "URL Favicon",

diff --git a/i18n/de.json b/i18n/de.json
@@ -377,6 +377,8 @@
     "settings.general.checkUpdatesHelp": "Prüfe regelmäßig nach Aktualisierungen und benachrichtige mich.",
     "settings.general.enablePublicArchive": "Enable public mailing list archive page",
     "settings.general.enablePublicArchiveHelp": "Veröffentlichen Sie Kampagnen, für die die Archivierung aktiviert ist, auf der öffentlichen Website.",
+    "settings.general.enablePublicArchiveRSSContent": "Show full content in RSS feed",
+    "settings.general.enablePublicArchiveRSSContentHelp": "Show full e-mail content in the RSS feed. If disabled, only the title and link elements are shown.",
     "settings.general.enablePublicSubPage": "Aktiviere eine öffentliche Abonnement Seite",
     "settings.general.enablePublicSubPageHelp": "Zeige eine öffentliche Abonnement Seite mit allen öffentlichen Listen, die Personen abonnieren können.",
     "settings.general.faviconURL": "Favicon URL",

diff --git a/i18n/en.json b/i18n/en.json
@@ -377,6 +377,8 @@
     "settings.general.checkUpdatesHelp": "Periodically check for new app releases and notify.",
     "settings.general.enablePublicArchive": "Enable public mailing list archive",
     "settings.general.enablePublicArchiveHelp": "Publish campaigns on which archiving is enabled on the public website.",
+    "settings.general.enablePublicArchiveRSSContent": "Show full content in RSS feed",
+    "settings.general.enablePublicArchiveRSSContentHelp": "Show full e-mail content in the RSS feed. If disabled, only the title and link elements are shown.",
     "settings.general.enablePublicSubPage": "Enable public subscription page",
     "settings.general.enablePublicSubPageHelp": "Show a public subscription page with all the public lists for people to subscribe.",
     "settings.general.faviconURL": "Favicon URL",

diff --git a/i18n/es.json b/i18n/es.json
@@ -378,6 +378,8 @@
     "settings.general.checkUpdatesHelp": "Periódicamente buscar nuevas actualizaciones y notificarme.",
     "settings.general.enablePublicArchive": "Habilitar la página de archivo público de listas de correo",
     "settings.general.enablePublicArchiveHelp": "Publicar en la web pública campañas en las que el archivo público está habilitado.",
+    "settings.general.enablePublicArchiveRSSContent": "Show full content in RSS feed",
+    "settings.general.enablePublicArchiveRSSContentHelp": "Show full e-mail content in the RSS feed. If disabled, only the title and link elements are shown.",
     "settings.general.enablePublicSubPage": "Habilitar pagina pública de suscripción",
     "settings.general.enablePublicSubPageHelp": "Muestra una página con todas las listas públicas para suscribirse.",
     "settings.general.faviconURL": "URL del Favicon",

diff --git a/i18n/fi.json b/i18n/fi.json
@@ -378,6 +378,8 @@
     "settings.general.checkUpdatesHelp": "Periodically check for new app releases and notify.",
     "settings.general.enablePublicArchive": "Enable public mailing list archive page",
     "settings.general.enablePublicArchiveHelp": "Publish campaigns on which archiving is enabled on the public website.",
+    "settings.general.enablePublicArchiveRSSContent": "Show full content in RSS feed",
+    "settings.general.enablePublicArchiveRSSContentHelp": "Show full e-mail content in the RSS feed. If disabled, only the title and link elements are shown.",
     "settings.general.enablePublicSubPage": "Enable public subscription page",
     "settings.general.enablePublicSubPageHelp": "Show a public subscription page with all the public lists for people to subscribe.",
     "settings.general.faviconURL": "Favicon URL",

diff --git a/i18n/fr.json b/i18n/fr.json
@@ -378,6 +378,8 @@
     "settings.general.checkUpdatesHelp": "Vérifier régulièrement si de nouvelles applications sont disponibles et notifier-les.",
     "settings.general.enablePublicArchive": "Activer la page publiques des emails archivés",
     "settings.general.enablePublicArchiveHelp": "Publier les campagnes pour lesquelles l'archivage est activé sur le site web public.",
+    "settings.general.enablePublicArchiveRSSContent": "Show full content in RSS feed",
+    "settings.general.enablePublicArchiveRSSContentHelp": "Show full e-mail content in the RSS feed. If disabled, only the title and link elements are shown.",
     "settings.general.enablePublicSubPage": "Activer la page d'abonnement publique",
     "settings.general.enablePublicSubPageHelp": "Afficher une page d'abonnement publique avec toutes les listes publiques auxquelles les personnes peuvent s'abonner.",
     "settings.general.faviconURL": "URL du favicon",

diff --git a/i18n/hu.json b/i18n/hu.json
@@ -377,6 +377,8 @@
     "settings.general.checkUpdatesHelp": "Rendszeresen ellenőrizze, és értesítsen, ha új alkalmazásverzió érhető el.",
     "settings.general.enablePublicArchive": "Nyilvános archívum",
     "settings.general.enablePublicArchiveHelp": "Nyilvános archívum felület engedélyezése, melyen az archivált kampányok megtekinthetők.",
+    "settings.general.enablePublicArchiveRSSContent": "Show full content in RSS feed",
+    "settings.general.enablePublicArchiveRSSContentHelp": "Show full e-mail content in the RSS feed. If disabled, only the title and link elements are shown.",
     "settings.general.enablePublicSubPage": "Nyilvános feliratkozás",
     "settings.general.enablePublicSubPageHelp": "Nyilvános feliratkozási felület engedélyezése, amelyen az összes nyilvános listára fel lehet iratkozni.",
     "settings.general.faviconURL": "Favicon URL",

diff --git a/i18n/it.json b/i18n/it.json
@@ -378,6 +378,8 @@
     "settings.general.checkUpdatesHelp": "Rutinariamente controllare se ci sono nuove versioni dell'app e notificami.",
     "settings.general.enablePublicArchive": "Abilita la pagina publica di archivio delle mail",
     "settings.general.enablePublicArchiveHelp": "Rendere pubbliche le campagne in qui l'archivio pubblico nella pagina web è stato abilitato.",
+    "settings.general.enablePublicArchiveRSSContent": "Show full content in RSS feed",
+    "settings.general.enablePublicArchiveRSSContentHelp": "Show full e-mail content in the RSS feed. If disabled, only the title and link elements are shown.",
     "settings.general.enablePublicSubPage": "Attiva la pagina di iscrizione pubblica",
     "settings.general.enablePublicSubPageHelp": "Visualizza una pagina di iscrizione pubblica con tutte le liste pubbliche a cui è possibile iscriversi.",
     "settings.general.faviconURL": "URL della favicon",

diff --git a/i18n/jp.json b/i18n/jp.json
@@ -378,6 +378,8 @@
     "settings.general.checkUpdatesHelp": "定期的に新しいアプリのリリースを確認し、通知する。",
     "settings.general.enablePublicArchive": "Enable public mailing list archive page",
     "settings.general.enablePublicArchiveHelp": "公開ウエブサイトに公開アーカイブOK設定されたキャンペーンを発行する。",
+    "settings.general.enablePublicArchiveRSSContent": "Show full content in RSS feed",
+    "settings.general.enablePublicArchiveRSSContentHelp": "Show full e-mail content in the RSS feed. If disabled, only the title and link elements are shown.",
     "settings.general.enablePublicSubPage": "公開サブスクリプションページを有効にする。",
     "settings.general.enablePublicSubPageHelp": "全ての公開リストを含む公開サブスクリプションページを表示し人々が加入できるようにする。",
     "settings.general.faviconURL": "ファビコンURL",

diff --git a/i18n/ml.json b/i18n/ml.json
@@ -377,6 +377,8 @@
     "settings.general.checkUpdatesHelp": "പുതിയ ആപ്പ് റിലീസുകൾക്കായി ഇടയ്ക്കിടെ പരിശോധിച്ച് അറിയിക്കുക.",
     "settings.general.enablePublicArchive": "പൊതു മെയിലിംഗ് ലിസ്റ്റ് ആർക്കൈവ് പ്രവർത്തനക്ഷമമാക്കുക",
     "settings.general.enablePublicArchiveHelp": "പൊതു വെബ്‌സൈറ്റിൽ ആർക്കൈവിംഗ് പ്രവർത്തനക്ഷമമാക്കിയ കാമ്പെയ്‌നുകൾ പ്രസിദ്ധീകരിക്കുക.",
+    "settings.general.enablePublicArchiveRSSContent": "Show full content in RSS feed",
+    "settings.general.enablePublicArchiveRSSContentHelp": "Show full e-mail content in the RSS feed. If disabled, only the title and link elements are shown.",
     "settings.general.enablePublicSubPage": "പൊതു സബ്‌സ്‌ക്രിപ്‌ഷൻ താൾ പ്രവർത്തനക്ഷമമാക്കുക",
     "settings.general.enablePublicSubPageHelp": "ആളുകൾക്ക് വരിക്കാരാകാനുള്ള എല്ലാ പൊതു ലിസ്റ്റുകളുമുള്ള പൊതുവായ ഒരു താൾ കാണിക്കുക.",
     "settings.general.faviconURL": "ഫാവ് ഐക്കൺ യൂ. ആർ. എൽ",

diff --git a/i18n/nl.json b/i18n/nl.json
@@ -377,6 +377,8 @@
     "settings.general.checkUpdatesHelp": "Controleer regelmatig voor nieuwe app releases en verwittig.",
     "settings.general.enablePublicArchive": "Enable public mailing list archive page",
     "settings.general.enablePublicArchiveHelp": "Publish campaigns on which archiving is enabled on the public website.",
+    "settings.general.enablePublicArchiveRSSContent": "Show full content in RSS feed",
+    "settings.general.enablePublicArchiveRSSContentHelp": "Show full e-mail content in the RSS feed. If disabled, only the title and link elements are shown.",
     "settings.general.enablePublicSubPage": "Publieke inschrijvingspagina inschakelen.",
     "settings.general.enablePublicSubPageHelp": "Laat een publieke inschrijvingspagina zien met alle publieke lijsten waarmee mensen zich kunnen inschrijven.",
     "settings.general.faviconURL": "Favicon URL",