-
Notifications
You must be signed in to change notification settings - Fork 8
/
embed.go
286 lines (241 loc) · 7.12 KB
/
embed.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
/*
* Tencent is pleased to support the open source community by making Blueking Container Service available.
* Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved.
* Licensed under the MIT License (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
* http://opensource.org/licenses/MIT
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific language governing permissions and
* limitations under the License.
*/
// Package bscp use embed ui
package bscp
import (
"embed"
"encoding/base64"
"encoding/json"
"fmt"
"html/template"
"io/fs"
"mime"
"net/http"
"path/filepath"
"strconv"
"strings"
"github.com/TencentBlueKing/bk-bscp/pkg/config"
)
// nolint:typecheck
//
//go:embed ui/dist
var frontendAssets embed.FS
const (
confFilePath = "ui/dist/config.json"
)
var (
allowCompressExtentions = map[string]bool{
".js": true,
".css": true,
}
)
// IndexConfig 前端配置
type IndexConfig struct {
RunEnv string
StaticURL string
IAMHost string
CMDBHost string
APIURL string
SiteURL string // vue 路由前缀
EnableBKNotice bool // 是否启用蓝鲸通知中心
Helper string
ProxyAPI bool
GrpcAddr string // feed-server grpc 地址
HttpAddr string // feed-server http 地址
BKSharedResBaseJSURL string // 规则是${bkSharedResUrl}/${目录名 aka app_code}/base.js
NodeManHost string
UserManHost string
}
// EmbedWebServer 前端 web server
type EmbedWebServer interface {
RenderIndexHandler(conf *IndexConfig) http.Handler
Render403Handler(conf *IndexConfig) http.Handler
FaviconHandler(w http.ResponseWriter, r *http.Request)
StaticFileHandler(prefix string) http.Handler
}
type gzipFileInfo struct {
contentType string
contentSize string
lastModified string
filePath string
}
// EmbedWeb ..
type EmbedWeb struct {
dist fs.FS
tpl *template.Template
root http.FileSystem
fsServer http.Handler
}
// NewEmbedWeb 初始化模版和fs
func NewEmbedWeb() *EmbedWeb {
// dist 路径
dist, err := fs.Sub(frontendAssets, "ui/dist")
if err != nil {
panic(err)
}
// 模版路径
tpl := template.Must(template.New("").ParseFS(frontendAssets, "ui/dist/*.html"))
root := http.FS(dist)
w := &EmbedWeb{
dist: dist,
tpl: tpl,
root: root,
fsServer: http.FileServer(root),
}
return w
}
// FaviconHandler favicon Handler
func (e *EmbedWeb) FaviconHandler(w http.ResponseWriter, r *http.Request) {
// 填写实际的 icon 路径
r.URL.Path = "/favicon.ico"
// 添加缓存
w.Header().Set("Content-Type", "image/x-icon")
w.Header().Set("Cache-Control", "max-age=86400, public")
e.fsServer.ServeHTTP(w, r)
}
// readConfigFile 读取前端配置文件
func readConfigFile() (map[string]string, error) {
data, err := frontendAssets.ReadFile(confFilePath)
if err != nil {
return nil, err
}
c := new(map[string]string)
if err := json.Unmarshal(data, &c); err != nil {
return nil, err
}
return *c, nil
}
// mergeConfig 合并默认和自定义配置
func mergeConfig() ([]byte, error) {
c, err := readConfigFile()
if err != nil {
return nil, err
}
for k, v := range config.G.Frontend.Docs {
c[k] = v
}
configBytes, err := json.Marshal(c)
if err != nil {
return nil, err
}
return configBytes, nil
}
// RenderIndexHandler vue html 模板渲染
func (e *EmbedWeb) RenderIndexHandler(conf *IndexConfig) http.Handler {
configBytes, err := mergeConfig()
if err != nil {
panic(fmt.Errorf("init bscp config err, %s", err))
}
bscpConfig := string(configBytes)
fn := func(w http.ResponseWriter, r *http.Request) {
tplData := map[string]interface{}{
"BK_STATIC_URL": conf.StaticURL,
"RUN_ENV": conf.RunEnv,
"BK_BCS_BSCP_API": conf.APIURL,
"BK_IAM_HOST": conf.IAMHost,
"BK_CC_HOST": conf.CMDBHost,
"BK_SHARED_RES_BASE_JS_URL": conf.BKSharedResBaseJSURL,
"BK_BSCP_CONFIG": bscpConfig,
"SITE_URL": conf.SiteURL,
"ENABLE_BK_NOTICE": conf.EnableBKNotice,
"HELPER": conf.Helper,
"GRPC_ADDR": conf.GrpcAddr,
"HTTP_ADDR": conf.HttpAddr,
"BK_NODE_HOST": conf.NodeManHost,
"USER_MAN_HOST": conf.UserManHost,
}
// 本地开发模式 / 代理请求
if conf.ProxyAPI {
tplData["BK_BCS_BSCP_API"] = "/bscp"
}
e.tpl.ExecuteTemplate(w, "index.html", tplData) //nolint
}
return http.HandlerFunc(fn)
}
// get403Msg base64 decode msg
func get403Msg(r *http.Request) string {
rawMsg := r.URL.Query().Get("msg")
if rawMsg == "" {
return ""
}
b, err := base64.StdEncoding.DecodeString(rawMsg)
if err != nil {
return ""
}
return string(b)
}
// Render403Handler 403.html 页面
func (e *EmbedWeb) Render403Handler(conf *IndexConfig) http.Handler {
fn := func(w http.ResponseWriter, r *http.Request) {
tplData := map[string]string{
"MSG": get403Msg(r),
"BK_STATIC_URL": conf.StaticURL,
}
e.tpl.ExecuteTemplate(w, "403.html", tplData) //nolint
}
return http.HandlerFunc(fn)
}
func (e *EmbedWeb) shouldCompress(r *http.Request) (bool, *gzipFileInfo) {
// 必须包含 gzip 编码
if !strings.Contains(r.Header.Get("Accept-Encoding"), "gzip") {
return false, nil
}
// 其他不支持的场景
if strings.Contains(r.Header.Get("Connection"), "Upgrade") ||
strings.Contains(r.Header.Get("Accept"), "text/event-stream") {
return false, nil
}
upath := r.URL.Path
fileExt := filepath.Ext(upath)
if ok, exist := allowCompressExtentions[fileExt]; !exist || !ok {
return false, nil
}
ctype := mime.TypeByExtension(fileExt)
if ctype == "" {
return false, nil
}
filePath := upath + ".gz"
gzipFile, err := e.root.Open(filePath)
if err != nil {
return false, nil
}
fileInfo, err := gzipFile.Stat()
if err != nil {
return false, nil
}
info := &gzipFileInfo{
filePath: filePath,
contentType: ctype,
contentSize: strconv.FormatInt(fileInfo.Size(), 10),
lastModified: fileInfo.ModTime().Format(http.TimeFormat),
}
return true, info
}
// StaticFileHandler 静态文件处理函数
func (e *EmbedWeb) StaticFileHandler(prefix string) http.Handler {
fn := func(w http.ResponseWriter, r *http.Request) {
if ok, fileInfo := e.shouldCompress(r); ok {
r.URL.Path = fileInfo.filePath
w.Header().Add("Vary", "Accept-Encoding")
w.Header().Set("Content-Encoding", "gzip")
w.Header().Set("Content-Length", fileInfo.contentSize)
w.Header().Set("Content-Type", fileInfo.contentType)
// 添加缓存
w.Header().Set("Cache-Control", "max-age=86400, public")
// issue https://github.com/golang/go/issues/44854
// w.Header().Set("Last-Modified", fileInfo.lastModified)
w.Header().Del("Transfer-Encoding")
}
e.fsServer.ServeHTTP(w, r)
}
return http.StripPrefix(prefix, http.HandlerFunc(fn))
}