mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-09-30 22:26:38 +08:00
dbaa3bf140
docs(changelog): 修正表述笔误
refactor(cordis): 磁盘缓存改用上上游能力并清理本地副本
按上游/下游归属规约:类型断言守卫已回流 Wavelet(f3d85d5,附回归用例),
本仓库删除 OpenFlare/plugins/server/pkg/cache 整包并改 import 到
Wavelet/pkg/cache/disk,同步后与上游零漂移。
验证:go build 通过;go test ./... exit 0(137 包 ok);256 条路由对拍与
232 条 swagger 操作均零差异;make build-all 四进制;前端零改动。
docs(cordis): 记录 T1 清理结果与五个复用阻塞点
refactor(cordis): server 复用上游 pkg 能力并删除等价本地副本
按上游/下游归属规约清理重复实现,删除 7 个与上游等价的本地包并改 import:
shared/response→pkg/response、pkg/{logger,mail,trace,httppool,cache/ram}→
上游同名包、infra/persistence/batchwriter→pkg/batchwriter。逐项核过差异:
httppool 逐字节相同;logger 的 Config 字段完全一致;response 的 7 个 Abort*
一致;cache/ram 换过去顺带把裸 go 变回带 panic 恢复的 util.Go。
两处非等价差异按语义处理:
- batchwriter.Stats 与 status DTO 原为类型别名,改为消费侧逐字段转换,
避免 model 反向依赖基础设施类型;
- 上游 pkg/idgen 要求显式 Init(本地副本为懒加载自动初始化),本次保留本地
副本,待与 infra 初始化一并迁移(已登记在清理计划)。
验证:go build 通过;go test ./... exit 0(138 包 ok);256 条路由对拍零差异;
make swagger 232 条操作零增减,且归一化后与旧文档深度相等——差异仅为
response.Any / logger.LogEntry 两个定义名随包路径改名,接口形状未变。
chore(cordis): 回流内核与 pkg/util 通用能力并清理 vendoring 污染
按新增的上游/下游归属规约:HandleRaw/BasePath 与版本比较、网络、格式化助手
属通用能力,已提交到 Wavelet 分支 feat/cordis-router-raw-routes,本仓库改为
纯同步获取(pkg/util 已零漂移),补丁登记保留至上游合并。
同时修掉我此前 git add -A 造成的污染:首次 vendoring 把上游工作区里被
gitignore 的运行期产物一起提交进来(upload 的 diskcache 缓存块 650 个与
driver_http/dist 前端构建物 380 个,共 12872 行/1030 文件)。sync-upstream.sh
现显式排除 uploads/dist/data/*.db,.gitignore 补上对应兜底规则。
AGENTS.md 增加上游/下游改动归属规约,并把仍指向前 Cordis 布局的硬性约束
(internal/router + Serve、internal/repository/logstore、internal/platform/bootstrap、
internal/cmd)改到当前插件路径。
验证:go build 通过;go test ./... exit 0(144 包 ok);make swagger 232 条
操作与基线逐条一致;make build-all 四进制;gofmt 干净。
feat(cordis): server 插件化并改由内核挂载控制面路由
新增 plugins/server/plugin.go:Apply 以 ctx.Router().Group(app.api_prefix)
声明根级与 /v1 全部路由;33 个注册函数由 *gin.RouterGroup 改为
core.RouterExtension,RegisterCollection 改用内核新增的 HandleRaw 保留
尾部斜杠变体,AdminMiddlewares 返回 []any(Go 不允许把 []T 展开为 ...any)。
删除 router.Serve 与 registerRoutes,装配根改为 core.App +
driver_http.New(WithEngine(router.BuildEngine())),监听、信号与优雅退出归内核;
前端 SPA 的 NoRoute 兜底因内核暂无贡献点而保留在引擎层。
路由保真证据:plugin_parity_test 对拍 baseline/routes-engine.txt 的 256 条
(方法 路径) 零差异;go test ./... exit 0(144 包 ok,含真实 handler 的
openflare/integration 用例走同一条挂载路径);make swagger 232 条操作与基线
逐条一致;golangci-lint 0 issues;make build-all 四进制;embed_frontend
标签编译通过;前端零改动。
已知待补:带 Redis 的实机 HTTP 冒烟(本机 6379 未启动,session store 与
改造前一样在建店阶段即 fatal),以及 bootstrap 的任务/设置/迁移注册迁入 Apply。
feat(core): RouterExtension 增加 HandleRaw 与 BasePath 以保真尾部斜杠路由
server 插件化的前置:Handle 经 cleanPath 会剥掉尾部斜杠,无法表达
/resource 与 /resource/ 两条不同路由,而 OpenFlare 有 20 个历史 list
端点两者都注册且部署关闭了 RedirectTrailingSlash,缺失即 404。新增
HandleRaw 与 BasePath(作用域包装器同样登记反注册),补 extpoints 用例;
并把 router.Serve 拆出 BuildEngine 以便交给 driver_http.WithEngine 复用,
新增路由表导出 harness,固化 256 条 (方法 路径) 基线供插件化对拍。
上游补丁登记于 backend/OpenFlare/upstream-patches.md,同步脚本改为按目录
前缀输出差异并在同步后提醒确认补丁是否仍在。
验证:go build 通过;go test ./... exit 0(143 包 ok);gofmt 干净。
docs(cordis): 记录 server 插件接入内核的可行路径与内核能力缺口
feat(cordis): agent/relay/flared 落地为内核驱动插件
三个边缘守护进程各新增 plugin.go,实现 core.Plugin + core.Driver
(自定义 DriverType 与同名 profile),装配与生命周期从 main 迁入
Apply/Start/Stop:Apply 负责 JSON 配置加载、运行环境与用户确保、
openresty/frps/frpc 管理器与各服务装配;Start 以 util.Go 拉起阻塞式
runner 与 GeoIP 周期更新;Stop 收敛主循环结果并在超时时报错而非静默。
入口改为 core.NewApp(core.WithProfile(...)) + Prepare/Run,保持
-config 旗标、默认路径、退出码与启动/停止日志不变。
验证:go build 通过;go test ./... exit 0(143 包 ok,含 3 个插件身份
与配置失败路径测试);make build-all 四进制产出;三进制实跑缺失配置
均 exit 1 且错误链保留 load {agent,relay,flared} config 原因;gofmt 干净。
refactor(cordis): 按功能职责拆分为 4 个插件与 share 共享层
backend/OpenFlare 不再平铺遗留分层,改为 plugins/{server,agent,relay,flared}
加 share/:控制面业务(openflare/admin/oauth/user/upload/cap/config/health 与
repository/model/infra/router 等支撑层)归 server;三个边缘守护进程各自成插件;
被两个以上插件消费的 protocol/geoip/wsclient/render/pagesarchive/edge 归 share。
同时把 pkg/util 与 buildinfo 合并回上游 pkg(上游已覆盖全部符号,仅 8 个函数与
2 个类型为 OpenFlare 独有,已一并迁入),装配根统一到 backend/cmd(含三个 daemon
入口),Dockerfile 与 release 工作流的构建路径和 -X 注入路径同步更新。
验证:go build 通过;go test ./... exit 0(141 包 ok);make swagger exit 0 且
232 条 API 操作与基线逐条一致;make build-all 产出 4 进制;-X 注入经二进制
strings 实测生效;日志后端直连门禁改写为按 server 插件业务域扫描并在扫描数为 0
时报错(防门禁静默失效);前端零改动。
feat(cordis): 落地 backend/share 共享层与上游同步脚本
跨插件共享资源(控制消息协议、GeoIP+iputil、边缘守护进程日志)从下游包
移入 backend/share,并声明其只能依赖 core/pkg 与标准/第三方库,禁止反向
引用下游业务与具体插件实现;新增 scripts/sync-upstream.sh 只覆盖
backend/{core,pkg,plugins},同步后 --check 报告零差异,证明与上游逐字一致。
go build 通过,go test ./... exit 0(142 包 ok),前端零改动。
refactor(cordis): 采用与 Wavelet 同构的单模块布局并引入上游内核
按上游结构落位:backend/{core,pkg,plugins} 为 Wavelet 上游拷贝,OpenFlare
全部业务收拢到上游 downstream 所对应的位置 backend/OpenFlare/,模块名保持
Wavelet 以保证上游 import 路径逐字一致、同步零改写;三个 daemon 入口移至
backend/OpenFlare/cmd,backend/cmd 与 main.go 作为控制面装配根。
行为不变:go build 通过,142 个测试包全绿(含上游插件测试),232 条 API
操作与改造前逐条一致,四进制产物正常,前端零改动。swagger 暂只扫描下游代码,
待 P4 挂载上游路由后再纳入 plugins/。
style: 修正模块路径改写导致的 import 分组排序漂移
refactor(layout): Go 代码迁入 backend/ 并将模块名简化为 OpenFlare
对齐上游 Wavelet 的仓库布局,为以第二 module 形态 vendoring Cordis 内核与
平台插件做准备:模块路径整体改写为 OpenFlare,Go 目标加 cd backend,
swaggo 产物移至 backend/docs 并把 json/yaml 复制回 docs/ 供站点消费,
Dockerfile 与 release 工作流的构建目录、ldflags 模块路径同步更新。
行为保持不变:232 条路由与改造前逐条一致,95 个测试包全绿,
四进制产物正常,前端零改动。
chore(cordis): 落地改造计划与 schema/路由基线
新增 legacy_dump_test 迁移快照 harness:在临时 sqlite 库上按生产顺序
(goose.UpTo → zone 导入 → goose.Up)跑完 76 个历史迁移并导出 schema 与
版本序列,作为改造前后一致性门禁的唯一事实来源。同时记录 232 条路由清单
与 foundation 实施计划。
docs(cordis): add OpenFlare Cordis 架构改造设计
明确上游以第二 module 形态 vendoring 进 backend/Wavelet、4 个插件
(server/agent/relay/flared) 全部装载内核,并规定保留 76 个历史 goose
迁移 + 一次性版本 stamp 桥接的迁移方案,配套三方 schema 一致性门禁,
确保已部署库不重跑历史、不丢数据。
636 lines
17 KiB
Go
636 lines
17 KiB
Go
// Copyright 2026 Arctel.net
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package service
|
|
|
|
import (
|
|
"Wavelet/pkg/buildinfo"
|
|
"Wavelet/pkg/logger"
|
|
"Wavelet/plugins/domain/admin/errs"
|
|
"Wavelet/plugins/domain/admin/model"
|
|
"Wavelet/plugins/domain/admin/repository"
|
|
"archive/tar"
|
|
"archive/zip"
|
|
"compress/gzip"
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"net/url"
|
|
"os"
|
|
"path/filepath"
|
|
"runtime"
|
|
"strings"
|
|
"sync"
|
|
"time"
|
|
|
|
"golang.org/x/mod/semver"
|
|
)
|
|
|
|
const (
|
|
githubAPIBaseURL = "https://api.github.com"
|
|
maxArchiveSize = int64(1024 * 1024 * 1024)
|
|
maxReleaseSize = int64(4 * 1024 * 1024)
|
|
repositoryParts = 2
|
|
windowsOS = "windows"
|
|
archiveFileMode = 0o600
|
|
stagedBinaryMode = 0o700
|
|
)
|
|
|
|
type releaseAsset struct {
|
|
Name string `json:"name"`
|
|
BrowserDownloadURL string `json:"browser_download_url"`
|
|
Size int64 `json:"size"`
|
|
State string `json:"state"`
|
|
}
|
|
|
|
type githubRelease struct {
|
|
TagName string `json:"tag_name"`
|
|
Name string `json:"name"`
|
|
Body string `json:"body"`
|
|
HTMLURL string `json:"html_url"`
|
|
Draft bool `json:"draft"`
|
|
Prerelease bool `json:"prerelease"`
|
|
Published time.Time `json:"published_at"`
|
|
Assets []releaseAsset `json:"assets"`
|
|
}
|
|
|
|
type releaseClient interface {
|
|
Do(req *http.Request) (*http.Response, error)
|
|
}
|
|
|
|
// UpdaterManager manages application binary updates from GitHub releases.
|
|
type UpdaterManager struct {
|
|
client releaseClient
|
|
mu sync.Mutex
|
|
upgrading bool
|
|
}
|
|
|
|
// DefaultUpdaterManager is the default singleton update manager.
|
|
var DefaultUpdaterManager = &UpdaterManager{
|
|
client: &http.Client{Timeout: 10 * time.Minute},
|
|
}
|
|
|
|
func normalizeVersion(version string) string {
|
|
version = strings.TrimSpace(version)
|
|
if version == "" || version == "dev" {
|
|
return ""
|
|
}
|
|
if !strings.HasPrefix(version, "v") {
|
|
version = "v" + version
|
|
}
|
|
if !semver.IsValid(version) {
|
|
return ""
|
|
}
|
|
return version
|
|
}
|
|
|
|
func parseRepository(raw string) (string, error) {
|
|
raw = strings.TrimSpace(raw)
|
|
if raw == "" {
|
|
return "", errors.New(errs.ErrInvalidRepository)
|
|
}
|
|
|
|
if !strings.Contains(raw, "://") {
|
|
repo := strings.TrimSuffix(strings.Trim(raw, "/"), ".git")
|
|
if len(strings.Split(repo, "/")) == repositoryParts {
|
|
return repo, nil
|
|
}
|
|
return "", errors.New(errs.ErrInvalidRepository)
|
|
}
|
|
|
|
parsed, err := url.Parse(raw)
|
|
if err != nil || !strings.EqualFold(parsed.Hostname(), "github.com") {
|
|
return "", errors.New(errs.ErrInvalidRepository)
|
|
}
|
|
repo := strings.TrimSuffix(strings.Trim(parsed.Path, "/"), ".git")
|
|
if len(strings.Split(repo, "/")) != repositoryParts {
|
|
return "", errors.New(errs.ErrInvalidRepository)
|
|
}
|
|
return repo, nil
|
|
}
|
|
|
|
func expectedAssetName(tag string) string {
|
|
extension := "tar.gz"
|
|
if runtime.GOOS == windowsOS {
|
|
extension = "zip"
|
|
}
|
|
return fmt.Sprintf("wavelet_%s_%s_%s.%s", tag, runtime.GOOS, runtime.GOARCH, extension)
|
|
}
|
|
|
|
func expectedAssetNames(repo, tag string) []string {
|
|
names := []string{expectedAssetName(tag)}
|
|
if parts := strings.Split(repo, "/"); len(parts) == repositoryParts {
|
|
repoName := parts[1]
|
|
if repoName != "wavelet" {
|
|
extension := "tar.gz"
|
|
if runtime.GOOS == windowsOS {
|
|
extension = "zip"
|
|
}
|
|
names = append(names, fmt.Sprintf("%s_%s_%s_%s.%s", repoName, tag, runtime.GOOS, runtime.GOARCH, extension))
|
|
}
|
|
}
|
|
return names
|
|
}
|
|
|
|
func selectLatestRelease(repo string, releases []githubRelease) (githubRelease, releaseAsset, error) {
|
|
var selected githubRelease
|
|
var selectedAsset releaseAsset
|
|
selectedVersion := ""
|
|
|
|
for _, release := range releases {
|
|
version := normalizeVersion(release.TagName)
|
|
if release.Draft || version == "" {
|
|
continue
|
|
}
|
|
expectedNames := expectedAssetNames(repo, release.TagName)
|
|
for _, asset := range release.Assets {
|
|
matched := false
|
|
for _, name := range expectedNames {
|
|
if asset.Name == name {
|
|
matched = true
|
|
break
|
|
}
|
|
}
|
|
if !matched || asset.BrowserDownloadURL == "" || asset.State != "uploaded" {
|
|
continue
|
|
}
|
|
if selectedVersion == "" || semver.Compare(version, selectedVersion) > 0 {
|
|
selected = release
|
|
selectedAsset = asset
|
|
selectedVersion = version
|
|
}
|
|
}
|
|
}
|
|
|
|
if selectedVersion == "" {
|
|
return githubRelease{}, releaseAsset{}, errors.New(errs.ErrNoCompatibleRelease)
|
|
}
|
|
return selected, selectedAsset, nil
|
|
}
|
|
|
|
func (m *UpdaterManager) fetchRelease(ctx context.Context, repo string) (githubRelease, releaseAsset, error) {
|
|
req, err := http.NewRequestWithContext(
|
|
ctx,
|
|
http.MethodGet,
|
|
fmt.Sprintf("%s/repos/%s/releases?per_page=30", githubAPIBaseURL, repo),
|
|
nil,
|
|
)
|
|
if err != nil {
|
|
return githubRelease{}, releaseAsset{}, fmt.Errorf("%s: %w", errs.ErrReleaseRequestFailed, err)
|
|
}
|
|
req.Header.Set("Accept", "application/vnd.github+json")
|
|
req.Header.Set("User-Agent", "Wavelet-Updater")
|
|
req.Header.Set("X-GitHub-Api-Version", "2022-11-28")
|
|
|
|
resp, err := m.client.Do(req)
|
|
if err != nil {
|
|
return githubRelease{}, releaseAsset{}, fmt.Errorf("%s: %w", errs.ErrReleaseRequestFailed, err)
|
|
}
|
|
defer func() {
|
|
_ = resp.Body.Close()
|
|
}()
|
|
if resp.StatusCode != http.StatusOK {
|
|
return githubRelease{}, releaseAsset{}, fmt.Errorf("%s: HTTP %d", errs.ErrReleaseRequestFailed, resp.StatusCode)
|
|
}
|
|
|
|
var releases []githubRelease
|
|
decoder := json.NewDecoder(io.LimitReader(resp.Body, maxReleaseSize))
|
|
if err := decoder.Decode(&releases); err != nil {
|
|
return githubRelease{}, releaseAsset{}, fmt.Errorf("%s: %w", errs.ErrReleaseResponseInvalid, err)
|
|
}
|
|
|
|
release, asset, err := selectLatestRelease(repo, releases)
|
|
if err != nil {
|
|
return githubRelease{}, releaseAsset{}, err
|
|
}
|
|
logger.InfoF(ctx, "[Updater] Selected latest compatible release: %s (Asset: %s)", release.TagName, asset.Name)
|
|
return release, asset, nil
|
|
}
|
|
|
|
func loadRepository(ctx context.Context) (string, error) {
|
|
cfg, err := repository.GetSystemConfigByKey(ctx, model.ConfigKeyUpdateUpstreamRepository)
|
|
if err != nil {
|
|
return "", fmt.Errorf("%s: %w", errs.ErrInvalidRepository, err)
|
|
}
|
|
return parseRepository(cfg.Value)
|
|
}
|
|
|
|
// status returns current version and update status.
|
|
func (m *UpdaterManager) status(ctx context.Context) (model.UpdaterStatus, releaseAsset, error) {
|
|
upstreamRepo, err := loadRepository(ctx)
|
|
if err != nil {
|
|
return model.UpdaterStatus{}, releaseAsset{}, err
|
|
}
|
|
release, asset, err := m.fetchRelease(ctx, upstreamRepo)
|
|
if err != nil {
|
|
return model.UpdaterStatus{}, releaseAsset{}, err
|
|
}
|
|
|
|
currentVersion := normalizeVersion(buildinfo.Version)
|
|
latestVersion := normalizeVersion(release.TagName)
|
|
updateAvailable := currentVersion != "" && semver.Compare(latestVersion, currentVersion) > 0
|
|
|
|
logger.InfoF(ctx, "[Updater] Check update complete. current: %s, latest: %s, update_available: %t", buildinfo.Version, release.TagName, updateAvailable)
|
|
|
|
return model.UpdaterStatus{
|
|
CurrentVersion: buildinfo.Version,
|
|
BuildTime: buildinfo.BuildTime,
|
|
LatestVersion: release.TagName,
|
|
UpdateAvailable: updateAvailable,
|
|
CanUpgrade: updateAvailable && runtime.GOOS != windowsOS,
|
|
Prerelease: release.Prerelease,
|
|
ReleaseName: release.Name,
|
|
ReleaseNotes: release.Body,
|
|
ReleaseURL: release.HTMLURL,
|
|
PublishedAt: release.Published.Format(time.RFC3339),
|
|
UpstreamRepository: upstreamRepo,
|
|
AssetName: asset.Name,
|
|
Platform: runtime.GOOS + "/" + runtime.GOARCH,
|
|
}, asset, nil
|
|
}
|
|
|
|
// GetUpdateStatus returns current updater status.
|
|
func GetUpdateStatus(ctx context.Context) (model.UpdaterStatus, error) {
|
|
status, _, err := DefaultUpdaterManager.status(ctx)
|
|
return status, err
|
|
}
|
|
|
|
func downloadArchive(ctx context.Context, client releaseClient, asset releaseAsset, destination string) error {
|
|
if asset.Size <= 0 || asset.Size > maxArchiveSize {
|
|
return fmt.Errorf(errs.ErrReleaseAssetSizeInvalid, asset.Size)
|
|
}
|
|
logger.InfoF(ctx, "[Updater] Downloading release asset: %s", asset.Name)
|
|
req, err := http.NewRequestWithContext(ctx, http.MethodGet, asset.BrowserDownloadURL, nil)
|
|
if err != nil {
|
|
return fmt.Errorf(errs.ErrCreateUpgradeRequestFailed, err)
|
|
}
|
|
req.Header.Set("User-Agent", "Wavelet-Updater")
|
|
|
|
resp, err := client.Do(req)
|
|
if err != nil {
|
|
return fmt.Errorf(errs.ErrDownloadUpgradeAssetFailed, err)
|
|
}
|
|
defer func() {
|
|
_ = resp.Body.Close()
|
|
}()
|
|
if resp.StatusCode != http.StatusOK {
|
|
return fmt.Errorf(errs.ErrUpgradeAssetHTTPFailed, resp.StatusCode)
|
|
}
|
|
|
|
//nolint:gosec // updater download destination is validated
|
|
file, err := os.OpenFile(destination, os.O_CREATE|os.O_EXCL|os.O_WRONLY, archiveFileMode)
|
|
if err != nil {
|
|
return fmt.Errorf(errs.ErrCreateUpgradeArchiveFailed, err)
|
|
}
|
|
|
|
written, err := io.Copy(file, io.LimitReader(resp.Body, maxArchiveSize+1))
|
|
if err != nil {
|
|
_ = file.Close()
|
|
return fmt.Errorf(errs.ErrWriteUpgradeArchiveFailed, err)
|
|
}
|
|
if err := file.Close(); err != nil {
|
|
return fmt.Errorf(errs.ErrCloseUpgradeArchiveFailed, err)
|
|
}
|
|
if written > maxArchiveSize || written != asset.Size {
|
|
return fmt.Errorf(errs.ErrUpgradeArchiveSizeMismatch, written, asset.Size)
|
|
}
|
|
logger.InfoF(ctx, "[Updater] Successfully downloaded release asset to %s", destination)
|
|
return nil
|
|
}
|
|
|
|
func safeArchivePath(destination, name string) (string, error) {
|
|
cleanName := filepath.Clean(name)
|
|
if filepath.IsAbs(cleanName) || cleanName == "." || strings.HasPrefix(cleanName, ".."+string(filepath.Separator)) {
|
|
return "", fmt.Errorf(errs.ErrArchiveContainsIllegalPath, name)
|
|
}
|
|
target := filepath.Join(destination, cleanName)
|
|
relative, err := filepath.Rel(destination, target)
|
|
if err != nil || relative == ".." || strings.HasPrefix(relative, ".."+string(filepath.Separator)) {
|
|
return "", fmt.Errorf(errs.ErrArchivePathOutOfDestination, name)
|
|
}
|
|
return target, nil
|
|
}
|
|
|
|
func matchBinaryName(name string, candidates []string) bool {
|
|
for _, candidate := range candidates {
|
|
if runtime.GOOS == windowsOS {
|
|
if strings.EqualFold(name, candidate) {
|
|
return true
|
|
}
|
|
} else {
|
|
if name == candidate {
|
|
return true
|
|
}
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
func getCandidateBinaryNames(executable, repo string) []string {
|
|
execName := filepath.Base(executable)
|
|
names := []string{execName}
|
|
|
|
addName := func(base string) {
|
|
name := base
|
|
if runtime.GOOS == windowsOS && !strings.HasSuffix(strings.ToLower(name), ".exe") {
|
|
name += ".exe"
|
|
}
|
|
for _, existing := range names {
|
|
if existing == name {
|
|
return
|
|
}
|
|
}
|
|
names = append(names, name)
|
|
}
|
|
|
|
if parts := strings.Split(repo, "/"); len(parts) == repositoryParts {
|
|
addName(parts[1])
|
|
}
|
|
addName("wavelet")
|
|
|
|
return names
|
|
}
|
|
|
|
func isLikelyBinary(name string, isDir bool, mode os.FileMode) bool {
|
|
if isDir {
|
|
return false
|
|
}
|
|
base := strings.ToLower(filepath.Base(name))
|
|
|
|
exclusions := []string{
|
|
"license", "licence", "copying", "notice", "readme", "changelog",
|
|
}
|
|
for _, excl := range exclusions {
|
|
if strings.HasPrefix(base, excl) {
|
|
return false
|
|
}
|
|
}
|
|
|
|
if runtime.GOOS == windowsOS {
|
|
return filepath.Ext(base) == ".exe"
|
|
}
|
|
|
|
return (mode.Perm()&0o111 != 0) || (filepath.Ext(base) == "")
|
|
}
|
|
|
|
func findBinaryInTarGz(archivePath string, candidates []string) (string, error) {
|
|
//nolint:gosec // updater archivePath is verified
|
|
file, err := os.Open(archivePath)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
defer func() {
|
|
_ = file.Close()
|
|
}()
|
|
|
|
gzipReader, err := gzip.NewReader(file)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
defer func() {
|
|
_ = gzipReader.Close()
|
|
}()
|
|
|
|
reader := tar.NewReader(gzipReader)
|
|
var binaries []string
|
|
for {
|
|
header, err := reader.Next()
|
|
if errors.Is(err, io.EOF) {
|
|
break
|
|
}
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
if header.Typeflag == tar.TypeReg && isLikelyBinary(header.Name, false, header.FileInfo().Mode()) {
|
|
binaries = append(binaries, header.Name)
|
|
}
|
|
}
|
|
|
|
if len(binaries) == 1 {
|
|
return binaries[0], nil
|
|
}
|
|
|
|
for _, name := range binaries {
|
|
if matchBinaryName(filepath.Base(name), candidates) {
|
|
return name, nil
|
|
}
|
|
}
|
|
|
|
return "", errors.New(errs.ErrNoCompatibleAsset)
|
|
}
|
|
|
|
func findBinaryInZip(archivePath string, candidates []string) (string, error) {
|
|
reader, err := zip.OpenReader(archivePath)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
defer func() {
|
|
_ = reader.Close()
|
|
}()
|
|
|
|
var binaries []string
|
|
for _, file := range reader.File {
|
|
if !file.FileInfo().IsDir() && isLikelyBinary(file.Name, false, file.FileInfo().Mode()) {
|
|
binaries = append(binaries, file.Name)
|
|
}
|
|
}
|
|
|
|
if len(binaries) == 1 {
|
|
return binaries[0], nil
|
|
}
|
|
|
|
for _, name := range binaries {
|
|
if matchBinaryName(filepath.Base(name), candidates) {
|
|
return name, nil
|
|
}
|
|
}
|
|
|
|
return "", errors.New(errs.ErrNoCompatibleAsset)
|
|
}
|
|
|
|
func extractTarGz(ctx context.Context, archivePath, destination, targetName string, candidates []string) (string, error) {
|
|
binaryPathInArchive, err := findBinaryInTarGz(archivePath, candidates)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
logger.InfoF(ctx, "[Updater] Extracting tar.gz archive: %s (extracting: %s)", archivePath, binaryPathInArchive)
|
|
//nolint:gosec // updater archivePath is verified
|
|
file, err := os.Open(archivePath)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
defer func() {
|
|
_ = file.Close()
|
|
}()
|
|
gzipReader, err := gzip.NewReader(file)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
defer func() {
|
|
_ = gzipReader.Close()
|
|
}()
|
|
|
|
reader := tar.NewReader(gzipReader)
|
|
for {
|
|
header, err := reader.Next()
|
|
if errors.Is(err, io.EOF) {
|
|
break
|
|
}
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
if header.Name != binaryPathInArchive {
|
|
continue
|
|
}
|
|
target, err := safeArchivePath(destination, targetName)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
//nolint:gosec // updater destination is sanitized
|
|
output, err := os.OpenFile(target, os.O_CREATE|os.O_EXCL|os.O_WRONLY, stagedBinaryMode)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
written, copyErr := io.Copy(output, io.LimitReader(reader, maxArchiveSize+1))
|
|
closeErr := output.Close()
|
|
if copyErr != nil {
|
|
return "", copyErr
|
|
}
|
|
if closeErr != nil {
|
|
return "", closeErr
|
|
}
|
|
if written > maxArchiveSize {
|
|
return "", errors.New(errs.ErrExtractedBinaryTooLarge)
|
|
}
|
|
logger.InfoF(ctx, "[Updater] Successfully extracted binary to %s", target)
|
|
return target, nil
|
|
}
|
|
return "", errors.New(errs.ErrNoCompatibleAsset)
|
|
}
|
|
|
|
func extractZip(ctx context.Context, archivePath, destination, targetName string, candidates []string) (string, error) {
|
|
binaryPathInArchive, err := findBinaryInZip(archivePath, candidates)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
logger.InfoF(ctx, "[Updater] Extracting zip archive: %s (extracting: %s)", archivePath, binaryPathInArchive)
|
|
reader, err := zip.OpenReader(archivePath)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
defer func() {
|
|
_ = reader.Close()
|
|
}()
|
|
for _, file := range reader.File {
|
|
if file.Name != binaryPathInArchive {
|
|
continue
|
|
}
|
|
target, err := safeArchivePath(destination, targetName)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
input, err := file.Open()
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
//nolint:gosec // updater extraction target is safe
|
|
output, err := os.OpenFile(target, os.O_CREATE|os.O_EXCL|os.O_WRONLY, stagedBinaryMode)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
written, copyErr := io.Copy(output, io.LimitReader(input, maxArchiveSize+1))
|
|
inputCloseErr := input.Close()
|
|
outputCloseErr := output.Close()
|
|
if copyErr != nil {
|
|
return "", copyErr
|
|
}
|
|
if inputCloseErr != nil {
|
|
return "", inputCloseErr
|
|
}
|
|
if outputCloseErr != nil {
|
|
return "", outputCloseErr
|
|
}
|
|
if written > maxArchiveSize {
|
|
return "", errors.New(errs.ErrExtractedBinaryTooLarge)
|
|
}
|
|
logger.InfoF(ctx, "[Updater] Successfully extracted binary to %s", target)
|
|
return target, nil
|
|
}
|
|
return "", errors.New(errs.ErrNoCompatibleAsset)
|
|
}
|
|
|
|
// PrepareUpgrade validates preconditions and downloads the newest binary.
|
|
func (m *UpdaterManager) PrepareUpgrade(ctx context.Context) (string, string, error) {
|
|
if runtime.GOOS == windowsOS {
|
|
return "", "", errors.New(errs.ErrAutomaticUpgradeBlocked)
|
|
}
|
|
if normalizeVersion(buildinfo.Version) == "" {
|
|
return "", "", errors.New(errs.ErrDevelopmentBuild)
|
|
}
|
|
|
|
m.mu.Lock()
|
|
defer m.mu.Unlock()
|
|
if m.upgrading {
|
|
return "", "", errors.New(errs.ErrUpgradeAlreadyRunning)
|
|
}
|
|
|
|
status, asset, err := m.status(ctx)
|
|
if err != nil {
|
|
return "", "", err
|
|
}
|
|
if !status.UpdateAvailable {
|
|
return "", "", errors.New(errs.ErrAlreadyUpToDate)
|
|
}
|
|
|
|
logger.InfoF(ctx, "[Updater] Preparing upgrade. current: %s, latest: %s", status.CurrentVersion, status.LatestVersion)
|
|
|
|
executable, err := os.Executable()
|
|
if err != nil {
|
|
return "", "", fmt.Errorf(errs.ErrLocateExecutableFailed, err)
|
|
}
|
|
executable, err = filepath.EvalSymlinks(executable)
|
|
if err != nil {
|
|
return "", "", fmt.Errorf(errs.ErrResolveExecutablePathFailed, err)
|
|
}
|
|
|
|
tempDir, err := os.MkdirTemp(filepath.Dir(executable), ".wavelet-update-*")
|
|
if err != nil {
|
|
return "", "", fmt.Errorf(errs.ErrCreateUpgradeDirFailed, err)
|
|
}
|
|
|
|
archivePath := filepath.Join(tempDir, asset.Name)
|
|
if err := downloadArchive(ctx, m.client, asset, archivePath); err != nil {
|
|
_ = os.RemoveAll(tempDir)
|
|
return "", "", err
|
|
}
|
|
|
|
targetName := filepath.Base(executable)
|
|
candidates := getCandidateBinaryNames(executable, status.UpstreamRepository)
|
|
|
|
var stagedBinary string
|
|
if strings.HasSuffix(asset.Name, ".zip") {
|
|
stagedBinary, err = extractZip(ctx, archivePath, tempDir, targetName, candidates)
|
|
} else {
|
|
stagedBinary, err = extractTarGz(ctx, archivePath, tempDir, targetName, candidates)
|
|
}
|
|
if err != nil {
|
|
_ = os.RemoveAll(tempDir)
|
|
return "", "", fmt.Errorf(errs.ErrExtractUpgradeAssetFailed, err)
|
|
}
|
|
logger.InfoF(ctx, "[Updater] Staged binary successfully prepared: %s", stagedBinary)
|
|
m.upgrading = true
|
|
return executable, stagedBinary, nil
|
|
}
|
|
|
|
// FinishUpgrade resets the upgrading flag.
|
|
func (m *UpdaterManager) FinishUpgrade() {
|
|
m.mu.Lock()
|
|
defer m.mu.Unlock()
|
|
m.upgrading = false
|
|
}
|