customize quick tab switcher buttons

2026-07-06 17:48:58 +02:00
parent 10052ed3a3
commit 1b1c33dee5
30 changed files with 4763 additions and 133 deletions
@@ -0,0 +1,175 @@
+/*
+ * Copyright (c) 2024-2026 Fabian Freund.
+ *
+ * This file is part of WebLibre
+ * (see https://weblibre.eu).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+import 'package:drift/drift.dart';
+import 'package:weblibre/features/user/data/database/daos/quick_switcher_button_config.drift.dart';
+import 'package:weblibre/features/user/data/database/database.dart';
+import 'package:weblibre/features/user/data/database/definitions.drift.dart';
+
+/// Mirror of [ToolbarButtonConfigDao] against the separate
+/// `quick_switcher_button_configs` table. See that DAO for the rationale behind
+/// each visibility-partitioned order-key operation.
+@DriftAccessor()
+class QuickSwitcherButtonConfigDao extends DatabaseAccessor<UserDatabase>
+    with $QuickSwitcherButtonConfigDaoMixin {
+  QuickSwitcherButtonConfigDao(super.attachedDatabase);
+
+  Selectable<QuickSwitcherButtonConfig> selectAll() =>
+      db.quickSwitcherButtonConfigs.select()
+        ..orderBy([(t) => OrderingTerm.asc(t.orderKey)]);
+
+  Stream<List<QuickSwitcherButtonConfig>> watchAll() => selectAll().watch();
+
+  Future<List<QuickSwitcherButtonConfig>> getAll() => selectAll().get();
+
+  Future<void> upsert(QuickSwitcherButtonConfig config) =>
+      into(db.quickSwitcherButtonConfigs).insertOnConflictUpdate(config);
+
+  Future<void> assignOrderKey(String buttonId, {required String orderKey}) =>
+      (update(
+        db.quickSwitcherButtonConfigs,
+      )..where((t) => t.buttonId.equals(buttonId))).write(
+        QuickSwitcherButtonConfigsCompanion(orderKey: Value(orderKey)),
+      );
+
+  Future<void> assignVisibility(String buttonId, {required bool visible}) =>
+      transaction(() async {
+        // Land the toggled button at the trailing edge of its *new* section so
+        // its order_key always stays inside the visibility partition.
+        final orderKey = await generateTrailingOrderKey(
+          isVisible: visible,
+        ).getSingle();
+
+        await (update(
+          db.quickSwitcherButtonConfigs,
+        )..where((t) => t.buttonId.equals(buttonId))).write(
+          QuickSwitcherButtonConfigsCompanion(
+            isVisible: Value(visible),
+            orderKey: Value(orderKey),
+          ),
+        );
+      });
+
+  Future<void> assignFallback(String buttonId, String? fallbackId) =>
+      (update(
+        db.quickSwitcherButtonConfigs,
+      )..where((t) => t.buttonId.equals(buttonId))).write(
+        QuickSwitcherButtonConfigsCompanion(fallbackId: Value(fallbackId)),
+      );
+
+  Future<void> replaceAll(List<QuickSwitcherButtonConfig> configs) =>
+      transaction(() async {
+        await delete(db.quickSwitcherButtonConfigs).go();
+        await _insertWithDeferredFallbacks(configs);
+      });
+
+  Future<void> seedMissing(
+    List<({String buttonId, bool defaultVisible, String? defaultFallback})>
+    defaults,
+  ) async {
+    final existing = await getAll();
+    final existingIds = {for (final r in existing) r.buttonId};
+
+    final missing = defaults
+        .where((d) => !existingIds.contains(d.buttonId))
+        .toList();
+    if (missing.isEmpty) return;
+
+    await transaction(() async {
+      final inserted = <QuickSwitcherButtonConfig>[];
+      for (final def in missing) {
+        final orderKey = await generateTrailingOrderKey(
+          isVisible: def.defaultVisible,
+        ).getSingle();
+        inserted.add(
+          QuickSwitcherButtonConfig(
+            buttonId: def.buttonId,
+            orderKey: orderKey,
+            isVisible: def.defaultVisible,
+            fallbackId: def.defaultFallback,
+          ),
+        );
+        await into(db.quickSwitcherButtonConfigs).insert(
+          QuickSwitcherButtonConfig(
+            buttonId: def.buttonId,
+            orderKey: orderKey,
+            isVisible: def.defaultVisible,
+          ),
+        );
+      }
+
+      await _assignFallbacks(inserted);
+    });
+  }
+
+  SingleSelectable<String> generateLeadingOrderKey({
+    int bucket = 0,
+    required bool isVisible,
+  }) => db.definitionsDrift.quickSwitcherLeadingOrderKey(
+    bucket: bucket,
+    isVisible: isVisible,
+  );
+
+  SingleSelectable<String> generateTrailingOrderKey({
+    int bucket = 0,
+    required bool isVisible,
+  }) => db.definitionsDrift.quickSwitcherTrailingOrderKey(
+    bucket: bucket,
+    isVisible: isVisible,
+  );
+
+  SingleOrNullSelectable<String> generateOrderKeyAfterButtonId(
+    String buttonId, {
+    required bool isVisible,
+  }) => db.definitionsDrift.quickSwitcherOrderKeyAfterButton(
+    buttonId: buttonId,
+    isVisible: isVisible,
+  );
+
+  SingleSelectable<String> generateOrderKeyBeforeButtonId(
+    String buttonId, {
+    required bool isVisible,
+  }) => db.definitionsDrift.quickSwitcherOrderKeyBeforeButton(
+    buttonId: buttonId,
+    isVisible: isVisible,
+  );
+
+  Future<void> _insertWithDeferredFallbacks(
+    List<QuickSwitcherButtonConfig> configs,
+  ) async {
+    for (final config in configs) {
+      await into(db.quickSwitcherButtonConfigs).insert(
+        QuickSwitcherButtonConfig(
+          buttonId: config.buttonId,
+          orderKey: config.orderKey,
+          isVisible: config.isVisible,
+        ),
+      );
+    }
+
+    await _assignFallbacks(configs);
+  }
+
+  Future<void> _assignFallbacks(List<QuickSwitcherButtonConfig> configs) async {
+    for (final config in configs) {
+      if (config.fallbackId == null) continue;
+      await assignFallback(config.buttonId, config.fallbackId);
+    }
+  }
+}
@@ -0,0 +1,15 @@
+// dart format width=80
+// ignore_for_file: type=lint
+import 'package:drift/drift.dart' as i0;
+import 'package:weblibre/features/user/data/database/database.dart' as i1;
+
+mixin $QuickSwitcherButtonConfigDaoMixin
+    on i0.DatabaseAccessor<i1.UserDatabase> {
+  QuickSwitcherButtonConfigDaoManager get managers =>
+      QuickSwitcherButtonConfigDaoManager(this);
+}
+
+class QuickSwitcherButtonConfigDaoManager {
+  final $QuickSwitcherButtonConfigDaoMixin _db;
+  QuickSwitcherButtonConfigDaoManager(this._db);
+}