-
-
Notifications
You must be signed in to change notification settings - Fork 48
/
websocket.clj
256 lines (230 loc) · 9.02 KB
/
websocket.clj
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
(ns ring.adapter.jetty9.websocket
(:import [org.eclipse.jetty.servlet ServletHolder]
[org.eclipse.jetty.websocket.api
WebSocketAdapter Session
RemoteEndpoint WriteCallback WebSocketPingPongListener]
[org.eclipse.jetty.websocket.server JettyWebSocketServerContainer
JettyWebSocketCreator JettyServerUpgradeRequest]
[org.eclipse.jetty.websocket.common JettyExtensionConfig]
[javax.servlet AsyncContext]
[javax.servlet.http HttpServlet HttpServletRequest HttpServletResponse]
[clojure.lang IFn]
[java.nio ByteBuffer]
[java.util Locale]
[java.time Duration])
(:require [clojure.string :as string]
[ring.adapter.jetty9.common :refer [RequestMapDecoder build-request-map
get-headers set-headers]]))
(defprotocol WebSocketProtocol
(send! [this msg] [this msg callback])
(ping! [this] [this msg])
(close! [this]
[this status-code reason])
(remote-addr [this])
(idle-timeout! [this ms])
(connected? [this])
(req-of [this]))
(defprotocol WebSocketSend
(-send! [x ws] [x ws callback] "How to encode content sent to the WebSocket clients"))
(defprotocol WebSocketPing
(-ping! [x ws] "How to encode bytes sent with a ping"))
(def ^:private no-op (constantly nil))
(defn- write-callback
[{:keys [write-failed write-success]
:or {write-failed no-op
write-success no-op}}]
(reify WriteCallback
(writeFailed [_ throwable]
(write-failed throwable))
(writeSuccess [_]
(write-success))))
(extend-protocol WebSocketSend
(Class/forName "[B")
(-send!
([ba ws]
(-send! (ByteBuffer/wrap ba) ws))
([ba ws callback]
(-send! (ByteBuffer/wrap ba) ws callback)))
ByteBuffer
(-send!
([bb ws]
(-> ^WebSocketAdapter ws .getRemote (.sendBytes ^ByteBuffer bb)))
([bb ws callback]
(-> ^WebSocketAdapter ws .getRemote (.sendBytes ^ByteBuffer bb ^WriteCallback (write-callback callback)))))
String
(-send!
([s ws]
(-> ^WebSocketAdapter ws .getRemote (.sendString ^String s)))
([s ws callback]
(-> ^WebSocketAdapter ws .getRemote (.sendString ^String s ^WriteCallback (write-callback callback)))))
IFn
(-send! [f ws]
(-> ^WebSocketAdapter ws .getRemote f))
Object
(send!
([this ws]
(-> ^WebSocketAdapter ws .getRemote
(.sendString ^RemoteEndpoint (str this))))
([this ws callback]
(-> ^WebSocketAdapter ws .getRemote
(.sendString ^RemoteEndpoint (str this) ^WriteCallback (write-callback callback))))))
(extend-protocol WebSocketPing
(Class/forName "[B")
(-ping! [ba ws] (-ping! (ByteBuffer/wrap ba) ws))
ByteBuffer
(-ping! [bb ws] (-> ^WebSocketAdapter ws .getRemote (.sendPing ^ByteBuffer bb)))
String
(-ping! [s ws] (-ping! (.getBytes ^String s) ws))
Object
(-ping! [o ws] (-ping! (str o) ws)))
(extend-protocol RequestMapDecoder
JettyServerUpgradeRequest
(build-request-map [request]
(let [servlet-request (.getHttpServletRequest request)
base-request-map {:server-port (.getServerPort servlet-request)
:server-name (.getServerName servlet-request)
:remote-addr (.getRemoteAddr servlet-request)
:uri (.getRequestURI servlet-request)
:query-string (.getQueryString servlet-request)
:scheme (keyword (.getScheme servlet-request))
:request-method (keyword (.toLowerCase (.getMethod servlet-request) Locale/ENGLISH))
:protocol (.getProtocol servlet-request)
:headers (get-headers servlet-request)
:ssl-client-cert (first (.getAttribute servlet-request
"javax.servlet.request.X509Certificate"))}]
(assoc base-request-map
:websocket-subprotocols (into [] (.getSubProtocols request))
:websocket-extensions (into [] (.getExtensions request))))))
(extend-protocol WebSocketProtocol
WebSocketAdapter
(send!
([this msg]
(-send! msg this))
([this msg callback]
(-send! msg this callback)))
(ping!
([this]
(-ping! (ByteBuffer/allocate 0) this))
([this msg]
(-ping! msg this)))
(close! [this]
(.. this (getSession) (close)))
(close! [this status-code reason]
(.. this (getSession) (close status-code reason)))
(remote-addr [this]
(.. this (getSession) (getRemoteAddress)))
(idle-timeout! [this ms]
(.. this (getSession) (setIdleTimeout ^long ms)))
(connected? [this]
(. this (isConnected)))
(req-of [this]
(build-request-map (.. this (getSession) (getUpgradeRequest)))))
(defn- proxy-ws-adapter
[{:as _
:keys [on-connect on-error on-text on-close on-bytes on-ping on-pong]
:or {on-connect no-op
on-error no-op
on-text no-op
on-close no-op
on-bytes no-op
on-ping no-op
on-pong no-op}}]
(proxy [WebSocketAdapter WebSocketPingPongListener] []
(onWebSocketConnect [^Session session]
(let [^WebSocketAdapter this this]
(proxy-super onWebSocketConnect session))
(on-connect this))
(onWebSocketError [^Throwable e]
(on-error this e))
(onWebSocketText [^String message]
(on-text this message))
(onWebSocketClose [statusCode ^String reason]
(let [^WebSocketAdapter this this]
(proxy-super onWebSocketClose statusCode reason))
(on-close this statusCode reason))
(onWebSocketBinary [^bytes payload offset len]
(on-bytes this payload offset len))
(onWebSocketPing [^ByteBuffer bytebuffer]
(on-ping this bytebuffer))
(onWebSocketPong [^ByteBuffer bytebuffer]
(on-pong this bytebuffer))))
(defn reify-default-ws-creator
[ws-fns]
(reify JettyWebSocketCreator
(createWebSocket [this _ _]
(proxy-ws-adapter ws-fns))))
(defn reify-custom-ws-creator
[ws-creator-fn]
(reify JettyWebSocketCreator
(createWebSocket [this req resp]
(let [req-map (build-request-map req)
ws-results (ws-creator-fn req-map)]
(if-let [{:keys [code message headers]} (:error ws-results)]
(do (set-headers resp headers)
(.sendError resp code message))
(do
(when-let [sp (:subprotocol ws-results)]
(.setAcceptedSubProtocol resp sp))
(when-let [exts (not-empty (:extensions ws-results))]
(.setExtensions resp (mapv #(JettyExtensionConfig. ^String %) exts)))
(proxy-ws-adapter ws-results)))))))
(defn upgrade-websocket
([req res ws options]
(upgrade-websocket req res nil ws options))
([^HttpServletRequest req
^HttpServletResponse res
^AsyncContext async-context
ws
{:as _options
:keys [ws-max-idle-time
ws-max-text-message-size]
:or {ws-max-idle-time 500000
ws-max-text-message-size 65536}}]
{:pre [(or (map? ws) (fn? ws))]}
(let [creator (if (map? ws)
(reify-default-ws-creator ws)
(reify-custom-ws-creator ws))
container (JettyWebSocketServerContainer/getContainer (.getServletContext req))]
(.setIdleTimeout container (Duration/ofMillis ws-max-idle-time))
(.setMaxTextMessageSize container ws-max-text-message-size)
(.upgrade container creator req res)
(when async-context
(.complete async-context)))))
(defn proxy-ws-servlet [ws options]
(ServletHolder.
(proxy [HttpServlet] []
(doGet [req res]
(upgrade-websocket req res ws options)))))
(defn ws-upgrade-request?
"Checks if a request is a websocket upgrade request.
It is a websocket upgrade request when it contains the following headers:
- connection: upgrade
- upgrade: websocket
"
[{:keys [headers]}]
(let [upgrade (get headers "upgrade")
connection (get headers "connection")]
(and upgrade
connection
(string/includes? (string/lower-case upgrade) "websocket")
(string/includes? (string/lower-case connection) "upgrade"))))
(defn ws-upgrade-response
"Returns a websocket upgrade response.
ws-handler must be a map of handler fns:
{:on-connect #(create-fn %) ; ^Session ws-session
:on-text #(text-fn % %2 %3 %4) ; ^Session ws-session message
:on-bytes #(binary-fn % %2 %3 %4 %5 %6) ; ^Session ws-session payload offset len
:on-close #(close-fn % %2 %3 %4) ; ^Session ws-session statusCode reason
:on-error #(error-fn % %2 %3)} ; ^Session ws-session e
or a custom creator function take upgrade request as parameter and returns a handler fns map,
negotiated subprotocol and extensions (or error info).
The response contains HTTP status 101 (Switching Protocols)
and the following headers:
- connection: upgrade
- upgrade: websocket
"
[ws-handler]
{:status 101 ;; http 101 switching protocols
:headers {"upgrade" "websocket"
"connection" "upgrade"}
:ws ws-handler})