Skip to content

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

:recycle: Remove duplicated work in marketplace package installation

Jeffrey Chene4d64a4bccca
diff --git a/kernel/bazaar/install.go b/kernel/bazaar/install.go
index 51248658dc..2ab47d5098 100644
--- a/kernel/bazaar/install.go
+++ b/kernel/bazaar/install.go
@@ -98,16 +98,6 @@ func incPackageDownloads(repoURL, packageName, systemID string) {
}).Post(u)
}
-// packageManifestNames 各类型集市包清单文件名
-var packageManifestNames = func() map[string]string {
- // localPackageManifests 是清单文件名到包类型的映射,这里反转出包类型到清单文件名的映射
- names := make(map[string]string, len(localPackageManifests))
- for manifest, pkgType := range localPackageManifests {
- names[pkgType] = manifest
- }
- return names
-}()
-
// InstallPackageWithOptions 将在线包替换也纳入目标版本校验。
func InstallPackageWithOptions(repoURL, repoHash, repoRef, installPath, systemID, pkgType, packageName string, update bool, options PackageInstallOptions) (*PackageInstallResult, error) {
if err := options.check(); err != nil {
@@ -160,6 +150,10 @@ func installPackageWithOptions(data []byte, installPath, pkgType, packageName st
if err = options.check(); err != nil {
return
}
+ layout, ok := GetPackageLayout(pkgType)
+ if !ok {
+ return nil, errors.New("invalid marketplace package type")
+ }
// 非更新安装时目标目录已存在且非空则拒绝覆盖,防止把其他包的内容写入已有包目录
// https://github.com/siyuan-note/siyuan/security/advisories/GHSA-rpx2-p6hp-x5gj
if !update {
@@ -171,61 +165,49 @@ func installPackageWithOptions(data []byte, installPath, pkgType, packageName st
return nil, errors.New("marketplace package install path already exists")
}
}
-
- tmpPackage := filepath.Join(util.TempDir, "bazaar", "package")
- if options.PrivateTemp {
- tmpPackage = filepath.Join(installPrivateRoot(), "install-operations")
- if err = makePrivateInstallDir(tmpPackage); err != nil {
- return
- }
- } else if err = os.MkdirAll(tmpPackage, 0755); err != nil {
+ reader, err := zip.NewReader(bytes.NewReader(data), int64(len(data)))
+ if err != nil {
return
}
- unzipPath, err := os.MkdirTemp(tmpPackage, "online-")
- if err != nil {
+ packageTempPath := filepath.Join(util.TempDir, "bazaar", "package")
+ if err = os.MkdirAll(packageTempPath, 0755); err != nil {
return
}
- defer os.RemoveAll(unzipPath)
- reader, err := zip.NewReader(bytes.NewReader(data), int64(len(data)))
+ // 先在 temp 中解压并完成归档、路径和包名校验,data 下只接收已通过校验的内容
+ unpackPath, err := os.MkdirTemp(packageTempPath, "online-")
if err != nil {
return
}
- if err = extractLocalPackageReaderContext(options.context(), reader, unzipPath); err != nil {
+ defer os.RemoveAll(unpackPath)
+ if err = extractLocalPackageReaderContext(options.context(), reader, unpackPath); err != nil {
return
}
-
- dirs, err := os.ReadDir(unzipPath)
+ sourcePath, err := localPackageRoot(unpackPath)
if err != nil {
return
}
-
- srcPath := unzipPath
- if 1 == len(dirs) && dirs[0].IsDir() {
- srcPath = filepath.Join(unzipPath, dirs[0].Name())
- }
-
// 校验下载包自身声明的名称与请求安装的包名一致,防止把其他包的内容写入指定目录
// https://github.com/siyuan-note/siyuan/security/advisories/GHSA-rpx2-p6hp-x5gj
- jsonFileName, ok := packageManifestNames[pkgType]
- if !ok {
- return nil, errors.New("invalid marketplace package type")
+ if err = validateInstallPackageManifest(sourcePath, layout.Manifest, packageName); err != nil {
+ return
}
- manifestData, readErr := os.ReadFile(filepath.Join(srcPath, jsonFileName))
- if readErr != nil {
- return nil, errors.New("marketplace package manifest not found or invalid")
+ return replacePackageDirectoryWithOptions(sourcePath, installPath, update, options)
+}
+
+// validateInstallPackageManifest 校验包目录的清单声明与请求安装的包名一致。
+func validateInstallPackageManifest(sourcePath, manifestName, packageName string) error {
+ manifestData, err := os.ReadFile(filepath.Join(sourcePath, manifestName))
+ if err != nil {
+ return errors.New("marketplace package manifest not found or invalid")
}
- pkg, parseErr := parseInstallPackageManifest(manifestData)
- if parseErr != nil || nil == pkg {
- return nil, errors.New("marketplace package manifest not found or invalid")
+ pkg, err := parseInstallPackageManifest(manifestData)
+ if err != nil || nil == pkg {
+ return errors.New("marketplace package manifest not found or invalid")
}
if packageName != pkg.Name {
- return nil, fmt.Errorf("marketplace package name mismatch: expected [%s], got [%s]", packageName, pkg.Name)
+ return fmt.Errorf("marketplace package name mismatch: expected [%s], got [%s]", packageName, pkg.Name)
}
-
- if result, err = replacePackageDirectoryWithOptions(srcPath, installPath, update, options); err != nil {
- return
- }
- return
+ return nil
}
// replacePackageDirectory 将 sourcePath 整目录替换到 installPath。
@@ -236,45 +218,24 @@ func replacePackageDirectory(sourcePath, installPath string, update bool) error
return err
}
+// replacePackageDirectoryWithOptions 在安装锁外复制并核对 staging,锁内只做目标摘要校验与提交替换。
func replacePackageDirectoryWithOptions(sourcePath, installPath string, update bool, options PackageInstallOptions) (result *PackageInstallResult, err error) {
- if err = packageInstallLock.Acquire(options.context(), 1); err != nil {
- return nil, err
- }
- defer packageInstallLock.Release(1)
if err = options.check(); err != nil {
return nil, err
}
if err = validateInstalledRevision(options.ExpectedInstalledRevision); err != nil {
return
}
+ // 逐层拒绝链接后再创建操作目录,避免把内容写入连接目录
if err = rejectInstallPathLinks(installPath); err != nil {
return
}
- previousRevision, err := installedPackageRevision(installPath)
- if err != nil {
- return nil, err
- }
- if options.ExpectedInstalledRevision != "" && previousRevision != options.ExpectedInstalledRevision {
- return nil, ErrInstalledRevisionConflict
- }
- containsFile, statErr := PackageDirContainsFile(installPath)
- targetExists := statErr == nil
- if statErr != nil && !os.IsNotExist(statErr) {
- return nil, statErr
- }
- if targetExists && !update && containsFile {
- return nil, errors.New("marketplace package install path already exists")
- }
- if update && !targetExists {
- return nil, os.ErrNotExist
- }
- result = &PackageInstallResult{PreviousRevision: previousRevision}
if err = os.MkdirAll(filepath.Dir(installPath), 0755); err != nil {
return
}
operationPath, err := os.MkdirTemp(filepath.Dir(installPath), ".siyuan-package-install-")
if err != nil {
- return result, err
+ return nil, err
}
stagingPath := filepath.Join(operationPath, "staging")
backupPath := filepath.Join(operationPath, "backup")
@@ -284,47 +245,59 @@ func replacePackageDirectoryWithOptions(sourcePath, installPath string, update b
_ = os.RemoveAll(operationPath)
}
}()
- copiedRevision, err := copyInstallTree(sourcePath, stagingPath)
- if err != nil {
- return result, err
- }
- sourceRevision, err := installedPackageRevision(sourcePath)
+ copiedRevision, err := copyInstallTree(options.context(), sourcePath, stagingPath)
if err != nil {
- return result, err
+ return nil, err
}
+ // staging 位于本次操作独有的目录,锁外即可核对复制结果,失败也在进入临界区前返回
stagingRevision, err := installedPackageRevision(stagingPath)
if err != nil {
- return result, err
+ return nil, err
}
- if sourceRevision != copiedRevision || stagingRevision != copiedRevision {
- return result, ErrInstalledRevisionConflict
+ if stagingRevision == MissingInstalledRevision {
+ return nil, errors.New("marketplace package staging content is missing")
}
- currentRevision, err := installedPackageRevision(installPath)
- if err != nil {
- return result, err
+ if copiedRevision != stagingRevision {
+ return nil, ErrInstalledRevisionConflict
}
- if currentRevision != previousRevision {
- return result, ErrInstalledRevisionConflict
+ if err = options.check(); err != nil {
+ return nil, err
}
- if options.BeforeReplace != nil {
- if err = options.BeforeReplace(); err != nil {
- return
- }
+
+ if err = packageInstallLock.Acquire(options.context(), 1); err != nil {
+ return nil, err
+ }
+ defer packageInstallLock.Release(1)
+ if err = options.check(); err != nil {
+ return nil, err
}
- // 回调和复制均结束后再复核,线上与本地安装共享这一个实际替换段。
- currentRevision, err = installedPackageRevision(installPath)
+ previousRevision, err := installedPackageRevision(installPath)
if err != nil {
- return result, err
+ return nil, err
}
- if currentRevision != previousRevision {
- return result, ErrInstalledRevisionConflict
+ if options.ExpectedInstalledRevision != "" && previousRevision != options.ExpectedInstalledRevision {
+ return nil, ErrInstalledRevisionConflict
}
- finalStagingRevision, err := installedPackageRevision(stagingPath)
- if err != nil {
- return result, err
+ containsFile, statErr := PackageDirContainsFile(installPath)
+ targetExists := statErr == nil
+ if statErr != nil && !os.IsNotExist(statErr) {
+ return nil, statErr
}
- if finalStagingRevision != stagingRevision {
- return result, ErrInstalledRevisionConflict
+ if targetExists && !update && containsFile {
+ return nil, errors.New("marketplace package install path already exists")
+ }
+ if update && !targetExists {
+ return nil, os.ErrNotExist
+ }
+ result = &PackageInstallResult{PreviousRevision: previousRevision}
+ if options.BeforeReplace != nil {
+ if err = options.BeforeReplace(); err != nil {
+ return result, err
+ }
+ // 回调是锁内唯一执行外部代码的位置,只有存在回调时才复核两侧内容未被改动
+ if err = verifyInstallRevisions(installPath, previousRevision, stagingPath, stagingRevision); err != nil {
+ return result, err
+ }
}
// 最后一次取消和授权检查紧邻提交点;开始替换后必须完成提交或回滚并返回真实结果。
if err = options.check(); err != nil {
@@ -352,6 +325,25 @@ func replacePackageDirectoryWithOptions(sourcePath, installPath string, update b
return
}
+// verifyInstallRevisions 复核回调前后安装目标与 staging 的摘要都未变化。
+func verifyInstallRevisions(installPath, installRevision, stagingPath, stagingRevision string) error {
+ current, err := installedPackageRevision(installPath)
+ if err != nil {
+ return err
+ }
+ if current != installRevision {
+ return ErrInstalledRevisionConflict
+ }
+ current, err = installedPackageRevision(stagingPath)
+ if err != nil {
+ return err
+ }
+ if current != stagingRevision {
+ return ErrInstalledRevisionConflict
+ }
+ return nil
+}
+
// InstallLocalPackage 从已解压并验证的目录安装本地集市包。
func InstallLocalPackage(sourcePath, installPath, pkgType, packageName string, update bool) error {
_, err := InstallLocalPackageWithOptions(sourcePath, installPath, pkgType, packageName, update, PackageInstallOptions{})
diff --git a/kernel/bazaar/install_paths.go b/kernel/bazaar/install_paths.go
index d95d9b8ec4..6d68281e93 100644
--- a/kernel/bazaar/install_paths.go
+++ b/kernel/bazaar/install_paths.go
@@ -12,29 +12,37 @@ import (
"github.com/siyuan-note/siyuan/kernel/util"
)
-func installPrivateRoot() string {
- confDir := util.ConfDir
- if confDir == "" && filepath.IsAbs(util.DataDir) {
- confDir = filepath.Join(filepath.Dir(util.DataDir), "conf")
- }
- if confDir == "" {
- return ""
- }
- return filepath.Join(confDir, "plugin-development")
+// PackageLayout 描述一类集市包在文件系统中的安装布局。
+type PackageLayout struct {
+ BasePath string // 安装目录的父目录
+ Manifest string // 清单文件名
+ URLPath string // 前端访问该包目录的路径前缀
}
-// makePrivateInstallDir 拒绝工作空间内部的链接目录及非绝对根;已有目录同样逐层检查。
-func makePrivateInstallDir(root string) error {
- if !filepath.IsAbs(root) {
- return errors.New("private package operation root is unavailable")
- }
- if err := rejectInstallPathLinks(root); err != nil {
- return err
+// GetPackageLayout 集中维护包类型到安装目录、清单文件名和访问路径的映射。
+// 清单文件名始终由 localPackageManifests 反查,避免同一映射散落在多处。
+func GetPackageLayout(pkgType string) (layout PackageLayout, ok bool) {
+ var basePath, urlPath string
+ switch pkgType {
+ case "plugins":
+ basePath, urlPath = filepath.Join(util.DataDir, "plugins"), "/plugins/"
+ case "themes":
+ basePath, urlPath = util.ThemesPath, "/appearance/themes/"
+ case "icons":
+ basePath, urlPath = util.IconsPath, "/appearance/icons/"
+ case "templates":
+ basePath, urlPath = filepath.Join(util.DataDir, "templates"), "/templates/"
+ case "widgets":
+ basePath, urlPath = filepath.Join(util.DataDir, "widgets"), "/widgets/"
+ default:
+ return PackageLayout{}, false
}
- if err := os.MkdirAll(root, 0700); err != nil {
- return err
+ for manifest, packageType := range localPackageManifests {
+ if packageType == pkgType {
+ return PackageLayout{BasePath: basePath, Manifest: manifest, URLPath: urlPath}, true
+ }
}
- return rejectInstallPathLinks(root)
+ return PackageLayout{}, false
}
func rejectInstallPathLinks(target string) error {
diff --git a/kernel/bazaar/install_paths_windows_test.go b/kernel/bazaar/install_paths_windows_test.go
index 469bebeba8..ea11904aa0 100644
--- a/kernel/bazaar/install_paths_windows_test.go
+++ b/kernel/bazaar/install_paths_windows_test.go
@@ -36,9 +36,6 @@ func TestInstallPathsAllowWorkspaceJunctions(t *testing.T) {
}
util.ConfDir = filepath.Join(util.WorkspaceDir, "conf")
util.DataDir = filepath.Join(util.WorkspaceDir, "data")
- if err := makePrivateInstallDir(installPrivateRoot()); err != nil {
- t.Fatalf("private operation under workspace junction: %v", err)
- }
source := filepath.Join(realRoot, "source")
if err := os.Mkdir(source, 0755); err != nil {
t.Fatal(err)
diff --git a/kernel/bazaar/install_revision.go b/kernel/bazaar/install_revision.go
index c0dded220e..54bdaa2e4e 100644
--- a/kernel/bazaar/install_revision.go
+++ b/kernel/bazaar/install_revision.go
@@ -30,7 +30,6 @@ var (
// PackageInstallOptions 只由宿主安装服务构造,回调在共用安装锁内执行。
type PackageInstallOptions struct {
ExpectedInstalledRevision string
- PrivateTemp bool
BeforeReplace func() error
Context context.Context
Recheck func() error
@@ -258,11 +257,15 @@ func readInstallFileAt(root *os.Root, name string, expected fs.FileInfo, maxSize
return readInstallFile(file, expected, maxSize)
}
-func copyInstallTree(sourcePath, destination string) (string, error) {
+// copyInstallTree 按 visitInstallTree 的遍历顺序写入目标目录,并在每个文件前后响应取消。
+func copyInstallTree(ctx context.Context, sourcePath, destination string) (string, error) {
if err := os.Mkdir(destination, 0700); err != nil {
return "", err
}
return visitInstallTree(sourcePath, func(name string, info fs.FileInfo, data []byte) error {
+ if err := ctx.Err(); err != nil {
+ return err
+ }
target := filepath.Join(destination, filepath.FromSlash(name))
if info.IsDir() {
return os.Mkdir(target, 0755)
diff --git a/kernel/bazaar/install_revision_test.go b/kernel/bazaar/install_revision_test.go
index 21d8a3edd2..8d26b545b1 100644
--- a/kernel/bazaar/install_revision_test.go
+++ b/kernel/bazaar/install_revision_test.go
@@ -34,7 +34,7 @@ func useInstallRevisionFixture(t *testing.T) (source, target string) {
func installRevisionOptions(target string) PackageInstallOptions {
revision, _ := InstalledPackageRevision(target)
- return PackageInstallOptions{ExpectedInstalledRevision: revision, PrivateTemp: true}
+ return PackageInstallOptions{ExpectedInstalledRevision: revision}
}
func TestInstallRevisionConflictHasNoReplacement(t *testing.T) {
@@ -149,13 +149,17 @@ func TestInstallArchiveHashConsumesVerifiedSnapshot(t *testing.T) {
t.Fatal(err)
}
hash := fmt.Sprintf("%x", sha256.Sum256(data))
+ // 解压统一落在 temp,哈希不符时不应在其中留下任何内容
+ if err := os.MkdirAll(util.TempDir, 0755); err != nil {
+ t.Fatal(err)
+ }
_, _, _, _, cleanup, err := ExtractLocalPackageWithHash(archivePath, strings.Repeat("0", 64))
cleanup()
if !errors.Is(err, ErrPackageHashConflict) {
t.Fatalf("wrong archive hash was accepted: %v", err)
}
- if _, err := os.Stat(filepath.Join(installPrivateRoot(), "install-operations")); !os.IsNotExist(err) {
- t.Fatal("hash failure created extraction directory")
+ if entries, err := os.ReadDir(util.TempDir); err != nil || len(entries) != 0 {
+ t.Fatalf("hash failure created extraction directory: %#v, %v", entries, err)
}
_, _, source, gotHash, cleanup, err := ExtractLocalPackageWithHash(archivePath, hash)
if err != nil {
diff --git a/kernel/bazaar/install_staging_test.go b/kernel/bazaar/install_staging_test.go
new file mode 100644
index 0000000000..ba3acdbe67
--- /dev/null
+++ b/kernel/bazaar/install_staging_test.go
@@ -0,0 +1,100 @@
+// SiYuan - From thought to insight, with agents
+// Copyright (c) 2020-present, b3log.org
+// Licensed under the GNU Affero General Public License, version 3 or later.
+
+package bazaar
+
+import (
+ "os"
+ "path/filepath"
+ "testing"
+
+ "github.com/siyuan-note/siyuan/kernel/util"
+)
+
+// useInstallTempDir 把解压目录指向独立临时目录,避免写入工作空间 temp
+func useInstallTempDir(t *testing.T) {
+ t.Helper()
+ oldTempDir := util.TempDir
+ util.TempDir = t.TempDir()
+ t.Cleanup(func() { util.TempDir = oldTempDir })
+}
+
+// TestInstallPackageFlattensSingleTopLevelDirectory 校验归档带唯一顶层目录时安装的是包根内容
+func TestInstallPackageFlattensSingleTopLevelDirectory(t *testing.T) {
+ useInstallTempDir(t)
+ data := buildInstallPackageArchive(t, map[string]string{
+ "wrapper/plugin.json": `{"name":"sample","version":"1.0.0"}`,
+ "wrapper/index.js": "new",
+ "wrapper/i18n/en.json": `{}`,
+ })
+ installPath := filepath.Join(t.TempDir(), "plugins", "sample")
+ if err := installPackage(data, installPath, "plugins", "sample", false); err != nil {
+ t.Fatalf("expected wrapped archive to install: %s", err)
+ }
+ if _, err := os.Stat(filepath.Join(installPath, "index.js")); err != nil {
+ t.Fatalf("package root was not flattened: %s", err)
+ }
+ if _, err := os.Stat(filepath.Join(installPath, "wrapper")); !os.IsNotExist(err) {
+ t.Fatalf("wrapper directory reached the install path: %v", err)
+ }
+ entries, err := os.ReadDir(filepath.Dir(installPath))
+ if err != nil || len(entries) != 1 || entries[0].Name() != "sample" {
+ t.Fatalf("temporary installation directory was not cleaned up: %#v, %v", entries, err)
+ }
+}
+
+// TestInstallPackageValidatesBeforeTouchingInstallRoot 校验包名不符时不会在 data 下创建任何内容
+// https://github.com/siyuan-note/siyuan/security/advisories/GHSA-rpx2-p6hp-x5gj
+func TestInstallPackageValidatesBeforeTouchingInstallRoot(t *testing.T) {
+ useInstallTempDir(t)
+ installRoot := t.TempDir()
+ data := buildInstallPackageArchive(t, map[string]string{
+ "plugin.json": `{"name":"attacker-plugin","version":"1.0.0"}`,
+ "index.js": "malicious",
+ })
+ installPath := filepath.Join(installRoot, "plugins", "trusted-plugin")
+ if err := installPackage(data, installPath, "plugins", "trusted-plugin", false); err == nil {
+ t.Fatal("expected name mismatch to be rejected")
+ }
+ if _, err := os.Stat(filepath.Join(installRoot, "plugins")); !os.IsNotExist(err) {
+ t.Fatalf("rejected package reached the install root: %v", err)
+ }
+}
+
+// TestInstallPackageCleansTempExtraction 校验解压产生的临时目录在安装后被清理
+func TestInstallPackageCleansTempExtraction(t *testing.T) {
+ useInstallTempDir(t)
+ data := buildInstallPackageArchive(t, map[string]string{
+ "plugin.json": `{"name":"sample","version":"1.0.0"}`,
+ "index.js": "new",
+ })
+ installPath := filepath.Join(t.TempDir(), "plugins", "sample")
+ if err := installPackage(data, installPath, "plugins", "sample", false); err != nil {
+ t.Fatalf("expected fresh install to succeed: %s", err)
+ }
+ entries, err := os.ReadDir(filepath.Join(util.TempDir, "bazaar", "package"))
+ if err != nil {
+ t.Fatalf("read temp package root: %s", err)
+ }
+ if len(entries) != 0 {
+ t.Fatalf("temp extraction was retained: %#v", entries)
+ }
+}
+
+// TestPackageLayoutCoversAllManifests 校验包类型布局与清单映射保持单一来源
+func TestPackageLayoutCoversAllManifests(t *testing.T) {
+ for manifest, pkgType := range localPackageManifests {
+ layout, ok := GetPackageLayout(pkgType)
+ if !ok {
+ t.Fatalf("package type [%s] has no layout", pkgType)
+ }
+ // BasePath 依赖工作空间路径,测试环境可能为空;清单与访问路径必须始终可用
+ if layout.Manifest != manifest || layout.URLPath == "" {
+ t.Fatalf("layout of [%s] = %+v", pkgType, layout)
+ }
+ }
+ if _, ok := GetPackageLayout("unknown"); ok {
+ t.Fatal("unknown package type accepted")
+ }
+}
diff --git a/kernel/bazaar/install_test.go b/kernel/bazaar/install_test.go
index 6e5d381015..f710aa616d 100644
--- a/kernel/bazaar/install_test.go
+++ b/kernel/bazaar/install_test.go
@@ -24,8 +24,6 @@ import (
"path/filepath"
"testing"
"time"
-
- "github.com/siyuan-note/siyuan/kernel/util"
)
func TestIncPackageDownloadsIncludesPackageName(t *testing.T) {
@@ -53,10 +51,7 @@ func TestIncPackageDownloadsIncludesPackageName(t *testing.T) {
// TestInstallPackageNameMismatch 校验下载包声明的名称与请求安装的包名不一致时拒绝安装
// https://github.com/siyuan-note/siyuan/security/advisories/GHSA-rpx2-p6hp-x5gj
func TestInstallPackageNameMismatch(t *testing.T) {
- oldTempDir := util.TempDir
- util.TempDir = t.TempDir()
- t.Cleanup(func() { util.TempDir = oldTempDir })
-
+ useInstallTempDir(t)
installPath := filepath.Join(t.TempDir(), "plugins", "trusted-plugin")
if err := os.MkdirAll(installPath, 0755); err != nil {
t.Fatal(err)
@@ -85,10 +80,7 @@ func TestInstallPackageNameMismatch(t *testing.T) {
// TestInstallPackageRefusesOverwriteWithoutUpdate 校验非更新安装时拒绝覆盖非空目标目录
// https://github.com/siyuan-note/siyuan/security/advisories/GHSA-rpx2-p6hp-x5gj
func TestInstallPackageRefusesOverwriteWithoutUpdate(t *testing.T) {
- oldTempDir := util.TempDir
- util.TempDir = t.TempDir()
- t.Cleanup(func() { util.TempDir = oldTempDir })
-
+ useInstallTempDir(t)
installPath := filepath.Join(t.TempDir(), "plugins", "sample")
if err := os.MkdirAll(installPath, 0755); err != nil {
t.Fatal(err)
@@ -116,10 +108,7 @@ func TestInstallPackageRefusesOverwriteWithoutUpdate(t *testing.T) {
// TestInstallPackageUpdateReplacesDirectory 校验在线更新会整目录替换,新版本已删除的文件不会残留
// https://github.com/siyuan-note/siyuan/issues/18933
func TestInstallPackageUpdateReplacesDirectory(t *testing.T) {
- oldTempDir := util.TempDir
- util.TempDir = t.TempDir()
- t.Cleanup(func() { util.TempDir = oldTempDir })
-
+ useInstallTempDir(t)
installPath := filepath.Join(t.TempDir(), "plugins", "sample")
if err := os.MkdirAll(installPath, 0755); err != nil {
t.Fatal(err)
@@ -155,10 +144,7 @@ func TestInstallPackageUpdateReplacesDirectory(t *testing.T) {
// TestInstallPackageUpdateOverwrites 校验对同名已安装包的更新安装正常覆盖
func TestInstallPackageUpdateOverwrites(t *testing.T) {
- oldTempDir := util.TempDir
- util.TempDir = t.TempDir()
- t.Cleanup(func() { util.TempDir = oldTempDir })
-
+ useInstallTempDir(t)
installPath := filepath.Join(t.TempDir(), "plugins", "sample")
if err := os.MkdirAll(installPath, 0755); err != nil {
t.Fatal(err)
@@ -182,10 +168,7 @@ func TestInstallPackageUpdateOverwrites(t *testing.T) {
// TestInstallPackageFreshInstall 校验新安装写入目标目录
func TestInstallPackageFreshInstall(t *testing.T) {
- oldTempDir := util.TempDir
- util.TempDir = t.TempDir()
- t.Cleanup(func() { util.TempDir = oldTempDir })
-
+ useInstallTempDir(t)
installPath := filepath.Join(t.TempDir(), "plugins", "sample")
data := buildInstallPackageArchive(t, map[string]string{
"plugin.json": `{"name":"sample","version":"1.0.0"}`,
@@ -201,10 +184,7 @@ func TestInstallPackageFreshInstall(t *testing.T) {
// TestInstallPackageFreshInstallReplacesEmptyDirectoryTree 校验新安装可以替换仅包含空目录的目标目录
func TestInstallPackageFreshInstallReplacesEmptyDirectoryTree(t *testing.T) {
- oldTempDir := util.TempDir
- util.TempDir = t.TempDir()
- t.Cleanup(func() { util.TempDir = oldTempDir })
-
+ useInstallTempDir(t)
installPath := filepath.Join(t.TempDir(), "plugins", "sample")
if err := os.MkdirAll(filepath.Join(installPath, "i18n"), 0755); err != nil {
t.Fatal(err)
@@ -296,10 +276,7 @@ func TestReplacePackageDirectoryRefreshesFileTimes(t *testing.T) {
// TestInstallPackageMissingManifest 校验下载包缺少清单文件时拒绝安装
func TestInstallPackageMissingManifest(t *testing.T) {
- oldTempDir := util.TempDir
- util.TempDir = t.TempDir()
- t.Cleanup(func() { util.TempDir = oldTempDir })
-
+ useInstallTempDir(t)
installPath := filepath.Join(t.TempDir(), "plugins", "sample")
data := buildInstallPackageArchive(t, map[string]string{
"index.js": "new",
diff --git a/kernel/bazaar/local.go b/kernel/bazaar/local.go
index 508539e5e6..73c0029435 100644
--- a/kernel/bazaar/local.go
+++ b/kernel/bazaar/local.go
@@ -60,7 +60,7 @@ func IsValidPackageType(pkgType string) bool {
// ExtractLocalPackage 将本地集市包解压到临时目录并识别包类型。
func ExtractLocalPackage(archivePath string) (pkgType string, pkg *Package, packagePath string, cleanup func(), err error) {
- pkgType, pkg, packagePath, _, cleanup, err = extractLocalPackageWithHash(context.Background(), archivePath, "", false)
+ pkgType, pkg, packagePath, _, cleanup, err = extractLocalPackageWithHash(context.Background(), archivePath, "")
return
}
@@ -70,11 +70,12 @@ func ExtractLocalPackageWithHash(archivePath, expectedHash string) (pkgType stri
}
// ExtractLocalPackageWithHashContext 在核验与解压期间响应取消,未提交的临时内容会清理。
+// 解压始终落在 temp,校验通过后才由安装流程拷入 data。
func ExtractLocalPackageWithHashContext(ctx context.Context, archivePath, expectedHash string) (pkgType string, pkg *Package, packagePath, packageHash string, cleanup func(), err error) {
- return extractLocalPackageWithHash(ctx, archivePath, expectedHash, true)
+ return extractLocalPackageWithHash(ctx, archivePath, expectedHash)
}
-func extractLocalPackageWithHash(ctx context.Context, archivePath, expectedHash string, private bool) (pkgType string, pkg *Package, packagePath, packageHash string, cleanup func(), err error) {
+func extractLocalPackageWithHash(ctx context.Context, archivePath, expectedHash string) (pkgType string, pkg *Package, packagePath, packageHash string, cleanup func(), err error) {
cleanup = func() {}
if err = ctx.Err(); err != nil {
return
@@ -96,16 +97,6 @@ func extractLocalPackageWithHash(ctx context.Context, archivePath, expectedHash
return
}
tempPath := filepath.Join(util.TempDir, "bazaar", "local", gulu.Rand.String(7))
- if private {
- root := filepath.Join(installPrivateRoot(), "install-operations")
- if err = makePrivateInstallDir(root); err != nil {
- return
- }
- tempPath, err = os.MkdirTemp(root, "extract-")
- if err != nil {
- return
- }
- }
cleanup = func() { _ = os.RemoveAll(tempPath) }
reader, readerErr := zip.NewReader(bytes.NewReader(data), int64(len(data)))
if readerErr != nil {
@@ -157,10 +148,6 @@ func extractLocalPackageWithHash(ctx context.Context, archivePath, expectedHash
return
}
-func extractLocalPackageReader(reader *zip.Reader, destination string) error {
- return extractLocalPackageReaderContext(context.Background(), reader, destination)
-}
-
func extractLocalPackageReaderContext(ctx context.Context, reader *zip.Reader, destination string) error {
if err := ctx.Err(); err != nil {
return err
diff --git a/kernel/bazaar/local_test.go b/kernel/bazaar/local_test.go
index 651f0c31f9..f92c647554 100644
--- a/kernel/bazaar/local_test.go
+++ b/kernel/bazaar/local_test.go
@@ -27,6 +27,7 @@ import (
)
func TestExtractLocalPackage(t *testing.T) {
+ useInstallTempDir(t)
tests := []struct {
name string
files map[string]string
@@ -119,6 +120,7 @@ func TestExtractLocalPackage(t *testing.T) {
}
func TestExtractLocalPackageRejectsTraversal(t *testing.T) {
+ useInstallTempDir(t)
archivePath := filepath.Join(t.TempDir(), "package.zip")
writeLocalPackageArchive(t, archivePath, map[string]string{
"plugin.json": `{"name":"sample"}`,
@@ -134,6 +136,7 @@ func TestExtractLocalPackageRejectsTraversal(t *testing.T) {
}
func TestExtractLocalPackageRejectsSymlink(t *testing.T) {
+ useInstallTempDir(t)
archivePath := filepath.Join(t.TempDir(), "package.zip")
file, err := os.Create(archivePath)
if err != nil {
diff --git a/kernel/model/bazaar.go b/kernel/model/bazaar.go
index 6e18b9f0ee..f88886c26b 100644
--- a/kernel/model/bazaar.go
+++ b/kernel/model/bazaar.go
@@ -60,28 +60,17 @@ func getPackageInstallPath(pkgType, packageName string) (string, string, error)
return "", "", errors.New("invalid package name")
}
- var baseDir, jsonFileName string
- switch pkgType {
- case "plugins":
- baseDir, jsonFileName = filepath.Join(util.DataDir, "plugins"), "plugin.json"
- case "themes":
- baseDir, jsonFileName = util.ThemesPath, "theme.json"
- case "icons":
- baseDir, jsonFileName = util.IconsPath, "icon.json"
- case "templates":
- baseDir, jsonFileName = filepath.Join(util.DataDir, "templates"), "template.json"
- case "widgets":
- baseDir, jsonFileName = filepath.Join(util.DataDir, "widgets"), "widget.json"
- default:
+ layout, ok := bazaar.GetPackageLayout(pkgType)
+ if !ok {
logging.LogErrorf("invalid package type: %s", pkgType)
return "", "", errors.New("invalid package type")
}
- installPath := filepath.Join(baseDir, packageName)
- if !gulu.File.IsSubPath(baseDir, installPath) {
+ installPath := filepath.Join(layout.BasePath, packageName)
+ if !gulu.File.IsSubPath(layout.BasePath, installPath) {
return "", "", errors.New("invalid package name")
}
- return installPath, jsonFileName, nil
+ return installPath, layout.Manifest, nil
}
// installMeta 记录安装前后的状态,供安装后处理使用
@@ -283,23 +272,14 @@ func buildUpdatedPackages(installedPackages []*bazaar.Package, bazaarPackagesMap
// GetInstalledPackageInfos 获取本地集市包信息,并返回路径相关字段供调用方复用
func GetInstalledPackageInfos(pkgType string) (installedPackageInfos []installedPackageInfo, basePath, baseURLPathPrefix string, err error) {
- var jsonFileName string
- switch pkgType {
- case "plugins":
- basePath, jsonFileName, baseURLPathPrefix = filepath.Join(util.DataDir, "plugins"), "plugin.json", "/plugins/"
- case "themes":
- basePath, jsonFileName, baseURLPathPrefix = util.ThemesPath, "theme.json", "/appearance/themes/"
- case "icons":
- basePath, jsonFileName, baseURLPathPrefix = util.IconsPath, "icon.json", "/appearance/icons/"
- case "templates":
- basePath, jsonFileName, baseURLPathPrefix = filepath.Join(util.DataDir, "templates"), "template.json", "/templates/"
- case "widgets":
- basePath, jsonFileName, baseURLPathPrefix = filepath.Join(util.DataDir, "widgets"), "widget.json", "/widgets/"
- default:
+ layout, ok := bazaar.GetPackageLayout(pkgType)
+ if !ok {
logging.LogErrorf("invalid package type: %s", pkgType)
err = errors.New("invalid package type")
return
}
+ basePath, baseURLPathPrefix = layout.BasePath, layout.URLPath
+ jsonFileName := layout.Manifest
dirs, err := bazaar.ReadInstalledPackageDirs(basePath)
if err != nil {
@@ -576,7 +556,7 @@ func installBazaarPackageContext(ctx context.Context, pkgType, repoURL, repoHash
installedPkg, parseErr := bazaar.ParsePackageJSON(filepath.Join(installPath, jsonFileName))
meta.update = parseErr == nil && installedPkg != nil && installedPkg.Name == packageName
- options := bazaar.PackageInstallOptions{PrivateTemp: pkgType == "plugins", Context: ctx}
+ options := bazaar.PackageInstallOptions{Context: ctx}
_, err = bazaar.InstallPackageWithOptions(repoURL, repoHash, repoRef, installPath, Conf.System.Load().ID, pkgType, packageName, meta.update, options)
if err != nil {
err = fmt.Errorf(Conf.Language(46), packageName, err)