Merge pull request #37 from OctagonalStar/refactor/setting-structure

Refactor/setting-structure

Author: OctagonalStar

CHANGELOG.md

@@ -11,6 +11,8 @@
 ### Improvement
 
 - 优化了网页端字体加载逻辑
+- 重构了Config数据结构 [#27](https://github.com/OctagonalStar/arabic_learning/issues/27)
+- 重构了软件运行时数据结构 [#16](https://github.com/OctagonalStar/arabic_learning/issues/16)
 
 ### Fix
 

lib/funcs/fsrs_func.dart

@@ -1,101 +1,69 @@
 import 'dart:convert';
 
-import 'package:arabic_learning/funcs/utili.dart';
+import 'package:flutter/foundation.dart';
 import 'package:fsrs/fsrs.dart';
 import 'package:logging/logging.dart';
 
 import 'package:arabic_learning/package_replacement/storage.dart';
 
 class FSRS { 
-  List<Card> cards = [];
-  List<ReviewLog> reviewLogs = [];
-  late Scheduler scheduler;
   late final SharedPreferences prefs;
-  late Map<String, dynamic> settingData;
+  late FSRSConfig config;
   late final Logger logger;
   // index != cardId; cardId = wordId = the index of word in global.wordData[words]
 
   bool init({required SharedPreferences outerPrefs}) {
     prefs = outerPrefs;
     logger = Logger('FSRS');
     logger.fine("构建FSRS模块");
-    settingData = {
-      'enabled': false,
-      'scheduler': {},
-      'cards': [],
-      'reviewLog': [],
-      'rater': {
-        "desiredRetention": 0.9,
-        "easyDuration": 3000,
-        "goodDuration": 6000
-      },
-    };
 
     if(!prefs.containsKey("fsrsData")) {
       logger.info("未发现FSRS配置，加载默认配置");
-      prefs.setString("fsrsData", jsonEncode(settingData));
+      config = FSRSConfig();
+      prefs.setString("fsrsData", jsonEncode(config));
       return false;
     } else {
-      settingData = deepMerge(settingData, jsonDecode(prefs.getString("fsrsData")!));
-    }
-    
-    if(isEnabled()){
-      scheduler = Scheduler.fromMap(settingData['scheduler']);
-      for(int i = 0; i < settingData['cards'].length; i++) {
-        cards.add(Card.fromMap(settingData['cards'][i]));
-        reviewLogs.add(ReviewLog.fromMap(settingData['reviewLog'][i]));
-      }
+      config = FSRSConfig.buildFromMap(jsonDecode(prefs.getString("fsrsData")!));
       logger.info("FSRS配置加载完成");
-      return true;
     }
+    
+    if(config.enabled) return true;
     logger.info("FSRS未启用");
     return false;
   }
 
   void save() async {
     logger.info("正在保存FSRS配置");
-    settingData['scheduler'] = scheduler.toMap();
-    List cardsCache = [];
-    List logCache = [];
-    for(int i = 0; i < cards.length; i++) {
-      cardsCache.add(cards[i].toMap());
-      logCache.add(reviewLogs[i].toMap());
-    }
-    settingData['cards'] = cardsCache;
-    settingData['reviewLog'] = logCache;
-    prefs.setString("fsrsData", jsonEncode(settingData));
-  }
-
-  bool isEnabled() {
-    return settingData['enabled'];
+    prefs.setString("fsrsData", jsonEncode(config.toMap()));
   }
 
   void createScheduler({required SharedPreferences prefs}) {
-    logger.info("初始化scheduler，选择相关配置 ${settingData["rater"].toString()}");
-    scheduler = Scheduler(desiredRetention: settingData["rater"]["desiredRetention"]);
-    settingData['enabled'] = true;
-    settingData['scheduler'] = scheduler.toMap();
+    logger.info("初始化scheduler，选择相关配置 ${config.toMap().toString()}");
+    config = config.copyWith(
+      enabled: true,
+      scheduler: Scheduler(desiredRetention: config.desiredRetention)
+    );
     save();
   }
 
   int willDueIn(int index) {
-    return cards[index].due.toLocal().difference(DateTime.now()).inDays;
+    return config.cards[index].due.toLocal().difference(DateTime.now()).inDays;
   }
 
   void reviewCard(int wordId, int duration, bool isCorrect) {
     logger.fine("记录复习卡片: Id: $wordId; duration: $duration; isCorrect: $isCorrect");
-    int index = cards.indexWhere((Card card) => card.cardId == wordId); // 避免有时候cardId != wordId
-    logger.fine("定位复习卡片地址: $index, 目前阶段: ${cards[index].step}, 难度: ${cards[index].difficulty}, 稳定: ${cards[index].stability}, 过期时间(+8): ${cards[index].due.toLocal()}");
-    final (:card, :reviewLog) = scheduler.reviewCard(cards[index], calculate(duration, isCorrect), reviewDateTime: DateTime.now().toUtc(), reviewDuration: duration);
-    cards[index] = card;
-    reviewLogs[index] = reviewLog;
-    logger.fine("卡片 $index 复习后: 目前阶段: ${cards[index].step}, 难度: ${cards[index].difficulty}, 稳定: ${cards[index].stability}, 过期时间(+8): ${cards[index].due.toLocal()}");
+    int index = config.cards.indexWhere((Card card) => card.cardId == wordId); // 避免有时候cardId != wordId
+    logger.fine("定位复习卡片地址: $index, 目前阶段: ${config.cards[index].step}, 难度: ${config.cards[index].difficulty}, 稳定: ${config.cards[index].stability}, 过期时间(+8): ${config.cards[index].due.toLocal()}");
+    final (:card, :reviewLog) = config.scheduler!.reviewCard(config.cards[index], calculate(duration, isCorrect), reviewDateTime: DateTime.now().toUtc(), reviewDuration: duration);
+    config.cards[index] = card;
+    config.reviewLogs[index] = reviewLog;
+    logger.fine("卡片 $index 复习后: 目前阶段: ${config.cards[index].step}, 难度: ${config.cards[index].difficulty}, 稳定: ${config.cards[index].stability}, 过期时间(+8): ${config.cards[index].due.toLocal()}");
     save();
   }
 
   int getWillDueCount() {
     int dueCards = 0;
-    for(int i = 0; i < cards.length; i++) {
+    for(int i = 0; i < config.cards.length; i++) {
       if(willDueIn(i) < 1) {
         dueCards++;
       }
@@ -105,26 +73,26 @@ class FSRS {
 
   int getLeastDueCard() {
     int leastDueIndex = 0;
-    for(int i = 1; i < cards.length; i++) {
-      if(cards[i].due.toLocal().isBefore(cards[leastDueIndex].due.toLocal()) && cards[i].due.toLocal().difference(DateTime.now()) < Duration(days: 1)) {
+    for(int i = 1; i < config.cards.length; i++) {
+      if(config.cards[i].due.toLocal().isBefore(config.cards[leastDueIndex].due.toLocal()) && config.cards[i].due.toLocal().difference(DateTime.now()) < Duration(days: 1)) {
         leastDueIndex = i;
       }
     }
-    if(cards[leastDueIndex].due.difference(DateTime.now()) > Duration(days: 1)) return -1;
-    return cards[leastDueIndex].cardId;
+    if(config.cards[leastDueIndex].due.difference(DateTime.now()) > Duration(days: 1)) return -1;
+    return config.cards[leastDueIndex].cardId;
   }
 
   bool isContained(int wordId) {
-    for(Card card in cards) {
+    for(Card card in config.cards) {
       if(card.cardId == wordId) return true;
     }
     return false;
   }
 
   void addWordCard(int wordId) {
     // os the wordID == cardID
-    cards.add(Card(cardId: wordId, state: State.learning));
-    reviewLogs.add(ReviewLog(cardId: wordId, rating: Rating.good, reviewDateTime: DateTime.now()));
+    config.cards.add(Card(cardId: wordId, state: State.learning));
+    config.reviewLogs.add(ReviewLog(cardId: wordId, rating: Rating.good, reviewDateTime: DateTime.now()));
     save();
   }
 
@@ -134,15 +102,89 @@ class FSRS {
       logger.fine("计算得分: again");
       return Rating.again;
     }
-    if (duration < settingData['rater']['easyDuration']) {
+    if (duration < config.easyDuration) {
       logger.fine("计算得分: easy");
       return Rating.easy;
     }
-    if (duration < settingData['rater']['goodDuration']) {
+    if (duration < config.goodDuration) {
       logger.fine("计算得分: good");
       return Rating.good;
     }
     logger.fine("计算得分: hard");
     return Rating.hard;
   }
+}
+
+@immutable
+class FSRSConfig {
+  final bool enabled;
+  final Scheduler? scheduler;
+  final List<Card> cards;
+  final List<ReviewLog> reviewLogs;
+  final double desiredRetention;
+  final int easyDuration;
+  final int goodDuration;
+
+  const FSRSConfig({
+    bool? enabled,
+    this.scheduler,
+    List<Card>? cards,
+    List<ReviewLog>? reviewLogs,
+    double? desiredRetention,
+    int? easyDuration,
+    int? goodDuration
+  }) :
+    enabled = enabled??false,
+    cards = cards??const [],
+    reviewLogs = reviewLogs??const [],
+    desiredRetention = desiredRetention??0.9,
+    easyDuration = easyDuration??3000,
+    goodDuration = goodDuration??6000;
+  
+  Map<String, dynamic> toMap(){
+    return {
+      'enabled': enabled,
+      'scheduler': scheduler?.toMap() ?? {},
+      'cards': List<Map>.generate(cards.length, (index) => cards[index].toMap(), growable: false),
+      'reviewLog': List<Map>.generate(reviewLogs.length, (index) => reviewLogs[index].toMap(), growable: false),
+      "desiredRetention": desiredRetention,
+      "easyDuration": easyDuration,
+      "goodDuration": goodDuration
+    };
+  }
+
+  FSRSConfig copyWith({
+    bool? enabled,
+    Scheduler? scheduler,
+    List<Card>? cards,
+    List<ReviewLog>? reviewLogs,
+    double? desiredRetention,
+    int? easyDuration,
+    int? goodDuration
+  }) {
+    return FSRSConfig(
+      enabled: enabled??this.enabled,
+      scheduler: scheduler??this.scheduler,
+      cards: cards??this.cards,
+      reviewLogs: reviewLogs??this.reviewLogs,
+      desiredRetention: desiredRetention??this.desiredRetention,
+      easyDuration: easyDuration??this.easyDuration,
+      goodDuration: goodDuration??this.goodDuration
+    );
+  }
+
+  static FSRSConfig buildFromMap(Map<String, dynamic> configData){
+    if(configData["enabled"]??false) {
+      return FSRSConfig(
+        enabled: configData["enabled"],
+        scheduler: Scheduler.fromMap(configData["scheduler"]),
+        cards: List<Card>.generate(configData["cards"].length,(index) => Card.fromMap(configData["cards"][index]), growable: true),
+        reviewLogs: List<ReviewLog>.generate(configData["reviewLog"].length,(index) => ReviewLog.fromMap(configData["reviewLog"][index]), growable: true),
+        desiredRetention: configData["desiredRetention"],
+        easyDuration: configData["easyDuration"],
+        goodDuration: configData["goodDuration"]
+      );
+    }
+    return FSRSConfig(enabled: false);
+  }
 }

lib/funcs/sync.dart

@@ -1,5 +1,4 @@
 import 'dart:convert';
-import 'dart:typed_data' show Uint8List;
 
 import 'package:webdav_client/webdav_client.dart';
 import 'package:logging/logging.dart';
@@ -14,7 +13,6 @@ class WebDAV {
 
   bool isReachable = false;
   bool isReadable = false;
-  bool isWriteable = false;
 
   late Client client;
   final Logger logger = Logger("WebDAV");
@@ -57,14 +55,6 @@ class WebDAV {
       tempLogger.warning("PING: 可读性测试错误: $e");
       return [true, false, 'no read access: $e'];
     }
-    try{
-      await tempClient.write("TestFile", Uint8List(64)); // test for write
-      await tempClient.remove("TestFile");
-      tempLogger.fine("WRITE: 可写性测试成功");
-    } catch (e) {
-      tempLogger.warning("PING: 可写性测试错误: $e");
-      return [true, false, 'no write access: $e'];
-    }
     tempLogger.info("所有测试均通过");
     return [true, true, 'ok'];
   } 
@@ -85,24 +75,18 @@ class WebDAV {
       isReachable = true;
       await client.readDir(''); // test for read
       isReadable = true;
-      await client.write("TestFile", Uint8List(64)); // test for write
-      isWriteable = true;
-      await client.remove("TestFile");
     } catch (e) {
       logger.warning("链接中出现错误: $e");
       rethrow;
     }
   }
 
-  Future<void> upload(SharedPreferences pref,{bool force = false}) async {
-    logger.info("开始上传文件: 服务可写: $isWriteable; force: $force");
+  Future<void> upload(SharedPreferences pref) async {
+    logger.info("开始上传文件:");
     try {
-      if(isWriteable || force) {
         await client.write("arabic_learning.bak", utf8.encode(jsonEncode(pref.export())));
         logger.info("文件上传成功");
         return;
-      }
-      throw Exception("服务不可写，取消上传");
     } catch (e) {
       logger.warning("WebDAV上传失败: $e");
       rethrow;