gotosocial/internal/gtsmodel/notification.go

// 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

import (
	"strings"
	"time"
)

// Notification models an alert/notification sent to an account about something like a reblog, like, new follow request, etc.
type Notification struct {
	ID               string           `bun:"type:CHAR(26),pk,nullzero,notnull,unique"`                    // id of this item in the database
	CreatedAt        time.Time        `bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item created
	UpdatedAt        time.Time        `bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item last updated
	NotificationType NotificationType `bun:",nullzero,notnull"`                                           // Type of this notification
	TargetAccountID  string           `bun:"type:CHAR(26),nullzero,notnull"`                              // ID of the account targeted by the notification (ie., who will receive the notification?)
	TargetAccount    *Account         `bun:"-"`                                                           // Account corresponding to TargetAccountID. Can be nil, always check first + select using ID if necessary.
	OriginAccountID  string           `bun:"type:CHAR(26),nullzero,notnull"`                              // ID of the account that performed the action that created the notification.
	OriginAccount    *Account         `bun:"-"`                                                           // Account corresponding to OriginAccountID. Can be nil, always check first + select using ID if necessary.
	StatusOrEditID   string           `bun:"status_id,type:CHAR(26),nullzero"`                            // If the notification pertains to a status or a status edit event, what is the database ID of the status or status edit?
	Status           *Status          `bun:"-"`                                                           // Status corresponding to StatusOrEditID. Can be nil, always check first + select using ID if necessary.
	Read             *bool            `bun:",nullzero,notnull,default:false"`                             // Notification has been seen/read
}

// NotificationType describes the
// reason/type of this notification.
type NotificationType enumType

const (
	// Notification Types
	NotificationUnknown       NotificationType = 0  // NotificationUnknown -- unknown notification type, error if this occurs
	NotificationFollow        NotificationType = 1  // NotificationFollow -- someone followed you
	NotificationFollowRequest NotificationType = 2  // NotificationFollowRequest -- someone requested to follow you
	NotificationMention       NotificationType = 3  // NotificationMention -- someone mentioned you in their status
	NotificationReblog        NotificationType = 4  // NotificationReblog -- someone boosted one of your statuses
	NotificationFavourite     NotificationType = 5  // NotificationFavourite -- someone faved/liked one of your statuses
	NotificationPoll          NotificationType = 6  // NotificationPoll -- a poll you voted in or created has ended
	NotificationStatus        NotificationType = 7  // NotificationStatus -- someone you enabled notifications for has posted a status.
	NotificationAdminSignup   NotificationType = 8  // NotificationAdminSignup -- someone has submitted a new account sign-up to the instance.
	NotificationPendingFave   NotificationType = 9  // NotificationPendingFave -- Someone has faved a status of yours, which requires approval by you.
	NotificationPendingReply  NotificationType = 10 // NotificationPendingReply -- Someone has replied to a status of yours, which requires approval by you.
	NotificationPendingReblog NotificationType = 11 // NotificationPendingReblog -- Someone has boosted a status of yours, which requires approval by you.
	NotificationAdminReport   NotificationType = 12 // NotificationAdminReport -- someone has submitted a new report to the instance.
	NotificationUpdate        NotificationType = 13 // NotificationUpdate -- someone has edited their status.
	NotificationTypeNumValues NotificationType = 14 // NotificationTypeNumValues -- 1 + number of max notification type
)

// String returns a stringified, frontend API compatible form of NotificationType.
func (t NotificationType) String() string {
	switch t {
	case NotificationFollow:
		return "follow"
	case NotificationFollowRequest:
		return "follow_request"
	case NotificationMention:
		return "mention"
	case NotificationReblog:
		return "reblog"
	case NotificationFavourite:
		return "favourite"
	case NotificationPoll:
		return "poll"
	case NotificationStatus:
		return "status"
	case NotificationAdminSignup:
		return "admin.sign_up"
	case NotificationPendingFave:
		return "pending.favourite"
	case NotificationPendingReply:
		return "pending.reply"
	case NotificationPendingReblog:
		return "pending.reblog"
	case NotificationAdminReport:
		return "admin.report"
	case NotificationUpdate:
		return "update"
	default:
		panic("invalid notification type")
	}
}

// ParseNotificationType returns a notification type from the given value.
func ParseNotificationType(in string) NotificationType {
	switch strings.ToLower(in) {
	case "follow":
		return NotificationFollow
	case "follow_request":
		return NotificationFollowRequest
	case "mention":
		return NotificationMention
	case "reblog":
		return NotificationReblog
	case "favourite":
		return NotificationFavourite
	case "poll":
		return NotificationPoll
	case "status":
		return NotificationStatus
	case "admin.sign_up":
		return NotificationAdminSignup
	case "pending.favourite":
		return NotificationPendingFave
	case "pending.reply":
		return NotificationPendingReply
	case "pending.reblog":
		return NotificationPendingReblog
	case "admin.report":
		return NotificationAdminReport
	case "update":
		return NotificationUpdate
	default:
		return NotificationUnknown
	}
}