xevion/paperless-mobile
1
0
Fork 0
mirror of https://github.com/Xevion/paperless-mobile.git synced 2025-12-07 20:07:48 -06:00
Code Issues Packages Projects Releases Wiki Activity

Refactored DI, serialization, added feedback to document download

Browse Source
This commit is contained in:
Anton Stubenbord
2022-12-06 00:39:18 +01:00
parent d79682a011
commit 75fa2f7713
51 changed files with 711 additions and 366 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
integration_test/login_integration_test.dart
View File

@@ -45,7 +45,6 @@ void main() async {
when(getIt<PaperlessAuthenticationApi>().login(
username: testUsername,
password: testPassword,
serverUrl: testServerUrl,
)).thenAnswer((i) => Future.value("eyTestToken"));
await getIt<ConnectivityCubit>().initialize();
@@ -74,7 +73,6 @@ void main() async {
verify(getIt<PaperlessAuthenticationApi>().login(
username: testUsername,
password: testPassword,
serverUrl: testServerUrl,
)).called(1);
});
@@ -125,7 +123,6 @@ void main() async {
.login(
username: testUsername,
password: testPassword,
serverUrl: testServerUrl,
));
expect(
find.textContaining(t.translations.loginPagePasswordValidatorMessageText),
@@ -175,7 +172,6 @@ void main() async {
.login(
username: testUsername,
password: testPassword,
serverUrl: testServerUrl,
));
expect(
find.textContaining(t.translations.loginPageUsernameValidatorMessageText),
@@ -224,7 +220,6 @@ void main() async {
verifyNever(getIt<PaperlessAuthenticationApi>().login(
username: testUsername,
password: testPassword,
serverUrl: testServerUrl,
));
expect(
find.textContaining(

4
lib/core/bloc/connectivity_cubit.dart
View File

@@ -4,7 +4,9 @@ import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:paperless_mobile/core/service/connectivity_status.service.dart';
import 'package:injectable/injectable.dart';
@singleton
@prod
@test
@lazySingleton
class ConnectivityCubit extends Cubit<ConnectivityState> {
final ConnectivityStatusService connectivityStatusService;
StreamSubscription<bool>? _sub;

4
lib/core/bloc/document_status_cubit.dart
View File

@@ -2,7 +2,9 @@ import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:paperless_mobile/core/model/document_processing_status.dart';
import 'package:injectable/injectable.dart';
@singleton
@prod
@test
@lazySingleton
class DocumentStatusCubit extends Cubit<DocumentProcessingStatus?> {
DocumentStatusCubit() : super(null);

4
lib/core/bloc/paperless_server_information_cubit.dart
View File

@@ -3,7 +3,9 @@ import 'package:injectable/injectable.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/core/bloc/paperless_server_information_state.dart';
@singleton
@prod
@test
@lazySingleton
class PaperlessServerInformationCubit
extends Cubit<PaperlessServerInformationState> {
final PaperlessServerStatsApi service;

18
lib/core/interceptor/authentication.interceptor.dart
View File

@@ -1,14 +1,12 @@
import 'dart:developer';
import 'package:flutter/foundation.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/core/store/local_vault.dart';
import 'package:http_interceptor/http_interceptor.dart';
import 'package:injectable/injectable.dart';
import 'package:paperless_mobile/core/store/local_vault.dart';
@injectable
@dev
@prod
@injectable
class AuthenticationInterceptor implements InterceptorContract {
final LocalVault _localVault;
AuthenticationInterceptor(this._localVault);
@@ -20,15 +18,15 @@ class AuthenticationInterceptor implements InterceptorContract {
if (kDebugMode) {
log("Intercepted ${request.method} request to ${request.url.toString()}");
}
if (auth == null) {
throw const PaperlessServerException(ErrorCode.notAuthenticated);
}
return request.copyWith(
//Append server Url
url: Uri.parse(auth.serverUrl + request.url.toString()),
headers: auth.token.isEmpty
headers: auth?.token?.isEmpty ?? true
? request.headers
: {...request.headers, 'Authorization': 'Token ${auth.token}'},
: {
...request.headers,
'Authorization': 'Token ${auth!.token}',
},
);
}

28
lib/core/interceptor/base_url_interceptor.dart Normal file
View File

@@ -0,0 +1,28 @@
import 'package:http_interceptor/http_interceptor.dart';
import 'package:injectable/injectable.dart';
import 'package:paperless_mobile/core/store/local_vault.dart';
@prod
@injectable
class BaseUrlInterceptor implements InterceptorContract {
final LocalVault _localVault;
BaseUrlInterceptor(this._localVault);
@override
Future<BaseRequest> interceptRequest({required BaseRequest request}) async {
final auth = await _localVault.loadAuthenticationInformation();
if (auth == null) {
throw Exception(
"Authentication information not available, cannot perform request!",
);
}
return request.copyWith(
url: Uri.parse(auth.serverUrl + request.url.toString()),
);
}
@override
Future<BaseResponse> interceptResponse(
{required BaseResponse response}) async =>
response;
}

1
lib/core/interceptor/response_conversion.interceptor.dart
View File

@@ -5,7 +5,6 @@ import 'package:injectable/injectable.dart';
const interceptedRoutes = ['thumb/'];
@injectable
@dev
@prod
class ResponseConversionInterceptor implements InterceptorContract {
@override

3
lib/core/logic/timeout_client.dart
View File

@@ -12,10 +12,9 @@ import 'package:injectable/injectable.dart';
///
/// Convenience class which handles timeout errors.
///
@Injectable(as: BaseClient)
@dev
@prod
@Named("timeoutClient")
@Injectable(as: BaseClient)
class TimeoutClient implements BaseClient {
final ConnectivityStatusService connectivityStatusService;
static const Duration requestTimeout = Duration(seconds: 25);

3
lib/core/service/connectivity_status.service.dart
View File

@@ -9,7 +9,8 @@ abstract class ConnectivityStatusService {
Stream<bool> connectivityChanges();
}
@Injectable(as: ConnectivityStatusService, env: ['prod', 'dev'])
@prod
@Injectable(as: ConnectivityStatusService)
class ConnectivityStatusServiceImpl implements ConnectivityStatusService {
final Connectivity connectivity;

2
lib/core/service/file_service.dart
View File

@@ -56,7 +56,7 @@ class FileService {
}
}
static Future<Directory?> get downloadsDirectory async {
static Future<Directory> get downloadsDirectory async {
if (Platform.isAndroid) {
return (await getExternalStorageDirectories(
type: StorageDirectory.downloads))!

3
lib/core/store/local_vault.dart
View File

@@ -17,9 +17,8 @@ abstract class LocalVault {
Future<void> clear();
}
@Injectable(as: LocalVault)
@prod
@dev
@Injectable(as: LocalVault)
class LocalVaultImpl implements LocalVault {
static const applicationSettingsKey = "applicationSettings";
static const authenticationKey = "authentication";

7
lib/di_initializer.dart
View File

@@ -2,18 +2,21 @@ import 'dart:io';
import 'package:paperless_mobile/di_initializer.config.dart';
import 'package:paperless_mobile/di_modules.dart';
import 'package:paperless_mobile/di_paperless_api.dart';
import 'package:paperless_mobile/features/login/model/client_certificate.dart';
import 'package:get_it/get_it.dart';
import 'package:injectable/injectable.dart';
final getIt = GetIt.instance..allowReassignment;
@InjectableInit(
initializerName: r'$initGetIt', // default
initializerName: 'init', // default
preferRelativeImports: true, // default
asExtension: false, // default
includeMicroPackages: false,
)
void configureDependencies(String environment) =>
$initGetIt(getIt, environment: environment);
init(getIt, environment: environment);
///
/// Registers new security context, which will be used by the HttpClient, see [RegisterModule].

67
lib/di_modules.dart
View File

@@ -2,10 +2,9 @@ import 'dart:io';
import 'package:connectivity_plus/connectivity_plus.dart';
import 'package:encrypted_shared_preferences/encrypted_shared_preferences.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter_cache_manager/flutter_cache_manager.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/core/interceptor/authentication.interceptor.dart';
import 'package:paperless_mobile/core/interceptor/base_url_interceptor.dart';
import 'package:paperless_mobile/core/interceptor/language_header.interceptor.dart';
import 'package:paperless_mobile/core/interceptor/response_conversion.interceptor.dart';
import 'package:http/http.dart';
@@ -16,34 +15,30 @@ import 'package:local_auth/local_auth.dart';
@module
abstract class RegisterModule {
@singleton
@dev
@prod
@singleton
LocalAuthentication get localAuthentication => LocalAuthentication();
@singleton
@dev
@prod
@singleton
EncryptedSharedPreferences get encryptedSharedPreferences =>
EncryptedSharedPreferences();
@singleton
@dev
@prod
@test
@singleton
@Order(-1)
SecurityContext get securityContext => SecurityContext();
@singleton
@dev
@prod
@singleton
Connectivity get connectivity => Connectivity();
///
/// Factory method creating an [HttpClient] with the currently registered [SecurityContext].
///
@injectable
@dev
@prod
@Order(-1)
HttpClient getHttpClient(SecurityContext securityContext) =>
HttpClient(context: securityContext)
..connectionTimeout = const Duration(seconds: 10);
@@ -51,66 +46,26 @@ abstract class RegisterModule {
///
/// Factory method creating a [InterceptedClient] on top of the currently registered [HttpClient].
///
@injectable
@dev
@prod
@Order(-1)
BaseClient getBaseClient(
AuthenticationInterceptor authInterceptor,
ResponseConversionInterceptor responseConversionInterceptor,
LanguageHeaderInterceptor languageHeaderInterceptor,
BaseUrlInterceptor baseUrlInterceptor,
HttpClient client,
) =>
InterceptedClient.build(
interceptors: [
baseUrlInterceptor,
authInterceptor,
responseConversionInterceptor,
languageHeaderInterceptor
languageHeaderInterceptor,
],
client: IOClient(client),
);
@injectable
@dev
@prod
CacheManager getCacheManager(BaseClient client) => CacheManager(
Config('cacheKey', fileService: HttpFileService(httpClient: client)));
@injectable
@dev
@prod
PaperlessAuthenticationApi authenticationModule(BaseClient client) =>
PaperlessAuthenticationApiImpl(client);
@injectable
@dev
@prod
PaperlessLabelsApi labelsModule(
@Named('timeoutClient') BaseClient timeoutClient,
) =>
PaperlessLabelApiImpl(timeoutClient);
@injectable
@dev
@prod
PaperlessDocumentsApi documentsModule(
@Named('timeoutClient') BaseClient timeoutClient,
HttpClient httpClient,
) =>
PaperlessDocumentsApiImpl(timeoutClient, httpClient);
@injectable
@dev
@prod
PaperlessSavedViewsApi savedViewsModule(
@Named('timeoutClient') BaseClient timeoutClient,
) =>
PaperlessSavedViewsApiImpl(timeoutClient);
@injectable
@dev
@prod
PaperlessServerStatsApi serverStatsModule(
@Named('timeoutClient') BaseClient timeoutClient,
) =>
PaperlessServerStatsApiImpl(timeoutClient);
}

47
lib/di_paperless_api.dart Normal file
View File

@@ -0,0 +1,47 @@
import 'dart:io';
import 'package:http/http.dart';
import 'package:injectable/injectable.dart';
import 'package:paperless_api/paperless_api.dart';
@module
abstract class PaperlessApiModule {
@prod
@Order(-1)
@injectable
PaperlessAuthenticationApi authenticationModule(BaseClient client) =>
PaperlessAuthenticationApiImpl(client);
@prod
@Order(-1)
@injectable
PaperlessLabelsApi labelsModule(
@Named('timeoutClient') BaseClient timeoutClient,
) =>
PaperlessLabelApiImpl(timeoutClient);
@prod
@Order(-1)
@injectable
PaperlessDocumentsApi documentsModule(
@Named('timeoutClient') BaseClient timeoutClient,
HttpClient httpClient,
) =>
PaperlessDocumentsApiImpl(timeoutClient, httpClient);
@prod
@Order(-1)
@injectable
PaperlessSavedViewsApi savedViewsModule(
@Named('timeoutClient') BaseClient timeoutClient,
) =>
PaperlessSavedViewsApiImpl(timeoutClient);
@prod
@Order(-1)
@injectable
PaperlessServerStatsApi serverStatsModule(
@Named('timeoutClient') BaseClient timeoutClient,
) =>
PaperlessServerStatsApiImpl(timeoutClient);
}

2
lib/features/app_intro/widgets/biometric_authentication_intro_slide.dart
View File

@@ -1,7 +1,7 @@
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:paperless_mobile/di_initializer.dart';
import 'package:paperless_mobile/features/login/services/authentication.service.dart';
import 'package:paperless_mobile/features/login/services/authentication_service.dart';
import 'package:paperless_mobile/features/settings/bloc/application_settings_cubit.dart';
import 'package:paperless_mobile/features/settings/model/application_settings_state.dart';
import 'package:paperless_mobile/util.dart';

29
lib/features/document_details/view/pages/document_details_page.dart
View File

@@ -12,6 +12,7 @@ import 'package:paperless_mobile/core/widgets/highlighted_text.dart';
import 'package:paperless_mobile/di_initializer.dart';
import 'package:paperless_mobile/extensions/flutter_extensions.dart';
import 'package:paperless_mobile/features/document_details/bloc/document_details_cubit.dart';
import 'package:paperless_mobile/features/document_details/view/widgets/document_download_button.dart';
import 'package:paperless_mobile/features/documents/view/pages/document_edit_page.dart';
import 'package:paperless_mobile/features/documents/view/pages/document_view.dart';
import 'package:paperless_mobile/features/documents/view/widgets/delete_document_confirmation_dialog.dart';
@@ -82,12 +83,9 @@ class _DocumentDetailsPageState extends State<DocumentDetailsPage> {
? () => _onDelete(state.document!)
: null,
).padded(const EdgeInsets.symmetric(horizontal: 4)),
IconButton(
icon: const Icon(Icons.download),
onPressed: Platform.isAndroid && state.document != null
? () => _onDownload(state.document!)
: null,
).padded(const EdgeInsets.only(right: 4)),
DocumentDownloadButton(
document: state.document,
),
IconButton(
icon: const Icon(Icons.open_in_new),
onPressed: state.document != null
@@ -404,25 +402,6 @@ class _DocumentDetailsPageState extends State<DocumentDetailsPage> {
return const SizedBox(height: 32.0);
}
Future<void> _onDownload(DocumentModel document) async {
if (!Platform.isAndroid) {
showSnackBar(
context, "This feature is currently only supported on Android!");
return;
}
setState(() => _isDownloadPending = true);
getIt<PaperlessDocumentsApi>().download(document).then((bytes) async {
final Directory dir = (await getExternalStorageDirectories(
type: StorageDirectory.downloads))!
.first;
String filePath = "${dir.path}/${document.originalFileName}";
//TODO: Add replacement mechanism here (ask user if file should be replaced if exists)
await File(filePath).writeAsBytes(bytes);
setState(() => _isDownloadPending = false);
dev.log("File downloaded to $filePath");
});
}
///
/// Downloads file to temporary directory, from which it can then be shared.
///

61
lib/features/document_details/view/widgets/document_download_button.dart Normal file
View File

@@ -0,0 +1,61 @@
import 'dart:developer';
import 'dart:io';
import 'package:flutter/material.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/core/service/file_service.dart';
import 'package:paperless_mobile/di_initializer.dart';
import 'package:paperless_mobile/extensions/flutter_extensions.dart';
import 'package:paperless_mobile/generated/l10n.dart';
import 'package:paperless_mobile/util.dart';
class DocumentDownloadButton extends StatefulWidget {
final DocumentModel? document;
const DocumentDownloadButton({super.key, required this.document});
@override
State<DocumentDownloadButton> createState() => _DocumentDownloadButtonState();
}
class _DocumentDownloadButtonState extends State<DocumentDownloadButton> {
bool _isDownloadPending = false;
@override
Widget build(BuildContext context) {
return IconButton(
icon: _isDownloadPending
? const SizedBox(
child: CircularProgressIndicator(),
height: 16,
width: 16,
)
: const Icon(Icons.download),
onPressed: Platform.isAndroid && widget.document != null
? () => _onDownload(widget.document!)
: null,
).padded(const EdgeInsets.only(right: 4));
}
Future<void> _onDownload(DocumentModel document) async {
if (!Platform.isAndroid) {
showSnackBar(
context, "This feature is currently only supported on Android!");
return;
}
setState(() => _isDownloadPending = true);
try {
final bytes = await getIt<PaperlessDocumentsApi>().download(document);
final Directory dir = await FileService.downloadsDirectory;
String filePath = "${dir.path}/${document.originalFileName}";
//TODO: Add replacement mechanism here (ask user if file should be replaced if exists)
await File(filePath).writeAsBytes(bytes);
showSnackBar(context, S.of(context).documentDownloadSuccessMessage);
} on PaperlessServerException catch (error, stackTrace) {
showErrorMessage(context, error, stackTrace);
} catch (error) {
showGenericError(context, error);
} finally {
setState(() => _isDownloadPending = false);
}
}
}

6
lib/features/documents/bloc/documents_cubit.dart
View File

@@ -1,11 +1,11 @@
import 'dart:typed_data';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:injectable/injectable.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/features/documents/bloc/documents_state.dart';
@singleton
@prod
@test
@lazySingleton
class DocumentsCubit extends Cubit<DocumentsState> {
final PaperlessDocumentsApi _api;

1
lib/features/documents/view/widgets/search/sort_field_selection_bottom_sheet.dart
View File

@@ -64,7 +64,6 @@ class _SortFieldSelectionBottomSheetState
contentPadding: const EdgeInsets.symmetric(horizontal: 32),
title: Text(
_localizedSortField(field),
style: Theme.of(context).textTheme.bodyText2,
),
trailing: isNextSelected
? (_buildOrderIcon(_selectedOrderLoading!))

4
lib/features/labels/correspondent/bloc/correspondents_cubit.dart
View File

@@ -2,7 +2,9 @@ import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/features/labels/bloc/label_cubit.dart';
import 'package:injectable/injectable.dart';
@singleton
@prod
@test
@lazySingleton
class CorrespondentCubit extends LabelCubit<Correspondent> {
CorrespondentCubit(super.metaDataService);

4
lib/features/labels/document_type/bloc/document_type_cubit.dart
View File

@@ -2,7 +2,9 @@ import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/features/labels/bloc/label_cubit.dart';
import 'package:injectable/injectable.dart';
@singleton
@prod
@test
@lazySingleton
class DocumentTypeCubit extends LabelCubit<DocumentType> {
DocumentTypeCubit(super.metaDataService);

4
lib/features/labels/storage_path/bloc/storage_path_cubit.dart
View File

@@ -2,7 +2,9 @@ import 'package:injectable/injectable.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/features/labels/bloc/label_cubit.dart';
@singleton
@prod
@test
@lazySingleton
class StoragePathCubit extends LabelCubit<StoragePath> {
StoragePathCubit(super.metaDataService);

4
lib/features/labels/tags/bloc/tags_cubit.dart
View File

@@ -2,7 +2,9 @@ import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/features/labels/bloc/label_cubit.dart';
import 'package:injectable/injectable.dart';
@singleton
@prod
@test
@lazySingleton
class TagCubit extends LabelCubit<Tag> {
TagCubit(super.metaDataService);

8
lib/features/labels/tags/view/widgets/tags_form_field.dart
View File

@@ -159,7 +159,7 @@ class _TagFormFieldState extends State<TagFormField> {
(query) => _buildTag(
field,
query,
tagState.getLabel(query.id)!,
tagState.getLabel(query.id),
),
)
.toList(),
@@ -235,11 +235,13 @@ class _TagFormFieldState extends State<TagFormField> {
Widget _buildTag(
FormFieldState<TagsQuery> field,
TagIdQuery query,
Tag tag,
Tag? tag,
) {
final currentQuery = field.value as IdsTagsQuery;
final isIncludedTag = currentQuery.includedIds.contains(query.id);
if (tag == null) {
return Container();
}
return InputChip(
label: Text(
tag.name,

14
lib/features/labels/view/pages/edit_label_page.dart
View File

@@ -120,11 +120,15 @@ class _EditLabelPageState<T extends Label> extends State<EditLabelPage<T>> {
child: Text(S.of(context).genericActionCancelLabel),
),
TextButton(
onPressed: () {
Navigator.pop(context);
widget.onDelete(widget.label);
},
child: Text(S.of(context).genericActionDeleteLabel)),
onPressed: () {
Navigator.pop(context);
widget.onDelete(widget.label);
},
child: Text(
S.of(context).genericActionDeleteLabel,
style: TextStyle(color: Theme.of(context).errorColor),
),
),
],
),
);

87
lib/features/login/bloc/authentication_cubit.dart
View File

@@ -8,19 +8,19 @@ import 'package:paperless_mobile/di_initializer.dart';
import 'package:paperless_mobile/features/login/model/authentication_information.dart';
import 'package:paperless_mobile/features/login/model/client_certificate.dart';
import 'package:paperless_mobile/features/login/model/user_credentials.model.dart';
import 'package:paperless_mobile/features/login/services/authentication.service.dart';
import 'package:paperless_mobile/features/login/services/authentication_service.dart';
import 'package:paperless_mobile/features/settings/model/application_settings_state.dart';
const authenticationKey = "authentication";
@prod
@test
@singleton
class AuthenticationCubit extends Cubit<AuthenticationState> {
final LocalAuthenticationService _localAuthService;
final PaperlessAuthenticationApi _authApi;
final LocalVault localStore;
final LocalVault _localVault;
AuthenticationCubit(
this.localStore,
this._localVault,
this._localAuthService,
this._authApi,
) : super(AuthenticationState.initial);
@@ -37,33 +37,21 @@ class AuthenticationCubit extends Cubit<AuthenticationState> {
assert(credentials.username != null && credentials.password != null);
try {
registerSecurityContext(clientCertificate);
emit(
AuthenticationState(
isAuthenticated: false,
wasLoginStored: false,
authentication: AuthenticationInformation(
username: credentials.username!,
password: credentials.password!,
serverUrl: serverUrl,
token: "",
clientCertificate: clientCertificate,
),
),
);
final token = await _authApi.login(
username: credentials.username!,
password: credentials.password!,
serverUrl: serverUrl,
);
final auth = AuthenticationInformation(
username: credentials.username!,
password: credentials.password!,
token: token,
// Store information required to make requests
final currentAuth = AuthenticationInformation(
serverUrl: serverUrl,
clientCertificate: clientCertificate,
);
await _localVault.storeAuthenticationInformation(currentAuth);
await localStore.storeAuthenticationInformation(auth);
final token = await _authApi.login(
username: credentials.username!,
password: credentials.password!,
);
final auth = currentAuth.copyWith(token: token);
await _localVault.storeAuthenticationInformation(auth);
emit(AuthenticationState(
isAuthenticated: true,
@@ -84,10 +72,10 @@ class AuthenticationCubit extends Cubit<AuthenticationState> {
}
Future<void> restoreSessionState() async {
final storedAuth = await localStore.loadAuthenticationInformation();
final storedAuth = await _localVault.loadAuthenticationInformation();
late ApplicationSettingsState? appSettings;
try {
appSettings = await localStore.loadApplicationSettings() ??
appSettings = await _localVault.loadApplicationSettings() ??
ApplicationSettingsState.defaultSettings;
} catch (err) {
appSettings = ApplicationSettingsState.defaultSettings;
@@ -95,31 +83,40 @@ class AuthenticationCubit extends Cubit<AuthenticationState> {
if (storedAuth == null || !storedAuth.isValid) {
emit(AuthenticationState(isAuthenticated: false, wasLoginStored: false));
} else {
if (!appSettings.isLocalAuthenticationEnabled ||
await _localAuthService
.authenticateLocalUser("Authenticate to log back in")) {
registerSecurityContext(storedAuth.clientCertificate);
emit(
AuthenticationState(
isAuthenticated: true,
if (appSettings.isLocalAuthenticationEnabled) {
final localAuthSuccess = await _localAuthService
.authenticateLocalUser("Authenticate to log back in");
if (localAuthSuccess) {
registerSecurityContext(storedAuth.clientCertificate);
return emit(
AuthenticationState(
isAuthenticated: true,
wasLoginStored: true,
authentication: storedAuth,
wasLocalAuthenticationSuccessful: true,
),
);
} else {
return emit(AuthenticationState(
isAuthenticated: false,
wasLoginStored: true,
authentication: storedAuth,
),
);
} else {
emit(AuthenticationState(isAuthenticated: false, wasLoginStored: true));
wasLocalAuthenticationSuccessful: false,
));
}
}
emit(AuthenticationState(isAuthenticated: false, wasLoginStored: true));
}
}
Future<void> logout() async {
await localStore.clear();
await _localVault.clear();
emit(AuthenticationState.initial);
}
}
class AuthenticationState {
final bool wasLoginStored;
final bool? wasLocalAuthenticationSuccessful;
final bool isAuthenticated;
final AuthenticationInformation? authentication;
@@ -131,6 +128,7 @@ class AuthenticationState {
AuthenticationState({
required this.isAuthenticated,
required this.wasLoginStored,
this.wasLocalAuthenticationSuccessful,
this.authentication,
});
@@ -138,11 +136,14 @@ class AuthenticationState {
bool? wasLoginStored,
bool? isAuthenticated,
AuthenticationInformation? authentication,
bool? wasLocalAuthenticationSuccessful,
}) {
return AuthenticationState(
isAuthenticated: isAuthenticated ?? this.isAuthenticated,
wasLoginStored: wasLoginStored ?? this.wasLoginStored,
authentication: authentication ?? this.authentication,
wasLocalAuthenticationSuccessful: wasLocalAuthenticationSuccessful ??
this.wasLocalAuthenticationSuccessful,
);
}
}

25
lib/features/login/bloc/local_authentication_cubit.dart
View File

@@ -1,25 +0,0 @@
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/di_initializer.dart';
import 'package:local_auth/local_auth.dart';
class LocalAuthenticationCubit extends Cubit<LocalAuthenticationState> {
LocalAuthenticationCubit() : super(LocalAuthenticationState(false));
Future<void> authorize(String localizedMessage) async {
final isAuthenticationSuccessful = await getIt<LocalAuthentication>()
.authenticate(localizedReason: localizedMessage);
if (isAuthenticationSuccessful) {
emit(LocalAuthenticationState(true));
} else {
throw const PaperlessServerException(
ErrorCode.biometricAuthenticationFailed);
}
}
}
class LocalAuthenticationState {
final bool isAuthorized;
LocalAuthenticationState(this.isAuthorized);
}

23
lib/features/login/model/authentication_information.dart
View File

@@ -2,30 +2,22 @@ import 'package:paperless_mobile/core/type/types.dart';
import 'package:paperless_mobile/features/login/model/client_certificate.dart';
class AuthenticationInformation {
static const usernameKey = 'username';
static const passwordKey = 'password';
static const tokenKey = 'token';
static const serverUrlKey = 'serverUrl';
static const clientCertificateKey = 'clientCertificate';
final String username;
final String password;
final String token;
final String? token;
final String serverUrl;
final ClientCertificate? clientCertificate;
AuthenticationInformation({
required this.username,
required this.password,
required this.token,
this.token,
required this.serverUrl,
this.clientCertificate,
});
AuthenticationInformation.fromJson(JSON json)
: username = json[usernameKey],
password = json[passwordKey],
token = json[tokenKey],
: token = json[tokenKey],
serverUrl = json[serverUrlKey],
clientCertificate = json[clientCertificateKey] != null
? ClientCertificate.fromJson(json[clientCertificateKey])
@@ -33,8 +25,6 @@ class AuthenticationInformation {
JSON toJson() {
return {
usernameKey: username,
passwordKey: password,
tokenKey: token,
serverUrlKey: serverUrl,
clientCertificateKey: clientCertificate?.toJson(),
@@ -42,21 +32,16 @@ class AuthenticationInformation {
}
bool get isValid {
return serverUrl.isNotEmpty && token.isNotEmpty;
return serverUrl.isNotEmpty && (token?.isNotEmpty ?? false);
}
AuthenticationInformation copyWith({
String? username,
String? password,
String? token,
String? serverUrl,
ClientCertificate? clientCertificate,
bool removeClientCertificate = false,
bool? isLocalAuthenticationEnabled,
}) {
return AuthenticationInformation(
username: username ?? this.username,
password: password ?? this.password,
token: token ?? this.token,
serverUrl: serverUrl ?? this.serverUrl,
clientCertificate: clientCertificate ??

2
lib/features/login/services/authentication.service.dart → lib/features/login/services/authentication_service.dart
View File

@@ -2,7 +2,7 @@ import 'package:injectable/injectable.dart';
import 'package:local_auth/local_auth.dart';
import 'package:paperless_mobile/core/store/local_vault.dart';
@singleton
@lazySingleton
class LocalAuthenticationService {
final LocalVault localStore;
final LocalAuthentication localAuthentication;

4
lib/features/saved_view/bloc/saved_view_cubit.dart
View File

@@ -3,7 +3,9 @@ import 'package:injectable/injectable.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/features/saved_view/bloc/saved_view_state.dart';
@singleton
@prod
@test
@lazySingleton
class SavedViewCubit extends Cubit<SavedViewState> {
final PaperlessSavedViewsApi _api;
SavedViewCubit(this._api) : super(SavedViewState(value: {}));

2
lib/features/scan/bloc/document_scanner_cubit.dart
View File

@@ -67,7 +67,7 @@ class DocumentScannerCubit extends Cubit<List<File>> {
correspondent: correspondent,
tags: tags,
createdAt: createdAt,
authToken: auth.token,
authToken: auth.token!,
serverUrl: auth.serverUrl,
);
if (onConsumptionFinished != null) {

4
lib/features/settings/bloc/application_settings_cubit.dart
View File

@@ -5,7 +5,9 @@ import 'package:paperless_mobile/features/settings/model/application_settings_st
import 'package:injectable/injectable.dart';
import 'package:paperless_mobile/features/settings/model/view_type.dart';
@singleton
@prod
@test
@lazySingleton
class ApplicationSettingsCubit extends Cubit<ApplicationSettingsState> {
final LocalVault localVault;

2
lib/features/settings/view/widgets/biometric_authentication_setting.dart
View File

@@ -1,7 +1,7 @@
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:paperless_mobile/di_initializer.dart';
import 'package:paperless_mobile/features/login/services/authentication.service.dart';
import 'package:paperless_mobile/features/login/services/authentication_service.dart';
import 'package:paperless_mobile/features/settings/bloc/application_settings_cubit.dart';
import 'package:paperless_mobile/features/settings/model/application_settings_state.dart';
import 'package:paperless_mobile/generated/l10n.dart';

10
lib/l10n/intl_cs.arb
View File

@@ -70,6 +70,8 @@
"@documentDetailsPageTabOverviewLabel": {},
"documentDocumentTypePropertyLabel": "Typ dokumentu",
"@documentDocumentTypePropertyLabel": {},
"documentDownloadSuccessMessage": "Document successfully downloaded.",
"@documentDownloadSuccessMessage": {},
"documentEditPageTitle": "Upravit dokument",
"@documentEditPageTitle": {},
"documentMetaDataChecksumLabel": "MD5 součet originálu",
@@ -270,6 +272,10 @@
"@inboxPageMarkAllAsSeenLabel": {},
"inboxPageMarkAsSeenText": "Označit jako shlédnuté",
"@inboxPageMarkAsSeenText": {},
"inboxPageNoNewDocumentsRefreshLabel": "Refresh",
"@inboxPageNoNewDocumentsRefreshLabel": {},
"inboxPageNoNewDocumentsText": "You do not have unseen documents.",
"@inboxPageNoNewDocumentsText": {},
"inboxPageTodayText": "Dnes",
"@inboxPageTodayText": {},
"inboxPageUndoRemoveText": "VRÁTIT",
@@ -415,7 +421,5 @@
"tagInboxTagPropertyLabel": "Tag inboxu",
"@tagInboxTagPropertyLabel": {},
"uploadPageAutomaticallInferredFieldsHintText": "Pokud specifikuješ hodnoty pro tato pole, paperless instance nebude automaticky přiřazovat naučené hodnoty. Pokud mají být tato pole automaticky vyplňována, nevyplňujte zde nic.",
"@uploadPageAutomaticallInferredFieldsHintText": {},
"inboxPageNoNewDocumentsText": "You do not have unseen documents.",
"inboxPageNoNewDocumentsRefreshLabel": "Refresh"
"@uploadPageAutomaticallInferredFieldsHintText": {}
}

26
lib/l10n/intl_de.arb
View File

@@ -70,6 +70,8 @@
"@documentDetailsPageTabOverviewLabel": {},
"documentDocumentTypePropertyLabel": "Dokumenttyp",
"@documentDocumentTypePropertyLabel": {},
"documentDownloadSuccessMessage": "Dokument erfolgreich heruntergeladen.",
"@documentDownloadSuccessMessage": {},
"documentEditPageTitle": "Dokument Bearbeiten",
"@documentEditPageTitle": {},
"documentMetaDataChecksumLabel": "MD5-Prüfsumme Original",
@@ -136,13 +138,13 @@
"@documentsPageEmptyStateOopsText": {},
"documentsPageOrderByLabel": "Sortiere nach",
"@documentsPageOrderByLabel": {},
"documentsPageSelectionBulkDeleteDialogContinueText": "Diese Aktion ist unwiderruflich. Möchten Sie trotzdem fortfahren?",
"documentsPageSelectionBulkDeleteDialogContinueText": "Diese Aktion ist unwiderruflich. Möchtest Du trotzdem fortfahren?",
"@documentsPageSelectionBulkDeleteDialogContinueText": {},
"documentsPageSelectionBulkDeleteDialogTitle": "Löschen bestätigen",
"@documentsPageSelectionBulkDeleteDialogTitle": {},
"documentsPageSelectionBulkDeleteDialogWarningTextMany": "Sind Sie sicher, dass sie folgende Dokumente löschen wollen?",
"documentsPageSelectionBulkDeleteDialogWarningTextMany": "Bist Du sicher, dass Du folgende Dokumente löschen möchtest?",
"@documentsPageSelectionBulkDeleteDialogWarningTextMany": {},
"documentsPageSelectionBulkDeleteDialogWarningTextOne": "Sind Sie sicher, dass sie folgendes Dokument löschen wollen?",
"documentsPageSelectionBulkDeleteDialogWarningTextOne": "Bist Du sicher, dass Du folgendes Dokument löschen möchtest?",
"@documentsPageSelectionBulkDeleteDialogWarningTextOne": {},
"documentsPageTitle": "Dokumente",
"@documentsPageTitle": {},
@@ -190,7 +192,7 @@
"@errorMessageCorrespondentLoadFailed": {},
"errorMessageCreateSavedViewError": "Gespeicherte Ansicht konnte nicht erstellt werden, bitte versuche es erneut.",
"@errorMessageCreateSavedViewError": {},
"errorMessageDeleteSavedViewError": "Gespeicherte Ansicht konnte nicht gelöscht werden, bitte versuche es erneut.",
"errorMessageDeleteSavedViewError": "Gespeicherte Ansicht konnte nicht geklöscht werden, bitte versuche es erneut.",
"@errorMessageDeleteSavedViewError": {},
"errorMessageDeviceOffline": "Daten konnten nicht geladen werden: Eine Verbindung zum Internet konnte nicht hergestellt werden.",
"@errorMessageDeviceOffline": {},
@@ -262,14 +264,18 @@
"@genericMessageOfflineText": {},
"inboxPageDocumentRemovedMessageText": "Dokument aus Posteingang entfernt.",
"@inboxPageDocumentRemovedMessageText": {},
"inboxPageMarkAllAsSeenConfirmationDialogText": "Sind Sie sicher, dass Sie alle Dokumente als gesehen markieren möchten? Dadurch wird eine Massenbearbeitung durchgeführt, bei der alle Posteingangs-Tags von den Dokumenten entfernt werden.\nDiese Aktion kann nicht rückgängig gemacht werden! Möchten Sie trotzdem fortfahren?",
"inboxPageMarkAllAsSeenConfirmationDialogText": "Bist Du sicher, dass Du alle Dokumente als gesehen markieren möchtest? Dadurch wird eine Massenbearbeitung durchgeführt, bei der alle Posteingangs-Tags von den Dokumenten entfernt werden.\\nDiese Aktion kann nicht rückgängig gemacht werden! Möchtest Du trotzdem fortfahren?",
"@inboxPageMarkAllAsSeenConfirmationDialogText": {},
"inboxPageMarkAllAsSeenConfirmationDialogTitleText": "Alle als gesehen markieren?",
"inboxPageMarkAllAsSeenConfirmationDialogTitleText": "Alle als gelesen markieren?",
"@inboxPageMarkAllAsSeenConfirmationDialogTitleText": {},
"inboxPageMarkAllAsSeenLabel": "Alle als gesehen markieren",
"inboxPageMarkAllAsSeenLabel": "Alle als gelesen markieren",
"@inboxPageMarkAllAsSeenLabel": {},
"inboxPageMarkAsSeenText": "Als gesehen markieren",
"inboxPageMarkAsSeenText": "Als gelesen markieren",
"@inboxPageMarkAsSeenText": {},
"inboxPageNoNewDocumentsRefreshLabel": "Neu laden",
"@inboxPageNoNewDocumentsRefreshLabel": {},
"inboxPageNoNewDocumentsText": "Du hast keine ungesehenen Dokumente.",
"@inboxPageNoNewDocumentsText": {},
"inboxPageTodayText": "Heute",
"@inboxPageTodayText": {},
"inboxPageUndoRemoveText": "UNDO",
@@ -415,7 +421,5 @@
"tagInboxTagPropertyLabel": "Posteingangs-Tag",
"@tagInboxTagPropertyLabel": {},
"uploadPageAutomaticallInferredFieldsHintText": "Wenn Werte für diese Felder angegeben werden, wird Paperless nicht automatisch einen Wert zuweisen. Wenn diese Felder automatisch von Paperless erkannt werden sollen, sollten die Felder leer bleiben.",
"@uploadPageAutomaticallInferredFieldsHintText": {},
"inboxPageNoNewDocumentsText": "You do not have unseen documents.",
"inboxPageNoNewDocumentsRefreshLabel": "Refresh"
"@uploadPageAutomaticallInferredFieldsHintText": {}
}

12
lib/l10n/intl_en.arb
View File

@@ -70,6 +70,8 @@
"@documentDetailsPageTabOverviewLabel": {},
"documentDocumentTypePropertyLabel": "Document Type",
"@documentDocumentTypePropertyLabel": {},
"documentDownloadSuccessMessage": "Document successfully downloaded.",
"@documentDownloadSuccessMessage": {},
"documentEditPageTitle": "Edit Document",
"@documentEditPageTitle": {},
"documentMetaDataChecksumLabel": "Original MD5-Checksum",
@@ -262,7 +264,7 @@
"@genericMessageOfflineText": {},
"inboxPageDocumentRemovedMessageText": "Document removed from inbox.",
"@inboxPageDocumentRemovedMessageText": {},
"inboxPageMarkAllAsSeenConfirmationDialogText": "Are you sure you want to mark all documents as seen? This will perform a bulk edit operation removing all inbox tags from the documents.\nThis action is not reversible! Are you sure you want to continue?",
"inboxPageMarkAllAsSeenConfirmationDialogText": "Are you sure you want to mark all documents as seen? This will perform a bulk edit operation removing all inbox tags from the documents.\\nThis action is not reversible! Are you sure you want to continue?",
"@inboxPageMarkAllAsSeenConfirmationDialogText": {},
"inboxPageMarkAllAsSeenConfirmationDialogTitleText": "Mark all as seen?",
"@inboxPageMarkAllAsSeenConfirmationDialogTitleText": {},
@@ -270,6 +272,10 @@
"@inboxPageMarkAllAsSeenLabel": {},
"inboxPageMarkAsSeenText": "Mark as seen",
"@inboxPageMarkAsSeenText": {},
"inboxPageNoNewDocumentsRefreshLabel": "Refresh",
"@inboxPageNoNewDocumentsRefreshLabel": {},
"inboxPageNoNewDocumentsText": "You do not have unseen documents.",
"@inboxPageNoNewDocumentsText": {},
"inboxPageTodayText": "Today",
"@inboxPageTodayText": {},
"inboxPageUndoRemoveText": "UNDO",
@@ -415,7 +421,5 @@
"tagInboxTagPropertyLabel": "Inbox-Tag",
"@tagInboxTagPropertyLabel": {},
"uploadPageAutomaticallInferredFieldsHintText": "If you specify values for these fields, your paperless instance will not automatically derive a value. If you want these values to be automatically populated by your server, leave the fields blank.",
"@uploadPageAutomaticallInferredFieldsHintText": {},
"inboxPageNoNewDocumentsText": "You do not have unseen documents.",
"inboxPageNoNewDocumentsRefreshLabel": "Refresh"
"@uploadPageAutomaticallInferredFieldsHintText": {}
}

67
lib/main.dart
View File

@@ -32,8 +32,9 @@ import 'package:paperless_mobile/features/settings/model/application_settings_st
import 'package:paperless_mobile/generated/l10n.dart';
import 'package:paperless_mobile/util.dart';
import 'package:receive_sharing_intent/receive_sharing_intent.dart';
import 'package:paperless_mobile/extensions/flutter_extensions.dart';
Future<void> startAppProd() async {
void main() async {
Bloc.observer = BlocChangesObserver();
final widgetsBinding = WidgetsFlutterBinding.ensureInitialized();
FlutterNativeSplash.preserve(widgetsBinding: widgetsBinding);
@@ -54,10 +55,6 @@ Future<void> startAppProd() async {
runApp(const PaperlessMobileEntrypoint());
}
void main() async {
await startAppProd();
}
class PaperlessMobileEntrypoint extends StatefulWidget {
const PaperlessMobileEntrypoint({Key? key}) : super(key: key);
@@ -71,10 +68,18 @@ class _PaperlessMobileEntrypointState extends State<PaperlessMobileEntrypoint> {
Widget build(BuildContext context) {
return MultiBlocProvider(
providers: [
BlocProvider.value(value: getIt<ConnectivityCubit>()),
BlocProvider.value(value: getIt<AuthenticationCubit>()),
BlocProvider.value(value: getIt<PaperlessServerInformationCubit>()),
BlocProvider.value(value: getIt<ApplicationSettingsCubit>()),
BlocProvider<ConnectivityCubit>.value(
value: getIt<ConnectivityCubit>(),
),
BlocProvider<AuthenticationCubit>.value(
value: getIt<AuthenticationCubit>(),
),
BlocProvider<PaperlessServerInformationCubit>.value(
value: getIt<PaperlessServerInformationCubit>(),
),
BlocProvider<ApplicationSettingsCubit>.value(
value: getIt<ApplicationSettingsCubit>(),
),
],
child: BlocBuilder<ApplicationSettingsCubit, ApplicationSettingsState>(
builder: (context, settings) {
@@ -234,6 +239,10 @@ class _AuthenticationWrapperState extends State<AuthenticationWrapper> {
child: const HomePage(),
);
} else {
if (authentication.wasLoginStored &&
!(authentication.wasLocalAuthenticationSuccessful ?? false)) {
return BiometricAuthenticationPage();
}
return const LoginPage();
}
},
@@ -241,3 +250,43 @@ class _AuthenticationWrapperState extends State<AuthenticationWrapper> {
);
}
}
class BiometricAuthenticationPage extends StatelessWidget {
const BiometricAuthenticationPage({super.key});
@override
Widget build(BuildContext context) {
return Material(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [
Text(
"The app is locked!",
style: Theme.of(context).textTheme.titleLarge,
),
Text(
"You can now either try to authenticate again or disconnect from the current server.",
textAlign: TextAlign.center,
style: Theme.of(context).textTheme.caption,
).padded(),
const SizedBox(height: 48),
Row(
mainAxisAlignment: MainAxisAlignment.spaceAround,
children: [
ElevatedButton(
onPressed: () =>
BlocProvider.of<AuthenticationCubit>(context).logout(),
child: Text("Log out"),
),
ElevatedButton(
onPressed: () => BlocProvider.of<AuthenticationCubit>(context)
.restoreSessionState(),
child: Text("Authenticate"),
),
],
),
],
),
);
}
}

18
lib/util.dart
View File

@@ -22,15 +22,17 @@ void showSnackBar(
String? details,
SnackBarAction? action,
}) {
ScaffoldMessenger.of(context).showSnackBar(
SnackBar(
content: Text(
message + (details != null ? ' ($details)' : ''),
ScaffoldMessenger.of(context)
..hideCurrentSnackBar()
..showSnackBar(
SnackBar(
content: Text(
message + (details != null ? ' ($details)' : ''),
),
action: action,
duration: const Duration(seconds: 5),
),
action: action,
duration: const Duration(seconds: 5),
),
);
);
}
void showGenericError(

40
packages/paperless_api/lib/src/models/labels/correspondent_model.dart
View File

@@ -1,12 +1,14 @@
import 'package:json_annotation/json_annotation.dart';
import 'package:paperless_api/src/models/labels/label_model.dart';
import 'package:paperless_api/src/models/labels/matching_algorithm.dart';
part 'correspondent_model.g.dart';
@JsonSerializable(includeIfNull: false, fieldRename: FieldRename.snake)
class Correspondent extends Label {
static const lastCorrespondenceKey = 'last_correspondence';
final DateTime? lastCorrespondence;
late DateTime? lastCorrespondence;
Correspondent({
const Correspondent({
required super.id,
required super.name,
super.slug,
@@ -17,24 +19,16 @@ class Correspondent extends Label {
this.lastCorrespondence,
});
Correspondent.fromJson(Map<String, dynamic> json)
: lastCorrespondence =
DateTime.tryParse(json[lastCorrespondenceKey] ?? ''),
super.fromJson(json);
factory Correspondent.fromJson(Map<String, dynamic> json) =>
_$CorrespondentFromJson(json);
Map<String, dynamic> toJson() => _$CorrespondentToJson(this);
@override
String toString() {
return name;
}
@override
void addSpecificFieldsToJson(Map<String, dynamic> json) {
if (lastCorrespondence != null) {
json.putIfAbsent(
lastCorrespondenceKey, () => lastCorrespondence!.toIso8601String());
}
}
@override
Correspondent copyWith({
int? id,
@@ -51,13 +45,25 @@ class Correspondent extends Label {
name: name ?? this.name,
documentCount: documentCount ?? documentCount,
isInsensitive: isInsensitive ?? isInsensitive,
lastCorrespondence: lastCorrespondence ?? this.lastCorrespondence,
match: match ?? this.match,
matchingAlgorithm: matchingAlgorithm ?? this.matchingAlgorithm,
slug: slug ?? this.slug,
lastCorrespondence: lastCorrespondence ?? this.lastCorrespondence,
);
}
@override
String get queryEndpoint => 'correspondents';
@override
List<Object?> get props => [
id,
name,
slug,
isInsensitive,
documentCount,
lastCorrespondence,
matchingAlgorithm,
match,
];
}

53
packages/paperless_api/lib/src/models/labels/correspondent_model.g.dart Normal file
View File

@@ -0,0 +1,53 @@
// GENERATED CODE - DO NOT MODIFY BY HAND
part of 'correspondent_model.dart';
// **************************************************************************
// JsonSerializableGenerator
// **************************************************************************
Correspondent _$CorrespondentFromJson(Map<String, dynamic> json) =>
Correspondent(
id: json['id'] as int?,
name: json['name'] as String,
slug: json['slug'] as String?,
match: json['match'] as String?,
matchingAlgorithm: $enumDecodeNullable(
_$MatchingAlgorithmEnumMap, json['matching_algorithm']),
isInsensitive: json['is_insensitive'] as bool?,
documentCount: json['document_count'] as int?,
lastCorrespondence: json['last_correspondence'] == null
? null
: DateTime.parse(json['last_correspondence'] as String),
);
Map<String, dynamic> _$CorrespondentToJson(Correspondent instance) {
final val = <String, dynamic>{};
void writeNotNull(String key, dynamic value) {
if (value != null) {
val[key] = value;
}
}
writeNotNull('id', instance.id);
val['name'] = instance.name;
writeNotNull('slug', instance.slug);
writeNotNull('match', instance.match);
writeNotNull('matching_algorithm',
_$MatchingAlgorithmEnumMap[instance.matchingAlgorithm]);
writeNotNull('is_insensitive', instance.isInsensitive);
writeNotNull('document_count', instance.documentCount);
writeNotNull(
'last_correspondence', instance.lastCorrespondence?.toIso8601String());
return val;
}
const _$MatchingAlgorithmEnumMap = {
MatchingAlgorithm.anyWord: 1,
MatchingAlgorithm.allWords: 2,
MatchingAlgorithm.exactMatch: 3,
MatchingAlgorithm.regex: 4,
MatchingAlgorithm.similarWord: 5,
MatchingAlgorithm.auto: 6,
};

25
packages/paperless_api/lib/src/models/labels/document_type_model.dart
View File

@@ -1,8 +1,11 @@
import 'package:json_annotation/json_annotation.dart';
import 'package:paperless_api/src/models/labels/label_model.dart';
import 'package:paperless_api/src/models/labels/matching_algorithm.dart';
part 'document_type_model.g.dart';
@JsonSerializable(includeIfNull: false, fieldRename: FieldRename.snake)
class DocumentType extends Label {
DocumentType({
const DocumentType({
required super.id,
required super.name,
super.slug,
@@ -12,10 +15,8 @@ class DocumentType extends Label {
super.documentCount,
});
DocumentType.fromJson(Map<String, dynamic> json) : super.fromJson(json);
@override
void addSpecificFieldsToJson(Map<String, dynamic> json) {}
factory DocumentType.fromJson(Map<String, dynamic> json) =>
_$DocumentTypeFromJson(json);
@override
String get queryEndpoint => 'document_types';
@@ -40,4 +41,18 @@ class DocumentType extends Label {
slug: slug ?? this.slug,
);
}
@override
Map<String, dynamic> toJson() => _$DocumentTypeToJson(this);
@override
List<Object?> get props => [
id,
name,
slug,
isInsensitive,
documentCount,
matchingAlgorithm,
match,
];
}

47
packages/paperless_api/lib/src/models/labels/document_type_model.g.dart Normal file
View File

@@ -0,0 +1,47 @@
// GENERATED CODE - DO NOT MODIFY BY HAND
part of 'document_type_model.dart';
// **************************************************************************
// JsonSerializableGenerator
// **************************************************************************
DocumentType _$DocumentTypeFromJson(Map<String, dynamic> json) => DocumentType(
id: json['id'] as int?,
name: json['name'] as String,
slug: json['slug'] as String?,
match: json['match'] as String?,
matchingAlgorithm: $enumDecodeNullable(
_$MatchingAlgorithmEnumMap, json['matching_algorithm']),
isInsensitive: json['is_insensitive'] as bool?,
documentCount: json['document_count'] as int?,
);
Map<String, dynamic> _$DocumentTypeToJson(DocumentType instance) {
final val = <String, dynamic>{};
void writeNotNull(String key, dynamic value) {
if (value != null) {
val[key] = value;
}
}
writeNotNull('id', instance.id);
val['name'] = instance.name;
writeNotNull('slug', instance.slug);
writeNotNull('match', instance.match);
writeNotNull('matching_algorithm',
_$MatchingAlgorithmEnumMap[instance.matchingAlgorithm]);
writeNotNull('is_insensitive', instance.isInsensitive);
writeNotNull('document_count', instance.documentCount);
return val;
}
const _$MatchingAlgorithmEnumMap = {
MatchingAlgorithm.anyWord: 1,
MatchingAlgorithm.allWords: 2,
MatchingAlgorithm.exactMatch: 3,
MatchingAlgorithm.regex: 4,
MatchingAlgorithm.similarWord: 5,
MatchingAlgorithm.auto: 6,
};

39
packages/paperless_api/lib/src/models/labels/label_model.dart
View File

@@ -1,7 +1,8 @@
import 'package:equatable/equatable.dart';
import 'package:json_annotation/json_annotation.dart';
import 'package:paperless_api/src/models/labels/matching_algorithm.dart';
abstract class Label with EquatableMixin implements Comparable {
abstract class Label extends Equatable implements Comparable {
static const idKey = "id";
static const nameKey = "name";
static const slugKey = "slug";
@@ -11,13 +12,19 @@ abstract class Label with EquatableMixin implements Comparable {
static const documentCountKey = "document_count";
String get queryEndpoint;
@JsonKey()
final int? id;
@JsonKey()
final String name;
@JsonKey()
final String? slug;
@JsonKey()
final String? match;
@JsonKey()
final MatchingAlgorithm? matchingAlgorithm;
@JsonKey()
final bool? isInsensitive;
@JsonKey()
final int? documentCount;
const Label({
@@ -30,31 +37,6 @@ abstract class Label with EquatableMixin implements Comparable {
this.slug,
});
Label.fromJson(Map<String, dynamic> json)
: id = json[idKey],
name = json[nameKey],
slug = json[slugKey],
match = json[matchKey],
matchingAlgorithm =
MatchingAlgorithm.fromInt(json[matchingAlgorithmKey]),
isInsensitive = json[isInsensitiveKey],
documentCount = json[documentCountKey];
Map<String, dynamic> toJson() {
Map<String, dynamic> json = {};
json.putIfAbsent(idKey, () => id);
json.putIfAbsent(nameKey, () => name);
json.putIfAbsent(slugKey, () => slug);
json.putIfAbsent(matchKey, () => match);
json.putIfAbsent(matchingAlgorithmKey, () => matchingAlgorithm?.value);
json.putIfAbsent(isInsensitiveKey, () => isInsensitive);
json.putIfAbsent(documentCountKey, () => documentCount);
addSpecificFieldsToJson(json);
return json;
}
void addSpecificFieldsToJson(Map<String, dynamic> json);
Label copyWith({
int? id,
String? name,
@@ -75,6 +57,5 @@ abstract class Label with EquatableMixin implements Comparable {
return toString().toLowerCase().compareTo(other.toString().toLowerCase());
}
@override
List<Object?> get props => [id];
Map<String, dynamic> toJson();
}

3
packages/paperless_api/lib/src/models/labels/matching_algorithm.dart
View File

@@ -1,3 +1,6 @@
import 'package:json_annotation/json_annotation.dart';
@JsonEnum(valueField: 'value')
enum MatchingAlgorithm {
anyWord(1, "Any: Match one of the following words"),
allWords(2, "All: Match all of the following words"),

32
packages/paperless_api/lib/src/models/labels/storage_path_model.dart
View File

@@ -1,9 +1,11 @@
import 'package:json_annotation/json_annotation.dart';
import 'package:paperless_api/src/models/labels/label_model.dart';
import 'package:paperless_api/src/models/labels/matching_algorithm.dart';
part 'storage_path_model.g.dart';
@JsonSerializable(includeIfNull: false, fieldRename: FieldRename.snake)
class StoragePath extends Label {
static const pathKey = 'path';
late String? path;
StoragePath({
@@ -17,23 +19,14 @@ class StoragePath extends Label {
required this.path,
});
StoragePath.fromJson(Map<String, dynamic> json)
: path = json[pathKey],
super.fromJson(json);
factory StoragePath.fromJson(Map<String, dynamic> json) =>
_$StoragePathFromJson(json);
@override
String toString() {
return name;
}
@override
void addSpecificFieldsToJson(Map<String, dynamic> json) {
json.putIfAbsent(
pathKey,
() => path,
);
}
@override
StoragePath copyWith({
int? id,
@@ -59,4 +52,19 @@ class StoragePath extends Label {
@override
String get queryEndpoint => 'storage_paths';
@override
List<Object?> get props => [
id,
name,
slug,
isInsensitive,
documentCount,
path,
matchingAlgorithm,
match,
];
@override
Map<String, dynamic> toJson() => _$StoragePathToJson(this);
}

49
packages/paperless_api/lib/src/models/labels/storage_path_model.g.dart Normal file
View File

@@ -0,0 +1,49 @@
// GENERATED CODE - DO NOT MODIFY BY HAND
part of 'storage_path_model.dart';
// **************************************************************************
// JsonSerializableGenerator
// **************************************************************************
StoragePath _$StoragePathFromJson(Map<String, dynamic> json) => StoragePath(
id: json['id'] as int?,
name: json['name'] as String,
slug: json['slug'] as String?,
match: json['match'] as String?,
matchingAlgorithm: $enumDecodeNullable(
_$MatchingAlgorithmEnumMap, json['matching_algorithm']),
isInsensitive: json['is_insensitive'] as bool?,
documentCount: json['document_count'] as int?,
path: json['path'] as String?,
);
Map<String, dynamic> _$StoragePathToJson(StoragePath instance) {
final val = <String, dynamic>{};
void writeNotNull(String key, dynamic value) {
if (value != null) {
val[key] = value;
}
}
writeNotNull('id', instance.id);
val['name'] = instance.name;
writeNotNull('slug', instance.slug);
writeNotNull('match', instance.match);
writeNotNull('matching_algorithm',
_$MatchingAlgorithmEnumMap[instance.matchingAlgorithm]);
writeNotNull('is_insensitive', instance.isInsensitive);
writeNotNull('document_count', instance.documentCount);
writeNotNull('path', instance.path);
return val;
}
const _$MatchingAlgorithmEnumMap = {
MatchingAlgorithm.anyWord: 1,
MatchingAlgorithm.allWords: 2,
MatchingAlgorithm.exactMatch: 3,
MatchingAlgorithm.regex: 4,
MatchingAlgorithm.similarWord: 5,
MatchingAlgorithm.auto: 6,
};

151
packages/paperless_api/lib/src/models/labels/tag_model.dart
View File

@@ -1,6 +1,7 @@
import 'dart:developer';
import 'dart:ui';
import 'package:json_annotation/json_annotation.dart';
import 'package:paperless_api/src/models/labels/label_model.dart';
import 'package:paperless_api/src/models/labels/matching_algorithm.dart';
@@ -10,11 +11,17 @@ class Tag extends Label {
static const textColorKey = 'text_color';
static const legacyColourKey = 'colour';
final Color? color;
final Color? _apiV2color;
final Color? _apiV1color;
final Color? textColor;
final bool? isInboxTag;
Tag({
Color? get color => _apiV2color ?? _apiV1color;
const Tag({
required super.id,
required super.name,
super.documentCount,
@@ -22,42 +29,17 @@ class Tag extends Label {
super.match,
super.matchingAlgorithm,
super.slug,
this.color,
Color? color,
this.textColor,
this.isInboxTag,
});
Tag.fromJson(Map<String, dynamic> json)
: isInboxTag = json[isInboxTagKey],
textColor = Color(_colorStringToInt(json[textColorKey]) ?? 0),
color = _parseColorFromJson(json),
super.fromJson(json);
///
/// The `color` field of the json object can either be of type [Color] or a hex [String].
/// Since API version 2, the old attribute `colour` has been replaced with `color`.
///
static Color _parseColorFromJson(Map<String, dynamic> json) {
if (json.containsKey(legacyColourKey)) {
return Color(_colorStringToInt(json[legacyColourKey]) ?? 0);
}
if (json[colorKey] is Color) {
return json[colorKey];
}
return Color(_colorStringToInt(json[colorKey]) ?? 0);
}
}) : _apiV1color = color,
_apiV2color = color;
@override
String toString() {
return name;
}
@override
void addSpecificFieldsToJson(Map<String, dynamic> json) {
json.putIfAbsent(colorKey, () => _toHex(color));
json.putIfAbsent(isInboxTagKey, () => isInboxTag);
}
@override
Tag copyWith({
int? id,
@@ -87,22 +69,103 @@ class Tag extends Label {
@override
String get queryEndpoint => 'tags';
}
///
/// Taken from [FormBuilderColorPicker].
///
String? _toHex(Color? color) {
if (color == null) {
@override
List<Object?> get props => [
id,
name,
slug,
isInsensitive,
documentCount,
matchingAlgorithm,
color,
textColor,
isInboxTag,
match,
];
factory Tag.fromJson(Map<String, dynamic> json) {
const $MatchingAlgorithmEnumMap = {
MatchingAlgorithm.anyWord: 1,
MatchingAlgorithm.allWords: 2,
MatchingAlgorithm.exactMatch: 3,
MatchingAlgorithm.regex: 4,
MatchingAlgorithm.similarWord: 5,
MatchingAlgorithm.auto: 6,
};
return Tag(
id: json['id'] as int?,
name: json['name'] as String,
documentCount: json['document_count'] as int?,
isInsensitive: json['is_insensitive'] as bool?,
match: json['match'] as String?,
matchingAlgorithm: $enumDecodeNullable(
$MatchingAlgorithmEnumMap, json['matching_algorithm']),
slug: json['slug'] as String?,
textColor: _colorFromJson(json['text_color']),
isInboxTag: json['is_inbox_tag'] as bool?,
color: _colorFromJson(json['color']) ?? _colorFromJson(json['colour']),
);
}
@override
Map<String, dynamic> toJson() {
final val = <String, dynamic>{};
const $MatchingAlgorithmEnumMap = {
MatchingAlgorithm.anyWord: 1,
MatchingAlgorithm.allWords: 2,
MatchingAlgorithm.exactMatch: 3,
MatchingAlgorithm.regex: 4,
MatchingAlgorithm.similarWord: 5,
MatchingAlgorithm.auto: 6,
};
void writeNotNull(String key, dynamic value) {
if (value != null) {
val[key] = value;
}
}
writeNotNull('id', id);
val['name'] = name;
writeNotNull('slug', slug);
writeNotNull('match', match);
writeNotNull(
'matching_algorithm', $MatchingAlgorithmEnumMap[matchingAlgorithm]);
writeNotNull('is_insensitive', isInsensitive);
writeNotNull('document_count', documentCount);
writeNotNull('color', _toHex(_apiV2color));
writeNotNull('colour', _toHex(_apiV1color));
writeNotNull('text_color', _toHex(textColor));
writeNotNull('is_inbox_tag', isInboxTag);
return val;
}
static Color? _colorFromJson(dynamic color) {
if (color is Color) {
return color;
}
if (color is String) {
final decoded = int.tryParse(color.replaceAll("#", "ff"), radix: 16);
if (decoded == null) {
return null;
}
return Color(decoded);
}
return null;
}
String val =
'#${(color.value & 0xFFFFFF).toRadixString(16).padLeft(6, '0').toLowerCase()}';
log("Color in Tag#_toHex is $val");
return val;
}
int? _colorStringToInt(String? color) {
if (color == null) return null;
return int.tryParse(color.replaceAll("#", "ff"), radix: 16);
///
/// Taken from [FormBuilderColorPicker].
///
static String? _toHex(Color? color) {
if (color == null) {
return null;
}
String val =
'#${(color.value & 0xFFFFFF).toRadixString(16).padLeft(6, '0').toLowerCase()}';
return val;
}
}

1
packages/paperless_api/lib/src/modules/authentication_api/authentication_api.dart
View File

@@ -2,6 +2,5 @@ abstract class PaperlessAuthenticationApi {
Future<String> login({
required String username,
required String password,
required String serverUrl,
});
}

6
packages/paperless_api/lib/src/modules/authentication_api/authentication_api_impl.dart
View File

@@ -14,13 +14,15 @@ class PaperlessAuthenticationApiImpl implements PaperlessAuthenticationApi {
Future<String> login({
required String username,
required String password,
required String serverUrl,
}) async {
late Response response;
try {
response = await client.post(
Uri.parse("/api/token/"),
body: {"username": username, "password": password},
body: {
"username": username,
"password": password,
},
);
} on FormatException catch (e) {
final source = e.source;

11
pubspec.lock
View File

@@ -644,6 +644,13 @@ packages:
url: "https://pub.dartlang.org"
source: hosted
version: "2.1.0"
hive:
dependency: "direct main"
description:
name: hive
url: "https://pub.dartlang.org"
source: hosted
version: "2.2.3"
html:
dependency: transitive
description:
@@ -699,14 +706,14 @@ packages:
name: injectable
url: "https://pub.dartlang.org"
source: hosted
version: "1.5.3"
version: "2.1.0"
injectable_generator:
dependency: "direct dev"
description:
name: injectable_generator
url: "https://pub.dartlang.org"
source: hosted
version: "1.5.4"
version: "2.1.2"
integration_test:
dependency: "direct dev"
description: flutter

5
pubspec.yaml
View File

@@ -33,7 +33,7 @@ dependencies:
flutter_localizations:
sdk: flutter
get_it: ^7.2.0
injectable: ^1.5.3
injectable: ^2.1.0
encrypted_shared_preferences: ^3.0.0
permission_handler: ^9.2.0
pdf: ^3.8.1
@@ -80,6 +80,7 @@ dependencies:
fluttertoast: ^8.1.1
paperless_api:
path: packages/paperless_api
hive: ^2.2.3
dev_dependencies:
integration_test:
@@ -87,7 +88,7 @@ dev_dependencies:
flutter_test:
sdk: flutter
build_runner: ^2.1.11
injectable_generator: ^1.5.3
injectable_generator: ^2.1.0
mockito: ^5.3.2
bloc_test: ^9.1.0
dependency_validator: ^3.0.0