siyuan/kernel/filesys/tree.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 filesys

import (
	"bytes"
	"encoding/json"
	"errors"
	"fmt"
	"os"
	"path/filepath"
	"strings"
	"time"

	"github.com/88250/lute"
	"github.com/88250/lute/parse"
	"github.com/88250/lute/render"
	"github.com/siyuan-note/filelock"
	"github.com/siyuan-note/logging"
	"github.com/siyuan-note/siyuan/kernel/cache"
	"github.com/siyuan-note/siyuan/kernel/treenode"
	"github.com/siyuan-note/siyuan/kernel/util"
)

func LoadTree(boxID, p string, luteEngine *lute.Lute) (ret *parse.Tree, err error) {
	filePath := filepath.Join(util.DataDir, boxID, p)
	data, err := filelock.ReadFile(filePath)
	if nil != err {
		return
	}
	ret = parseJSON2Tree(boxID, p, data, luteEngine)
	if nil == ret {
		ret = recoverParseJSON2Tree(boxID, p, filePath, luteEngine)
		if nil == ret {
			return nil, errors.New("parse tree failed")
		}
	}
	ret.Path = p
	ret.Root.Path = p

	parts := strings.Split(p, "/")
	parts = parts[1 : len(parts)-1] // 去掉开头的斜杆和结尾的自己
	if 1 > len(parts) {
		ret.HPath = "/" + ret.Root.IALAttr("title")
		ret.Hash = treenode.NodeHash(ret.Root, ret, luteEngine)
		return
	}

	// 构造 HPath
	hPathBuilder := bytes.Buffer{}
	hPathBuilder.WriteString("/")
	for i, _ := range parts {
		var parentAbsPath string
		if 0 < i {
			parentAbsPath = strings.Join(parts[:i+1], "/")
		} else {
			parentAbsPath = parts[0]
		}
		parentAbsPath += ".sy"
		parentPath := parentAbsPath
		parentAbsPath = filepath.Join(util.DataDir, boxID, parentAbsPath)
		parentData, readErr := filelock.ReadFile(parentAbsPath)
		if nil != readErr {
			if os.IsNotExist(readErr) {
				parentTree := treenode.NewTree(boxID, parentPath, hPathBuilder.String()+"Untitled", "Untitled")
				if writeErr := WriteTree(parentTree); nil != writeErr {
					logging.LogErrorf("rebuild parent tree [%s] failed: %s", parentAbsPath, writeErr)
				} else {
					logging.LogInfof("rebuilt parent tree [%s]", parentAbsPath)
				}
			} else {
				logging.LogWarnf("read parent tree data [%s] failed: %s", parentAbsPath, readErr)
			}
			hPathBuilder.WriteString("Untitled/")
			continue
		}
		parentTree, parseErr := parse.ParseJSONWithoutFix(parentData, luteEngine.ParseOptions)
		if nil != parseErr {
			logging.LogWarnf("parse parent tree [%s] failed: %s", parentAbsPath, parseErr)
			hPathBuilder.WriteString("Untitled/")
			continue
		}
		hPathBuilder.WriteString(parentTree.Root.IALAttr("title"))
		hPathBuilder.WriteString("/")
	}
	hPathBuilder.WriteString(ret.Root.IALAttr("title"))
	ret.HPath = hPathBuilder.String()
	ret.Hash = treenode.NodeHash(ret.Root, ret, luteEngine)
	return
}

func WriteTreeWithoutChangeTime(tree *parse.Tree) (err error) {
	data, filePath, err := prepareWriteTree(tree)
	if nil != err {
		return
	}

	if err = filelock.WriteFileWithoutChangeTime(filePath, data); nil != err {
		if errors.Is(err, filelock.ErrUnableAccessFile) {
			return
		}

		msg := fmt.Sprintf("write data [%s] failed: %s", filePath, err)
		logging.LogErrorf(msg)
		return errors.New(msg)
	}

	afterWriteTree(tree)
	return
}

func WriteTree(tree *parse.Tree) (err error) {
	data, filePath, err := prepareWriteTree(tree)
	if nil != err {
		return
	}

	if err = filelock.WriteFile(filePath, data); nil != err {
		if errors.Is(err, filelock.ErrUnableAccessFile) {
			return
		}

		msg := fmt.Sprintf("write data [%s] failed: %s", filePath, err)
		logging.LogErrorf(msg)
		return errors.New(msg)
	}

	afterWriteTree(tree)
	return
}

func prepareWriteTree(tree *parse.Tree) (data []byte, filePath string, err error) {
	luteEngine := util.NewLute() // 不关注用户的自定义解析渲染选项

	if nil == tree.Root.FirstChild {
		newP := parse.NewParagraph()
		tree.Root.AppendChild(newP)
		tree.Root.SetIALAttr("updated", util.TimeFromID(newP.ID))
		treenode.ReindexBlockTree(tree)
	}

	filePath = filepath.Join(util.DataDir, tree.Box, tree.Path)
	if oldSpec := tree.Root.Spec; "" == oldSpec {
		parse.NestedInlines2FlattedSpans(tree)
		tree.Root.Spec = "1"
		logging.LogInfof("migrated tree [%s] from spec [%s] to [%s]", filePath, oldSpec, tree.Root.Spec)
	}
	renderer := render.NewJSONRenderer(tree, luteEngine.RenderOptions)
	data = renderer.Render()

	// .sy 文档数据使用格式化好的 JSON 而非单行 JSON
	buf := bytes.Buffer{}
	buf.Grow(4096)
	if err = json.Indent(&buf, data, "", "\t"); nil != err {
		return
	}
	data = buf.Bytes()

	if err = os.MkdirAll(filepath.Dir(filePath), 0755); nil != err {
		return
	}
	return
}

func afterWriteTree(tree *parse.Tree) {
	docIAL := parse.IAL2MapUnEsc(tree.Root.KramdownIAL)
	cache.PutDocIAL(tree.Path, docIAL)
}

func recoverParseJSON2Tree(boxID, p, filePath string, luteEngine *lute.Lute) (ret *parse.Tree) {
	// 尝试从临时文件恢复
	tmp := util.LatestTmpFile(filePath)
	if "" == tmp {
		logging.LogWarnf("recover tree [%s] not found tmp", filePath)
		return
	}

	stat, err := os.Stat(filePath)
	if nil != err {
		logging.LogErrorf("stat tmp [%s] failed: %s", tmp, err)
		return
	}

	if stat.ModTime().Before(time.Now().Add(-time.Hour * 24)) {
		logging.LogWarnf("tmp [%s] is too old, remove it", tmp)
		os.RemoveAll(tmp)
		return
	}

	data, err := filelock.ReadFile(tmp)
	if nil != err {
		logging.LogErrorf("recover tree read from tmp [%s] failed: %s", tmp, err)
		return
	}
	if err = filelock.WriteFile(filePath, data); nil != err {
		logging.LogErrorf("recover tree write [%s] from tmp [%s] failed: %s", filePath, tmp, err)
		return
	}

	ret = parseJSON2Tree(boxID, p, data, luteEngine)
	if nil == ret {
		logging.LogErrorf("recover tree from tmp [%s] parse failed, remove it", tmp)
		os.RemoveAll(tmp)
		return
	}
	logging.LogInfof("recovered tree [%s] from [%s]", filePath, tmp)
	os.RemoveAll(tmp)
	return
}

func parseJSON2Tree(boxID, p string, jsonData []byte, luteEngine *lute.Lute) (ret *parse.Tree) {
	var err error
	var needFix bool
	ret, needFix, err = parse.ParseJSON(jsonData, luteEngine.ParseOptions)
	if nil != err {
		logging.LogErrorf("parse json [%s] to tree failed: %s", boxID+p, err)
		return
	}

	ret.Box = boxID
	ret.Path = p

	filePath := filepath.Join(util.DataDir, ret.Box, ret.Path)
	if oldSpec := ret.Root.Spec; "" == oldSpec {
		parse.NestedInlines2FlattedSpans(ret)
		ret.Root.Spec = "1"
		needFix = true
		logging.LogInfof("migrated tree [%s] from spec [%s] to [%s]", filePath, oldSpec, ret.Root.Spec)
	}
	if needFix {
		renderer := render.NewJSONRenderer(ret, luteEngine.RenderOptions)
		output := renderer.Render()

		buf := bytes.Buffer{}
		buf.Grow(4096)
		if err = json.Indent(&buf, output, "", "\t"); nil != err {
			return
		}
		output = buf.Bytes()

		if err = os.MkdirAll(filepath.Dir(filePath), 0755); nil != err {
			return
		}
		if err = filelock.WriteFile(filePath, output); nil != err {
			msg := fmt.Sprintf("write data [%s] failed: %s", filePath, err)
			logging.LogErrorf(msg)
		}
	}
	return
}