forked from Jeffail/leaps
-
Notifications
You must be signed in to change notification settings - Fork 0
/
http_server.go
307 lines (276 loc) · 9.48 KB
/
http_server.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
/*
Copyright (c) 2014 Ashley Jeffs
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, sub to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
package net
import (
"errors"
"fmt"
"net/http"
"code.google.com/p/go.net/websocket"
"github.com/jeffail/leaps/lib"
"github.com/jeffail/util/log"
)
/*--------------------------------------------------------------------------------------------------
*/
/*
SSLConfig - Options for setting an SSL certificate
*/
type SSLConfig struct {
Enabled bool `json:"enabled" yaml:"enabled"`
CertificatePath string `json:"certificate_path" yaml:"certificate_path"`
PrivateKeyPath string `json:"private_key_path" yaml:"private_key_path"`
}
/*
NewSSLConfig - Creates a new SSLConfig object with default values
*/
func NewSSLConfig() SSLConfig {
return SSLConfig{
Enabled: false,
CertificatePath: "",
PrivateKeyPath: "",
}
}
/*
HTTPBinderConfig - Options for individual binders (one for each socket connection)
*/
type HTTPBinderConfig struct {
BindSendTimeout int `json:"bind_send_timeout_ms" yaml:"bind_send_timeout_ms"`
}
/*
HTTPServerConfig - Holds configuration options for the HTTPServer.
*/
type HTTPServerConfig struct {
StaticPath string `json:"static_path" yaml:"static_path"`
Path string `json:"socket_path" yaml:"socket_path"`
Address string `json:"address" yaml:"address"`
StaticFilePath string `json:"www_dir" yaml:"www_dir"`
Binder HTTPBinderConfig `json:"binder" yaml:"binder"`
SSL SSLConfig `json:"ssl" yaml:"ssl"`
HTTPAuth AuthMiddlewareConfig `json:"basic_auth" yaml:"basic_auth"`
}
/*
DefaultHTTPServerConfig - Returns a fully defined HTTPServer configuration with the default values
for each field.
*/
func DefaultHTTPServerConfig() HTTPServerConfig {
return HTTPServerConfig{
StaticPath: "/leaps",
Path: "/leaps/socket",
Address: "localhost:8080",
StaticFilePath: "",
Binder: HTTPBinderConfig{
BindSendTimeout: 10,
},
SSL: NewSSLConfig(),
HTTPAuth: NewAuthMiddlewareConfig(),
}
}
/*--------------------------------------------------------------------------------------------------
*/
/*
LeapClientMessage - A structure that defines a message format to expect from clients. Commands can
be 'create' (init with new document) or 'find' (init with existing document).
*/
type LeapClientMessage struct {
Command string `json:"command" yaml:"command"`
Token string `json:"token" yaml:"token"`
DocID string `json:"document_id,omitempty" yaml:"document_id,omitempty"`
UserID string `json:"user_id,omitempty" yaml:"user_id,omitempty"`
Document *lib.Document `json:"leap_document,omitempty" yaml:"leap_document,omitempty"`
}
/*
LeapServerMessage - A structure that defines a response message from the server to a client. Type
can be 'document' (init response) or 'error' (an error message to display to the client).
*/
type LeapServerMessage struct {
Type string `json:"response_type" yaml:"response_type"`
Document *lib.Document `json:"leap_document,omitempty" yaml:"leap_document,omitempty"`
Version *int `json:"version,omitempty" yaml:"version,omitempty"`
Error string `json:"error,omitempty" yaml:"error,omitempty"`
}
/*--------------------------------------------------------------------------------------------------
*/
/*
HTTPServer - A construct designed to take a LeapLocator (a structure for finding and binding to
leap documents) and bind it to http clients.
*/
type HTTPServer struct {
config HTTPServerConfig
logger *log.Logger
stats *log.Stats
auth *AuthMiddleware
locator LeapLocator
closeChan chan bool
}
/*
CreateHTTPServer - Create a new leaps HTTPServer.
*/
func CreateHTTPServer(
locator LeapLocator,
config HTTPServerConfig,
logger *log.Logger,
stats *log.Stats,
) (*HTTPServer, error) {
auth, err := NewAuthMiddleware(config.HTTPAuth, logger, stats)
if err != nil {
return nil, err
}
httpServer := HTTPServer{
config: config,
locator: locator,
logger: logger.NewModule("[http]"),
stats: stats,
auth: auth,
closeChan: make(chan bool),
}
if len(httpServer.config.Path) == 0 {
return nil, errors.New("invalid config value for socket path")
}
http.Handle(
httpServer.config.Path,
httpServer.auth.WrapWSHandler(websocket.Handler(httpServer.websocketHandler)),
)
if len(httpServer.config.StaticFilePath) > 0 {
if len(httpServer.config.StaticPath) == 0 {
return nil, errors.New("invalid config value for static path")
}
http.Handle(httpServer.config.StaticPath,
httpServer.auth.WrapHandler( // Auth wrap
http.StripPrefix(httpServer.config.StaticPath, // File strip prefix wrap
http.FileServer(http.Dir(httpServer.config.StaticFilePath))))) // File serve handler
}
return &httpServer, nil
}
/*--------------------------------------------------------------------------------------------------
*/
/*
websocketHandler - The method for creating fresh websocket clients.
*/
func (h *HTTPServer) websocketHandler(ws *websocket.Conn) {
defer func() {
if err := ws.Close(); err != nil {
h.logger.Errorf("Failed to close socket: %v\n", err)
}
h.stats.Decr("http.open_websockets", 1)
}()
h.stats.Incr("http.websocket.opened", 1)
h.stats.Incr("http.open_websockets", 1)
select {
case <-h.closeChan:
websocket.JSON.Send(ws, LeapServerMessage{
Type: "error",
Error: "target server node is closing",
})
return
default:
}
h.logger.Infoln("Fresh client connected via websocket")
handleInitError := func(err error) {
h.logger.Infof("Client failed to init: %v\n", err)
websocket.JSON.Send(ws, LeapServerMessage{
Type: "error",
Error: fmt.Sprintf("socket initialization failed: %v", err),
})
}
for {
var clientMsg LeapClientMessage
websocket.JSON.Receive(ws, &clientMsg)
switch clientMsg.Command {
case "create":
if clientMsg.Document == nil {
handleInitError(errors.New("create request must contain a valid document structure"))
return
}
h.logger.Infoln("Attempting to create document")
if binder, err := h.locator.CreateDocument(
clientMsg.Token, clientMsg.UserID, *clientMsg.Document); err == nil {
h.logger.Infof("Client bound to document %v\n", binder.Document.ID)
websocket.JSON.Send(ws, LeapServerMessage{
Type: "document",
Document: &binder.Document,
Version: &binder.Version,
})
socketRouter := NewWebsocketServer(h.config.Binder, ws, binder, h.closeChan, h.logger, h.stats)
socketRouter.Launch()
} else {
handleInitError(err)
}
return
case "find":
if len(clientMsg.DocID) <= 0 {
handleInitError(errors.New("find request must contain a valid document ID"))
return
}
h.logger.Infof("Attempting to bind to document: %v\n", clientMsg.DocID)
if binder, err := h.locator.FindDocument(clientMsg.Token, clientMsg.DocID); err == nil {
h.logger.Infof("Client bound to document %v\n", binder.Document.ID)
websocket.JSON.Send(ws, LeapServerMessage{
Type: "document",
Document: &binder.Document,
Version: &binder.Version,
})
socketRouter := NewWebsocketServer(h.config.Binder, ws, binder, h.closeChan, h.logger, h.stats)
socketRouter.Launch()
} else {
handleInitError(err)
}
return
case "ping":
// Ignore
default:
handleInitError(fmt.Errorf("first message must be init, client sent: %v", clientMsg.Command))
return
}
}
}
/*
Listen - Bind to the http endpoint as per configured address, and begin serving requests. This is
simply a helper function that calls http.ListenAndServe
*/
func (h *HTTPServer) Listen() error {
if len(h.config.Address) == 0 {
return errors.New("invalid config value for URL.Address")
}
if h.config.SSL.Enabled && (len(h.config.SSL.CertificatePath) == 0 || len(h.config.SSL.PrivateKeyPath) == 0) {
return errors.New("SSL requires both a certificate path and private key path")
}
h.logger.Infof("Listening for websockets at address: %v%v\n", h.config.Address, h.config.Path)
if len(h.config.StaticPath) > 0 {
h.logger.Infof("Serving static file requests at address: %v%v\n", h.config.Address, h.config.StaticPath)
}
var err error
if h.config.SSL.Enabled {
err = http.ListenAndServeTLS(
h.config.Address,
h.config.SSL.CertificatePath,
h.config.SSL.PrivateKeyPath,
nil,
)
} else {
err = http.ListenAndServe(h.config.Address, nil)
}
return err
}
/*
Stop - Stop serving web requests and close the HTTPServer.
*/
func (h *HTTPServer) Stop() {
close(h.closeChan)
}
/*--------------------------------------------------------------------------------------------------
*/