🔀 Merge database system from spotube

lib/services/database/database.dart

@@ -0,0 +1,80 @@
+library database;
+
+import 'dart:convert';
+import 'dart:io';
+
+import 'package:drift/drift.dart';
+import 'package:encrypt/encrypt.dart';
+import 'package:path/path.dart';
+import 'package:path_provider/path_provider.dart';
+import 'package:rhythm_box/services/color.dart';
+import 'package:rhythm_box/services/lyrics.dart';
+import 'package:spotify/spotify.dart' hide Playlist;
+import 'package:rhythm_box/services/kv_store/encrypted_kv_store.dart';
+import 'package:rhythm_box/services/kv_store/kv_store.dart';
+import 'package:rhythm_box/services/sourced_track/enums.dart';
+import 'package:flutter/material.dart' hide Table, Key, View;
+import 'package:drift/native.dart';
+import 'package:sqlite3/sqlite3.dart';
+import 'package:sqlite3_flutter_libs/sqlite3_flutter_libs.dart';
+
+part 'database.g.dart';
+
+part 'tables/authentication.dart';
+part 'tables/blacklist.dart';
+part 'tables/preferences.dart';
+part 'tables/scrobbler.dart';
+part 'tables/skip_segment.dart';
+part 'tables/source_match.dart';
+part 'tables/history.dart';
+part 'tables/lyrics.dart';
+
+part 'typeconverters/color.dart';
+part 'typeconverters/locale.dart';
+part 'typeconverters/string_list.dart';
+part 'typeconverters/encrypted_text.dart';
+part 'typeconverters/map.dart';
+part 'typeconverters/subtitle.dart';
+
+@DriftDatabase(
+  tables: [
+    AuthenticationTable,
+    BlacklistTable,
+    PreferencesTable,
+    ScrobblerTable,
+    SkipSegmentTable,
+    SourceMatchTable,
+    HistoryTable,
+    LyricsTable,
+  ],
+)
+class AppDatabase extends _$AppDatabase {
+  AppDatabase() : super(_openConnection());
+
+  @override
+  int get schemaVersion => 1;
+}
+
+LazyDatabase _openConnection() {
+  // the LazyDatabase util lets us find the right location for the file async.
+  return LazyDatabase(() async {
+    // put the database file, called db.sqlite here, into the documents folder
+    // for your app.
+    final dbFolder = await getApplicationSupportDirectory();
+    final file = File(join(dbFolder.path, 'db.sqlite'));
+
+    // Also work around limitations on old Android versions
+    if (Platform.isAndroid) {
+      await applyWorkaroundToOpenSqlite3OnOldAndroidVersions();
+    }
+
+    // Make sqlite3 pick a more suitable location for temporary files - the
+    // one from the system may be inaccessible due to sandboxing.
+    final cacheBase = (await getTemporaryDirectory()).path;
+    // We can't access /tmp on Android, which sqlite3 would try by default.
+    // Explicitly tell it about the correct temporary directory.
+    sqlite3.tempDirectory = cacheBase;
+
+    return NativeDatabase.createInBackground(file);
+  });
+}

lib/services/database/tables/authentication.dart

@@ -0,0 +1,8 @@
+part of '../database.dart';
+
+class AuthenticationTable extends Table {
+  IntColumn get id => integer().autoIncrement()();
+  TextColumn get cookie => text().map(EncryptedTextConverter())();
+  TextColumn get accessToken => text().map(EncryptedTextConverter())();
+  DateTimeColumn get expiration => dateTime()();
+}

lib/services/database/tables/blacklist.dart

@@ -0,0 +1,18 @@
+part of '../database.dart';
+
+enum BlacklistedType {
+  artist,
+  track;
+}
+
+@TableIndex(
+  name: "unique_blacklist",
+  unique: true,
+  columns: {#elementType, #elementId},
+)
+class BlacklistTable extends Table {
+  IntColumn get id => integer().autoIncrement()();
+  TextColumn get name => text()();
+  TextColumn get elementType => textEnum<BlacklistedType>()();
+  TextColumn get elementId => text()();
+}

lib/services/database/tables/history.dart

@@ -0,0 +1,25 @@
+part of '../database.dart';
+
+enum HistoryEntryType {
+  playlist,
+  album,
+  track,
+}
+
+class HistoryTable extends Table {
+  IntColumn get id => integer().autoIncrement()();
+  DateTimeColumn get createdAt => dateTime().withDefault(currentDateAndTime)();
+  TextColumn get type => textEnum<HistoryEntryType>()();
+  TextColumn get itemId => text()();
+  TextColumn get data =>
+      text().map(const MapTypeConverter<String, dynamic>())();
+}
+
+extension HistoryItemParseExtension on HistoryTableData {
+  PlaylistSimple? get playlist =>
+      type == HistoryEntryType.playlist ? PlaylistSimple.fromJson(data) : null;
+  AlbumSimple? get album =>
+      type == HistoryEntryType.album ? AlbumSimple.fromJson(data) : null;
+  Track? get track =>
+      type == HistoryEntryType.track ? Track.fromJson(data) : null;
+}

lib/services/database/tables/lyrics.dart

@@ -0,0 +1,8 @@
+part of '../database.dart';
+
+class LyricsTable extends Table {
+  IntColumn get id => integer().autoIncrement()();
+
+  TextColumn get trackId => text()();
+  TextColumn get data => text().map(SubtitleTypeConverter())();
+}

lib/services/database/tables/preferences.dart

@@ -0,0 +1,125 @@
+part of '../database.dart';
+
+enum LayoutMode {
+  compact,
+  extended,
+  adaptive,
+}
+
+enum CloseBehavior {
+  minimizeToTray,
+  close,
+}
+
+enum AudioSource {
+  youtube,
+  piped,
+  jiosaavn;
+
+  String get label => name[0].toUpperCase() + name.substring(1);
+}
+
+enum MusicCodec {
+  m4a._('M4a (Best for downloaded music)'),
+  weba._("WebA (Best for streamed music)\nDoesn't support audio metadata");
+
+  final String label;
+  const MusicCodec._(this.label);
+}
+
+enum SearchMode {
+  youtube._('YouTube'),
+  youtubeMusic._('YouTube Music');
+
+  final String label;
+
+  const SearchMode._(this.label);
+
+  factory SearchMode.fromString(String key) {
+    return SearchMode.values.firstWhere((e) => e.name == key);
+  }
+}
+
+class PreferencesTable extends Table {
+  IntColumn get id => integer().autoIncrement()();
+  TextColumn get audioQuality => textEnum<SourceQualities>()
+      .withDefault(Constant(SourceQualities.high.name))();
+  BoolColumn get albumColorSync =>
+      boolean().withDefault(const Constant(true))();
+  BoolColumn get amoledDarkTheme =>
+      boolean().withDefault(const Constant(false))();
+  BoolColumn get checkUpdate => boolean().withDefault(const Constant(true))();
+  BoolColumn get normalizeAudio =>
+      boolean().withDefault(const Constant(false))();
+  BoolColumn get showSystemTrayIcon =>
+      boolean().withDefault(const Constant(false))();
+  BoolColumn get systemTitleBar =>
+      boolean().withDefault(const Constant(false))();
+  BoolColumn get skipNonMusic => boolean().withDefault(const Constant(false))();
+  TextColumn get closeBehavior => textEnum<CloseBehavior>()
+      .withDefault(Constant(CloseBehavior.close.name))();
+  TextColumn get accentColorScheme => text()
+      .withDefault(const Constant('Blue:0xFF2196F3'))
+      .map(const RhythmColorConverter())();
+  TextColumn get layoutMode =>
+      textEnum<LayoutMode>().withDefault(Constant(LayoutMode.adaptive.name))();
+  TextColumn get locale => text()
+      .withDefault(
+        const Constant('{"languageCode":"system","countryCode":"system"}'),
+      )
+      .map(const LocaleConverter())();
+  TextColumn get market =>
+      textEnum<Market>().withDefault(Constant(Market.US.name))();
+  TextColumn get searchMode =>
+      textEnum<SearchMode>().withDefault(Constant(SearchMode.youtube.name))();
+  TextColumn get downloadLocation => text().withDefault(const Constant(''))();
+  TextColumn get localLibraryLocation =>
+      text().withDefault(const Constant('')).map(const StringListConverter())();
+  TextColumn get pipedInstance =>
+      text().withDefault(const Constant('https://pipedapi.kavin.rocks'))();
+  TextColumn get themeMode =>
+      textEnum<ThemeMode>().withDefault(Constant(ThemeMode.system.name))();
+  TextColumn get audioSource =>
+      textEnum<AudioSource>().withDefault(Constant(AudioSource.youtube.name))();
+  TextColumn get streamMusicCodec =>
+      textEnum<SourceCodecs>().withDefault(Constant(SourceCodecs.weba.name))();
+  TextColumn get downloadMusicCodec =>
+      textEnum<SourceCodecs>().withDefault(Constant(SourceCodecs.m4a.name))();
+  BoolColumn get discordPresence =>
+      boolean().withDefault(const Constant(true))();
+  BoolColumn get endlessPlayback =>
+      boolean().withDefault(const Constant(true))();
+  BoolColumn get enableConnect =>
+      boolean().withDefault(const Constant(false))();
+
+  // Default values as PreferencesTableData
+  static PreferencesTableData defaults() {
+    return PreferencesTableData(
+      id: 0,
+      audioQuality: SourceQualities.high,
+      albumColorSync: true,
+      amoledDarkTheme: false,
+      checkUpdate: true,
+      normalizeAudio: false,
+      showSystemTrayIcon: false,
+      systemTitleBar: false,
+      skipNonMusic: false,
+      closeBehavior: CloseBehavior.close,
+      accentColorScheme: RhythmColor(Colors.blue.value, name: 'Blue'),
+      layoutMode: LayoutMode.adaptive,
+      locale: const Locale('system', 'system'),
+      market: Market.US,
+      searchMode: SearchMode.youtube,
+      downloadLocation: '',
+      localLibraryLocation: [],
+      pipedInstance: 'https://pipedapi.kavin.rocks',
+      themeMode: ThemeMode.system,
+      audioSource: AudioSource.youtube,
+      streamMusicCodec: SourceCodecs.weba,
+      downloadMusicCodec: SourceCodecs.m4a,
+      discordPresence: true,
+      endlessPlayback: true,
+      enableConnect: false,
+    );
+  }
+}

lib/services/database/tables/scrobbler.dart

@@ -0,0 +1,8 @@
+part of '../database.dart';
+
+class ScrobblerTable extends Table {
+  IntColumn get id => integer().autoIncrement()();
+  DateTimeColumn get createdAt => dateTime().withDefault(currentDateAndTime)();
+  TextColumn get username => text()();
+  TextColumn get passwordHash => text().map(EncryptedTextConverter())();
+}

lib/services/database/tables/skip_segment.dart

@@ -0,0 +1,9 @@
+part of '../database.dart';
+
+class SkipSegmentTable extends Table {
+  IntColumn get id => integer().autoIncrement()();
+  IntColumn get start => integer()();
+  IntColumn get end => integer()();
+  TextColumn get trackId => text()();
+  DateTimeColumn get createdAt => dateTime().withDefault(currentDateAndTime)();
+}

lib/services/database/tables/source_match.dart

@@ -0,0 +1,25 @@
+part of '../database.dart';
+
+enum SourceType {
+  youtube._("YouTube"),
+  youtubeMusic._("YouTube Music"),
+  jiosaavn._("JioSaavn");
+
+  final String label;
+
+  const SourceType._(this.label);
+}
+
+@TableIndex(
+  name: "uniq_track_match",
+  columns: {#trackId, #sourceId, #sourceType},
+  unique: true,
+)
+class SourceMatchTable extends Table {
+  IntColumn get id => integer().autoIncrement()();
+  TextColumn get trackId => text()();
+  TextColumn get sourceId => text()();
+  TextColumn get sourceType =>
+      textEnum<SourceType>().withDefault(Constant(SourceType.youtube.name))();
+  DateTimeColumn get createdAt => dateTime().withDefault(currentDateAndTime)();
+}

lib/services/database/typeconverters/color.dart

@@ -0,0 +1,29 @@
+part of '../database.dart';
+
+class ColorConverter extends TypeConverter<Color, int> {
+  const ColorConverter();
+
+  @override
+  Color fromSql(int fromDb) {
+    return Color(fromDb);
+  }
+
+  @override
+  int toSql(Color value) {
+    return value.value;
+  }
+}
+
+class RhythmColorConverter extends TypeConverter<RhythmColor, String> {
+  const RhythmColorConverter();
+
+  @override
+  RhythmColor fromSql(String fromDb) {
+    return RhythmColor.fromString(fromDb);
+  }
+
+  @override
+  String toSql(RhythmColor value) {
+    return value.toString();
+  }
+}

lib/services/database/typeconverters/encrypted_text.dart

@@ -0,0 +1,44 @@
+part of '../database.dart';
+
+class DecryptedText {
+  final String value;
+  const DecryptedText(this.value);
+
+  static Encrypter? _encrypter;
+
+  factory DecryptedText.decrypted(String value) {
+    _encrypter ??= Encrypter(
+      Salsa20(
+        Key.fromUtf8(EncryptedKvStoreService.encryptionKeySync),
+      ),
+    );
+
+    return DecryptedText(
+      _encrypter!.decrypt(
+        Encrypted.fromBase64(value),
+        iv: KVStoreService.ivKey,
+      ),
+    );
+  }
+
+  String encrypt() {
+    _encrypter ??= Encrypter(
+      Salsa20(
+        Key.fromUtf8(EncryptedKvStoreService.encryptionKeySync),
+      ),
+    );
+    return _encrypter!.encrypt(value, iv: KVStoreService.ivKey).base64;
+  }
+}
+
+class EncryptedTextConverter extends TypeConverter<DecryptedText, String> {
+  @override
+  DecryptedText fromSql(String fromDb) {
+    return DecryptedText.decrypted(fromDb);
+  }
+
+  @override
+  String toSql(DecryptedText value) {
+    return value.encrypt();
+  }
+}

lib/services/database/typeconverters/locale.dart

@@ -0,0 +1,19 @@
+part of '../database.dart';
+
+class LocaleConverter extends TypeConverter<Locale, String> {
+  const LocaleConverter();
+
+  @override
+  Locale fromSql(String fromDb) {
+    final rawMap = jsonDecode(fromDb) as Map<String, dynamic>;
+    return Locale(rawMap["languageCode"], rawMap["countryCode"]);
+  }
+
+  @override
+  String toSql(Locale value) {
+    return jsonEncode({
+      "languageCode": value.languageCode,
+      "countryCode": value.countryCode,
+    });
+  }
+}

lib/services/database/typeconverters/map.dart

@@ -0,0 +1,15 @@
+part of '../database.dart';
+
+class MapTypeConverter<K, V> extends TypeConverter<Map<K, V>, String> {
+  const MapTypeConverter();
+
+  @override
+  fromSql(String fromDb) {
+    return json.decode(fromDb) as Map<K, V>;
+  }
+
+  @override
+  toSql(value) {
+    return json.encode(value);
+  }
+}

lib/services/database/typeconverters/string_list.dart

@@ -0,0 +1,15 @@
+part of '../database.dart';
+
+class StringListConverter extends TypeConverter<List<String>, String> {
+  const StringListConverter();
+
+  @override
+  List<String> fromSql(String fromDb) {
+    return fromDb.split(",").where((e) => e.isNotEmpty).toList();
+  }
+
+  @override
+  String toSql(List<String> value) {
+    return value.join(",");
+  }
+}

lib/services/database/typeconverters/subtitle.dart

@@ -0,0 +1,13 @@
+part of '../database.dart';
+
+class SubtitleTypeConverter extends TypeConverter<SubtitleSimple, String> {
+  @override
+  SubtitleSimple fromSql(String fromDb) {
+    return SubtitleSimple.fromJson(jsonDecode(fromDb));
+  }
+
+  @override
+  String toSql(SubtitleSimple value) {
+    return jsonEncode(value.toJson());
+  }
+}