api_rest_ws.go 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. package api_rest
  2. import (
  3. "encoding/json"
  4. "net/http"
  5. "strings"
  6. "time"
  7. "github.com/bettercap/bettercap/session"
  8. "github.com/gorilla/websocket"
  9. )
  10. const (
  11. // Time allowed to write an event to the client.
  12. writeWait = 10 * time.Second
  13. // Time allowed to read the next pong message from the client.
  14. pongWait = 60 * time.Second
  15. // Send pings to client with this period. Must be less than pongWait.
  16. pingPeriod = (pongWait * 9) / 10
  17. )
  18. func (mod *RestAPI) streamEvent(ws *websocket.Conn, event session.Event) error {
  19. msg, err := json.Marshal(event)
  20. if err != nil {
  21. mod.Error("Error while creating websocket message: %s", err)
  22. return err
  23. }
  24. ws.SetWriteDeadline(time.Now().Add(writeWait))
  25. if err := ws.WriteMessage(websocket.TextMessage, msg); err != nil {
  26. if !strings.Contains(err.Error(), "closed connection") {
  27. mod.Error("Error while writing websocket message: %s", err)
  28. return err
  29. }
  30. }
  31. return nil
  32. }
  33. func (mod *RestAPI) sendPing(ws *websocket.Conn) error {
  34. ws.SetWriteDeadline(time.Now().Add(writeWait))
  35. ws.SetReadDeadline(time.Now().Add(pongWait))
  36. if err := ws.WriteMessage(websocket.PingMessage, []byte{}); err != nil {
  37. mod.Error("Error while writing websocket ping message: %s", err)
  38. return err
  39. }
  40. return nil
  41. }
  42. func (mod *RestAPI) streamWriter(ws *websocket.Conn, w http.ResponseWriter, r *http.Request) {
  43. defer ws.Close()
  44. // first we stream what we already have
  45. events := session.I.Events.Sorted()
  46. n := len(events)
  47. if n > 0 {
  48. mod.Debug("Sending %d events.", n)
  49. for _, event := range events {
  50. if err := mod.streamEvent(ws, event); err != nil {
  51. return
  52. }
  53. }
  54. }
  55. session.I.Events.Clear()
  56. mod.Debug("Listening for events and streaming to ws endpoint ...")
  57. pingTicker := time.NewTicker(pingPeriod)
  58. listener := session.I.Events.Listen()
  59. defer session.I.Events.Unlisten(listener)
  60. for {
  61. select {
  62. case <-pingTicker.C:
  63. if err := mod.sendPing(ws); err != nil {
  64. return
  65. }
  66. case event := <-listener:
  67. if err := mod.streamEvent(ws, event); err != nil {
  68. return
  69. }
  70. case <-mod.quit:
  71. mod.Info("Stopping websocket events streamer ...")
  72. return
  73. }
  74. }
  75. }
  76. func (mod *RestAPI) streamReader(ws *websocket.Conn) {
  77. defer ws.Close()
  78. ws.SetReadLimit(512)
  79. ws.SetReadDeadline(time.Now().Add(pongWait))
  80. ws.SetPongHandler(func(string) error { ws.SetReadDeadline(time.Now().Add(pongWait)); return nil })
  81. for {
  82. _, _, err := ws.ReadMessage()
  83. if err != nil {
  84. mod.Warning("error reading message from websocket: %v", err)
  85. break
  86. }
  87. }
  88. }
  89. func (mod *RestAPI) startStreamingEvents(w http.ResponseWriter, r *http.Request) {
  90. ws, err := mod.upgrader.Upgrade(w, r, nil)
  91. if err != nil {
  92. if _, ok := err.(websocket.HandshakeError); !ok {
  93. mod.Error("error while updating api.rest connection to websocket: %s", err)
  94. }
  95. return
  96. }
  97. mod.Debug("websocket streaming started for %s", r.RemoteAddr)
  98. go mod.streamWriter(ws, w, r)
  99. mod.streamReader(ws)
  100. }