Merge pull request #32 from OctagonalStar/feat/add_logger

Feat/add_logger

Author: OctagonalStar

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## v?.?.?? - ????-??-?? - (??????)
 
+### Added
+
+- 添加了日志捕获 [#23](https://github.com/OctagonalStar/arabic_learning/issues/23)
+- 添加了调试页面
+
 ### Improvement
 
 - 优化了网页端字体加载逻辑

lib/funcs/fsrs_func.dart

@@ -1,6 +1,12 @@
 import 'dart:convert';
-import 'package:arabic_learning/package_replacement/storage.dart';
+
+import 'package:arabic_learning/vars/global.dart';
+import 'package:flutter/material.dart' show BuildContext;
 import 'package:fsrs/fsrs.dart';
+import 'package:logging/logging.dart';
+
+import 'package:arabic_learning/package_replacement/storage.dart';
+import 'package:provider/provider.dart';
 
 class FSRS { 
   List<Card> cards = [];
@@ -9,12 +15,15 @@ class FSRS {
   late SharedPreferences prefs;
   late Rater rater;
   late Map<String, dynamic> settingData;
-
+  late final Logger logger;
   // index != cardId; cardId = wordId = the index of word in global.wordData[words]
 
-  Future<bool> init() async {
-    prefs = await SharedPreferences.getInstance();
+  Future<bool> init({BuildContext? context}) async {
+    logger = Logger('FSRS');
+    logger.fine("构建FSRS模块");
+    prefs = context==null ? await SharedPreferences.getInstance() : context.read<Global>().prefs;
     if(!prefs.containsKey("fsrsData")) {
+      logger.info("未发现FSRS配置，加载默认配置");
       settingData = {
         'enabled': false,
         'scheduler': {},
@@ -33,12 +42,15 @@ class FSRS {
         reviewLogs.add(ReviewLog.fromMap(settingData['reviewLog'][i]));
       }
       rater = Rater(settingData['rater']['scheme']);
+      logger.info("FSRS配置加载完成");
       return true;
     }
+    logger.info("FSRS未启用");
     return false;
   }
 
   void save() async {
+    logger.info("正在保存FSRS配置");
     settingData['scheduler'] = scheduler.toMap();
     List cardsCache = [];
     List logCache = [];
@@ -55,8 +67,9 @@ class FSRS {
     return settingData['enabled'];
   }
 
-  Future<void> createScheduler(int scheme) async {
-    await init();
+  Future<void> createScheduler(int scheme, {BuildContext? context}) async {
+    await init(context: context);
+    logger.info("初始化scheduler，选择方案 $scheme");
     List<double> desiredRetention = [0.85, 0.9, 0.95, 0.95, 0.99];
     scheduler = Scheduler(desiredRetention: desiredRetention[scheme]);
     settingData['rater']['scheme'] = scheme;
@@ -71,8 +84,11 @@ class FSRS {
   }
 
   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
-    final (:card, :reviewLog) = scheduler.reviewCard(cards[index], rater.calculate(duration, isCorrect));
+    logger.fine("定位复习卡片地址: $index, 目前阶段: ${cards[index].step}, 难度: ${cards[index].difficulty}, 稳定: ${cards[index].stability}, 过期时间(+8): ${cards[index].due.toLocal()}");
+    final (:card, :reviewLog) = scheduler.reviewCard(cards[index], rater.calculate(duration, isCorrect), reviewDateTime: DateTime.now().toUtc(), reviewDuration: duration);
+    logger.fine("卡片 $index 复习后: 目前阶段: ${cards[index].step}, 难度: ${cards[index].difficulty}, 稳定: ${cards[index].stability}, 过期时间(+8): ${cards[index].due.toLocal()}");
     cards[index] = card;
     reviewLogs[index] = reviewLog;
     save();

lib/funcs/sync.dart

@@ -1,8 +1,8 @@
 import 'dart:convert';
 import 'dart:typed_data' show Uint8List;
 
-import 'package:flutter/material.dart';
 import 'package:webdav_client/webdav_client.dart';
+import 'package:logging/logging.dart';
 
 import 'package:arabic_learning/package_replacement/storage.dart' show SharedPreferences;
 
@@ -17,8 +17,12 @@ class WebDAV {
   bool isWriteable = false;
 
   late Client client;
+  final Logger logger = Logger("WebDAV");
 
   static Future<List<dynamic>> test(String uri, String user, {String password = ''}) async {
+    final Logger tempLogger = Logger("WebDAV_Test");
+    tempLogger.info("进行WebDAV测试");
+    tempLogger.fine("测试uri: $uri");
     Client tempClient = newClient(
       uri,
       user: user,
@@ -34,29 +38,39 @@ class WebDAV {
       tempClient.setConnectTimeout(8000);
       tempClient.setSendTimeout(60000);
       tempClient.setReceiveTimeout(60000);
+      tempLogger.fine("完成基础设置");
     } catch (e) {
+      tempLogger.warning("基础设置中出现错误: $e");
       return [false, false, "base setting error: $e"];
     }
     try{
       await tempClient.ping(); // test for connection
+      tempLogger.fine("PING: 可达性测试成功");
     } catch (e) {
+      tempLogger.warning("PING: 可达性测试错误: $e");
       return [false, false, "remote server didn't response: $e"];
     }
     try {
       await tempClient.readDir('/'); // test for read
+      tempLogger.fine("READ: 可读性测试成功");
     } catch (e) {
+      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'];
   } 
 
   Future<void> connect() async {
+    logger.info("正在链接: $uri");
     try{
       client = newClient(
         uri,
@@ -75,24 +89,39 @@ class WebDAV {
       isWriteable = true;
       await client.remove("TestFile");
     } catch (e) {
-      debugPrint(e.toString());
+      logger.warning("链接中出现错误: $e");
+      rethrow;
     }
   }
 
-  Future<bool> upload(SharedPreferences pref,{bool force = false}) async {
-    if(isWriteable || force) {
-      await client.write("arabic_learning.bak", utf8.encode(jsonEncode(pref.export())));
-      return true;
+  Future<void> upload(SharedPreferences pref,{bool force = false}) async {
+    logger.info("开始上传文件: 服务可写: $isWriteable; force: $force");
+    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;
     }
-    return false;
   }
 
-  Future<bool> download(SharedPreferences pref,{bool force = false}) async {
-    if(isReadable || force) {
-      Map<String, dynamic> file = jsonDecode(utf8.decode(await client.read("arabic_learning.bak")));
-      pref.recovery(file);
-      return true;
+  Future<void> download(SharedPreferences pref,{bool force = false}) async {
+    logger.info("开始恢复文件: 服务可读: $isReadable; force: $force");
+    try {
+      if(isReadable || force) {
+        Map<String, dynamic> file = jsonDecode(utf8.decode(await client.read("arabic_learning.bak")));
+        logger.fine("文件下载成功，开始恢复");
+        pref.recovery(file);
+        return;
+      }
+      throw Exception("服务不可读，取消恢复");
+    } catch (e) {
+      logger.warning("WebDAV恢复失败: $e");
+      rethrow;
     }
-    return false;
   }
 }

lib/funcs/ui.dart

@@ -1,10 +1,12 @@
 import 'dart:convert';
 import 'dart:ui';
-import 'package:arabic_learning/vars/global.dart';
-import 'package:arabic_learning/vars/statics_var.dart';
+
 import 'package:flutter/material.dart';
 import 'package:provider/provider.dart';
-import 'utili.dart';
+
+import 'package:arabic_learning/vars/global.dart';
+import 'package:arabic_learning/vars/statics_var.dart';
+import 'package:arabic_learning/funcs/utili.dart';
 
 // 该文件主要包含了对于UI有关的函数及多次在不同地方使用的Widget类或者函数
 
@@ -34,20 +36,22 @@ import 'utili.dart';
 /// List<Map<String, dynamic>> words = getSelectedWords(context , forceSelectClasses: value);
 /// ```
 Future<List<List<String>>> popSelectClasses(BuildContext context, {bool withCache = false}) async {
+  context.read<Global>().uiLogger.info("弹出课程选择（ClassSelectPage），withCache: $withCache");
   late final List<List<String>> beforeSelectedClasses;
   if(withCache) {
     final String tpcPrefs = context.read<Global>().prefs.getString("tempConfig") ?? jsonEncode(StaticsVar.tempConfig);
     beforeSelectedClasses = (jsonDecode(tpcPrefs)["SelectedClasses"] as List)
         .cast<List>()
         .map((e) => e.cast<String>().toList())
         .toList();
+    context.read<Global>().uiLogger.fine("已缓存课程选择: $beforeSelectedClasses");
   } else {
     beforeSelectedClasses = [];
   }
   List<List<String>>? selectedClasses = await showModalBottomSheet<List<List<String>>>(
     context: context,
     // 假装圆角... :)
-    shape: RoundedSuperellipseBorder(side: BorderSide(width: 1.0, color: Theme.of(context).colorScheme.onSurface.withAlpha(150)), borderRadius: StaticsVar.br),
+    shape: RoundedRectangleBorder(side: BorderSide(width: 1.0, color: Theme.of(context).colorScheme.onSurface.withAlpha(150)), borderRadius: StaticsVar.br),
     isDismissible: false,
     isScrollControlled: context.read<Global>().isWideScreen,
     enableDrag: true,
@@ -60,7 +64,9 @@ Future<List<List<String>>> popSelectClasses(BuildContext context, {bool withCach
     Map<String, dynamic> tpcMap = jsonDecode(tpcPrefs);
     tpcMap["SelectedClasses"] = selectedClasses;
     context.read<Global>().prefs.setString("tempConfig", jsonEncode(tpcMap));
+    context.read<Global>().uiLogger.info("课程选择缓存完成");
   }
+  if(context.mounted) context.read<Global>().uiLogger.fine("选择的课程: $selectedClasses");
   return selectedClasses ?? [];
 }
 
@@ -76,7 +82,8 @@ Future<List<List<String>>> popSelectClasses(BuildContext context, {bool withCach
 /// [isClassSelected] :需要一个函数判断该课程是否被选中
 /// 
 /// 一般情况下该函数只会在 [ClassSelectPage] 中被使用，若非必要你不应该使用此函数
-List<Widget> classesSelectionList(BuildContext context, MediaQueryData mediaQuery, Function (List<String>) onChanged, bool Function (List<String>) isClassSelected) {
+List<Widget> classesSelectionList(BuildContext context, Function (List<String>) onChanged, bool Function (List<String>) isClassSelected) {
+  context.read<Global>().uiLogger.fine("构建课程选择列表");
   Map<String, dynamic> wordData = context.read<Global>().wordData;
   List<Widget> widgetList = [];
   for (String sourceName in wordData["Classes"].keys) {
@@ -125,10 +132,12 @@ List<Widget> classesSelectionList(BuildContext context, MediaQueryData mediaQuer
     }
   }
   if(widgetList.isEmpty) {
+    context.read<Global>().uiLogger.warning("用户未导入可用词库");
     widgetList.add(
       Center(child: Text('啥啥词库都没导入，你学个啥呢？\n自己去 设置 -> 数据设置 -> 导入词库', style: TextStyle(fontSize: 24.0, color: Colors.redAccent),))
     );
   }
+  context.read<Global>().uiLogger.info("课程选择列表构建完成");
   return widgetList;
 }
 
@@ -149,7 +158,8 @@ List<Widget> classesSelectionList(BuildContext context, MediaQueryData mediaQuer
 ///   alart(context, "你点击了按钮"，onConfirmed: (){i++}, delayConfirm: Duration(seconds: 1));
 /// }
 /// ```
-void alart(context, String e, {Function? onConfirmed, Duration delayConfirm = const Duration(milliseconds: 0)}) {
+void alart(BuildContext context, String e, {Function? onConfirmed, Duration delayConfirm = const Duration(milliseconds: 0)}) {
+  context.read<Global>().uiLogger.info("构建弹出窗口: 携带信息: $e ;确认参数: ${onConfirmed != null}; 延迟: ${delayConfirm.inMilliseconds}");
   showDialog(
     context: context, 
     builder: (BuildContext context) {
@@ -179,6 +189,39 @@ void alart(context, String e, {Function? onConfirmed, Duration delayConfirm = co
   );
 }
 
+/// 弹出详解页面
+void viewAnswer(BuildContext context, Map<String, dynamic> wordData) async {
+  context.read<Global>().uiLogger.info("弹出详解页面");
+  MediaQueryData mediaQuery = MediaQuery.of(context);
+  showBottomSheet(
+    context: context, 
+    shape: RoundedSuperellipseBorder(side: BorderSide(width: 1.0, color: Theme.of(context).colorScheme.onSurface), borderRadius: StaticsVar.br),
+    enableDrag: true,
+    builder: (context) {
+      return Container(
+        padding: EdgeInsets.only(top: mediaQuery.size.height * 0.05),
+        decoration: BoxDecoration(
+          color: Theme.of(context).colorScheme.onPrimary,
+          borderRadius: StaticsVar.br,
+        ),
+        child: Column(
+          children: [
+            Expanded(child: WordCard(word: wordData)),
+            ElevatedButton(
+              onPressed: () {Navigator.pop(context);}, 
+              style: ElevatedButton.styleFrom(
+                fixedSize: Size(mediaQuery.size.width * 0.8, mediaQuery.size.height * 0.1),
+                shape: RoundedRectangleBorder(borderRadius: StaticsVar.br)
+              ),
+              child: Text("我知道了"),
+            )
+          ],
+        ),
+      );
+    },
+  );
+}
+
 // Base Widgets 较为基础的Widget
 
 /// 文本框容器
@@ -537,7 +580,7 @@ class ClassSelectPage extends StatelessWidget {
         children: [
           Expanded(
             child: ListView(
-              children: classesSelectionList(context, mediaQuery, onClassChanged, isClassSelected)
+              children: classesSelectionList(context, onClassChanged, isClassSelected)
             ),
           ),
           ElevatedButton(
@@ -653,13 +696,16 @@ class _ChoiceQuestions extends State<ChoiceQuestions> {
 
   @override
   Widget build(BuildContext context) {
+    context.read<Global>().uiLogger.info("构建选择题页面: 主单词: ${widget.mainWord};选项: ${widget.choices}");
     MediaQueryData mediaQuery = MediaQuery.of(context);
     int showingMode = widget.bottonLayout;
     // showingMode 0: 1 Row, 1: 2 Rows, 2: 4 Rows
     if(showingMode == -1){
+      context.read<Global>().uiLogger.fine("未指定布局，开始计算");
       bool overFlowPossible = false;
       for(int i = 1; i < 4; i++) {
         if(widget.choices[i].length * 16 > mediaQuery.size.width * (context.read<Global>().isWideScreen ? 0.21 : 0.8)){
+          context.read<Global>().uiLogger.fine("在 [${widget.choices[i]}] 可能溢出，采用密集布局");
           overFlowPossible = true;
           break;
         }
@@ -678,6 +724,7 @@ class _ChoiceQuestions extends State<ChoiceQuestions> {
           showingMode = 1;
         }
       }
+      context.read<Global>().uiLogger.info("最终采用布局方案: $showingMode");
     }
     return Material(
       child: Center(
@@ -696,6 +743,7 @@ class _ChoiceQuestions extends State<ChoiceQuestions> {
                     ),
                     onPressed: () async {
                       if (playing || !widget.allowAudio) {
+                        context.read<Global>().uiLogger.warning("${playing ? "正在播放" : "不准许音频"}，中断TTS");
                         return;
                       }
                       setLocalState(() {
@@ -759,6 +807,7 @@ class WordCardQuestion extends StatelessWidget {
 
   @override
   Widget build(BuildContext context) {
+    context.read<Global>().uiLogger.info("构建单词卡片页面，主单词: ${word["arabic"]}");
     MediaQueryData mediaQuery = MediaQuery.of(context);
     return Material(
       child: Column(
@@ -804,6 +853,7 @@ class _SpellQuestion extends State<SpellQuestion> {
 
   @override
   Widget build(BuildContext context) {
+    context.read<Global>().uiLogger.info("构建拼写题页面，主单词: ${widget.word["arabic"]}");
     MediaQueryData mediaQuery = MediaQuery.of(context);
     return Material(
       child: Column(
@@ -854,6 +904,7 @@ class _SpellQuestion extends State<SpellQuestion> {
           SizedBox(height: mediaQuery.size.height * 0.05),
           ElevatedButton(
             onPressed: () {
+              context.read<Global>().uiLogger.info("提交单词检查: [${controller.text}]");
               check(controller.text);
             }, 
             style: ElevatedButton.styleFrom(