Merge pull request #36 from Pairman/patch-score

Feature: Cache scores list.

Author: BenderBlog

lib/model/xidian_ids/score.dart

@@ -3,6 +3,11 @@
 
 // ignore_for_file: non_constant_identifier_names
 
+import 'package:json_annotation/json_annotation.dart';
+
+part 'score.g.dart';
+
+@JsonSerializable(explicitToJson: true)
 class Score {
   int mark; // 编号，用于某种计算，从 0 开始
   String name; // 学科名称
@@ -17,6 +22,7 @@ class Score {
   String? level; // 等级
   String? isPassedStr; //是否及格，null 没出分，1 通过 0 没有
   String? classID; // 教学班序列号
+
   Score({
     required this.mark,
     required this.name,
@@ -107,8 +113,43 @@ class Score {
         }
     }
   }
+
+  factory Score.fromJson(Map<String, dynamic> json) {
+    return Score(
+      mark: json['mark'],
+      name: json['name'],
+      score: (json['score'] as num?)?.toDouble(),
+      semesterCode: json['semesterCode'],
+      credit: (json['credit'] as num).toDouble(),
+      classStatus: json['classStatus'],
+      classType: json['classType'],
+      scoreStatus: json['scoreStatus'],
+      scoreTypeCode: json['scoreTypeCode'],
+      level: json['level'],
+      isPassedStr: json['isPassedStr'],
+      classID: json['classID'],
+    );
+  }
+
+  Map<String, dynamic> toJson() {
+    return {
+      'mark': mark,
+      'name': name,
+      'score': score,
+      'semesterCode': semesterCode,
+      'credit': credit,
+      'classStatus': classStatus,
+      'classType': classType,
+      'scoreStatus': scoreStatus,
+      'scoreTypeCode': scoreTypeCode,
+      'level': level,
+      'isPassedStr': isPassedStr,
+      'classID': classID,
+    };
+  }
 }
 
+
 class ComposeDetail {
   String content;
   String ratio;

lib/model/xidian_ids/score.g.dart

@@ -6,6 +6,7 @@
 import 'package:flutter/material.dart';
 import 'package:watermeter/model/xidian_ids/score.dart';
 import 'package:watermeter/page/public_widget/public_widget.dart';
+import 'package:watermeter/page/public_widget/toast.dart';
 import 'package:watermeter/page/score/score_page.dart';
 import 'package:watermeter/page/score/score_state.dart';
 import 'package:watermeter/repository/xidian_ids/ehall_score_session.dart';
@@ -28,7 +29,16 @@ class _ScoreWindowState extends State<ScoreWindow> {
     );
   }
 
-  void dataInit() => scoreList = ScoreSession().getScore();
+  void dataInit() {
+    ScoreSession session = ScoreSession()
+    scoreList = session.getScore();
+    if (session.isScoreListCacheUsed) {
+      showToast(
+        context: context,
+        msg: "已显示缓存成绩信息",
+      );
+    }
+  }
 
   @override
   void initState() {
@@ -71,4 +81,4 @@ class _ScoreWindowState extends State<ScoreWindow> {
       },
     );
   }
-}
+}

lib/page/score/score.dart

@@ -62,6 +62,12 @@ class AboutPage extends StatelessWidget {
       "开发：图书馆搜索功能",
       "https://github.com/NanCunChild",
     ),
+    Developer(
+      "Pairman",
+      "https://avatars.githubusercontent.com/u/18365163",
+      "开发：成绩信息缓存功能",
+      "https://github.com/ZCWzy",
+    ),
     Developer(
       "ReverierXu",
       "https://blog.woooo.tech/img/avatar.png",

lib/page/setting/about_page/about_page.dart

@@ -7,13 +7,20 @@
 // ignore_for_file: non_constant_identifier_names
 
 import 'dart:convert';
+import 'dart:io';
+
 import 'package:watermeter/repository/preference.dart' as pref;
 import 'package:watermeter/model/xidian_ids/score.dart';
 import 'package:watermeter/repository/logger.dart';
+import 'package:watermeter/repository/network_session.dart';
 import 'package:watermeter/repository/xidian_ids/ehall_session.dart';
 
 /// 考试成绩 4768574631264620
 class ScoreSession extends EhallSession {
+  static const scoreListCacheName = "scores.json";
+  late File file = File("${supportPath.path}/${scoreListCacheName}");
+  bool isScoreListCacheUsed = false;
+
   /// Must be called after [getScore]!
   /// If bug, just return dummy data.
   Future<List<ComposeDetail>> getDetail(
@@ -86,12 +93,61 @@ class ScoreSession extends EhallSession {
     }
   }
 
+  Future<List<Score>> loadScoreListCache() async {
+    log.i(
+      "[ScoreSession][loadScoreListCache] "
+      "Path at ${supportPath.path}/${scoreListCacheName}.",
+    );
+    if (file.existsSync()) {
+      final timeDiff = DateTime.now().difference(
+        file.lastModifiedSync()
+      ).inHours;
+      if (timeDiff < 6) {
+        log.i(
+          "[ScoreSession][loadScoreListCache] "
+          "Cache file effective.",
+        );
+        List<dynamic> data = jsonDecode(file.readAsStringSync());
+        return data.map(
+          (s) => Score.fromJson(s as Map<String, dynamic>)
+        ).toList();
+      }
+    }
+    log.i(
+      "[ScoreSession][loadScoreListCache] "
+      "Cache file non-existent or ineffective.",
+    );
+    return [];
+  }
+
+  void dumpScoreListCache(List<Score> scores) {
+    file.writeAsStringSync(
+      jsonEncode(scores.map((s) => s.toJson()).toList()),
+    );
+    log.i(
+      "[ScoreWindow][dumpScoreListCache] "
+      "Dumped scoreList to ${supportPath.path}/${scoreListCacheName}.",
+    );
+  }
+
   Future<List<Score>> getScore() async {
     List<Score> toReturn = [];
+    /// Try retrieving cached scores first.
+    isScoreListCacheUsed = false;
+    toReturn = await loadScoreListCache();
+    if (!toReturn.isEmpty) {
+      log.i(
+        "[ScoreSession][getScore] "
+        "Loaded scores from cache.",
+      );
+      isScoreListCacheUsed = true;
+      return toReturn;
+    }
 
-    /// Get all scores here.
+    /// Otherwise get fresh score data.
     log.i(
-      "[ScoreSession] Start getting the score.",
+      "[ScoreSession][getScore] "
+      "Start getting score data.",
     );
     Map<String, dynamic> querySetting = {
       'name': 'SFYX',
@@ -101,7 +157,8 @@ class ScoreSession extends EhallSession {
     };
 
     log.i(
-      "[ScoreSession] Ready to login the system.",
+      "[ScoreSession][getScore] "
+      "Ready to log into the system.",
     );
     var firstPost = await useApp("4768574631264620");
     log.i(
@@ -110,7 +167,8 @@ class ScoreSession extends EhallSession {
     await dioEhall.get(firstPost);
 
     log.i(
-      "[ScoreSession] Getting the score data.",
+      "[ScoreSession][getScore] "
+      "Getting score data.",
     );
     var getData = await dioEhall.post(
       "https://ehall.xidian.edu.cn/jwapp/sys/cjcx/modules/cjcx/xscjcx.do",
@@ -123,7 +181,8 @@ class ScoreSession extends EhallSession {
       },
     ).then((value) => value.data);
     log.i(
-      "[ScoreSession] Dealing the score data.",
+      "[ScoreSession][getScore] "
+      "Dealing with the score data.",
     );
     if (getData['datas']['xscjcx']["extParams"]["code"] != 1) {
       throw GetScoreFailedException(
@@ -150,6 +209,11 @@ class ScoreSession extends EhallSession {
       ));
       j++;
     }
+    dumpScoreListCache(toReturn);
+    log.i(
+      "[ScoreSession][getScore] "
+      "Cached the score data.",
+    );
     return toReturn;
   }
 }