Add tray icon and close-to-tray behavior in macOS/Windows, keep VPN running when UI closes and resync UI on relaunch in android, keep tunnel running when UI terminates and resync UI on relaunch in ios, sync UI with native tunnel status on init/resume in flutter

Author: zaelgohary

android/app/src/main/kotlin/tech/threefold/mycelium/MainActivity.kt

@@ -5,6 +5,7 @@ import android.app.Activity
 import android.content.BroadcastReceiver
 import android.content.Context
 import android.content.Intent
+import android.content.SharedPreferences
 import android.content.IntentFilter
 import android.net.VpnService
 import android.os.Build
@@ -27,9 +28,11 @@ class MainActivity: FlutterActivity() {
     private var vpnPermissionSecretKey: ByteArray? = null
 
     private lateinit var channel : MethodChannel
+    private lateinit var prefs: SharedPreferences
 
     override fun configureFlutterEngine(flutterEngine: FlutterEngine) {
         super.configureFlutterEngine(flutterEngine)
+        prefs = getSharedPreferences("mycelium_prefs", MODE_PRIVATE)
         channel = MethodChannel(flutterEngine.dartExecutor.binaryMessenger, channelName)
         channel.setMethodCallHandler {
             // This method is invoked on the main thread.
@@ -56,6 +59,17 @@ class MainActivity: FlutterActivity() {
                     Log.d(tag,  "stopping VPN")
                     result.success(stopCmdSent)
                 }
+                "queryStatus" -> {
+                    // Immediately report last known state while also querying the service
+                    val running = prefs.getBoolean("mycelium_running", false)
+                    if (running) {
+                        channel.invokeMethod("notifyMyceliumStarted","")
+                    } else {
+                        channel.invokeMethod("notifyMyceliumFinished","")
+                    }
+                    queryStatus()
+                    result.success(true)
+                }
                 else -> result.notImplemented()
             }
         }
@@ -69,6 +83,9 @@ class MainActivity: FlutterActivity() {
                 TunService.EVENT_MYCELIUM_FINISHED -> {
                     channel.invokeMethod("notifyMyceliumFinished","")
                 }
+                TunService.EVENT_MYCELIUM_RUNNING -> {
+                    channel.invokeMethod("notifyMyceliumStarted", "")
+                }
                 TunService.EVENT_MYCELIUM_FAILED -> {
                     channel.invokeMethod("notifyMyceliumFailed", "")
                 }
@@ -129,6 +146,12 @@ class MainActivity: FlutterActivity() {
         return true
     }
 
+    private fun queryStatus() {
+        val intent = Intent(this, TunService::class.java)
+        intent.action = TunService.ACTION_QUERY
+        startService(intent)
+    }
+
     @SuppressLint("UnspecifiedRegisterReceiverFlag", "WrongConstant")
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
@@ -177,10 +200,6 @@ class MainActivity: FlutterActivity() {
 
     override fun onDestroy() {
         Log.e(tag, "onDestroy")
-
-        Log.i(tag, "onDestroy:Stopping VPN service")
-        stopVpn()
-
         super.onDestroy()
 
         // Activity is about to be destroyed.

android/app/src/main/kotlin/tech/threefold/mycelium/TunService.kt

@@ -1,6 +1,8 @@
 package tech.threefold.mycelium
 
 import android.content.Intent
+import android.content.Context
+import android.content.SharedPreferences
 import android.net.VpnService
 import android.os.ParcelFileDescriptor
 import android.system.OsConstants
@@ -20,13 +22,16 @@ class TunService : VpnService(), CoroutineScope {
     companion object {
         const val ACTION_START = "tech.threefold.mycelium.TunService.START"
         const val ACTION_STOP = "tech.threefold.mycelium.TunService.STOP"
+        const val ACTION_QUERY = "tech.threefold.mycelium.TunService.QUERY"
         const val EVENT_INTENT = "tech.threefold.mycelium.TunService.EVENT"
         const val EVENT_MYCELIUM_FAILED = "mycelium_failed"
         const val EVENT_MYCELIUM_FINISHED = "mycelium_finished"
+        const val EVENT_MYCELIUM_RUNNING = "mycelium_running"
     }
 
     private var started = AtomicBoolean()
     private var parcel: ParcelFileDescriptor? = null
+    private lateinit var prefs: SharedPreferences
 
     private val job = Job()
 
@@ -36,6 +41,7 @@ class TunService : VpnService(), CoroutineScope {
     override fun onCreate() {
         Log.d(tag, "tun service created")
         super.onCreate()
+        prefs = getSharedPreferences("mycelium_prefs", Context.MODE_PRIVATE)
     }
 
     override fun onDestroy() {
@@ -63,6 +69,14 @@ class TunService : VpnService(), CoroutineScope {
                 start(peers.toList(), secretKey)
                 START_STICKY
             }
+            ACTION_QUERY -> {
+                if (started.get()) {
+                    sendMyceliumEvent(EVENT_MYCELIUM_RUNNING)
+                } else {
+                    sendMyceliumEvent(EVENT_MYCELIUM_FINISHED)
+                }
+                START_NOT_STICKY
+            }
             else -> {
                 Log.e(tag, "unknown command")
 
@@ -75,6 +89,7 @@ class TunService : VpnService(), CoroutineScope {
         if (!started.compareAndSet(false, true)) {
             return 0
         }
+        prefs.edit().putBoolean("mycelium_running", true).apply()
         val nodeAddress = addressFromSecretKey(secretKey)
         Log.i(tag, "creating TUN device with node address:  $nodeAddress")
 
@@ -127,6 +142,7 @@ class TunService : VpnService(), CoroutineScope {
             Log.d(tag, "got stop when not started")
             return
         }
+        prefs.edit().putBoolean("mycelium_running", false).apply()
         if (stopMycelium) {
             stopMycelium()
         }

ios/Runner/AppDelegate.swift

@@ -60,6 +60,9 @@ import OSLog
                     self.flutterTunnelStatus = .stopped
                     self.stopMycelium()
                     result(true)
+                case "queryStatus":
+                    self.queryStatus()
+                    result(true)
                 default:
                     result(FlutterMethodNotImplemented)
                 }
@@ -76,7 +79,6 @@ import OSLog
     override func applicationWillTerminate(_ application: UIApplication) {
         // Called when the application is about to terminate. Save data if appropriate. See also applicationDidEnterBackground:.
         // Insert code here to handle when the app is about to terminate
-        self.stopMycelium()
         super.applicationWillTerminate(application)
     }
 
@@ -227,6 +229,31 @@ import OSLog
         self.vpnManager?.connection.stopVPNTunnel()
     }
 
+    func queryStatus() {
+        NETunnelProviderManager.loadAllFromPreferences { (providers: [NETunnelProviderManager]?, error: Error?) in
+            if let error = error {
+                errlog("queryStatus loadAllFromPref failed:" + error.localizedDescription)
+                self.flutterChannel?.invokeMethod("notifyMyceliumFinished", arguments: nil)
+                return
+            }
+            guard let providers = providers else {
+                self.flutterChannel?.invokeMethod("notifyMyceliumFinished", arguments: nil)
+                return
+            }
+            let myProvider = providers.first(where: { $0.protocolConfiguration?.serverAddress==self.vpnServerAddress })
+            if let vpnManager = myProvider {
+                switch vpnManager.connection.status {
+                case .connected, .connecting, .reasserting:
+                    self.flutterChannel?.invokeMethod("notifyMyceliumStarted", arguments: nil)
+                default:
+                    self.flutterChannel?.invokeMethod("notifyMyceliumFinished", arguments: nil)
+                }
+            } else {
+                self.flutterChannel?.invokeMethod("notifyMyceliumFinished", arguments: nil)
+            }
+        }
+    }
+
     /*
      TODO: add some handlers to below func
      func applicationWillResignActive(_ application: UIApplication) {

lib/main.dart

@@ -7,7 +7,8 @@ import 'package:flutter/services.dart';
 import 'package:path_provider/path_provider.dart';
 import 'package:logging/logging.dart';
 import 'package:flutter_desktop_sleep/flutter_desktop_sleep.dart';
-import 'package:flutter_window_close/flutter_window_close.dart';
+import 'package:tray_manager/tray_manager.dart';
+import 'package:window_manager/window_manager.dart';
 
 import 'myceliumflut_ffi_binding.dart';
 
@@ -45,7 +46,7 @@ class MyApp extends StatefulWidget {
   State<MyApp> createState() => _MyAppState();
 }
 
-class _MyAppState extends State<MyApp> {
+class _MyAppState extends State<MyApp> with TrayListener, WindowListener, WidgetsBindingObserver {
   static const platform = MethodChannel("tech.threefold.mycelium/tun");
   String _nodeAddr = '';
   var privKey = Uint8List(0);
@@ -58,6 +59,7 @@ class _MyAppState extends State<MyApp> {
   void initState() {
     textEditController = TextEditingController(text: '');
     super.initState();
+    WidgetsBinding.instance.addObserver(this);
     initPlatformState();
     platform.setMethodCallHandler((MethodCall call) async {
       methodHandler(call.method);
@@ -87,16 +89,32 @@ class _MyAppState extends State<MyApp> {
       }
     });
 
-    // only for windows because macos already has own handler
-    if (Platform.isWindows) {
-      FlutterWindowClose.setWindowShouldCloseHandler(() async {
-        _logger.info("Window close handler");
-        if (_isStarted) {
-          stopMycelium();
-        }
-        return true;
-      });
+    _initDesktopLifecycle();
+  }
+
+  Future<void> _initDesktopLifecycle() async {
+    if (!(Platform.isMacOS || Platform.isWindows)) {
+      return;
     }
+
+    await windowManager.ensureInitialized();
+    windowManager.addListener(this);
+    await windowManager.setPreventClose(true);
+
+    trayManager.addListener(this);
+    await trayManager.setIcon('assets/images/mycelium_icon.png');
+    final items = [
+      MenuItem(key: 'show', label: 'Show Window'),
+      MenuItem(key: 'hide', label: 'Hide Window'),
+      MenuItem.separator(),
+      MenuItem(key: 'toggle', label: 'Start/Stop Mycelium'),
+      MenuItem.separator(),
+      MenuItem(key: 'quit', label: 'Quit'),
+    ];
+    await trayManager.setContextMenu(Menu(items: items));
+
+    // Optional: start minimized to tray when app launches on desktop
+    // await windowManager.hide();
   }
 
   void methodHandler(String methodName) {
@@ -172,6 +190,15 @@ class _MyAppState extends State<MyApp> {
     setState(() {
       _nodeAddr = nodeAddr;
     });
+
+    // Query native layer for current VPN status to sync UI
+    if (!isUseDylib()) {
+      try {
+        await platform.invokeMethod('queryStatus');
+      } catch (e) {
+        _logger.warning("queryStatus not implemented: $e");
+      }
+    }
   }
 
   // start/stop mycelium button variables
@@ -187,6 +214,11 @@ class _MyAppState extends State<MyApp> {
   void dispose() {
     // Clean up the controller when the widget is disposed.
     textEditController.dispose();
+    if (Platform.isMacOS || Platform.isWindows) {
+      windowManager.removeListener(this);
+      trayManager.removeListener(this);
+    }
+    WidgetsBinding.instance.removeObserver(this);
     super.dispose();
   }
 
@@ -374,6 +406,17 @@ class _MyAppState extends State<MyApp> {
     );
   }
 
+  @override
+  void didChangeAppLifecycleState(AppLifecycleState state) {
+    if (state == AppLifecycleState.resumed) {
+      if (!isUseDylib()) {
+        platform.invokeMethod('queryStatus').catchError((e) {
+          _logger.warning("queryStatus on resume failed: $e");
+        });
+      }
+    }
+  }
+
   void startMycelium() {
     if (_isStarted) {
       _logger.warning("Mycelium already started");
@@ -487,6 +530,61 @@ class _MyAppState extends State<MyApp> {
       isRestartVisible = true;
     });
   }
+  // Window lifecycle handlers
+  @override
+  void onWindowClose() async {
+    // Intercept close to keep app running in tray
+    await windowManager.hide();
+  }
+
+  // Tray handlers
+  @override
+  void onTrayIconMouseDown() async {
+    if (await windowManager.isVisible()) {
+      await windowManager.hide();
+    } else {
+      await windowManager.show();
+      await windowManager.focus();
+    }
+  }
+
+  @override
+  void onTrayMenuItemClick(MenuItem menuItem) async {
+    switch (menuItem.key) {
+      case 'show':
+        await windowManager.show();
+        await windowManager.focus();
+        break;
+      case 'hide':
+        await windowManager.hide();
+        break;
+      case 'toggle':
+        if (!_isStarted) {
+          startMycelium();
+        } else {
+          stopMycelium();
+        }
+        break;
+      case 'quit':
+        if (_isStarted) {
+          stopMycelium();
+        }
+        // Give a brief moment for stop to propagate
+        await Future.delayed(const Duration(milliseconds: 200));
+        // Terminate application
+        if (Platform.isMacOS) {
+          // Use existing plugin to terminate if available
+          try {
+            _flutterDesktopSleepPlugin.terminateApp();
+          } catch (_) {
+            exit(0);
+          }
+        } else {
+          exit(0);
+        }
+        break;
+    }
+  }
 }
 
 double physicalPxToLogicalPx(BuildContext context, double physicalPx) {

macos/Flutter/GeneratedPluginRegistrant.swift

@@ -8,9 +8,15 @@ import Foundation
 import flutter_desktop_sleep
 import flutter_window_close
 import path_provider_foundation
+import screen_retriever_macos
+import tray_manager
+import window_manager
 
 func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
   FlutterDesktopSleepPlugin.register(with: registry.registrar(forPlugin: "FlutterDesktopSleepPlugin"))
   FlutterWindowClosePlugin.register(with: registry.registrar(forPlugin: "FlutterWindowClosePlugin"))
   PathProviderPlugin.register(with: registry.registrar(forPlugin: "PathProviderPlugin"))
+  ScreenRetrieverMacosPlugin.register(with: registry.registrar(forPlugin: "ScreenRetrieverMacosPlugin"))
+  TrayManagerPlugin.register(with: registry.registrar(forPlugin: "TrayManagerPlugin"))
+  WindowManagerPlugin.register(with: registry.registrar(forPlugin: "WindowManagerPlugin"))
 }