Skip to content

PasteFerry (隔空贴): clipboard and file sync across macOS, Windows and Linux. Direct-first, end-to-end encrypted. Optional official access: no server to host. Independent self-hosting remains available.

feat(core): run as a background service on Linux

baiyuzed0733449352b
diff --git a/client-core/cmd/copysyncd/main.go b/client-core/cmd/copysyncd/main.go
index ccd108d..be3283a 100644
--- a/client-core/cmd/copysyncd/main.go
+++ b/client-core/cmd/copysyncd/main.go
@@ -50,7 +50,7 @@ func main() {
probe = flag.Bool("probe-clipboard", false,
"诊断用:在主线程直接读一次剪贴板并打印结果后退出")
supervise = flag.Bool("supervise", false,
- "守护模式:拉起后台服务,异常退出时自动重启(Windows 开机自启用)")
+ "守护模式:拉起后台服务,异常退出时自动重启(Windows、Linux 开机自启用)")
)
flag.Parse()
@@ -83,7 +83,7 @@ func main() {
}
}
-// exitAlreadyRunning 是「已有实例在运行」的退出码。Windows 的守护进程见到它就不再重启。
+// exitAlreadyRunning 是「已有实例在运行」的退出码。守护进程见到它就不再重启。
const exitAlreadyRunning = 3
var errAlreadyRunning = errors.New("已有后台服务在运行")
@@ -120,7 +120,7 @@ func probeClipboard() {
func run(dataDir string) error {
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer stop()
- // 注销、关机时由剪贴板窗口收到系统通知后调用(目前只有 Windows),见下方 SetSystemHooks
+ // 注销、关机时调用(Windows 由剪贴板窗口收到系统通知,Linux 是与 X11 显示的连接断了),见下方 SetSystemHooks
ctx, cancel := context.WithCancel(ctx)
defer cancel()
@@ -409,7 +409,7 @@ func run(dataDir string) error {
stopTray := startTray(ctx, cancel, dataDir == "")
defer stopTray()
- // 系统事件(目前只有 Windows 上报):注销关机时正常退出,唤醒后立即重新探测网络
+ // 系统事件(Windows 上报注销关机与唤醒,Linux 上报注销):注销关机时正常退出,唤醒后立即重新探测网络
clipboard.SetSystemHooks(
func() {
slog.Info("系统正在注销或关机,退出")
diff --git a/client-core/cmd/copysyncd/platform_linux.go b/client-core/cmd/copysyncd/platform_linux.go
new file mode 100644
index 0000000..00aaa53
--- /dev/null
+++ b/client-core/cmd/copysyncd/platform_linux.go
@@ -0,0 +1,48 @@
+//go:build linux
+
+package main
+
+import (
+ "context"
+ "os"
+ "path/filepath"
+ "syscall"
+)
+
+// Linux 上没有托盘:主流桌面(GNOME)默认不显示托盘图标,界面从应用菜单打开。
+func startTray(context.Context, context.CancelFunc, bool) func() { return func() {} }
+
+// acquireInstance 保证同一个数据目录只有一个后台服务在运行。用文件锁:进程不管怎么退出,
+// 内核都会释放它,不会留下僵死的锁。
+func acquireInstance(root string) (release func(), ok bool) {
+ return lockFile(filepath.Join(root, "daemon.lock"))
+}
+
+// acquireSupervisorLock 保证同一个数据目录只有一个守护进程。
+func acquireSupervisorLock(root string) (release func(), ok bool) {
+ return lockFile(filepath.Join(root, "supervisor.lock"))
+}
+
+func lockFile(path string) (release func(), ok bool) {
+ if err := os.MkdirAll(filepath.Dir(path), 0o700); err != nil {
+ return func() {}, true // 建不了锁就不做单实例保护,总比起不来好
+ }
+ f, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0o600)
+ if err != nil {
+ return func() {}, true
+ }
+ if err := syscall.Flock(int(f.Fd()), syscall.LOCK_EX|syscall.LOCK_NB); err != nil {
+ f.Close()
+ if err == syscall.EWOULDBLOCK {
+ return nil, false
+ }
+ return func() {}, true
+ }
+ return func() { f.Close() }, true
+}
+
+// childAttr 让子进程在守护进程退出时随之结束:界面重启服务时只要结束守护进程,
+// 不会留下一个没人看着的后台服务。
+func childAttr() *syscall.SysProcAttr {
+ return &syscall.SysProcAttr{Pdeathsig: syscall.SIGTERM}
+}
diff --git a/client-core/cmd/copysyncd/platform_other.go b/client-core/cmd/copysyncd/platform_other.go
index 54c89f0..f73fdb0 100644
--- a/client-core/cmd/copysyncd/platform_other.go
+++ b/client-core/cmd/copysyncd/platform_other.go
@@ -1,4 +1,4 @@
-//go:build !windows
+//go:build !windows && !linux
package main
@@ -17,6 +17,6 @@ func logOutput(string) io.Writer { return os.Stderr }
func acquireInstance(string) (release func(), ok bool) { return func() {}, true }
func runSupervisor(string) int {
- os.Stderr.WriteString("-supervise 只在 Windows 上使用;这个平台由系统服务管理器负责拉起\n")
+ os.Stderr.WriteString("-supervise 只在 Windows 和 Linux 上使用;这个平台由系统服务管理器负责拉起\n")
return 2
}
diff --git a/client-core/cmd/copysyncd/platform_windows.go b/client-core/cmd/copysyncd/platform_windows.go
index 7eab354..656fd63 100644
--- a/client-core/cmd/copysyncd/platform_windows.go
+++ b/client-core/cmd/copysyncd/platform_windows.go
@@ -2,7 +2,7 @@
package main
-// Windows 上 launchd 管的那些事要自己做:日志写文件、只运行一个实例、崩溃自动重启。
+// Windows 上的单实例保护用命名互斥量。日志与守护进程见 supervisor.go。
//
// 开机自启由界面在 HKCU\...\Run 下登记「copysyncd.exe -supervise」,
// 守护进程再拉起真正干活的子进程(见 runSupervisor)。
@@ -11,44 +11,13 @@ import (
"crypto/sha256"
"encoding/hex"
"errors"
- "io"
- "log/slog"
- "os"
- "os/exec"
"path/filepath"
- "runtime/debug"
"strings"
- "time"
+ "syscall"
"golang.org/x/sys/windows"
)
-const (
- logMaxSize = 10 << 20 // 10 MB,轮转后最多占 20 MB
- // restartThrottle 与 Mac 上 LaunchAgent 的 ThrottleInterval 一致:崩溃后至少隔这么久再拉起
- restartThrottle = 10 * time.Second
-)
-
-// logOutput 打开日志文件。后台服务以 GUI 子系统运行、没有控制台,标准错误输出不可用。
-// 未处理的 panic 另写到 crash.log:日志文件会轮转,崩溃信息不能跟着被挤掉。
-func logOutput(dataDir string) io.Writer {
- paths, err := resolvePaths(dataDir)
- if err != nil {
- return io.Discard
- }
- dir := filepath.Join(paths.Root, "logs")
- w, err := openRotating(filepath.Join(dir, "daemon.log"), logMaxSize)
- if err != nil {
- return io.Discard
- }
- if f, err := os.OpenFile(filepath.Join(dir, "crash.log"),
- os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o600); err == nil {
- _ = debug.SetCrashOutput(f, debug.CrashOptions{})
- f.Close() // SetCrashOutput 会自己复制一份句柄
- }
- return w
-}
-
// acquireInstance 保证同一个数据目录只有一个后台服务在运行。
// 用命名互斥量:进程不管怎么退出,系统都会释放它,不会留下僵死的锁。
func acquireInstance(root string) (release func(), ok bool) {
@@ -78,59 +47,10 @@ func dirKey(root string) string {
return hex.EncodeToString(sum[:6])
}
-// runSupervisor 是守护模式:拉起后台服务,它异常退出就隔一会儿再拉起。
-//
-// 子进程正常退出(退出码 0:用户注销、或界面要求停止)或发现已有实例在运行时,
-// 守护进程也随之退出。界面要重启服务时,把两者一起结束再重新启动守护进程。
-func runSupervisor(dataDir string) int {
- paths, err := resolvePaths(dataDir)
- if err != nil {
- return 1
- }
- release, ok := acquireMutex("CopySync.Supervisor." + dirKey(paths.Root))
- if !ok {
- return 0 // 已经有守护进程在看着了
- }
- defer release()
-
- logFile, err := openRotating(filepath.Join(paths.Root, "logs", "supervisor.log"), 1<<20)
- log := slog.New(slog.NewTextHandler(io.Discard, nil))
- if err == nil {
- defer logFile.Close()
- log = slog.New(slog.NewTextHandler(logFile, nil))
- }
-
- exe, err := os.Executable()
- if err != nil {
- log.Error("找不到自身的路径", "err", err)
- return 1
- }
- var args []string
- if dataDir != "" {
- args = append(args, "-data-dir", dataDir)
- }
-
- for {
- started := time.Now()
- cmd := exec.Command(exe, args...)
- err := cmd.Run()
- code := 0
- var exitErr *exec.ExitError
- switch {
- case errors.As(err, &exitErr):
- code = exitErr.ExitCode()
- case err != nil:
- log.Error("启动后台服务失败", "err", err)
- code = 1
- }
- if code == 0 || code == exitAlreadyRunning {
- log.Info("后台服务已退出,守护结束", "code", code)
- return 0
- }
- wait := restartThrottle - time.Since(started)
- log.Warn("后台服务异常退出,稍后重启", "code", code, "等待", wait.Round(time.Second))
- if wait > 0 {
- time.Sleep(wait)
- }
- }
+// acquireSupervisorLock 保证同一个数据目录只有一个守护进程。
+func acquireSupervisorLock(root string) (release func(), ok bool) {
+ return acquireMutex("CopySync.Supervisor." + dirKey(root))
}
+
+// childAttr 是守护进程拉起子进程时的进程属性。Windows 上不需要特别设置。
+func childAttr() *syscall.SysProcAttr { return nil }
diff --git a/client-core/cmd/copysyncd/supervisor.go b/client-core/cmd/copysyncd/supervisor.go
new file mode 100644
index 0000000..e8f18ef
--- /dev/null
+++ b/client-core/cmd/copysyncd/supervisor.go
@@ -0,0 +1,103 @@
+//go:build windows || linux
+
+package main
+
+// Windows 与 Linux 上,launchd 在 Mac 上管的那些事要自己做:日志写文件、崩溃自动重启。
+// 开机自启由界面登记「copysyncd -supervise」(Windows 写注册表的 Run 项,Linux 写 XDG 自启动项),
+// 守护进程再拉起真正干活的子进程。单实例保护各平台不同,见 platform_windows.go、platform_linux.go。
+
+import (
+ "errors"
+ "io"
+ "log/slog"
+ "os"
+ "os/exec"
+ "path/filepath"
+ "runtime/debug"
+ "time"
+)
+
+const (
+ logMaxSize = 10 << 20 // 10 MB,轮转后最多占 20 MB
+ // restartThrottle 与 Mac 上 LaunchAgent 的 ThrottleInterval 一致:崩溃后至少隔这么久再拉起
+ restartThrottle = 10 * time.Second
+)
+
+// logOutput 打开日志文件。Windows 上后台服务以 GUI 子系统运行、没有控制台;
+// Linux 上由桌面的自启动拉起,标准错误输出也没人看。
+// 未处理的 panic 另写到 crash.log:日志文件会轮转,崩溃信息不能跟着被挤掉。
+func logOutput(dataDir string) io.Writer {
+ paths, err := resolvePaths(dataDir)
+ if err != nil {
+ return io.Discard
+ }
+ dir := filepath.Join(paths.Root, "logs")
+ w, err := openRotating(filepath.Join(dir, "daemon.log"), logMaxSize)
+ if err != nil {
+ return io.Discard
+ }
+ if f, err := os.OpenFile(filepath.Join(dir, "crash.log"),
+ os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o600); err == nil {
+ _ = debug.SetCrashOutput(f, debug.CrashOptions{})
+ f.Close() // SetCrashOutput 会自己复制一份句柄
+ }
+ return w
+}
+
+// runSupervisor 是守护模式:拉起后台服务,它异常退出就隔一会儿再拉起。
+//
+// 子进程正常退出(退出码 0:用户注销、或界面要求停止)或发现已有实例在运行时,
+// 守护进程也随之退出。界面要重启服务时,把两者一起结束再重新启动守护进程。
+func runSupervisor(dataDir string) int {
+ paths, err := resolvePaths(dataDir)
+ if err != nil {
+ return 1
+ }
+ release, ok := acquireSupervisorLock(paths.Root)
+ if !ok {
+ return 0 // 已经有守护进程在看着了
+ }
+ defer release()
+
+ logFile, err := openRotating(filepath.Join(paths.Root, "logs", "supervisor.log"), 1<<20)
+ log := slog.New(slog.NewTextHandler(io.Discard, nil))
+ if err == nil {
+ defer logFile.Close()
+ log = slog.New(slog.NewTextHandler(logFile, nil))
+ }
+
+ exe, err := os.Executable()
+ if err != nil {
+ log.Error("找不到自身的路径", "err", err)
+ return 1
+ }
+ var args []string
+ if dataDir != "" {
+ args = append(args, "-data-dir", dataDir)
+ }
+
+ for {
+ started := time.Now()
+ cmd := exec.Command(exe, args...)
+ cmd.SysProcAttr = childAttr()
+ err := cmd.Run()
+ code := 0
+ var exitErr *exec.ExitError
+ switch {
+ case errors.As(err, &exitErr):
+ code = exitErr.ExitCode()
+ case err != nil:
+ log.Error("启动后台服务失败", "err", err)
+ code = 1
+ }
+ if code == 0 || code == exitAlreadyRunning {
+ log.Info("后台服务已退出,守护结束", "code", code)
+ return 0
+ }
+ wait := restartThrottle - time.Since(started)
+ log.Warn("后台服务异常退出,稍后重启", "code", code, "等待", wait.Round(time.Second))
+ if wait > 0 {
+ time.Sleep(wait)
+ }
+ }
+}
diff --git a/client-core/internal/config/config.go b/client-core/internal/config/config.go
index f647152..a908731 100644
--- a/client-core/internal/config/config.go
+++ b/client-core/internal/config/config.go
@@ -137,9 +137,15 @@ func DefaultPaths() (Paths, error) {
}
root = filepath.Join(base, "CopySync")
default:
- base, err := os.UserConfigDir()
- if err != nil {
- return Paths{}, err
+ // Linux 等:数据库、缓存、身份都是数据而不是配置,按 XDG 放在 ~/.local/share 下。
+ // 界面要找到同一个位置,见 ui/lib/daemon_client.dart 的 defaultDataDir
+ base := os.Getenv("XDG_DATA_HOME")
+ if !filepath.IsAbs(base) {
+ home, err := os.UserHomeDir()
+ if err != nil {
+ return Paths{}, err
+ }
+ base = filepath.Join(home, ".local", "share")
}
root = filepath.Join(base, "copysync")
}