adding support for settings for notification policy and content, per convo opt in/outs, and attaching relevant info to messages

constants/attributes.go

@@ -17,6 +17,9 @@ const PeerOnline = "peer-online"
 // Description is used on server contacts,
 const Description = "description"
 
+const NotificationOptIn = "notification-opt-in"
+const NotificationOptOut = "notification-opt-out"
+
 const StateProfilePane = "state-profile-pane"
 const StateSelectedConversation = "state-selected-conversation"
 const StateSelectedProfileTime = "state-selected-profile-time"

constants/globals.go

@@ -11,3 +11,12 @@ const (
 	// StatusError is an event response for event.Status signifying a call failed in error, ideally accompanied by a event.Error
 	StatusError = "error"
 )
+
+const (
+	// NotificationNone enum for message["notification"] that means no notification
+	NotificationNone = "None"
+	// NotificationEvent enum for message["notification"] that means emit a notification that a message event happened only
+	NotificationEvent = "SimpleEvent"
+	// NotificationConversation enum for message["notification"] that means emit a notification event with Conversation handle included
+	NotificationConversation = "ContactInfo"
+)

utils/contacts.go

@@ -1,18 +1,19 @@
 package utils
 
 type Contact struct {
-	Name        string `json:"name"`
-	Onion       string `json:"onion"`
-	Status      string `json:"status"`
-	Picture     string `json:"picture"`
-	Accepted    bool   `json:"accepted"`
-	Blocked     bool   `json:"blocked"`
-	SaveHistory string `json:"saveConversationHistory"`
-	Messages    int    `json:"numMessages"`
-	Unread      int    `json:"numUnread"`
-	LastMessage string `json:"lastMsgTime"`
-	IsGroup     bool   `json:"isGroup"`
-	GroupServer string `json:"groupServer"`
-	IsArchived  bool   `json:"isArchived"`
-	Identifier  int    `json:"identifier"`
+	Name        string            `json:"name"`
+	Onion       string            `json:"onion"`
+	Status      string            `json:"status"`
+	Picture     string            `json:"picture"`
+	Accepted    bool              `json:"accepted"`
+	Blocked     bool              `json:"blocked"`
+	SaveHistory string            `json:"saveConversationHistory"`
+	Messages    int               `json:"numMessages"`
+	Unread      int               `json:"numUnread"`
+	LastMessage string            `json:"lastMsgTime"`
+	IsGroup     bool              `json:"isGroup"`
+	GroupServer string            `json:"groupServer"`
+	IsArchived  bool              `json:"isArchived"`
+	Identifier  int               `json:"identifier"`
+	Options     map[string]string `json:"options"`
 }

utils/eventHandler.go

@@ -204,6 +204,14 @@ func (eh *EventHandler) handleAppBusEvent(e *event.Event) string {
 
 					lastMessage, _ := profile.GetMostRecentMessages(conversationInfo.ID, 0, 0, 1)
 
+					options := make(map[string]string)
+					if notificationOptIn, exists := conversationInfo.GetAttribute(attr.LocalScope, attr.ProfileZone, constants2.NotificationOptIn); exists {
+						options[constants2.NotificationOptIn] = notificationOptIn
+					}
+					if notificationOptOut, exists := conversationInfo.GetAttribute(attr.LocalScope, attr.ProfileZone, constants2.NotificationOptOut); exists {
+						options[constants2.NotificationOptOut] = notificationOptOut
+					}
+
 					contacts = append(contacts, Contact{
 						Name:        name,
 						Identifier:  conversationInfo.ID,
@@ -219,6 +227,7 @@ func (eh *EventHandler) handleAppBusEvent(e *event.Event) string {
 						IsGroup:     conversationInfo.IsGroup(),
 						GroupServer: groupServer,
 						IsArchived:  isArchived == event.True,
+						Options:     options,
 					})
 				}
 			}
@@ -276,6 +285,8 @@ func (eh *EventHandler) handleProfileEvent(ev *EventProfileEnvelope) string {
 			if ci.Accepted {
 				handleImagePreviews(profile, &ev.Event, ci.ID, ci.ID)
 			}
+
+			ev.Event.Data["notification"] = determineNotification(ci)
 		case event.NewMessageFromGroup:
 			// only needs contact nickname and picture, for displaying on popup notifications
 			ci, err := profile.FetchConversationInfo(ev.Event.Data["RemotePeer"])
@@ -296,6 +307,7 @@ func (eh *EventHandler) handleProfileEvent(ev *EventProfileEnvelope) string {
 			if ci != nil && ci.Accepted {
 				handleImagePreviews(profile, &ev.Event, conversationID, ci.ID)
 			}
+			ev.Event.Data["notification"] = determineNotification(ci)
 		case event.PeerAcknowledgement:
 			ci, err := profile.FetchConversationInfo(ev.Event.Data["RemotePeer"])
 			if ci != nil && err == nil {

utils/settings.go

@@ -34,6 +34,8 @@ type GlobalSettings struct {
 	ExperimentsEnabled      bool
 	Experiments             map[string]bool
 	BlockUnknownConnections bool
+	NotificationPolicy      string
+	NotificationContent     string
 	StreamerMode            bool
 	StateRootPane           int
 	FirstTime               bool
@@ -62,6 +64,8 @@ var DefaultGlobalSettings = GlobalSettings{
 	StreamerMode:            false,
 	UIColumnModePortrait:    "DualpaneMode.Single",
 	UIColumnModeLandscape:   "DualpaneMode.CopyPortrait",
+	NotificationPolicy:      "NotificationPolicy.OptOut",
+	NotificationContent:     "NotificationContent.SimpleEvent",
 	DownloadPath:            "",
 	AllowAdvancedTorConfig:  false,
 	CustomTorrc:             "",

utils/utils.go

@@ -1,8 +1,11 @@
 package utils
 
 import (
+	"cwtch.im/cwtch/model"
+	"cwtch.im/cwtch/model/attr"
 	"encoding/base32"
 	"encoding/hex"
+	"git.openprivacy.ca/cwtch.im/libcwtch-go/constants"
 	"git.openprivacy.ca/openprivacy/log"
 	"strings"
 )
@@ -27,3 +30,29 @@ func RandomGroupImage(handle string) string {
 	}
 	return "servers/" + choices[int(barr[0])%len(choices)] + ".png"
 }
+
+func determineNotification(ci *model.Conversation) string {
+	settings := ReadGlobalSettings()
+
+	switch settings.NotificationPolicy {
+	case "NotificationPolicy.None":
+		return constants.NotificationNone
+	case "NotificationPolicy.OptOut":
+		if optOut, exists := ci.GetAttribute(attr.LocalScope, attr.ProfileZone, constants.NotificationOptOut); exists && optOut == "true" {
+			return constants.NotificationNone
+		}
+		if settings.NotificationContent == "NotificationContent.ContactInfo" {
+			return constants.NotificationConversation
+		}
+		return constants.NotificationEvent
+	case "NotificationPolicy.OptIn":
+		if optIn, exists := ci.GetAttribute(attr.LocalScope, attr.ProfileZone, constants.NotificationOptIn); exists && optIn == "true" {
+			if settings.NotificationContent == "NotificationContent.ContactInfo" {
+				return constants.NotificationConversation
+			}
+			return constants.NotificationEvent
+		}
+		return constants.NotificationNone
+	}
+	return constants.NotificationNone
+}