snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)

server/public/model/push_notification.go

@@ -0,0 +1,125 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package model
+
+import (
+	"slices"
+	"strings"
+)
+
+const (
+	PushNotifyApple              = "apple"
+	PushNotifyAndroid            = "android"
+	PushNotifyAppleReactNative   = "apple_rn"
+	PushNotifyAndroidReactNative = "android_rn"
+
+	PushTypeMessage     = "message"
+	PushTypeClear       = "clear"
+	PushTypeUpdateBadge = "update_badge"
+	PushTypeSession     = "session"
+	PushTypeTest        = "test"
+	PushMessageV2       = "v2"
+
+	PushSoundNone = "none"
+
+	// The category is set to handle a set of interactive Actions
+	// with the push notifications
+	CategoryCanReply = "CAN_REPLY"
+
+	// Push notification server URLs
+	// Legacy URLs are DNS aliases that automatically route to the regional endpoints
+	MHPNSLegacyUS = "https://push.mattermost.com"
+	MHPNSLegacyDE = "https://hpns-de.mattermost.com"
+	// Current regional URLs
+	MHPNSGlobal = "https://global.push.mattermost.com"
+	MHPNSUS     = "https://us.push.mattermost.com"
+	MHPNSEU     = "https://eu.push.mattermost.com"
+	MHPNSAP     = "https://ap.push.mattermost.com"
+	MHPNS       = MHPNSUS // Legacy constant for backwards compatibility
+
+	PushSendPrepare = "Prepared to send"
+	PushSendSuccess = "Successful"
+	PushNotSent     = "Not Sent due to preferences"
+	PushReceived    = "Received by device"
+)
+
+// IsMHPNSEndpoint reports whether the given push notification server URL is one of the
+// Mattermost-hosted (HPNS) production endpoints.
+func IsMHPNSEndpoint(url string) bool {
+	return slices.Contains([]string{
+		MHPNSLegacyUS,
+		MHPNSLegacyDE,
+		MHPNSGlobal,
+		MHPNSUS,
+		MHPNSEU,
+		MHPNSAP,
+	}, url)
+}
+
+// PushSubType allows for passing additional message type information
+// to mobile clients in a backwards-compatible way
+type PushSubType string
+
+// PushSubTypeCalls is used by the Calls plugin
+const PushSubTypeCalls PushSubType = "calls"
+
+// PushTransport selects which delivery path the push proxy uses.
+type PushTransport string
+
+const (
+	PushTransportStandard PushTransport = ""
+	PushTransportVoIP     PushTransport = "voip"
+)
+
+type PushNotificationAck struct {
+	Id               string `json:"id"`
+	ClientReceivedAt int64  `json:"received_at"`
+	ClientPlatform   string `json:"platform"`
+	NotificationType string `json:"type"`
+	PostId           string `json:"post_id,omitempty"`
+	IsIdLoaded       bool   `json:"is_id_loaded"`
+}
+
+type PushNotification struct {
+	AckId            string        `json:"ack_id"`
+	Platform         string        `json:"platform"`
+	ServerId         string        `json:"server_id"`
+	DeviceId         string        `json:"device_id"`
+	PostId           string        `json:"post_id"`
+	Category         string        `json:"category,omitempty"`
+	Sound            string        `json:"sound,omitempty"`
+	Message          string        `json:"message,omitempty"`
+	Badge            int           `json:"badge,omitempty"`
+	ContentAvailable int           `json:"cont_ava,omitempty"`
+	TeamId           string        `json:"team_id,omitempty"`
+	ChannelId        string        `json:"channel_id,omitempty"`
+	RootId           string        `json:"root_id,omitempty"`
+	ChannelName      string        `json:"channel_name,omitempty"`
+	Type             string        `json:"type,omitempty"`
+	SubType          PushSubType   `json:"sub_type,omitempty"`
+	Transport        PushTransport `json:"transport,omitempty"`
+	SenderId         string        `json:"sender_id,omitempty"`
+	SenderName       string        `json:"sender_name,omitempty"`
+	OverrideUsername string        `json:"override_username,omitempty"`
+	OverrideIconURL  string        `json:"override_icon_url,omitempty"`
+	FromWebhook      string        `json:"from_webhook,omitempty"`
+	Version          string        `json:"version,omitempty"`
+	IsCRTEnabled     bool          `json:"is_crt_enabled"`
+	IsIdLoaded       bool          `json:"is_id_loaded"`
+	PostType         string        `json:"-"`
+	ChannelType      ChannelType   `json:"-"`
+	Signature        string        `json:"signature"`
+}
+
+func (pn *PushNotification) DeepCopy() *PushNotification {
+	pnCopy := *pn
+	return &pnCopy
+}
+
+func (pn *PushNotification) SetDeviceIdAndPlatform(deviceId string) {
+	if platform, id, ok := strings.Cut(deviceId, ":"); ok {
+		pn.Platform = platform
+		pn.DeviceId = id
+	}
+}