wsapi.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486
  1. // Discordgo - Discord bindings for Go
  2. // Available at https://github.com/bwmarrin/discordgo
  3. // Copyright 2015 Bruce Marriner <bruce@sqls.net>. All rights reserved.
  4. // Use of this source code is governed by a BSD-style
  5. // license that can be found in the LICENSE file.
  6. // This file contains low level functions for interacting with the Discord
  7. // data websocket interface.
  8. package discordgo
  9. import (
  10. "encoding/json"
  11. "fmt"
  12. "runtime"
  13. "time"
  14. "github.com/gorilla/websocket"
  15. )
  16. // Open opens a websocket connection to Discord.
  17. func (s *Session) Open() (err error) {
  18. // Get the gateway to use for the Websocket connection
  19. g, err := s.Gateway()
  20. // TODO: See if there's a use for the http response.
  21. // conn, response, err := websocket.DefaultDialer.Dial(session.Gateway, nil)
  22. s.wsConn, _, err = websocket.DefaultDialer.Dial(g, nil)
  23. return
  24. }
  25. // maybe this is SendOrigin? not sure the right name here
  26. // also bson.M vs string interface map? Read about
  27. // how to send JSON the right way.
  28. // Handshake sends the client data to Discord during websocket initial connection.
  29. func (s *Session) Handshake() (err error) {
  30. err = s.wsConn.WriteJSON(map[string]interface{}{
  31. "op": 2,
  32. "d": map[string]interface{}{
  33. "v": 3,
  34. "token": s.Token,
  35. "properties": map[string]string{
  36. "$os": runtime.GOOS,
  37. "$browser": "Discordgo",
  38. "$device": "Discordgo",
  39. "$referer": "",
  40. "$referring_domain": "",
  41. },
  42. },
  43. })
  44. return
  45. }
  46. // UpdateStatus is used to update the authenticated user's status.
  47. func (s *Session) UpdateStatus(idleSince, gameID string) (err error) {
  48. err = s.wsConn.WriteJSON(map[string]interface{}{
  49. "op": 2,
  50. "d": map[string]interface{}{
  51. "idle_since": idleSince,
  52. "game_id": gameID,
  53. },
  54. })
  55. return
  56. }
  57. // TODO: need a channel or something to communicate
  58. // to this so I can tell it to stop listening
  59. // Listen starts listening to the websocket connection for events.
  60. func (s *Session) Listen() (err error) {
  61. if s.wsConn == nil {
  62. fmt.Println("No websocket connection exists.")
  63. return // TODO need to return an error.
  64. }
  65. for {
  66. messageType, message, err := s.wsConn.ReadMessage()
  67. if err != nil {
  68. fmt.Println("Websocket Listen Error", err)
  69. // TODO Log error
  70. break
  71. }
  72. go s.event(messageType, message)
  73. }
  74. return
  75. }
  76. // Not sure how needed this is and where it would be best to call it.
  77. // somewhere.
  78. // Close closes the connection to the websocket.
  79. func (s *Session) Close() {
  80. s.wsConn.Close()
  81. }
  82. // Front line handler for all Websocket Events. Determines the
  83. // event type and passes the message along to the next handler.
  84. // event is the front line handler for all events. This needs to be
  85. // broken up into smaller functions to be more idiomatic Go.
  86. func (s *Session) event(messageType int, message []byte) (err error) {
  87. if s.Debug {
  88. printJSON(message)
  89. }
  90. var e Event
  91. if err := json.Unmarshal(message, &e); err != nil {
  92. return err
  93. }
  94. switch e.Type {
  95. case "READY":
  96. if s.OnReady != nil {
  97. var st Ready
  98. if err := json.Unmarshal(e.RawData, &st); err != nil {
  99. fmt.Println(e.Type, err)
  100. printJSON(e.RawData) // TODO: Better error logging
  101. return err
  102. }
  103. s.OnReady(s, st)
  104. return
  105. }
  106. case "VOICE_SERVER_UPDATE":
  107. // TEMP CODE FOR TESTING VOICE
  108. var st VoiceServerUpdate
  109. if err := json.Unmarshal(e.RawData, &st); err != nil {
  110. fmt.Println(e.Type, err)
  111. printJSON(e.RawData) // TODO: Better error logging
  112. return err
  113. }
  114. s.onVoiceServerUpdate(st)
  115. return
  116. case "VOICE_STATE_UPDATE":
  117. // TEMP CODE FOR TESTING VOICE
  118. var st VoiceState
  119. if err := json.Unmarshal(e.RawData, &st); err != nil {
  120. fmt.Println(e.Type, err)
  121. printJSON(e.RawData) // TODO: Better error logging
  122. return err
  123. }
  124. s.onVoiceStateUpdate(st)
  125. return
  126. case "PRESENCE_UPDATE":
  127. if s.OnPresenceUpdate != nil {
  128. var st PresenceUpdate
  129. if err := json.Unmarshal(e.RawData, &st); err != nil {
  130. fmt.Println(e.Type, err)
  131. printJSON(e.RawData) // TODO: Better error logging
  132. return err
  133. }
  134. s.OnPresenceUpdate(s, st)
  135. return
  136. }
  137. case "TYPING_START":
  138. if s.OnTypingStart != nil {
  139. var st TypingStart
  140. if err := json.Unmarshal(e.RawData, &st); err != nil {
  141. fmt.Println(e.Type, err)
  142. printJSON(e.RawData) // TODO: Better error logging
  143. return err
  144. }
  145. s.OnTypingStart(s, st)
  146. return
  147. }
  148. /* // Never seen this come in but saw it in another Library.
  149. case "MESSAGE_ACK":
  150. if s.OnMessageAck != nil {
  151. }
  152. */
  153. case "MESSAGE_CREATE":
  154. if s.OnMessageCreate != nil {
  155. var st Message
  156. if err := json.Unmarshal(e.RawData, &st); err != nil {
  157. fmt.Println(e.Type, err)
  158. printJSON(e.RawData) // TODO: Better error logging
  159. return err
  160. }
  161. s.OnMessageCreate(s, st)
  162. return
  163. }
  164. case "MESSAGE_UPDATE":
  165. if s.OnMessageUpdate != nil {
  166. var st Message
  167. if err := json.Unmarshal(e.RawData, &st); err != nil {
  168. fmt.Println(e.Type, err)
  169. printJSON(e.RawData) // TODO: Better error logging
  170. return err
  171. }
  172. s.OnMessageUpdate(s, st)
  173. return
  174. }
  175. case "MESSAGE_DELETE":
  176. if s.OnMessageDelete != nil {
  177. var st MessageDelete
  178. if err := json.Unmarshal(e.RawData, &st); err != nil {
  179. fmt.Println(e.Type, err)
  180. printJSON(e.RawData) // TODO: Better error logging
  181. return err
  182. }
  183. s.OnMessageDelete(s, st)
  184. return
  185. }
  186. case "MESSAGE_ACK":
  187. if s.OnMessageAck != nil {
  188. var st MessageAck
  189. if err := json.Unmarshal(e.RawData, &st); err != nil {
  190. fmt.Println(e.Type, err)
  191. printJSON(e.RawData) // TODO: Better error logging
  192. return err
  193. }
  194. s.OnMessageAck(s, st)
  195. return
  196. }
  197. case "CHANNEL_CREATE":
  198. if s.OnChannelCreate != nil {
  199. var st Channel
  200. if err := json.Unmarshal(e.RawData, &st); err != nil {
  201. fmt.Println(e.Type, err)
  202. printJSON(e.RawData) // TODO: Better error logginEventg
  203. return err
  204. }
  205. s.OnChannelCreate(s, st)
  206. return
  207. }
  208. case "CHANNEL_UPDATE":
  209. if s.OnChannelUpdate != nil {
  210. var st Channel
  211. if err := json.Unmarshal(e.RawData, &st); err != nil {
  212. fmt.Println(e.Type, err)
  213. printJSON(e.RawData) // TODO: Better error logginEventg
  214. return err
  215. }
  216. s.OnChannelUpdate(s, st)
  217. return
  218. }
  219. case "CHANNEL_DELETE":
  220. if s.OnChannelDelete != nil {
  221. var st Channel
  222. if err := json.Unmarshal(e.RawData, &st); err != nil {
  223. fmt.Println(e.Type, err)
  224. printJSON(e.RawData) // TODO: Better error logginEventg
  225. return err
  226. }
  227. s.OnChannelDelete(s, st)
  228. return
  229. }
  230. case "GUILD_CREATE":
  231. if s.OnGuildCreate != nil {
  232. var st Guild
  233. if err := json.Unmarshal(e.RawData, &st); err != nil {
  234. fmt.Println(e.Type, err)
  235. printJSON(e.RawData) // TODO: Better error logginEventg
  236. return err
  237. }
  238. s.OnGuildCreate(s, st)
  239. return
  240. }
  241. case "GUILD_UPDATE":
  242. if s.OnGuildCreate != nil {
  243. var st Guild
  244. if err := json.Unmarshal(e.RawData, &st); err != nil {
  245. fmt.Println(e.Type, err)
  246. printJSON(e.RawData) // TODO: Better error logginEventg
  247. return err
  248. }
  249. s.OnGuildUpdate(s, st)
  250. return
  251. }
  252. case "GUILD_DELETE":
  253. if s.OnGuildDelete != nil {
  254. var st Guild
  255. if err := json.Unmarshal(e.RawData, &st); err != nil {
  256. fmt.Println(e.Type, err)
  257. printJSON(e.RawData) // TODO: Better error logginEventg
  258. return err
  259. }
  260. s.OnGuildDelete(s, st)
  261. return
  262. }
  263. case "GUILD_MEMBER_ADD":
  264. if s.OnGuildMemberAdd != nil {
  265. var st Member
  266. if err := json.Unmarshal(e.RawData, &st); err != nil {
  267. fmt.Println(e.Type, err)
  268. printJSON(e.RawData) // TODO: Better error logginEventg
  269. return err
  270. }
  271. s.OnGuildMemberAdd(s, st)
  272. return
  273. }
  274. case "GUILD_MEMBER_REMOVE":
  275. if s.OnGuildMemberRemove != nil {
  276. var st Member
  277. if err := json.Unmarshal(e.RawData, &st); err != nil {
  278. fmt.Println(e.Type, err)
  279. printJSON(e.RawData) // TODO: Better error logginEventg
  280. return err
  281. }
  282. s.OnGuildMemberRemove(s, st)
  283. return
  284. }
  285. case "GUILD_MEMBER_UPDATE":
  286. if s.OnGuildMemberUpdate != nil {
  287. var st Member
  288. if err := json.Unmarshal(e.RawData, &st); err != nil {
  289. fmt.Println(e.Type, err)
  290. printJSON(e.RawData) // TODO: Better error logginEventg
  291. return err
  292. }
  293. s.OnGuildMemberUpdate(s, st)
  294. return
  295. }
  296. case "GUILD_ROLE_CREATE":
  297. if s.OnGuildRoleCreate != nil {
  298. var st GuildRole
  299. if err := json.Unmarshal(e.RawData, &st); err != nil {
  300. fmt.Println(e.Type, err)
  301. printJSON(e.RawData) // TODO: Better error logginEventg
  302. return err
  303. }
  304. s.OnGuildRoleCreate(s, st)
  305. return
  306. }
  307. case "GUILD_ROLE_UPDATE":
  308. if s.OnGuildRoleUpdate != nil {
  309. var st GuildRole
  310. if err := json.Unmarshal(e.RawData, &st); err != nil {
  311. fmt.Println(e.Type, err)
  312. printJSON(e.RawData) // TODO: Better error logginEventg
  313. return err
  314. }
  315. s.OnGuildRoleUpdate(s, st)
  316. return
  317. }
  318. case "GUILD_ROLE_DELETE":
  319. if s.OnGuildRoleDelete != nil {
  320. var st GuildRoleDelete
  321. if err := json.Unmarshal(e.RawData, &st); err != nil {
  322. fmt.Println(e.Type, err)
  323. printJSON(e.RawData) // TODO: Better error logginEventg
  324. return err
  325. }
  326. s.OnGuildRoleDelete(s, st)
  327. return
  328. }
  329. case "GUILD_INTEGRATIONS_UPDATE":
  330. if s.OnGuildIntegrationsUpdate != nil {
  331. var st GuildIntegrationsUpdate
  332. if err := json.Unmarshal(e.RawData, &st); err != nil {
  333. fmt.Println(e.Type, err)
  334. printJSON(e.RawData) // TODO: Better error logginEventg
  335. return err
  336. }
  337. s.OnGuildIntegrationsUpdate(s, st)
  338. return
  339. }
  340. default:
  341. fmt.Println("UNKNOWN EVENT: ", e.Type)
  342. // learn the log package
  343. // log.print type and JSON data
  344. }
  345. // if still here, send to generic OnEvent
  346. if s.OnEvent != nil {
  347. s.OnEvent(s, e)
  348. return
  349. }
  350. return
  351. }
  352. // This heartbeat is sent to keep the Websocket conenction
  353. // to Discord alive. If not sent, Discord will close the
  354. // connection.
  355. // Heartbeat sends regular heartbeats to Discord so it knows the client
  356. // is still connected. If you do not send these heartbeats Discord will
  357. // disconnect the websocket connection after a few seconds.
  358. func (s *Session) Heartbeat(i time.Duration) {
  359. if s.wsConn == nil {
  360. fmt.Println("No websocket connection exists.")
  361. return // TODO need to return an error.
  362. }
  363. // send first heartbeat immediately because lag could put the
  364. // first heartbeat outside the required heartbeat interval window
  365. ticker := time.NewTicker(i * time.Millisecond)
  366. for {
  367. timestamp := int(time.Now().Unix())
  368. err := s.wsConn.WriteJSON(map[string]int{
  369. "op": 1,
  370. "d": timestamp,
  371. })
  372. if err != nil {
  373. fmt.Println("error sending data heartbeat:", err)
  374. return // TODO log error?
  375. }
  376. <-ticker.C
  377. }
  378. }
  379. // Everything below is experimental Voice support code
  380. // all of it will get changed and moved around.
  381. // A VoiceServerUpdate stores the data received during the Voice Server Update
  382. // data websocket event. This data is used during the initial Voice Channel
  383. // join handshaking.
  384. type VoiceServerUpdate struct {
  385. Token string `json:"token"`
  386. GuildID string `json:"guild_id"`
  387. Endpoint string `json:"endpoint"`
  388. }
  389. // VoiceChannelJoin joins the authenticated session user to
  390. // a voice channel. All the voice magic starts with this.
  391. func (s *Session) VoiceChannelJoin(guildID, channelID string) {
  392. if s.wsConn == nil {
  393. fmt.Println("error: no websocket connection exists.")
  394. return // TODO return error
  395. }
  396. // Odd, but.. it works. map interface caused odd unknown opcode error
  397. // Later I'll test with a struct
  398. json := []byte(fmt.Sprintf(`{"op":4,"d":{"guild_id":"%s","channel_id":"%s","self_mute":false,"self_deaf":false}}`,
  399. guildID, channelID))
  400. err := s.wsConn.WriteMessage(websocket.TextMessage, json)
  401. if err != nil {
  402. fmt.Println("error:", err)
  403. return
  404. }
  405. // Probably will be removed later.
  406. s.VGuildID = guildID
  407. s.VChannelID = channelID
  408. }
  409. // onVoiceStateUpdate handles Voice State Update events on the data
  410. // websocket. This comes immediately after the call to VoiceChannelJoin
  411. // for the authenticated session user. This block is experimental
  412. // code and will be chaned in the future.
  413. func (s *Session) onVoiceStateUpdate(st VoiceState) {
  414. // Need to have this happen at login and store it in the Session
  415. self, err := s.User("@me")
  416. if err != nil {
  417. fmt.Println(err)
  418. return
  419. }
  420. // This event comes for all users, if it's not for the session
  421. // user just ignore it.
  422. if st.UserID != self.ID {
  423. return
  424. }
  425. // Store the SessionID. Used later.
  426. s.VSessionID = st.SessionID
  427. }
  428. // onVoiceServerUpdate handles the Voice Server Update data websocket event.
  429. // This will later be exposed but is only for experimental use now.
  430. func (s *Session) onVoiceServerUpdate(st VoiceServerUpdate) {
  431. // Store all the values. They are used later.
  432. // GuildID is probably not needed and may be dropped.
  433. s.VToken = st.Token
  434. s.VEndpoint = st.Endpoint
  435. s.VGuildID = st.GuildID
  436. // We now have enough information to open a voice websocket conenction
  437. // so, that's what the next call does.
  438. s.VoiceOpenWS()
  439. }