Added Copyright header.
[src/xds/xds-server.git] / lib / xdsserver / webserver.go
1 /*
2  * Copyright (C) 2017 "IoT.bzh"
3  * Author Sebastien Douheret <sebastien@iot.bzh>
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *   http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 package xdsserver
19
20 import (
21         "fmt"
22         "log"
23         "net/http"
24         "os"
25
26         "path"
27
28         "github.com/Sirupsen/logrus"
29         "github.com/gin-contrib/static"
30         "github.com/gin-gonic/gin"
31         "github.com/googollee/go-socket.io"
32 )
33
34 // WebServer .
35 type WebServer struct {
36         *Context
37         router    *gin.Engine
38         api       *APIService
39         sIOServer *socketio.Server
40         webApp    *gin.RouterGroup
41         stop      chan struct{} // signals intentional stop
42 }
43
44 const indexFilename = "index.html"
45
46 // NewWebServer creates an instance of WebServer
47 func NewWebServer(ctx *Context) *WebServer {
48
49         // Setup logging for gin router
50         if ctx.Log.Level == logrus.DebugLevel {
51                 gin.SetMode(gin.DebugMode)
52         } else {
53                 gin.SetMode(gin.ReleaseMode)
54         }
55
56         // Redirect gin logs into another logger (LogVerboseOut may be stderr or a file)
57         gin.DefaultWriter = ctx.Config.LogVerboseOut
58         gin.DefaultErrorWriter = ctx.Config.LogVerboseOut
59         log.SetOutput(ctx.Config.LogVerboseOut)
60
61         // FIXME - fix pb about isTerminal=false when out is in VSC Debug Console
62
63         // Creates gin router
64         r := gin.New()
65
66         svr := &WebServer{
67                 Context:   ctx,
68                 router:    r,
69                 api:       nil,
70                 sIOServer: nil,
71                 webApp:    nil,
72                 stop:      make(chan struct{}),
73         }
74
75         return svr
76 }
77
78 // Serve starts a new instance of the Web Server
79 func (s *WebServer) Serve() error {
80         var err error
81
82         // Setup middlewares
83         s.router.Use(gin.Logger())
84         s.router.Use(gin.Recovery())
85         s.router.Use(s.middlewareXDSDetails())
86         s.router.Use(s.middlewareCORS())
87
88         // Create REST API
89         s.api = NewAPIV1(s.Context)
90
91         // Websocket routes
92         s.sIOServer, err = socketio.NewServer(nil)
93         if err != nil {
94                 s.Log.Fatalln(err)
95         }
96
97         s.router.GET("/socket.io/", s.socketHandler)
98         s.router.POST("/socket.io/", s.socketHandler)
99         /* TODO: do we want to support ws://...  ?
100         s.router.Handle("WS", "/socket.io/", s.socketHandler)
101         s.router.Handle("WSS", "/socket.io/", s.socketHandler)
102         */
103
104         // Web Application (serve on / )
105         idxFile := path.Join(s.Config.FileConf.WebAppDir, indexFilename)
106         if _, err := os.Stat(idxFile); err != nil {
107                 s.Log.Fatalln("Web app directory not found, check/use webAppDir setting in config file: ", idxFile)
108         }
109         s.Log.Infof("Serve WEB app dir: %s", s.Config.FileConf.WebAppDir)
110         s.router.Use(static.Serve("/", static.LocalFile(s.Config.FileConf.WebAppDir, true)))
111         s.webApp = s.router.Group("/", s.serveIndexFile)
112         {
113                 s.webApp.GET("/")
114         }
115
116         // Serve in the background
117         serveError := make(chan error, 1)
118         go func() {
119                 msg := fmt.Sprintf("Web Server running on localhost:%s ...\n", s.Config.FileConf.HTTPPort)
120                 s.Log.Infof(msg)
121                 fmt.Printf(msg)
122                 serveError <- http.ListenAndServe(":"+s.Config.FileConf.HTTPPort, s.router)
123         }()
124
125         // Wait for stop, restart or error signals
126         select {
127         case <-s.stop:
128                 // Shutting down permanently
129                 s.sessions.Stop()
130                 s.Log.Infoln("shutting down (stop)")
131         case err = <-serveError:
132                 // Error due to listen/serve failure
133                 s.Log.Errorln(err)
134         }
135
136         return nil
137 }
138
139 // Stop web server
140 func (s *WebServer) Stop() {
141         close(s.stop)
142 }
143
144 // serveIndexFile provides initial file (eg. index.html) of webapp
145 func (s *WebServer) serveIndexFile(c *gin.Context) {
146         c.HTML(200, indexFilename, gin.H{})
147 }
148
149 // Add details in Header
150 func (s *WebServer) middlewareXDSDetails() gin.HandlerFunc {
151         return func(c *gin.Context) {
152                 c.Header("XDS-Version", s.Config.Version)
153                 c.Header("XDS-API-Version", s.Config.APIVersion)
154                 c.Next()
155         }
156 }
157
158 // CORS middleware
159 func (s *WebServer) middlewareCORS() gin.HandlerFunc {
160         return func(c *gin.Context) {
161                 if c.Request.Method == "OPTIONS" {
162                         c.Header("Access-Control-Allow-Origin", "*")
163                         c.Header("Access-Control-Allow-Headers", "Content-Type")
164                         c.Header("Access-Control-Allow-Methods", "GET, POST, DELETE")
165                         c.Header("Access-Control-Max-Age", cookieMaxAge)
166                         c.AbortWithStatus(204)
167                         return
168                 }
169
170                 c.Next()
171         }
172 }
173
174 // socketHandler is the handler for the "main" websocket connection
175 func (s *WebServer) socketHandler(c *gin.Context) {
176
177         // Retrieve user session
178         sess := s.sessions.Get(c)
179         if sess == nil {
180                 c.JSON(500, gin.H{"error": "Cannot retrieve session"})
181                 return
182         }
183
184         s.sIOServer.On("connection", func(so socketio.Socket) {
185                 s.Log.Debugf("WS Connected (SID=%v)", so.Id())
186                 s.sessions.UpdateIOSocket(sess.ID, &so)
187
188                 so.On("disconnection", func() {
189                         s.Log.Debugf("WS disconnected (SID=%v)", so.Id())
190                         s.sessions.UpdateIOSocket(sess.ID, nil)
191                 })
192         })
193
194         s.sIOServer.On("error", func(so socketio.Socket, err error) {
195                 s.Log.Errorf("WS SID=%v Error : %v", so.Id(), err.Error())
196         })
197
198         s.sIOServer.ServeHTTP(c.Writer, c.Request)
199 }