-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
broadcast.go
227 lines (186 loc) · 5.31 KB
/
broadcast.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
// SiYuan - Refactor your thinking
// Copyright (c) 2020-present, b3log.org
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
package api
import (
"fmt"
"net/http"
"sync"
"github.com/88250/gulu"
"github.com/gin-gonic/gin"
"github.com/olahol/melody"
"github.com/siyuan-note/logging"
"github.com/siyuan-note/siyuan/kernel/util"
)
type Channel struct {
Name string `json:"name"`
Count int `json:"count"`
}
var (
BroadcastChannels = sync.Map{}
)
/*
broadcast create a broadcast channel WebSocket connection
@param
query.channel: channel name
@example
ws://localhost:6806/ws/broadcast?channel=test
*/
func broadcast(c *gin.Context) {
var (
channel string = c.Query("channel")
broadcastChannel *melody.Melody
)
if _broadcastChannel, exist := BroadcastChannels.Load(channel); exist {
// channel exists, use it
broadcastChannel = _broadcastChannel.(*melody.Melody)
subscribe(c, broadcastChannel, channel)
} else {
// channel not found, create a new one
broadcastChannel := melody.New()
broadcastChannel.Config.MaxMessageSize = 1024 * 1024 * 128 // 128 MiB
BroadcastChannels.Store(channel, broadcastChannel)
subscribe(c, broadcastChannel, channel)
// broadcast string message to other session
broadcastChannel.HandleMessage(func(s *melody.Session, msg []byte) {
broadcastChannel.BroadcastOthers(msg, s)
})
// broadcast binary message to other session
broadcastChannel.HandleMessageBinary(func(s *melody.Session, msg []byte) {
broadcastChannel.BroadcastBinaryOthers(msg, s)
})
// recycling
broadcastChannel.HandleClose(func(s *melody.Session, status int, reason string) error {
channel := s.Keys["channel"].(string)
logging.LogInfof("close broadcast session in channel [%s] with status code %d: %s", channel, status, reason)
count := broadcastChannel.Len()
if count == 0 {
BroadcastChannels.Delete(channel)
logging.LogInfof("dispose broadcast channel [%s]", channel)
}
return nil
})
}
}
// subscribe creates a new websocket session to a channel
func subscribe(c *gin.Context, broadcastChannel *melody.Melody, channel string) {
if err := broadcastChannel.HandleRequestWithKeys(
c.Writer,
c.Request,
map[string]interface{}{
"channel": channel,
},
); nil != err {
logging.LogErrorf("create broadcast channel failed: %s", err)
return
}
}
/*
postMessage send string message to a broadcast channel
@param
body.channel: channel name
body.message: message payload
@returns
body.data.channel.name: channel name
body.data.channel.count: indicate how many websocket session received the message
*/
func postMessage(c *gin.Context) {
ret := gulu.Ret.NewResult()
defer c.JSON(http.StatusOK, ret)
arg, ok := util.JsonArg(c, ret)
if !ok {
return
}
channel := arg["channel"].(string)
message := arg["message"].(string)
if _broadcastChannel, ok := BroadcastChannels.Load(channel); !ok {
err := fmt.Errorf("broadcast channel [%s] not found", channel)
logging.LogWarnf(err.Error())
ret.Code = -1
ret.Msg = err.Error()
return
} else {
var broadcastChannel = _broadcastChannel.(*melody.Melody)
if err := broadcastChannel.Broadcast([]byte(message)); nil != err {
logging.LogErrorf("broadcast message failed: %s", err)
ret.Code = -2
ret.Msg = err.Error()
return
}
count := broadcastChannel.Len()
ret.Data = map[string]interface{}{
"channel": &Channel{
Name: channel,
Count: count,
},
}
}
}
/*
getChannelInfo gets the information of a broadcast channel
@param
body.name: channel name
@returns
body.data.channel: the channel information
*/
func getChannelInfo(c *gin.Context) {
ret := gulu.Ret.NewResult()
defer c.JSON(http.StatusOK, ret)
arg, ok := util.JsonArg(c, ret)
if !ok {
return
}
name := arg["name"].(string)
if _broadcastChannel, ok := BroadcastChannels.Load(name); !ok {
err := fmt.Errorf("broadcast channel [%s] not found", name)
logging.LogWarnf(err.Error())
ret.Code = -1
ret.Msg = err.Error()
return
} else {
var broadcastChannel = _broadcastChannel.(*melody.Melody)
count := broadcastChannel.Len()
ret.Data = map[string]interface{}{
"channel": &Channel{
Name: name,
Count: count,
},
}
}
}
/*
getChannels gets the channel name and lintener number of all broadcast chanel
@returns
body.data.channels: {
name: channel name
count: listener count
}[]
*/
func getChannels(c *gin.Context) {
ret := gulu.Ret.NewResult()
defer c.JSON(http.StatusOK, ret)
channels := []*Channel{}
BroadcastChannels.Range(func(key, value any) bool {
broadcastChannel := value.(*melody.Melody)
channels = append(channels, &Channel{
Name: key.(string),
Count: broadcastChannel.Len(),
})
return true
})
ret.Data = map[string]interface{}{
"channels": channels,
}
}