Skip to content

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

Add new `campaigns:send` permission and separate it from `campaigns:manage`.

Kailash Nadhe9c1da1f25a1
diff --git a/cmd/handlers.go b/cmd/handlers.go
index c89408a2..ecc27639 100644
--- a/cmd/handlers.go
+++ b/cmd/handlers.go
@@ -170,7 +170,7 @@ func initHTTPHandlers(e *echo.Echo, a *App) {
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: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"))
diff --git a/docs/docs/content/roles-and-permissions.md b/docs/docs/content/roles-and-permissions.md
index 157d742c..16f77002 100644
--- a/docs/docs/content/roles-and-permissions.md
+++ b/docs/docs/content/roles-and-permissions.md
@@ -17,7 +17,9 @@ A user role is a collection of user related permissions. User roles are attached
| campaigns | campaigns:get | Get and view campaigns belonging to permitted lists |
| | campaigns:get_all | Get and view campaigns across all lists |
| | campaigns:get_analytics | Access campaign performance metrics |
-| | campaigns:manage | Create, update, and delete campaigns |
+| | campaigns:manage | Create, update, and delete campaigns belonging to permitted lists |
+| | campaigns:manage_all | Create, update, and delete campaigns across all lists |
+| | campaigns:send | Start, schedule, pause, resume, and cancel campaigns. This is independent of manage permissions. This is required to send a campaign, even with `campaigns:manage_all` |
| bounces | bounces:get | Get email bounce records |
| | bounces:manage | Process and handle bounced emails |
| | webhooks:post_bounce | Receive bounce notifications via webhook |
diff --git a/frontend/src/views/Campaign.vue b/frontend/src/views/Campaign.vue
index f1d56523..93362b03 100644
--- a/frontend/src/views/Campaign.vue
+++ b/frontend/src/views/Campaign.vue
@@ -23,27 +23,27 @@
</div>
<div class="column is-6">
- <div v-if="canManage" class="buttons">
+ <div v-if="canManage || canSend" class="buttons">
<b-field grouped v-if="isEditing && canEdit">
- <b-field expanded>
+ <b-field v-if="canManage" expanded>
<b-button expanded @click="() => onSubmit('update')" :loading="loading.campaigns" type="is-primary"
icon-left="content-save-outline" data-cy="btn-save" aria-keyshortcuts="ctrl+s">
<span class="has-kbd">{{ $t('globals.buttons.saveChanges') }} <span class="kbd">Ctrl+S</span></span>
</b-button>
</b-field>
- <b-field expanded v-if="canStart">
+ <b-field expanded v-if="canSend && canStart">
<b-button expanded @click="startCampaign" :loading="loading.campaigns" type="is-primary"
icon-left="rocket-launch-outline" data-cy="btn-start">
{{ $t('campaigns.start') }}
</b-button>
</b-field>
- <b-field expanded v-if="canSchedule">
+ <b-field expanded v-if="canSend && canSchedule">
<b-button expanded @click="startCampaign" :loading="loading.campaigns" type="is-primary"
icon-left="clock-start" data-cy="btn-schedule">
{{ $t('campaigns.schedule') }}
</b-button>
</b-field>
- <b-field expanded v-if="canUnSchedule">
+ <b-field expanded v-if="canSend && canUnSchedule">
<b-button expanded @click="$utils.confirm(null, unscheduleCampaign)" :loading="loading.campaigns"
type="is-primary" icon-left="clock-start" data-cy="btn-unschedule">
{{ $t('campaigns.unSchedule') }}
@@ -694,6 +694,10 @@ export default Vue.extend({
return this.$can('campaigns:manage_all', 'campaigns:manage');
},
+ canSend() {
+ return this.$can('campaigns:send');
+ },
+
canEdit() {
return this.isNew
|| this.data.status === 'draft' || this.data.status === 'scheduled' || this.data.status === 'paused';
diff --git a/frontend/src/views/Campaigns.vue b/frontend/src/views/Campaigns.vue
index b18eb3fa..1b411a83 100644
--- a/frontend/src/views/Campaigns.vue
+++ b/frontend/src/views/Campaigns.vue
@@ -184,7 +184,7 @@
<b-table-column v-slot="props" cell-class="actions" width="15%" align="right">
<div>
<!-- start / pause / resume / scheduled -->
- <template v-if="$can('campaigns:manage')">
+ <template v-if="$can('campaigns:send')">
<a v-if="canStart(props.row)" href="#"
@click.prevent="$utils.confirm(null, () => changeCampaignStatus(props.row, 'running'))"
data-cy="btn-start" :aria-label="$t('campaigns.start')">
diff --git a/internal/auth/models.go b/internal/auth/models.go
index 3e0579e4..bbd9d0aa 100644
--- a/internal/auth/models.go
+++ b/internal/auth/models.go
@@ -57,6 +57,7 @@ const (
PermCampaignsGetAnalytics = "campaigns:get_analytics"
PermCampaignsManage = "campaigns:manage"
PermCampaignsManageAll = "campaigns:manage_all"
+ PermCampaignsSend = "campaigns:send"
PermBouncesGet = "bounces:get"
PermBouncesManage = "bounces:manage"
PermWebhooksPostBounce = "webhooks:post_bounce"
diff --git a/internal/migrations/v6.1.0.go b/internal/migrations/v6.1.0.go
index 8026eea6..1db7a39c 100644
--- a/internal/migrations/v6.1.0.go
+++ b/internal/migrations/v6.1.0.go
@@ -72,5 +72,15 @@ func V6_1_0(db *sqlx.DB, fs stuffbin.FileSystem, ko *koanf.Koanf, lo *log.Logger
return err
}
+ // Grant 'campaigns:send' to all roles that previously had 'campaigns:manage' or 'campaigns:manage_all'
+ // for backwards compatibility. 'campaigns:send' is a new separate permission.
+ if _, err := db.Exec(`
+ UPDATE roles SET permissions = permissions || '{campaigns:send}'
+ WHERE (permissions @> '{campaigns:manage}' OR permissions @> '{campaigns:manage_all}')
+ AND NOT permissions @> '{campaigns:send}';
+ `); err != nil {
+ return err
+ }
+
return nil
-}
\ No newline at end of file
+}
diff --git a/permissions.json b/permissions.json
index dbdbd432..e6a01bf8 100644
--- a/permissions.json
+++ b/permissions.json
@@ -27,7 +27,8 @@
"campaigns:get_all",
"campaigns:get_analytics",
"campaigns:manage",
- "campaigns:manage_all"
+ "campaigns:manage_all",
+ "campaigns:send"
]
},
{