Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

:bug: Preserve conflicting custom emojis during SY import https://github.com/siyuan-note/siyuan/issues/20386

Daniel6826713944ab
diff --git a/kernel/apicontract/import.go b/kernel/apicontract/import.go
index f1bbf79086..6480af6e72 100644
--- a/kernel/apicontract/import.go
+++ b/kernel/apicontract/import.go
@@ -14,6 +14,7 @@ type ImportDataRequest struct {
File *multipart.FileHeader `json:"file" api:"optional"`
}
+// ImportSYRequest 导入 .sy.zip,同名同内容的自定义表情复用;同名不同内容返回错误并保留已有文件。
type ImportSYRequest struct {
File *multipart.FileHeader `json:"file" api:"optional"`
Notebook string `json:"notebook" api:"optional"`
diff --git a/kernel/model/import.go b/kernel/model/import.go
index a6c0a3dd1a..ad1903b8fb 100644
--- a/kernel/model/import.go
+++ b/kernel/model/import.go
@@ -515,6 +515,9 @@ func importSY0(zipPath, boxID, toPath string, createNotebook, autoDetect bool, s
err = errors.New(Conf.Language(0))
return
}
+ if _, err = importEmojiFiles(unzipRootPath, true); err != nil {
+ return
+ }
if createNotebook {
if importedBoxConf != nil && importedBoxConf.Name != "" {
name = importedBoxConf.Name
@@ -1043,47 +1046,12 @@ func importSY0(zipPath, boxID, toPath string, createNotebook, autoDetect bool, s
// AV 定义已在 storage 删除前处理(加密笔记本DEK 加密拷到笔记本级,
// 普通 box 拷到全局 storage/av/),这里不再重复处理
- // 将包含的自定义表情统一移动到 data/emojis/ 下
- unzipRootEmojisPath := filepath.Join(unzipRootPath, "emojis")
- filelock.Walk(unzipRootEmojisPath, func(path string, d fs.DirEntry, err error) error {
- if err != nil {
- return err
- }
- if d == nil {
- return nil
- }
- if !util.IsValidExistingEmojiFileName(d.Name()) {
- emojiFullName := path
- fullPathFilteredName := filepath.Join(filepath.Dir(path), util.FilterUploadEmojiFileName(d.Name()))
- // XSS through emoji name https://github.com/siyuan-note/siyuan/issues/15034
- logging.LogWarnf("renaming invalid custom emoji file [%s] to [%s]", d.Name(), fullPathFilteredName)
- if removeErr := util.RenameEmojiFile(emojiFullName, fullPathFilteredName); nil != removeErr {
- logging.LogErrorf("renaming invalid custom emoji file to [%s] failed: %s", fullPathFilteredName, removeErr)
- }
- }
- return nil
- })
- var emojiDirs []string
- filelock.Walk(unzipRootPath, func(path string, d fs.DirEntry, err error) error {
- if err != nil {
- return err
- }
- if d == nil || unzipRootPath == path {
- return nil
- }
- if d.Name() == "emojis" && d.IsDir() {
- emojiDirs = append(emojiDirs, path)
- }
- return nil
- })
- dataEmojis := filepath.Join(util.DataDir, "emojis")
+ // 将包内表情复制到全局目录,冲突时不覆盖已有内容。
+ emojiDirs, err := importEmojiFiles(unzipRootPath, false)
+ if err != nil {
+ return
+ }
for _, emojis := range emojiDirs {
- if gulu.File.IsDir(emojis) {
- if err = filelock.Copy(emojis, dataEmojis); err != nil {
- logging.LogErrorf("copy emojis from [%s] to [%s] failed: %s", emojis, dataEmojis, err)
- return
- }
- }
os.RemoveAll(emojis)
}
diff --git a/kernel/model/import_emoji.go b/kernel/model/import_emoji.go
new file mode 100644
index 0000000000..005cf489d7
--- /dev/null
+++ b/kernel/model/import_emoji.go
@@ -0,0 +1,123 @@
+package model
+
+import (
+ "bytes"
+ "fmt"
+ "io/fs"
+ "os"
+ "path/filepath"
+ "strings"
+
+ "github.com/siyuan-note/filelock"
+ "github.com/siyuan-note/siyuan/kernel/util"
+)
+
+type importedEmojiFile struct {
+ source string
+ target string
+}
+
+// importEmojiFiles 预检或复制包内表情,相同内容复用已有文件,内容冲突时保留源和目标并返回错误。
+func importEmojiFiles(root string, checkOnly bool) (dirs []string, err error) {
+ var files []importedEmojiFile
+ err = filepath.WalkDir(root, func(p string, entry fs.DirEntry, walkErr error) error {
+ if walkErr != nil {
+ return walkErr
+ }
+ if p == root || !entry.IsDir() || entry.Name() != "emojis" {
+ return nil
+ }
+ dirs = append(dirs, p)
+ if err := filepath.WalkDir(p, func(source string, item fs.DirEntry, readErr error) error {
+ if readErr != nil {
+ return readErr
+ }
+ if item.IsDir() {
+ return nil
+ }
+ if !item.Type().IsRegular() {
+ return fmt.Errorf("import custom emoji [%s]: %w", source, fs.ErrInvalid)
+ }
+ relative, err := filepath.Rel(p, source)
+ if err != nil {
+ return err
+ }
+ parts := strings.Split(filepath.ToSlash(relative), "/")
+ for i, part := range parts {
+ if !util.IsValidExistingEmojiFileName(part) {
+ parts[i] = util.FilterUploadEmojiFileName(part)
+ }
+ }
+ files = append(files, importedEmojiFile{source: source, target: filepath.Join(util.DataDir, "emojis", filepath.Join(parts...))})
+ return nil
+ }); err != nil {
+ return err
+ }
+ return fs.SkipDir
+ })
+ if err != nil {
+ return
+ }
+ for _, file := range files {
+ if err = importEmojiFile(file.source, file.target, checkOnly); err != nil {
+ return
+ }
+ }
+ return
+}
+
+func existingImportedEmoji(target string, data []byte) (exists bool, err error) {
+ info, err := os.Lstat(target)
+ if os.IsNotExist(err) {
+ return false, nil
+ }
+ if err != nil {
+ return false, err
+ }
+ if !info.Mode().IsRegular() {
+ return true, fmt.Errorf("import custom emoji [%s]: %w", target, os.ErrExist)
+ }
+ existing, err := os.ReadFile(target)
+ if err != nil {
+ return true, err
+ }
+ if !bytes.Equal(existing, data) {
+ return true, fmt.Errorf("import custom emoji [%s]: different content: %w", target, os.ErrExist)
+ }
+ return true, nil
+}
+
+func importEmojiFile(source, target string, checkOnly bool) error {
+ data, err := filelock.ReadFile(source)
+ if err != nil {
+ return err
+ }
+ filelock.Lock(target)
+ defer filelock.Unlock(target)
+ if exists, err := existingImportedEmoji(target, data); err != nil || exists || checkOnly {
+ return err
+ }
+ if err = os.MkdirAll(filepath.Dir(target), 0755); err != nil {
+ return err
+ }
+ file, err := os.OpenFile(target, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0644)
+ if os.IsExist(err) {
+ if exists, checkErr := existingImportedEmoji(target, data); exists {
+ return checkErr
+ }
+ }
+ if err != nil {
+ return err
+ }
+ info, _ := file.Stat()
+ _, err = file.Write(data)
+ if closeErr := file.Close(); err == nil {
+ err = closeErr
+ }
+ if err != nil && info != nil {
+ if current, statErr := os.Lstat(target); statErr == nil && os.SameFile(info, current) {
+ _ = os.Remove(target)
+ }
+ }
+ return err
+}
diff --git a/kernel/model/import_emoji_test.go b/kernel/model/import_emoji_test.go
new file mode 100644
index 0000000000..10c0fbc46c
--- /dev/null
+++ b/kernel/model/import_emoji_test.go
@@ -0,0 +1,153 @@
+package model
+
+import (
+ "archive/zip"
+ "bytes"
+ "errors"
+ "os"
+ "path/filepath"
+ "testing"
+ "time"
+
+ "github.com/siyuan-note/siyuan/kernel/conf"
+ "github.com/siyuan-note/siyuan/kernel/util"
+)
+
+func TestImportSYEmojiConflictPreservesWorkspace(t *testing.T) {
+ boxID, docPath := setupUnusedAssetWorkspace(t)
+ boxConf := conf.NewBoxConf()
+ boxConf.Closed = false
+ if err := (&Box{ID: boxID}).SaveConf(boxConf); err != nil {
+ t.Fatal(err)
+ }
+ target := filepath.Join(util.DataDir, "emojis", "ok.png")
+ if err := os.MkdirAll(filepath.Dir(target), 0755); err != nil {
+ t.Fatal(err)
+ }
+ for _, p := range []string{target, docPath} {
+ if err := os.WriteFile(p, []byte("existing"), 0644); err != nil {
+ t.Fatal(err)
+ }
+ }
+ archivePath := filepath.Join(t.TempDir(), "document.sy.zip")
+ file, err := os.Create(archivePath)
+ if err != nil {
+ t.Fatal(err)
+ }
+ writer := zip.NewWriter(file)
+ for name, data := range map[string]string{
+ "Export/20260918000002-doc0002.sy": `{"Type":"NodeDocument","Spec":"5","ID":"20260918000002-doc0002"}`,
+ "Export/emojis/ok.png": "imported",
+ } {
+ entry, err := writer.Create(name)
+ if err != nil {
+ t.Fatal(err)
+ }
+ if _, err = entry.Write([]byte(data)); err != nil {
+ t.Fatal(err)
+ }
+ }
+ if err = writer.Close(); err != nil {
+ t.Fatal(err)
+ }
+ if err = file.Close(); err != nil {
+ t.Fatal(err)
+ }
+ original, err := os.ReadFile(archivePath)
+ if err != nil {
+ t.Fatal(err)
+ }
+ for i, importArchive := range []func() error{
+ func() error { return ImportSY(archivePath, boxID, "/") },
+ func() error { _, _, err := ImportSYAuto(archivePath, boxID, "/"); return err },
+ func() error { _, err := ImportSYNotebook(archivePath); return err },
+ func() error {
+ _, err := importSY0(archivePath, boxID, "/", true, false, map[string]string{}, true)
+ return err
+ },
+ } {
+ if err := importArchive(); !errors.Is(err, os.ErrExist) {
+ t.Fatalf("archive import %d did not report conflicting emoji: %v", i, err)
+ }
+ for _, p := range []string{target, docPath} {
+ if data, err := os.ReadFile(p); err != nil || string(data) != "existing" {
+ t.Fatalf("failed import changed %s: %q %v", p, data, err)
+ }
+ }
+ if data, err := os.ReadFile(archivePath); err != nil || !bytes.Equal(data, original) {
+ t.Fatalf("failed import changed source archive: %v", err)
+ }
+ }
+}
+
+func TestImportEmojiFilesPreservesConflictingContent(t *testing.T) {
+ previousData := util.DataDir
+ util.DataDir = filepath.Join(t.TempDir(), "data")
+ t.Cleanup(func() { util.DataDir = previousData })
+ root := t.TempDir()
+ source := filepath.Join(root, "notebook", "emojis", "ok.png")
+ target := filepath.Join(util.DataDir, "emojis", "ok.png")
+ for _, p := range []string{source, target} {
+ if err := os.MkdirAll(filepath.Dir(p), 0755); err != nil {
+ t.Fatal(err)
+ }
+ }
+ if err := os.WriteFile(source, []byte("imported"), 0644); err != nil {
+ t.Fatal(err)
+ }
+ if err := os.WriteFile(target, []byte("existing"), 0644); err != nil {
+ t.Fatal(err)
+ }
+ for _, checkOnly := range []bool{true, false} {
+ if _, err := importEmojiFiles(root, checkOnly); !errors.Is(err, os.ErrExist) {
+ t.Fatalf("different content was accepted: %v", err)
+ }
+ for p, want := range map[string]string{source: "imported", target: "existing"} {
+ if data, err := os.ReadFile(p); err != nil || string(data) != want {
+ t.Fatalf("conflict changed %s: %q %v", p, data, err)
+ }
+ }
+ }
+}
+
+func TestImportEmojiFilesReusesAndCopies(t *testing.T) {
+ previousData := util.DataDir
+ util.DataDir = filepath.Join(t.TempDir(), "data")
+ t.Cleanup(func() { util.DataDir = previousData })
+ root := t.TempDir()
+ sourceDir := filepath.Join(root, "emojis")
+ targetDir := filepath.Join(util.DataDir, "emojis")
+ for _, p := range []string{sourceDir, targetDir} {
+ if err := os.MkdirAll(p, 0755); err != nil {
+ t.Fatal(err)
+ }
+ }
+ for _, p := range []string{filepath.Join(sourceDir, "same.png"), filepath.Join(targetDir, "same.png")} {
+ if err := os.WriteFile(p, []byte("same"), 0644); err != nil {
+ t.Fatal(err)
+ }
+ }
+ target := filepath.Join(targetDir, "same.png")
+ modified := time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC)
+ if err := os.Chtimes(target, modified, modified); err != nil {
+ t.Fatal(err)
+ }
+ if err := os.WriteFile(filepath.Join(sourceDir, "new.png"), []byte("new"), 0644); err != nil {
+ t.Fatal(err)
+ }
+ if _, err := importEmojiFiles(root, true); err != nil {
+ t.Fatal(err)
+ }
+ if _, err := os.Stat(filepath.Join(targetDir, "new.png")); !os.IsNotExist(err) {
+ t.Fatalf("preflight copied a file: %v", err)
+ }
+ if _, err := importEmojiFiles(root, false); err != nil {
+ t.Fatal(err)
+ }
+ if info, err := os.Stat(target); err != nil || !info.ModTime().Equal(modified) {
+ t.Fatalf("identical emoji was rewritten: %v", err)
+ }
+ if data, err := os.ReadFile(filepath.Join(targetDir, "new.png")); err != nil || !bytes.Equal(data, []byte("new")) {
+ t.Fatalf("new emoji was not copied: %q %v", data, err)
+ }
+}