Merge pull request #3425 from Heap-Hop/android_start_on_boot

Android start on boot
2025-10-29 17:00:05 +00:00 · 2023-03-01 11:06:24 +08:00
parent 492ca411e9 cff2ca9df8
commit b10e76f67b
49 changed files with 602 additions and 337 deletions
--- a/flutter/lib/common.dart
+++ b/flutter/lib/common.dart
@@ -910,21 +910,14 @@ class AccessibilityListener extends StatelessWidget {
  }
 }

-class PermissionManager {
+class AndroidPermissionManager {
  static Completer<bool>? _completer;
  static Timer? _timer;
  static var _current = "";

-  static final permissions = [
-    "audio",
-    "file",
-    "ignore_battery_optimizations",
-    "application_details_settings"
-  ];
-
  static bool isWaitingFile() {
    if (_completer != null) {
-      return !_completer!.isCompleted && _current == "file";
+      return !_completer!.isCompleted && _current == kManageExternalStorage;
    }
    return false;
  }
@@ -933,31 +926,33 @@ class PermissionManager {
    if (isDesktop) {
      return Future.value(true);
    }
-    if (!permissions.contains(type)) {
-      return Future.error("Wrong permission!$type");
-    }
    return gFFI.invokeMethod("check_permission", type);
  }

+  // startActivity goto Android Setting's page to request permission manually by user
+  static void startAction(String action) {
+    gFFI.invokeMethod(AndroidChannel.kStartAction, action);
+  }
+
+  /// We use XXPermissions to request permissions,
+  /// for supported types, see https://github.com/getActivity/XXPermissions/blob/e46caea32a64ad7819df62d448fb1c825481cd28/library/src/main/java/com/hjq/permissions/Permission.java
  static Future<bool> request(String type) {
    if (isDesktop) {
      return Future.value(true);
    }
-    if (!permissions.contains(type)) {
-      return Future.error("Wrong permission!$type");
-    }

    gFFI.invokeMethod("request_permission", type);
-    if (type == "ignore_battery_optimizations") {
-      return Future.value(false);
+
+    // clear last task
+    if (_completer?.isCompleted == false) {
+      _completer?.complete(false);
    }
+    _timer?.cancel();
+
    _current = type;
    _completer = Completer<bool>();
-    gFFI.invokeMethod("request_permission", type);

-    // timeout
-    _timer?.cancel();
-    _timer = Timer(Duration(seconds: 60), () {
+    _timer = Timer(Duration(seconds: 120), () {
      if (_completer == null) return;
      if (!_completer!.isCompleted) {
        _completer!.complete(false);
@@ -1487,8 +1482,8 @@ connect(BuildContext context, String id,
    }
  } else {
    if (isFileTransfer) {
-      if (!await PermissionManager.check("file")) {
-        if (!await PermissionManager.request("file")) {
+      if (!await AndroidPermissionManager.check(kManageExternalStorage)) {
+        if (!await AndroidPermissionManager.request(kManageExternalStorage)) {
          return;
        }
      }
--- a/flutter/lib/consts.dart
+++ b/flutter/lib/consts.dart
@@ -59,11 +59,12 @@ const double kDesktopFileTransferMaximumWidth = 300;
 const double kDesktopFileTransferRowHeight = 30.0;
 const double kDesktopFileTransferHeaderHeight = 25.0;

-EdgeInsets get kDragToResizeAreaPadding => !kUseCompatibleUiMode && Platform.isLinux
-    ? stateGlobal.fullscreen || stateGlobal.maximize
-        ? EdgeInsets.zero
-        : EdgeInsets.all(5.0)
-    : EdgeInsets.zero;
+EdgeInsets get kDragToResizeAreaPadding =>
+    !kUseCompatibleUiMode && Platform.isLinux
+        ? stateGlobal.fullscreen || stateGlobal.maximize
+            ? EdgeInsets.zero
+            : EdgeInsets.all(5.0)
+        : EdgeInsets.zero;
 // https://en.wikipedia.org/wiki/Non-breaking_space
 const int $nbsp = 0x00A0;

@@ -136,6 +137,25 @@ const kRemoteAudioDualWay = 'dual-way';

 const kIgnoreDpi = true;

+/// Android constants
+const kActionApplicationDetailsSettings =
+    "android.settings.APPLICATION_DETAILS_SETTINGS";
+const kActionAccessibilitySettings = "android.settings.ACCESSIBILITY_SETTINGS";
+
+const kRecordAudio = "android.permission.RECORD_AUDIO";
+const kManageExternalStorage = "android.permission.MANAGE_EXTERNAL_STORAGE";
+const kRequestIgnoreBatteryOptimizations =
+    "android.permission.REQUEST_IGNORE_BATTERY_OPTIMIZATIONS";
+const kSystemAlertWindow = "android.permission.SYSTEM_ALERT_WINDOW";
+
+/// Android channel invoke type key
+class AndroidChannel {
+  static final kStartAction = "start_action";
+  static final kGetStartOnBootOpt = "get_start_on_boot_opt";
+  static final kSetStartOnBootOpt = "set_start_on_boot_opt";
+  static final kSyncAppDirConfigPath = "sync_app_dir";
+}
+
 /// flutter/packages/flutter/lib/src/services/keyboard_key.dart -> _keyLabels
 /// see [LogicalKeyboardKey.keyLabel]
 const Map<int, String> logicalKeyMap = <int, String>{
--- a/flutter/lib/main.dart
+++ b/flutter/lib/main.dart
@@ -153,6 +153,7 @@ void runMainApp(bool startService) async {
 void runMobileApp() async {
  await initEnv(kAppTypeMain);
  if (isAndroid) androidChannelInit();
+  platformFFI.syncAndroidServiceAppDirConfigPath();
  runApp(App());
 }

--- a/flutter/lib/mobile/pages/server_page.dart
+++ b/flutter/lib/mobile/pages/server_page.dart
@@ -6,6 +6,7 @@ import 'package:provider/provider.dart';

 import '../../common.dart';
 import '../../common/widgets/dialog.dart';
+import '../../consts.dart';
 import '../../models/platform_model.dart';
 import '../../models/server_model.dart';
 import 'home_page.dart';
@@ -40,14 +41,14 @@ class ServerPage extends StatefulWidget implements PageShape {
              value: "setTemporaryPasswordLength",
              enabled:
                  gFFI.serverModel.verificationMethod != kUsePermanentPassword,
-              child: Text(translate("Set temporary password length")),
+              child: Text(translate("One-time password length")),
            ),
            const PopupMenuDivider(),
            PopupMenuItem(
              padding: const EdgeInsets.symmetric(horizontal: 0.0),
              value: kUseTemporaryPassword,
              child: ListTile(
-                  title: Text(translate("Use temporary password")),
+                  title: Text(translate("Use one-time password")),
                  trailing: Icon(
                    Icons.check,
                    color: gFFI.serverModel.verificationMethod ==
@@ -150,10 +151,11 @@ class _ServerPageState extends State<ServerPage> {
 }

 void checkService() async {
-  gFFI.invokeMethod("check_service"); // jvm
-  // for Android 10/11,MANAGE_EXTERNAL_STORAGE permission from a system setting page
-  if (PermissionManager.isWaitingFile() && !gFFI.serverModel.fileOk) {
-    PermissionManager.complete("file", await PermissionManager.check("file"));
+  gFFI.invokeMethod("check_service");
+  // for Android 10/11, request MANAGE_EXTERNAL_STORAGE permission from system setting page
+  if (AndroidPermissionManager.isWaitingFile() && !gFFI.serverModel.fileOk) {
+    AndroidPermissionManager.complete(kManageExternalStorage,
+        await AndroidPermissionManager.check(kManageExternalStorage));
    debugPrint("file permission finished");
  }
 }
@@ -567,7 +569,7 @@ void androidChannelInit() {
          {
            var type = arguments["type"] as String;
            var result = arguments["result"] as bool;
-            PermissionManager.complete(type, result);
+            AndroidPermissionManager.complete(type, result);
            break;
          }
        case "on_media_projection_canceled":
--- a/flutter/lib/mobile/pages/settings_page.dart
+++ b/flutter/lib/mobile/pages/settings_page.dart
@@ -10,6 +10,7 @@ import 'package:url_launcher/url_launcher.dart';
 import '../../common.dart';
 import '../../common/widgets/dialog.dart';
 import '../../common/widgets/login.dart';
+import '../../consts.dart';
 import '../../models/model.dart';
 import '../../models/platform_model.dart';
 import '../widgets/dialog.dart';
@@ -31,18 +32,20 @@ class SettingsPage extends StatefulWidget implements PageShape {
 }

 const url = 'https://rustdesk.com/';
-final _hasIgnoreBattery = androidVersion >= 26;
-var _ignoreBatteryOpt = false;
-var _enableAbr = false;
-var _denyLANDiscovery = false;
-var _onlyWhiteList = false;
-var _enableDirectIPAccess = false;
-var _enableRecordSession = false;
-var _autoRecordIncomingSession = false;
-var _localIP = "";
-var _directAccessPort = "";

 class _SettingsState extends State<SettingsPage> with WidgetsBindingObserver {
+  final _hasIgnoreBattery = androidVersion >= 26;
+  var _ignoreBatteryOpt = false;
+  var _enableStartOnBoot = false;
+  var _enableAbr = false;
+  var _denyLANDiscovery = false;
+  var _onlyWhiteList = false;
+  var _enableDirectIPAccess = false;
+  var _enableRecordSession = false;
+  var _autoRecordIncomingSession = false;
+  var _localIP = "";
+  var _directAccessPort = "";
+
  @override
  void initState() {
    super.initState();
@@ -50,11 +53,34 @@ class _SettingsState extends State<SettingsPage> with WidgetsBindingObserver {

    () async {
      var update = false;
+
      if (_hasIgnoreBattery) {
-        update = await updateIgnoreBatteryStatus();
+        if (await checkAndUpdateIgnoreBatteryStatus()) {
+          update = true;
+        }
      }

-      final enableAbrRes = await bind.mainGetOption(key: "enable-abr") != "N";
+      if (await checkAndUpdateStartOnBoot()) {
+        update = true;
+      }
+
+      // start on boot depends on ACTION_IGNORE_BATTERY_OPTIMIZATION_SETTINGS and SYSTEM_ALERT_WINDOW
+      var enableStartOnBoot =
+          await gFFI.invokeMethod(AndroidChannel.kGetStartOnBootOpt);
+      if (enableStartOnBoot) {
+        if (!await canStartOnBoot()) {
+          enableStartOnBoot = false;
+          gFFI.invokeMethod(AndroidChannel.kSetStartOnBootOpt, false);
+        }
+      }
+
+      if (enableStartOnBoot != _enableStartOnBoot) {
+        update = true;
+        _enableStartOnBoot = enableStartOnBoot;
+      }
+
+      final enableAbrRes = option2bool(
+          "enable-abr", await bind.mainGetOption(key: "enable-abr"));
      if (enableAbrRes != _enableAbr) {
        update = true;
        _enableAbr = enableAbrRes;
@@ -125,15 +151,18 @@ class _SettingsState extends State<SettingsPage> with WidgetsBindingObserver {
  void didChangeAppLifecycleState(AppLifecycleState state) {
    if (state == AppLifecycleState.resumed) {
      () async {
-        if (await updateIgnoreBatteryStatus()) {
+        final ibs = await checkAndUpdateIgnoreBatteryStatus();
+        final sob = await checkAndUpdateStartOnBoot();
+        if (ibs || sob) {
          setState(() {});
        }
      }();
    }
  }

-  Future<bool> updateIgnoreBatteryStatus() async {
-    final res = await PermissionManager.check("ignore_battery_optimizations");
+  Future<bool> checkAndUpdateIgnoreBatteryStatus() async {
+    final res = await AndroidPermissionManager.check(
+        kRequestIgnoreBatteryOptimizations);
    if (_ignoreBatteryOpt != res) {
      _ignoreBatteryOpt = res;
      return true;
@@ -142,6 +171,18 @@ class _SettingsState extends State<SettingsPage> with WidgetsBindingObserver {
    }
  }

+  Future<bool> checkAndUpdateStartOnBoot() async {
+    if (!await canStartOnBoot() && _enableStartOnBoot) {
+      _enableStartOnBoot = false;
+      debugPrint(
+          "checkAndUpdateStartOnBoot and set _enableStartOnBoot -> false");
+      gFFI.invokeMethod(AndroidChannel.kSetStartOnBootOpt, false);
+      return true;
+    } else {
+      return false;
+    }
+  }
+
  @override
  Widget build(BuildContext context) {
    Provider.of<FfiModel>(context);
@@ -265,7 +306,8 @@ class _SettingsState extends State<SettingsPage> with WidgetsBindingObserver {
                  ]),
              onToggle: (v) async {
                if (v) {
-                  PermissionManager.request("ignore_battery_optimizations");
+                  await AndroidPermissionManager.request(
+                      kRequestIgnoreBatteryOptimizations);
                } else {
                  final res = await gFFI.dialogManager
                      .show<bool>((setState, close) => CustomAlertDialog(
@@ -282,11 +324,44 @@ class _SettingsState extends State<SettingsPage> with WidgetsBindingObserver {
                            ],
                          ));
                  if (res == true) {
-                    PermissionManager.request("application_details_settings");
+                    AndroidPermissionManager.startAction(
+                        kActionApplicationDetailsSettings);
                  }
                }
              }));
    }
+    enhancementsTiles.add(SettingsTile.switchTile(
+        initialValue: _enableStartOnBoot,
+        title: Column(crossAxisAlignment: CrossAxisAlignment.start, children: [
+          Text("${translate('Start on Boot')} (beta)"),
+          Text(
+              '* ${translate('Start the screen sharing service on boot, requires special permissions')}',
+              style: Theme.of(context).textTheme.bodySmall),
+        ]),
+        onToggle: (toValue) async {
+          if (toValue) {
+            // 1. request kIgnoreBatteryOptimizations
+            if (!await AndroidPermissionManager.check(
+                kRequestIgnoreBatteryOptimizations)) {
+              if (!await AndroidPermissionManager.request(
+                  kRequestIgnoreBatteryOptimizations)) {
+                return;
+              }
+            }
+
+            // 2. request kSystemAlertWindow
+            if (!await AndroidPermissionManager.check(kSystemAlertWindow)) {
+              if (!await AndroidPermissionManager.request(kSystemAlertWindow)) {
+                return;
+              }
+            }
+
+            // (Optional) 3. request input permission
+          }
+          setState(() => _enableStartOnBoot = toValue);
+
+          gFFI.invokeMethod(AndroidChannel.kSetStartOnBootOpt, toValue);
+        }));

    return SettingsList(
      sections: [
@@ -387,6 +462,17 @@ class _SettingsState extends State<SettingsPage> with WidgetsBindingObserver {
      ],
    );
  }
+
+  Future<bool> canStartOnBoot() async {
+    // start on boot depends on ACTION_IGNORE_BATTERY_OPTIMIZATION_SETTINGS and SYSTEM_ALERT_WINDOW
+    if (_hasIgnoreBattery && !_ignoreBatteryOpt) {
+      return false;
+    }
+    if (!await AndroidPermissionManager.check(kSystemAlertWindow)) {
+      return false;
+    }
+    return true;
+  }
 }

 void showServerSettings(OverlayDialogManager dialogManager) async {
--- a/flutter/lib/models/native_model.dart
+++ b/flutter/lib/models/native_model.dart
@@ -30,7 +30,7 @@ typedef F4Dart = int Function(Pointer<Utf8>);
 typedef F5 = Void Function(Pointer<Utf8>);
 typedef F5Dart = void Function(Pointer<Utf8>);
 typedef HandleEvent = Future<void> Function(Map<String, dynamic> evt);
-// pub fn session_register_texture(id: *const char, ptr: usize) 
+// pub fn session_register_texture(id: *const char, ptr: usize)
 typedef F6 = Void Function(Pointer<Utf8>, Uint64);
 typedef F6Dart = void Function(Pointer<Utf8>, int);

@@ -56,7 +56,6 @@ class PlatformFFI {
  F4Dart? _session_get_rgba_size;
  F5Dart? _session_next_rgba;
  F6Dart? _session_register_texture;
-  

  static get localeName => Platform.localeName;

@@ -162,7 +161,8 @@ class PlatformFFI {
          dylib.lookupFunction<F4, F4Dart>("session_get_rgba_size");
      _session_next_rgba =
          dylib.lookupFunction<F5, F5Dart>("session_next_rgba");
-      _session_register_texture = dylib.lookupFunction<F6, F6Dart>("session_register_texture");
+      _session_register_texture =
+          dylib.lookupFunction<F6, F6Dart>("session_register_texture");
      try {
        // SYSTEM user failed
        _dir = (await getApplicationDocumentsDirectory()).path;
@@ -301,4 +301,8 @@ class PlatformFFI {
    if (!isAndroid) return Future<bool>(() => false);
    return await _toAndroidChannel.invokeMethod(method, arguments);
  }
+
+  void syncAndroidServiceAppDirConfigPath() {
+    invokeMethod(AndroidChannel.kSyncAppDirConfigPath, _dir);
+  }
 }
--- a/flutter/lib/models/server_model.dart
+++ b/flutter/lib/models/server_model.dart
@@ -3,6 +3,7 @@ import 'dart:convert';
 import 'dart:io';

 import 'package:flutter/material.dart';
+import 'package:flutter_hbb/consts.dart';
 import 'package:flutter_hbb/main.dart';
 import 'package:flutter_hbb/models/platform_model.dart';
 import 'package:get/get.dart';
@@ -154,7 +155,8 @@ class ServerModel with ChangeNotifier {
  /// file true by default (if permission on)
  checkAndroidPermission() async {
    // audio
-    if (androidVersion < 30 || !await PermissionManager.check("audio")) {
+    if (androidVersion < 30 ||
+        !await AndroidPermissionManager.check(kRecordAudio)) {
      _audioOk = false;
      bind.mainSetOption(key: "enable-audio", value: "N");
    } else {
@@ -163,7 +165,7 @@ class ServerModel with ChangeNotifier {
    }

    // file
-    if (!await PermissionManager.check("file")) {
+    if (!await AndroidPermissionManager.check(kManageExternalStorage)) {
      _fileOk = false;
      bind.mainSetOption(key: "enable-file-transfer", value: "N");
    } else {
@@ -229,10 +231,10 @@ class ServerModel with ChangeNotifier {
  }

  toggleAudio() async {
-    if (!_audioOk && !await PermissionManager.check("audio")) {
-      final res = await PermissionManager.request("audio");
+    if (!_audioOk && !await AndroidPermissionManager.check(kRecordAudio)) {
+      final res = await AndroidPermissionManager.request(kRecordAudio);
      if (!res) {
-        // TODO handle fail
+        showToast(translate('Failed'));
        return;
      }
    }
@@ -243,10 +245,12 @@ class ServerModel with ChangeNotifier {
  }

  toggleFile() async {
-    if (!_fileOk && !await PermissionManager.check("file")) {
-      final res = await PermissionManager.request("file");
+    if (!_fileOk &&
+        !await AndroidPermissionManager.check(kManageExternalStorage)) {
+      final res =
+          await AndroidPermissionManager.request(kManageExternalStorage);
      if (!res) {
-        // TODO handle fail
+        showToast(translate('Failed'));
        return;
      }
    }
@@ -344,10 +348,6 @@ class ServerModel with ChangeNotifier {
    }
  }

-  Future<void> initInput() async {
-    await parent.target?.invokeMethod("init_input");
-  }
-
  Future<bool> setPermanentPassword(String newPW) async {
    await bind.mainSetPermanentPassword(password: newPW);
    await Future.delayed(Duration(milliseconds: 500));
@@ -561,7 +561,8 @@ class ServerModel with ChangeNotifier {
  }

  Future<void> closeAll() async {
-    await Future.wait(_clients.map((client) => bind.cmCloseConnection(connId: client.id)));
+    await Future.wait(
+        _clients.map((client) => bind.cmCloseConnection(connId: client.id)));
    _clients.clear();
    tabController.state.value.tabs.clear();
  }
@@ -684,7 +685,7 @@ String getLoginDialogTag(int id) {
 showInputWarnAlert(FFI ffi) {
  ffi.dialogManager.show((setState, close) {
    submit() {
-      ffi.serverModel.initInput();
+      AndroidPermissionManager.startAction(kActionAccessibilitySettings);
      close();
    }