/
push_fcm.go
280 lines (244 loc) · 7.26 KB
/
push_fcm.go
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
// Package fcm implements push notification plugin for Google FCM backend.
// Push notifications for Android, iOS and web clients are sent through Google's Firebase Cloud Messaging service.
package fcm
import (
"context"
"encoding/json"
"errors"
"log"
"strconv"
"time"
fbase "firebase.google.com/go"
fcm "firebase.google.com/go/messaging"
"github.com/tinode/chat/server/drafty"
"github.com/tinode/chat/server/push"
"github.com/tinode/chat/server/store"
t "github.com/tinode/chat/server/store/types"
"golang.org/x/oauth2/google"
"google.golang.org/api/option"
)
var handler Handler
// Size of the input channel buffer.
const defaultBuffer = 32
// Handler represents the push handler; implements push.PushHandler interface.
type Handler struct {
input chan *push.Receipt
stop chan bool
client *fcm.Client
}
type configType struct {
Enabled bool `json:"enabled"`
Buffer int `json:"buffer"`
Credentials json.RawMessage `json:"credentials"`
CredentialsFile string `json:"credentials_file"`
TimeToLive uint `json:"time_to_live,omitempty"`
IncludeAndroidNotification bool `json:"include_android_notification,omitempty"`
Icon string `json:"icon,omitempty"`
IconColor string `json:"icon_color,omitempty"`
}
// Init initializes the push handler
func (Handler) Init(jsonconf string) error {
var config configType
err := json.Unmarshal([]byte(jsonconf), &config)
if err != nil {
return errors.New("failed to parse config: " + err.Error())
}
if !config.Enabled {
return nil
}
ctx := context.Background()
var opt option.ClientOption
if config.Credentials != nil {
credentials, err := google.CredentialsFromJSON(ctx, config.Credentials,
"https://www.googleapis.com/auth/firebase.messaging")
if err != nil {
return err
}
opt = option.WithCredentials(credentials)
} else if config.CredentialsFile != "" {
opt = option.WithCredentialsFile(config.CredentialsFile)
} else {
return errors.New("missing credentials")
}
app, err := fbase.NewApp(ctx, &fbase.Config{}, opt)
if err != nil {
return err
}
handler.client, err = app.Messaging(ctx)
if err != nil {
return err
}
if config.Buffer <= 0 {
config.Buffer = defaultBuffer
}
handler.input = make(chan *push.Receipt, config.Buffer)
handler.stop = make(chan bool, 1)
go func() {
for {
select {
case rcpt := <-handler.input:
go sendNotifications(rcpt, &config)
case <-handler.stop:
return
}
}
}()
return nil
}
func payloadToData(pl *push.Payload) (map[string]string, error) {
if pl == nil {
return nil, nil
}
data := make(map[string]string)
var err error
data["topic"] = pl.Topic
// Must use "xfrom" because "from" is a reserved word.
// Google did not bother to document it anywhere.
data["xfrom"] = pl.From
data["ts"] = pl.Timestamp.Format(time.RFC3339Nano)
data["seq"] = strconv.Itoa(pl.SeqId)
data["mime"] = pl.ContentType
data["content"], err = drafty.ToPlainText(pl.Content)
if err != nil {
return nil, err
}
// Trim long strings to 80 runes.
// Check byte length first and don't waste time converting short strings.
if len(data["content"]) > 80 {
runes := []rune(data["content"])
if len(runes) > 80 {
data["content"] = string(runes[:80]) + "…"
}
}
return data, nil
}
func sendNotifications(rcpt *push.Receipt, config *configType) {
ctx := context.Background()
data, _ := payloadToData(&rcpt.Payload)
if data == nil || data["content"] == "" {
log.Println("fcm push: could not parse payload or empty payload")
return
}
// List of UIDs for querying the database
uids := make([]t.Uid, len(rcpt.To))
skipDevices := make(map[string]bool)
i := 0
for uid, to := range rcpt.To {
uids[i] = uid
i++
// Some devices were online and received the message. Skip them.
for _, deviceID := range to.Devices {
skipDevices[deviceID] = true
}
}
devices, count, err := store.Devices.GetAll(uids...)
if err != nil {
log.Println("fcm push: db error", err)
return
}
if count == 0 {
return
}
for uid, devList := range devices {
for i := range devList {
d := &devList[i]
if _, ok := skipDevices[d.DeviceId]; !ok && d.DeviceId != "" {
msg := fcm.Message{
Token: d.DeviceId,
Data: data,
}
if d.Platform == "android" {
msg.Android = &fcm.AndroidConfig{
Priority: "high",
}
if config.IncludeAndroidNotification {
// When this notification type is included and the app is not in the foreground
// Android won't wake up the app and won't call FirebaseMessagingService:onMessageReceived.
msg.Android.Notification = &fcm.AndroidNotification{
// Android uses Tag value to group notifications together:
// show just one notification per topic.
Tag: rcpt.Payload.Topic,
Title: "New message",
Body: data["content"],
Icon: config.Icon,
Color: config.IconColor,
}
}
} else if d.Platform == "ios" {
// iOS uses Badge to show the total unread message count.
badge := rcpt.To[uid].Unread
// Need to duplicate these in APNS.Payload.Aps.Alert so
// iOS may call NotificationServiceExtension (if present).
title := "New message"
body := data["content"]
msg.APNS = &fcm.APNSConfig{
Payload: &fcm.APNSPayload{
Aps: &fcm.Aps{
Badge: &badge,
ContentAvailable: true,
MutableContent: true,
Sound: "default",
Alert: &fcm.ApsAlert{
Title: title,
Body: body,
},
},
},
}
msg.Notification = &fcm.Notification{
Title: title,
Body: body,
}
}
// Firebase messaging is buggy and poorly documented. If
// msg.Notification is defined, then firebase will ignore
// whatever handler is set in setBackgroundMessageHandler.
// See dicussion of this madness here:
// https://github.com/firebase/quickstart-js/issues/71
// msg.Notification = &fcm.Notification{
// Title: "New message",
// Body: data["content"],
// }
_, err := handler.client.Send(ctx, &msg)
if err != nil {
if fcm.IsMessageRateExceeded(err) ||
fcm.IsServerUnavailable(err) ||
fcm.IsInternal(err) ||
fcm.IsUnknown(err) {
// Transient errors. Stop sending this batch.
log.Println("fcm transient failure", err)
return
}
if fcm.IsMismatchedCredential(err) || fcm.IsInvalidArgument(err) {
// Config errors
log.Println("fcm push: failed", err)
return
}
if fcm.IsRegistrationTokenNotRegistered(err) {
// Token is no longer valid.
store.Devices.Delete(uid, d.DeviceId)
log.Println("fcm push: invalid token", err)
} else {
log.Println("fcm push:", err)
}
}
}
}
}
}
// IsReady checks if the push handler has been initialized.
func (Handler) IsReady() bool {
return handler.input != nil
}
// Push returns a channel that the server will use to send messages to.
// If the adapter blocks, the message will be dropped.
func (Handler) Push() chan<- *push.Receipt {
return handler.input
}
// Stop shuts down the handler
func (Handler) Stop() {
handler.stop <- true
}
func init() {
push.Register("fcm", &handler)
}