siyuan/kernel/api/workspace.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 api

import (
	"errors"
	"fmt"
	"net/http"
	"os"
	"path/filepath"
	"strings"
	"time"
	"unicode/utf8"

	"github.com/88250/gulu"
	"github.com/gin-gonic/gin"
	"github.com/gofrs/flock"
	"github.com/siyuan-note/logging"
	"github.com/siyuan-note/siyuan/kernel/model"
	"github.com/siyuan-note/siyuan/kernel/util"
)

func createWorkspaceDir(c *gin.Context) {
	ret := gulu.Ret.NewResult()
	defer c.JSON(http.StatusOK, ret)

	arg, ok := util.JsonArg(c, ret)
	if !ok {
		return
	}

	absPath := arg["path"].(string)
	absPath = gulu.Str.RemoveInvisible(absPath)
	absPath = strings.TrimSpace(absPath)
	if isInvalidWorkspacePath(absPath) {
		ret.Code = -1
		ret.Msg = "This workspace name is not allowed, please use another name"
		return
	}

	if gulu.File.IsExist(absPath) {
		ret.Code = -1
		ret.Msg = model.Conf.Language(78)
		return
	}

	if err := os.MkdirAll(absPath, 0755); nil != err {
		ret.Code = -1
		ret.Msg = fmt.Sprintf("create workspace dir [%s] failed: %s", absPath, err)
		return
	}

	workspacePaths, err := readWorkspacePaths()
	if nil != err {
		ret.Code = -1
		ret.Msg = err.Error()
		return
	}

	workspacePaths = append(workspacePaths, absPath)

	if err = writeWorkspacePaths(workspacePaths); nil != err {
		ret.Code = -1
		ret.Msg = err.Error()
		return
	}
}

func removeWorkspaceDir(c *gin.Context) {
	ret := gulu.Ret.NewResult()
	defer c.JSON(http.StatusOK, ret)

	arg, ok := util.JsonArg(c, ret)
	if !ok {
		return
	}

	path := arg["path"].(string)

	workspacePaths, err := readWorkspacePaths()
	if nil != err {
		ret.Code = -1
		ret.Msg = err.Error()
		return
	}

	workspacePaths = gulu.Str.RemoveElem(workspacePaths, path)

	if err = writeWorkspacePaths(workspacePaths); nil != err {
		ret.Code = -1
		ret.Msg = err.Error()
		return
	}

	if util.WorkspaceDir == path && (util.ContainerIOS == util.Container || util.ContainerAndroid == util.Container) {
		os.Exit(util.ExitCodeOk)
	}
}

type Workspace struct {
	Path   string `json:"path"`
	Closed bool   `json:"closed"`
}

func getWorkspaces(c *gin.Context) {
	ret := gulu.Ret.NewResult()
	defer c.JSON(http.StatusOK, ret)

	workspacePaths, err := readWorkspacePaths()
	if nil != err {
		ret.Code = -1
		ret.Msg = err.Error()
		return
	}

	var workspaces []*Workspace
	for _, p := range workspacePaths {
		closed := false
		f := flock.New(filepath.Join(p, ".lock"))
		ok, _ := f.TryLock()
		if ok {
			closed = true
		}
		f.Unlock()

		workspaces = append(workspaces, &Workspace{Path: p, Closed: closed})
	}
	ret.Data = workspaces
}

func setWorkspaceDir(c *gin.Context) {
	ret := gulu.Ret.NewResult()
	defer c.JSON(http.StatusOK, ret)

	arg, ok := util.JsonArg(c, ret)
	if !ok {
		return
	}

	path := arg["path"].(string)
	if util.WorkspaceDir == path {
		ret.Code = -1
		ret.Msg = model.Conf.Language(78)
		ret.Data = map[string]interface{}{"closeTimeout": 3000}
		return
	}

	if gulu.OS.IsWindows() {
		installDir := filepath.Dir(util.WorkingDir)
		if strings.HasPrefix(path, installDir) {
			ret.Code = -1
			ret.Msg = model.Conf.Language(98)
			ret.Data = map[string]interface{}{"closeTimeout": 5000}
			return
		}
	}

	workspacePaths, err := readWorkspacePaths()
	if nil != err {
		ret.Code = -1
		ret.Msg = err.Error()
		return
	}

	workspacePaths = append(workspacePaths, path)
	workspacePaths = gulu.Str.RemoveDuplicatedElem(workspacePaths)
	workspacePaths = gulu.Str.RemoveElem(workspacePaths, path)
	workspacePaths = append(workspacePaths, path) // 切换的工作空间固定放在最后一个

	if err = writeWorkspacePaths(workspacePaths); nil != err {
		ret.Code = -1
		ret.Msg = err.Error()
		return
	}

	if util.ContainerAndroid == util.Container || util.ContainerIOS == util.Container {
		util.PushMsg(model.Conf.Language(42), 1000*15)
		time.Sleep(time.Second * 2)
		model.Close(false, 1)
	}
}

func readWorkspacePaths() (ret []string, err error) {
	ret = []string{}
	workspaceConf := filepath.Join(util.HomeDir, ".config", "siyuan", "workspace.json")
	data, err := os.ReadFile(workspaceConf)
	if nil != err {
		msg := fmt.Sprintf("read workspace conf [%s] failed: %s", workspaceConf, err)
		logging.LogErrorf(msg)
		err = errors.New(msg)
		return
	}

	if err = gulu.JSON.UnmarshalJSON(data, &ret); nil != err {
		msg := fmt.Sprintf("unmarshal workspace conf [%s] failed: %s", workspaceConf, err)
		logging.LogErrorf(msg)
		err = errors.New(msg)
		return
	}
	return
}

func writeWorkspacePaths(workspacePaths []string) (err error) {
	workspaceConf := filepath.Join(util.HomeDir, ".config", "siyuan", "workspace.json")
	data, err := gulu.JSON.MarshalJSON(workspacePaths)
	if nil != err {
		msg := fmt.Sprintf("marshal workspace conf [%s] failed: %s", workspaceConf, err)
		logging.LogErrorf(msg)
		err = errors.New(msg)
		return
	}

	if err = os.WriteFile(workspaceConf, data, 0644); nil != err {
		msg := fmt.Sprintf("write workspace conf [%s] failed: %s", workspaceConf, err)
		logging.LogErrorf(msg)
		err = errors.New(msg)
		return
	}
	return
}

func isInvalidWorkspacePath(absPath string) bool {
	if "" == absPath {
		return true
	}
	name := filepath.Base(absPath)
	if "" == name {
		return true
	}
	if strings.HasPrefix(name, ".") {
		return true
	}
	if !gulu.File.IsValidFilename(name) {
		return true
	}
	if 16 < utf8.RuneCountInString(name) {
		return true
	}
	return "siyuan" == name || "conf" == name || "home" == name || "data" == name || "temp" == name
}