Something went wrong. Try again.
A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang. (PERSONAL FORK)
Something went wrong. Try again.
Go
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529// SiYuan - Refactor your thinking// 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 model
import ( "bytes" "errors" "fmt" "io/fs" "os" "path/filepath" "sort" "strings" "text/template"
"github.com/88250/gulu" "github.com/88250/lute/ast" "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/av" "github.com/siyuan-note/siyuan/kernel/filesys" "github.com/siyuan-note/siyuan/kernel/search" "github.com/siyuan-note/siyuan/kernel/sql" "github.com/siyuan-note/siyuan/kernel/treenode" "github.com/siyuan-note/siyuan/kernel/util" "github.com/xrash/smetrics")
func RenderGoTemplate(templateContent string) (ret string, err error) { tmpl := template.New("") tplFuncMap := filesys.BuiltInTemplateFuncs() sql.SQLTemplateFuncs(&tplFuncMap) tmpl = tmpl.Funcs(tplFuncMap) tpl, err := tmpl.Parse(templateContent) if err != nil { return "", errors.New(fmt.Sprintf(Conf.Language(44), err.Error())) }
buf := &bytes.Buffer{} buf.Grow(4096) err = tpl.Execute(buf, nil) if err != nil { return "", errors.New(fmt.Sprintf(Conf.Language(44), err.Error())) } ret = buf.String() return}
func RemoveTemplate(p string) (err error) { err = filelock.Remove(p) if err != nil { logging.LogErrorf("remove template failed: %s", err) } return}
func SearchTemplate(keyword string) (ret []*Block) { ret = []*Block{}
templates := filepath.Join(util.DataDir, "templates") if !util.IsPathRegularDirOrSymlinkDir(templates) { return }
groups, err := os.ReadDir(templates) if err != nil { logging.LogErrorf("read templates failed: %s", err) return }
sort.Slice(ret, func(i, j int) bool { return util.PinYinCompare(filepath.Base(groups[i].Name()), filepath.Base(groups[j].Name())) })
keyword = strings.TrimSpace(keyword) type result struct { block *Block score float64 } var results []*result keywords := strings.Fields(keyword) for _, group := range groups { if strings.HasPrefix(group.Name(), ".") { continue }
if group.IsDir() { templateDir := filepath.Join(templates, group.Name()) filelock.Walk(templateDir, func(path string, d fs.DirEntry, err error) error { name := strings.ToLower(d.Name()) if strings.HasPrefix(name, ".") { if d.IsDir() { return filepath.SkipDir } return nil }
if !strings.HasSuffix(name, ".md") || strings.HasPrefix(name, "readme") { return nil }
content := strings.TrimPrefix(path, templates) content = strings.TrimSuffix(content, ".md") p := filepath.Join(group.Name(), content) score := 0.0 hit := true for _, k := range keywords { if strings.Contains(strings.ToLower(p), strings.ToLower(k)) { score += smetrics.JaroWinkler(name, k, 0.7, 4) } else { hit = false break } } if hit { content = strings.TrimPrefix(path, templates) content = strings.TrimSuffix(content, ".md") content = filepath.ToSlash(content) _, content = search.MarkText(content, strings.Join(keywords, search.TermSep), 32, Conf.Search.CaseSensitive) b := &Block{Path: path, Content: content} results = append(results, &result{block: b, score: score}) } return nil }) } else { name := strings.ToLower(group.Name()) if strings.HasPrefix(name, ".") || !strings.HasSuffix(name, ".md") || "readme.md" == name { continue }
content := group.Name() content = strings.TrimSuffix(content, ".md") score := 0.0 hit := true for _, k := range keywords { if strings.Contains(strings.ToLower(content), strings.ToLower(k)) { score += smetrics.JaroWinkler(name, k, 0.7, 4) } else { hit = false break } } if hit { content = filepath.ToSlash(content) _, content = search.MarkText(content, strings.Join(keywords, search.TermSep), 32, Conf.Search.CaseSensitive) b := &Block{Path: filepath.Join(templates, group.Name()), Content: content} results = append(results, &result{block: b, score: score}) } } }
sort.Slice(results, func(i, j int) bool { return results[i].score > results[j].score }) for _, r := range results { ret = append(ret, r.block) } return}
func DocSaveAsTemplate(id, name string, overwrite bool) (code int, err error) { bt := treenode.GetBlockTree(id) if nil == bt { return }
tree := prepareExportTree(bt) addBlockIALNodes(tree, true)
ast.Walk(tree.Root, func(n *ast.Node, entering bool) ast.WalkStatus { if !entering { return ast.WalkContinue }
// Content in templates is not properly escaped // https://github.com/siyuan-note/siyuan/issues/9649 // https://github.com/siyuan-note/siyuan/issues/13701 switch n.Type { case ast.NodeCodeBlockCode: n.Tokens = bytes.ReplaceAll(n.Tokens, []byte("""), []byte("\"")) case ast.NodeCodeSpanContent: n.Tokens = bytes.ReplaceAll(n.Tokens, []byte("""), []byte("\"")) case ast.NodeBlockQueryEmbedScript: n.Tokens = bytes.ReplaceAll(n.Tokens, []byte("""), []byte("\"")) case ast.NodeTextMark: if n.IsTextMarkType("code") { n.TextMarkTextContent = strings.ReplaceAll(n.TextMarkTextContent, """, "\"") } } return ast.WalkContinue })
var unlinks []*ast.Node ast.Walk(tree.Root, func(n *ast.Node, entering bool) ast.WalkStatus { if !entering { return ast.WalkContinue }
if ast.NodeCodeBlockFenceInfoMarker == n.Type { if lang := string(n.CodeBlockInfo); "siyuan-template" == lang || "template" == lang { // 将模板代码转换为段落文本 https://github.com/siyuan-note/siyuan/pull/15345 unlinks = append(unlinks, n.Parent) p := treenode.NewParagraph(n.Parent.ID) // 代码块内可能会有多个空行，但是这里不需要分块处理，后面渲染一个文本节点即可 p.AppendChild(&ast.Node{Type: ast.NodeText, Tokens: n.Next.Tokens}) n.Parent.InsertBefore(p) } } return ast.WalkContinue }) for _, n := range unlinks { n.Unlink() }
luteEngine := NewLute() formatRenderer := render.NewFormatRenderer(tree, luteEngine.RenderOptions, luteEngine.ParseOptions) md := formatRenderer.Render()
// 单独渲染根节点的 IAL if 0 < len(tree.Root.KramdownIAL) { // 把 docIAL 中的 id 调整到第一个 tree.Root.RemoveIALAttr("id") tree.Root.KramdownIAL = append([][]string{{"id", tree.Root.ID}}, tree.Root.KramdownIAL...) md = append(md, []byte("\n")...) md = append(md, parse.IAL2Tokens(tree.Root.KramdownIAL)...) }
name = util.FilterFileName(name) + ".md" name = util.TruncateLenFileName(name) savePath := filepath.Join(util.DataDir, "templates", name) if filelock.IsExist(savePath) { if !overwrite { code = 1 return } }
err = filelock.WriteFile(savePath, md) return}
func RenderDynamicIconContentTemplate(content, id string) (ret string) { tree, err := LoadTreeByBlockID(id) if err != nil { return }
node := treenode.GetNodeInTree(tree, id) if nil == node { return } block := sql.BuildBlockFromNode(node, tree) if nil == block { return }
dataModel := map[string]string{} title := block.Name if "d" == block.Type { title = block.Content } dataModel["title"] = title dataModel["id"] = block.ID dataModel["name"] = block.Name dataModel["alias"] = block.Alias
goTpl := template.New("").Delims(".action{", "}") tplFuncMap := filesys.BuiltInTemplateFuncs() sql.SQLTemplateFuncs(&tplFuncMap) goTpl = goTpl.Funcs(tplFuncMap) tpl, err := goTpl.Funcs(tplFuncMap).Parse(content) if err != nil { err = errors.New(fmt.Sprintf(Conf.Language(44), err.Error())) return }
buf := &bytes.Buffer{} buf.Grow(4096) if err = tpl.Execute(buf, dataModel); err != nil { err = errors.New(fmt.Sprintf(Conf.Language(44), err.Error())) return } ret = buf.String() return}
func RenderTemplate(p, id string, preview bool) (tree *parse.Tree, dom string, err error) { tree, err = LoadTreeByBlockID(id) if err != nil { return }
node := treenode.GetNodeInTree(tree, id) if nil == node { err = ErrBlockNotFound return } block := sql.BuildBlockFromNode(node, tree) md, err := os.ReadFile(p) if err != nil { return }
dataModel := map[string]string{} var titleVar string if nil != block { titleVar = block.Name if "d" == block.Type { titleVar = block.Content } dataModel["title"] = titleVar dataModel["id"] = block.ID dataModel["name"] = block.Name dataModel["alias"] = block.Alias }
goTpl := template.New("").Delims(".action{", "}") tplFuncMap := filesys.BuiltInTemplateFuncs() sql.SQLTemplateFuncs(&tplFuncMap) goTpl = goTpl.Funcs(tplFuncMap) tpl, err := goTpl.Funcs(tplFuncMap).Parse(gulu.Str.FromBytes(md)) if err != nil { err = errors.New(fmt.Sprintf(Conf.Language(44), err.Error())) return }
buf := &bytes.Buffer{} buf.Grow(4096) if err = tpl.Execute(buf, dataModel); err != nil { err = errors.New(fmt.Sprintf(Conf.Language(44), err.Error())) return } md = buf.Bytes() tree = parseKTree(md) if nil == tree { msg := fmt.Sprintf("parse tree [%s] failed", p) logging.LogErrorf(msg) err = errors.New(msg) return }
var nodesNeedAppendChild, unlinks []*ast.Node ast.Walk(tree.Root, func(n *ast.Node, entering bool) ast.WalkStatus { if !entering { return ast.WalkContinue }
if "" != n.ID { // 重新生成 ID n.ID = ast.NewNodeID() n.SetIALAttr("id", n.ID) n.RemoveIALAttr(av.NodeAttrNameAvs)
// Blocks created via template update time earlier than creation time https://github.com/siyuan-note/siyuan/issues/8607 refreshUpdated(n) }
if (ast.NodeListItem == n.Type && (nil == n.FirstChild || (3 == n.ListData.Typ && (nil == n.FirstChild.Next || ast.NodeKramdownBlockIAL == n.FirstChild.Next.Type)))) || (ast.NodeBlockquote == n.Type && nil != n.FirstChild && nil != n.FirstChild.Next && ast.NodeKramdownBlockIAL == n.FirstChild.Next.Type) || (ast.NodeCallout == n.Type && nil != n.FirstChild && ast.NodeKramdownBlockIAL == n.FirstChild.Type) { nodesNeedAppendChild = append(nodesNeedAppendChild, n) }
if n.IsTextMarkType("block-ref") { if refText := n.Text(); "" == refText { refText = strings.TrimSpace(sql.GetRefText(n.TextMarkBlockRefID)) if "" != refText { treenode.SetDynamicBlockRefText(n, refText) } else { unlinks = append(unlinks, n) } } } else if ast.NodeBlockRef == n.Type { if refText := n.Text(); "" == refText { if refID := n.ChildByType(ast.NodeBlockRefID); nil != refID { refText = strings.TrimSpace(sql.GetRefText(refID.TokensStr())) if "" != refText { treenode.SetDynamicBlockRefText(n, refText) } else { unlinks = append(unlinks, n) } } } } else if n.IsTextMarkType("inline-math") { if n.ParentIs(ast.NodeTableCell) { // 表格中的公式中带有管道符时使用 HTML 实体替换管道符 Improve the handling of inline-math containing `|` in the table https://github.com/siyuan-note/siyuan/issues/9227 n.TextMarkInlineMathContent = strings.ReplaceAll(n.TextMarkInlineMathContent, "|", "|") } }
if ast.NodeAttributeView == n.Type { // 重新生成数据库视图 attrView, parseErr := av.ParseAttributeView(n.AttributeViewID) if nil != parseErr { logging.LogErrorf("parse attribute view [%s] failed: %s", n.AttributeViewID, parseErr) } else { cloned := attrView.Clone() if nil == cloned { logging.LogErrorf("clone attribute view [%s] failed", n.AttributeViewID) return ast.WalkContinue }
n.AttributeViewID = cloned.ID if !preview { // 非预览时持久化数据库 if saveErr := av.SaveAttributeView(cloned); nil != saveErr { logging.LogErrorf("save attribute view [%s] failed: %s", cloned.ID, saveErr) } } else { // 预览时使用简单表格渲染 viewID := n.IALAttr(av.NodeAttrView) view, getErr := attrView.GetCurrentView(viewID) if nil != getErr { logging.LogErrorf("get attribute view [%s] failed: %s", n.AttributeViewID, getErr) return ast.WalkContinue }
table := getAttrViewTable(attrView, view, "")
var aligns []int for range table.Columns { aligns = append(aligns, 0) } mdTable := &ast.Node{Type: ast.NodeTable, TableAligns: aligns} mdTableHead := &ast.Node{Type: ast.NodeTableHead} mdTable.AppendChild(mdTableHead) mdTableHeadRow := &ast.Node{Type: ast.NodeTableRow, TableAligns: aligns} mdTableHead.AppendChild(mdTableHeadRow) for _, col := range table.Columns { cell := &ast.Node{Type: ast.NodeTableCell} cell.AppendChild(&ast.Node{Type: ast.NodeText, Tokens: []byte(col.Name)}) mdTableHeadRow.AppendChild(cell) }
n.InsertBefore(mdTable) unlinks = append(unlinks, n) } } }
return ast.WalkContinue }) for _, n := range nodesNeedAppendChild { if ast.NodeBlockquote == n.Type { n.FirstChild.InsertAfter(treenode.NewParagraph("")) } else { n.AppendChild(treenode.NewParagraph("")) } } for _, n := range unlinks { n.Unlink() }
// 折叠标题导出为模板后使用会出现内容重复 https://github.com/siyuan-note/siyuan/issues/4488 ast.Walk(tree.Root, func(n *ast.Node, entering bool) ast.WalkStatus { if !entering { return ast.WalkContinue }
if "1" == n.IALAttr("heading-fold") { // 为标题折叠下方块添加属性，前端渲染以后会统一做移除处理 n.SetIALAttr("status", "temp") } return ast.WalkContinue })
icon := tree.Root.IALAttr("icon") if "" != icon { // 动态图标需要反转义 https://github.com/siyuan-note/siyuan/issues/13211 icon = util.UnescapeHTML(icon) tree.Root.SetIALAttr("icon", icon) }
luteEngine := NewLute() dom = luteEngine.Tree2BlockDOM(tree, luteEngine.RenderOptions, luteEngine.ParseOptions) return}
func addBlockIALNodes(tree *parse.Tree, removeUpdated bool) { var blocks []*ast.Node ast.Walk(tree.Root, func(n *ast.Node, entering bool) ast.WalkStatus { if !entering || !n.IsBlock() { return ast.WalkContinue }
if ast.NodeBlockQueryEmbed == n.Type { if script := n.ChildByType(ast.NodeBlockQueryEmbedScript); nil != script { script.Tokens = bytes.ReplaceAll(script.Tokens, []byte("\n"), []byte(" ")) } } else if ast.NodeHTMLBlock == n.Type { n.Tokens = bytes.TrimSpace(n.Tokens) // 使用 <div> 包裹，否则后续解析时会识别为行级 HTML https://github.com/siyuan-note/siyuan/issues/4244 if !bytes.HasPrefix(n.Tokens, []byte("<div>")) { n.Tokens = append([]byte("<div>\n"), n.Tokens...) } if !bytes.HasSuffix(n.Tokens, []byte("</div>")) { n.Tokens = append(n.Tokens, []byte("\n</div>")...) } }
if removeUpdated { n.RemoveIALAttr("updated") } if 0 < len(n.KramdownIAL) { blocks = append(blocks, n) } return ast.WalkContinue }) for _, block := range blocks { block.InsertAfter(&ast.Node{Type: ast.NodeKramdownBlockIAL, Tokens: parse.IAL2Tokens(block.KramdownIAL)}) }}