feat: Migrate to go_router

2025-12-10 18:07:59 -06:00 · 2023-07-30 23:51:00 +02:00
parent 61336d9527
commit f1398e6d4c
78 changed files with 2206 additions and 1756 deletions
--- a/lib/features/login/cubit/authentication_cubit.dart
+++ b/lib/features/login/cubit/authentication_cubit.dart
@@ -55,12 +55,11 @@ class AuthenticationCubit extends Cubit<AuthenticationState> {
    // Mark logged in user as currently active user.
    final globalSettings =
        Hive.box<GlobalSettings>(HiveBoxes.globalSettings).getValue()!;
-    globalSettings.currentLoggedInUser = localUserId;
+    globalSettings.loggedInUserId = localUserId;
    await globalSettings.save();

    emit(
      AuthenticationState.authenticated(
-        apiVersion: apiVersion,
        localUserId: localUserId,
      ),
    );
@@ -75,7 +74,8 @@ class AuthenticationCubit extends Cubit<AuthenticationState> {
    emit(const AuthenticationState.switchingAccounts());
    final globalSettings =
        Hive.box<GlobalSettings>(HiveBoxes.globalSettings).getValue()!;
-    if (globalSettings.currentLoggedInUser == localUserId) {
+    if (globalSettings.loggedInUserId == localUserId) {
+      emit(AuthenticationState.authenticated(localUserId: localUserId));
      return;
    }
    final userAccountBox =
@@ -112,7 +112,7 @@ class AuthenticationCubit extends Cubit<AuthenticationState> {
        baseUrl: account.serverUrl,
      );

-      globalSettings.currentLoggedInUser = localUserId;
+      globalSettings.loggedInUserId = localUserId;
      await globalSettings.save();

      final apiVersion = await _getApiVersion(_sessionManager.client);
@@ -126,7 +126,6 @@ class AuthenticationCubit extends Cubit<AuthenticationState> {

      emit(AuthenticationState.authenticated(
        localUserId: localUserId,
-        apiVersion: apiVersion,
      ));
    });
  }
@@ -175,13 +174,14 @@ class AuthenticationCubit extends Cubit<AuthenticationState> {
    );
    final globalSettings =
        Hive.box<GlobalSettings>(HiveBoxes.globalSettings).getValue()!;
-    final localUserId = globalSettings.currentLoggedInUser;
+    final localUserId = globalSettings.loggedInUserId;
    if (localUserId == null) {
      _debugPrintMessage(
        "restoreSessionState",
        "There is nothing to restore.",
      );
      // If there is nothing to restore, we can quit here.
+      emit(const AuthenticationState.unauthenticated());
      return;
    }
    final localUserAccountBox =
@@ -223,7 +223,7 @@ class AuthenticationCubit extends Cubit<AuthenticationState> {
    final authentication =
        await withEncryptedBox<UserCredentials, UserCredentials>(
            HiveBoxes.localUserCredentials, (box) {
-      return box.get(globalSettings.currentLoggedInUser!);
+      return box.get(globalSettings.loggedInUserId!);
    });

    if (authentication == null) {
@@ -261,7 +261,6 @@ class AuthenticationCubit extends Cubit<AuthenticationState> {
    );
    emit(
      AuthenticationState.authenticated(
-        apiVersion: apiVersion,
        localUserId: localUserId,
      ),
    );
@@ -279,7 +278,7 @@ class AuthenticationCubit extends Cubit<AuthenticationState> {
    await _resetExternalState();
    final globalSettings =
        Hive.box<GlobalSettings>(HiveBoxes.globalSettings).getValue()!;
-    globalSettings.currentLoggedInUser = null;
+    globalSettings.loggedInUserId = null;
    await globalSettings.save();

    emit(const AuthenticationState.unauthenticated());
@@ -389,6 +388,7 @@ class AuthenticationCubit extends Cubit<AuthenticationState> {
        settings: LocalUserSettings(),
        serverUrl: serverUrl,
        paperlessUser: serverUser,
+        apiVersion: apiVersion,
      ),
    );
    _debugPrintMessage(
--- a/lib/features/login/cubit/authentication_state.dart
+++ b/lib/features/login/cubit/authentication_state.dart
@@ -2,12 +2,18 @@ part of 'authentication_cubit.dart';

@freezed
 class AuthenticationState with _$AuthenticationState {
+  const AuthenticationState._();
+
  const factory AuthenticationState.unauthenticated() = _Unauthenticated;
  const factory AuthenticationState.requriresLocalAuthentication() =
      _RequiresLocalAuthentication;
  const factory AuthenticationState.authenticated({
    required String localUserId,
-    required int apiVersion,
  }) = _Authenticated;
  const factory AuthenticationState.switchingAccounts() = _SwitchingAccounts;
+
+  bool get isAuthenticated => maybeWhen(
+        authenticated: (_) => true,
+        orElse: () => false,
+      );
 }
--- a/lib/features/login/view/add_account_page.dart
+++ b/lib/features/login/view/add_account_page.dart
@@ -0,0 +1,161 @@
+import 'dart:async';
+
+import 'package:flutter/material.dart';
+import 'package:flutter_bloc/flutter_bloc.dart';
+import 'package:flutter_form_builder/flutter_form_builder.dart';
+import 'package:hive_flutter/adapters.dart';
+import 'package:paperless_api/paperless_api.dart';
+import 'package:paperless_mobile/core/config/hive/hive_config.dart';
+import 'package:paperless_mobile/core/database/tables/local_user_account.dart';
+import 'package:paperless_mobile/core/exception/server_message_exception.dart';
+import 'package:paperless_mobile/features/login/cubit/authentication_cubit.dart';
+import 'package:paperless_mobile/features/login/model/client_certificate.dart';
+import 'package:paperless_mobile/features/login/model/client_certificate_form_model.dart';
+import 'package:paperless_mobile/features/login/model/login_form_credentials.dart';
+import 'package:paperless_mobile/features/login/view/widgets/form_fields/client_certificate_form_field.dart';
+import 'package:paperless_mobile/features/login/view/widgets/form_fields/server_address_form_field.dart';
+import 'package:paperless_mobile/features/login/view/widgets/form_fields/user_credentials_form_field.dart';
+import 'package:paperless_mobile/features/login/view/widgets/login_pages/server_connection_page.dart';
+import 'package:paperless_mobile/features/users/view/widgets/user_account_list_tile.dart';
+import 'package:paperless_mobile/generated/l10n/app_localizations.dart';
+import 'package:paperless_mobile/helpers/message_helpers.dart';
+
+import 'widgets/login_pages/server_login_page.dart';
+import 'widgets/never_scrollable_scroll_behavior.dart';
+
+class AddAccountPage extends StatefulWidget {
+  final FutureOr<void> Function(
+    BuildContext context,
+    String username,
+    String password,
+    String serverUrl,
+    ClientCertificate? clientCertificate,
+  ) onSubmit;
+
+  final String submitText;
+  final String titleString;
+
+  final bool showLocalAccounts;
+
+  const AddAccountPage({
+    Key? key,
+    required this.onSubmit,
+    required this.submitText,
+    required this.titleString,
+    this.showLocalAccounts = false,
+  }) : super(key: key);
+
+  @override
+  State<AddAccountPage> createState() => _AddAccountPageState();
+}
+
+class _AddAccountPageState extends State<AddAccountPage> {
+  final _formKey = GlobalKey<FormBuilderState>();
+
+  final PageController _pageController = PageController();
+
+  @override
+  Widget build(BuildContext context) {
+    final localAccounts =
+        Hive.box<LocalUserAccount>(HiveBoxes.localUserAccount);
+    return Scaffold(
+      resizeToAvoidBottomInset: false,
+      body: FormBuilder(
+        key: _formKey,
+        child: PageView(
+          controller: _pageController,
+          scrollBehavior: NeverScrollableScrollBehavior(),
+          children: [
+            if (widget.showLocalAccounts && localAccounts.isNotEmpty)
+              Scaffold(
+                appBar: AppBar(
+                  title: Text(S.of(context)!.logInToExistingAccount),
+                ),
+                bottomNavigationBar: BottomAppBar(
+                  child: Row(
+                    mainAxisAlignment: MainAxisAlignment.end,
+                    children: [
+                      FilledButton(
+                        child: Text(S.of(context)!.goToLogin),
+                        onPressed: () {
+                          _pageController.nextPage(
+                            duration: const Duration(milliseconds: 300),
+                            curve: Curves.easeInOut,
+                          );
+                        },
+                      ),
+                    ],
+                  ),
+                ),
+                body: ListView.builder(
+                  itemBuilder: (context, index) {
+                    final account = localAccounts.values.elementAt(index);
+                    return Card(
+                      child: UserAccountListTile(
+                        account: account,
+                        onTap: () {
+                          context
+                              .read<AuthenticationCubit>()
+                              .switchAccount(account.id);
+                        },
+                      ),
+                    );
+                  },
+                  itemCount: localAccounts.length,
+                ),
+              ),
+            ServerConnectionPage(
+              titleText: widget.titleString,
+              formBuilderKey: _formKey,
+              onContinue: () {
+                _pageController.nextPage(
+                  duration: const Duration(milliseconds: 300),
+                  curve: Curves.easeInOut,
+                );
+              },
+            ),
+            ServerLoginPage(
+              formBuilderKey: _formKey,
+              submitText: widget.submitText,
+              onSubmit: _login,
+            ),
+          ],
+        ),
+      ),
+    );
+  }
+
+  Future<void> _login() async {
+    FocusScope.of(context).unfocus();
+    if (_formKey.currentState?.saveAndValidate() ?? false) {
+      final form = _formKey.currentState!.value;
+      ClientCertificate? clientCert;
+      final clientCertFormModel =
+          form[ClientCertificateFormField.fkClientCertificate]
+              as ClientCertificateFormModel?;
+      if (clientCertFormModel != null) {
+        clientCert = ClientCertificate(
+          bytes: clientCertFormModel.bytes,
+          passphrase: clientCertFormModel.passphrase,
+        );
+      }
+      final credentials =
+          form[UserCredentialsFormField.fkCredentials] as LoginFormCredentials;
+      try {
+        await widget.onSubmit(
+          context,
+          credentials.username!,
+          credentials.password!,
+          form[ServerAddressFormField.fkServerAddress],
+          clientCert,
+        );
+      } on PaperlessApiException catch (error) {
+        showErrorMessage(context, error);
+      } on ServerMessageException catch (error) {
+        showLocalizedError(context, error.message);
+      } catch (error) {
+        showGenericError(context, error);
+      }
+    }
+  }
+}
--- a/lib/features/login/view/login_page.dart
+++ b/lib/features/login/view/login_page.dart
@@ -1,161 +1,78 @@
-import 'dart:async';
-
 import 'package:flutter/material.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
-import 'package:flutter_form_builder/flutter_form_builder.dart';
+import 'package:go_router/go_router.dart';
 import 'package:hive_flutter/adapters.dart';
 import 'package:paperless_api/paperless_api.dart';
 import 'package:paperless_mobile/core/config/hive/hive_config.dart';
-import 'package:paperless_mobile/core/database/tables/local_user_account.dart';
-import 'package:paperless_mobile/core/exception/server_message_exception.dart';
+import 'package:paperless_mobile/core/database/tables/global_settings.dart';
+import 'package:paperless_mobile/features/app_intro/application_intro_slideshow.dart';
 import 'package:paperless_mobile/features/login/cubit/authentication_cubit.dart';
 import 'package:paperless_mobile/features/login/model/client_certificate.dart';
-import 'package:paperless_mobile/features/login/model/client_certificate_form_model.dart';
 import 'package:paperless_mobile/features/login/model/login_form_credentials.dart';
-import 'package:paperless_mobile/features/login/view/widgets/form_fields/client_certificate_form_field.dart';
-import 'package:paperless_mobile/features/login/view/widgets/form_fields/server_address_form_field.dart';
-import 'package:paperless_mobile/features/login/view/widgets/form_fields/user_credentials_form_field.dart';
-import 'package:paperless_mobile/features/login/view/widgets/login_pages/server_connection_page.dart';
-import 'package:paperless_mobile/features/users/view/widgets/user_account_list_tile.dart';
+import 'package:paperless_mobile/features/login/view/add_account_page.dart';
 import 'package:paperless_mobile/generated/l10n/app_localizations.dart';
 import 'package:paperless_mobile/helpers/message_helpers.dart';
+import 'package:paperless_mobile/routes/typed/branches/documents_route.dart';

-import 'widgets/login_pages/server_login_page.dart';
-import 'widgets/never_scrollable_scroll_behavior.dart';
+class LoginPage extends StatelessWidget {
+  const LoginPage({super.key});

-class LoginPage extends StatefulWidget {
-  final FutureOr<void> Function(
+  @override
+  Widget build(BuildContext context) {
+    return AddAccountPage(
+      titleString: S.of(context)!.connectToPaperless,
+      submitText: S.of(context)!.signIn,
+      onSubmit: _onLogin,
+      showLocalAccounts: true,
+    );
+  }
+
+  void _onLogin(
    BuildContext context,
    String username,
    String password,
    String serverUrl,
    ClientCertificate? clientCertificate,
-  ) onSubmit;
-
-  final String submitText;
-  final String titleString;
-
-  final bool showLocalAccounts;
-
-  const LoginPage({
-    Key? key,
-    required this.onSubmit,
-    required this.submitText,
-    required this.titleString,
-    this.showLocalAccounts = false,
-  }) : super(key: key);
-
-  @override
-  State<LoginPage> createState() => _LoginPageState();
-}
-
-class _LoginPageState extends State<LoginPage> {
-  final _formKey = GlobalKey<FormBuilderState>();
-
-  final PageController _pageController = PageController();
-
-  @override
-  Widget build(BuildContext context) {
-    final localAccounts =
-        Hive.box<LocalUserAccount>(HiveBoxes.localUserAccount);
-    return Scaffold(
-      resizeToAvoidBottomInset: false,
-      body: FormBuilder(
-        key: _formKey,
-        child: PageView(
-          controller: _pageController,
-          scrollBehavior: NeverScrollableScrollBehavior(),
-          children: [
-            if (widget.showLocalAccounts && localAccounts.isNotEmpty)
-              Scaffold(
-                appBar: AppBar(
-                  title: Text(S.of(context)!.logInToExistingAccount),
-                ),
-                bottomNavigationBar: BottomAppBar(
-                  child: Row(
-                    mainAxisAlignment: MainAxisAlignment.end,
-                    children: [
-                      FilledButton(
-                        child: Text(S.of(context)!.goToLogin),
-                        onPressed: () {
-                          _pageController.nextPage(
-                            duration: const Duration(milliseconds: 300),
-                            curve: Curves.easeInOut,
-                          );
-                        },
-                      ),
-                    ],
-                  ),
-                ),
-                body: ListView.builder(
-                  itemBuilder: (context, index) {
-                    final account = localAccounts.values.elementAt(index);
-                    return Card(
-                      child: UserAccountListTile(
-                        account: account,
-                        onTap: () {
-                          context
-                              .read<AuthenticationCubit>()
-                              .switchAccount(account.id);
-                        },
-                      ),
-                    );
-                  },
-                  itemCount: localAccounts.length,
-                ),
-              ),
-            ServerConnectionPage(
-              titleText: widget.titleString,
-              formBuilderKey: _formKey,
-              onContinue: () {
-                _pageController.nextPage(
-                  duration: const Duration(milliseconds: 300),
-                  curve: Curves.easeInOut,
-                );
-              },
+  ) async {
+    try {
+      await context.read<AuthenticationCubit>().login(
+            credentials: LoginFormCredentials(
+              username: username,
+              password: password,
            ),
-            ServerLoginPage(
-              formBuilderKey: _formKey,
-              submitText: widget.submitText,
-              onSubmit: _login,
-            ),
-          ],
-        ),
-      ),
-    );
-  }
-
-  Future<void> _login() async {
-    FocusScope.of(context).unfocus();
-    if (_formKey.currentState?.saveAndValidate() ?? false) {
-      final form = _formKey.currentState!.value;
-      ClientCertificate? clientCert;
-      final clientCertFormModel =
-          form[ClientCertificateFormField.fkClientCertificate]
-              as ClientCertificateFormModel?;
-      if (clientCertFormModel != null) {
-        clientCert = ClientCertificate(
-          bytes: clientCertFormModel.bytes,
-          passphrase: clientCertFormModel.passphrase,
-        );
-      }
-      final credentials =
-          form[UserCredentialsFormField.fkCredentials] as LoginFormCredentials;
-      try {
-        await widget.onSubmit(
+            serverUrl: serverUrl,
+            clientCertificate: clientCertificate,
+          );
+      // Show onboarding after first login!
+      final globalSettings =
+          Hive.box<GlobalSettings>(HiveBoxes.globalSettings).getValue()!;
+      if (globalSettings.showOnboarding) {
+        Navigator.push(
          context,
-          credentials.username!,
-          credentials.password!,
-          form[ServerAddressFormField.fkServerAddress],
-          clientCert,
-        );
-      } on PaperlessApiException catch (error) {
-        showErrorMessage(context, error);
-      } on ServerMessageException catch (error) {
-        showLocalizedError(context, error.message);
-      } catch (error) {
-        showGenericError(context, error);
+          MaterialPageRoute(
+            builder: (context) => const ApplicationIntroSlideshow(),
+            fullscreenDialog: true,
+          ),
+        ).then((value) {
+          globalSettings.showOnboarding = false;
+          globalSettings.save();
+        });
      }
+      // DocumentsRoute().go(context);
+    } on PaperlessApiException catch (error, stackTrace) {
+      showErrorMessage(context, error, stackTrace);
+    } on PaperlessFormValidationException catch (exception, stackTrace) {
+      if (exception.hasUnspecificErrorMessage()) {
+        showLocalizedError(context, exception.unspecificErrorMessage()!);
+      } else {
+        showGenericError(
+          context,
+          exception.validationMessages.values.first,
+          stackTrace,
+        ); //TODO: Check if we can show error message directly on field here.
+      }
+    } catch (unknownError, stackTrace) {
+      showGenericError(context, unknownError.toString(), stackTrace);
    }
  }
 }