485 lines
14 KiB
Go
485 lines
14 KiB
Go
// SiYuan - Build Your Eternal Digital Garden
|
||
// Copyright (c) 2020-present, b3log.org
|
||
//
|
||
// This program is free software: you can redistribute it and/or modify
|
||
// it under the terms of the GNU Affero General Public License as published by
|
||
// the Free Software Foundation, either version 3 of the License, or
|
||
// (at your option) any later version.
|
||
//
|
||
// This program is distributed in the hope that it will be useful,
|
||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
// GNU Affero General Public License for more details.
|
||
//
|
||
// You should have received a copy of the GNU Affero General Public License
|
||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
|
||
package server
|
||
|
||
import (
|
||
"bytes"
|
||
"fmt"
|
||
"html/template"
|
||
"net"
|
||
"net/http"
|
||
"net/http/httputil"
|
||
"net/http/pprof"
|
||
"net/url"
|
||
"os"
|
||
"path"
|
||
"path/filepath"
|
||
"strings"
|
||
"time"
|
||
|
||
"github.com/88250/gulu"
|
||
"github.com/gin-contrib/gzip"
|
||
"github.com/gin-contrib/sessions"
|
||
"github.com/gin-contrib/sessions/cookie"
|
||
"github.com/gin-gonic/gin"
|
||
"github.com/mssola/user_agent"
|
||
"github.com/olahol/melody"
|
||
"github.com/siyuan-note/logging"
|
||
"github.com/siyuan-note/siyuan/kernel/api"
|
||
"github.com/siyuan-note/siyuan/kernel/cmd"
|
||
"github.com/siyuan-note/siyuan/kernel/model"
|
||
"github.com/siyuan-note/siyuan/kernel/util"
|
||
)
|
||
|
||
var cookieStore = cookie.NewStore([]byte("ATN51UlxVq1Gcvdf"))
|
||
|
||
func Serve(fastMode bool) {
|
||
gin.SetMode(gin.ReleaseMode)
|
||
ginServer := gin.New()
|
||
ginServer.MaxMultipartMemory = 1024 * 1024 * 32 // 插入较大的资源文件时内存占用较大 https://github.com/siyuan-note/siyuan/issues/5023
|
||
ginServer.Use(gin.Recovery())
|
||
ginServer.Use(corsMiddleware()) // 后端服务支持 CORS 预检请求验证 https://github.com/siyuan-note/siyuan/pull/5593
|
||
ginServer.Use(gzip.Gzip(gzip.DefaultCompression, gzip.WithExcludedExtensions([]string{".pdf", ".mp3", ".wav", ".ogg", ".mov", ".weba", ".mkv", ".mp4", ".webm"})))
|
||
|
||
cookieStore.Options(sessions.Options{
|
||
Path: "/",
|
||
Secure: util.SSL,
|
||
//MaxAge: 60 * 60 * 24 * 7, // 默认是 Session
|
||
HttpOnly: true,
|
||
})
|
||
ginServer.Use(sessions.Sessions("siyuan", cookieStore))
|
||
|
||
if "dev" == util.Mode {
|
||
serveDebug(ginServer)
|
||
}
|
||
|
||
serveAssets(ginServer)
|
||
serveAppearance(ginServer)
|
||
serveWebSocket(ginServer)
|
||
serveExport(ginServer)
|
||
serveWidgets(ginServer)
|
||
serveEmojis(ginServer)
|
||
serveTemplates(ginServer)
|
||
api.ServeAPI(ginServer)
|
||
|
||
if !fastMode && "prod" == util.Mode && util.ContainerStd == util.Container {
|
||
killRunningKernel()
|
||
}
|
||
|
||
var host string
|
||
if model.Conf.System.NetworkServe || util.ContainerDocker == util.Container {
|
||
host = "0.0.0.0"
|
||
} else {
|
||
host = "127.0.0.1"
|
||
}
|
||
|
||
ln, err := net.Listen("tcp", host+":"+util.ServerPort)
|
||
if nil != err {
|
||
if !fastMode {
|
||
logging.LogErrorf("boot kernel failed: %s", err)
|
||
os.Exit(util.ExitCodeUnavailablePort)
|
||
}
|
||
|
||
// fast 模式下启动失败则直接返回
|
||
return
|
||
}
|
||
|
||
_, port, err := net.SplitHostPort(ln.Addr().String())
|
||
if nil != err {
|
||
if !fastMode {
|
||
logging.LogErrorf("boot kernel failed: %s", err)
|
||
os.Exit(util.ExitCodeUnavailablePort)
|
||
}
|
||
}
|
||
util.ServerPort = port
|
||
|
||
pid := fmt.Sprintf("%d", os.Getpid())
|
||
if !fastMode {
|
||
rewritePortJSON(pid, port)
|
||
}
|
||
|
||
logging.LogInfof("kernel [pid=%s] is booting [%s]", pid, "http://"+util.LocalHost+":"+port)
|
||
util.HttpServing = true
|
||
|
||
go func() {
|
||
if util.FixedPort != port {
|
||
// 启动一个 6806 端口的反向代理服务器，这样浏览器扩展才能直接使用 127.0.0.1:6806，不用配置端口
|
||
serverURL, _ := url.Parse("http://" + host + ":" + port)
|
||
proxy := httputil.NewSingleHostReverseProxy(serverURL)
|
||
logging.LogInfof("reverse proxy server [%s] is booting", util.FixedPort)
|
||
if proxyErr := http.ListenAndServe(host+":"+util.FixedPort, proxy); nil != proxyErr {
|
||
logging.LogWarnf("boot reverse proxy server [%s] failed: %s", serverURL, proxyErr)
|
||
}
|
||
// 反代服务器启动失败不影响核心服务器启动
|
||
}
|
||
}()
|
||
|
||
if err = http.Serve(ln, ginServer); nil != err {
|
||
if !fastMode {
|
||
logging.LogErrorf("boot kernel failed: %s", err)
|
||
os.Exit(util.ExitCodeUnavailablePort)
|
||
}
|
||
}
|
||
}
|
||
|
||
func rewritePortJSON(pid, port string) {
|
||
portJSON := filepath.Join(util.HomeDir, ".config", "siyuan", "port.json")
|
||
pidPorts := map[string]string{}
|
||
var data []byte
|
||
var err error
|
||
|
||
if gulu.File.IsExist(portJSON) {
|
||
data, err = os.ReadFile(portJSON)
|
||
if nil != err {
|
||
logging.LogWarnf("read port.json failed: %s", err)
|
||
} else {
|
||
if err = gulu.JSON.UnmarshalJSON(data, &pidPorts); nil != err {
|
||
logging.LogWarnf("unmarshal port.json failed: %s", err)
|
||
}
|
||
}
|
||
}
|
||
|
||
pidPorts[pid] = port
|
||
if data, err = gulu.JSON.MarshalIndentJSON(pidPorts, "", " "); nil != err {
|
||
logging.LogWarnf("marshal port.json failed: %s", err)
|
||
} else {
|
||
if err = os.WriteFile(portJSON, data, 0644); nil != err {
|
||
logging.LogWarnf("write port.json failed: %s", err)
|
||
}
|
||
}
|
||
}
|
||
|
||
func serveExport(ginServer *gin.Engine) {
|
||
ginServer.Static("/export/", filepath.Join(util.TempDir, "export"))
|
||
}
|
||
|
||
func serveWidgets(ginServer *gin.Engine) {
|
||
ginServer.Static("/widgets/", filepath.Join(util.DataDir, "widgets"))
|
||
}
|
||
|
||
func serveEmojis(ginServer *gin.Engine) {
|
||
ginServer.Static("/emojis/", filepath.Join(util.DataDir, "emojis"))
|
||
}
|
||
|
||
func serveTemplates(ginServer *gin.Engine) {
|
||
ginServer.Static("/templates/", filepath.Join(util.DataDir, "templates"))
|
||
}
|
||
|
||
func serveAppearance(ginServer *gin.Engine) {
|
||
siyuan := ginServer.Group("", model.CheckAuth)
|
||
|
||
siyuan.Handle("GET", "/", func(c *gin.Context) {
|
||
userAgentHeader := c.GetHeader("User-Agent")
|
||
if strings.Contains(userAgentHeader, "Electron") {
|
||
c.Redirect(302, "/stage/build/app/?r="+gulu.Rand.String(7))
|
||
return
|
||
}
|
||
|
||
ua := user_agent.New(userAgentHeader)
|
||
if ua.Mobile() {
|
||
c.Redirect(302, "/stage/build/mobile/?r="+gulu.Rand.String(7))
|
||
return
|
||
}
|
||
|
||
c.Redirect(302, "/stage/build/desktop/?r="+gulu.Rand.String(7))
|
||
})
|
||
|
||
appearancePath := util.AppearancePath
|
||
if "dev" == util.Mode {
|
||
appearancePath = filepath.Join(util.WorkingDir, "appearance")
|
||
}
|
||
siyuan.GET("/appearance/*filepath", func(c *gin.Context) {
|
||
filePath := filepath.Join(appearancePath, strings.TrimPrefix(c.Request.URL.Path, "/appearance/"))
|
||
if strings.HasSuffix(c.Request.URL.Path, "/theme.js") {
|
||
if !gulu.File.IsExist(filePath) {
|
||
// 主题 js 不存在时生成空内容返回
|
||
c.Data(200, "application/x-javascript", nil)
|
||
return
|
||
}
|
||
} else if strings.Contains(c.Request.URL.Path, "/langs/") && strings.HasSuffix(c.Request.URL.Path, ".json") {
|
||
lang := path.Base(c.Request.URL.Path)
|
||
lang = strings.TrimSuffix(lang, ".json")
|
||
if "zh_CN" != lang && "en_US" != lang {
|
||
// 多语言配置缺失项使用对应英文配置项补齐 https://github.com/siyuan-note/siyuan/issues/5322
|
||
|
||
enUSFilePath := filepath.Join(appearancePath, "langs", "en_US.json")
|
||
enUSData, err := os.ReadFile(enUSFilePath)
|
||
if nil != err {
|
||
logging.LogFatalf("read en_US.json [%s] failed: %s", enUSFilePath, err)
|
||
return
|
||
}
|
||
enUSMap := map[string]interface{}{}
|
||
if err = gulu.JSON.UnmarshalJSON(enUSData, &enUSMap); nil != err {
|
||
logging.LogFatalf("unmarshal en_US.json [%s] failed: %s", enUSFilePath, err)
|
||
return
|
||
}
|
||
|
||
for {
|
||
data, err := os.ReadFile(filePath)
|
||
if nil != err {
|
||
c.JSON(200, enUSMap)
|
||
return
|
||
}
|
||
|
||
langMap := map[string]interface{}{}
|
||
if err = gulu.JSON.UnmarshalJSON(data, &langMap); nil != err {
|
||
logging.LogErrorf("unmarshal json [%s] failed: %s", filePath, err)
|
||
c.JSON(200, enUSMap)
|
||
return
|
||
}
|
||
|
||
for enUSDataKey, enUSDataValue := range enUSMap {
|
||
if _, ok := langMap[enUSDataKey]; !ok {
|
||
langMap[enUSDataKey] = enUSDataValue
|
||
}
|
||
}
|
||
c.JSON(200, langMap)
|
||
return
|
||
}
|
||
}
|
||
}
|
||
|
||
c.File(filePath)
|
||
})
|
||
|
||
siyuan.Static("/stage/", filepath.Join(util.WorkingDir, "stage"))
|
||
siyuan.StaticFile("favicon.ico", filepath.Join(util.WorkingDir, "stage", "icon.png"))
|
||
|
||
siyuan.GET("/check-auth", serveCheckAuth)
|
||
}
|
||
|
||
func serveCheckAuth(c *gin.Context) {
|
||
data, err := os.ReadFile(filepath.Join(util.WorkingDir, "stage/auth.html"))
|
||
if nil != err {
|
||
logging.LogErrorf("load auth page failed: %s", err)
|
||
c.Status(500)
|
||
return
|
||
}
|
||
|
||
tpl, err := template.New("auth").Parse(string(data))
|
||
if nil != err {
|
||
logging.LogErrorf("parse auth page failed: %s", err)
|
||
c.Status(500)
|
||
return
|
||
}
|
||
|
||
model := map[string]interface{}{
|
||
"l0": model.Conf.Language(173),
|
||
"l1": model.Conf.Language(174),
|
||
"l2": template.HTML(model.Conf.Language(172)),
|
||
"l3": model.Conf.Language(175),
|
||
"l4": model.Conf.Language(176),
|
||
"l5": model.Conf.Language(177),
|
||
"l6": model.Conf.Language(178),
|
||
"appearanceMode": model.Conf.Appearance.Mode,
|
||
"appearanceModeOS": model.Conf.Appearance.ModeOS,
|
||
}
|
||
buf := &bytes.Buffer{}
|
||
if err = tpl.Execute(buf, model); nil != err {
|
||
logging.LogErrorf("execute auth page failed: %s", err)
|
||
c.Status(500)
|
||
return
|
||
}
|
||
data = buf.Bytes()
|
||
c.Data(http.StatusOK, "text/html; charset=utf-8", data)
|
||
}
|
||
|
||
func serveAssets(ginServer *gin.Engine) {
|
||
ginServer.POST("/upload", model.CheckAuth, model.Upload)
|
||
|
||
ginServer.GET("/assets/*path", model.CheckAuth, func(context *gin.Context) {
|
||
requestPath := context.Param("path")
|
||
relativePath := path.Join("assets", requestPath)
|
||
p, err := model.GetAssetAbsPath(relativePath)
|
||
if nil != err {
|
||
context.Status(404)
|
||
return
|
||
}
|
||
http.ServeFile(context.Writer, context.Request, p)
|
||
return
|
||
})
|
||
ginServer.GET("/history/*path", model.CheckAuth, func(context *gin.Context) {
|
||
p := filepath.Join(util.HistoryDir, context.Param("path"))
|
||
http.ServeFile(context.Writer, context.Request, p)
|
||
return
|
||
})
|
||
}
|
||
|
||
func serveDebug(ginServer *gin.Engine) {
|
||
ginServer.GET("/debug/pprof/", gin.WrapF(pprof.Index))
|
||
ginServer.GET("/debug/pprof/allocs", gin.WrapF(pprof.Index))
|
||
ginServer.GET("/debug/pprof/block", gin.WrapF(pprof.Index))
|
||
ginServer.GET("/debug/pprof/goroutine", gin.WrapF(pprof.Index))
|
||
ginServer.GET("/debug/pprof/heap", gin.WrapF(pprof.Index))
|
||
ginServer.GET("/debug/pprof/mutex", gin.WrapF(pprof.Index))
|
||
ginServer.GET("/debug/pprof/threadcreate", gin.WrapF(pprof.Index))
|
||
ginServer.GET("/debug/pprof/cmdline", gin.WrapF(pprof.Cmdline))
|
||
ginServer.GET("/debug/pprof/profile", gin.WrapF(pprof.Profile))
|
||
ginServer.GET("/debug/pprof/symbol", gin.WrapF(pprof.Symbol))
|
||
ginServer.GET("/debug/pprof/trace", gin.WrapF(pprof.Trace))
|
||
}
|
||
|
||
func serveWebSocket(ginServer *gin.Engine) {
|
||
util.WebSocketServer.Config.MaxMessageSize = 1024 * 1024 * 8
|
||
|
||
ginServer.GET("/ws", func(c *gin.Context) {
|
||
if err := util.WebSocketServer.HandleRequest(c.Writer, c.Request); nil != err {
|
||
logging.LogErrorf("handle command failed: %s", err)
|
||
}
|
||
})
|
||
|
||
util.WebSocketServer.HandlePong(func(session *melody.Session) {
|
||
//logging.LogInfof("pong")
|
||
})
|
||
|
||
util.WebSocketServer.HandleConnect(func(s *melody.Session) {
|
||
//logging.LogInfof("ws check auth for [%s]", s.Request.RequestURI)
|
||
authOk := true
|
||
|
||
if "" != model.Conf.AccessAuthCode {
|
||
session, err := cookieStore.Get(s.Request, "siyuan")
|
||
if nil != err {
|
||
authOk = false
|
||
logging.LogErrorf("get cookie failed: %s", err)
|
||
} else {
|
||
val := session.Values["data"]
|
||
if nil == val {
|
||
authOk = false
|
||
} else {
|
||
sess := map[string]interface{}{}
|
||
err = gulu.JSON.UnmarshalJSON([]byte(val.(string)), &sess)
|
||
if nil != err {
|
||
authOk = false
|
||
logging.LogErrorf("unmarshal cookie failed: %s", err)
|
||
} else {
|
||
authOk = sess["AccessAuthCode"].(string) == model.Conf.AccessAuthCode
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
if !authOk {
|
||
// 用于授权页保持连接，避免非常驻内存内核自动退出 https://github.com/siyuan-note/insider/issues/1099
|
||
authOk = strings.Contains(s.Request.RequestURI, "/ws?app=siyuan&id=auth")
|
||
}
|
||
|
||
if !authOk {
|
||
s.CloseWithMsg([]byte(" unauthenticated"))
|
||
//logging.LogWarnf("closed an unauthenticated session [%s]", util.GetRemoteAddr(s))
|
||
return
|
||
}
|
||
|
||
util.AddPushChan(s)
|
||
//sessionId, _ := s.Get("id")
|
||
//logging.LogInfof("ws [%s] connected", sessionId)
|
||
})
|
||
|
||
util.WebSocketServer.HandleDisconnect(func(s *melody.Session) {
|
||
util.RemovePushChan(s)
|
||
//sessionId, _ := s.Get("id")
|
||
//logging.LogInfof("ws [%s] disconnected", sessionId)
|
||
})
|
||
|
||
util.WebSocketServer.HandleError(func(s *melody.Session, err error) {
|
||
//sessionId, _ := s.Get("id")
|
||
//logging.LogDebugf("ws [%s] failed: %s", sessionId, err)
|
||
})
|
||
|
||
util.WebSocketServer.HandleClose(func(s *melody.Session, i int, str string) error {
|
||
//sessionId, _ := s.Get("id")
|
||
//logging.LogDebugf("ws [%s] closed: %v, %v", sessionId, i, str)
|
||
return nil
|
||
})
|
||
|
||
util.WebSocketServer.HandleMessage(func(s *melody.Session, msg []byte) {
|
||
start := time.Now()
|
||
logging.LogTracef("request [%s]", shortReqMsg(msg))
|
||
request := map[string]interface{}{}
|
||
if err := gulu.JSON.UnmarshalJSON(msg, &request); nil != err {
|
||
result := util.NewResult()
|
||
result.Code = -1
|
||
result.Msg = "Bad Request"
|
||
responseData, _ := gulu.JSON.MarshalJSON(result)
|
||
s.Write(responseData)
|
||
return
|
||
}
|
||
|
||
if _, ok := s.Get("app"); !ok {
|
||
result := util.NewResult()
|
||
result.Code = -1
|
||
result.Msg = "Bad Request"
|
||
s.Write(result.Bytes())
|
||
return
|
||
}
|
||
|
||
cmdStr := request["cmd"].(string)
|
||
cmdId := request["reqId"].(float64)
|
||
param := request["param"].(map[string]interface{})
|
||
command := cmd.NewCommand(cmdStr, cmdId, param, s)
|
||
if nil == command {
|
||
result := util.NewResult()
|
||
result.Code = -1
|
||
result.Msg = "can not find command [" + cmdStr + "]"
|
||
s.Write(result.Bytes())
|
||
return
|
||
}
|
||
if util.ReadOnly && !command.IsRead() {
|
||
result := util.NewResult()
|
||
result.Code = -1
|
||
result.Msg = model.Conf.Language(34)
|
||
s.Write(result.Bytes())
|
||
return
|
||
}
|
||
|
||
end := time.Now()
|
||
logging.LogTracef("parse cmd [%s] consumed [%d]ms", command.Name(), end.Sub(start).Milliseconds())
|
||
|
||
cmd.Exec(command)
|
||
})
|
||
}
|
||
|
||
func shortReqMsg(msg []byte) []byte {
|
||
s := gulu.Str.FromBytes(msg)
|
||
max := 128
|
||
if len(s) > max {
|
||
count := 0
|
||
for i := range s {
|
||
count++
|
||
if count > max {
|
||
return gulu.Str.ToBytes(s[:i] + "...")
|
||
}
|
||
}
|
||
}
|
||
return msg
|
||
}
|
||
|
||
func corsMiddleware() gin.HandlerFunc {
|
||
return func(c *gin.Context) {
|
||
|
||
c.Header("Access-Control-Allow-Origin", "*")
|
||
c.Header("Access-Control-Allow-Credentials", "true")
|
||
c.Header("Access-Control-Allow-Headers", "origin, Content-Length, Content-Type, Authorization")
|
||
c.Header("Access-Control-Allow-Methods", "GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS")
|
||
|
||
if c.Request.Method == "OPTIONS" {
|
||
c.AbortWithStatus(204)
|
||
return
|
||
}
|
||
|
||
c.Next()
|
||
}
|
||
}
|