forked from thrasher-corp/gocryptotrader
/
slack.go
389 lines (341 loc) · 9.58 KB
/
slack.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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
// Package slack is used to connect to the slack network. Slack is a
// code-centric collaboration hub that allows users to connect via an app and
// share different types of data
package slack
import (
"encoding/json"
"errors"
"fmt"
"net/http"
"strings"
"sync"
"time"
"github.com/gorilla/websocket"
"github.com/nbltrust/gocryptotrader/common"
"github.com/nbltrust/gocryptotrader/communications/base"
"github.com/nbltrust/gocryptotrader/config"
"github.com/nbltrust/gocryptotrader/log"
)
// const declares main slack url and commands that will be supported on client
// side
const (
SlackURL = "https://slack.com/api/rtm.start"
cmdStatus = "!status"
cmdHelp = "!help"
getHelp = `GoCryptoTrader SlackBot, thank you for using this service!
Current commands are:
!status - Displays current working status of bot
!help - Displays help text`
)
// Slack starts a websocket connection and uses https://api.slack.com/rtm real
// time messaging
type Slack struct {
base.Base
TargetChannel string
VerificationToken string
TargetChannelID string
Details Response
ReconnectURL string
WebsocketConn *websocket.Conn
Connected bool
Shutdown bool
sync.Mutex
}
// IsConnected returns whether or not the connection is connected
func (s *Slack) IsConnected() bool {
return s.Connected
}
// Setup takes in a slack configuration, sets bots target channel and
// sets verification token to access workspace
func (s *Slack) Setup(cfg *config.CommunicationsConfig) {
s.Name = cfg.SlackConfig.Name
s.Enabled = cfg.SlackConfig.Enabled
s.Verbose = cfg.SlackConfig.Verbose
s.TargetChannel = cfg.SlackConfig.TargetChannel
s.VerificationToken = cfg.SlackConfig.VerificationToken
}
// Connect connects to the service
func (s *Slack) Connect() error {
err := s.NewConnection()
if err != nil {
return err
}
s.Connected = true
return nil
}
// PushEvent pushes an event to either a slack channel or specific client
func (s *Slack) PushEvent(event base.Event) error {
if s.Connected {
return s.WebsocketSend("message",
fmt.Sprintf("event: %s %s", event.Type, event.Message))
}
return errors.New("slack not connected")
}
// BuildURL returns an appended token string with the SlackURL
func (s *Slack) BuildURL(token string) string {
return fmt.Sprintf("%s?token=%s", SlackURL, token)
}
// GetChannelsString returns a list of all channels on the slack workspace
func (s *Slack) GetChannelsString() []string {
var channels []string
for i := range s.Details.Channels {
channels = append(channels, s.Details.Channels[i].NameNormalized)
}
return channels
}
// GetUsernameByID returns a users name by ID
func (s *Slack) GetUsernameByID(id string) string {
for i := range s.Details.Users {
if s.Details.Users[i].ID == id {
return s.Details.Users[i].Name
}
}
return ""
}
// GetIDByName returns either a group ID or Channel ID
func (s *Slack) GetIDByName(userName string) (string, error) {
id, err := s.GetGroupIDByName(userName)
if err != nil {
return s.GetChannelIDByName(userName)
}
return id, err
}
// GetGroupIDByName returns a groupID by group name
func (s *Slack) GetGroupIDByName(group string) (string, error) {
for i := range s.Details.Groups {
if s.Details.Groups[i].Name == group {
return s.Details.Groups[i].ID, nil
}
}
return "", errors.New("channel not found")
}
// GetChannelIDByName returns a channel ID by its corresponding name
func (s *Slack) GetChannelIDByName(channel string) (string, error) {
for i := range s.Details.Channels {
if s.Details.Channels[i].Name == channel {
return s.Details.Channels[i].ID, nil
}
}
return "", errors.New("channel not found")
}
// GetUsersInGroup returns a list of users currently in a group
func (s *Slack) GetUsersInGroup(group string) []string {
for i := range s.Details.Groups {
if s.Details.Groups[i].Name == group {
return s.Details.Groups[i].Members
}
}
return nil
}
// NewConnection connects the bot to a slack workgroup using a verification
// token and a channel
func (s *Slack) NewConnection() error {
if !s.Connected {
err := common.SendHTTPGetRequest(s.BuildURL(s.VerificationToken), true, s.Verbose, &s.Details)
if err != nil {
return err
}
if !s.Details.Ok {
return errors.New(s.Details.Error)
}
if s.Verbose {
log.Debugf(log.CommunicationMgr, "Slack: %s [%s] connected to %s [%s] \nWebsocket URL: %s.\n",
s.Details.Self.Name,
s.Details.Self.ID,
s.Details.Team.Domain,
s.Details.Team.ID,
s.Details.URL)
log.Debugf(log.CommunicationMgr, "Slack: Public channels: %s\n", s.GetChannelsString())
}
s.TargetChannelID, err = s.GetIDByName(s.TargetChannel)
if err != nil {
return err
}
log.Debugf(log.CommunicationMgr, "Slack: Target channel ID: %v [#%v]\n", s.TargetChannelID,
s.TargetChannel)
return s.WebsocketConnect()
}
return errors.New("slack.go NewConnection() Already Connected")
}
// WebsocketConnect creates a websocket dialer amd initiates a websocket
// connection
func (s *Slack) WebsocketConnect() error {
var dialer websocket.Dialer
var err error
websocketURL := s.Details.URL
if s.ReconnectURL != "" {
websocketURL = s.ReconnectURL
}
var resp *http.Response
s.WebsocketConn, resp, err = dialer.Dial(websocketURL, http.Header{})
if err != nil {
return err
}
resp.Body.Close()
go s.WebsocketReader()
return nil
}
// WebsocketReader reads incoming events from the websocket connection
func (s *Slack) WebsocketReader() {
for {
_, resp, err := s.WebsocketConn.ReadMessage()
if err != nil {
log.Errorln(log.CommunicationMgr, err)
}
var data WebsocketResponse
err = json.Unmarshal(resp, &data)
if err != nil {
log.Errorln(log.CommunicationMgr, err)
continue
}
switch data.Type {
case "error":
err = s.handleErrorResponse(data)
if err != nil {
continue
}
case "hello":
s.handleHelloResponse()
case "reconnect_url":
err = s.handleReconnectResponse(resp)
if err != nil {
continue
}
case "presence_change":
err = s.handlePresenceChange(resp)
if err != nil {
continue
}
case "message":
err = s.handleMessageResponse(resp, data)
if err != nil {
continue
}
case "pong":
if s.Verbose {
log.Debugln(log.CommunicationMgr, "Slack: Pong received from server")
}
default:
log.Debugln(log.CommunicationMgr, string(resp))
}
}
}
func (s *Slack) handlePresenceChange(resp []byte) error {
var pres PresenceChange
err := json.Unmarshal(resp, &pres)
if err != nil {
return err
}
if s.Verbose {
log.Debugf(log.CommunicationMgr, "Slack: Presence change. User %s [%s] changed status to %s\n",
s.GetUsernameByID(pres.User),
pres.User, pres.Presence)
}
return nil
}
func (s *Slack) handleMessageResponse(resp []byte, data WebsocketResponse) error {
if data.ReplyTo != 0 {
return errors.New("reply to is != 0")
}
var msg Message
err := json.Unmarshal(resp, &msg)
if err != nil {
return err
}
if s.Verbose {
log.Debugf(log.CommunicationMgr, "Slack: Message received by %s [%s] with text: %s\n",
s.GetUsernameByID(msg.User),
msg.User, msg.Text)
}
if string(msg.Text[0]) == "!" {
return s.HandleMessage(&msg)
}
return nil
}
func (s *Slack) handleErrorResponse(data WebsocketResponse) error {
if data.Error.Msg == "Socket URL has expired" {
if s.Verbose {
log.Debugln(log.CommunicationMgr, "Slack websocket URL has expired.. Reconnecting")
}
if s.WebsocketConn == nil {
return errors.New("websocket connection is nil")
}
if err := s.WebsocketConn.Close(); err != nil {
log.Errorln(log.CommunicationMgr, err)
}
s.ReconnectURL = ""
s.Connected = false
return s.NewConnection()
}
return fmt.Errorf("unknown error '%s'", data.Error.Msg)
}
func (s *Slack) handleHelloResponse() {
if s.Verbose {
log.Debugln(log.CommunicationMgr, "Slack: Websocket connected successfully.")
}
s.Connected = true
go s.WebsocketKeepAlive()
}
func (s *Slack) handleReconnectResponse(resp []byte) error {
type reconnectResponse struct {
URL string `json:"url"`
}
var recURL reconnectResponse
err := json.Unmarshal(resp, &recURL)
if err != nil {
return err
}
s.ReconnectURL = recURL.URL
if s.Verbose {
log.Debugf(log.CommunicationMgr, "Slack: Reconnect URL set to %s\n", s.ReconnectURL)
}
return nil
}
// WebsocketKeepAlive sends a ping every 5 minutes to keep connection alive
func (s *Slack) WebsocketKeepAlive() {
ticker := time.NewTicker(5 * time.Minute)
defer ticker.Stop()
for {
<-ticker.C
if err := s.WebsocketSend("ping", ""); err != nil {
log.Errorf(log.CommunicationMgr, "Slack: WebsocketKeepAlive() error %s\n", err)
}
}
}
// WebsocketSend sends a message via the websocket connection
func (s *Slack) WebsocketSend(eventType, text string) error {
s.Lock()
defer s.Unlock()
newMessage := SendMessage{
ID: time.Now().Unix(),
Type: eventType,
Channel: s.TargetChannelID,
Text: text,
}
data, err := json.Marshal(newMessage)
if err != nil {
return err
}
if s.Verbose {
log.Debugf(log.CommunicationMgr, "Slack: Sending websocket message: %s\n", string(data))
}
if s.WebsocketConn == nil {
return errors.New("websocket not connected")
}
return s.WebsocketConn.WriteMessage(websocket.TextMessage, data)
}
// HandleMessage handles incoming messages and/or commands from slack
func (s *Slack) HandleMessage(msg *Message) error {
if msg == nil {
return errors.New("slack msg is nil")
}
msg.Text = strings.ToLower(msg.Text)
switch {
case strings.Contains(msg.Text, cmdStatus):
return s.WebsocketSend("message", s.GetStatus())
case strings.Contains(msg.Text, cmdHelp):
return s.WebsocketSend("message", getHelp)
default:
return s.WebsocketSend("message", "GoCryptoTrader SlackBot - Command Unknown!")
}
}