lemmur-app-android/lib/stores/config_store.dart

import 'dart:convert';

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:json_annotation/json_annotation.dart';
import 'package:lemmy_api_client/v3.dart';
import 'package:shared_preferences/shared_preferences.dart';

import '../l10n/l10n.dart';

part 'config_store.g.dart';

/// Store managing user-level configuration such as theme or language
@JsonSerializable()
class ConfigStore extends ChangeNotifier {
  static const prefsKey = 'v1:ConfigStore';
  static final _prefs = SharedPreferences.getInstance();

  late ThemeMode _theme;
  @JsonKey(defaultValue: ThemeMode.system)
  ThemeMode get theme => _theme;
  set theme(ThemeMode theme) {
    _theme = theme;
    notifyListeners();
    save();
  }

  late bool _amoledDarkMode;
  @JsonKey(defaultValue: false)
  bool get amoledDarkMode => _amoledDarkMode;
  set amoledDarkMode(bool amoledDarkMode) {
    _amoledDarkMode = amoledDarkMode;
    notifyListeners();
    save();
  }

  late Locale _locale;
  // default value is set in the `LocaleSerde.fromJson` method because json_serializable does
  // not accept non-literals as defaultValue
  @JsonKey(fromJson: LocaleSerde.fromJson, toJson: LocaleSerde.toJson)
  Locale get locale => _locale;
  set locale(Locale locale) {
    _locale = locale;
    notifyListeners();
    save();
  }

  late bool _showAvatars;
  @JsonKey(defaultValue: true)
  bool get showAvatars => _showAvatars;
  set showAvatars(bool showAvatars) {
    _showAvatars = showAvatars;
    notifyListeners();
    save();
  }

  late bool _showScores;
  @JsonKey(defaultValue: true)
  bool get showScores => _showScores;
  set showScores(bool showScores) {
    _showScores = showScores;
    notifyListeners();
    save();
  }

  late SortType _defaultSortType;
  // default is set in fromJson
  @JsonKey(fromJson: _sortTypeFromJson)
  SortType get defaultSortType => _defaultSortType;
  set defaultSortType(SortType defaultSortType) {
    _defaultSortType = defaultSortType;
    notifyListeners();
    save();
  }

  late PostListingType _defaultListingType;
  // default is set in fromJson
  @JsonKey(fromJson: _postListingTypeFromJson)
  PostListingType get defaultListingType => _defaultListingType;
  set defaultListingType(PostListingType defaultListingType) {
    _defaultListingType = defaultListingType;
    notifyListeners();
    save();
  }

  /// Copies over settings from lemmy to [ConfigStore]
  void copyLemmyUserSettings(LocalUserSettings localUserSettings) {
    // themes from lemmy-ui that are dark mode
    const darkModeLemmyUiThemes = {
      'solar',
      'cyborg',
      'darkly',
      'vaporwave-dark',
      'i386',
    };

    _showAvatars = localUserSettings.showAvatars;
    _theme = darkModeLemmyUiThemes.contains(localUserSettings.theme)
        ? ThemeMode.dark
        : ThemeMode.light;
    _locale = L10n.supportedLocales.contains(Locale(localUserSettings.lang))
        ? Locale(localUserSettings.lang)
        : _locale;
    // TODO: add when it is released
    // _showScores = localUserSettings.showScores;
    _defaultSortType = localUserSettings.defaultSortType;
    _defaultListingType = localUserSettings.defaultListingType;

    notifyListeners();
    save();
  }

  /// Fetches [LocalUserSettings] and imports them with [.copyLemmyUserSettings]
  Future<void> importLemmyUserSettings(Jwt token) async {
    final site =
        await LemmyApiV3(token.payload.iss).run(GetSite(auth: token.raw));
    copyLemmyUserSettings(site.myUser!.localUser);
  }

  static Future<ConfigStore> load() async {
    final prefs = await _prefs;

    return _$ConfigStoreFromJson(
      jsonDecode(prefs.getString(prefsKey) ?? '{}') as Map<String, dynamic>,
    );
  }

  Future<void> save() async {
    final prefs = await _prefs;

    await prefs.setString(prefsKey, jsonEncode(_$ConfigStoreToJson(this)));
  }
}

SortType _sortTypeFromJson(String? json) =>
    json != null ? SortType.fromJson(json) : SortType.hot;
PostListingType _postListingTypeFromJson(String? json) =>
    json != null ? PostListingType.fromJson(json) : PostListingType.all;