summaryrefslogtreecommitdiffstats
path: root/model/websocket_message.go
blob: 08c238480cbfc44e918f6f34b3f81086eba788f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
// See License.txt for license information.

package model

import (
	"encoding/json"
	"fmt"
	"io"
)

const (
	WEBSOCKET_EVENT_TYPING                 = "typing"
	WEBSOCKET_EVENT_POSTED                 = "posted"
	WEBSOCKET_EVENT_POST_EDITED            = "post_edited"
	WEBSOCKET_EVENT_POST_DELETED           = "post_deleted"
	WEBSOCKET_EVENT_CHANNEL_DELETED        = "channel_deleted"
	WEBSOCKET_EVENT_CHANNEL_CREATED        = "channel_created"
	WEBSOCKET_EVENT_CHANNEL_UPDATED        = "channel_updated"
	WEBSOCKET_EVENT_CHANNEL_MEMBER_UPDATED = "channel_member_updated"
	WEBSOCKET_EVENT_DIRECT_ADDED           = "direct_added"
	WEBSOCKET_EVENT_GROUP_ADDED            = "group_added"
	WEBSOCKET_EVENT_NEW_USER               = "new_user"
	WEBSOCKET_EVENT_ADDED_TO_TEAM          = "added_to_team"
	WEBSOCKET_EVENT_LEAVE_TEAM             = "leave_team"
	WEBSOCKET_EVENT_UPDATE_TEAM            = "update_team"
	WEBSOCKET_EVENT_DELETE_TEAM            = "delete_team"
	WEBSOCKET_EVENT_USER_ADDED             = "user_added"
	WEBSOCKET_EVENT_USER_UPDATED           = "user_updated"
	WEBSOCKET_EVENT_USER_ROLE_UPDATED      = "user_role_updated"
	WEBSOCKET_EVENT_MEMBERROLE_UPDATED     = "memberrole_updated"
	WEBSOCKET_EVENT_USER_REMOVED           = "user_removed"
	WEBSOCKET_EVENT_PREFERENCE_CHANGED     = "preference_changed"
	WEBSOCKET_EVENT_PREFERENCES_CHANGED    = "preferences_changed"
	WEBSOCKET_EVENT_PREFERENCES_DELETED    = "preferences_deleted"
	WEBSOCKET_EVENT_EPHEMERAL_MESSAGE      = "ephemeral_message"
	WEBSOCKET_EVENT_STATUS_CHANGE          = "status_change"
	WEBSOCKET_EVENT_HELLO                  = "hello"
	WEBSOCKET_EVENT_WEBRTC                 = "webrtc"
	WEBSOCKET_AUTHENTICATION_CHALLENGE     = "authentication_challenge"
	WEBSOCKET_EVENT_REACTION_ADDED         = "reaction_added"
	WEBSOCKET_EVENT_REACTION_REMOVED       = "reaction_removed"
	WEBSOCKET_EVENT_RESPONSE               = "response"
	WEBSOCKET_EVENT_EMOJI_ADDED            = "emoji_added"
	WEBSOCKET_EVENT_CHANNEL_VIEWED         = "channel_viewed"
	WEBSOCKET_EVENT_PLUGIN_ACTIVATED       = "plugin_activated"   // EXPERIMENTAL - SUBJECT TO CHANGE
	WEBSOCKET_EVENT_PLUGIN_DEACTIVATED     = "plugin_deactivated" // EXPERIMENTAL - SUBJECT TO CHANGE
	WEBSOCKET_EVENT_ROLE_UPDATED           = "role_updated"
	WEBSOCKET_EVENT_LICENSE_CHANGED        = "license_changed"
	WEBSOCKET_EVENT_CONFIG_CHANGED         = "config_changed"
)

type WebSocketMessage interface {
	ToJson() string
	IsValid() bool
	EventType() string
}

type WebsocketBroadcast struct {
	OmitUsers             map[string]bool `json:"omit_users"` // broadcast is omitted for users listed here
	UserId                string          `json:"user_id"`    // broadcast only occurs for this user
	ChannelId             string          `json:"channel_id"` // broadcast only occurs for users in this channel
	TeamId                string          `json:"team_id"`    // broadcast only occurs for users in this team
	ContainsSanitizedData bool            `json:"-"`
	ContainsSensitiveData bool            `json:"-"`
}

type precomputedWebSocketEventJSON struct {
	Event     json.RawMessage
	Data      json.RawMessage
	Broadcast json.RawMessage
}

type WebSocketEvent struct {
	Event     string                 `json:"event"`
	Data      map[string]interface{} `json:"data"`
	Broadcast *WebsocketBroadcast    `json:"broadcast"`
	Sequence  int64                  `json:"seq"`

	precomputedJSON *precomputedWebSocketEventJSON
}

// PrecomputeJSON precomputes and stores the serialized JSON for all fields other than Sequence.
// This makes ToJson much more efficient when sending the same event to multiple connections.
func (m *WebSocketEvent) PrecomputeJSON() {
	event, _ := json.Marshal(m.Event)
	data, _ := json.Marshal(m.Data)
	broadcast, _ := json.Marshal(m.Broadcast)
	m.precomputedJSON = &precomputedWebSocketEventJSON{
		Event:     json.RawMessage(event),
		Data:      json.RawMessage(data),
		Broadcast: json.RawMessage(broadcast),
	}
}

func (m *WebSocketEvent) Add(key string, value interface{}) {
	m.Data[key] = value
}

func NewWebSocketEvent(event, teamId, channelId, userId string, omitUsers map[string]bool) *WebSocketEvent {
	return &WebSocketEvent{Event: event, Data: make(map[string]interface{}),
		Broadcast: &WebsocketBroadcast{TeamId: teamId, ChannelId: channelId, UserId: userId, OmitUsers: omitUsers}}
}

func (o *WebSocketEvent) IsValid() bool {
	return o.Event != ""
}

func (o *WebSocketEvent) EventType() string {
	return o.Event
}

func (o *WebSocketEvent) ToJson() string {
	if o.precomputedJSON != nil {
		return fmt.Sprintf(`{"event": %s, "data": %s, "broadcast": %s, "seq": %d}`, o.precomputedJSON.Event, o.precomputedJSON.Data, o.precomputedJSON.Broadcast, o.Sequence)
	}
	b, _ := json.Marshal(o)
	return string(b)
}

func WebSocketEventFromJson(data io.Reader) *WebSocketEvent {
	var o *WebSocketEvent
	json.NewDecoder(data).Decode(&o)
	return o
}

type WebSocketResponse struct {
	Status   string                 `json:"status"`
	SeqReply int64                  `json:"seq_reply,omitempty"`
	Data     map[string]interface{} `json:"data,omitempty"`
	Error    *AppError              `json:"error,omitempty"`
}

func (m *WebSocketResponse) Add(key string, value interface{}) {
	m.Data[key] = value
}

func NewWebSocketResponse(status string, seqReply int64, data map[string]interface{}) *WebSocketResponse {
	return &WebSocketResponse{Status: status, SeqReply: seqReply, Data: data}
}

func NewWebSocketError(seqReply int64, err *AppError) *WebSocketResponse {
	return &WebSocketResponse{Status: STATUS_FAIL, SeqReply: seqReply, Error: err}
}

func (o *WebSocketResponse) IsValid() bool {
	return o.Status != ""
}

func (o *WebSocketResponse) EventType() string {
	return WEBSOCKET_EVENT_RESPONSE
}

func (o *WebSocketResponse) ToJson() string {
	b, _ := json.Marshal(o)
	return string(b)
}

func WebSocketResponseFromJson(data io.Reader) *WebSocketResponse {
	var o *WebSocketResponse
	json.NewDecoder(data).Decode(&o)
	return o
}