Merge pull request #193 from losiu97/feature/scan-export

FEATURE export scanned pages to pdf

lib/core/widgets/dialog_utils/dialog_confirm_button.dart

@@ -9,12 +9,19 @@ enum DialogConfirmButtonStyle {
 class DialogConfirmButton<T> extends StatelessWidget {
   final DialogConfirmButtonStyle style;
   final String? label;
+
+  /// The value [Navigator.pop] will be called with. If [onPressed] is
+  /// specified, this value will be ignored.
   final T? returnValue;
+
+  /// Function called when the button is pressed. Takes precedence over [returnValue].
+  final void Function()? onPressed;
   const DialogConfirmButton({
     super.key,
     this.style = DialogConfirmButtonStyle.normal,
     this.label,
     this.returnValue,
+    this.onPressed,
   });
 
   @override
@@ -45,10 +52,13 @@ class DialogConfirmButton<T> extends StatelessWidget {
         _style = _dangerStyle;
         break;
     }
+
+    final effectiveOnPressed =
+        onPressed ?? () => Navigator.of(context).pop(returnValue ?? true);
     return ElevatedButton(
       child: Text(label ?? S.of(context)!.confirm),
       style: _style,
-      onPressed: () => Navigator.of(context).pop(returnValue ?? true),
+      onPressed: effectiveOnPressed,
     );
   }
 }

lib/features/document_scan/cubit/document_scanner_cubit.dart

@@ -5,9 +5,13 @@ import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
 import 'package:paperless_api/paperless_api.dart';
+import 'package:paperless_mobile/core/service/file_service.dart';
+import 'package:paperless_mobile/features/notifications/services/local_notification_service.dart';
 
 class DocumentScannerCubit extends Cubit<List<File>> {
-  DocumentScannerCubit() : super(const []);
+  final LocalNotificationService _notificationService;
+
+  DocumentScannerCubit(this._notificationService) : super(const []);
 
   void addScan(File file) => emit([...state, file]);
 
@@ -36,4 +40,18 @@ class DocumentScannerCubit extends Cubit<List<File>> {
       throw const PaperlessServerException(ErrorCode.scanRemoveFailed);
     }
   }
+
+  Future<void> saveToFile(
+    Uint8List bytes,
+    String fileName,
+    String locale,
+  ) async {
+    var file = await FileService.saveToFile(bytes, fileName);
+    _notificationService.notifyFileSaved(
+      filename: fileName,
+      filePath: file.path,
+      finished: true,
+      locale: locale,
+    );
+  }
 }

lib/features/document_scan/view/scanner_page.dart

@@ -7,15 +7,19 @@ import 'package:file_picker/file_picker.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
+import 'package:hive/hive.dart';
 import 'package:paperless_api/paperless_api.dart';
+import 'package:paperless_mobile/constants.dart';
 import 'package:paperless_mobile/core/bloc/connectivity_cubit.dart';
-import 'package:paperless_mobile/core/delegate/customizable_sliver_persistent_header_delegate.dart';
+import 'package:paperless_mobile/core/config/hive/hive_config.dart';
+import 'package:paperless_mobile/core/database/tables/global_settings.dart';
 import 'package:paperless_mobile/core/global/constants.dart';
 import 'package:paperless_mobile/core/navigation/push_routes.dart';
 import 'package:paperless_mobile/core/service/file_description.dart';
 import 'package:paperless_mobile/core/service/file_service.dart';
 import 'package:paperless_mobile/features/app_drawer/view/app_drawer.dart';
 import 'package:paperless_mobile/features/document_scan/cubit/document_scanner_cubit.dart';
+import 'package:paperless_mobile/features/document_scan/view/widgets/export_scans_dialog.dart';
 import 'package:paperless_mobile/features/document_scan/view/widgets/scanned_image_item.dart';
 import 'package:paperless_mobile/features/document_search/view/sliver_search_bar.dart';
 import 'package:paperless_mobile/features/documents/view/pages/document_view.dart';
@@ -27,6 +31,7 @@ import 'package:path/path.dart' as p;
 import 'package:pdf/pdf.dart';
 import 'package:pdf/widgets.dart' as pw;
 import 'package:permission_handler/permission_handler.dart';
+import 'package:sliver_tools/sliver_tools.dart';
 
 class ScannerPage extends StatefulWidget {
   const ScannerPage({Key? key}) : super(key: key);
@@ -42,6 +47,8 @@ class _ScannerPageState extends State<ScannerPage>
   final SliverOverlapAbsorberHandle actionsHandle =
       SliverOverlapAbsorberHandle();
 
+  final _scrollController = ScrollController();
+
   @override
   Widget build(BuildContext context) {
     return BlocBuilder<ConnectivityCubit, ConnectivityState>(
@@ -70,13 +77,8 @@ class _ScannerPageState extends State<ScannerPage>
                       ),
                       SliverOverlapAbsorber(
                         handle: actionsHandle,
-                        sliver: SliverPersistentHeader(
+                        sliver: SliverPinnedHeader(
-                          pinned: true,
-                          delegate: CustomizableSliverPersistentHeaderDelegate(
                           child: _buildActions(connectedState.isConnected),
-                            maxExtent: kTextTabBarHeight,
-                            minExtent: kTextTabBarHeight,
-                          ),
                         ),
                       ),
                     ],
@@ -111,14 +113,25 @@ class _ScannerPageState extends State<ScannerPage>
       color: Theme.of(context).colorScheme.background,
       child: SizedBox(
         height: kTextTabBarHeight,
-        child: Row(
+        child: BlocBuilder<DocumentScannerCubit, List<File>>(
-          crossAxisAlignment: CrossAxisAlignment.center,
-          mainAxisAlignment: MainAxisAlignment.spaceAround,
-          children: [
-            BlocBuilder<DocumentScannerCubit, List<File>>(
           builder: (context, state) {
-                return TextButton.icon(
+            return RawScrollbar(
+              padding: EdgeInsets.fromLTRB(16, 0, 16, 4),
+              interactive: false,
+              thumbVisibility: true,
+              thickness: 2,
+              radius: Radius.circular(2),
+              controller: _scrollController,
+              child: ListView(
+                controller: _scrollController,
+                scrollDirection: Axis.horizontal,
+                children: [
+                  SizedBox(width: 12),
+                  TextButton.icon(
                     label: Text(S.of(context)!.previewScan),
+                    style: TextButton.styleFrom(
+                      padding: const EdgeInsets.fromLTRB(5, 10, 5, 10),
+                    ),
                     onPressed: state.isNotEmpty
                         ? () => Navigator.of(context).push(
                               MaterialPageRoute(
@@ -132,35 +145,85 @@ class _ScannerPageState extends State<ScannerPage>
                             )
                         : null,
                     icon: const Icon(Icons.visibility_outlined),
-                );
-              },
                   ),
-            BlocBuilder<DocumentScannerCubit, List<File>>(
+                  SizedBox(width: 8),
-              builder: (context, state) {
+                  TextButton.icon(
-                return TextButton.icon(
                     label: Text(S.of(context)!.clearAll),
+                    style: TextButton.styleFrom(
+                      padding: const EdgeInsets.fromLTRB(5, 10, 5, 10),
+                    ),
                     onPressed: state.isEmpty ? null : () => _reset(context),
                     icon: const Icon(Icons.delete_sweep_outlined),
-                );
-              },
                   ),
-            BlocBuilder<DocumentScannerCubit, List<File>>(
+                  SizedBox(width: 8),
-              builder: (context, state) {
+                  TextButton.icon(
-                return TextButton.icon(
                     label: Text(S.of(context)!.upload),
+                    style: TextButton.styleFrom(
+                      padding: const EdgeInsets.fromLTRB(5, 10, 5, 10),
+                    ),
                     onPressed: state.isEmpty || !isConnected
                         ? null
                         : () => _onPrepareDocumentUpload(context),
                     icon: const Icon(Icons.upload_outlined),
+                  ),
+                  SizedBox(width: 8),
+                  TextButton.icon(
+                    label: Text(S.of(context)!.export),
+                    style: TextButton.styleFrom(
+                      padding: const EdgeInsets.fromLTRB(5, 10, 5, 10),
+                    ),
+                    onPressed: state.isEmpty ? null : _onSaveToFile,
+                    icon: const Icon(Icons.save_alt_outlined),
+                  ),
+                  SizedBox(width: 12),
+                ],
+              ),
             );
           },
         ),
-          ],
-        ),
       ),
     );
   }
 
+  void _onSaveToFile() async {
+    final fileName = await showDialog<String>(
+      context: context,
+      builder: (context) => const ExportScansDialog(),
+    );
+    if (fileName != null) {
+      final cubit = context.read<DocumentScannerCubit>();
+      final file = await _assembleFileBytes(
+        forcePdf: true,
+        context.read<DocumentScannerCubit>().state,
+      );
+      try {
+        final globalSettings =
+            Hive.box<GlobalSettings>(HiveBoxes.globalSettings).getValue()!;
+        if (Platform.isAndroid && androidInfo!.version.sdkInt <= 29) {
+          final isGranted = await askForPermission(Permission.storage);
+          if (!isGranted) {
+            showSnackBar(
+              context,
+              "Please grant Paperless Mobile permissions to access your filesystem.",
+              action: SnackBarActionConfig(
+                label: "OK",
+                onPressed: openAppSettings,
+              ),
+            );
+            return;
+          }
+        }
+        await cubit.saveToFile(
+          file.bytes,
+          "$fileName.pdf",
+          globalSettings.preferredLocaleSubtag,
+        );
+      } catch (error) {
+        showGenericError(context, error);
+      }
+    }
+  }
+
   void _openDocumentScanner(BuildContext context) async {
     final isGranted = await askForPermission(Permission.camera);
     if (!isGranted) {
@@ -236,7 +299,9 @@ class _ScannerPageState extends State<ScannerPage>
   }
 
   Widget _buildImageGrid(List<File> scans) {
-    return CustomScrollView(
+    return Padding(
+      padding: const EdgeInsets.all(8.0),
+      child: CustomScrollView(
         slivers: [
           SliverOverlapInjector(handle: searchBarHandle),
           SliverOverlapInjector(handle: actionsHandle),
@@ -264,6 +329,7 @@ class _ScannerPageState extends State<ScannerPage>
             },
           ),
         ],
+      ),
     );
   }
 

lib/features/document_scan/view/widgets/export_scans_dialog.dart

@@ -0,0 +1,88 @@
+import 'package:flutter/material.dart';
+import 'package:flutter/widgets.dart';
+import 'package:intl/intl.dart';
+import 'package:paperless_mobile/core/widgets/dialog_utils/dialog_cancel_button.dart';
+import 'package:paperless_mobile/core/widgets/dialog_utils/dialog_confirm_button.dart';
+import 'package:paperless_mobile/generated/l10n/app_localizations.dart';
+
+class ExportScansDialog extends StatefulWidget {
+  const ExportScansDialog({super.key});
+
+  @override
+  State<ExportScansDialog> createState() => _ExportScansDialogState();
+}
+
+class _ExportScansDialogState extends State<ExportScansDialog> {
+  final _formKey = GlobalKey<FormState>();
+  String? _filename;
+  late String _placeholder;
+
+  @override
+  void initState() {
+    super.initState();
+    final date = DateFormat("yyyy_MM_ddThhmmss").format(DateTime.now());
+    _placeholder = "paperless_mobile_scan_$date";
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return AlertDialog(
+      insetPadding: EdgeInsets.all(8),
+      title: Text(S.of(context)!.exportScansToPdf),
+      content: Form(
+        key: _formKey,
+        child: Column(
+          mainAxisSize: MainAxisSize.min,
+          crossAxisAlignment: CrossAxisAlignment.start,
+          children: [
+            Text(S.of(context)!.allScansWillBeMerged),
+            SizedBox(height: 16),
+            TextFormField(
+              onSaved: (newValue) {
+                _filename = newValue;
+              },
+              autofocus: true,
+              autovalidateMode: AutovalidateMode.onUserInteraction,
+              validator: (value) {
+                final matches = RegExp(r'[<>:"/\|?*]').allMatches(value!);
+                if (matches.isNotEmpty) {
+                  final illegalCharacters = matches
+                      .map((match) => match.group(0))
+                      .toList()
+                      .toSet()
+                      .join(" ");
+                  return S
+                      .of(context)!
+                      .invalidFilenameCharacter(illegalCharacters);
+                }
+
+                return null;
+              },
+              decoration: InputDecoration(
+                labelText: S.of(context)!.fileName,
+                errorMaxLines: 5,
+                suffixText: ".pdf",
+                hintText: _placeholder,
+              ),
+            ),
+          ],
+        ),
+      ),
+      actions: [
+        const DialogCancelButton(),
+        DialogConfirmButton(
+          label: S.of(context)!.export,
+          onPressed: () async {
+            if (_formKey.currentState?.validate() ?? false) {
+              _formKey.currentState?.save();
+              final effectiveFilename = (_filename?.trim().isEmpty ?? true)
+                  ? _placeholder
+                  : _filename;
+              Navigator.pop(context, effectiveFilename);
+            }
+          },
+        ),
+      ],
+    );
+  }
+}

lib/features/document_scan/view/widgets/scanned_image_item.dart

@@ -61,7 +61,7 @@ class _ScannedImageItemState extends State<ScannedImageItem> {
                         width: double.infinity,
                         height: 100,
                         child: FittedBox(
-                          fit: BoxFit.fill,
+                          fit: BoxFit.cover,
                           clipBehavior: Clip.antiAliasWithSaveLayer,
                           alignment: Alignment.center,
                           child: Image.file(

lib/features/home/view/home_route.dart

@@ -130,15 +130,10 @@ class HomeRoute extends StatelessWidget {
                             .get(currentLocalUserId)!,
                       )..initialize(),
                     ),
-                    Provider(create: (context) => DocumentScannerCubit()),
+                    Provider(create: (context) => DocumentScannerCubit(context.read())),
-                    ProxyProvider4<
+                    ProxyProvider4<PaperlessDocumentsApi, PaperlessServerStatsApi, LabelRepository,
-                        PaperlessDocumentsApi,
+                        DocumentChangedNotifier, InboxCubit>(
-                        PaperlessServerStatsApi,
+                      update: (context, docApi, statsApi, labelRepo, notifier, previous) =>
-                        LabelRepository,
-                        DocumentChangedNotifier,
-                        InboxCubit>(
-                      update: (context, docApi, statsApi, labelRepo, notifier,
-                              previous) =>
                           InboxCubit(
                         docApi,
                         statsApi,

lib/features/notifications/services/local_notification_service.dart

@@ -90,6 +90,50 @@ class LocalNotificationService {
     ); //TODO: INTL
   }
 
+  Future<void> notifyFileSaved({
+    required String filename,
+    required String filePath,
+    required bool finished,
+    required String locale,
+  }) async {
+    final tr = await S.delegate.load(Locale(locale));
+
+    await _plugin.show(
+      filePath.hashCode,
+      filename,
+      finished
+          ? tr.notificationDownloadComplete
+          : tr.notificationDownloadingDocument,
+      NotificationDetails(
+        android: AndroidNotificationDetails(
+          NotificationChannel.documentDownload.id + "_$filename",
+          NotificationChannel.documentDownload.name,
+          ongoing: !finished,
+          indeterminate: true,
+          importance: Importance.max,
+          priority: Priority.high,
+          showProgress: !finished,
+          when: DateTime.now().millisecondsSinceEpoch,
+          category: AndroidNotificationCategory.progress,
+          icon: finished ? 'file_download_done' : 'downloading',
+        ),
+        iOS: DarwinNotificationDetails(
+          attachments: [
+            DarwinNotificationAttachment(
+              filePath,
+            ),
+          ],
+        ),
+      ),
+      payload: jsonEncode(
+        OpenDownloadedDocumentPayload(
+          filePath: filePath,
+        ).toJson(),
+      ),
+    ); //TODO: INTL
+  }
+
+
   //TODO: INTL
   Future<void> notifyTaskChanged(Task task) {
     log("[LocalNotificationService] notifyTaskChanged: ${task.toString()}");

lib/l10n/intl_ca.arb

@@ -811,5 +811,18 @@
   "goToLogin": "Anar al login",
   "@goToLogin": {
     "description": "Label of the button shown on the login page to skip logging in to existing accounts and navigate user to login page"
-  }
+  },
+  "export": "Exporta",
+  "@export": {
+    "description": "Label for button that exports scanned images to pdf (before upload)"
+  },
+  "invalidFilenameCharacter": "Invalid character(s) found in filename: {characters}",
+  "@invalidFilenameCharacter": {
+    "description": "For validating filename in export dialogue"
+  },
+  "exportScansToPdf": "Export scans to PDF",
+  "@exportScansToPdf": {
+    "description": "title of the alert dialog when exporting scans to pdf"
+  },
+  "allScansWillBeMerged": "All scans will be merged into a single PDF file."
 }

lib/l10n/intl_cs.arb

@@ -811,5 +811,18 @@
   "goToLogin": "Go to login",
   "@goToLogin": {
     "description": "Label of the button shown on the login page to skip logging in to existing accounts and navigate user to login page"
-  }
+  },
+  "export": "Export",
+  "@export": {
+    "description": "Label for button that exports scanned images to pdf (before upload)"
+  },
+  "invalidFilenameCharacter": "Invalid character(s) found in filename: {characters}",
+  "@invalidFilenameCharacter": {
+    "description": "For validating filename in export dialogue"
+  },
+  "exportScansToPdf": "Export scans to PDF",
+  "@exportScansToPdf": {
+    "description": "title of the alert dialog when exporting scans to pdf"
+  },
+  "allScansWillBeMerged": "All scans will be merged into a single PDF file."
 }

lib/l10n/intl_de.arb

@@ -811,5 +811,18 @@
   "goToLogin": "Gehe zur Anmeldung",
   "@goToLogin": {
     "description": "Label of the button shown on the login page to skip logging in to existing accounts and navigate user to login page"
-  }
+  },
+  "export": "Exportieren",
+  "@export": {
+    "description": "Label for button that exports scanned images to pdf (before upload)"
+  },
+  "invalidFilenameCharacter": "Ungültige(s) Zeichen im Dateinamen gefunden: {characters}",
+  "@invalidFilenameCharacter": {
+    "description": "For validating filename in export dialogue"
+  },
+  "exportScansToPdf": "Scans als PDF exportieren",
+  "@exportScansToPdf": {
+    "description": "title of the alert dialog when exporting scans to pdf"
+  },
+  "allScansWillBeMerged": "Alle Scans werden in eine einzige PDF-Datei zusammengeführt."
 }

lib/l10n/intl_en.arb

@@ -811,5 +811,18 @@
   "goToLogin": "Go to login",
   "@goToLogin": {
     "description": "Label of the button shown on the login page to skip logging in to existing accounts and navigate user to login page"
-  }
+  },
+  "export": "Export",
+  "@export": {
+    "description": "Label for button that exports scanned images to pdf (before upload)"
+  },
+  "invalidFilenameCharacter": "Invalid character(s) found in filename: {characters}",
+  "@invalidFilenameCharacter": {
+    "description": "For validating filename in export dialogue"
+  },
+  "exportScansToPdf": "Export scans to PDF",
+  "@exportScansToPdf": {
+    "description": "title of the alert dialog when exporting scans to pdf"
+  },
+  "allScansWillBeMerged": "All scans will be merged into a single PDF file."
 }

lib/l10n/intl_fr.arb

@@ -780,36 +780,49 @@
   "@alwaysAsk": {
     "description": "Option to choose when the app should always ask the user which filetype to use"
   },
-  "disableMatching": "Do not tag documents automatically",
+  "disableMatching": "Ne pas étiqueter les documents automatiquement",
   "@disableMatching": {
     "description": "One of the options for automatic tagging of documents"
   },
-  "none": "None",
+  "none": "Aucun",
   "@none": {
     "description": "One of available enum values of matching algorithm for tags"
   },
-  "logInToExistingAccount": "Log in to existing account",
+  "logInToExistingAccount": "Se connecter à un compte existant",
   "@logInToExistingAccount": {
     "description": "Title shown on login page if at least one user is already known to the app."
   },
-  "print": "Print",
+  "print": "Imprimer",
   "@print": {
     "description": "Tooltip for print button"
   },
-  "managePermissions": "Manage permissions",
+  "managePermissions": "Gérer les permissions",
   "@managePermissions": {
     "description": "Button which leads user to manage permissions page"
   },
-  "errorRetrievingServerVersion": "An error occurred trying to resolve the server version.",
+  "errorRetrievingServerVersion": "Une erreur est survenue en essayant de résoudre la version du serveur.",
   "@errorRetrievingServerVersion": {
     "description": "Message shown at the bottom of the settings page when the remote server version could not be resolved."
   },
-  "resolvingServerVersion": "Resolving server version...",
+  "resolvingServerVersion": "Résolution de la version du serveur...",
   "@resolvingServerVersion": {
     "description": "Message shown while the app is loading the remote server version."
   },
-  "goToLogin": "Go to login",
+  "goToLogin": "Se connecter",
   "@goToLogin": {
     "description": "Label of the button shown on the login page to skip logging in to existing accounts and navigate user to login page"
-  }
+  },
+  "export": "Export",
+  "@export": {
+    "description": "Label for button that exports scanned images to pdf (before upload)"
+  },
+  "invalidFilenameCharacter": "Invalid character(s) found in filename: {characters}",
+  "@invalidFilenameCharacter": {
+    "description": "For validating filename in export dialogue"
+  },
+  "exportScansToPdf": "Export scans to PDF",
+  "@exportScansToPdf": {
+    "description": "title of the alert dialog when exporting scans to pdf"
+  },
+  "allScansWillBeMerged": "All scans will be merged into a single PDF file."
 }

lib/l10n/intl_pl.arb

@@ -811,5 +811,18 @@
   "goToLogin": "Przejdź do logowania",
   "@goToLogin": {
     "description": "Label of the button shown on the login page to skip logging in to existing accounts and navigate user to login page"
-  }
+  },
+  "export": "Eksport",
+  "@export": {
+    "description": "Label for button that exports scanned images to pdf (before upload)"
+  },
+  "invalidFilenameCharacter": "Znaleziono niedozwolony znak w nazwie pliku",
+  "@invalidFilenameCharacter": {
+    "description": "For validating filename in export dialogue"
+  },
+  "exportScansToPdf": "Export scans to PDF",
+  "@exportScansToPdf": {
+    "description": "title of the alert dialog when exporting scans to pdf"
+  },
+  "allScansWillBeMerged": "All scans will be merged into a single PDF file."
 }

lib/l10n/intl_ru.arb

@@ -811,5 +811,18 @@
   "goToLogin": "Go to login",
   "@goToLogin": {
     "description": "Label of the button shown on the login page to skip logging in to existing accounts and navigate user to login page"
-  }
+  },
+  "export": "Export",
+  "@export": {
+    "description": "Label for button that exports scanned images to pdf (before upload)"
+  },
+  "invalidFilenameCharacter": "Invalid character(s) found in filename: {characters}",
+  "@invalidFilenameCharacter": {
+    "description": "For validating filename in export dialogue"
+  },
+  "exportScansToPdf": "Export scans to PDF",
+  "@exportScansToPdf": {
+    "description": "title of the alert dialog when exporting scans to pdf"
+  },
+  "allScansWillBeMerged": "All scans will be merged into a single PDF file."
 }

lib/l10n/intl_tr.arb

@@ -811,5 +811,18 @@
   "goToLogin": "Go to login",
   "@goToLogin": {
     "description": "Label of the button shown on the login page to skip logging in to existing accounts and navigate user to login page"
-  }
+  },
+  "export": "Export",
+  "@export": {
+    "description": "Label for button that exports scanned images to pdf (before upload)"
+  },
+  "invalidFilenameCharacter": "Invalid character(s) found in filename: {characters}",
+  "@invalidFilenameCharacter": {
+    "description": "For validating filename in export dialogue"
+  },
+  "exportScansToPdf": "Export scans to PDF",
+  "@exportScansToPdf": {
+    "description": "title of the alert dialog when exporting scans to pdf"
+  },
+  "allScansWillBeMerged": "All scans will be merged into a single PDF file."
 }

packages/mock_server/pubspec.yaml

@@ -13,7 +13,7 @@ dependencies:
   logging: ^1.1.1
   flutter:
     sdk: flutter
-  http: ^0.13.4
+  http: ^0.13.5
 
 dev_dependencies:
   flutter_test: