feat: refactor browser extension communication to use IPC (#1130)

Author: monkeyWie

_examples/basic/main.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"fmt"
+
 	"github.com/GopeedLab/gopeed/pkg/base"
 	"github.com/GopeedLab/gopeed/pkg/download"
 	"github.com/GopeedLab/gopeed/pkg/protocol/http"

cmd/host/dail_other.go

@@ -0,0 +1,19 @@
+//go:build !windows
+// +build !windows
+
+package main
+
+import (
+	"net"
+	"os"
+	"path/filepath"
+)
+
+func Dial() (net.Conn, error) {
+	// Get binary path
+	exe, err := os.Executable()
+	if err != nil {
+		return nil, err
+	}
+	return net.Dial("unix", filepath.Join(filepath.Dir(exe), "gopeed_host.sock"))
+}

cmd/host/dail_windows.go

@@ -0,0 +1,11 @@
+package main
+
+import (
+	"net"
+
+	"github.com/Microsoft/go-winio"
+)
+
+func Dial() (net.Conn, error) {
+	return winio.DialPipe(`\\.\pipe\gopeed_host`, nil)
+}

cmd/host/main.go

@@ -1,22 +1,24 @@
 package main
 
 import (
+	"bytes"
+	"context"
 	"encoding/binary"
 	"encoding/json"
 	"errors"
 	"fmt"
 	"io"
+	"net"
+	"net/http"
 	"os"
-	"strings"
+	"time"
 
 	"github.com/pkg/browser"
-	"github.com/shirou/gopsutil/v4/process"
 )
 
-const identifier = "gopeed"
-
 type Message struct {
 	Method string          `json:"method"`
+	Meta   map[string]any  `json:"meta"`
 	Params json.RawMessage `json:"params"`
 }
 
@@ -26,31 +28,74 @@ type Response struct {
 	Message string `json:"message,omitempty"`
 }
 
-var apiMap = map[string]func(params json.RawMessage) (data any, err error){
-	"ping": func(params json.RawMessage) (data any, err error) {
-		processes, err := process.Processes()
+func check() (data bool, err error) {
+	conn, err := Dial()
+	if err != nil {
+		return false, err
+	}
+	defer conn.Close()
+	return true, nil
+}
+
+func wakeup(hidden bool) error {
+	running, _ := check()
+	if running {
+		return nil
+	}
+
+	uri := "gopeed:"
+	if hidden {
+		uri = uri + "?hidden=true"
+	}
+	if err := browser.OpenURL(uri); err != nil {
+		return err
+	}
+
+	for i := 0; i < 10; i++ {
+		if ok, _ := check(); ok {
+			return nil
+		}
+		time.Sleep(1 * time.Second)
+	}
+	return fmt.Errorf("start gopeed failed")
+}
+
+var apiMap = map[string]func(message *Message) (data any, err error){
+	"ping": func(message *Message) (data any, err error) {
+		return check()
+	},
+	"create": func(message *Message) (data any, err error) {
+		buf, err := message.Params.MarshalJSON()
 		if err != nil {
-			return false, err
+			return
 		}
 
-		for _, p := range processes {
-			name, err := p.Name()
-			if err != nil {
-				continue
-			}
+		silent := false
+		if v, ok := message.Meta["silent"]; ok {
+			silent, _ = v.(bool)
+		}
 
-			if strings.Contains(strings.ToLower(name), strings.ToLower(identifier)) {
-				return true, nil
-			}
+		if err := wakeup(silent); err != nil {
+			return nil, err
 		}
-		return false, nil
-	},
-	"create": func(params json.RawMessage) (data any, err error) {
-		var strParams string
-		if err = json.Unmarshal(params, &strParams); err != nil {
+
+		client := &http.Client{
+			Transport: &http.Transport{
+				DialContext: func(ctx context.Context, network, addr string) (net.Conn, error) {
+					return Dial()
+				},
+			},
+			Timeout: 10 * time.Second,
+		}
+		req, err := http.NewRequest("POST", "http://127.0.0.1/create", bytes.NewBuffer(buf))
+		if err != nil {
 			return
 		}
-		err = browser.OpenURL(fmt.Sprintf("%s:///create?params=%s", identifier, strParams))
+		if message.Meta != nil {
+			metaJson, _ := json.Marshal(message.Meta)
+			req.Header.Set("X-Gopeed-Host-Meta", string(metaJson))
+		}
+		_, err = client.Do(req)
 		return
 	},
 }
@@ -88,7 +133,7 @@ func main() {
 		var data any
 		var err error
 		if handler, ok := apiMap[message.Method]; ok {
-			data, err = handler(message.Params)
+			data, err = handler(&message)
 		} else {
 			err = errors.New("Unknown method: " + message.Method)
 		}

cmd/updater/main.go

@@ -5,7 +5,6 @@ import (
 	"fmt"
 	"log"
 	"os"
-	"path/filepath"
 	"syscall"
 	"time"
 
@@ -19,6 +18,7 @@ func main() {
 	pid := flag.Int("pid", 0, "PID of the process to update")
 	updateChannel := flag.String("channel", "", "Update channel")
 	packagePath := flag.String("asset", "", "Path to the package asset")
+	exeDir := flag.String("exeDir", "", "Directory of the entry executable")
 	logPath := flag.String("log", "", "Log file path")
 	flag.Parse()
 
@@ -43,7 +43,7 @@ func main() {
 		restart bool
 		err     error
 	)
-	if restart, err = update(*pid, *updateChannel, *packagePath); err != nil {
+	if restart, err = update(*pid, *updateChannel, *packagePath, *exeDir); err != nil {
 		log.Printf("Update failed: %v\n", err)
 		os.Exit(1)
 	}
@@ -61,7 +61,7 @@ func main() {
 	os.Exit(0)
 }
 
-func update(pid int, updateChannel, packagePath string) (restart bool, err error) {
+func update(pid int, updateChannel, packagePath, exeDir string) (restart bool, err error) {
 	killSignalChan := make(chan any, 1)
 
 	go func() {
@@ -76,9 +76,8 @@ func update(pid int, updateChannel, packagePath string) (restart bool, err error
 		}
 	}()
 
-	appDir := filepath.Dir(os.Args[0])
-	log.Printf("Updating process updateChannel=%s packagePath=%s appDir=%s\n", updateChannel, packagePath, appDir)
-	if restart, err = install(killSignalChan, updateChannel, packagePath, appDir); err != nil {
+	log.Printf("Updating process updateChannel=%s packagePath=%s exeDir=%s\n", updateChannel, packagePath, exeDir)
+	if restart, err = install(killSignalChan, updateChannel, packagePath, exeDir); err != nil {
 		return false, errors.Wrap(err, "failed to install package")
 	}
 

cmd/updater/updater_darwin.go

@@ -25,16 +25,20 @@ func installByDmg(killSignalChan chan<- any, packagePath, destDir string) error
 	mountPoint := ""
 	for _, line := range strings.Split(string(output), "\n") {
 		if strings.Contains(line, "/Volumes/") {
-			fields := strings.Fields(line)
-			if len(fields) > 2 {
-				mountPoint = fields[len(fields)-1]
+			// Find the /Volumes/ path in the line
+			// hdiutil output format: /dev/disk4s1  Apple_HFS  /Volumes/Gopeed
+			// or with sequence number: /dev/disk4s1  Apple_HFS  /Volumes/Gopeed 1
+			idx := strings.Index(line, "/Volumes/")
+			if idx != -1 {
+				// Extract everything from /Volumes/ onwards and trim whitespace
+				mountPoint = strings.TrimSpace(line[idx:])
 				break
 			}
 		}
 	}
 
 	if mountPoint == "" {
-		return fmt.Errorf("failed to get mount point")
+		return fmt.Errorf("failed to get mount point from hdiutil output: %s", string(output))
 	}
 
 	// Detach the mounted DMG
@@ -45,7 +49,7 @@ func installByDmg(killSignalChan chan<- any, packagePath, destDir string) error
 		return err
 	}
 	if len(matches) == 0 {
-		return fmt.Errorf("no .app found in dmg")
+		return fmt.Errorf("no .app found in dmg, mountPoint: %s", mountPoint)
 	}
 
 	killSignalChan <- nil

ui/flutter/lib/app/modules/app/controllers/app_controller.dart

@@ -16,6 +16,7 @@ import 'package:url_launcher/url_launcher.dart';
 import 'package:window_manager/window_manager.dart';
 
 import '../../../../api/api.dart';
+import '../../../../api/model/create_task.dart';
 import '../../../../api/model/downloader_config.dart';
 import '../../../../api/model/request.dart';
 import '../../../../core/common/start_config.dart';
@@ -31,7 +32,7 @@ import '../../../../util/package_info.dart';
 import '../../../../util/updater.dart';
 import '../../../../util/util.dart';
 import '../../../routes/app_pages.dart';
-import '../../create/dto/create_router_params.dart';
+import '../../../rpc/rpc.dart';
 import '../../redirect/views/redirect_view.dart';
 
 const unixSocketPath = 'gopeed.sock';
@@ -78,6 +79,9 @@ class AppController extends GetxController with WindowListener, TrayListener {
     _initTray().onError(
         (error, stackTrace) => logger.w("initTray error", error, stackTrace));
 
+    _initRpcServer().onError((error, stackTrace) =>
+        logger.w("initRpcServer error", error, stackTrace));
+
     _initForegroundTask().onError((error, stackTrace) =>
         logger.w("initForegroundTask error", error, stackTrace));
 
@@ -271,6 +275,37 @@ class AppController extends GetxController with WindowListener, TrayListener {
     trayManager.addListener(this);
   }
 
+  Future<void> _initRpcServer() async {
+    if (!Util.isDesktop()) {
+      return;
+    }
+    try {
+      await startRpcServer({
+        "/create": (ctx) async {
+          final meta =
+              ctx.request.headers["X-Gopeed-Host-Meta"]?.firstOrNull ?? "{}";
+          final jsonMeta = jsonDecode(meta);
+          final silent = jsonMeta['silent'] as bool? ?? false;
+          final params = await ctx.readText();
+          final createTaskParams = _decodeToCreatTaskParams(params);
+          if (!silent) {
+            await windowManager.show();
+            _handleToCreate0(createTaskParams);
+          } else {
+            try {
+              await createTask(createTaskParams);
+            } catch (e) {
+              logger.w(
+                  "create task from extension fail", e, StackTrace.current);
+            }
+          }
+        },
+      });
+    } catch (e) {
+      logger.w("start rpc server fail", e, StackTrace.current);
+    }
+  }
+
   Future<void> _initForegroundTask() async {
     if (!Util.isMobile()) {
       return;
@@ -317,13 +352,7 @@ class AppController extends GetxController with WindowListener, TrayListener {
       if (uri.path == "/create") {
         final params = uri.queryParameters["params"];
         if (params?.isNotEmpty == true) {
-          final safeParams = params!.replaceAll(" ", "+");
-          final paramsJson =
-              String.fromCharCodes(base64Decode(base64.normalize(safeParams)));
-          Get.rootDelegate.offAndToNamed(Routes.REDIRECT,
-              arguments: RedirectArgs(Routes.CREATE,
-                  arguments:
-                      CreateRouterParams.fromJson(jsonDecode(paramsJson))));
+          _handleToCreate(params!);
           return;
         }
         Get.rootDelegate.offAndToNamed(Routes.CREATE);
@@ -346,7 +375,7 @@ class AppController extends GetxController with WindowListener, TrayListener {
     }
     Get.rootDelegate.offAndToNamed(Routes.REDIRECT,
         arguments: RedirectArgs(Routes.CREATE,
-            arguments: CreateRouterParams(req: Request(url: path))));
+            arguments: CreateTask(req: Request(url: path))));
   }
 
   String runningAddress() {
@@ -524,4 +553,21 @@ class AppController extends GetxController with WindowListener, TrayListener {
         apiToken: startConfig.value.apiToken));
     await putConfig(downloaderConfig.value);
   }
+
+  CreateTask _decodeToCreatTaskParams(String params) {
+    final safeParams = params.replaceAll('"', "").replaceAll(" ", "+");
+    final paramsJson =
+        String.fromCharCodes(base64Decode(base64.normalize(safeParams)));
+    return CreateTask.fromJson(jsonDecode(paramsJson));
+  }
+
+  _handleToCreate(String params) {
+    final createTaskParams = _decodeToCreatTaskParams(params);
+    _handleToCreate0(createTaskParams);
+  }
+
+  _handleToCreate0(CreateTask createTaskParams) {
+    Get.rootDelegate.offAndToNamed(Routes.REDIRECT,
+        arguments: RedirectArgs(Routes.CREATE, arguments: createTaskParams));
+  }
 }