spotube/lib/provider/user_preferences_provider.dart

import 'dart:async';
import 'dart:convert';

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter_desktop_tools/flutter_desktop_tools.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:path_provider/path_provider.dart';
import 'package:spotify/spotify.dart';
import 'package:spotube/components/settings/color_scheme_picker_dialog.dart';
import 'package:spotube/models/matched_track.dart';
import 'package:spotube/provider/palette_provider.dart';
import 'package:spotube/provider/proxy_playlist/proxy_playlist_provider.dart';
import 'package:spotube/services/audio_player/audio_player.dart';

import 'package:spotube/utils/persisted_change_notifier.dart';
import 'package:spotube/utils/platform.dart';
import 'package:path/path.dart' as path;

enum LayoutMode {
  compact,
  extended,
  adaptive,
}

enum AudioQuality {
  high,
  low,
}

enum CloseBehavior {
  minimizeToTray,
  close,
}

enum YoutubeApiType {
  youtube,
  piped;

  String get label => name[0].toUpperCase() + name.substring(1);
}

class UserPreferences extends PersistedChangeNotifier {
  ThemeMode themeMode;
  Market recommendationMarket;
  bool saveTrackLyrics;
  bool checkUpdate;
  AudioQuality audioQuality;

  SpotubeColor accentColorScheme;
  bool albumColorSync;

  String downloadLocation;

  LayoutMode layoutMode;

  CloseBehavior closeBehavior;

  bool showSystemTrayIcon;

  Locale locale;

  String pipedInstance;

  SearchMode searchMode;

  bool skipNonMusic;

  YoutubeApiType youtubeApiType;

  bool systemTitleBar;

  bool amoledDarkTheme;

  bool normalizeAudio;

  final Ref ref;

  UserPreferences(
    this.ref, {
    required this.recommendationMarket,
    required this.themeMode,
    required this.layoutMode,
    required this.accentColorScheme,
    this.albumColorSync = true,
    this.saveTrackLyrics = false,
    this.checkUpdate = true,
    this.audioQuality = AudioQuality.high,
    this.downloadLocation = "",
    this.closeBehavior = CloseBehavior.close,
    this.showSystemTrayIcon = true,
    this.locale = const Locale("system", "system"),
    this.pipedInstance = "https://pipedapi.kavin.rocks",
    this.searchMode = SearchMode.youtube,
    this.skipNonMusic = true,
    this.youtubeApiType = YoutubeApiType.youtube,
    this.systemTitleBar = false,
    this.amoledDarkTheme = false,
    this.normalizeAudio = true,
  }) : super() {
    if (downloadLocation.isEmpty && !kIsWeb) {
      _getDefaultDownloadDirectory().then(
        (value) {
          downloadLocation = value;
        },
      );
    }
  }

  void setThemeMode(ThemeMode mode) {
    themeMode = mode;
    notifyListeners();
    updatePersistence();
  }

  void setSaveTrackLyrics(bool shouldSave) {
    saveTrackLyrics = shouldSave;
    notifyListeners();
    updatePersistence();
  }

  void setRecommendationMarket(Market country) {
    recommendationMarket = country;
    notifyListeners();
    updatePersistence();
  }

  void setAccentColorScheme(SpotubeColor color) {
    accentColorScheme = color;
    notifyListeners();
    updatePersistence();
  }

  void setAlbumColorSync(bool sync) {
    albumColorSync = sync;
    if (!sync) {
      ref.read(paletteProvider.notifier).state = null;
    } else {
      ref.read(ProxyPlaylistNotifier.notifier).updatePalette();
    }
    notifyListeners();
    updatePersistence();
  }

  void setCheckUpdate(bool check) {
    checkUpdate = check;
    notifyListeners();
    updatePersistence();
  }

  void setAudioQuality(AudioQuality quality) {
    audioQuality = quality;
    notifyListeners();
    updatePersistence();
  }

  void setDownloadLocation(String downloadDir) {
    if (downloadDir.isEmpty) return;
    downloadLocation = downloadDir;
    notifyListeners();
    updatePersistence();
  }

  void setLayoutMode(LayoutMode mode) {
    layoutMode = mode;
    notifyListeners();
    updatePersistence();
  }

  void setCloseBehavior(CloseBehavior behavior) {
    closeBehavior = behavior;
    notifyListeners();
    updatePersistence();
  }

  void setShowSystemTrayIcon(bool show) {
    showSystemTrayIcon = show;
    notifyListeners();
    updatePersistence();
  }

  void setLocale(Locale locale) {
    this.locale = locale;
    notifyListeners();
    updatePersistence();
  }

  void setPipedInstance(String instance) {
    pipedInstance = instance;
    notifyListeners();
    updatePersistence();
  }

  void setSearchMode(SearchMode mode) {
    searchMode = mode;
    notifyListeners();
    updatePersistence();
  }

  void setSkipNonMusic(bool skip) {
    skipNonMusic = skip;
    notifyListeners();
    updatePersistence();
  }

  void setYoutubeApiType(YoutubeApiType type) {
    youtubeApiType = type;
    notifyListeners();
    updatePersistence();
  }

  void setSystemTitleBar(bool isSystemTitleBar) {
    systemTitleBar = isSystemTitleBar;
    DesktopTools.window.setTitleBarStyle(
      systemTitleBar ? TitleBarStyle.normal : TitleBarStyle.hidden,
    );
    notifyListeners();
    updatePersistence();
  }

  void setAmoledDarkTheme(bool isAmoled) {
    amoledDarkTheme = isAmoled;
    notifyListeners();
    updatePersistence();
  }

  void setNormalizeAudio(bool normalize) {
    normalizeAudio = normalize;
    audioPlayer.setAudioNormalization(normalize);
    notifyListeners();
    updatePersistence();
  }

  Future<String> _getDefaultDownloadDirectory() async {
    if (kIsAndroid) return "/storage/emulated/0/Download/Spotube";

    if (kIsMacOS) {
      return path.join((await getLibraryDirectory()).path, "Caches");
    }

    return getDownloadsDirectory().then((dir) {
      return path.join(dir!.path, "Spotube");
    });
  }

  @override
  FutureOr<void> loadFromLocal(Map<String, dynamic> map) async {
    saveTrackLyrics = map["saveTrackLyrics"] ?? false;
    recommendationMarket = Market.values.firstWhere(
      (market) =>
          market.name == (map["recommendationMarket"] ?? recommendationMarket),
    );
    checkUpdate = map["checkUpdate"] ?? checkUpdate;

    themeMode = ThemeMode.values[map["themeMode"] ?? 0];
    accentColorScheme = map["accentColorScheme"] != null
        ? SpotubeColor.fromString(map["accentColorScheme"])
        : accentColorScheme;
    albumColorSync = map["albumColorSync"] ?? albumColorSync;
    audioQuality = map["audioQuality"] != null
        ? AudioQuality.values[map["audioQuality"]]
        : audioQuality;

    if (!kIsWeb) {
      downloadLocation =
          map["downloadLocation"] ?? await _getDefaultDownloadDirectory();
    }

    layoutMode = LayoutMode.values.firstWhere(
      (mode) => mode.name == map["layoutMode"],
      orElse: () => kIsDesktop ? LayoutMode.extended : LayoutMode.compact,
    );

    closeBehavior = map["closeBehavior"] != null
        ? CloseBehavior.values[map["closeBehavior"]]
        : closeBehavior;

    showSystemTrayIcon = map["showSystemTrayIcon"] ?? showSystemTrayIcon;

    final localeMap = map["locale"] != null ? jsonDecode(map["locale"]) : null;
    locale =
        localeMap != null ? Locale(localeMap?["lc"], localeMap?["cc"]) : locale;

    pipedInstance = map["pipedInstance"] ?? pipedInstance;

    searchMode = SearchMode.values.firstWhere(
      (mode) => mode.name == map["searchMode"],
      orElse: () => SearchMode.youtube,
    );

    skipNonMusic = map["skipNonMusic"] ?? skipNonMusic;

    youtubeApiType = YoutubeApiType.values.firstWhere(
      (type) => type.name == map["youtubeApiType"],
      orElse: () => YoutubeApiType.youtube,
    );

    systemTitleBar = map["systemTitleBar"] ?? systemTitleBar;
    // updates the title bar
    setSystemTitleBar(systemTitleBar);

    amoledDarkTheme = map["amoledDarkTheme"] ?? amoledDarkTheme;

    normalizeAudio = map["normalizeAudio"] ?? normalizeAudio;
    audioPlayer.setAudioNormalization(normalizeAudio);
  }

  @override
  FutureOr<Map<String, dynamic>> toMap() {
    return {
      "saveTrackLyrics": saveTrackLyrics,
      "recommendationMarket": recommendationMarket.name,
      "themeMode": themeMode.index,
      "accentColorScheme": accentColorScheme.toString(),
      "albumColorSync": albumColorSync,
      "checkUpdate": checkUpdate,
      "audioQuality": audioQuality.index,
      "downloadLocation": downloadLocation,
      "layoutMode": layoutMode.name,
      "closeBehavior": closeBehavior.index,
      "showSystemTrayIcon": showSystemTrayIcon,
      "locale":
          jsonEncode({"lc": locale.languageCode, "cc": locale.countryCode}),
      "pipedInstance": pipedInstance,
      "searchMode": searchMode.name,
      "skipNonMusic": skipNonMusic,
      "youtubeApiType": youtubeApiType.name,
      'systemTitleBar': systemTitleBar,
      "amoledDarkTheme": amoledDarkTheme,
      "normalizeAudio": normalizeAudio,
    };
  }

  UserPreferences copyWith({
    ThemeMode? themeMode,
    SpotubeColor? accentColorScheme,
    bool? albumColorSync,
    bool? checkUpdate,
    AudioQuality? audioQuality,
    String? downloadLocation,
    LayoutMode? layoutMode,
    CloseBehavior? closeBehavior,
    bool? showSystemTrayIcon,
    Locale? locale,
    String? pipedInstance,
    SearchMode? searchMode,
    bool? skipNonMusic,
    YoutubeApiType? youtubeApiType,
    Market? recommendationMarket,
    bool? saveTrackLyrics,
  }) {
    return UserPreferences(
      ref,
      themeMode: themeMode ?? this.themeMode,
      accentColorScheme: accentColorScheme ?? this.accentColorScheme,
      albumColorSync: albumColorSync ?? this.albumColorSync,
      checkUpdate: checkUpdate ?? this.checkUpdate,
      audioQuality: audioQuality ?? this.audioQuality,
      downloadLocation: downloadLocation ?? this.downloadLocation,
      layoutMode: layoutMode ?? this.layoutMode,
      closeBehavior: closeBehavior ?? this.closeBehavior,
      showSystemTrayIcon: showSystemTrayIcon ?? this.showSystemTrayIcon,
      locale: locale ?? this.locale,
      pipedInstance: pipedInstance ?? this.pipedInstance,
      searchMode: searchMode ?? this.searchMode,
      skipNonMusic: skipNonMusic ?? this.skipNonMusic,
      youtubeApiType: youtubeApiType ?? this.youtubeApiType,
      recommendationMarket: recommendationMarket ?? this.recommendationMarket,
      saveTrackLyrics: saveTrackLyrics ?? this.saveTrackLyrics,
    );
  }
}

final userPreferencesProvider = ChangeNotifierProvider(
  (ref) => UserPreferences(
    ref,
    accentColorScheme: SpotubeColor(Colors.blue.value, name: "Blue"),
    recommendationMarket: Market.US,
    themeMode: ThemeMode.system,
    layoutMode: LayoutMode.adaptive,
  ),
);