/
file_server.go
236 lines (209 loc) · 7.2 KB
/
file_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
package httpfs
import (
"errors"
"fmt"
"html/template"
"io"
"net/http"
"os"
"time"
"github.com/gin-contrib/gzip"
"github.com/gin-contrib/pprof"
"github.com/gin-contrib/sessions"
"github.com/gin-gonic/gin"
"github.com/no-src/gofs/auth"
"github.com/no-src/gofs/core"
"github.com/no-src/gofs/driver/minio"
"github.com/no-src/gofs/driver/sftp"
"github.com/no-src/gofs/internal/rate"
"github.com/no-src/gofs/logger"
"github.com/no-src/gofs/report"
"github.com/no-src/gofs/server"
"github.com/no-src/gofs/server/handler"
"github.com/no-src/gofs/server/middleware"
"github.com/no-src/nsgo/hashutil"
"github.com/quic-go/quic-go/http3"
)
// StartFileServer start a file server by gin
func StartFileServer(opt server.Option) error {
logger := opt.Logger
initEnvGinMode()
gin.DefaultWriter = logger
engine := gin.New()
engine.NoRoute(middleware.NoRoute)
initCompress(engine, opt.EnableFileServerCompress)
initDefaultMiddleware(engine, logger, opt.Reporter)
if err := initHTMLTemplate(engine); err != nil {
opt.Init.DoneWithError(err)
return err
}
if err := initSession(engine, opt.SessionConnection); err != nil {
opt.Init.DoneWithError(err)
return err
}
if err := initRoute(engine, opt, logger); err != nil {
opt.Init.DoneWithError(err)
return err
}
logger.Info("file server [%s] starting...", opt.FileServerAddr)
c := make(chan error, 1)
go func() {
select {
case <-time.After(time.Second):
opt.Init.Done()
case err := <-c:
opt.Init.DoneWithError(err)
}
}()
var err error
if opt.EnableTLS {
if opt.EnableHTTP3 {
err = logger.ErrorIf(http3.ListenAndServe(opt.FileServerAddr, opt.TLSCertFile, opt.TLSKeyFile, engine.Handler()), "running the http3 server error")
} else {
err = logger.ErrorIf(engine.RunTLS(opt.FileServerAddr, opt.TLSCertFile, opt.TLSKeyFile), "running the https server error")
}
c <- err
return err
}
if opt.EnableHTTP3 && !opt.EnableTLS {
logger.Warn("please enable the TLS first if you want to enable the HTTP3 protocol, currently downgraded to HTTP2!")
}
logger.Warn("file server is not a security connection, you need the https replaced maybe!")
err = logger.ErrorIf(engine.Run(opt.FileServerAddr), "running the http server error")
c <- err
return err
}
// initEnvGinMode change default mode is release
func initEnvGinMode() {
mode := os.Getenv(gin.EnvGinMode)
if mode == "" {
mode = gin.ReleaseMode
}
gin.SetMode(mode)
}
func initSession(engine *gin.Engine, sessionConnection string) error {
store, err := server.NewSessionStore(sessionConnection)
if err != nil {
return err
}
engine.Use(sessions.Sessions(server.SessionName, store))
return nil
}
func initDefaultMiddleware(engine *gin.Engine, logger io.Writer, reporter report.Reporter) {
engine.Use(gin.LoggerWithConfig(gin.LoggerConfig{
Formatter: defaultLogFormatter,
Output: logger,
SkipPaths: []string{"/favicon.ico"},
}), gin.Recovery(), middleware.ApiStat(reporter))
}
func initHTMLTemplate(engine *gin.Engine) error {
tmpl, err := template.ParseFS(server.Templates, server.ResourceTemplatePath)
if err != nil {
return err
}
engine.SetHTMLTemplate(tmpl)
return nil
}
func initCompress(engine *gin.Engine, enableCompress bool) {
if enableCompress {
// enable gzip compression
engine.Use(gzip.Gzip(gzip.DefaultCompression))
}
}
func initRoute(engine *gin.Engine, opt server.Option, logger *logger.Logger) error {
enableFileApi := false
source := opt.Source
dest := opt.Dest
reporter := opt.Reporter
loginGroup := engine.Group(server.LoginGroupRoute)
loginGroup.GET(server.LoginIndexRoute, func(context *gin.Context) {
context.HTML(http.StatusOK, "login.html", nil)
})
loginGroup.POST(server.LoginSignInRoute, handler.NewLoginHandlerFunc(opt.Users, logger))
rootGroup := engine.Group(server.RootGroupRoute)
wGroup := engine.Group(server.WriteGroupRoute)
manageGroup := engine.Group(server.ManageGroupRoute)
initRouteAuth(opt, logger, rootGroup, wGroup, manageGroup)
rootGroup.GET(server.DefaultRoute, handler.NewDefaultHandlerFunc(logger))
initManageRoute(opt, logger, manageGroup, reporter)
hash, errHash := hashutil.NewHash(opt.ChecksumAlgorithm)
if errHash != nil {
return errHash
}
if source.IsDisk() || source.Is(core.RemoteDisk) {
rootGroup.StaticFS(server.SourceRoutePrefix, rate.NewHTTPDir(source.Path().Base(), opt.MaxTranRate.Bytes(), logger))
enableFileApi = true
if opt.EnablePushServer {
wGroup.POST(server.PushRoute, handler.NewPushHandlerFunc(logger, source, opt.EnableLogicallyDelete, hash))
}
}
if dest.IsDisk() {
rootGroup.StaticFS(server.DestRoutePrefix, rate.NewHTTPDir(dest.Path().Base(), opt.MaxTranRate.Bytes(), logger))
enableFileApi = true
} else if dest.Is(core.SFTP) {
sftpDir, err := sftp.NewDir(dest.RemotePath().Base(), dest.Addr(), dest.SSHConfig(), opt.Retry, opt.MaxTranRate.Bytes(), logger)
if err != nil {
return err
}
rootGroup.StaticFS(server.DestRoutePrefix, sftpDir)
enableFileApi = true
} else if dest.Is(core.MinIO) {
if len(opt.Users) == 0 {
return errors.New("a user is required for MinIO server")
}
user := opt.Users[0]
minioDir, err := minio.NewDir(dest.RemotePath().Bucket(), dest.Addr(), dest.Secure(), user.UserName(), user.Password(), opt.Retry, opt.MaxTranRate.Bytes(), logger)
if err != nil {
return err
}
rootGroup.StaticFS(server.DestRoutePrefix, minioDir)
enableFileApi = true
}
if enableFileApi {
rootGroup.GET(server.QueryRoute, handler.NewFileApiHandlerFunc(logger, http.Dir(source.Path().Base()), opt.ChunkSize.Bytes(), opt.CheckpointCount, hash))
}
return nil
}
func initRouteAuth(opt server.Option, logger *logger.Logger, rootGroup, wGroup, manageGroup *gin.RouterGroup) {
if len(opt.Users) > 0 {
rootGroup.Use(middleware.NewAuthHandlerFunc(logger, auth.ReadPerm))
wGroup.Use(middleware.NewAuthHandlerFunc(logger, auth.WritePerm))
manageGroup.Use(middleware.NewAuthHandlerFunc(logger, auth.ExecutePerm))
} else {
logger.Warn("the file server allows anonymous access, you should set some server users by the -users or -rand_user_count flag for security reasons")
}
}
func initManageRoute(opt server.Option, logger *logger.Logger, manageGroup *gin.RouterGroup, reporter report.Reporter) {
if opt.EnableManage {
if opt.ManagePrivate {
manageGroup.Use(middleware.NewPrivateAccessHandlerFunc(logger))
}
pprof.RouteRegister(manageGroup, server.PProfRoutePrefix)
manageGroup.GET(server.ManageConfigRoute, handler.NewManageHandlerFunc(logger, opt.Config))
if opt.EnableReport {
manageGroup.GET(server.ManageReportRoute, handler.NewReportHandlerFunc(logger, reporter))
reporter.Enable(true)
}
}
}
var defaultLogFormatter = func(param gin.LogFormatterParams) string {
var statusColor, methodColor, resetColor string
if param.IsOutputColor() {
statusColor = param.StatusCodeColor()
methodColor = param.MethodColor()
resetColor = param.ResetColor()
}
if param.Latency > time.Minute {
// Truncate in a golang < 1.8 safe way
param.Latency = param.Latency - param.Latency%time.Second
}
return fmt.Sprintf("[%v] [GIN] |%s %3d %s| %13v | %15s |%s %-7s %s %#v\n%s",
param.TimeStamp.Format("2006-01-02 15:04:05"),
statusColor, param.StatusCode, resetColor,
param.Latency,
param.ClientIP,
methodColor, param.Method, resetColor,
param.Path,
param.ErrorMessage,
)
}