Refactor developer settings

This commit is contained in:
Ming Ming 2023-05-30 00:55:10 +08:00
parent 228bee77b9
commit f531865a3a
7 changed files with 340 additions and 67 deletions

View file

@ -1,3 +1,11 @@
abstract class BlocTag {
String get tag;
}
/// Wrap around a string such that two strings with the same value will fail
/// the identical check
class StateMessage {
StateMessage(this.value);
final String value;
}

View file

@ -9,9 +9,7 @@ import 'package:nc_photos/account.dart';
import 'package:nc_photos/app_localizations.dart';
import 'package:nc_photos/controller/account_controller.dart';
import 'package:nc_photos/debug_util.dart';
import 'package:nc_photos/di_container.dart';
import 'package:nc_photos/entity/server_status.dart';
import 'package:nc_photos/entity/sqlite/database.dart' as sql;
import 'package:nc_photos/event/event.dart';
import 'package:nc_photos/exception_util.dart' as exception_util;
import 'package:nc_photos/k.dart' as k;
@ -30,6 +28,7 @@ import 'package:nc_photos/widget/gps_map.dart';
import 'package:nc_photos/widget/home.dart';
import 'package:nc_photos/widget/list_tile_center_leading.dart';
import 'package:nc_photos/widget/root_picker.dart';
import 'package:nc_photos/widget/settings/developer_settings.dart';
import 'package:nc_photos/widget/settings/expert_settings.dart';
import 'package:nc_photos/widget/settings/theme_settings.dart';
import 'package:nc_photos/widget/share_folder_picker.dart';
@ -200,7 +199,7 @@ class _SettingsState extends State<Settings> {
context,
leading: const Icon(Icons.code_outlined),
label: "Developer options",
builder: () => _DevSettings(),
builder: () => const DeveloperSettings(),
),
_buildCaption(context, L10n.global().settingsAboutSectionTitle),
ListTile(
@ -1582,63 +1581,6 @@ class _MiscSettingsState extends State<_MiscSettings> {
late bool _isDoubleTapExit;
}
class _DevSettings extends StatefulWidget {
@override
createState() => _DevSettingsState();
}
@npLog
class _DevSettingsState extends State<_DevSettings> {
@override
build(BuildContext context) {
return Scaffold(
body: Builder(
builder: (context) => _buildContent(context),
),
);
}
Widget _buildContent(BuildContext context) {
return CustomScrollView(
slivers: [
const SliverAppBar(
pinned: true,
title: Text("Developer options"),
),
SliverList(
delegate: SliverChildListDelegate(
[
ListTile(
title: const Text("SQL:VACUUM"),
onTap: () => _runSqlVacuum(),
),
],
),
),
],
);
}
Future<void> _runSqlVacuum() async {
try {
final c = KiwiContainer().resolve<DiContainer>();
await c.sqliteDb.useNoTransaction((db) async {
await db.customStatement("VACUUM;");
});
SnackBarManager().showSnackBar(const SnackBar(
content: Text("Finished successfully"),
duration: k.snackBarDurationShort,
));
} catch (e, stackTrace) {
SnackBarManager().showSnackBar(SnackBar(
content: Text(exception_util.toUserString(e)),
duration: k.snackBarDurationNormal,
));
_log.shout("[_runSqlVacuum] Uncaught exception", e, stackTrace);
}
}
}
Widget _buildCaption(BuildContext context, String label) {
return Padding(
padding: const EdgeInsets.fromLTRB(16, 16, 16, 8),

View file

@ -54,10 +54,3 @@ extension _$_MiscSettingsStateNpLog on _MiscSettingsState {
static final log = Logger("widget.settings._MiscSettingsState");
}
extension _$_DevSettingsStateNpLog on _DevSettingsState {
// ignore: unused_element
Logger get _log => log;
static final log = Logger("widget.settings._DevSettingsState");
}

View file

@ -0,0 +1,54 @@
part of '../developer_settings.dart';
@npLog
class _Bloc extends Bloc<_Event, _State> {
_Bloc(DiContainer c)
: _c = c,
super(const _State()) {
on<_VacuumDb>(_onVacuumDb);
on<_ExportDb>(_onExportDb);
on<_ClearCertWhitelist>(_onClearCertWhitelist);
on<_SetError>(_onSetError);
}
@override
void onError(Object error, StackTrace stackTrace) {
// we need this to prevent onError being triggered recursively
if (!isClosed && !_isHandlingError) {
_isHandlingError = true;
try {
add(_SetError(error, stackTrace));
} catch (_) {}
_isHandlingError = false;
}
super.onError(error, stackTrace);
}
Future<void> _onVacuumDb(_VacuumDb ev, Emitter<_State> emit) async {
await _c.sqliteDb.useNoTransaction((db) async {
await db.customStatement("VACUUM;");
});
emit(state.copyWith(message: StateMessage("Finished successfully")));
}
Future<void> _onExportDb(_ExportDb ev, Emitter<_State> emit) async {
await platform.exportSqliteDb(_c.sqliteDb);
emit(state.copyWith(message: StateMessage("Finished successfully")));
}
Future<void> _onClearCertWhitelist(
_ClearCertWhitelist ev, Emitter<_State> emit) async {
await SelfSignedCertManager().clearWhitelist();
emit(state.copyWith(message: StateMessage("Finished successfully")));
}
void _onSetError(_SetError ev, Emitter<_State> emit) {
_log.info("$ev");
emit(state.copyWith(error: ExceptionEvent(ev.error, ev.stackTrace)));
}
final DiContainer _c;
var _isHandlingError = false;
}

View file

@ -0,0 +1,56 @@
part of '../developer_settings.dart';
@genCopyWith
@toString
class _State {
const _State({
this.lastSuccessful,
this.error,
this.message,
});
@override
String toString() => _$toString();
final _Event? lastSuccessful;
final ExceptionEvent? error;
final StateMessage? message;
}
abstract class _Event {}
@toString
class _VacuumDb implements _Event {
const _VacuumDb();
@override
String toString() => _$toString();
}
@toString
class _ExportDb implements _Event {
const _ExportDb();
@override
String toString() => _$toString();
}
@toString
class _ClearCertWhitelist implements _Event {
const _ClearCertWhitelist();
@override
String toString() => _$toString();
}
@toString
class _SetError implements _Event {
const _SetError(this.error, [this.stackTrace]);
@override
String toString() => _$toString();
final Object error;
final StackTrace? stackTrace;
}

View file

@ -0,0 +1,118 @@
import 'package:copy_with/copy_with.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:kiwi/kiwi.dart';
import 'package:logging/logging.dart';
import 'package:nc_photos/bloc_util.dart';
import 'package:nc_photos/di_container.dart';
import 'package:nc_photos/entity/sqlite/database.dart';
import 'package:nc_photos/exception_event.dart';
import 'package:nc_photos/exception_util.dart' as exception_util;
import 'package:nc_photos/k.dart' as k;
import 'package:nc_photos/mobile/platform.dart'
if (dart.library.html) 'package:nc_photos/web/platform.dart' as platform;
import 'package:nc_photos/mobile/self_signed_cert_manager.dart';
import 'package:nc_photos/platform/k.dart' as platform_k;
import 'package:nc_photos/snack_bar_manager.dart';
import 'package:nc_photos/widget/page_visibility_mixin.dart';
import 'package:np_codegen/np_codegen.dart';
import 'package:to_string/to_string.dart';
part 'developer/bloc.dart';
part 'developer/state_event.dart';
part 'developer_settings.g.dart';
class DeveloperSettings extends StatelessWidget {
const DeveloperSettings({super.key});
@override
Widget build(BuildContext context) {
return BlocProvider(
create: (_) => _Bloc(KiwiContainer().resolve<DiContainer>()),
child: const _WrappedDeveloperSettings(),
);
}
}
class _WrappedDeveloperSettings extends StatefulWidget {
const _WrappedDeveloperSettings();
@override
State<StatefulWidget> createState() => _WrappedDeveloperSettingsState();
}
@npLog
class _WrappedDeveloperSettingsState extends State<_WrappedDeveloperSettings>
with RouteAware, PageVisibilityMixin {
@override
Widget build(BuildContext context) {
return Scaffold(
body: MultiBlocListener(
listeners: [
BlocListener<_Bloc, _State>(
listenWhen: (previous, current) => previous.error != current.error,
listener: (context, state) {
if (state.error != null && isPageVisible()) {
SnackBarManager().showSnackBar(SnackBar(
content:
Text(exception_util.toUserString(state.error!.error)),
duration: k.snackBarDurationNormal,
));
}
},
),
BlocListener<_Bloc, _State>(
listenWhen: (previous, current) =>
previous.message != current.message,
listener: (context, state) {
if (state.message != null && isPageVisible()) {
SnackBarManager().showSnackBar(SnackBar(
content: Text(state.message!.value),
duration: k.snackBarDurationNormal,
));
}
},
),
],
child: CustomScrollView(
slivers: [
const SliverAppBar(
pinned: true,
title: Text("Developer options"),
),
SliverList(
delegate: SliverChildListDelegate(
[
ListTile(
title: const Text("SQL:VACUUM"),
onTap: () {
context.read<_Bloc>().add(const _VacuumDb());
},
),
if (kDebugMode) ...[
ListTile(
title: const Text("Export SQLite DB"),
onTap: () {
context.read<_Bloc>().add(const _ExportDb());
},
),
if (platform_k.isMobile)
ListTile(
title: const Text("Clear whitelisted certs"),
onTap: () {
context
.read<_Bloc>()
.add(const _ClearCertWhitelist());
},
),
],
],
),
),
],
),
),
);
}
}

View file

@ -0,0 +1,102 @@
// GENERATED CODE - DO NOT MODIFY BY HAND
part of 'developer_settings.dart';
// **************************************************************************
// CopyWithLintRuleGenerator
// **************************************************************************
// ignore_for_file: library_private_types_in_public_api, duplicate_ignore
// **************************************************************************
// CopyWithGenerator
// **************************************************************************
abstract class $_StateCopyWithWorker {
_State call(
{_Event? lastSuccessful, ExceptionEvent? error, StateMessage? message});
}
class _$_StateCopyWithWorkerImpl implements $_StateCopyWithWorker {
_$_StateCopyWithWorkerImpl(this.that);
@override
_State call(
{dynamic lastSuccessful = copyWithNull,
dynamic error = copyWithNull,
dynamic message = copyWithNull}) {
return _State(
lastSuccessful: lastSuccessful == copyWithNull
? that.lastSuccessful
: lastSuccessful as _Event?,
error: error == copyWithNull ? that.error : error as ExceptionEvent?,
message:
message == copyWithNull ? that.message : message as StateMessage?);
}
final _State that;
}
extension $_StateCopyWith on _State {
$_StateCopyWithWorker get copyWith => _$copyWith;
$_StateCopyWithWorker get _$copyWith => _$_StateCopyWithWorkerImpl(this);
}
// **************************************************************************
// NpLogGenerator
// **************************************************************************
extension _$_WrappedDeveloperSettingsStateNpLog
on _WrappedDeveloperSettingsState {
// ignore: unused_element
Logger get _log => log;
static final log = Logger(
"widget.settings.developer_settings._WrappedDeveloperSettingsState");
}
extension _$_BlocNpLog on _Bloc {
// ignore: unused_element
Logger get _log => log;
static final log = Logger("widget.settings.developer_settings._Bloc");
}
// **************************************************************************
// ToStringGenerator
// **************************************************************************
extension _$_StateToString on _State {
String _$toString() {
// ignore: unnecessary_string_interpolations
return "_State {lastSuccessful: $lastSuccessful, error: $error, message: $message}";
}
}
extension _$_VacuumDbToString on _VacuumDb {
String _$toString() {
// ignore: unnecessary_string_interpolations
return "_VacuumDb {}";
}
}
extension _$_ExportDbToString on _ExportDb {
String _$toString() {
// ignore: unnecessary_string_interpolations
return "_ExportDb {}";
}
}
extension _$_ClearCertWhitelistToString on _ClearCertWhitelist {
String _$toString() {
// ignore: unnecessary_string_interpolations
return "_ClearCertWhitelist {}";
}
}
extension _$_SetErrorToString on _SetError {
String _$toString() {
// ignore: unnecessary_string_interpolations
return "_SetError {error: $error, stackTrace: $stackTrace}";
}
}