An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作
TypeScript agentic-aiai-agentknowledge-baselocal-firstmarkdownmcpmindmapnote-takingself-hostedsiyuanworkspace
:bug: Normalize deprecated export modes before saving https://github.com/siyuan-note/siyuan/issues/20426
Daniel40910505dd77
diff --git a/app/src/types/api/index.d.ts b/app/src/types/api/index.d.tsindex 4acb5938e5..765bf5b6ed 100644--- a/app/src/types/api/index.d.ts+++ b/app/src/types/api/index.d.ts@@ -6593,6 +6593,7 @@ export interface APIPOSTRoutes {};/*** 保留省略字段,成功后客户端重新读取配置;通知不包含密码或密钥。+ * export.blockRefMode 的废弃值 0、1、5 在保存前转换为 4,与启动时的转换规则一致。*/"/api/setting/patch": {request: PatchSettingRequestInput;@@ -6696,6 +6697,10 @@ export interface APIPOSTRoutes {/** 服务器路由要求;资源权限与笔记本租约仍由内核校验 */authorization?: readonly ["authenticated","admin","writable"];};+ /**+ * 整体替换导出配置,将 blockRefMode 的废弃值 0、1、5 转换为 4 后同步保存并回显。+ * 其他取值及字段省略、null 的解析行为保持不变。+ */"/api/setting/setExport": {request: SetExportRequestInput;response: { "code": 0; "data": SettingExport | null; "msg": string; } | { "code": -1; "data": { "closeTimeout": number; } | null; "msg": string; };@@ -7361,7 +7366,7 @@ export interface APIPOSTRoutes {authorization?: readonly ["authenticated","admin","writable"];};/**- * 导入前按启动和设置接口的相同规则规范化编辑器、文档树、搜索和闪卡偏好,并同步保存。+ * 导入前按启动和设置接口的相同规则规范化编辑器、导出、文档树、搜索和闪卡偏好,并同步保存。*/"/api/system/importConf": {request: SystemImportConfRequestInput;diff --git a/kernel/api/contract_setting_export_test.go b/kernel/api/contract_setting_export_test.gonew file mode 100644index 0000000000..ef1d2db507--- /dev/null+++ b/kernel/api/contract_setting_export_test.go@@ -0,0 +1,80 @@+package api++import (+ "encoding/json"+ "os"+ "path/filepath"+ "reflect"+ "testing"++ "github.com/gin-gonic/gin"+ "github.com/siyuan-note/siyuan/kernel/conf"+ "github.com/siyuan-note/siyuan/kernel/model"+ "github.com/siyuan-note/siyuan/kernel/util"+)++func TestAPIContractSettingExportNormalization(t *testing.T) {+ previousConf, previousDir, previousReadOnly := model.Conf, util.ConfDir, util.ReadOnly+ util.ConfDir, util.ReadOnly = t.TempDir(), false+ t.Cleanup(func() {+ model.Conf, util.ConfDir, util.ReadOnly = previousConf, previousDir, previousReadOnly+ })+ for _, route := range []struct {+ name string+ handler gin.HandlerFunc+ }{+ {"setExport", setExport},+ {"patch", patchSetting},+ } {+ for _, entry := range []struct {+ body string+ want int+ }{+ {`{"blockRefMode":0}`, 4}, {`{"blockRefMode":1}`, 4}, {`{"blockRefMode":5}`, 4},+ {`{"blockRefMode":2}`, 2}, {`{"blockRefMode":3}`, 3}, {`{"blockRefMode":4}`, 4},+ {`{"blockRefMode":-1}`, -1}, {`{"blockRefMode":6}`, 6},+ {`{"blockRefMode":null}`, 4}, {`{"addTitle":false}`, 4},+ } {+ t.Run(route.name+"/"+entry.body, func(t *testing.T) {+ model.Conf = model.NewAppConf()+ model.Conf.Export = conf.NewExport()+ model.Conf.Export.BlockRefMode = 3+ model.Conf.Export.BlockRefTextLeft = "["+ body, want := entry.body, entry.want+ if route.name == "patch" {+ body = `{"export":` + body + `}`+ if entry.body == `{"addTitle":false}` {+ want = 3+ }+ }+ code, message, data := settingContractRequest(t, route.name, route.handler, body)+ if code != 0 || model.Conf.Export.BlockRefMode != want {+ t.Fatalf("save failed: code=%d message=%s config=%+v", code, message, model.Conf.Export)+ }+ if route.name == "setExport" {+ var response conf.Export+ if err := json.Unmarshal(data, &response); err != nil {+ t.Fatal(err)+ }+ if !reflect.DeepEqual(&response, model.Conf.Export) || response.BlockRefTextLeft != "" {+ t.Fatal("replacement response differs from the applied export settings")+ }+ } else if model.Conf.Export.BlockRefTextLeft != "[" {+ t.Fatal("patch lost an omitted export setting")+ }+ persisted, err := os.ReadFile(filepath.Join(util.ConfDir, "conf.json"))+ if err != nil {+ t.Fatal(err)+ }+ var reloaded model.AppConf+ if err = json.Unmarshal(persisted, &reloaded); err != nil {+ t.Fatal(err)+ }+ if !reflect.DeepEqual(reloaded.Export, model.Conf.Export) ||+ !reflect.DeepEqual(conf.NormalizeExport(reloaded.Export), model.Conf.Export) {+ t.Fatal("persisted export settings differ from the applied or startup settings")+ }+ })+ }+ }+}diff --git a/kernel/api/contract_setting_normalize_test.go b/kernel/api/contract_setting_normalize_test.goindex 2ed16a5b9f..e358b924d9 100644--- a/kernel/api/contract_setting_normalize_test.go+++ b/kernel/api/contract_setting_normalize_test.go@@ -63,8 +63,10 @@ func TestAPIContractImportedSettingsNormalization(t *testing.T) {util.TempDir, util.ReadOnly = t.TempDir(), truet.Cleanup(func() { model.Conf, util.TempDir, util.ReadOnly = previous, temp, readOnly })for _, payload := range []string{- `{"editor":{"blockRefDynamicAnchorTextMaxLen":1,"fontSize":100},"fileTree":{"maxListCount":0},"search":{"limit":0},"flashcard":{"weights":"invalid"}}`,- `{"editor":null,"fileTree":null,"search":null,"flashcard":null}`,+ `{"editor":{"blockRefDynamicAnchorTextMaxLen":1,"fontSize":100},"export":{"blockRefMode":0},"fileTree":{"maxListCount":0},"search":{"limit":0},"flashcard":{"weights":"invalid"}}`,+ `{"editor":null,"export":null,"fileTree":null,"search":null,"flashcard":null}`,+ `{"export":{"blockRefMode":1}}`,+ `{"export":{"blockRefMode":5}}`,} {model.Conf = model.NewAppConf()originalSync := model.Conf.Sync@@ -93,6 +95,7 @@ func TestAPIContractImportedSettingsNormalization(t *testing.T) {t.Fatalf("import failed: %s (%v)", recorder.Body.String(), err)}if model.Conf.Editor == nil || model.Conf.Editor.FontSize != 16 || model.Conf.Editor.BlockRefDynamicAnchorTextMaxLen < 1 ||+ model.Conf.Export == nil || model.Conf.Export.BlockRefMode != 4 ||model.Conf.FileTree.MaxListCount != 512 || model.Conf.Search.Limit != 64 ||model.Conf.Flashcard.Weights != conf.DefaultFSRSWeights() || model.Conf.Sync != originalSync {t.Fatal("import did not normalize preferences or replaced sync configuration")diff --git a/kernel/api/setting.go b/kernel/api/setting.goindex 71b4c5867c..9809df8a45 100644--- a/kernel/api/setting.go+++ b/kernel/api/setting.go@@ -440,6 +440,7 @@ func applyExportSetting(c *gin.Context, request apicontract.SetExportRequest) (rreturn}+ export = conf.NormalizeExport(export)previousPandocBin := model.Conf.Export.PandocBinif "" != export.PandocBin {if !util.IsValidPandocBin(export.PandocBin) {diff --git a/kernel/api/system.go b/kernel/api/system.goindex 6368a44d7f..9f6bc7f4ef 100644--- a/kernel/api/system.go+++ b/kernel/api/system.go@@ -693,6 +693,7 @@ var importConf = contractHandler(apicontract.SystemImportConf, func(c *gin.ConteimportedConf.FileTree = conf.NormalizeFileTree(importedConf.FileTree)importedConf.Editor = conf.NormalizeEditor(importedConf.Editor)+ importedConf.Export = conf.NormalizeExport(importedConf.Export)importedConf.Search = conf.NormalizeSearch(importedConf.Search)importedConf.Flashcard, _ = conf.NormalizeFlashcard(importedConf.Flashcard)model.Conf.FileTree = importedConf.FileTreediff --git a/kernel/apicontract/contracts.go b/kernel/apicontract/contracts.goindex d4be774b21..c6b7de9370 100644--- a/kernel/apicontract/contracts.go+++ b/kernel/apicontract/contracts.go@@ -1080,7 +1080,11 @@ var SetFlashcard = define[SetFlashcardRequest, *SettingFlashcard]("setFlashcard"var SetEditor = define[SetEditorRequest, *SettingEditor]("setEditor", "/api/setting/setEditor", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")// PatchSetting 保留省略字段,成功后客户端重新读取配置;通知不包含密码或密钥。+// export.blockRefMode 的废弃值 0、1、5 在保存前转换为 4,与启动时的转换规则一致。var PatchSetting = define[PatchSettingRequest, Null]("patchSetting", "/api/setting/patch", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")++// SetExport 整体替换导出配置,将 blockRefMode 的废弃值 0、1、5 转换为 4 后同步保存并回显。+// 其他取值及字段省略、null 的解析行为保持不变。var SetExport = define[SetExportRequest, *SettingExport]("setExport", "/api/setting/setExport", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")// SetFiletree 使用与启动、导入相同的路径和数值规范化规则;省略顶层笔记本文档和默认图标选项时保留当前值。@@ -1319,7 +1323,7 @@ var SystemGetMobileWorkspaces = define[EmptyRequest, []string]("getMobileWorkspavar SystemGetSysFonts = define[EmptyRequest, []*SystemFont]("getSysFonts", "/api/system/getSysFonts", AuthenticatedAccess|AdminAccess, NoBody, ResponseOptions{}, "POST")var SystemGetWorkspaces = define[EmptyRequest, []*SystemWorkspace]("getWorkspaces", "/api/system/getWorkspaces", AuthenticatedAccess, NoBody, ResponseOptions{}, "POST")-// SystemImportConf 导入前按启动和设置接口的相同规则规范化编辑器、文档树、搜索和闪卡偏好,并同步保存。+// SystemImportConf 导入前按启动和设置接口的相同规则规范化编辑器、导出、文档树、搜索和闪卡偏好,并同步保存。var SystemImportConf = define[SystemImportConfRequest, Null]("importConf", "/api/system/importConf", AuthenticatedAccess|AdminAccess|WritableAccess, MultipartBody, ResponseOptions{}, "POST")var SystemImportCustomFont = define[SystemImportFileRequest, *SystemCustomFont]("importCustomFont", "/api/system/importCustomFont", AuthenticatedAccess|AdminAccess|WritableAccess, MultipartBody, ResponseOptions{AdditionalCodes: []int{400, 413}}, "POST")var SystemImportTLSCABundle = define[SystemImportFileRequest, SystemMessageData]("importTLSCABundle", "/api/system/importTLSCABundle", AuthenticatedAccess|AdminAccess|WritableAccess, MultipartBody, ResponseOptions{}, "POST")diff --git a/kernel/conf/settings_normalize.go b/kernel/conf/settings_normalize.goindex b03237a7a7..2bfb5b5ddd 100644--- a/kernel/conf/settings_normalize.go+++ b/kernel/conf/settings_normalize.go@@ -128,6 +128,17 @@ func NormalizeEditor(editor *Editor) *Editor {return editor}+// NormalizeExport 将已废弃的块引用导出模式统一转换为脚注与锚点哈希模式。+func NormalizeExport(export *Export) *Export {+ if export == nil {+ export = NewExport()+ }+ if export.BlockRefMode == 0 || export.BlockRefMode == 1 || export.BlockRefMode == 5 {+ export.BlockRefMode = 4+ }+ return export+}+// NormalizeSearch 保留非空布尔指针表示的用户选择。func NormalizeSearch(search *Search) *Search {if search == nil {diff --git a/kernel/model/conf.go b/kernel/model/conf.goindex 71c0a99d2a..302d82026e 100644--- a/kernel/model/conf.go+++ b/kernel/model/conf.go@@ -419,14 +419,7 @@ func InitConf() {Conf.Appearance.NormalizeGlobalFontFamilies()util.MarkdownSettings = Conf.Editor.Markdown- if nil == Conf.Export {- Conf.Export = conf.NewExport()- }- if 0 == Conf.Export.BlockRefMode || 1 == Conf.Export.BlockRefMode || 5 == Conf.Export.BlockRefMode {- // 废弃导出选项引用块转换为原始块和引述块 https://github.com/siyuan-note/siyuan/issues/3155- // 锚点哈希模式和脚注模式合并 https://github.com/siyuan-note/siyuan/issues/13331- Conf.Export.BlockRefMode = 4 // 改为脚注+锚点哈希- }+ Conf.Export = conf.NormalizeExport(Conf.Export)if nil == Conf.Graph || nil == Conf.Graph.Local || nil == Conf.Graph.Global {Conf.Graph = conf.NewGraph()} else {diff --git a/kernel/model/settings_reset.go b/kernel/model/settings_reset.goindex b86e233c6d..ae76ae90f6 100644--- a/kernel/model/settings_reset.go+++ b/kernel/model/settings_reset.go@@ -67,6 +67,7 @@ func defaultWorkspaceSettings(current *AppConf) *AppConf {next.System = &system}next.Editor = conf.NormalizeEditor(next.Editor)+ next.Export = conf.NormalizeExport(next.Export)next.FileTree = conf.NormalizeFileTree(next.FileTree)next.Search = conf.NormalizeSearch(next.Search)next.Flashcard, _ = conf.NormalizeFlashcard(next.Flashcard)