Skip to content

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

Refactor hardcoded string literals to global constants. Long pending.

Kailash Nadh0408cd4e4069
diff --git a/cmd/campaign_analytics.go b/cmd/campaign_analytics.go
index 6e2f7550..b371ac44 100644
--- a/cmd/campaign_analytics.go
+++ b/cmd/campaign_analytics.go
@@ -51,12 +51,12 @@ type analyticsView struct {
// ViewCampaignAnalytics renders the HTML view for campaign analytics.
func (a *App) ViewCampaignAnalytics(c echo.Context) error {
- return a.viewAnalytics(c, "campaigns")
+ return a.viewAnalytics(c, models.ResourceCampaigns)
}
// ViewListAnalytics renders analytics for selected lists.
func (a *App) ViewListAnalytics(c echo.Context) error {
- return a.viewAnalytics(c, "lists")
+ return a.viewAnalytics(c, models.ResourceLists)
}
func (a *App) viewAnalytics(c echo.Context, resource string) error {
@@ -68,7 +68,7 @@ func (a *App) viewAnalytics(c echo.Context, resource string) error {
}
getAll, permittedLists := user.GetPermittedLists(auth.PermTypeGet)
- if resource == "campaigns" {
+ if resource == models.ResourceCampaigns {
getAll, permittedLists = user.GetPermittedLists(auth.PermTypeGet | auth.PermTypeManage)
getAll = getAll || user.HasPerm(auth.PermCampaignsGetAll)
}
@@ -100,10 +100,10 @@ func (a *App) viewAnalytics(c echo.Context, resource string) error {
ShowUnique: a.cfg.Privacy.IndividualTracking && c.QueryParam("unique") == "true",
}
- data.CanViewCampaignCharts = resource == "campaigns" || (data.Can("campaigns:get", "campaigns:get_all") && data.Can("campaigns:get_analytics"))
+ data.CanViewCampaignCharts = resource == models.ResourceCampaigns || (data.Can(auth.PermCampaignsGet, auth.PermCampaignsGetAll) && data.Can(auth.PermCampaignsGetAnalytics))
if data.Interval == "" {
- data.Interval = "day"
+ data.Interval = models.AnalyticsIntervalDay
}
// Pull analytics for the selected campaigns or lists.
@@ -122,17 +122,17 @@ func (a *App) viewAnalytics(c echo.Context, resource string) error {
getCounts := a.core.GetCampaignAnalyticsCounts
getLinks := a.core.GetCampaignAnalyticsLinks
- if resource == "lists" {
+ if resource == models.ResourceLists {
getCounts = a.core.GetListAnalyticsCounts
getLinks = a.core.GetListAnalyticsLinks
- rows, err := getCounts(ids, "subscriptions", fromStr, toStr, data.Interval)
+ rows, err := getCounts(ids, models.AnalyticsTypeSubscriptions, fromStr, toStr, data.Interval)
if err != nil {
return err
}
data.Data.Subscriptions = rows
data.Counts.Subscriptions = sumAnalyticsCounts(rows)
- rows, err = getCounts(ids, "unsubscriptions", fromStr, toStr, data.Interval)
+ rows, err = getCounts(ids, models.AnalyticsTypeUnsubscriptions, fromStr, toStr, data.Interval)
if err != nil {
return err
}
@@ -140,32 +140,35 @@ func (a *App) viewAnalytics(c echo.Context, resource string) error {
data.Data.Unsubscriptions = rows
data.Counts.Unsubscriptions = sumAnalyticsCounts(rows)
}
+
if data.CanViewCampaignCharts {
var err error
- data.Data.Views, err = getCounts(ids, "total_views", fromStr, toStr, data.Interval)
+ data.Data.Views, err = getCounts(ids, models.AnalyticsTypeTotalViews, fromStr, toStr, data.Interval)
if err != nil {
return err
}
- data.Data.Clicks, err = getCounts(ids, "total_clicks", fromStr, toStr, data.Interval)
+ data.Data.Clicks, err = getCounts(ids, models.AnalyticsTypeTotalClicks, fromStr, toStr, data.Interval)
if err != nil {
return err
}
if data.ShowUnique {
- data.Data.UniqueViews, err = getCounts(ids, "views", fromStr, toStr, data.Interval)
+ data.Data.UniqueViews, err = getCounts(ids, models.AnalyticsTypeViews, fromStr, toStr, data.Interval)
if err != nil {
return err
}
- data.Data.UniqueClicks, err = getCounts(ids, "clicks", fromStr, toStr, data.Interval)
+
+ data.Data.UniqueClicks, err = getCounts(ids, models.AnalyticsTypeClicks, fromStr, toStr, data.Interval)
if err != nil {
return err
}
+
data.Counts.UniqueViews = sumAnalyticsCounts(data.Data.UniqueViews)
data.Counts.UniqueClicks = sumAnalyticsCounts(data.Data.UniqueClicks)
}
- data.Data.Bounces, err = getCounts(ids, "bounces", fromStr, toStr, data.Interval)
+ data.Data.Bounces, err = getCounts(ids, models.AnalyticsTypeBounces, fromStr, toStr, data.Interval)
if err != nil {
return err
}
@@ -186,12 +189,12 @@ func (a *App) viewAnalytics(c echo.Context, resource string) error {
// GetCampaignViewAnalytics retrieves analytics for campaigns.
func (a *App) GetCampaignViewAnalytics(c echo.Context) error {
- return a.getAnalytics(c, "campaigns")
+ return a.getAnalytics(c, models.ResourceCampaigns)
}
// GetListAnalytics retrieves analytics for lists.
func (a *App) GetListAnalytics(c echo.Context) error {
- return a.getAnalytics(c, "lists")
+ return a.getAnalytics(c, models.ResourceLists)
}
func (a *App) getAnalytics(c echo.Context, resource string) error {
@@ -208,13 +211,13 @@ func (a *App) getAnalytics(c echo.Context, resource string) error {
getCounts := a.core.GetCampaignAnalyticsCounts
getLinks := a.core.GetCampaignAnalyticsLinks
- if resource == "lists" {
+ if resource == models.ResourceLists {
user := auth.GetUser(c)
if err := user.HasListPerm(auth.PermTypeGet, ids...); err != nil {
return err
}
// Match the list page: campaign metrics require campaign analytics access.
- if typ := c.Param("type"); typ != "subscriptions" && typ != "unsubscriptions" {
+ if typ := c.Param("type"); typ != models.AnalyticsTypeSubscriptions && typ != models.AnalyticsTypeUnsubscriptions {
if !(user.HasPerm(auth.PermCampaignsGet) || user.HasPerm(auth.PermCampaignsGetAll)) || !user.HasPerm(auth.PermCampaignsGetAnalytics) {
return auth.ErrPermDenied
}
@@ -240,7 +243,7 @@ func (a *App) getAnalytics(c echo.Context, resource string) error {
}
// Link stats.
- if typ == "links" {
+ if typ == models.AnalyticsTypeLinks {
out, err := getLinks(ids, from, to)
if err != nil {
return err
@@ -251,14 +254,16 @@ func (a *App) getAnalytics(c echo.Context, resource string) error {
interval := c.QueryParam("interval")
if interval == "" {
- interval = "day"
+ interval = models.AnalyticsIntervalDay
}
// Views and clicks default to totals, with unique counts available when tracking is on.
if c.QueryParam("unique") != "true" || !a.cfg.Privacy.IndividualTracking {
switch typ {
- case "views", "clicks":
- typ = "total_" + typ
+ case models.AnalyticsTypeViews:
+ typ = models.AnalyticsTypeTotalViews
+ case models.AnalyticsTypeClicks:
+ typ = models.AnalyticsTypeTotalClicks
}
}
diff --git a/cmd/campaigns.go b/cmd/campaigns.go
index c472b44f..58b67949 100644
--- a/cmd/campaigns.go
+++ b/cmd/campaigns.go
@@ -14,6 +14,7 @@ import (
"time"
"github.com/knadh/listmonk/internal/auth"
+ "github.com/knadh/listmonk/internal/messenger/email"
"github.com/knadh/listmonk/internal/notifs"
"github.com/knadh/listmonk/models"
"github.com/labstack/echo/v4"
@@ -86,7 +87,7 @@ type campaignView struct {
// ViewNewCampaign renders the new campaign page (only the "campaign" tab).
func (a *App) ViewNewCampaign(c echo.Context) error {
var tpls []models.Template
- if can(auth.GetUser(c), "templates:get") {
+ if can(auth.GetUser(c), auth.PermTemplatesGet) {
var err error
tpls, err = a.core.GetTemplates("", "", true, "", "")
if err != nil {
@@ -163,7 +164,7 @@ func (a *App) ViewCampaign(c echo.Context) error {
}
var tpls []models.Template
- if can(auth.GetUser(c), "templates:get") {
+ if can(auth.GetUser(c), auth.PermTemplatesGet) {
var err error
tpls, err = a.core.GetTemplates("", "", true, "", "")
if err != nil {
@@ -473,7 +474,7 @@ func (a *App) CreateCampaign(c echo.Context) error {
}
if o.Messenger == "" {
- o.Messenger = "email"
+ o.Messenger = email.MessengerName
}
// Validate.
@@ -873,7 +874,7 @@ func (a *App) validateCampaignFields(c campReq) (campReq, error) {
if !a.manager.HasMessenger(c.Messenger) {
// If it's a specific SMTP, but it's no longer available (removed/disabled), fall back to general email messenger.
if strings.HasPrefix(c.Messenger, "email-") {
- c.Messenger = "email"
+ c.Messenger = email.MessengerName
} else {
return c, errors.New(a.i18n.Ts("campaigns.fieldInvalidMessenger", "name", c.Messenger))
}
diff --git a/cmd/dashboard.go b/cmd/dashboard.go
index cac11b4a..e6d0e2bc 100644
--- a/cmd/dashboard.go
+++ b/cmd/dashboard.go
@@ -133,7 +133,7 @@ func (a *App) getDashboardCampaigns(c echo.Context) (models.Campaigns, error) {
}
// Get scheduled campaigns to show on top of the dashboard.
- camps, _, err := a.core.QueryCampaigns("", []string{models.CampaignStatusScheduled}, nil, "", "created_at", "desc", hasAllPerm, permittedLists, 0, dashboardCampaignCount)
+ camps, _, err := a.core.QueryCampaigns("", []string{models.CampaignStatusScheduled}, nil, "", models.FieldCreatedAt, models.OrderDesc, hasAllPerm, permittedLists, 0, dashboardCampaignCount)
if err != nil {
return nil, err
}
@@ -146,7 +146,7 @@ func (a *App) getDashboardCampaigns(c echo.Context) (models.Campaigns, error) {
models.CampaignStatusPaused,
models.CampaignStatusFinished,
models.CampaignStatusCancelled,
- }, nil, "", "created_at", "desc", hasAllPerm, permittedLists, 0, rem)
+ }, nil, "", models.FieldCreatedAt, models.OrderDesc, hasAllPerm, permittedLists, 0, rem)
if err != nil {
return nil, err
}
diff --git a/cmd/handlers.go b/cmd/handlers.go
index e5ba7154..d8a5c442 100644
--- a/cmd/handlers.go
+++ b/cmd/handlers.go
@@ -84,48 +84,48 @@ func initHTTPHandlers(e *echo.Echo, a *App) {
g.GET(uriAdmin, a.ViewDashboard)
g.GET(path.Join(uriAdmin, "/lists"), a.ViewLists)
g.GET(path.Join(uriAdmin, "/lists/analytics"), a.ViewListAnalytics)
- g.GET(path.Join(uriAdmin, "/lists/new"), pm(a.ViewNewList, "lists:manage_all"))
+ g.GET(path.Join(uriAdmin, "/lists/new"), pm(a.ViewNewList, auth.PermListManageAll))
g.GET(path.Join(uriAdmin, "/lists/:id"), hasID(a.ViewList))
g.GET(path.Join(uriAdmin, "/lists/:id/edit"), hasID(a.ViewList))
g.GET(path.Join(uriAdmin, "/lists/forms"), a.ViewForms)
- g.GET(path.Join(uriAdmin, "/campaigns"), pm(a.ViewCampaigns, "campaigns:get_all", "campaigns:get"))
- g.GET(path.Join(uriAdmin, "/campaigns/media"), pm(a.ViewMedia, "media:get"))
- g.GET(path.Join(uriAdmin, "/campaigns/media/fragment"), pm(a.ViewMediaFragment, "media:get"))
- g.GET(path.Join(uriAdmin, "/campaigns/analytics"), pm(a.ViewCampaignAnalytics, "campaigns:get_analytics"))
- g.GET(path.Join(uriAdmin, "/campaigns/new"), pm(a.ViewNewCampaign, "campaigns:manage_all", "campaigns:manage"))
- g.GET(path.Join(uriAdmin, "/campaigns/:id"), pm(hasID(a.ViewCampaign), "campaigns:get_all", "campaigns:get"))
- g.GET(path.Join(uriAdmin, "/campaigns/:id/:tab"), pm(hasID(a.ViewCampaign), "campaigns:get_all", "campaigns:get"))
- g.GET(path.Join(uriAdmin, "/templates"), pm(a.ViewTemplates, "templates:get"))
- g.GET(path.Join(uriAdmin, "/templates/new"), pm(a.ViewNewTemplate, "templates:manage"))
- g.GET(path.Join(uriAdmin, "/templates/:id"), pm(hasID(a.ViewTemplate), "templates:get"))
- g.GET(path.Join(uriAdmin, "/subscribers/import"), pm(a.ViewImport, "subscribers:import"))
- g.GET(path.Join(uriAdmin, "/subscribers/bounces"), pm(a.ViewBounces, "bounces:get"))
- g.GET(path.Join(uriAdmin, "/subscribers"), pm(a.ViewSubscribers, "subscribers:get_all", "subscribers:get"))
- g.POST(path.Join(uriAdmin, "/subscribers"), pm(a.ViewSubscribers, "subscribers:get_all", "subscribers:get"))
- g.GET(path.Join(uriAdmin, "/subscribers/lists/:id"), pm(hasID(a.ViewSubscribers), "subscribers:get_all", "subscribers:get"))
- g.POST(path.Join(uriAdmin, "/subscribers/lists/:id"), pm(hasID(a.ViewSubscribers), "subscribers:get_all", "subscribers:get"))
- g.GET(path.Join(uriAdmin, "/subscribers/new"), pm(a.ViewNewSubscriber, "subscribers:manage"))
- g.GET(path.Join(uriAdmin, "/subscribers/:id/edit"), pm(hasID(a.ViewSubscriber), "subscribers:get_all", "subscribers:get"))
- g.GET(path.Join(uriAdmin, "/subscribers/:id"), pm(hasID(a.ViewSubscriberInfo), "subscribers:get_all", "subscribers:get"))
- g.GET(path.Join(uriAdmin, "/subscribers/:id/lists"), pm(hasID(a.ViewSubscriber), "subscribers:get_all", "subscribers:get"))
- g.GET(path.Join(uriAdmin, "/subscribers/:id/bounces"), pm(pm(hasID(a.ViewSubscriberBounces), "bounces:get"), "subscribers:get_all", "subscribers:get"))
+ g.GET(path.Join(uriAdmin, "/campaigns"), pm(a.ViewCampaigns, auth.PermCampaignsGetAll, auth.PermCampaignsGet))
+ g.GET(path.Join(uriAdmin, "/campaigns/media"), pm(a.ViewMedia, auth.PermMediaGet))
+ g.GET(path.Join(uriAdmin, "/campaigns/media/fragment"), pm(a.ViewMediaFragment, auth.PermMediaGet))
+ g.GET(path.Join(uriAdmin, "/campaigns/analytics"), pm(a.ViewCampaignAnalytics, auth.PermCampaignsGetAnalytics))
+ g.GET(path.Join(uriAdmin, "/campaigns/new"), pm(a.ViewNewCampaign, auth.PermCampaignsManageAll, auth.PermCampaignsManage))
+ g.GET(path.Join(uriAdmin, "/campaigns/:id"), pm(hasID(a.ViewCampaign), auth.PermCampaignsGetAll, auth.PermCampaignsGet))
+ g.GET(path.Join(uriAdmin, "/campaigns/:id/:tab"), pm(hasID(a.ViewCampaign), auth.PermCampaignsGetAll, auth.PermCampaignsGet))
+ g.GET(path.Join(uriAdmin, "/templates"), pm(a.ViewTemplates, auth.PermTemplatesGet))
+ g.GET(path.Join(uriAdmin, "/templates/new"), pm(a.ViewNewTemplate, auth.PermTemplatesManage))
+ g.GET(path.Join(uriAdmin, "/templates/:id"), pm(hasID(a.ViewTemplate), auth.PermTemplatesGet))
+ g.GET(path.Join(uriAdmin, "/subscribers/import"), pm(a.ViewImport, auth.PermSubscribersImport))
+ g.GET(path.Join(uriAdmin, "/subscribers/bounces"), pm(a.ViewBounces, auth.PermBouncesGet))
+ g.GET(path.Join(uriAdmin, "/subscribers"), pm(a.ViewSubscribers, auth.PermSubscribersGetAll, auth.PermSubscribersGet))
+ g.POST(path.Join(uriAdmin, "/subscribers"), pm(a.ViewSubscribers, auth.PermSubscribersGetAll, auth.PermSubscribersGet))
+ g.GET(path.Join(uriAdmin, "/subscribers/lists/:id"), pm(hasID(a.ViewSubscribers), auth.PermSubscribersGetAll, auth.PermSubscribersGet))
+ g.POST(path.Join(uriAdmin, "/subscribers/lists/:id"), pm(hasID(a.ViewSubscribers), auth.PermSubscribersGetAll, auth.PermSubscribersGet))
+ g.GET(path.Join(uriAdmin, "/subscribers/new"), pm(a.ViewNewSubscriber, auth.PermSubscribersManage))
+ g.GET(path.Join(uriAdmin, "/subscribers/:id/edit"), pm(hasID(a.ViewSubscriber), auth.PermSubscribersGetAll, auth.PermSubscribersGet))
+ g.GET(path.Join(uriAdmin, "/subscribers/:id"), pm(hasID(a.ViewSubscriberInfo), auth.PermSubscribersGetAll, auth.PermSubscribersGet))
+ g.GET(path.Join(uriAdmin, "/subscribers/:id/lists"), pm(hasID(a.ViewSubscriber), auth.PermSubscribersGetAll, auth.PermSubscribersGet))
+ g.GET(path.Join(uriAdmin, "/subscribers/:id/bounces"), pm(pm(hasID(a.ViewSubscriberBounces), auth.PermBouncesGet), auth.PermSubscribersGetAll, auth.PermSubscribersGet))
// Users and roles. Static segments are registered before the :id param routes.
- g.GET(path.Join(uriAdmin, "/users"), pm(a.ViewUsers, "users:get"))
- g.GET(path.Join(uriAdmin, "/users/new"), pm(a.ViewUser, "users:manage"))
- g.GET(path.Join(uriAdmin, "/users/roles"), pm(a.ViewUserRoles, "roles:get"))
- g.GET(path.Join(uriAdmin, "/users/roles/new"), pm(a.ViewUserRole, "roles:manage"))
- g.GET(path.Join(uriAdmin, "/users/roles/lists"), pm(a.ViewListRoles, "roles:get"))
- g.GET(path.Join(uriAdmin, "/users/roles/lists/new"), pm(a.ViewListRole, "roles:manage"))
- g.GET(path.Join(uriAdmin, "/users/roles/lists/:id"), pm(hasID(a.ViewListRole), "roles:get"))
- g.GET(path.Join(uriAdmin, "/users/roles/:id"), pm(hasID(a.ViewUserRole), "roles:get"))
- g.GET(path.Join(uriAdmin, "/users/:id"), pm(hasID(a.ViewUser), "users:get"))
+ g.GET(path.Join(uriAdmin, "/users"), pm(a.ViewUsers, auth.PermUsersGet))
+ g.GET(path.Join(uriAdmin, "/users/new"), pm(a.ViewUser, auth.PermUsersManage))
+ g.GET(path.Join(uriAdmin, "/users/roles"), pm(a.ViewUserRoles, auth.PermRolesGet))
+ g.GET(path.Join(uriAdmin, "/users/roles/new"), pm(a.ViewUserRole, auth.PermRolesManage))
+ g.GET(path.Join(uriAdmin, "/users/roles/lists"), pm(a.ViewListRoles, auth.PermRolesGet))
+ g.GET(path.Join(uriAdmin, "/users/roles/lists/new"), pm(a.ViewListRole, auth.PermRolesManage))
+ g.GET(path.Join(uriAdmin, "/users/roles/lists/:id"), pm(hasID(a.ViewListRole), auth.PermRolesGet))
+ g.GET(path.Join(uriAdmin, "/users/roles/:id"), pm(hasID(a.ViewUserRole), auth.PermRolesGet))
+ g.GET(path.Join(uriAdmin, "/users/:id"), pm(hasID(a.ViewUser), auth.PermUsersGet))
g.GET(path.Join(uriAdmin, "/user/profile"), a.ViewProfile)
// Settings.
- g.GET(path.Join(uriAdmin, "/settings"), pm(a.ViewSettings, "settings:get"))
- g.GET(path.Join(uriAdmin, "/settings/logs"), pm(a.ViewLogs, "settings:get"))
- g.GET(path.Join(uriAdmin, "/settings/maintenance"), pm(a.ViewMaintenance, "settings:maintain"))
+ g.GET(path.Join(uriAdmin, "/settings"), pm(a.ViewSettings, auth.PermSettingsGet))
+ g.GET(path.Join(uriAdmin, "/settings/logs"), pm(a.ViewLogs, auth.PermSettingsGet))
+ g.GET(path.Join(uriAdmin, "/settings/maintenance"), pm(a.ViewMaintenance, auth.PermSettingsMaintain))
}
// =================================================================
@@ -158,107 +158,107 @@ func initHTTPHandlers(e *echo.Echo, a *App) {
g.GET("/api/dashboard/counts", a.GetDashboardCounts)
g.GET("/api/dashboard/campaigns", a.GetDashboardCampaigns)
- g.GET("/api/settings", pm(a.GetSettings, "settings:get"))
- g.PUT("/api/settings", pm(a.UpdateSettings, "settings:manage"))
- g.PUT("/api/settings/:key", pm(a.UpdateSettingsByKey, "settings:manage"))
- g.POST("/api/settings/smtp/test", pm(a.TestSMTPSettings, "settings:manage"))
- g.POST("/api/admin/reload", pm(a.ReloadApp, "settings:manage"))
- g.GET("/api/logs", pm(a.GetLogs, "settings:get"))
- g.GET("/api/events", pm(a.EventStream, "settings:get"))
+ g.GET("/api/settings", pm(a.GetSettings, auth.PermSettingsGet))
+ g.PUT("/api/settings", pm(a.UpdateSettings, auth.PermSettingsManage))
+ g.PUT("/api/settings/:key", pm(a.UpdateSettingsByKey, auth.PermSettingsManage))
+ g.POST("/api/settings/smtp/test", pm(a.TestSMTPSettings, auth.PermSettingsManage))
+ g.POST("/api/admin/reload", pm(a.ReloadApp, auth.PermSettingsManage))
+ g.GET("/api/logs", pm(a.GetLogs, auth.PermSettingsGet))
+ g.GET("/api/events", pm(a.EventStream, auth.PermSettingsGet))
g.GET("/api/about", a.GetAboutInfo)
- g.GET("/api/subscribers", pm(a.QuerySubscribers, "subscribers:get_all", "subscribers:get"))
- g.GET("/api/subscribers/:id", pm(hasID(a.GetSubscriber), "subscribers:get_all", "subscribers:get"))
- g.GET("/api/subscribers/:id/activity", pm(hasID(a.GetSubscriberActivity), "subscribers:get_all", "subscribers:get"))
- g.DELETE("/api/subscribers/:id/activity/:type", pm(hasID(a.DeleteSubscriberActivity), "subscribers:manage"))
- g.GET("/api/subscribers/:id/export", pm(hasID(a.ExportSubscriberData), "subscribers:get_all", "subscribers:get"))
- g.GET("/api/subscribers/:id/bounces", pm(hasID(a.GetSubscriberBounces), "bounces:get"))
- g.DELETE("/api/subscribers/:id/bounces", pm(hasID(a.DeleteSubscriberBounces), "bounces:manage"))
- g.POST("/api/subscribers", pm(a.CreateSubscriber, "subscribers:manage"))
- g.PUT("/api/subscribers/:id", pm(hasID(a.UpdateSubscriber), "subscribers:manage"))
- g.PATCH("/api/subscribers/:id", pm(hasID(a.PatchSubscriber), "subscribers:manage"))
- g.POST("/api/subscribers/:id/optin", pm(hasID(a.SubscriberSendOptin), "subscribers:manage"))
- g.PUT("/api/subscribers/blocklist", pm(a.BlocklistSubscribers, "subscribers:manage"))
- g.PUT("/api/subscribers/:id/blocklist", pm(hasID(a.BlocklistSubscriber), "subscribers:manage"))
- g.PUT("/api/subscribers/lists/:id", pm(a.ManageSubscriberLists, "subscribers:manage"))
- g.PUT("/api/subscribers/lists", pm(a.ManageSubscriberLists, "subscribers:manage"))
- g.DELETE("/api/subscribers/:id", pm(hasID(a.DeleteSubscriber), "subscribers:manage"))
- g.DELETE("/api/subscribers", pm(a.DeleteSubscribers, "subscribers:manage"))
-
- g.GET("/api/bounces", pm(a.GetBounces, "bounces:get"))
- g.PUT("/api/bounces/blocklist", pm(a.BlocklistBouncedSubscribers, "bounces:manage"))
- g.GET("/api/bounces/:id", pm(hasID(a.GetBounce), "bounces:get"))
- g.DELETE("/api/bounces", pm(a.DeleteBounces, "bounces:manage"))
- g.DELETE("/api/bounces/:id", pm(hasID(a.DeleteBounce), "bounces:manage"))
+ g.GET("/api/subscribers", pm(a.QuerySubscribers, auth.PermSubscribersGetAll, auth.PermSubscribersGet))
+ g.GET("/api/subscribers/:id", pm(hasID(a.GetSubscriber), auth.PermSubscribersGetAll, auth.PermSubscribersGet))
+ g.GET("/api/subscribers/:id/activity", pm(hasID(a.GetSubscriberActivity), auth.PermSubscribersGetAll, auth.PermSubscribersGet))
+ g.DELETE("/api/subscribers/:id/activity/:type", pm(hasID(a.DeleteSubscriberActivity), auth.PermSubscribersManage))
+ g.GET("/api/subscribers/:id/export", pm(hasID(a.ExportSubscriberData), auth.PermSubscribersGetAll, auth.PermSubscribersGet))
+ g.GET("/api/subscribers/:id/bounces", pm(hasID(a.GetSubscriberBounces), auth.PermBouncesGet))
+ g.DELETE("/api/subscribers/:id/bounces", pm(hasID(a.DeleteSubscriberBounces), auth.PermBouncesManage))
+ g.POST("/api/subscribers", pm(a.CreateSubscriber, auth.PermSubscribersManage))
+ g.PUT("/api/subscribers/:id", pm(hasID(a.UpdateSubscriber), auth.PermSubscribersManage))
+ g.PATCH("/api/subscribers/:id", pm(hasID(a.PatchSubscriber), auth.PermSubscribersManage))
+ g.POST("/api/subscribers/:id/optin", pm(hasID(a.SubscriberSendOptin), auth.PermSubscribersManage))
+ g.PUT("/api/subscribers/blocklist", pm(a.BlocklistSubscribers, auth.PermSubscribersManage))
+ g.PUT("/api/subscribers/:id/blocklist", pm(hasID(a.BlocklistSubscriber), auth.PermSubscribersManage))
+ g.PUT("/api/subscribers/lists/:id", pm(a.ManageSubscriberLists, auth.PermSubscribersManage))
+ g.PUT("/api/subscribers/lists", pm(a.ManageSubscriberLists, auth.PermSubscribersManage))
+ g.DELETE("/api/subscribers/:id", pm(hasID(a.DeleteSubscriber), auth.PermSubscribersManage))
+ g.DELETE("/api/subscribers", pm(a.DeleteSubscribers, auth.PermSubscribersManage))
+
+ g.GET("/api/bounces", pm(a.GetBounces, auth.PermBouncesGet))
+ g.PUT("/api/bounces/blocklist", pm(a.BlocklistBouncedSubscribers, auth.PermBouncesManage))
+ g.GET("/api/bounces/:id", pm(hasID(a.GetBounce), auth.PermBouncesGet))
+ g.DELETE("/api/bounces", pm(a.DeleteBounces, auth.PermBouncesManage))
+ g.DELETE("/api/bounces/:id", pm(hasID(a.DeleteBounce), auth.PermBouncesManage))
// Subscriber operations based on arbitrary SQL queries.
// These aren't very REST-like.
- g.POST("/api/subscribers/query/delete", pm(a.DeleteSubscribersByQuery, "subscribers:manage"))
- g.PUT("/api/subscribers/query/blocklist", pm(a.BlocklistSubscribersByQuery, "subscribers:manage"))
- g.PUT("/api/subscribers/query/lists", pm(a.ManageSubscriberListsByQuery, "subscribers:manage"))
+ g.POST("/api/subscribers/query/delete", pm(a.DeleteSubscribersByQuery, auth.PermSubscribersManage))
+ g.PUT("/api/subscribers/query/blocklist", pm(a.BlocklistSubscribersByQuery, auth.PermSubscribersManage))
+ g.PUT("/api/subscribers/query/lists", pm(a.ManageSubscriberListsByQuery, auth.PermSubscribersManage))
g.GET("/api/subscribers/export",
- pm(middleware.GzipWithConfig(middleware.GzipConfig{Level: 9})(a.ExportSubscribers), "subscribers:get_all", "subscribers:get"))
+ pm(middleware.GzipWithConfig(middleware.GzipConfig{Level: 9})(a.ExportSubscribers), auth.PermSubscribersGetAll, auth.PermSubscribersGet))
- g.GET("/api/import/subscribers", pm(a.GetImportSubscribers, "subscribers:import"))
- g.GET("/api/import/subscribers/logs", pm(a.GetImportSubscriberStats, "subscribers:import"))
- g.POST("/api/import/subscribers", pm(a.ImportSubscribers, "subscribers:import"))
- g.DELETE("/api/import/subscribers", pm(a.StopImportSubscribers, "subscribers:import"))
+ g.GET("/api/import/subscribers", pm(a.GetImportSubscribers, auth.PermSubscribersImport))
+ g.GET("/api/import/subscribers/logs", pm(a.GetImportSubscriberStats, auth.PermSubscribersImport))
+ g.POST("/api/import/subscribers", pm(a.ImportSubscribers, auth.PermSubscribersImport))
+ g.DELETE("/api/import/subscribers", pm(a.StopImportSubscribers, auth.PermSubscribersImport))
// Individual list permissions are applied directly within handleGetLists.
g.GET("/api/lists", a.GetLists)
g.GET("/api/lists/analytics/:type", a.GetListAnalytics)
g.GET("/api/lists/:id", hasID(a.GetList))
- g.POST("/api/lists", pm(a.CreateList, "lists:manage_all"))
+ g.POST("/api/lists", pm(a.CreateList, auth.PermListManageAll))
g.PUT("/api/lists/:id", hasID(a.UpdateList))
g.DELETE("/api/lists", a.DeleteLists)
g.DELETE("/api/lists/:id", hasID(a.DeleteList))
- g.GET("/api/campaigns", pm(a.GetCampaigns, "campaigns:get_all", "campaigns:get"))
- g.GET("/api/campaigns/running/stats", pm(a.GetRunningCampaignStats, "campaigns:get_all", "campaigns:get"))
- 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"))
- g.POST("/api/campaigns/:id/test", pm(hasID(a.TestCampaign), "campaigns:manage_all", "campaigns:manage"))
- g.POST("/api/campaigns", pm(a.CreateCampaign, "campaigns:manage_all", "campaigns:manage"))
- g.PUT("/api/campaigns/:id", pm(hasID(a.UpdateCampaign), "campaigns:manage_all", "campaigns:manage"))
- g.PUT("/api/campaigns/:id/status", pm(hasID(a.UpdateCampaignStatus), "campaigns:send"))
- g.PUT("/api/campaigns/:id/archive", pm(hasID(a.UpdateCampaignArchive), "campaigns:manage_all", "campaigns:manage"))
- g.DELETE("/api/campaigns", pm(a.DeleteCampaigns, "campaigns:manage", "campaigns:manage_all"))
- g.DELETE("/api/campaigns/:id", pm(hasID(a.DeleteCampaign), "campaigns:manage_all", "campaigns:manage"))
-
- g.GET("/api/media", pm(a.GetAllMedia, "media:get"))
- g.GET("/api/media/:id", pm(hasID(a.GetMedia), "media:get"))
- g.POST("/api/media", pm(a.UploadMedia, "media:manage"))
- g.DELETE("/api/media/:id", pm(hasID(a.DeleteMedia), "media:manage"))
-
- g.GET("/api/templates", pm(a.GetTemplates, "templates:get"))
- g.GET("/api/templates/:id", pm(hasID(a.GetTemplate), "templates:get"))
- g.GET("/api/templates/:id/preview", pm(hasID(a.PreviewTemplate), "templates:get"))
- g.POST("/api/templates/preview", pm(a.PreviewTemplateBody, "templates:get"))
- g.POST("/api/templates", pm(a.CreateTemplate, "templates:manage"))
- g.PUT("/api/templates/:id", pm(hasID(a.UpdateTemplate), "templates:manage"))
- g.PUT("/api/templates/:id/default", pm(hasID(a.TemplateSetDefault), "templates:manage"))
- g.DELETE("/api/templates/:id", pm(hasID(a.DeleteTemplate), "templates:manage"))
-
- g.DELETE("/api/maintenance/subscribers/:type", pm(a.GCSubscribers, "settings:maintain"))
- g.DELETE("/api/maintenance/analytics/:type", pm(a.GCCampaignAnalytics, "settings:maintain"))
- g.GET("/api/maintenance/analytics/:type/export", pm(a.ExportCampaignAnalytics, "settings:maintain"))
- g.DELETE("/api/maintenance/subscriptions/unconfirmed", pm(a.GCSubscriptions, "settings:maintain"))
-
- g.POST("/api/tx", pm(a.SendTxMessage, "tx:send"))
+ g.GET("/api/campaigns", pm(a.GetCampaigns, auth.PermCampaignsGetAll, auth.PermCampaignsGet))
+ g.GET("/api/campaigns/running/stats", pm(a.GetRunningCampaignStats, auth.PermCampaignsGetAll, auth.PermCampaignsGet))
+ g.GET("/api/campaigns/:id", pm(hasID(a.GetCampaign), auth.PermCampaignsGetAll, auth.PermCampaignsGet))
+ g.GET("/api/campaigns/analytics/:type", pm(a.GetCampaignViewAnalytics, auth.PermCampaignsGetAnalytics))
+ g.GET("/api/campaigns/:id/preview", pm(hasID(a.PreviewCampaign), auth.PermCampaignsGetAll, auth.PermCampaignsGet))
+ g.POST("/api/campaigns/:id/preview/archive", pm(hasID(a.PreviewCampaignArchive), auth.PermCampaignsGetAll, auth.PermCampaignsGet))
+ g.POST("/api/campaigns/:id/preview", pm(hasID(a.PreviewCampaign), auth.PermCampaignsGetAll, auth.PermCampaignsGet))
+ g.POST("/api/campaigns/:id/content", pm(hasID(a.CampaignContent), auth.PermCampaignsManageAll, auth.PermCampaignsManage))
+ g.POST("/api/campaigns/:id/text", pm(hasID(a.PreviewCampaign), auth.PermCampaignsGet))
+ g.POST("/api/campaigns/:id/test", pm(hasID(a.TestCampaign), auth.PermCampaignsManageAll, auth.PermCampaignsManage))
+ g.POST("/api/campaigns", pm(a.CreateCampaign, auth.PermCampaignsManageAll, auth.PermCampaignsManage))
+ g.PUT("/api/campaigns/:id", pm(hasID(a.UpdateCampaign), auth.PermCampaignsManageAll, auth.PermCampaignsManage))
+ g.PUT("/api/campaigns/:id/status", pm(hasID(a.UpdateCampaignStatus), auth.PermCampaignsSend))
+ g.PUT("/api/campaigns/:id/archive", pm(hasID(a.UpdateCampaignArchive), auth.PermCampaignsManageAll, auth.PermCampaignsManage))
+ g.DELETE("/api/campaigns", pm(a.DeleteCampaigns, auth.PermCampaignsManage, auth.PermCampaignsManageAll))
+ g.DELETE("/api/campaigns/:id", pm(hasID(a.DeleteCampaign), auth.PermCampaignsManageAll, auth.PermCampaignsManage))
+
+ g.GET("/api/media", pm(a.GetAllMedia, auth.PermMediaGet))
+ g.GET("/api/media/:id", pm(hasID(a.GetMedia), auth.PermMediaGet))
+ g.POST("/api/media", pm(a.UploadMedia, auth.PermMediaManage))
+ g.DELETE("/api/media/:id", pm(hasID(a.DeleteMedia), auth.PermMediaManage))
+
+ g.GET("/api/templates", pm(a.GetTemplates, auth.PermTemplatesGet))
+ g.GET("/api/templates/:id", pm(hasID(a.GetTemplate), auth.PermTemplatesGet))
+ g.GET("/api/templates/:id/preview", pm(hasID(a.PreviewTemplate), auth.PermTemplatesGet))
+ g.POST("/api/templates/preview", pm(a.PreviewTemplateBody, auth.PermTemplatesGet))
+ g.POST("/api/templates", pm(a.CreateTemplate, auth.PermTemplatesManage))
+ g.PUT("/api/templates/:id", pm(hasID(a.UpdateTemplate), auth.PermTemplatesManage))
+ g.PUT("/api/templates/:id/default", pm(hasID(a.TemplateSetDefault), auth.PermTemplatesManage))
+ g.DELETE("/api/templates/:id", pm(hasID(a.DeleteTemplate), auth.PermTemplatesManage))
+
+ g.DELETE("/api/maintenance/subscribers/:type", pm(a.GCSubscribers, auth.PermSettingsMaintain))
+ g.DELETE("/api/maintenance/analytics/:type", pm(a.GCCampaignAnalytics, auth.PermSettingsMaintain))
+ g.GET("/api/maintenance/analytics/:type/export", pm(a.ExportCampaignAnalytics, auth.PermSettingsMaintain))
+ g.DELETE("/api/maintenance/subscriptions/unconfirmed", pm(a.GCSubscriptions, auth.PermSettingsMaintain))
+
+ g.POST("/api/tx", pm(a.SendTxMessage, auth.PermTxSend))
g.GET("/api/profile", a.GetUserProfile)
g.PUT("/api/profile", a.UpdateUserProfile)
- g.GET("/api/users", pm(a.GetUsers, "users:get"))
- g.GET("/api/users/:id", pm(hasID(a.GetUser), "users:get"))
- g.POST("/api/users", pm(a.CreateUser, "users:manage"))
- g.PUT("/api/users/:id", pm(hasID(a.UpdateUser), "users:manage"))
- g.DELETE("/api/users", pm(a.DeleteUsers, "users:manage"))
- g.DELETE("/api/users/:id", pm(hasID(a.DeleteUser), "users:manage"))
+ g.GET("/api/users", pm(a.GetUsers, auth.PermUsersGet))
+ g.GET("/api/users/:id", pm(hasID(a.GetUser), auth.PermUsersGet))
+ g.POST("/api/users", pm(a.CreateUser, auth.PermUsersManage))
+ g.PUT("/api/users/:id", pm(hasID(a.UpdateUser), auth.PermUsersManage))
+ g.DELETE("/api/users", pm(a.DeleteUsers, auth.PermUsersManage))
+ g.DELETE("/api/users/:id", pm(hasID(a.DeleteUser), auth.PermUsersManage))
g.POST("/api/logout", a.Logout)
// TOTP 2FA endpoints
@@ -266,17 +266,17 @@ func initHTTPHandlers(e *echo.Echo, a *App) {
g.PUT("/api/users/:id/twofa", hasID(a.EnableTOTP))
g.DELETE("/api/users/:id/twofa", hasID(a.DisableTOTP))
- g.GET("/api/roles/users", pm(a.GetUserRoles, "roles:get"))
- g.GET("/api/roles/lists", pm(a.GeListRoles, "roles:get"))
- g.POST("/api/roles/users", pm(a.CreateUserRole, "roles:manage"))
- g.POST("/api/roles/lists", pm(a.CreateListRole, "roles:manage"))
- g.PUT("/api/roles/users/:id", pm(hasID(a.UpdateUserRole), "roles:manage"))
- g.PUT("/api/roles/lists/:id", pm(hasID(a.UpdateListRole), "roles:manage"))
- g.DELETE("/api/roles/:id", pm(hasID(a.DeleteRole), "roles:manage"))
+ g.GET("/api/roles/users", pm(a.GetUserRoles, auth.PermRolesGet))
+ g.GET("/api/roles/lists", pm(a.GeListRoles, auth.PermRolesGet))
+ g.POST("/api/roles/users", pm(a.CreateUserRole, auth.PermRolesManage))
+ g.POST("/api/roles/lists", pm(a.CreateListRole, auth.PermRolesManage))
+ g.PUT("/api/roles/users/:id", pm(hasID(a.UpdateUserRole), auth.PermRolesManage))
+ g.PUT("/api/roles/lists/:id", pm(hasID(a.UpdateListRole), auth.PermRolesManage))
+ g.DELETE("/api/roles/:id", pm(hasID(a.DeleteRole), auth.PermRolesManage))
if a.cfg.BounceWebhooksEnabled {
// Private authenticated bounce endpoint.
- g.POST("/webhooks/bounce", pm(a.BounceWebhook, "webhooks:post_bounce"))
+ g.POST("/webhooks/bounce", pm(a.BounceWebhook, auth.PermWebhooksPostBounce))
}
}
diff --git a/cmd/init.go b/cmd/init.go
index 3f08a743..f2507a7d 100644
--- a/cmd/init.go
+++ b/cmd/init.go
@@ -65,8 +65,6 @@ import (
const (
// Path to the SQL queries directory in the embedded FS.
queryFilePath = "/queries"
-
- emailMsgr = "email"
)
// UrlConfig contains various URL constants used in the app.
@@ -816,7 +814,7 @@ func initPostbackMessengers(ko *koanf.Koanf) []manager.Messenger {
// initMediaStore initializes Upload manager with a custom backend.
func initMediaStore(ko *koanf.Koanf) media.Store {
switch provider := ko.String("upload.provider"); provider {
- case "s3":
+ case media.ProviderS3:
var o s3.Opt
ko.Unmarshal("upload.s3", &o)
o.RootURL = ko.String("app.root_url")
@@ -828,7 +826,7 @@ func initMediaStore(ko *koanf.Koanf) media.Store {
lo.Println("media upload provider: s3")
return up
- case "filesystem":
+ case media.ProviderFilesystem:
var o filesystem.Opts
ko.Unmarshal("upload.filesystem", &o)
@@ -1064,9 +1062,9 @@ func initHTTPServer(cfg *Config, urlCfg *UrlConfig, i *i18n.I18n, fs stuffbin.Fi
publicURL = ko.String("upload.s3.public_url")
)
switch {
- case uploadProvider == "filesystem" && uploadFsURI != "":
+ case uploadProvider == media.ProviderFilesystem && uploadFsURI != "":
srv.Static(uploadFsURI, ko.String("upload.filesystem.upload_path"))
- case uploadProvider == "s3" && strings.HasPrefix(publicURL, "/"):
+ case uploadProvider == media.ProviderS3 && strings.HasPrefix(publicURL, "/"):
srv.GET(path.Join(publicURL, "/:filepath"), app.ServeS3Media)
}
diff --git a/cmd/install.go b/cmd/install.go
index 2771fe48..ecc53fd4 100644
--- a/cmd/install.go
+++ b/cmd/install.go
@@ -9,6 +9,7 @@ import (
"github.com/gofrs/uuid/v5"
"github.com/jmoiron/sqlx"
"github.com/knadh/listmonk/internal/auth"
+ "github.com/knadh/listmonk/internal/messenger/email"
"github.com/knadh/listmonk/internal/utils"
"github.com/knadh/listmonk/models"
"github.com/knadh/stuffbin"
@@ -262,7 +263,7 @@ func installCampaign(campTplID, archiveTplID int, q *models.Queries) {
json.RawMessage("[]"),
json.RawMessage("{}"),
pq.StringArray{"test-campaign"},
- emailMsgr,
+ email.MessengerName,
campTplID,
pq.Int64Array{1},
false,
diff --git a/cmd/lists.go b/cmd/lists.go
index 77c368b8..ae304c3a 100644
--- a/cmd/lists.go
+++ b/cmd/lists.go
@@ -130,7 +130,7 @@ func (a *App) ViewList(c echo.Context) error {
}
if tab == "list" {
- data.CanViewCampaignCharts = data.Can("campaigns:get", "campaigns:get_all") && data.Can("campaigns:get_analytics")
+ data.CanViewCampaignCharts = data.Can(auth.PermCampaignsGet, auth.PermCampaignsGetAll) && data.Can(auth.PermCampaignsGetAnalytics)
data.CacheSlowQueries = ko.Bool("app.cache_slow_queries")
data.Charts, err = a.core.GetListCharts(id, data.CanViewCampaignCharts)
if err != nil {
@@ -138,7 +138,7 @@ func (a *App) ViewList(c echo.Context) error {
}
}
- if tab == "list" && data.Can("campaigns:get", "campaigns:get_all") {
+ if tab == "list" && data.Can(auth.PermCampaignsGet, auth.PermCampaignsGetAll) {
data.Campaigns, data.Page, err = a.getViewCampaigns(c, id)
if err != nil {
return err
diff --git a/cmd/main.go b/cmd/main.go
index fc250b50..c2d1b23d 100644
--- a/cmd/main.go
+++ b/cmd/main.go
@@ -246,7 +246,7 @@ func main() {
// Assign the default `email` messenger to the app.
for _, m := range msgrs {
- if m.Name() == "email" {
+ if m.Name() == email.MessengerName {
emailMsgr = m.(*email.Emailer)
}
}
diff --git a/cmd/maintenance.go b/cmd/maintenance.go
index c1fb3362..a3fefd9f 100644
--- a/cmd/maintenance.go
+++ b/cmd/maintenance.go
@@ -8,6 +8,7 @@ import (
"time"
"github.com/jmoiron/sqlx"
+ "github.com/knadh/listmonk/models"
"github.com/labstack/echo/v4"
)
@@ -97,9 +98,9 @@ func (a *App) GCCampaignAnalytics(c echo.Context) error {
return err
}
err = a.core.DeleteCampaignLinkClicks(t)
- case "views":
+ case models.AnalyticsTypeViews:
err = a.core.DeleteCampaignViews(t)
- case "clicks":
+ case models.AnalyticsTypeClicks:
err = a.core.DeleteCampaignLinkClicks(t)
default:
err = echo.NewHTTPError(http.StatusBadRequest, a.i18n.T("globals.messages.invalidData"))
@@ -120,7 +121,7 @@ func (a *App) ExportCampaignAnalytics(c echo.Context) error {
}
typ := c.Param("type")
- if typ != "views" && typ != "clicks" {
+ if typ != models.AnalyticsTypeViews && typ != models.AnalyticsTypeClicks {
return echo.NewHTTPError(http.StatusBadRequest, a.i18n.T("globals.messages.invalidData"))
}
@@ -133,8 +134,8 @@ func (a *App) ExportCampaignAnalytics(c echo.Context) error {
hdr.Set("Cache-Control", "no-cache")
switch typ {
- case "views":
- wr.Write([]string{"campaign_id", "campaign_uuid", "campaign_name", "subscriber_id", "subscriber_uuid", "email", "subscriber_name", "created_at"})
+ case models.AnalyticsTypeViews:
+ wr.Write([]string{"campaign_id", "campaign_uuid", "campaign_name", "subscriber_id", "subscriber_uuid", "email", "subscriber_name", models.FieldCreatedAt})
next := a.core.ExportCampaignViews(since, a.cfg.DBBatchSize)
for {
rows, err := next()
@@ -157,8 +158,8 @@ func (a *App) ExportCampaignAnalytics(c echo.Context) error {
wr.Flush()
}
- case "clicks":
- wr.Write([]string{"campaign_id", "campaign_uuid", "campaign_name", "subscriber_id", "subscriber_uuid", "email", "subscriber_name", "url", "created_at"})
+ case models.AnalyticsTypeClicks:
+ wr.Write([]string{"campaign_id", "campaign_uuid", "campaign_name", "subscriber_id", "subscriber_uuid", "email", "subscriber_name", "url", models.FieldCreatedAt})
next := a.core.ExportCampaignLinkClicks(since, a.cfg.DBBatchSize)
for {
rows, err := next()
diff --git a/cmd/roles.go b/cmd/roles.go
index e299fa3f..96c0cf45 100644
--- a/cmd/roles.go
+++ b/cmd/roles.go
@@ -15,8 +15,8 @@ import (
// rolesQueryDefaults is the allow list of filter query params.
var rolesQueryDefaults = map[string]string{
"query": "",
- "order_by": "created_at",
- "order": "asc",
+ "order_by": models.FieldCreatedAt,
+ "order": models.OrderAsc,
}
// roleRow is the normalized shape of a user/list role for the roles table view.
diff --git a/cmd/settings.go b/cmd/settings.go
index 268a42d0..5592e27e 100644
--- a/cmd/settings.go
+++ b/cmd/settings.go
@@ -166,7 +166,7 @@ func (a *App) UpdateSettings(c echo.Context) error {
// Validate and sanitize postback Messenger names along with SMTP names
// (where each SMTP is also considered as a standalone messenger).
// Duplicates are disallowed and "email" is a reserved name.
- names := map[string]bool{emailMsgr: true}
+ names := map[string]bool{email.MessengerName: true}
// There should be at least one SMTP block that's enabled.
has := false
diff --git a/cmd/subscribers.go b/cmd/subscribers.go
index 78c2ee0e..018b3430 100644
--- a/cmd/subscribers.go
+++ b/cmd/subscribers.go
@@ -495,7 +495,7 @@ func (a *App) ExportSubscribers(c echo.Context) error {
hdr.Set(echo.HeaderContentDisposition, "attachment; filename="+"subscribers.csv")
hdr.Set("Content-Transfer-Encoding", "binary")
hdr.Set("Cache-Control", "no-cache")
- wr.Write([]string{"uuid", "email", "name", "attributes", "status", "created_at", "updated_at"})
+ wr.Write([]string{"uuid", "email", "name", "attributes", "status", models.FieldCreatedAt, "updated_at"})
loop:
// Iterate in batches until there are no more subscribers to export.
@@ -801,11 +801,11 @@ func (a *App) ManageSubscriberLists(c echo.Context) error {
// Run the action in the DB.
var err error
switch req.Action {
- case "add":
+ case models.SubscriptionActionAdd:
err = a.core.AddSubscriptions(subIDs, listIDs, req.Status)
- case "remove":
+ case models.SubscriptionActionRemove:
err = a.core.DeleteSubscriptions(subIDs, listIDs)
- case "unsubscribe":
+ case models.SubscriptionActionUnsubscribe:
err = a.core.UnsubscribeLists(subIDs, listIDs, nil)
default:
return echo.NewHTTPError(http.StatusBadRequest, a.i18n.T("subscribers.invalidAction"))
@@ -969,11 +969,11 @@ func (a *App) ManageSubscriberListsByQuery(c echo.Context) error {
// Run the action in the DB.
var err error
switch req.Action {
- case "add":
+ case models.SubscriptionActionAdd:
err = a.core.AddSubscriptionsByQuery(req.Search, req.Query, sourceListIDs, targetListIDs, req.Status, req.SubscriptionStatus, req.SubscriberStatus)
- case "remove":
+ case models.SubscriptionActionRemove:
err = a.core.DeleteSubscriptionsByQuery(req.Search, req.Query, sourceListIDs, targetListIDs, req.SubscriptionStatus, req.SubscriberStatus)
- case "unsubscribe":
+ case models.SubscriptionActionUnsubscribe:
err = a.core.UnsubscribeListsByQuery(req.Search, req.Query, sourceListIDs, targetListIDs, req.SubscriptionStatus, req.SubscriberStatus)
default:
return echo.NewHTTPError(http.StatusBadRequest, a.i18n.T("subscribers.invalidAction"))
diff --git a/cmd/templates.go b/cmd/templates.go
index ef5516f7..dd319300 100644
--- a/cmd/templates.go
+++ b/cmd/templates.go
@@ -34,8 +34,8 @@ var (
templatesQueryDefaults = map[string]string{
"type": "",
"query": "",
- "order_by": "created_at",
- "order": "asc",
+ "order_by": models.FieldCreatedAt,
+ "order": models.OrderAsc,
}
)
diff --git a/cmd/tx.go b/cmd/tx.go
index eb545b16..3d56f0cc 100644
--- a/cmd/tx.go
+++ b/cmd/tx.go
@@ -9,6 +9,7 @@ import (
"strings"
"github.com/knadh/listmonk/internal/manager"
+ "github.com/knadh/listmonk/internal/messenger/email"
"github.com/knadh/listmonk/models"
"github.com/labstack/echo/v4"
)
@@ -238,7 +239,7 @@ func (a *App) validateTxMessage(m models.TxMessage) (models.TxMessage, error) {
}
if m.Messenger == "" {
- m.Messenger = emailMsgr
+ m.Messenger = email.MessengerName
} else if !a.manager.HasMessenger(m.Messenger) {
return m, echo.NewHTTPError(http.StatusBadRequest, a.i18n.Ts("campaigns.fieldInvalidMessenger", "name", m.Messenger))
}
diff --git a/cmd/users.go b/cmd/users.go
index 4faec63f..49efa936 100644
--- a/cmd/users.go
+++ b/cmd/users.go
@@ -25,8 +25,8 @@ var (
"status": "",
"user_role_id": "",
"list_role_id": "",
- "order_by": "created_at",
- "order": "asc",
+ "order_by": models.FieldCreatedAt,
+ "order": models.OrderAsc,
}
)
diff --git a/internal/core/analytics.go b/internal/core/analytics.go
index 380e5997..d83f34ee 100644
--- a/internal/core/analytics.go
+++ b/internal/core/analytics.go
@@ -18,8 +18,8 @@ func (c *Core) GetAnalyticsItems(resource string, ids []int, getAll bool, permit
stmt := c.q.GetListAnalyticsItems
switch resource {
- case "lists":
- case "campaigns":
+ case models.ResourceLists:
+ case models.ResourceCampaigns:
stmt = c.q.GetCampaignAnalyticsItems
default:
return nil, echo.NewHTTPError(http.StatusBadRequest, c.i18n.T("globals.messages.invalidData"))
@@ -40,7 +40,7 @@ func (c *Core) getAnalyticsCounts(stmt *sqlx.Stmt, ids []int, fromDate, toDate,
}
switch interval {
- case "hour", "day", "week", "month":
+ case models.AnalyticsIntervalHour, models.AnalyticsIntervalDay, models.AnalyticsIntervalWeek, models.AnalyticsIntervalMonth:
default:
return nil, echo.NewHTTPError(http.StatusBadRequest, c.i18n.T("globals.messages.invalidData"))
}
diff --git a/internal/core/bounces.go b/internal/core/bounces.go
index ea3b6f5c..85fa25a4 100644
--- a/internal/core/bounces.go
+++ b/internal/core/bounces.go
@@ -9,16 +9,16 @@ import (
"github.com/lib/pq"
)
-var bounceQuerySortFields = []string{"email", "campaign_name", "source", "created_at", "type"}
+var bounceQuerySortFields = []string{"email", "campaign_name", "source", models.FieldCreatedAt, "type"}
// QueryBounces retrieves paginated bounce entries based on the given params.
// It also returns the total number of bounce records in the DB.
func (c *Core) QueryBounces(campID, subID int, source, typ, orderBy, order string, offset, limit int) ([]models.Bounce, int, error) {
if !strSliceContains(orderBy, bounceQuerySortFields) {
- orderBy = "created_at"
+ orderBy = models.FieldCreatedAt
}
- if order != SortAsc && order != SortDesc {
- order = SortDesc
+ if order != models.OrderAsc && order != models.OrderDesc {
+ order = models.OrderDesc
}
out := []models.Bounce{}
@@ -40,7 +40,7 @@ func (c *Core) QueryBounces(campID, subID int, source, typ, orderBy, order strin
// GetBounce retrieves bounce entries based on the given params.
func (c *Core) GetBounce(id int) (models.Bounce, error) {
var out []models.Bounce
- stmt := strings.ReplaceAll(c.q.QueryBounces, "%order%", "id "+SortAsc)
+ stmt := strings.ReplaceAll(c.q.QueryBounces, "%order%", "id "+models.OrderAsc)
if err := c.db.Select(&out, stmt, id, 0, 0, "", "", 0, 1); err != nil {
c.log.Printf("error fetching bounces: %v", err)
return models.Bounce{}, echo.NewHTTPError(http.StatusInternalServerError,
diff --git a/internal/core/campaigns.go b/internal/core/campaigns.go
index 4c500a64..f3053c5b 100644
--- a/internal/core/campaigns.go
+++ b/internal/core/campaigns.go
@@ -385,15 +385,15 @@ func (c *Core) GetCampaignAnalyticsCounts(campIDs []int, typ, fromDate, toDate,
// Pick campaign view counts or click counts.
var stmt *sqlx.Stmt
switch typ {
- case "views":
+ case models.AnalyticsTypeViews:
stmt = c.q.GetCampaignViewCounts
- case "clicks":
+ case models.AnalyticsTypeClicks:
stmt = c.q.GetCampaignClickCounts
- case "total_views":
+ case models.AnalyticsTypeTotalViews:
stmt = c.q.GetCampaignTotalViewCounts
- case "total_clicks":
+ case models.AnalyticsTypeTotalClicks:
stmt = c.q.GetCampaignTotalClickCounts
- case "bounces":
+ case models.AnalyticsTypeBounces:
stmt = c.q.GetCampaignBounceCounts
default:
return nil, echo.NewHTTPError(http.StatusBadRequest, c.i18n.T("globals.messages.invalidData"))
diff --git a/internal/core/core.go b/internal/core/core.go
index 3a7fc5ab..32a67e3b 100644
--- a/internal/core/core.go
+++ b/internal/core/core.go
@@ -20,9 +20,6 @@ import (
)
const (
- SortAsc = "asc"
- SortDesc = "desc"
-
matDashboardCharts = "mat_dashboard_charts"
matDashboardCounts = "mat_dashboard_counts"
matListCharts = "mat_list_charts"
@@ -70,12 +67,12 @@ var (
var (
regexpSpaces = regexp.MustCompile(`[\s]+`)
- campQuerySortFields = []string{"name", "status", "created_at", "updated_at"}
- subQuerySortFields = []string{"email", "status", "name", "created_at", "updated_at"}
- userQuerySortFields = []string{"username", "email", "created_at", "loggedin_at"}
- roleQuerySortFields = []string{"name", "created_at", "updated_at"}
- templateQuerySortFields = []string{"name", "type", "created_at", "updated_at"}
- listQuerySortFields = []string{"name", "status", "created_at", "updated_at", "subscriber_count"}
+ campQuerySortFields = []string{"name", "status", models.FieldCreatedAt, "updated_at"}
+ subQuerySortFields = []string{"email", "status", "name", models.FieldCreatedAt, "updated_at"}
+ userQuerySortFields = []string{"username", "email", models.FieldCreatedAt, "loggedin_at"}
+ roleQuerySortFields = []string{"name", models.FieldCreatedAt, "updated_at"}
+ templateQuerySortFields = []string{"name", "type", models.FieldCreatedAt, "updated_at"}
+ listQuerySortFields = []string{"name", "status", models.FieldCreatedAt, "updated_at", "subscriber_count"}
)
// New returns a new instance of the core.
@@ -143,10 +140,10 @@ func makeSearchQuery(searchStr, orderBy, order, query string, querySortFields []
// Sort params.
if !strSliceContains(orderBy, querySortFields) {
- orderBy = "created_at"
+ orderBy = models.FieldCreatedAt
}
- if order != SortAsc && order != SortDesc {
- order = SortDesc
+ if order != models.OrderAsc && order != models.OrderDesc {
+ order = models.OrderDesc
}
query = strings.ReplaceAll(query, "%order%", orderBy+" "+order)
diff --git a/internal/core/lists.go b/internal/core/lists.go
index 48acb2da..70ab1326 100644
--- a/internal/core/lists.go
+++ b/internal/core/lists.go
@@ -243,19 +243,19 @@ func (c *Core) GetListCharts(id int, campaignViews bool) (types.JSONText, error)
func (c *Core) GetListAnalyticsCounts(ids []int, typ, fromDate, toDate, interval string) ([]models.CampaignAnalyticsCount, error) {
var stmt *sqlx.Stmt
switch typ {
- case "subscriptions":
+ case models.AnalyticsTypeSubscriptions:
stmt = c.q.GetListSubscriptionCounts
- case "unsubscriptions":
+ case models.AnalyticsTypeUnsubscriptions:
stmt = c.q.GetListUnsubscriptionCounts
- case "views":
+ case models.AnalyticsTypeViews:
stmt = c.q.GetListViewCounts
- case "clicks":
+ case models.AnalyticsTypeClicks:
stmt = c.q.GetListClickCounts
- case "total_views":
+ case models.AnalyticsTypeTotalViews:
stmt = c.q.GetListTotalViewCounts
- case "total_clicks":
+ case models.AnalyticsTypeTotalClicks:
stmt = c.q.GetListTotalClickCounts
- case "bounces":
+ case models.AnalyticsTypeBounces:
stmt = c.q.GetListBounceCounts
default:
return nil, echo.NewHTTPError(http.StatusBadRequest, c.i18n.T("globals.messages.invalidData"))
diff --git a/internal/core/roles.go b/internal/core/roles.go
index a4f00008..ad513518 100644
--- a/internal/core/roles.go
+++ b/internal/core/roles.go
@@ -5,6 +5,7 @@ import (
"net/http"
"github.com/knadh/listmonk/internal/auth"
+ "github.com/knadh/listmonk/models"
"github.com/labstack/echo/v4"
"github.com/lib/pq"
)
@@ -12,7 +13,7 @@ import (
// GetRoles retrieves all roles.
func (c *Core) GetRoles(searchStr, orderBy, order string) ([]auth.Role, error) {
if order == "" {
- order = SortAsc
+ order = models.OrderAsc
}
var (
@@ -30,7 +31,7 @@ func (c *Core) GetRoles(searchStr, orderBy, order string) ([]auth.Role, error) {
// GetRole retrieves a role.
func (c *Core) GetRole(id int) (auth.Role, error) {
out := []auth.Role{}
- _, stmt := makeSearchQuery("", "", SortAsc, c.q.GetUserRoles, roleQuerySortFields)
+ _, stmt := makeSearchQuery("", "", models.OrderAsc, c.q.GetUserRoles, roleQuerySortFields)
if err := c.db.Select(&out, stmt, id, ""); err != nil {
return auth.Role{}, echo.NewHTTPError(http.StatusInternalServerError,
c.i18n.Ts("globals.messages.errorFetching", "name", "role", "error", pqErrMsg(err)))
@@ -48,7 +49,7 @@ func (c *Core) GetRole(id int) (auth.Role, error) {
// GetListRoles retrieves all list roles.
func (c *Core) GetListRoles(searchStr, orderBy, order string) ([]auth.ListRole, error) {
if order == "" {
- order = SortAsc
+ order = models.OrderAsc
}
var (
diff --git a/internal/core/subscribers.go b/internal/core/subscribers.go
index 3a10c98a..9dd45dcc 100644
--- a/internal/core/subscribers.go
+++ b/internal/core/subscribers.go
@@ -109,8 +109,8 @@ func (c *Core) QuerySubscribers(searchStr, queryExp string, listIDs []int, subSt
if !strSliceContains(orderBy, subQuerySortFields) {
orderBy = "subscribers.id"
}
- if order != SortAsc && order != SortDesc {
- order = SortDesc
+ if order != models.OrderAsc && order != models.OrderDesc {
+ order = models.OrderDesc
}
// Required for pq.Array()
diff --git a/internal/core/templates.go b/internal/core/templates.go
index ed6a4a15..f137cc23 100644
--- a/internal/core/templates.go
+++ b/internal/core/templates.go
@@ -12,7 +12,7 @@ import (
// GetTemplates retrieves templates filtered by name and type.
func (c *Core) GetTemplates(searchStr, typ string, noBody bool, orderBy, order string) ([]models.Template, error) {
if order == "" {
- order = SortAsc
+ order = models.OrderAsc
}
var (
@@ -31,7 +31,7 @@ func (c *Core) GetTemplates(searchStr, typ string, noBody bool, orderBy, order s
func (c *Core) GetTemplate(id int, noBody bool) (models.Template, error) {
var (
out []models.Template
- _, stmt = makeSearchQuery("", "", SortAsc, c.q.GetTemplates, templateQuerySortFields)
+ _, stmt = makeSearchQuery("", "", models.OrderAsc, c.q.GetTemplates, templateQuerySortFields)
)
if err := c.db.Select(&out, stmt, id, noBody, "", ""); err != nil {
return models.Template{}, echo.NewHTTPError(http.StatusInternalServerError,
diff --git a/internal/core/users.go b/internal/core/users.go
index 4055b668..85a39868 100644
--- a/internal/core/users.go
+++ b/internal/core/users.go
@@ -8,6 +8,7 @@ import (
"github.com/knadh/listmonk/internal/auth"
"github.com/knadh/listmonk/internal/utils"
+ "github.com/knadh/listmonk/models"
"github.com/labstack/echo/v4"
"github.com/lib/pq"
"gopkg.in/volatiletech/null.v6"
@@ -16,7 +17,7 @@ import (
// GetUsers retrieves users.
func (c *Core) GetUsers(typ, status string, userRoleID, listRoleID int, orderBy, order string) ([]auth.User, error) {
if order == "" {
- order = SortAsc
+ order = models.OrderAsc
}
var (
diff --git a/internal/media/media.go b/internal/media/media.go
index bec2a5d2..0adc84ae 100644
--- a/internal/media/media.go
+++ b/internal/media/media.go
@@ -7,6 +7,12 @@ import (
"gopkg.in/volatiletech/null.v6"
)
+// Storage provider names.
+const (
+ ProviderS3 = "s3"
+ ProviderFilesystem = "filesystem"
+)
+
// Media represents an uploaded object.
type Media struct {
ID int `db:"id" json:"id"`
diff --git a/internal/notifs/notifs.go b/internal/notifs/notifs.go
index 7ff7b1f0..05d83375 100644
--- a/internal/notifs/notifs.go
+++ b/internal/notifs/notifs.go
@@ -96,7 +96,7 @@ func Notify(toEmails []string, subject, tplName string, data any, hdr textproto.
subject, body = GetTplSubject(subject, body)
m := models.Message{
- Messenger: "email",
+ Messenger: email.MessengerName,
ContentType: no.opt.ContentType,
From: no.opt.FromEmail,
To: toEmails,
diff --git a/models/common.go b/models/common.go
index 166b9b5a..fb1afbf2 100644
--- a/models/common.go
+++ b/models/common.go
@@ -35,6 +35,26 @@ const (
TwofaTypeNone = "none"
TwofaTypeTOTP = "totp"
+ // Resource names.
+ ResourceCampaigns = "campaigns"
+ ResourceLists = "lists"
+
+ // Analytics types.
+ AnalyticsTypeViews = "views"
+ AnalyticsTypeClicks = "clicks"
+ AnalyticsTypeTotalViews = "total_views"
+ AnalyticsTypeTotalClicks = "total_clicks"
+ AnalyticsTypeBounces = "bounces"
+ AnalyticsTypeSubscriptions = "subscriptions"
+ AnalyticsTypeUnsubscriptions = "unsubscriptions"
+ AnalyticsTypeLinks = "links"
+
+ // Analytics aggregation intervals.
+ AnalyticsIntervalHour = "hour"
+ AnalyticsIntervalDay = "day"
+ AnalyticsIntervalWeek = "week"
+ AnalyticsIntervalMonth = "month"
+
// Sort directions.
OrderAsc = "asc"
OrderDesc = "desc"
diff --git a/models/subscribers.go b/models/subscribers.go
index 4aaa3bbc..b2656d81 100644
--- a/models/subscribers.go
+++ b/models/subscribers.go
@@ -12,6 +12,10 @@ import (
)
const (
+ SubscriptionActionAdd = "add"
+ SubscriptionActionRemove = "remove"
+ SubscriptionActionUnsubscribe = "unsubscribe"
+
SubscriberStatusEnabled = "enabled"
SubscriberStatusDisabled = "disabled"
SubscriberStatusBlockListed = "blocklisted"