An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作
TypeScript agentic-aiai-agentknowledge-baselocal-firstmarkdownmcpmindmapnote-takingself-hostedsiyuanworkspace
// SiYuan - https://github.com/siyuan-note/siyuan
// Copyright (c) 2020-present, b3log.org
// SPDX-License-Identifier: AGPL-3.0-or-later
package model
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"io/fs"
"math"
"os"
"path"
"path/filepath"
"sort"
"strconv"
"strings"
"time"
"github.com/88250/gulu"
"github.com/88250/lute"
"github.com/88250/lute/ast"
"github.com/88250/lute/parse"
"github.com/88250/lute/render"
"github.com/siyuan-note/dataparser"
"github.com/siyuan-note/eventbus"
"github.com/siyuan-note/filelock"
"github.com/siyuan-note/logging"
"github.com/siyuan-note/siyuan/kernel/av"
"github.com/siyuan-note/siyuan/kernel/cache"
"github.com/siyuan-note/siyuan/kernel/conf"
"github.com/siyuan-note/siyuan/kernel/search"
"github.com/siyuan-note/siyuan/kernel/sql"
"github.com/siyuan-note/siyuan/kernel/task"
"github.com/siyuan-note/siyuan/kernel/treenode"
"github.com/siyuan-note/siyuan/kernel/util"
)
var historyTicker = time.NewTicker(time.Minute * 10)
func AutoGenerateFileHistory() {
ChangeHistoryTick(Conf.Editor.Load().GenerateHistoryInterval)
for {
<-historyTicker.C
task.AppendTask(task.HistoryGenerateFile, GenerateFileHistory)
}
}
// GenerateFileHistoryForBox 对单个 box 生成文件历史。供加密笔记本关闭(锁定)前调用——
// 锁定后定时器(GenerateFileHistory)无法为加密笔记本生成历史(不在 GetOpenedBoxes 里)。
func GenerateFileHistoryForBox(box *Box) {
defer logging.Recover()
if 1 > Conf.Editor.Load().GenerateHistoryInterval {
return
}
box.generateDocHistory0()
}
func GenerateFileHistory() {
defer logging.Recover()
if 1 > Conf.Editor.Load().GenerateHistoryInterval {
return
}
FlushTxQueue()
// 生成文档历史
for _, box := range Conf.GetOpenedBoxes() {
// 加密笔记本也生成历史:密文 .sy 直接拷到历史目录,查看/回滚时按路径里的 boxID 解密
box.generateDocHistory0()
}
// 生成资源文件历史
generateAssetsHistory()
historyDir := util.HistoryDir
// 以下部分是老版本的历史数据,不再保留
for _, box := range Conf.GetBoxes() {
historyDir = filepath.Join(util.DataDir, box.ID, ".siyuan", "history")
os.RemoveAll(historyDir)
}
historyDir = filepath.Join(util.DataDir, "assets", ".siyuan", "history")
os.RemoveAll(historyDir)
historyDir = filepath.Join(util.DataDir, ".siyuan", "history")
os.RemoveAll(historyDir)
}
func ChangeHistoryTick(minutes int) {
if 0 >= minutes {
minutes = 3600
}
historyTicker.Reset(time.Minute * time.Duration(minutes))
}
func ClearWorkspaceHistory() (err error) {
notebookArchiveHistoryMu.Lock()
defer notebookArchiveHistoryMu.Unlock()
historyDir := util.HistoryDir
if gulu.File.IsDir(historyDir) {
if err = os.RemoveAll(historyDir); err != nil {
logging.LogErrorf("remove workspace history dir [%s] failed: %s", historyDir, err)
return
}
logging.LogInfof("removed workspace history dir [%s]", historyDir)
}
sql.InitHistoryDatabase(true)
// 以下部分是老版本的清理逻辑,暂时保留
notebooks, err := ListNotebooks()
if err != nil {
return
}
for _, notebook := range notebooks {
boxID := notebook.ID
historyDir := filepath.Join(util.DataDir, boxID, ".siyuan", "history")
if !gulu.File.IsDir(historyDir) {
continue
}
if err = os.RemoveAll(historyDir); err != nil {
logging.LogErrorf("remove notebook history dir [%s] failed: %s", historyDir, err)
return
}
logging.LogInfof("removed notebook history dir [%s]", historyDir)
}
historyDir = filepath.Join(util.DataDir, ".siyuan", "history")
if gulu.File.IsDir(historyDir) {
if err = os.RemoveAll(historyDir); err != nil {
logging.LogErrorf("remove data history dir [%s] failed: %s", historyDir, err)
return
}
logging.LogInfof("removed data history dir [%s]", historyDir)
}
historyDir = filepath.Join(util.DataDir, "assets", ".siyuan", "history")
if gulu.File.IsDir(historyDir) {
if err = os.RemoveAll(historyDir); err != nil {
logging.LogErrorf("remove assets history dir [%s] failed: %s", historyDir, err)
return
}
logging.LogInfof("removed assets history dir [%s]", historyDir)
}
return
}
func GetDocHistoryContent(historyPath, keyword string, highlight bool) (id, rootID, content string, isLargeDoc bool, err error) {
historyPath, err = validateHistoryPath(historyPath)
if err != nil {
return
}
data, err := filelock.ReadFile(historyPath)
if err != nil {
logging.LogErrorf("read file [%s] failed: %s", historyPath, err)
return
}
// 加密笔记本的历史是密文,按路径里的 boxID 解密后解析
relPath := strings.TrimPrefix(filepath.ToSlash(historyPath), filepath.ToSlash(util.HistoryDir))
relPath = strings.TrimPrefix(relPath, "/")
pathParts := strings.SplitN(relPath, "/", 3)
ciphertext := util.IsCiphertext(data)
if ciphertext {
if len(pathParts) < 3 || !ast.IsNodeIDPattern(pathParts[1]) {
err = errors.New("encrypted document history is missing notebook context")
return
}
histBoxID := pathParts[1]
if !IsEncryptedBox(histBoxID) {
err = fmt.Errorf("encrypted document history has no matching notebook [%s]", histBoxID)
return
}
HoldBoxReadLock(histBoxID)
defer ReleaseBoxReadLock(histBoxID)
dek, dekErr := GetDEKIfUnlocked(histBoxID)
if dekErr != nil {
err = errors.New(Conf.Language(314))
return
}
data, err = DecryptFile(histBoxID, pathParts[2], dek, data)
if err != nil {
logging.LogErrorf("decrypt history [%s] failed: %s", historyPath, err)
return
}
} else if len(pathParts) >= 2 && IsEncryptedBox(pathParts[1]) {
err = fmt.Errorf("encrypted notebook document history is plaintext [%s]", pathParts[1])
return
}
isLargeDoc = 1024*1024*1 <= len(data)
luteEngine := NewLute()
if err = treenode.CheckSpecJSON(data); nil != err {
return
}
historyTree, err := dataparser.ParseJSONWithoutFix(data, luteEngine.ParseOptions)
if err != nil {
logging.LogErrorf("parse tree from file [%s] failed: %s", historyPath, err)
return
}
if err = treenode.RefreshTableCellRichProjection(historyTree.Root); nil != err {
return
}
id = historyTree.Root.ID
rootID = historyTree.Root.ID
if ciphertext && rootID+".sy" != filepath.Base(historyPath) {
return "", "", "", false, errors.New("encrypted document history root ID does not match its filename")
}
if !isLargeDoc {
renderTree := &parse.Tree{Root: &ast.Node{Type: ast.NodeDocument}}
keyword = strings.Join(strings.Split(keyword, " "), search.TermSep)
keywords := search.SplitKeyword(keyword)
var unlinks []*ast.Node
ast.Walk(historyTree.Root, func(n *ast.Node, entering bool) ast.WalkStatus {
if !entering {
return ast.WalkContinue
}
// 数据历史浏览时忽略内容块折叠状态 https://github.com/siyuan-note/siyuan/issues/5778
n.RemoveIALAttr("heading-fold")
n.RemoveIALAttr("fold")
if highlight && 0 < len(keywords) {
if markReplaceSpan(n, &unlinks, keywords, search.MarkDataType, luteEngine) {
return ast.WalkContinue
}
}
return ast.WalkContinue
})
for _, unlink := range unlinks {
unlink.Unlink()
}
var appends []*ast.Node
for n := historyTree.Root.FirstChild; nil != n; n = n.Next {
appends = append(appends, n)
}
for _, n := range appends {
renderTree.Root.AppendChild(n)
}
historyTree = renderTree
}
// 禁止文档历史内容可编辑 https://github.com/siyuan-note/siyuan/issues/6580
luteEngine.RenderOptions.ProtyleContenteditable = false
if isLargeDoc {
util.PushMsg(Conf.Language(36), 5000)
formatRenderer := render.NewFormatRenderer(historyTree, luteEngine.RenderOptions, luteEngine.ParseOptions)
content = gulu.Str.FromBytes(formatRenderer.Render())
} else {
content = luteEngine.Tree2BlockDOM(historyTree, luteEngine.RenderOptions, luteEngine.ParseOptions)
}
return
}
func RollbackDocHistory(historyPath string) (err error) {
return rollbackDocHistory(historyPath, removeIndexRepairSourceIfUnchanged)
}
func rollbackDocHistory(historyPath string, removeOldDoc func(string, []byte) error) (err error) {
historyPath, err = validateHistoryPath(historyPath)
if err != nil {
return
}
FlushTxQueue()
relPath := strings.TrimPrefix(historyPath, util.HistoryDir)
relPath = strings.TrimPrefix(relPath, string(os.PathSeparator))
relPath = filepath.ToSlash(relPath)
parts := strings.SplitN(relPath, "/", 3)
if len(parts) < 3 {
logging.LogWarnf("invalid history path [%s]", historyPath)
return fmt.Errorf("history path is missing notebook context [%s]", historyPath)
}
boxID := parts[1]
origBoxID := boxID // 保留原始 boxID 用于解密(getRollbackBox 可能返回不同的 box)
encrypted := IsEncryptedBox(origBoxID)
if encrypted {
// 整个回滚持有操作租约,内部文件读写可独立获取读锁,锁定等待租约结束后再申请写锁。
if err = AcquireEncryptedBoxOperation(origBoxID); err != nil {
return
}
defer ReleaseEncryptedBoxOperation(origBoxID)
}
// 加密笔记本的历史回滚要求原笔记本已挂载:
// WriteTree 根据 tree.Box 判断是否加密落盘。若原笔记本未挂载导致
// getRollbackBox fallback 到普通 Rollback 笔记本,解密后的 .sy 将被 WriteTree
// 以明文落盘,违反"WriteTree auto-encrypts on write-back"的设计承诺。
if IsEncryptedBox(origBoxID) && nil == Conf.Box(origBoxID) {
logging.LogErrorf("rollback encrypted doc history requires notebook [%s] to be mounted", origBoxID)
err = errors.New(Conf.Language(314))
return
}
box, needResetTree, err := getRollbackBox(boxID)
if err != nil {
logging.LogErrorf("get rollback box [%s] failed: %s", boxID, err)
return
}
boxID = box.ID
// Serialize replacement and history invalidation with edit commits and undo/redo selection.
// Rollback notebook creation/mounting above may itself wait for transactions.
FlushTxQueue()
flushLock.Lock()
defer flushLock.Unlock()
srcPath := historyPath
var destPath, parentHPath string
rootID := util.GetTreeID(historyPath)
workingDoc := treenode.GetBlockTree(rootID)
if needResetTree || workingDoc != nil && (workingDoc.Type != "d" || workingDoc.BoxID != boxID) {
workingDoc = nil
}
destPath, parentHPath, err = getRollbackDockPath(boxID, historyPath, workingDoc)
if err != nil {
return
}
var avIDs []string
// 加密笔记本的历史是密文,loadTree 读到密文无法解析,需要先解密
srcData, srcReadErr := filelock.ReadFile(srcPath)
if srcReadErr != nil {
logging.LogErrorf("read history [%s] failed: %s", srcPath, srcReadErr)
return srcReadErr
}
ciphertext := util.IsCiphertext(srcData)
if ciphertext && !IsEncryptedBox(origBoxID) {
return fmt.Errorf("encrypted document history has no matching notebook [%s]", origBoxID)
}
if !ciphertext && IsEncryptedBox(origBoxID) {
return fmt.Errorf("encrypted notebook document history is plaintext [%s]", origBoxID)
}
if encrypted {
dek, dekErr := GetDEKIfUnlocked(origBoxID)
if dekErr != nil {
err = errors.New(Conf.Language(314))
return
}
var decErr error
// 历史路径格式:<historyDir>/<datePrefix>/<boxID>/<relativePath>
// 用原始 boxID 解密(getRollbackBox 可能创建了新 box,密文仍属于原加密 box)
filePath := parts[2]
srcData, decErr = DecryptFile(origBoxID, filePath, dek, srcData)
if decErr != nil {
logging.LogErrorf("decrypt history [%s] failed: %s", srcPath, decErr)
err = decErr
return
}
}
tree, parseErr := loadTreeByData0(srcData)
if parseErr != nil {
return fmt.Errorf("parse document history failed: %w", parseErr)
}
if tree == nil {
return errors.New("parse document history failed")
}
if encrypted && tree.Root.ID+".sy" != filepath.Base(historyPath) {
return errors.New("encrypted document history root ID does not match its filename")
}
boundRecovery := &Transaction{trees: map[string]*parse.Tree{}}
defer func() { boundRecovery.finishAttributeViewMutation(err != nil) }()
if nil != tree {
historyDir := filepath.Join(util.HistoryDir, parts[0])
avNodes := tree.Root.ChildrenByType(ast.NodeAttributeView)
for _, avNode := range avNodes {
srcAvPath := filepath.Join(historyDir, "storage", "av", avNode.AttributeViewID+".json")
// 加密笔记本的 AV 定义在笔记本级目录
destAvPath := filepath.Join(util.DataDir, "storage", "av", avNode.AttributeViewID+".json")
if IsEncryptedBox(boxID) {
// 历史目录里 AV 也可能在 boxID 子目录下
boxSrcAvPath := filepath.Join(historyDir, boxID, "storage", "av", avNode.AttributeViewID+".json")
if !gulu.File.IsExist(boxSrcAvPath) {
return fmt.Errorf("encrypted attribute view history is missing notebook context [%s]", avNode.AttributeViewID)
}
srcAvPath = boxSrcAvPath
destAvPath = filepath.Join(util.DataDir, boxID, "storage", "av", avNode.AttributeViewID+".json")
}
if gulu.File.IsExist(destAvPath) || gulu.File.IsExist(srcAvPath) {
avBoxID := ""
if encrypted {
avBoxID = boxID
}
if err = boundRecovery.restoreEmbeddedAttributeViewHistory(srcAvPath, avBoxID, avNode.AttributeViewID); err != nil {
return
}
}
avIDs = append(avIDs, avNode.AttributeViewID)
}
}
avIDs = gulu.Str.RemoveDuplicatedElem(avIDs)
tree.Box = boxID
tree.Path = filepath.ToSlash(strings.TrimPrefix(destPath, util.DataDir+string(os.PathSeparator)+boxID))
tree.HPath = parentHPath + "/" + treenode.ReadDocumentTitle(tree.Root).Text
if needResetTree {
resetTree(tree, "", true)
}
// 重置重复的块 ID https://github.com/siyuan-note/siyuan/issues/14358
nodes := map[string]*ast.Node{}
ast.Walk(tree.Root, func(n *ast.Node, entering bool) ast.WalkStatus {
if !entering || !n.IsBlock() {
return ast.WalkContinue
}
nodes[n.ID] = n
return ast.WalkContinue
})
var ids []string
for nodeID := range nodes {
ids = append(ids, nodeID)
}
idMap := treenode.ExistBlockTrees(ids)
var duplicatedIDs []string
for nodeID, exist := range idMap {
if exist {
// 被替换文档自身的块保留 ID,其他文档中的重复块才需要重新分配 ID。
if workingDoc != nil && workingDoc.Type == "d" {
bt := treenode.GetBlockTree(nodeID)
if bt != nil && bt.BoxID == boxID && bt.RootID == workingDoc.RootID {
continue
}
}
duplicatedIDs = append(duplicatedIDs, nodeID)
}
}
remappedIDs := map[string]string{}
for _, nodeID := range duplicatedIDs {
node := nodes[nodeID]
treenode.ResetNodeID(node)
remappedIDs[nodeID] = node.ID
if ast.NodeDocument == node.Type {
tree.ID = node.ID
tree.Path = tree.Path[:strings.LastIndex(tree.Path, "/")] + "/" + node.ID + ".sy"
}
}
remapDuplicateDocTreeReferences(tree.Root, remappedIDs)
// 仅重新索引该文档,不进行全量索引
// Reindex only the current document after rolling back the document https://github.com/siyuan-note/siyuan/issues/12320
// 写回成功后再替换索引和清理旧路径,失败时保留当前文档并向调用方返回错误。
if !needResetTree {
if err = boundRecovery.restoreBoundAttributeViewHistory(tree, filepath.Join(util.HistoryDir, parts[0])); err != nil {
return
}
}
if err = writeHistoryDocument(tree, workingDoc, removeOldDoc); err != nil {
return
}
invalidateDocumentHistory(tree.ID)
if workingDoc != nil && workingDoc.Type == "d" && workingDoc.BoxID == boxID && workingDoc.RootID != tree.ID {
invalidateDocumentHistory(workingDoc.RootID)
}
if workingDoc != nil {
treenode.RemoveBlockTreesByRootID(boxID, rootID)
}
sql.RemoveTreeQueue(boxID, rootID)
treenode.IndexBlockTree(tree)
sql.IndexTreeQueue(tree)
ReloadFiletree()
ReloadProtyle(tree.ID)
msg := fmt.Sprintf(Conf.Language(286), box.Name+tree.HPath)
util.PushMsg(msg, 7000)
IncSync()
// 刷新属性视图
for _, avID := range avIDs {
ReloadAttrView(avID)
}
restoredID := tree.ID
go func() {
sql.FlushQueue()
tree, _ = LoadTreeByBlockID(restoredID)
if nil == tree {
return
}
ReloadProtyle(restoredID)
// 刷新页签名
refText := getNodeRefText(tree.Root)
evt := util.NewCmdResult("rename", 0, util.PushModeBroadcast)
evt.Data = map[string]any{
"box": boxID,
"id": tree.Root.ID,
"path": tree.Path,
"title": treenode.ReadDocumentTitle(tree.Root).Text,
"empty": "" != tree.Root.IALAttr(NodeAttrTitleEmpty),
"refText": refText,
}
util.PushEvent(evt)
// 收集引用的定义块 ID
refDefIDs := getRefDefIDs(tree.Root)
// 推送定义节点引用计数
for _, defID := range refDefIDs {
task.AppendAsyncTaskWithDelay(task.SetDefRefCount, util.SQLFlushInterval, refreshRefCount, defID)
}
}()
return nil
}
// loadTreeByData0 从已解密的 JSON 字节数据加载 tree(不走文件系统,不涉及加解密)。
func loadTreeByData0(data []byte) (ret *parse.Tree, err error) {
if err = treenode.CheckSpecJSON(data); nil != err {
return
}
ret, err = dataparser.ParseJSONWithoutFix(data, util.NewLute().ParseOptions)
if nil == err {
err = treenode.RefreshTableCellRichProjection(ret.Root)
}
return
}
func getRollbackDockPath(boxID, historyPath string, workingDoc *treenode.BlockTree) (destPath, parentHPath string, err error) {
var parentID string
baseName := filepath.Base(historyPath)
var parentWorkingDoc *treenode.BlockTree
if nil != workingDoc {
parentID = path.Base(path.Dir(workingDoc.Path))
parentWorkingDoc = treenode.GetBlockTree(parentID)
} else {
parentID = filepath.Base(filepath.Dir(historyPath))
parentWorkingDoc = treenode.GetBlockTree(parentID)
}
if nil != parentWorkingDoc && !IsBoxDoc(boxID, parentWorkingDoc.RootID) {
// 父路径如果是文档,则恢复到父路径下
parentDir := strings.TrimSuffix(parentWorkingDoc.Path, ".sy")
parentDir = filepath.Join(util.DataDir, boxID, parentDir)
if err = os.MkdirAll(parentDir, 0755); err != nil {
return
}
destPath = filepath.Join(parentDir, baseName)
parentHPath = parentWorkingDoc.HPath
} else {
// 父路径如果不是文档,则恢复到笔记本根路径下
destPath = filepath.Join(util.DataDir, boxID, baseName)
}
return
}
func RollbackAssetsHistory(historyPath string) (err error) {
historyPath, err = validateHistoryPath(historyPath)
if err != nil {
return
}
from := historyPath
// 从路径提取 boxID 判断是否加密笔记本的资源
relPath := strings.TrimPrefix(filepath.ToSlash(historyPath), filepath.ToSlash(util.HistoryDir))
relPath = strings.TrimPrefix(relPath, "/")
pathParts := strings.SplitN(relPath, "/", 3)
filelock.Lock(from)
data, readErr := os.ReadFile(from)
filelock.Unlock(from)
if readErr != nil {
return readErr
}
encrypted := bytes.HasPrefix(data, encryptedAssetMagic)
if encrypted && (len(pathParts) < 3 || !ast.IsNodeIDPattern(pathParts[1]) || !IsEncryptedBox(pathParts[1])) {
return errors.New("encrypted asset history is missing valid notebook context")
}
var to string
if len(pathParts) >= 2 && IsEncryptedBox(pathParts[1]) {
if !encrypted {
return fmt.Errorf("encrypted notebook asset history is plaintext [%s]", pathParts[1])
}
// 加密笔记本的资源回滚到笔记本级 assets 目录
assetPath := pathParts[2]
if !strings.HasPrefix(assetPath, "assets/") || path.Clean(assetPath) != assetPath || strings.Contains(assetPath, "\\") {
return errors.New("invalid encrypted asset history path")
}
boxID := pathParts[1]
HoldBoxReadLock(boxID)
defer ReleaseBoxReadLock(boxID)
dek, dekErr := GetDEKIfUnlocked(boxID)
if dekErr != nil {
return errors.New(Conf.Language(314))
}
defer zeroAndClear(dek)
if _, err = DecryptAssetToWriter(boxID, filepath.Base(historyPath), dek, bytes.NewReader(data), io.Discard); err != nil {
return err
}
to = filepath.Join(util.DataDir, boxID, filepath.FromSlash(assetPath))
if err = validateEncryptedCleanupPath(util.DataDir, to); err != nil {
return err
}
if err = os.MkdirAll(filepath.Dir(to), 0755); err != nil {
return
}
} else {
to, err = ordinaryAssetHistoryDestination(pathParts)
if err != nil {
return
}
if err = os.MkdirAll(filepath.Dir(to), 0755); err != nil {
return
}
}
if encrypted {
err = writeEncryptedCleanupData(to, data)
} else {
err = filelock.CopyNewtimes(from, to)
}
if err != nil {
logging.LogErrorf("copy file [%s] to [%s] failed: %s", from, to, err)
return
}
IncSync()
util.PushMsg(Conf.Language(102), 3000)
return nil
}
// Ordinary history stores the original data-relative path after the snapshot
// directory, both for global assets and notebook/document-local cleanup history.
func ordinaryAssetHistoryDestination(parts []string) (string, error) {
if len(parts) != 3 {
return "", errors.New("invalid asset history path")
}
rel := parts[1] + "/" + parts[2]
if path.Clean(rel) != rel || strings.Contains(rel, "\\") || path.IsAbs(rel) {
return "", errors.New("invalid asset history path")
}
if parts[1] != "assets" {
if !ast.IsNodeIDPattern(parts[1]) || !strings.Contains("/"+parts[2], "/assets/") {
return "", errors.New("history path does not identify an asset")
}
if !filelock.IsExist(filepath.Join(util.DataDir, parts[1], ".siyuan", "conf.json")) {
return "", errors.New("asset history notebook is unavailable")
}
}
to := filepath.Join(util.DataDir, filepath.FromSlash(rel))
if err := validateEncryptedCleanupPath(util.DataDir, to); err != nil {
return "", err
}
return to, nil
}
// validateHistoryPath 校验历史路径是否位于工作区内且属于历史目录。
// 拒绝路径穿越攻击(..、绝对路径等)。返回规范化的绝对路径。
func validateHistoryPath(historyPath string) (string, error) {
p := filepath.Join(util.WorkspaceDir, historyPath)
if !gulu.File.IsSubPath(util.WorkspaceDir, p) {
return "", fmt.Errorf("history path [%s] is not in workspace", historyPath)
}
if !gulu.File.IsExist(p) {
return "", fmt.Errorf("history path [%s] not exist", historyPath)
}
rel, err := filepath.Rel(util.HistoryDir, p)
if err != nil || strings.HasPrefix(rel, "..") {
return "", fmt.Errorf("history path [%s] is not under history directory", historyPath)
}
return p, nil
}
// IsEncryptedHistoryPath 判断历史路径是否明确属于加密笔记本。
func IsEncryptedHistoryPath(absPath string) bool {
boxID := ExtractBoxIDFromHistoryPath(absPath)
if boxID == "" {
return false
}
if IsEncryptedBox(boxID) {
return true
}
rel, err := filepath.Rel(util.HistoryDir, absPath)
if err != nil {
return false
}
parts := strings.SplitN(filepath.ToSlash(rel), "/", 3)
if len(parts) < 2 || parts[1] != boxID {
return false
}
encrypted, err := isEncryptedHistoryBoxDir(filepath.Join(util.HistoryDir, parts[0], boxID))
if err != nil {
logging.LogErrorf("inspect encrypted history path [%s] failed: %s", absPath, err)
return true
}
return encrypted
}
func RollbackNotebookHistory(historyPath string) (err error) {
return rollbackNotebookHistory(historyPath, filelock.CopyNewtimes)
}
func rollbackNotebookHistory(historyPath string, copyHistory func(string, string) error) (err error) {
historyPath, err = validateHistoryPath(historyPath)
if err != nil {
return
}
boxID, err := validateNotebookHistoryPath(historyPath)
if err != nil {
return
}
if _, loaded := boxLock.LoadOrStore(boxID, true); loaded {
return errors.New(Conf.Language(239))
}
defer boxLock.Delete(boxID)
from := historyPath
to := filepath.Join(util.DataDir, boxID)
if filelock.IsExist(to) {
return errors.New(Conf.Language(371))
}
if err = checkDocumentAddressingCopy(from, boxID); err != nil {
return
}
if err = os.MkdirAll(util.DataDir, 0755); err != nil {
return
}
staging, err := os.MkdirTemp(util.DataDir, ".notebook-history-"+boxID+"-")
if err != nil {
return
}
defer func() { err = errors.Join(err, os.RemoveAll(staging)) }()
if err = copyHistory(from, staging); err != nil {
return
}
FlushTxQueue()
flushLock.Lock()
defer flushLock.Unlock()
boundRecovery := &Transaction{trees: map[string]*parse.Tree{}}
defer func() { boundRecovery.finishAttributeViewMutation(err != nil) }()
if err = boundRecovery.restoreNotebookAttributeViewHistory(from, boxID); err != nil {
return err
}
if _, statErr := os.Lstat(to); !os.IsNotExist(statErr) {
if statErr != nil {
return statErr
}
return errors.New(Conf.Language(371))
}
if err = os.Rename(staging, to); err != nil {
return
}
IncSync()
ReloadFiletree()
util.PushMsg(Conf.Language(372), 3000)
return nil
}
func validateNotebookHistoryPath(historyPath string) (boxID string, err error) {
rel, err := filepath.Rel(util.HistoryDir, historyPath)
if err != nil {
return "", fmt.Errorf("invalid notebook history path [%s]", historyPath)
}
parts := strings.Split(filepath.ToSlash(rel), "/")
if len(parts) != 2 || !strings.HasSuffix(parts[0], "-"+HistoryOpDelete) || !ast.IsNodeIDPattern(parts[1]) ||
!gulu.File.IsDir(historyPath) || !filelock.IsExist(filepath.Join(historyPath, ".siyuan", "conf.json")) {
return "", fmt.Errorf("invalid notebook history path [%s]", historyPath)
}
return parts[1], nil
}
func RollbackAttributeViewHistory(historyPath string) (err error) {
historyPath, err = validateHistoryPath(historyPath)
if err != nil {
return
}
// 验证目标文件必须是 AV 定义文件
if !strings.HasSuffix(historyPath, ".json") || !strings.Contains(filepath.ToSlash(historyPath), "/storage/av/") {
return fmt.Errorf("invalid AV history path [%s]", historyPath)
}
from := historyPath
// 从路径提取 boxID 判断是否加密笔记本的 AV
relPath := strings.TrimPrefix(filepath.ToSlash(historyPath), filepath.ToSlash(util.HistoryDir))
relPath = strings.TrimPrefix(relPath, "/")
pathParts := strings.SplitN(relPath, "/", 3)
data, readErr := filelock.ReadFile(from)
if readErr != nil {
return readErr
}
ciphertext := util.IsCiphertext(data)
if ciphertext && (len(pathParts) < 3 || !ast.IsNodeIDPattern(pathParts[1]) || !IsEncryptedBox(pathParts[1])) {
return errors.New("encrypted attribute view history is missing valid notebook context")
}
avID := strings.TrimSuffix(filepath.Base(historyPath), ".json")
avBoxID := ""
if len(pathParts) >= 2 && IsEncryptedBox(pathParts[1]) {
if !ciphertext {
return fmt.Errorf("encrypted notebook attribute view history is plaintext [%s]", pathParts[1])
}
avBoxID = pathParts[1]
if err = AcquireEncryptedBoxOperation(avBoxID); err != nil {
return
}
defer ReleaseEncryptedBoxOperation(avBoxID)
}
FlushTxQueue()
flushLock.Lock()
defer flushLock.Unlock()
recovery := &Transaction{trees: map[string]*parse.Tree{}}
defer func() { recovery.finishAttributeViewMutation(err != nil) }()
if err = recovery.restoreEmbeddedAttributeViewHistory(from, avBoxID, avID); err != nil {
return
}
queueExternalAttributeViewRefIndex(avID, avBoxID)
ReloadAttrView(avID)
IncSync()
util.PushMsg(Conf.Language(102), 3000)
return nil
}
type History struct {
HCreated string `json:"hCreated"`
Items []*HistoryItem `json:"items"`
}
type HistoryItem struct {
ID string `json:"id"`
Title string `json:"title"`
Path string `json:"path"`
Op string `json:"op"`
Notebook string `json:"notebook"` // 仅用于文档历史
}
const fileHistoryPageSize = 32
func FullTextSearchHistory(query, box, op string, typ, page int) (ret []string, pageCount, totalCount int) {
query = util.RemoveInvalid(query)
if "" != query && HistoryTypeDocID != typ {
query = stringQuery(query)
}
offset := (page - 1) * fileHistoryPageSize
table := "histories_fts_case_insensitive"
stmt := "SELECT DISTINCT created FROM " + table + " WHERE "
stmt += buildSearchHistoryQueryFilter(query, op, box, table, typ)
countStmt := strings.ReplaceAll(stmt, "SELECT DISTINCT created", "SELECT COUNT(DISTINCT created) AS total")
stmt += " ORDER BY created DESC LIMIT " + strconv.Itoa(fileHistoryPageSize) + " OFFSET " + strconv.Itoa(offset)
result, err := sql.QueryHistory(stmt)
if err != nil {
return
}
for _, row := range result {
ret = append(ret, row["created"].(string))
}
result, err = sql.QueryHistory(countStmt)
if err != nil {
return
}
if 1 > len(ret) {
ret = []string{}
}
if 1 > len(result) {
return
}
totalCount = int(result[0]["total"].(int64))
pageCount = int(math.Ceil(float64(totalCount) / float64(fileHistoryPageSize)))
return
}
func FullTextSearchHistoryItems(created, query, box, op string, typ int) (ret []*HistoryItem) {
query = util.RemoveInvalid(query)
if "" != query && HistoryTypeDocID != typ {
query = stringQuery(query)
}
table := "histories_fts_case_insensitive"
stmt := "SELECT * FROM " + table + " WHERE "
stmt += buildSearchHistoryQueryFilter(query, op, box, table, typ)
_, parseErr := strconv.Atoi(created)
if nil != parseErr {
ret = []*HistoryItem{}
return
}
stmt += " AND created = '" + created + "' ORDER BY created DESC LIMIT " + fmt.Sprintf("%d", fileHistoryPageSize)
sqlHistories := sql.SelectHistoriesRawStmt(stmt)
ret = fromSQLHistories(sqlHistories)
return
}
func buildSearchHistoryQueryFilter(query, op, box, table string, typ int) (stmt string) {
if "" != query {
switch typ {
case HistoryTypeDocName:
stmt += table + " MATCH '{title}:(" + query + ")'"
case HistoryTypeDoc:
stmt += table + " MATCH '{title content}:(" + query + ")'"
case HistoryTypeDocID:
// id 为等值比较,仅需按 SQL 字符串字面量转义单引号,不能使用面向 FTS 的 stringQuery
// https://github.com/siyuan-note/siyuan/security/advisories/GHSA-4hjx-84f6-gr7c
stmt += " id = '" + strings.ReplaceAll(query, "'", "''") + "'"
case HistoryTypeAsset:
stmt += table + " MATCH '{title content}:(" + query + ")'"
case HistoryTypeDatabase:
stmt += table + " MATCH '{content}:(" + query + ")'"
}
} else {
stmt += "1=1"
}
if op = strings.TrimSpace(op); op != "" && op != "all" {
if !gulu.Str.Contains(op, validOps) {
// 白名单外的 op 取值直接判为空结果,避免拼入 SQL
// https://github.com/siyuan-note/siyuan/security/advisories/GHSA-4hjx-84f6-gr7c
stmt += " AND 1=0"
} else {
stmt += " AND op = '" + op + "'"
}
}
if "%" != box && !ast.IsNodeIDPattern(box) {
box = "%"
}
if HistoryTypeDocName == typ || HistoryTypeDoc == typ || HistoryTypeDocID == typ {
if HistoryTypeDocName == typ || HistoryTypeDoc == typ {
stmt += " AND path LIKE '%/" + box + "/%' AND path LIKE '%.sy'"
}
} else if HistoryTypeAsset == typ {
stmt += " AND path LIKE '%/assets/%'"
} else if HistoryTypeDatabase == typ {
stmt += " AND path LIKE '%/storage/av/%'"
}
ago := time.Now().Add(-24 * time.Hour * time.Duration(Conf.Editor.Load().HistoryRetentionDays))
stmt += " AND CAST(created AS INTEGER) > " + fmt.Sprintf("%d", ago.Unix()) + ""
return
}
func GetNotebookHistory() (ret []*History, err error) {
ret = []*History{}
historyDir := util.HistoryDir
if !gulu.File.IsDir(historyDir) {
return
}
historyNotebookConfs, err := filepath.Glob(historyDir + "/*-delete/*/.siyuan/conf.json")
if err != nil {
logging.LogErrorf("read dir [%s] failed: %s", historyDir, err)
return
}
sort.Slice(historyNotebookConfs, func(i, j int) bool {
iTimeDir := filepath.Base(filepath.Dir(filepath.Dir(filepath.Dir(historyNotebookConfs[i]))))
jTimeDir := filepath.Base(filepath.Dir(filepath.Dir(filepath.Dir(historyNotebookConfs[j]))))
return iTimeDir > jTimeDir
})
for _, historyNotebookConf := range historyNotebookConfs {
timeDir := filepath.Base(filepath.Dir(filepath.Dir(filepath.Dir(historyNotebookConf))))
t := timeDir[:strings.LastIndex(timeDir, "-")]
if ti, parseErr := time.Parse("2006-01-02-150405", t); nil == parseErr {
t = ti.Format("2006-01-02 15:04:05")
}
var c conf.BoxConf
data, readErr := os.ReadFile(historyNotebookConf)
if nil != readErr {
logging.LogErrorf("read notebook conf [%s] failed: %s", historyNotebookConf, readErr)
continue
}
if err = json.Unmarshal(data, &c); err != nil {
logging.LogErrorf("parse notebook conf [%s] failed: %s", historyNotebookConf, err)
continue
}
ret = append(ret, &History{
HCreated: t,
Items: []*HistoryItem{{
Title: c.Name,
Path: filepath.ToSlash(strings.TrimPrefix(filepath.Dir(filepath.Dir(historyNotebookConf)), util.WorkspaceDir)),
Op: HistoryOpDelete,
}},
})
}
sort.Slice(ret, func(i, j int) bool {
return ret[i].HCreated > ret[j].HCreated
})
return
}
func generateAssetsHistory() {
assets := recentModifiedAssets()
if 1 > len(assets) {
return
}
if err := createAssetsHistory(assets); err != nil {
logging.LogErrorf("generate assets history failed: %s", err)
}
}
// CreateAssetHistory 为指定资源文件创建历史快照。
func CreateAssetHistory(assetPath string) (err error) {
assetPath = strings.TrimPrefix(filepath.ToSlash(filepath.Clean(filepath.FromSlash(assetPath))), "/")
if !strings.HasPrefix(assetPath, "assets/") {
return errors.New("asset path must be under assets")
}
assetAbsPath := filepath.Join(util.DataDir, filepath.FromSlash(assetPath))
assetsDir := filepath.Join(util.DataDir, "assets")
if !gulu.File.IsSubPath(assetsDir, assetAbsPath) {
return errors.New("asset path must be under assets")
}
info, statErr := os.Stat(assetAbsPath)
if statErr != nil {
return statErr
}
if info.IsDir() {
return errors.New("asset path must be a file")
}
return createAssetsHistory([]string{assetAbsPath})
}
func createAssetsHistory(assets []string) (err error) {
historyDir, err := getHistoryDir(HistoryOpUpdate)
if err != nil {
return fmt.Errorf("get history directory failed: %w", err)
}
for _, file := range assets {
assetRelPath, relErr := filepath.Rel(filepath.Join(util.DataDir, "assets"), file)
if relErr != nil || assetRelPath == "." || strings.HasPrefix(assetRelPath, ".."+string(filepath.Separator)) {
return errors.New("asset path must be under assets")
}
historyPath := filepath.Join(historyDir, "assets", assetRelPath)
if err = os.MkdirAll(filepath.Dir(historyPath), 0755); err != nil {
return fmt.Errorf("create history directory [%s] failed: %w", filepath.Dir(historyPath), err)
}
if copyErr := filelock.Copy(file, historyPath); copyErr != nil {
if os.IsNotExist(copyErr) {
continue
}
return fmt.Errorf("copy asset [%s] to [%s] failed: %w", file, historyPath, copyErr)
}
}
indexHistoryDir(filepath.Base(historyDir), util.NewLute())
return
}
func (box *Box) generateDocHistory0() {
files := box.recentModifiedDocs()
if 1 > len(files) {
return
}
historyDir, err := getHistoryDir(HistoryOpUpdate)
if err != nil {
logging.LogErrorf("get history dir failed: %s", err)
return
}
luteEngine := util.NewLute()
for _, file := range files {
if err = generateDocHistoryFile(box.ID, file, historyDir, luteEngine); err != nil {
logging.LogErrorf("generate history failed: %s", err)
return
}
}
indexHistoryDir(filepath.Base(historyDir), util.NewLute())
}
func generateDocHistoryFile(boxID, file, historyDir string, luteEngine *lute.Lute) error {
data, err := filelock.ReadFile(file)
if err != nil {
if os.IsNotExist(err) {
return nil
}
return fmt.Errorf("read document [%s] failed: %w", file, err)
}
return generateDocHistoryFromData(boxID, file, historyDir, data, luteEngine)
}
func generateDocHistoryFromData(boxID, file, historyDir string, data []byte, luteEngine *lute.Lute) error {
historyPath := filepath.Join(historyDir, boxID, strings.TrimPrefix(file, filepath.Join(util.DataDir, boxID)))
if err := os.MkdirAll(filepath.Dir(historyPath), 0755); err != nil {
return err
}
if err := gulu.File.WriteFileSafer(historyPath, data, 0644); err != nil {
return err
}
if !strings.HasSuffix(file, ".sy") {
return nil
}
tree, err := loadTreeByData(file, data, luteEngine)
if err != nil {
logging.LogErrorf("load tree [%s] failed: %s", file, err)
return nil
}
// loadTreeByData 不设置 tree.Box,这里补上:generateAvHistoryInTree 依据 tree.Box 判定是否
// 加密笔记本并据此选择历史目标路径(<boxID>/storage/av vs 全局 storage/av),
// tree.Box 为空会把加密笔记本的密文 AV 错误拷到全局历史路径
tree.Box = boxID
generateAvHistoryInTree(tree, historyDir)
return nil
}
func ClearOutdatedHistoryDirJob() {
clearOutdatedHistoryDir()
}
func clearOutdatedHistoryDir() {
notebookArchiveHistoryMu.Lock()
defer notebookArchiveHistoryMu.Unlock()
historyDir := util.HistoryDir
if !gulu.File.IsExist(historyDir) {
return
}
dirs, err := os.ReadDir(historyDir)
if err != nil {
logging.LogErrorf("clear history [%s] failed: %s", historyDir, err)
return
}
now := time.Now()
ago := now.Add(-24 * time.Hour * time.Duration(Conf.Editor.Load().HistoryRetentionDays)).Unix()
var removes []string
for _, dir := range dirs {
dirInfo, err := dir.Info()
if err != nil {
logging.LogErrorf("read history dir [%s] failed: %s", dir.Name(), err)
continue
}
if dirInfo.ModTime().Unix() < ago {
removes = append(removes, filepath.Join(historyDir, dir.Name()))
continue
}
if dirName := dirInfo.Name(); len(dirName) > len("2006-01-02-150405") {
if t, parseErr := time.Parse("2006-01-02-150405", dirName[:len("2006-01-02-150405")]); nil == parseErr {
if nameTime := t.Unix(); 0 != nameTime && nameTime < ago {
removes = append(removes, filepath.Join(historyDir, dir.Name()))
continue
}
}
}
}
for _, dir := range removes {
if err = os.RemoveAll(dir); err != nil {
logging.LogWarnf("remove history dir [%s] failed: %s", dir, err)
continue
}
//logging.LogInfof("auto removed history dir [%s]", dir)
}
// 清理历史库
sql.DeleteOutdatedHistories(ago)
}
var boxLatestHistoryTime = map[string]time.Time{}
func (box *Box) recentModifiedDocs() (ret []string) {
latestHistoryTime := boxLatestHistoryTime[box.ID]
filelock.Walk(filepath.Join(util.DataDir, box.ID), func(path string, d fs.DirEntry, err error) error {
if nil != err || nil == d {
return nil
}
if isSkipFile(d.Name()) {
if d.IsDir() {
return filepath.SkipDir
}
return nil
}
if d.IsDir() {
return nil
}
info, err := d.Info()
if nil != err {
return err
}
if info.ModTime().After(latestHistoryTime) {
ret = append(ret, path)
}
return nil
})
box.UpdateHistoryGenerated()
return
}
var assetsLatestHistoryTime = time.Now().Unix()
func recentModifiedAssets() (ret []string) {
// 只获取最近修改的资源
recentAssets := cache.FilterAssets(func(path string, asset *cache.Asset) bool {
if asset.Updated <= assetsLatestHistoryTime {
return false
}
absPath := filepath.Join(util.DataDir, asset.Path)
if filelock.IsHidden(absPath) {
return false
}
if util.IsOfficeTempFile(absPath) {
return false
}
return true
})
for _, asset := range recentAssets {
absPath := filepath.Join(util.DataDir, asset.Path)
ret = append(ret, absPath)
}
assetsLatestHistoryTime = time.Now().Unix()
return
}
const (
HistoryOpClean = "clean"
HistoryOpUpdate = "update"
HistoryOpDelete = "delete"
HistoryOpFormat = "format"
HistoryOpSync = "sync"
HistoryOpReplace = "replace"
HistoryOpOutline = "outline"
)
func generateOpTypeHistory(tree *parse.Tree, opType string) {
historyDir, err := getHistoryDir(opType)
if err != nil {
logging.LogErrorf("get history dir failed: %s", err)
return
}
generateTreeHistory(tree, historyDir)
generateAvHistoryInTree(tree, historyDir)
indexHistoryDir(filepath.Base(historyDir), util.NewLute())
}
func CreateDocHistory(id string) (err error) {
tree, err := LoadTreeByBlockID(id)
if err != nil {
return
}
generateOpTypeHistory(tree, HistoryOpUpdate)
return
}
func generateTreeHistory(tree *parse.Tree, historyDir string) {
// 加密笔记本的历史直接拷密文 .sy,查看/回滚时按路径里的 boxID 解密
historyPath := filepath.Join(historyDir, tree.Box, tree.Path)
var err error
if err = os.MkdirAll(filepath.Dir(historyPath), 0755); err != nil {
logging.LogErrorf("generate history failed: %s", err)
return
}
var data []byte
if data, err = filelock.ReadFile(filepath.Join(util.DataDir, tree.Box, tree.Path)); err != nil {
logging.LogErrorf("generate history failed: %s", err)
return
}
if err = gulu.File.WriteFileSafer(historyPath, data, 0644); err != nil {
logging.LogErrorf("generate history failed: %s", err)
return
}
}
func generateAvHistoryInTree(tree *parse.Tree, historyDir string) {
avNodes := tree.Root.ChildrenByType(ast.NodeAttributeView)
for _, avNode := range avNodes {
// 用 FindAttributeViewPath 解析 AV 定义的真实路径(自动路由全局/加密笔记本笔记本级)
srcAvPath, _ := av.FindAttributeViewPath(avNode.AttributeViewID)
if srcAvPath == "" {
continue
}
// 普通笔记本保持原路径 historyDir/storage/av/;加密笔记本加 boxID 前缀(与文档历史
// 结构一致),让 indexHistoryDir 能从路径反查 boxID 判断是否加密
destAvPath := filepath.Join(historyDir, "storage", "av", avNode.AttributeViewID+".json")
if IsEncryptedBox(tree.Box) {
destAvPath = filepath.Join(historyDir, tree.Box, "storage", "av", avNode.AttributeViewID+".json")
}
if copyErr := filelock.Copy(srcAvPath, destAvPath); nil != copyErr {
logging.LogErrorf("copy av [%s] failed: %s", srcAvPath, copyErr)
}
}
}
func getHistoryDir(suffix string) (ret string, err error) {
ret = filepath.Join(util.HistoryDir, time.Now().Format("2006-01-02-150405")+"-"+suffix)
if err = os.MkdirAll(ret, 0755); err != nil {
logging.LogErrorf("make history dir failed: %s", err)
return
}
return
}
func ReindexHistory() {
task.AppendTask(task.HistoryDatabaseIndexFull, fullReindexHistory)
}
func fullReindexHistory() {
notebookArchiveHistoryMu.Lock()
defer notebookArchiveHistoryMu.Unlock()
historyDirs, err := os.ReadDir(util.HistoryDir)
if err != nil {
logging.LogErrorf("read history dir [%s] failed: %s", util.HistoryDir, err)
return
}
util.PushMsg(Conf.Language(192), 7*1000)
sql.InitHistoryDatabase(true)
lutEngine := util.NewLute()
for _, historyDir := range historyDirs {
if !historyDir.IsDir() {
continue
}
name := historyDir.Name()
indexHistoryDir(name, lutEngine)
}
}
var validOps = []string{HistoryOpClean, HistoryOpUpdate, HistoryOpDelete, HistoryOpFormat, HistoryOpSync, HistoryOpReplace, HistoryOpOutline}
const (
HistoryTypeDocName = 0 // Search docs by doc name
HistoryTypeDoc = 1 // Search docs by doc name and content
HistoryTypeAsset = 2 // Search assets
HistoryTypeDocID = 3 // Search docs by doc id
HistoryTypeDatabase = 4 // Search databases by database id
)
func indexHistoryDir(name string, luteEngine *lute.Lute) {
defer logging.Recover()
op := name[strings.LastIndex(name, "-")+1:]
if !gulu.Str.Contains(op, validOps) {
logging.LogWarnf("invalid history op [%s]", op)
return
}
t := name[:strings.LastIndex(name, "-")]
tt, parseErr := time.ParseInLocation("2006-01-02-150405", t, time.Local)
if nil != parseErr {
logging.LogWarnf("parse history dir time [%s] failed: %s", t, parseErr)
return
}
created := fmt.Sprintf("%d", tt.Unix())
entryPath := filepath.Join(util.HistoryDir, name)
var docs, assets, databases []string
filelock.Walk(entryPath, func(path string, d fs.DirEntry, err error) error {
if strings.HasSuffix(d.Name(), ".sy") {
docs = append(docs, path)
} else if strings.Contains(path, "assets"+string(os.PathSeparator)) {
assets = append(assets, path)
} else if strings.Contains(path, "storage"+string(os.PathSeparator)+"av"+string(os.PathSeparator)) {
databases = append(databases, path)
}
return nil
})
var histories []*sql.History
encryptedHistoryBoxes := map[string]bool{}
for _, doc := range docs {
relDoc := strings.TrimPrefix(doc, entryPath+string(os.PathSeparator))
relDoc = filepath.ToSlash(relDoc)
docParts := strings.SplitN(relDoc, "/", 2)
histBoxID := ""
if len(docParts) >= 1 {
histBoxID = docParts[0]
}
p := strings.TrimPrefix(doc, util.HistoryDir)
p = filepath.ToSlash(p[1:])
isEncrypted := IsEncryptedBox(histBoxID)
if histBoxID != "" && !isEncrypted {
if cached, ok := encryptedHistoryBoxes[histBoxID]; ok {
isEncrypted = cached
} else {
boxConfData, readErr := os.ReadFile(filepath.Join(entryPath, histBoxID, ".siyuan", "conf.json"))
if readErr == nil {
boxConf := &conf.BoxConf{}
if json.Unmarshal(boxConfData, boxConf) == nil {
isEncrypted = boxConf.Encrypted
}
}
encryptedHistoryBoxes[histBoxID] = isEncrypted
}
}
if isEncrypted {
// 加密笔记本:content 留空,只存路径用于文件列表展示
docID := strings.TrimSuffix(filepath.Base(doc), ".sy")
histories = append(histories, &sql.History{
ID: docID,
Type: HistoryTypeDoc,
Op: op,
Title: docID,
Content: "",
Path: p,
Created: created,
})
continue
}
tree, loadErr := loadTree(doc, luteEngine)
if nil != loadErr {
logging.LogErrorf("load tree [%s] failed: %s", doc, loadErr)
continue
}
if nil == tree {
continue
}
title := treenode.ReadDocumentTitle(tree.Root).Text
if "" == title {
title = Conf.language(16)
}
content := tree.Root.Content()
histories = append(histories, &sql.History{
ID: tree.Root.ID,
Type: HistoryTypeDoc,
Op: op,
Title: title,
Content: content,
Path: p,
Created: created,
})
}
for _, asset := range assets {
p := strings.TrimPrefix(asset, util.HistoryDir)
p = filepath.ToSlash(p[1:])
_, id := util.LastID(p)
if !ast.IsNodeIDPattern(id) {
id = ""
}
histories = append(histories, &sql.History{
ID: id,
Type: HistoryTypeAsset,
Op: op,
Title: filepath.Base(asset),
Path: p,
Created: created,
})
}
for _, database := range databases {
id := filepath.Base(database)
id = strings.TrimSuffix(id, ".json")
if !ast.IsNodeIDPattern(id) {
continue
}
p := strings.TrimPrefix(database, util.HistoryDir)
p = filepath.ToSlash(p[1:])
// 加密笔记本的 AV 历史不向全局历史索引写入内容。
relDb := strings.TrimPrefix(database, entryPath+string(os.PathSeparator))
relDb = filepath.ToSlash(relDb)
dbParts := strings.SplitN(relDb, "/", 2)
dbBoxID := ""
if len(dbParts) >= 1 {
dbBoxID = dbParts[0]
}
var content string
if dbBoxID != "" && IsEncryptedBox(dbBoxID) {
content = ""
} else {
content = av.GetAttributeViewContentByPath(database)
}
histories = append(histories, &sql.History{
ID: id,
Type: HistoryTypeDatabase,
Op: op,
Title: id,
Content: content,
Path: p,
Created: created,
})
}
sql.IndexHistoriesQueue(histories)
}
func fromSQLHistories(sqlHistories []*sql.History) (ret []*HistoryItem) {
if 1 > len(sqlHistories) {
ret = []*HistoryItem{}
return
}
for _, sqlHistory := range sqlHistories {
item := &HistoryItem{
ID: sqlHistory.ID,
Title: sqlHistory.Title,
Path: filepath.ToSlash(strings.TrimPrefix(filepath.Join(util.HistoryDir, sqlHistory.Path), util.WorkspaceDir)),
Op: sqlHistory.Op,
}
if HistoryTypeAsset != sqlHistory.Type {
parts := strings.Split(sqlHistory.Path, "/")
if 2 <= len(parts) {
item.Notebook = parts[1]
} else {
logging.LogWarnf("invalid doc history path [%s]", item.Path)
}
}
ret = append(ret, item)
}
return
}
func init() {
subscribeSQLHistoryEvents()
}
func subscribeSQLHistoryEvents() {
eventbus.Subscribe(util.EvtSQLHistoryRebuild, func() {
ReindexHistory()
})
}
func getRollbackBox(boxID string) (ret *Box, created bool, err error) {
ret = Conf.Box(boxID)
if nil == ret {
boxName := "Rollback"
ret = GetBoxByName(boxName)
if nil == ret {
var id string
id, err = CreateBox(boxName)
if nil != err {
return
}
_, err = Mount(id)
if nil != err {
return
}
ret = Conf.Box(id)
created = true
}
}
if nil == ret {
err = errors.New("can not get or create rollback box")
return
}
return
}