refactor(neon_framework): Remove url launcher hack

Signed-off-by: provokateurin <[email protected]>
nextcloud · Aug 16, 2024 · fe381fb · fe381fb
1 parent 755b28d
commit fe381fb
Show file tree

Hide file tree

Showing 35 changed files with 165 additions and 437 deletions.
diff --git a/packages/neon_framework/lib/src/models/account.dart b/packages/neon_framework/lib/src/models/account.dart
@@ -142,11 +142,6 @@ abstract class Account implements Credentials, Findable, Built<Account, AccountB
 
     return null;
   }
-
-  /// Removes the [serverURL] part from the [uri].
-  ///
-  /// Should be used when trying to push a [uri] from an API to the router as it might contain the scheme, host and sub path of the instance which will not work with the router.
-  Uri stripUri(Uri uri) => Uri.parse(uri.toString().replaceFirst(serverURL.toString(), ''));
 }
 
 /// QRcode Login credentials.

diff --git a/packages/neon_framework/lib/src/pages/account_settings.dart b/packages/neon_framework/lib/src/pages/account_settings.dart
@@ -14,7 +14,6 @@ import 'package:neon_framework/src/theme/dialog.dart';
 import 'package:neon_framework/src/widgets/dialog.dart';
 import 'package:neon_framework/src/widgets/error.dart';
 import 'package:neon_framework/utils.dart';
-import 'package:url_launcher/url_launcher.dart';
 
 /// Account settings page.
 ///
@@ -54,11 +53,9 @@ class AccountSettingsPage extends StatelessWidget {
               case null:
                 break;
               case AccountDeletion.remote:
-                await launchUrl(
-                  account.serverURL.replace(
-                    path: '${account.serverURL.path}/index.php/settings/user/drop_account',
-                  ),
-                );
+                if (context.mounted) {
+                  await launchUrl(NeonProvider.of<Account>(context), '/index.php/settings/user/drop_account');
+                }
               case AccountDeletion.local:
                 final isActive = bloc.activeAccount.valueOrNull == account;
 

diff --git a/packages/neon_framework/lib/src/pages/login_flow.dart b/packages/neon_framework/lib/src/pages/login_flow.dart
@@ -2,14 +2,14 @@ import 'dart:async';
 
 import 'package:flutter/material.dart';
 import 'package:meta/meta.dart';
-import 'package:neon_framework/l10n/localizations.dart';
+import 'package:neon_framework/models.dart';
 import 'package:neon_framework/src/bloc/result.dart';
 import 'package:neon_framework/src/blocs/login_flow.dart';
 import 'package:neon_framework/src/router.dart';
 import 'package:neon_framework/src/widgets/error.dart';
 import 'package:neon_framework/src/widgets/linear_progress_indicator.dart';
+import 'package:neon_framework/utils.dart';
 import 'package:nextcloud/core.dart' as core;
-import 'package:url_launcher/url_launcher_string.dart';
 
 @internal
 class LoginFlowPage extends StatefulWidget {
@@ -39,10 +39,7 @@ class _LoginFlowPageState extends State<LoginFlowPage> {
 
     initSubscription = bloc.init.listen((result) async {
       if (result.hasData) {
-        await launchUrlString(
-          result.requireData.login,
-          mode: LaunchMode.externalApplication,
-        );
+        await launchUrl(NeonProvider.of<Account>(context), result.requireData.login);
       }
     });
 

diff --git a/packages/neon_framework/lib/src/pages/settings.dart b/packages/neon_framework/lib/src/pages/settings.dart
@@ -5,9 +5,8 @@ import 'package:flutter/material.dart';
 import 'package:flutter_material_design_icons/flutter_material_design_icons.dart';
 import 'package:logging/logging.dart';
 import 'package:meta/meta.dart';
-import 'package:neon_framework/l10n/localizations.dart';
+import 'package:neon_framework/models.dart';
 import 'package:neon_framework/src/blocs/accounts.dart';
-import 'package:neon_framework/src/models/app_implementation.dart';
 import 'package:neon_framework/src/platform/platform.dart';
 import 'package:neon_framework/src/router.dart';
 import 'package:neon_framework/src/settings/utils/settings_export_helper.dart';
@@ -21,15 +20,13 @@ import 'package:neon_framework/src/settings/widgets/text_settings_tile.dart';
 import 'package:neon_framework/src/theme/branding.dart';
 import 'package:neon_framework/src/theme/dialog.dart';
 import 'package:neon_framework/src/theme/icons.dart';
-import 'package:neon_framework/src/utils/adaptive.dart';
 import 'package:neon_framework/src/utils/global_options.dart';
-import 'package:neon_framework/src/utils/provider.dart';
 import 'package:neon_framework/src/widgets/dialog.dart';
 import 'package:neon_framework/src/widgets/error.dart';
+import 'package:neon_framework/utils.dart';
 import 'package:nextcloud/utils.dart';
 import 'package:package_info_plus/package_info_plus.dart';
 import 'package:timezone/timezone.dart' as tz;
-import 'package:url_launcher/url_launcher_string.dart';
 
 final _log = Logger('SettingsPage');
 
@@ -196,10 +193,7 @@ class SettingsPage extends StatelessWidget {
                 ),
                 title: Text(NeonLocalizations.of(context).sourceCode),
                 onTap: () async {
-                  await launchUrlString(
-                    branding.sourceCodeURL!,
-                    mode: LaunchMode.externalApplication,
-                  );
+                  await launchUrl(NeonProvider.of<Account>(context), branding.sourceCodeURL!);
                 },
               ),
             if (branding.issueTrackerURL != null)
@@ -210,10 +204,7 @@ class SettingsPage extends StatelessWidget {
                 ),
                 title: Text(NeonLocalizations.of(context).issueTracker),
                 onTap: () async {
-                  await launchUrlString(
-                    branding.issueTrackerURL!,
-                    mode: LaunchMode.externalApplication,
-                  );
+                  await launchUrl(NeonProvider.of<Account>(context), branding.issueTrackerURL!);
                 },
               ),
             CustomSettingsTile(

diff --git a/packages/neon_framework/lib/src/router.dart b/packages/neon_framework/lib/src/router.dart
@@ -8,7 +8,6 @@ import 'package:flutter/material.dart';
 import 'package:go_router/go_router.dart';
 import 'package:meta/meta.dart';
 import 'package:neon_framework/src/blocs/accounts.dart';
-import 'package:neon_framework/src/blocs/capabilities.dart';
 import 'package:neon_framework/src/models/account.dart';
 import 'package:neon_framework/src/models/app_implementation.dart';
 import 'package:neon_framework/src/pages/account_settings.dart';
@@ -23,7 +22,6 @@ import 'package:neon_framework/src/pages/route_not_found.dart';
 import 'package:neon_framework/src/pages/settings.dart';
 import 'package:neon_framework/src/utils/findable.dart';
 import 'package:neon_framework/src/utils/provider.dart';
-import 'package:url_launcher/url_launcher.dart';
 
 part 'router.g.dart';
 
@@ -36,49 +34,16 @@ GoRouter buildAppRouter({
       debugLogDiagnostics: kDebugMode,
       navigatorKey: navigatorKey,
       initialLocation: const HomeRoute().location,
-      onException: onException,
+      errorBuilder: (context, state) => RouteNotFoundPage(
+        uri: state.uri,
+      ),
       redirect: redirect,
       routes: $appRoutes,
     );
 
-/// Handles routing exceptions thrown by the [GoRouter] of [buildAppRouter].
-@visibleForTesting
-Future<void> onException(BuildContext context, GoRouterState state, GoRouter router) async {
-  final accountsBloc = NeonProvider.of<AccountsBloc>(context);
-  if (accountsBloc.hasAccounts) {
-    final capabilitiesBloc = NeonProvider.of<CapabilitiesBloc>(context);
-    final capabilities = capabilitiesBloc.capabilities.valueOrNull?.data;
-    final modRewriteWorking = capabilities?.capabilities.coreCapabilities?.core.modRewriteWorking ?? false;
-
-    final account = NeonProvider.of<Account>(context);
-    var uri = account.completeUri(state.uri);
-
-    if (uri != state.uri && !modRewriteWorking && !uri.path.startsWith('/index.php')) {
-      uri = uri.replace(path: '/index.php${uri.path}');
-    }
-
-    await launchUrl(
-      uri,
-      mode: LaunchMode.externalApplication,
-    );
-
-    return;
-  }
-
-  if (!context.mounted) {
-    return;
-  }
-
-  await router.push(RouteNotFoundRoute(uri: state.uri).location);
-}
-
 /// Handles redirects of the [GoRouter] of [buildAppRouter].
 @visibleForTesting
 String? redirect(BuildContext context, GoRouterState state) {
-  if (state.uri.path.startsWith('/index.php/')) {
-    return state.uri.path.substring(10);
-  }
-
   final loginQRcode = LoginQRcode.tryParse(state.uri.toString());
   if (loginQRcode != null) {
     return LoginCheckServerStatusWithCredentialsRoute(
@@ -88,17 +53,9 @@ String? redirect(BuildContext context, GoRouterState state) {
     ).location;
   }
 
-  final accountsBloc = NeonProvider.of<AccountsBloc>(context);
-  if (accountsBloc.hasAccounts && state.uri.hasScheme) {
-    final account = NeonProvider.of<Account>(context);
-    final strippedUri = account.stripUri(state.uri);
-    if (strippedUri != state.uri) {
-      return strippedUri.toString();
-    }
-  }
-
-  // Redirect to login screen when no account is logged in
+  // Redirect to login screen when no account is logged in.
   // We only check the prefix of the current location as we also don't want to redirect on any of the other login routes.
+  final accountsBloc = NeonProvider.of<AccountsBloc>(context);
   if (!accountsBloc.hasAccounts && !state.matchedLocation.startsWith(const LoginRoute().location)) {
     return const LoginRoute().location;
   }
@@ -132,28 +89,6 @@ class AccountSettingsRoute extends GoRouteData {
   }
 }
 
-/// {@template AppRoutes.RouteNotFoundRoute}
-/// Route for the [RouteNotFoundPage].
-/// {@endtemplate}
-@TypedGoRoute<RouteNotFoundRoute>(path: '/not-found/:uri')
-@immutable
-class RouteNotFoundRoute extends GoRouteData {
-  /// {@macro AppRoutes.RouteNotFoundRoute}
-  const RouteNotFoundRoute({
-    required this.uri,
-  });
-
-  /// The URI of the route that caused the error.
-  final Uri uri;
-
-  @override
-  Widget build(BuildContext context, GoRouterState state) {
-    return RouteNotFoundPage(
-      uri: uri,
-    );
-  }
-}
-
 /// {@template AppRoutes.HomeRoute}
 /// Route for the [HomePage].
 /// {@endtemplate}

diff --git a/packages/neon_framework/lib/src/router.g.dart b/packages/neon_framework/lib/src/router.g.dart
diff --git a/packages/neon_framework/lib/src/utils/launch_url.dart b/packages/neon_framework/lib/src/utils/launch_url.dart
@@ -0,0 +1,10 @@
+import 'package:neon_framework/models.dart';
+import 'package:url_launcher/url_launcher.dart' as url_launcher;
+
+/// Completes the [url] using the [account] if necessary and launches it in an external application.
+Future<bool> launchUrl(Account account, String url) async {
+  return url_launcher.launchUrl(
+    account.completeUri(Uri.parse(url)),
+    mode: url_launcher.LaunchMode.externalApplication,
+  );
+}
diff --git a/packages/neon_framework/lib/src/widgets/app_bar.dart b/packages/neon_framework/lib/src/widgets/app_bar.dart
@@ -1,12 +1,13 @@
 import 'dart:async';
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
 import 'package:meta/meta.dart';
 import 'package:neon_framework/blocs.dart';
 import 'package:neon_framework/l10n/localizations.dart';
+import 'package:neon_framework/models.dart';
 import 'package:neon_framework/src/blocs/unified_search.dart';
 import 'package:neon_framework/src/utils/global_options.dart' as global_options;
+import 'package:neon_framework/src/utils/launch_url.dart';
 import 'package:neon_framework/src/utils/provider.dart';
 import 'package:neon_framework/src/widgets/account_switcher_button.dart';
 import 'package:neon_framework/src/widgets/unified_search_results.dart';
@@ -106,9 +107,9 @@ class _NeonAppBarState extends State<NeonAppBar> {
               viewBuilder: (_) => Padding(
                 padding: const EdgeInsets.all(8),
                 child: NeonUnifiedSearchResults(
-                  onSelected: (entry) {
-                    context.go(entry.resourceUrl);
+                  onSelected: (entry) async {
                     searchController.closeView('');
+                    await launchUrl(NeonProvider.of<Account>(context), entry.resourceUrl);
                   },
                 ),
               ),

diff --git a/packages/neon_framework/lib/src/widgets/dialog.dart b/packages/neon_framework/lib/src/widgets/dialog.dart
@@ -21,7 +21,6 @@ import 'package:nextcloud/core.dart' as core;
 import 'package:nextcloud/user_status.dart' as user_status;
 import 'package:nextcloud/utils.dart';
 import 'package:timezone/timezone.dart' as tz;
-import 'package:url_launcher/url_launcher_string.dart';
 
 /// An button typically used in an [AlertDialog.adaptive].
 ///
@@ -700,10 +699,7 @@ class NeonUnifiedPushDialog extends StatelessWidget {
           isDefaultAction: true,
           onPressed: () async {
             Navigator.pop(context);
-            await launchUrlString(
-              'https://f-droid.org/packages/$unifiedPushNextPushID',
-              mode: LaunchMode.externalApplication,
-            );
+            await launchUrl(NeonProvider.of<Account>(context), 'https://f-droid.org/packages/$unifiedPushNextPushID');
           },
           child: Text(
             NeonLocalizations.of(context).nextPushSupportedInstall,

diff --git a/packages/neon_framework/lib/utils.dart b/packages/neon_framework/lib/utils.dart
@@ -5,6 +5,7 @@ export 'package:neon_framework/src/utils/dialog.dart';
 export 'package:neon_framework/src/utils/exceptions.dart';
 export 'package:neon_framework/src/utils/findable.dart';
 export 'package:neon_framework/src/utils/hex_color.dart';
+export 'package:neon_framework/src/utils/launch_url.dart';
 export 'package:neon_framework/src/utils/provider.dart';
 export 'package:neon_framework/src/utils/request_manager.dart' show RequestManager, UnwrapCallback;
 export 'package:neon_framework/src/utils/validators.dart';
diff --git a/packages/neon_framework/packages/dashboard_app/lib/src/widgets/widget.dart b/packages/neon_framework/packages/dashboard_app/lib/src/widgets/widget.dart
@@ -1,6 +1,7 @@
 import 'package:dashboard_app/l10n/localizations.dart';
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:neon_framework/models.dart';
+import 'package:neon_framework/utils.dart';
 import 'package:nextcloud/dashboard.dart' as dashboard;
 
 /// Displays a single dashboard widget and its items.
@@ -31,7 +32,7 @@ class DashboardWidget extends StatelessWidget {
       child = Tooltip(
         message: DashboardLocalizations.of(context).openWidget,
         child: InkWell(
-          onTap: () => context.go(widget.widgetUrl!),
+          onTap: () async => launchUrl(NeonProvider.of<Account>(context), widget.widgetUrl!),
           borderRadius: const BorderRadius.all(Radius.circular(12)),
           child: child,
         ),

diff --git a/packages/neon_framework/packages/dashboard_app/lib/src/widgets/widget_button.dart b/packages/neon_framework/packages/dashboard_app/lib/src/widgets/widget_button.dart
@@ -1,6 +1,7 @@
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:neon_framework/models.dart';
 import 'package:neon_framework/theme.dart';
+import 'package:neon_framework/utils.dart';
 import 'package:nextcloud/dashboard.dart' as dashboard;
 
 /// Button inside a dashboard widget that is used to trigger an action.
@@ -16,7 +17,7 @@ class DashboardWidgetButton extends StatelessWidget {
 
   @override
   Widget build(BuildContext context) {
-    void onPressed() => context.go(button.link);
+    Future<void> onPressed() async => launchUrl(NeonProvider.of<Account>(context), button.link);
     final label = Text(button.text);
     final icon = switch (button.type) {
       'new' => AdaptiveIcons.add,

diff --git a/packages/neon_framework/packages/dashboard_app/lib/src/widgets/widget_item.dart b/packages/neon_framework/packages/dashboard_app/lib/src/widgets/widget_item.dart
@@ -1,5 +1,4 @@
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
 import 'package:neon_framework/models.dart';
 import 'package:neon_framework/theme.dart';
 import 'package:neon_framework/utils.dart';
@@ -74,7 +73,7 @@ class DashboardWidgetItem extends StatelessWidget {
         maxLines: 1,
       ),
       leading: leading,
-      onTap: item.link.isNotEmpty ? () => context.go(item.link) : null,
+      onTap: item.link.isNotEmpty ? () async => launchUrl(NeonProvider.of<Account>(context), item.link) : null,
     );
   }
 }
diff --git a/packages/neon_framework/packages/dashboard_app/pubspec.yaml b/packages/neon_framework/packages/dashboard_app/pubspec.yaml
@@ -36,6 +36,7 @@ dev_dependencies:
       url: https://github.com/nextcloud/neon
       path: packages/neon_lints
   provider: ^6.1.2
+  url_launcher_platform_interface: ^2.3.2
   vector_graphics_compiler: ^1.1.11+1
 
 flutter: