diff options
Diffstat (limited to 'internal/gtsmodel/webpushsubscription.go')
-rw-r--r-- | internal/gtsmodel/webpushsubscription.go | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/internal/gtsmodel/webpushsubscription.go b/internal/gtsmodel/webpushsubscription.go new file mode 100644 index 000000000..4aeef654a --- /dev/null +++ b/internal/gtsmodel/webpushsubscription.go @@ -0,0 +1,82 @@ +// GoToSocial +// Copyright (C) GoToSocial Authors admin@gotosocial.org +// SPDX-License-Identifier: AGPL-3.0-or-later +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see <http://www.gnu.org/licenses/>. + +package gtsmodel + +// WebPushSubscription represents an access token's Web Push subscription. +// There can be at most one per access token. +type WebPushSubscription struct { + // ID of this subscription in the database. + ID string `bun:"type:CHAR(26),pk,nullzero"` + + // AccountID of the local account that created this subscription. + AccountID string `bun:"type:CHAR(26),nullzero,notnull"` + + // TokenID is the ID of the associated access token. + // There can be at most one subscription for any given access token, + TokenID string `bun:"type:CHAR(26),nullzero,notnull,unique"` + + // Endpoint is the URL receiving Web Push notifications for this subscription. + Endpoint string `bun:",nullzero,notnull"` + + // Auth is a Base64-encoded authentication secret. + Auth string `bun:",nullzero,notnull"` + + // P256dh is a Base64-encoded Diffie-Hellman public key on the P-256 elliptic curve. + P256dh string `bun:",nullzero,notnull"` + + // NotificationFlags controls which notifications are delivered to a given subscription. + // Corresponds to model.PushSubscriptionAlerts. + NotificationFlags WebPushSubscriptionNotificationFlags `bun:",notnull"` +} + +// WebPushSubscriptionNotificationFlags is a bitfield representation of a set of NotificationType. +type WebPushSubscriptionNotificationFlags int64 + +// WebPushSubscriptionNotificationFlagsFromSlice packs a slice of NotificationType into a WebPushSubscriptionNotificationFlags. +func WebPushSubscriptionNotificationFlagsFromSlice(notificationTypes []NotificationType) WebPushSubscriptionNotificationFlags { + var n WebPushSubscriptionNotificationFlags + for _, notificationType := range notificationTypes { + n.Set(notificationType, true) + } + return n +} + +// ToSlice unpacks a WebPushSubscriptionNotificationFlags into a slice of NotificationType. +func (n *WebPushSubscriptionNotificationFlags) ToSlice() []NotificationType { + notificationTypes := make([]NotificationType, 0, NotificationTypeNumValues) + for notificationType := NotificationUnknown; notificationType < NotificationTypeNumValues; notificationType++ { + if n.Get(notificationType) { + notificationTypes = append(notificationTypes, notificationType) + } + } + return notificationTypes +} + +// Get tests to see if a given NotificationType is included in this set of flags. +func (n *WebPushSubscriptionNotificationFlags) Get(notificationType NotificationType) bool { + return *n&(1<<notificationType) != 0 +} + +// Set adds or removes a given NotificationType to or from this set of flags. +func (n *WebPushSubscriptionNotificationFlags) Set(notificationType NotificationType, value bool) { + if value { + *n |= 1 << notificationType + } else { + *n &= ^(1 << notificationType) + } +} |