思源笔记源码解析之kernel篇（十）model

# 总结

根据以上你自己的分析，对程序的整体功能和构架做出概括。然后用一张 markdown 表格整理每个文件的功能

SiYuan 是一款知识管理笔记软件，用户可以使用它来制作 Markdown 笔记、管理知识图谱以及进行 OCR 扫描等操作。系统通过分块、分组等方式实现了一些特色功能，如闪卡复习、块级内联属性、虚拟引用等，同时支持多端同步（包括云同步和局域网同步）。

以下是 model 目录下各个文件的功能列表：

# [0/49] ai.go

该程序文件实现了 model 包中的 ChatGPT 和 ChatGPTWithAction 函数，这两个函数用于调用 GPT 模型来进行对话。ChatGPT 函数用于一般情况的对话，ChatGPTWithAction 函数用于针对某个动作的对话。

程序中还定义了一个 ChatGPTContinueWrite 函数，用于依次发送多次请求，最终得到所有生成文字的整合结果。在具体实现上，程序通过判断是否开启了 GPT 的 API，来决定是否进行对话。

如果开启了 GPT 的 API，程序接着根据消息和前几次对话内容，调用 GPT 模型得到生成文字。另外还包括了一些辅助函数，用于从给定的区块 ID 中获取对应区块的内容，并将其转换为标准化的 Markdown 文本。

# [1/49] appearance.go

该文件是 SiYuan 笔记的一个模块，用于程序外观的管理和初始化。程序在初始化时，会创建必要的外观相关文件夹，并将资源文件等拷贝到这些文件夹下。

程序还会加载已经存在的主题（包括 UI 和图标），并启动文件监测。如果检测到主题或 UI 有变动，程序会重新加载相应的主题或 UI 文件，并刷新程序外观。

# [2/49] assets.go

该文件定义了一系列与 SiYuan 笔记的图片资源处理相关的函数，主要包括将网络图片转换为本地图片、搜索图片资源、获取图片的绝对路径等等。其中

• NetImg2LocalAssets 函数用于将指定笔记的网络图片转换为本地图片，并将转换后的图片的链接在笔记中进行替换。
• DocImageAssets 函数用于从指定笔记中获取所有的图片资源的链接。
• GetAssetAbsPath 函数用于获取指定图片资源的绝对路径。
• UploadAssets2Cloud 函数用于将指定笔记中的所有图片资源上传至云端图床。
• RemoveUnusedAssets 函数用于删除未使用的图片资源。

# [3/49] assets_watcher.go

该程序文件是一个 Go 语言的代码文件，文件名为 assets_watcher.go ，位于 model.zip.extract\model 目录下。

该文件实现了 model 包中的 WatchAssets() 函数和 CloseWatchAssets() 函数，用于监控系统中的资源文件夹的变化并进行处理。具体包括以下内容：

1. 该文件使用了 fsnotify 包，创建了一个 fsnotify.Watcher 实例，用于监听系统中资源文件夹的变化。如果监听出错，会打印日志。

2. 通过 watchAssets() 函数开启一个 goroutine 来监听资源文件夹的变化。具体包括以下内容：

   1. 创建 timer 实例和 lastEvent 变量。
   2. 通过 select 语句监听事件和错误的 channel，实现事件和错误的处理。
   3. 当接收到事件时，通过 timer 延迟 100ms 再处理事件。如果在延迟期间又接收到新事件，会重新计时。
   4. 如果事件的操作类型为 fsnotify.Write ，说明有文件被修改了，则调用 IncSync() 函数将修改添加到云端同步。
   5. 重新缓存资源文件，以便使用 /资源 搜索。

3. WatchAssets() 函数用于启动监听资源文件夹的 goroutine。

4. CloseWatchAssets() 函数用于关闭资源文件夹的监听器。

# [4/49] assets_watcher_darwin.go

该程序文件名为 assets_watcher_darwin.go，属于 Go 语言编写的 SiYuan 笔记的资产监视器模块。

它通过使用观察器实现对 SiYuan 笔记资产目录（assets）的监视，当文件发生更改时自动进行同步，同时重新缓存资源文件，以便使用 / 资源 搜索。

该模块通过使用 watcher 包和 filepath 包实现对资产目录的监视，启动和关闭资产监视器等相关操作。 该模块只对 Darwin 系统版本（如 macOS）有效，因此包含了 //go:build darwin 编译指令。

# [5/49] attribute_view.go

该程序文件主要实现了一个笔记应用中的属性视图相关功能。其中涉及到的函数包括：

1. RenderAttributeView：渲染属性视图，返回对应的 DOM 结构。
2. doInsertAttrViewBlock：向属性视图中添加块。
3. doRemoveAttrViewBlock：从属性视图中删除块。
4. doAddAttrViewColumn：向属性视图中添加属性列。
5. doRemoveAttrViewColumn：从属性视图中删除属性列。
6. addAttributeViewColumn：向属性视图中添加指定类型的属性列。
7. removeAttributeViewColumn：从属性视图中删除指定属性列。
8. removeAttributeViewBlock：从属性视图中删除指定块。
9. addAttributeViewBlock：向属性视图中添加指定块，并为块添加属性。

其中的 av 包提供了属性视图的解析、序列化和持久化等功能。文件中还引用了其他的包和库，如 lute、parse、treenode、sql 等。

总的来说，该程序文件实现了属性视图相关的操作，为笔记应用提供了可供使用的功能。

# [6/49] backlink.go

该程序文件为 siyuan-note 中的一个后端代码文件，主要包含 RefreshBacklink、GetBackmentionDoc、GetBacklinkDoc、GetBacklink2 和 GetBacklink 等函数。

其中，RefreshBacklink 主要用于更新引用关系，GetBackmentionDoc 和 GetBacklinkDoc 函数用于获取提及关系和引用关系，GetBacklink2 和 GetBacklink 函数用于获取链接和反链关系。这些函数都涉及到 sql 操作和解析树操作，主要是用于在 siyuan-note 中实现笔记本和笔记的链接、反链、提及等功能。

# [7/49] bazzar.go

该程序文件是一个实现了一系列从社区中心获取插件的功能函数集合，函数包括获取插件 README、获取插件组件、安装插件组件、卸载插件组件等。

其中调用了一些已有的函数库以实现具体功能。同时，该程序文件基于开源协议发布。

# [8/49] block.go

该文件实现了一个名为 Block 的结构体和这个结构体的一些操作函数。这个结构体描述了一个特定 content block （即 siyuan 笔记中的一个块）。它有许多字段，包括路径、id、名字、别名、内容和子结构等。

同时，这个文件还实现了一些函数，如 RecentUpdatedBlocks() ，它可以返回最近更新的 30 个块的信息，可以用来供笔记首页的构建； GetBlock(id string, tree *parse.Tree) ，它可以根据一个块的 id 来导出这个块的具体内容和信息。

# [9/49] blockial.go

该程序文件是在 model 目录下，文件名为 blockial.go。它实现了处理 SiYuan 笔记块属性的相关函数，包括设置和获取笔记块的属性、清除笔记块的属性等，其中还包括处理笔记块提醒事件的函数等。具体实现过程中，该文件引入了多个第三方库和其他模块中的函数。

# [10/49] blockinfo.go

该程序文件是一个 Go 语言编写的模块，它定义了 BlockInfo 结构体，用于存储块的元信息。它还定义了若干个函数用于获取块信息、块路径信息等。

其中获取块信息的函数是 GetDocInfo，它调用 loadTreeByBlockID 方法获取给定 ID 的块的 Tree，然后从 Tree 中取得块的相应属性（如 Name、RefCount、SubFileCount、RefIDs 等）并构造 BlockInfo 结构体。

其他函数则都是从给定的块或节点信息中提取块的相关信息，例如 GetBlockRefText 用于获取块的引用文本，GetBlockIndex 用于获取块在文档中的索引位置，BuildBlockBreadcrumb 用于构造块的面包屑路径。

# [11/49] bookmark.go

该文件是一个 Go 语言编写的模型文件，主要包含了关于标签的数据操作，如删除标签、修改标签、获取标签等。

其中包含了多个函数，如 RemoveBookmark 用于删除标签， RenameBookmark 用于修改标签， BookmarkLabels 用于获取现有的标签， BuildBookmark 用于构建标签。该文件还引用了其他 Go 语言库，如 github.com/88250/lute/parse 和 github.com/siyuan-note/siyuan/kernel/cache 等。

# [12/49] box.go

这是一个 Go 语言程序文件，名为 box.go，位于 model 文件夹下。该文件实现了笔记本 Box 的各种操作，如获取笔记本列表、获取或保存笔记本配置、列出或操作笔记本中的文件等。实现了 StatJob 函数用于自动记录笔记本的统计信息，如笔记数、块数、数据大小和资产大小，并推送桌面端可用磁盘空间不足的警告消息。

同时，程序中也实现了一些工具函数用于处理树形结构。

# [13/49] conf.go

该程序文件是一个 Go 语言源文件，文件名为 conf.go，位于 model 目录下。程序定义了一个名为 AppConf 的结构体类型，用于存储应用程序的各种配置选项。其中包括日志级别、界面语言列表、文件树、标签、编辑器、导出、关系图、界面布局等。

程序在初始化时从配置文件中读取这些选项的值，并进行一些修正和初始化工作，最终将 AppConf 对象输出。程序的初始化过程中还进行了语言初始化、本地 IP 获取、网络代理设置等操作。程序依赖于一些第三方库，包括 gulu、lute、locale 等。

# [14/49] css.go

该程序文件是一个模型文件，可以在处理和获取自定义 CSS 颜色方案时使用。代码将自定义颜色方案值写入到全局变量中，以便在其他地方使用。

主要包含一些读取和写入 CSS 的功能，以及一些与颜色有关的函数等。文件中定义了许多常量和变量，包括颜色的数组以及一个颜色映射。

该文件主要用于处理主题中的颜色设置，以及在输出 HTML 页面等情况下使用 CSS 策略的基础代码。

# [15/49] export.go

该程序文件是 Go 语言编写的代码，名称为 export.go。包含了 Siyuan 的导出相关功能。

其中 ExportData () 函数用于将数据导出并压缩成.zip 文件，Export2Liandi () 函数用于将当前文档导出到 Liandi 笔记中，ExportSY (id string) 函数用于将当前文档导出为.SY 文件并压缩成.zip 文件，ExportDocx (id, savePath string, removeAssets, merge bool) 函数用于将当前文档导出为 Word 文档，Preview (id string) 函数用于预览当前文档的 HTML 输出。

此外，文件还包含了其他导出相关的函数。

# [16/49] export_katex.go

该程序文件是一个 Go 语言编写的 Katex 导出函数。函数主要做的是提取数学表达式中使用的宏，并将其替换为一些占位符。

此外，该程序还定义了一个字符串切片数组，该数组包含 Katex 支持的函数和操作符列表。函数和操作符列表主要用于判断和处理数学表达式中的函数和操作符。

# [17/49] export_merge.go

该程序文件是 Siyuan 笔记应用的一个模块，主要实现了将多个子文档合并成一个文档的功能。

首先根据根结点生成一个 Block（即文档），然后遍历 Block 的所有子节点，将每个子节点代表的子文档加载成一棵 parse.Tree，然后将子文档中的所有节点插入到根结点指定的插入点之后。

其中涉及到了 Lute 引擎的使用，以及对文件系统中文档的读取，文档节点的创建和插入等操作。

# [18/49] file.go

该程序文件是 siyuan-note 应用的 model 包下的 file.go 文件。该文件实现了一些与文件相关操作的函数，包括获取文件列表、获取文件详情信息、统计文件内容等。

其中，ListDocTree 函数可以列出指定目录下的所有文档，ContentStat 函数可以统计指定文档的字符数、单词数、图片数、链接数和引用数，BlocksWordCount 函数可以统计指定文档块的字符数、单词数、图片数、链接数和引用数，StatTree 函数可以统计指定文档树的字符数、单词数、图片数、链接数和引用数。

# [19/49] flashcard.go

该程序文件是 Siyuan 的卡片记忆功能相关代码，主要功能包括卡包的增删改查、卡片的复习、跳过和显示等。

其中，程序中维护了一个 Decks 变量，它包含了所有卡包，每个卡包有自己的 ID，包含了它所管理的卡片的信息。

GetNotebookFlashcards 获取某个笔记本中的所有笔记的闪卡记录，GetTreeFlashcards 获取一棵子树中的所有闪卡，GetFlashcards 获取全部卡包中的所有闪卡信息。

ReviewFlashcard 对应闪卡复习功能，SkipReviewFlashcard 则是记录卡片跳过操作的函数。GetDueFlashcards 函数用于获取所有未复习的卡片，RemoveFlashcardsByCardIDs 用于移除指定卡包中的指定卡片的闪卡历史记录。

# [20/49] format.go

该文件是 SiYuan 笔记应用程序的一部分，文件名为 format.go。

该文件提供了一个函数用于自动添加空格。它引用了一些来自其他库的函数、变量和结构体，如 Github 上的 gulu、lute 和 render 等。

具体来说，该文件可以读取一棵树的 JSON 表示，然后合并相邻的同类行级节点，并使用 Lute 引擎将树渲染成 Markdown 格式。然后它启用自动空格，然后使用 Lute 引擎重新格式化树，并将结果保存在一个 JSON 文件中。该代码还实现了一个函数，用于生成历史记录。

# [21/49] graph.go

该文件是 SiYuan 笔记应用程序的一部分。该程序使用 golang 语言编写，主要负责建立笔记关系图。笔记是通过树形结构来管理的，每个节点都表示一个笔记块。

该程序使用从 SQL 中检索的块数据构建笔记关系图，并链接相关笔记。在此过程中使用了多个结构体，如 “GraphNode”，“GraphLink” 等，它们表示了笔记关系图中的节点和连接线。

此文件中的函数将 SQL 块数据转换为相应的结构体，并在处理过程中调用其他函数来构建笔记关系图。

# [22/49] heading.go

该程序文件是一个 Go 语言编写的模块，文件名为 heading.go，包含了从标题折叠到文档块之间的转换函数，以及一些与标题、文档块相关的函数。

文件中包含函数 doFoldHeading 和 doUnfoldHeading 分别用于折叠和展开标题。还包含了函数 Doc2Heading 用于将文档块转换为标题块，函数 Heading2Doc 用于将标题块转换为文档块，以及一些辅助函数。

这个程序文件实现了标题块与文档块的相互转换。

# [23/49] history.go

本程序文件主要实现了 siyuan 中文笔记软件中文档历史记录相关的功能，包括自动生成文档历史记录、获取文档历史记录内容、文档历史记录回滚等功能。

其中，AutoGenerateDocHistory 函数实现了自动生成文档历史记录的功能，该函数会在一定的时间间隔内自动调用 generateDocHistory 函数，对打开的文档生成历史记录。

generateDocHistory 函数则实现了生成文档历史记录的具体逻辑，包括清除过期的历史记录、对文档生成历史记录并保存到本地等。其他函数则实现了获取与回滚文档历史记录的相关功能。

# [24/49] import.go

该程序文件主要实现了一些 SiYuan 笔记系统中的数据导入处理逻辑，包含了以下函数：

• HTML2Markdown：将 HTML 字符串转换为 Markdown 字符串。
• ImportSY：将 SiYuan 笔记系统.SY.zip 文件导入到指定位置。
• ImportData：将 SiYuan 笔记系统.Data.zip 文件导入到默认位置。

其中，ImportSY 函数主要实现处理 .sy.zip 文件导入的逻辑，具体如下：

• 解压 zip 文件到一个临时目录；
• 读取临时目录下的所有 .sy 文件，解析出它们所对应的树结构，并重新生成每个节点的 ID；
• 修改导入后各个 .sy 文件中引用和嵌入的节点 ID；
• 重命名临时目录下的 .sy 文件到指定的目标路径，并拷贝其中所包含的资源文件到 data/assets/ 目录下；
• 读取 sort.json 文件，合并其中的排序规则，并将其写回到 .siyuan/sort.json 中；
• 拷贝所有解析出的 .sy 文件到指定位置，并上传到 SQL 中。

总的来说，该文件实现了 SiYuan 笔记系统的数据导入处理逻辑。

# [25/49] index.go

该程序文件是 SiYuan 笔记软件的一部分，其中包含了若干函数用于处理笔记的索引和查询。文件中的函数包括：

1. Unindex ()：从数据库中删除当前笔记盒的相关索引。
2. Index ()：为当前笔记盒创建索引。
3. index (boxID string)：实现 Index () 函数的具体过程，从笔记盒中读取所有的 .sy 文件，对每一个文件进行解析，得到笔记树，并对笔记树建立相关索引。
4. IndexRefs ()：对笔记牌中所有的引用节点进行处理，创建相应的引用索引。
5. IndexEmbedBlockJob ()：对所有的嵌入块进行处理，为嵌入块的查询结果建立相应的索引。
6. autoIndexEmbedBlock (embedBlocks []*sql.Block)：实现 IndexEmbedBlockJob () 的具体过程，遍历所有的嵌入块，执行嵌入块的查询操作，并将查询结果建立索引。
7. updateEmbedBlockContent (embedBlockID string, queryResultBlocks []*EmbedBlock)：更新嵌入块的内容。
8. init ()：订阅一些事件，用于显示程序运行状态。

# [26/49] index_fix.go

该程序文件主要实现了自动校验数据库索引的功能。包含以下函数：

• FixIndexJob：自动校验与订正数据库索引的入口函数。
• removeDuplicateDatabaseIndex：删除重复的数据库索引。
• resetDuplicateBlocksOnFileSys：重置重复 ID 的块。
• fixBlockTreeByFileSys：通过文件系统订正块树。
• fixDatabaseIndexByBlockTree：通过块树订正数据库索引。
• reindexTreeByUpdated：根据更新时间，重新索引笔记本块树。
• reindexTreeByPath：根据文件 .sy 文件路径，重新索引笔记本块树。
• reindexTree：根据块树 ID，重新索引笔记本块树。

主要流程是先删除重复的数据库索引，然后通过文件系统订正块树，再通过块树订正数据库索引。通过 reindexTreeByUpdated 、 reindexTreeByPath 、 reindexTree 函数，实现读取块树文件并订正索引的功能。

# [27/49] liandi.go

该程序文件名为 liandi.go，位于 model 文件夹下。该程序提供了与云端相关的一些操作，包括调用机器人进行对话、开始试用、设置云端提醒等等，其中部分涉及到网络请求。

同时，该程序文件中还包含一些变量的定义、判断是否是订阅用户、获取基础用户信息等功能。

# [28/49] listitem.go

该程序文件是一个 Go 语言程序文件，文件名为 listitem.go，位于 model 包下。

程序导入了一些库文件，例如 path 、 github.com 等。程序定义了一个函数 ListItem2Doc ，该函数会将一个列表项转化为文档，具体实现过程如下：

• loadTreeByBlockID 函数用于加载指定的 srcListItemID 所在的文档树。
• treenode.GetNodeInTree 函数用于获取指定节点 ID（在此为 srcListItemID）在文档树中的节点对象。
• 根据传递进来的 targetBoxID 和 targetPath ，确定目标位置。如果 targetPath 等于 / ，则将列表项移动到目标文件夹的根目录下，否则将列表项移动到所在目标文件夹的指定目录下。
• 将列表项中的子节点全部分离出来，并按顺序添加到新文档树上。如果列表项中没有子节点，则添加一个新段落节点。
• 设置新文档树的一些属性，例如根节点的 IAL 属性，路径等。
• 设置源列表项节点的一些 IAL 属性，例如节点类型为文档、ID、标题等，移除 fold 属性，并且设置 Kramdown IAL（Informal Attributes Language）。
• 将源列表项节点从原文档树中删除，并删除其父节点，如果其父节点已没有子节点。
• 根据源文档树和新文档树的各自 ID、路径等属性设置其它相关属性，然后写入更新队列。
• 对文档树进行索引，并存放到数据库中。
• 调用 RefreshBacklink 函数刷新其它相关的链接关系。

总之，该程序实现了将一个列表项转化为文档的功能，通过分离子节点、设置节点的 IAL 属性等步骤，将列表项转化为具备文档特性的节点，并最终存储于数据库中。

# [29/49] mount.go

该文件是 Siyuan 笔记的一个 Go 程序，主要包含了许多操作笔记本的函数，例如创建笔记本、重命名笔记本、删除笔记本、挂载和卸载笔记本等。

其中的函数实现了对笔记本的各种操作，具体包括所涉及到的函数有：CreateBox、RenameBox、RemoveBox、Unmount、unmount0、Mount、IsUserGuide 等。它们的作用分别是：创建一个新的笔记本，重命名一个笔记本，删除一个笔记本，卸载某个笔记本以及挂载某个笔记本，判断是否为用户指南。

文件中的函数还涉及到一些 Go 开发的基础知识，比如字符串处理、目录管理、文件的读写和操作等。

例如，函数中用到了操作系统的 path/filepath 包，处理文件路径；使用了 Go 自带的 errors 包，生成了错误信息；使用了 gulu 库处理字符串，以及监听器监听某些事件等。

该文件是 Siyuan 笔记的一个重要组成部分，负责笔记本本身的相关功能。它所提供的各个函数能够帮助用户更加方便、精准地管理和处理笔记本。

# [30/49] ocr.go

该文件是一个 Go 语言的程序文件，文件名为 ocr.go。

该文件声明了一些函数用于 OCR（Optical Character Recognition，光学字符识别）相关的操作，包括对图像进行 OCR 处理、将 OCR 处理结果存储到缓存中，以及从缓存中读取 OCR 处理结果等。其中，autoOCRAssets () 函数是一个主要的函数，用于自动对未处理的图像进行 OCR 处理并将结果存储到缓存中。

此外，还包括其它一些函数，如 cleanNotExistAssetsTexts ()、FlushAssetsTextsJob ()、LoadAssetsTexts ()、SaveAssetsTexts () 等，用于一些 OCR 处理相关的后续工作。

# [31/49] outline.go

该程序文件是一个 Go 语言编写的模块，文件名是 outline.go。其主要实现了一个名为 Outline 的函数，该函数被调用时，会传入一个 rootID 作为参数。

函数主要作用是在树形结构中提取出标题节点，然后将这些标题节点拼接成为一个平铺的树形结构。

在该函数中，会首先调用 loadTreeByBlockID 函数加载树形结构。然后使用 ast.Walk 遍历该树节点，提取出标题节点，并将这些节点组成一个块，每个块包含了标题节点的详细信息。然后使用 linkedliststack.New 实现堆栈的操作，将相同深度的标题块放入到子块的列表中。最终，使用 toFlatTree 将其组装为一个平铺的树形结构后返回。

# [32/49] path.go

该文件是 SiYuan 笔记应用的模型包，实现了笔记的增删改查等功能。主要包含以下函数：

• createDocsByHPath：根据传入的 boxID、hPath 和 content 创建一个文档。
• toFlatTree：构造传入的列表中子块的树结构，并返回生成的树形结构。
• toSubTree：根据关键字构造子树。
• getBlockIn：在传入的 blocks 列表中根据 id 查找是否存在一个 Block 对象。

其中，每个函数的内部实现复杂度各自不同。

# [33/49] process.go

该文件为 process.go，主要实现了处理信号和钩子桌面 UI 进程的功能。

函数 HandleSignal 用于接收系统相关的信号（如中断、退出等），并在接收到信号时关闭相关的进程。

函数 HookDesktopUIProcJob 用于挂钩桌面 UI 进程的作业，并在发现 UI 进程没有活动时退出。该函数首先检查是否存在活动的会话，如果存在则说明 UI 进程仍在运行，如果不存在则检测已经附加的 UI 进程数，如果大于 0，则说明 UI 进程仍在运行，如果等于 0，则检测所有进程中的 UI 进程数，如果大于 0，则说明 UI 进程仍在运行，否则退出。

变量 uiProcNames 定义了 UI 进程的名称列表。函数 getAttachedUIProcCount 用于获取已经附加的 UI 进程数，函数 getUIProcCount 用于获取 UI 进程数。

# [34/49] render.go

该文件为 SiYuan（思源笔记）中的一个 Go 语言源代码文件，包含多个函数用于渲染编辑器中的笔记内容。其中涉及到 Lute、ast、parse、html、render 等 Go 语言包，以及 SiYuan 自身定义的一些包和类型。具体函数如下：

1. renderOutline 函数：渲染大纲面板，将指定的 ast.Node 转换成大纲字符串。
2. renderBlockText 函数：将指定的 ast.Node 转换为一个字符串，该字符串包含了块中所有文本内容。
3. renderBlockDOMByNodes 函数：将指定的多个 ast.Node 转换为 HTML 字符创，这些 ast.Node 可以是同一个文档中的不同块。
4. renderBlockContentByNodes 函数：将指定的多个 ast.Node 转换为一个字符串，该字符串包含了这些 ast.Node 中所有文本内容。
5. renderBlockMarkdownR 函数：在渲染指定 ID 对应的块时，将该块中的块引用和嵌入 SQL 查询转换为对应的 Markdown 字符串，以便明文存储和分享。

# [35/49] repository.go

该程序文件是 model 的子模块文件夹 model 中的 repository.go 文件，代码如下：

函数代码包括：

1. OpenRepoSnapshotDoc；
2. LeftRightDiff 和 DiffFile；
3. parseTitleInSnapshot、parseTreeInSnapshot 和 buildSnapshots；
4. ImportRepoKey 和 ResetRepo；
5. InitRepoKeyFromPassphrase 和 InitRepoKey；
6. CheckoutRepo。

该文件中定义了许多的子函数，包括存储快照、数据同步、快照恢复，同时还有其他一些与快照或数据同步相关的函数。

# [36/49] search.go

本文介绍了程序文件 search.go 的作用。该文件定义了搜索相关的功能函数，包括全文搜索、查询语法、SQL 以及正则表达式等方法。

同时，还实现了嵌入块的搜索和替换功能，以及查找与引用块相关的块。本文件还包含处理块节点树的一些函数。

# [37/49] session.go

该文件为 SiYuan（私远笔记）的认证授权模块，定义了包括登出、登录、验证码、接口访问授权等功能函数。其中

• LoginAuth 函数为登录认证核心函数，对输入的验证码、认证码进行验证，若通过则将认证码写入 Session 并返回成功信息；
• LogoutAuth 函数为登出函数，从 Session 中移除 WorkspaceSession 信息；
• GetCaptcha 函数为生成验证码函数，生成验证码并将其存入 WorkspaceSession；
• CheckAuth 和 CheckReadonly 为接口访问授权和只读状态检查，分别需要登录认证和只读状态为 false 才可访问 API。

函数中还用到了第三方库 gin 和 steambap/captcha 等。

# [38/49] snippet.go

该程序文件实现了在思源笔记中加载、保存、删除代码片段的功能。其中，代码片段保存在 conf.json 文件中，并且实现了线程锁保证多个线程同时访问时的线程安全。

程序使用了 gulu、Lute、filelock、logging 等库来实现文件读写、日志输出、锁机制等操作。本文件遵循 GNU Affero General Public License 许可证。

# [39/49] storage.go

该程序文件是 SiYuan 笔记的模型模块的源代码。程序的主要作用是提供 SiYuan 笔记程序的模型方法，完成 SiYuan 笔记程序的搜索、文档编辑等功能。

具体方法包括：管理最近文档、文档搜索条件筛选、本地存储、读取。方法实现中使用了 sync 包实现了对最近文档、搜索条件、本地存储的互斥锁，保证数据的线程安全。

# [40/49] sync.go

该程序文件名为 sync.go，用于实现 SiYuan 的同步功能。程序实现了同步 SiYuan 笔记数据到云端和从云端同步数据到本地的功能，并提供了手动同步功能和自动同步功能。

实现手动同步需要在 UI 上进行操作，而自动同步功能可定时同步或在打开软件时进行同步操作。同时该程序还实现了删除云同步目录、创建云同步目录、列表云同步目录等一些对同步功能的基本操作。

# [41/49] tag.go

该程序文件名为 tag.go，主要包含了标签相关的功能函数。其中：

• RemoveTag (): 删除标签功能函数，会将所有该标签相关的文档和块中的标签删除。
• RenameTag (): 重命名标签功能函数，会将所有该标签相关的文档和块中的标签修改为新标签名称。
• BuildTags (): 构建所有标签树，返回一个 *Tags 类型的指针，用来表示最外层的所有标签。
• SearchTags (): 根据传入的关键字搜索标签，返回符合关键字的标签名称。
• labelBlocksByKeyword (): 根据关键字搜索所有包含该关键字的文档块，提取其中包含的标签，返回一个 map 类型，键为标签名称，值为包含该标签的所有文档块。
• labelTags (): 提取所有存在的标签名称，返回一个 map 类型，键为标签名称，值为空的 []*Tag 类型。
• sortTags (): 对标签进行排序。
• appendTagChildren () 和 appendChildren0 (): 用来将所有标签按照层级关系组织成树形结构。

该程序文件主要实现了标签的增删改查等常见功能，并能够将所有标签组织成树形结构以方便用户查看和管理标签。

# [42/49] template.go

文件名为 template.go，该程序文件包含了处理模板相关的函数和方法。其中

• RenderGoTemplate 函数用于渲染 Go 模板，
• RemoveTemplate 函数用于删除模板，
• SearchTemplate 函数用于搜索模板，
• DocSaveAsTemplate 函数用于将文档保存为模板，
• RenderTemplate 函数用于渲染模板，
• addBlockIALNodes 函数用于添加块级内联属性节点。

# [43/49] transaction.go

该程序文件是一个 Go 语言编写的模块，包含了 SiYuan 笔记系统的事务处理相关功能。

该模块主要负责实现 SiYuan 笔记系统中各种操作的事务处理，在每个操作执行之前，会将操作记录到队列中，随后统一进行事务提交。

其中的 FlushTxJob 函数用于触发事务提交任务，程序模块的主要函数包括 PerformTransactions 、 doMove 等一系列操作执行函数，这些函数主要用于操作的执行与相应的记录与撤销。此程序文件还包含了一些扩展功能的辅助函数，如函数 IsFoldHeading 用于判断操作是否为对折叠标题的操作，函数 waitforWritingFiles 用于等待文件写入操作完成等。

总之，该程序文件是 SiYuan 笔记系统的事务处理核心模块。

# [44/49] tree.go

该程序文件是一个 Go 语言编写的包 model，主要提供了加载笔记树内容、重置笔记树内容、对多个笔记进行分页等功能。其中

• LoadTreeByID 函数可以通过笔记树的 ID 来加载笔记树内容，如果找不到笔记树则返回 ErrTreeNotFound 错误，如果正在进行索引则返回 ErrIndexing 错误；
• loadTreeByBlockID 函数可以通过文档块的 ID 来加载笔记树，如果未找到文档块则返回 ErrBlockNotFound 错误。
• resetTree 函数可以重置笔记树的一些属性，如标题和路径，并重置块 ID 和内部引用。
• pagedPaths 函数可以对指定路径下的多个笔记进行分页。

# [45/49] updater.go

该文件名为 updater.go，位于 model 文件夹下。该程序主要实现了软件更新相关的功能，包括下载、安装、校验更新包等，实现了软件自动更新的功能。程序包含一些函数，主要包括：

1. execNewVerInstallPkg：执行下载的新版本安装包进行安装。
2. getNewVerInstallPkgPath：获取新版本安装包的路径。
3. checkDownloadInstallPkg：检查下载的安装包并进行下载安装。
4. getUpdatePkg：获取更新包的下载链接和 checksum 值。
5. downloadInstallPkg：下载并保存更新包。
6. sha256Hash：计算文件的 checksum 值。
7. Announcement 结构体：包含更新通知的 id、title 和 url 属性。
8. GetAnnouncements：获取更新通知。
9. CheckUpdate：检查更新并进行提示。

# [46/49] upload.go

该文件名为 upload.go，是一个 Go 语言的程序文件。该文件主要分为两个部分：

1. 函数 InsertLocalAssets

该函数的作用是将本地 assets 插入到该节点对应的目录下。函数的输入参数包括 id、assetPaths、isUpload。其中 id 代表节点 id，assetPaths 代表本地的 assets 路径，isUpload 代表是否是一个文件上传。该函数的输出参数包括 succMap，表示本次上传成功的文件列表，以及错误 err。

2. 函数 Upload

该函数的作用是上传文件。同时，如果有 id 参数，该函数将上传文件存储到该节点的目录下。如果没有 id 参数，则直接将文件存储到默认的 assets 目录下。该函数的输入参数包括 gin.Context 实例 c。该函数的输出参数包括 ret，表示该次上传的结果。

# [47/49] virutalref.go

该程序文件是一个 Go 语言编写的 SiYuan 文档编辑器中的模块，主要实现了处理虚拟引用的相关功能。具体包含以下功能模块：

• getBlockVirtualRefKeywords：获取块与虚拟引用有关的关键字，用于改进打开虚拟引用后加载文档的性能。
• putBlockVirtualRefKeywords：将虚拟引用关键字与块 ID 绑定，缓存到 virtualBlockRefCache 中。
• CacheVirtualBlockRefJob：缓存虚拟引用关键字到 virtualBlockRefCache 中，用于 globalSearch 中对虚拟引用的搜索。
• ResetVirtualBlockRefCache：清除 virtualBlockRefCache 中的缓存并重新缓存虚拟引用关键字。
• processVirtualRef：处理虚拟引用，将虚拟引用标记为可以替换的位置，并在需要的时候将其替换为实际的内容。
• getVirtualRefKeywords：获取虚拟引用的关键字，用于在 globalSearch 中对虚拟引用的搜索。
• prepareMarkKeywords：将给定的关键字列表进行去重、排序、标记处理。

总体来说，该程序文件是 SiYuan 文档编辑器中虚拟引用功能的一个实现，通过缓存与预处理等优化手段，提升了虚拟引用功能的性能表现。

# [48/49] widget.go

该文件名是 widget.go ，属于 model 包，里面定义了一个 SearchWidget 函数，用于搜索 widget 相关信息。

该函数接收一个 keyword 字符串作为参数，返回一个 Block 类型的切片。函数首先通过 filepath.Join 函数获取到 widget 目录的路径，然后通过 os.ReadDir 函数读取该目录下的所有文件和目录。接下来循环遍历所有的条目，如果该条目不是目录，则跳过，否则遍历该目录下的所有条目，如果不是目录且名称为 widget.json ，则将 isWidgetDir 设为 true ，表明该目录为 widget 目录。

然后将该目录名转为小写，并判断是否包含关键字，如果包含，则创建一个新的 Block 对象，将该目录名作为 Content 属性值，并加入到返回的切片中。最后返回所有匹配的 Block 切片。