From 56a5f13728aa5b4404abb1ba2ff4c071f4b84efd Mon Sep 17 00:00:00 2001
From: Daniel <845765@qq.com>
Date: Wed, 16 Jul 2025 00:05:51 +0800
Subject: [PATCH] :technologist: Improve kernel API `/api/block/updateBlock`
and `/api/block/batchUpdateBlock`
https://github.com/siyuan-note/siyuan/issues/15301
---
API.md | 16 +----
API_zh_CN.md | 16 +----
kernel/api/block_op.go | 136 ++++++++++++++---------------------------
kernel/model/export.go | 27 +++-----
kernel/model/tree.go | 11 ++++
5 files changed, 66 insertions(+), 140 deletions(-)
diff --git a/API.md b/API.md
index 14c548c35..45e0ad65d 100644
--- a/API.md
+++ b/API.md
@@ -782,21 +782,7 @@ Move documents by `id`:
{
"code": 0,
"msg": "",
- "data": [
- {
- "doOperations": [
- {
- "action": "update",
- "data": "",
- "id": "20211230161520-querkps",
- "parentID": "",
- "previousID": "",
- "retData": null
- }
- ],
- "undoOperations": null
- }
- ]
+ "data": null
}
```
diff --git a/API_zh_CN.md b/API_zh_CN.md
index c9694fb25..cbf5ec36f 100644
--- a/API_zh_CN.md
+++ b/API_zh_CN.md
@@ -776,21 +776,7 @@
{
"code": 0,
"msg": "",
- "data": [
- {
- "doOperations": [
- {
- "action": "update",
- "data": "",
- "id": "20211230161520-querkps",
- "parentID": "",
- "previousID": "",
- "retData": null
- }
- ],
- "undoOperations": null
- }
- ]
+ "data": null
}
```
diff --git a/kernel/api/block_op.go b/kernel/api/block_op.go
index 9c6ebe2f2..7bd20fa02 100644
--- a/kernel/api/block_op.go
+++ b/kernel/api/block_op.go
@@ -25,7 +25,6 @@ import (
"github.com/88250/lute/ast"
"github.com/88250/lute/parse"
"github.com/gin-gonic/gin"
- "github.com/siyuan-note/siyuan/kernel/filesys"
"github.com/siyuan-note/siyuan/kernel/model"
"github.com/siyuan-note/siyuan/kernel/treenode"
"github.com/siyuan-note/siyuan/kernel/util"
@@ -568,20 +567,21 @@ func updateBlock(c *gin.Context) {
return
}
- block, err := model.GetBlock(id, nil)
+ oldTree, err := model.LoadTreeByBlockID(id)
if err != nil {
ret.Code = -1
- ret.Msg = "get block failed: " + err.Error()
+ ret.Msg = "load tree failed: " + err.Error()
return
}
- if "NodeDocument" == block.Type {
- oldTree, err := filesys.LoadTree(block.Box, block.Path, luteEngine)
- if err != nil {
- ret.Code = -1
- ret.Msg = "load tree failed: " + err.Error()
- return
- }
+ node := treenode.GetNodeInTree(oldTree, id)
+ if nil == node {
+ ret.Code = -1
+ ret.Msg = "block not found [id=" + id + "]"
+ return
+ }
+
+ if ast.NodeDocument == node.Type {
var toRemoves []*ast.Node
for n := oldTree.Root.FirstChild; nil != n; n = n.Next {
toRemoves = append(toRemoves, n)
@@ -600,36 +600,21 @@ func updateBlock(c *gin.Context) {
model.WriteTreeUpsertQueue(oldTree)
model.ReloadProtyle(id)
- return
+ } else {
+ if ast.NodeListItem == node.Type && ast.NodeList == tree.Root.FirstChild.Type {
+ // 使用 API `api/block/updateBlock` 更新列表项时渲染错误 https://github.com/siyuan-note/siyuan/issues/4658
+ tree.Root.AppendChild(tree.Root.FirstChild.FirstChild) // 将列表下的第一个列表项移到文档结尾，移动以后根下面直接挂列表项，渲染器可以正常工作
+ tree.Root.FirstChild.Unlink() // 删除列表
+ tree.Root.FirstChild.Unlink() // 继续删除列表 IAL
+ }
+ tree.Root.FirstChild.SetIALAttr("id", id)
+ tree.Root.FirstChild.ID = id
+ node.InsertBefore(tree.Root.FirstChild)
+ node.Unlink()
}
- var transactions []*model.Transaction
- if "NodeListItem" == block.Type && ast.NodeList == tree.Root.FirstChild.Type {
- // 使用 API `api/block/updateBlock` 更新列表项时渲染错误 https://github.com/siyuan-note/siyuan/issues/4658
- tree.Root.AppendChild(tree.Root.FirstChild.FirstChild) // 将列表下的第一个列表项移到文档结尾，移动以后根下面直接挂列表项，渲染器可以正常工作
- tree.Root.FirstChild.Unlink() // 删除列表
- tree.Root.FirstChild.Unlink() // 继续删除列表 IAL
- }
- tree.Root.FirstChild.SetIALAttr("id", id)
-
- data = luteEngine.Tree2BlockDOM(tree, luteEngine.RenderOptions)
- transactions = []*model.Transaction{
- {
- DoOperations: []*model.Operation{
- {
- Action: "update",
- ID: id,
- Data: data,
- },
- },
- },
- }
-
- model.PerformTransactions(&transactions)
- model.FlushTxQueue()
-
- ret.Data = transactions
- broadcastTransactions(transactions)
+ model.WriteTreeUpsertQueue(oldTree)
+ model.ReloadProtyle(oldTree.ID)
}
func batchUpdateBlock(c *gin.Context) {
@@ -642,16 +627,7 @@ func batchUpdateBlock(c *gin.Context) {
}
blocksArg := arg["blocks"].([]interface{})
-
- type updateBlockArg struct {
- ID string
- Data string
- DataType string
- Block *model.Block
- Tree *parse.Tree
- }
-
- var blocks []*updateBlockArg
+ blocks := map[string]*parse.Tree{}
luteEngine := util.NewLute()
for _, blockArg := range blocksArg {
blockMap := blockArg.(map[string]interface{})
@@ -678,37 +654,26 @@ func batchUpdateBlock(c *gin.Context) {
return
}
- block, err := model.GetBlock(id, nil)
+ blocks[id] = tree
+ }
+
+ trees := map[string]*parse.Tree{}
+ for id, tree := range blocks {
+ oldTree, err := model.LoadTreeWithCache(id, &trees)
if err != nil {
ret.Code = -1
- ret.Msg = "get block failed: " + err.Error()
+ ret.Msg = "load tree failed: " + err.Error()
return
}
- blocks = append(blocks, &updateBlockArg{
- ID: id,
- Data: data,
- DataType: dataType,
- Block: block,
- Tree: tree,
- })
- }
+ node := treenode.GetNodeInTree(oldTree, id)
+ if nil == node {
+ ret.Code = -1
+ ret.Msg = "block not found [id=" + id + "]"
+ return
+ }
- var ops []*model.Operation
- tx := &model.Transaction{}
- transactions := []*model.Transaction{tx}
- for _, upBlock := range blocks {
- block := upBlock.Block
- data := upBlock.Data
- tree := upBlock.Tree
- id := upBlock.ID
- if "NodeDocument" == block.Type {
- oldTree, err := filesys.LoadTree(block.Box, block.Path, luteEngine)
- if err != nil {
- ret.Code = -1
- ret.Msg = "load tree failed: " + err.Error()
- return
- }
+ if ast.NodeDocument == node.Type {
var toRemoves []*ast.Node
for n := oldTree.Root.FirstChild; nil != n; n = n.Next {
toRemoves = append(toRemoves, n)
@@ -723,34 +688,23 @@ func batchUpdateBlock(c *gin.Context) {
for _, n := range toAppends {
oldTree.Root.AppendChild(n)
}
-
- model.WriteTreeUpsertQueue(oldTree)
- model.ReloadProtyle(id)
} else {
- if "NodeListItem" == block.Type && ast.NodeList == tree.Root.FirstChild.Type {
+ if ast.NodeListItem == node.Type && ast.NodeList == tree.Root.FirstChild.Type {
// 使用 API `api/block/updateBlock` 更新列表项时渲染错误 https://github.com/siyuan-note/siyuan/issues/4658
tree.Root.AppendChild(tree.Root.FirstChild.FirstChild) // 将列表下的第一个列表项移到文档结尾，移动以后根下面直接挂列表项，渲染器可以正常工作
tree.Root.FirstChild.Unlink() // 删除列表
tree.Root.FirstChild.Unlink() // 继续删除列表 IAL
}
tree.Root.FirstChild.SetIALAttr("id", id)
-
- data = luteEngine.Tree2BlockDOM(tree, luteEngine.RenderOptions)
- ops = append(ops, &model.Operation{
- Action: "update",
- ID: id,
- Data: data,
- })
+ tree.Root.FirstChild.ID = id
+ node.InsertBefore(tree.Root.FirstChild)
+ node.Unlink()
}
}
- if 0 < len(ops) {
- tx.DoOperations = ops
- model.PerformTransactions(&transactions)
- model.FlushTxQueue()
-
- ret.Data = transactions
- broadcastTransactions(transactions)
+ for _, tree := range trees {
+ model.WriteTreeUpsertQueue(tree)
+ model.ReloadProtyle(tree.ID)
}
}
diff --git a/kernel/model/export.go b/kernel/model/export.go
index 2b2b23777..e6bb4acfe 100644
--- a/kernel/model/export.go
+++ b/kernel/model/export.go
@@ -1994,7 +1994,7 @@ func ExportMarkdownContent(id string, refMode, embedMode int, addYfm, fillCSSVar
}
func exportMarkdownContent(id, ext string, exportRefMode int, defBlockIDs []string, singleFile bool, treeCache *map[string]*parse.Tree) (tree *parse.Tree, exportedMd string, isEmpty bool) {
- tree, err := loadTreeWithCache(id, treeCache)
+ tree, err := LoadTreeWithCache(id, treeCache)
if err != nil {
logging.LogErrorf("load tree by block id [%s] failed: %s", id, err)
return
@@ -2788,7 +2788,7 @@ func resolveFootnotesDefs(refFootnotes *[]*refAsFootnotes, currentTree *parse.Tr
footnotesDefBlock = &ast.Node{Type: ast.NodeFootnotesDefBlock}
var rendered []string
for _, foot := range *refFootnotes {
- t, err := loadTreeWithCache(foot.defID, treeCache)
+ t, err := LoadTreeWithCache(foot.defID, treeCache)
if nil != err {
return
}
@@ -2924,7 +2924,7 @@ func blockLink2Ref(currentTree *parse.Tree, id string, treeCache *map[string]*pa
if nil == b {
return
}
- t, err := loadTreeWithCache(b.RootID, treeCache)
+ t, err := LoadTreeWithCache(b.RootID, treeCache)
if nil != err {
return
}
@@ -2974,7 +2974,7 @@ func collectFootnotesDefs(currentTree *parse.Tree, id string, refFootnotes *[]*r
if nil == b {
return
}
- t, err := loadTreeWithCache(b.RootID, treeCache)
+ t, err := LoadTreeWithCache(b.RootID, treeCache)
if nil != err {
return
}
@@ -3265,7 +3265,7 @@ func prepareExportTrees(docPaths []string) (defBlockIDs []string, trees *map[str
continue
}
- tree, err := loadTreeWithCache(rootID, treeCache)
+ tree, err := LoadTreeWithCache(rootID, treeCache)
if err != nil {
continue
}
@@ -3307,7 +3307,7 @@ func exportRefTrees(tree *parse.Tree, defBlockIDs *[]string, retTrees, treeCache
if (*treeCache)[defBlock.RootID] != nil {
defTree = (*treeCache)[defBlock.RootID]
} else {
- defTree, err = loadTreeWithCache(defBlock.RootID, treeCache)
+ defTree, err = LoadTreeWithCache(defBlock.RootID, treeCache)
if err != nil {
return ast.WalkSkipChildren
}
@@ -3331,7 +3331,7 @@ func exportRefTrees(tree *parse.Tree, defBlockIDs *[]string, retTrees, treeCache
if (*treeCache)[defBlock.RootID] != nil {
defTree = (*treeCache)[defBlock.RootID]
} else {
- defTree, err = loadTreeWithCache(defBlock.RootID, treeCache)
+ defTree, err = LoadTreeWithCache(defBlock.RootID, treeCache)
if err != nil {
return ast.WalkSkipChildren
}
@@ -3370,7 +3370,7 @@ func exportRefTrees(tree *parse.Tree, defBlockIDs *[]string, retTrees, treeCache
if (*treeCache)[defBlock.RootID] != nil {
defTree = (*treeCache)[defBlock.RootID]
} else {
- defTree, err = loadTreeWithCache(defBlock.RootID, treeCache)
+ defTree, err = LoadTreeWithCache(defBlock.RootID, treeCache)
if err != nil {
continue
}
@@ -3387,17 +3387,6 @@ func exportRefTrees(tree *parse.Tree, defBlockIDs *[]string, retTrees, treeCache
*defBlockIDs = gulu.Str.RemoveDuplicatedElem(*defBlockIDs)
}
-func loadTreeWithCache(id string, treeCache *map[string]*parse.Tree) (tree *parse.Tree, err error) {
- if tree = (*treeCache)[id]; nil != tree {
- return
- }
- tree, err = LoadTreeByBlockID(id)
- if nil == err && nil != tree {
- (*treeCache)[id] = tree
- }
- return
-}
-
func getAttrViewTable(attrView *av.AttributeView, view *av.View, query string) (ret *av.Table) {
switch view.LayoutType {
case av.LayoutTypeGallery:
diff --git a/kernel/model/tree.go b/kernel/model/tree.go
index cd26fb03b..5200f9303 100644
--- a/kernel/model/tree.go
+++ b/kernel/model/tree.go
@@ -207,6 +207,17 @@ func LoadTreeByBlockIDWithReindex(id string) (ret *parse.Tree, err error) {
return
}
+func LoadTreeWithCache(id string, treeCache *map[string]*parse.Tree) (tree *parse.Tree, err error) {
+ if tree = (*treeCache)[id]; nil != tree {
+ return
+ }
+ tree, err = LoadTreeByBlockID(id)
+ if nil == err && nil != tree {
+ (*treeCache)[id] = tree
+ }
+ return
+}
+
func LoadTreeByBlockID(id string) (ret *parse.Tree, err error) {
if !ast.IsNodeIDPattern(id) {
stack := logging.ShortStack()