(null);
353 |
354 | const dispatch = useAppDispatch();
355 |
356 | const loadingProgress = useAppSelector((state) => state.ui.loadingProgress);
357 | const paneHidden = useAppSelector((state) => state.ui.paneHidden);
358 | const csrf = useAppSelector((state) => state.helper.helper.getCSRFToken());
359 |
360 | const [_, navigate] = useLocation();
361 |
362 | useEffect(() => {
363 | dispatch(loadApp()).then((res) => {
364 | if (res.navigate) {
365 | navigate(`/doc/${res.navigate}`);
366 | }
367 | });
368 | // keep login state
369 | const handle = window.setInterval(() => dispatch(tryLoginSilently()), 14 * 60 * 1000); // < 15 minutes and as long as possible
370 | return () => window.clearInterval(handle);
371 | }, [dispatch, navigate]);
372 |
373 | useEffect(() => {
374 | interceptCsrfRequest(csrf);
375 | }, [csrf]);
376 |
377 | return (
378 | {
380 | setErrorInfo(info);
381 | console.error(error);
382 | }}
383 | fallbackRender={(fallbackProps) =>
386 | {/* sidebar */}
387 |
390 | {loadingProgress !== undefined && (
391 |
394 |
401 |
403 |
409 |
410 | {/* dialogs */}
411 |
418 |
419 | );
420 | };
421 |
422 | export default App;
423 |
--------------------------------------------------------------------------------
/src/pages/content.tsx:
--------------------------------------------------------------------------------
1 | import type { ContentType } from 'thu-learn-lib';
2 | import { useParams } from 'wouter';
3 |
4 | import ContentDetail from '../components/ContentDetail';
5 | import { useAppSelector } from '../redux/hooks';
6 |
7 | export default function Content() {
8 | const { type, id } = useParams();
9 |
10 | const content = useAppSelector((state) =>
11 | type && id ? state.data[`${type as ContentType}Map`][id] : undefined,
12 | );
13 |
14 | return content &&
13 |
14 | 返回
19 |
20 |
21 |
22 | );
23 | };
24 |
25 | export default Doc;
26 |
--------------------------------------------------------------------------------
/src/pages/doc/about/_en.mdx:
--------------------------------------------------------------------------------
1 | # About
2 |
3 | > TODO: translation
4 |
5 | 做为一只贵系（计算机系的别称）的孩子，每周上双位数的作业实在是让人叫苦不迭。
6 | 我的脑子总是记不住繁多的作业 TT，网络学堂设计的不合理以及经常挂掉，使我有了兴趣来做这个网络学堂改造器。
7 |
8 | Contact us:
9 |
10 | * [xxr3376](mailto:xxr3376@gmail.com): Creator
11 | * [Harry-Chen](mailto:harry-chen@outlook.com): Current maintainer
12 | * [AsakuraMizu](mailto:asakuramizu111@gmail.com): Current maintainer
13 |
14 | This extension is open source on [GitHub](https://github.com/Harry-Chen/Learn-Helper) under the MIT license with additional terms.
15 | Before using the source code of this extension, please ensure that you have fully understood and accepted the content of the agreement and its additional terms.
16 |
17 | This extension will not send any information to any site except Tsinghua University Web Learning and Electric ID Service System.
18 | With the user's explicit consent, the plugin stores user credentials locally.
19 |
20 | This extension provides a best-effort service, but the author is not responsible for any consequences caused by using this extension,
21 | This includes, but is not limited to, downloaded files being corrupted, assignment deadlines missed, notifications not being updated in a timely manner, Web Learning being unavailable or being attacked,
22 | and any collateral consequences they result in, such as failing a course, missing an exam, or having a user's computer compromised by malware.
23 |
24 | Thanks:
25 |
26 | - jiegec、CircuitCoder：为 4.0 的诞生做出了巨大的贡献
27 | - yaoht、moreD 等贡献者：对 2015 版网络学堂修复和支持
28 | - 李百恩：无敌的技术支持以及最好的美工
29 | - 贵系老师：繁多的作业催生了这个插件的产生
30 | - React 框架：清晰的逻辑，前后端分离
31 | - MUI & FontAwesome：清新漂亮的界面
32 |
--------------------------------------------------------------------------------
/src/pages/doc/about/_zh.mdx:
--------------------------------------------------------------------------------
1 | # 关于我们
2 |
3 | 做为一只贵系（计算机系的别称）的孩子，每周上双位数的作业实在是让人叫苦不迭。
4 | 我的脑子总是记不住繁多的作业 TT，网络学堂设计的不合理以及经常挂掉，使我有了兴趣来做这个网络学堂改造器。
5 |
6 | 联系我们：
7 |
8 | - [xxr3376](mailto:xxr3376@gmail.com)：初始开发者
9 | - [Harry-Chen](mailto:harry-chen@outlook.com)：当前维护者
10 | - [AsakuraMizu](mailto:asakuramizu111@gmail.com)：当前维护者
11 |
12 | 本插件以含附加条款的 MIT 协议在 [GitHub](https://github.com/Harry-Chen/Learn-Helper) 开放源代码。
13 | 在使用本插件的源代码前，请确保您已经充分理解并接受协议及其附加条款的内容。
14 |
15 | 本插件不会向除清华大学网络学堂服务以及身份认证服务外的任何站点发送任何信息。
16 | 在用户明确同意的情况下，本插件会在本地存储用户凭据。
17 |
18 | 本插件提供尽力而为的服务，但作者不对使用本插件导致的任何后果负任何责任，
19 | 包括且不限于下载文件损坏、错过作业截止日期、通知未及时更新、网络学堂不可用或被攻击，
20 | 以及它们导致的任何连带后果，如课程不及格、考试缺席或用户计算机被恶意软件侵入。
21 |
22 | 致谢：
23 |
24 | - jiegec、CircuitCoder：为 4.0 的诞生做出了巨大的贡献
25 | - yaoht、moreD 等贡献者：对 2015 版网络学堂修复和支持
26 | - 李百恩：无敌的技术支持以及最好的美工
27 | - 贵系老师：繁多的作业催生了这个插件的产生
28 | - React 框架：清晰的逻辑，前后端分离
29 | - MUI & FontAwesome：清新漂亮的界面
30 |
--------------------------------------------------------------------------------
/src/pages/doc/about/index.tsx:
--------------------------------------------------------------------------------
1 | import { useLingui } from '@lingui/react';
2 |
3 | import styles from '../../../css/doc.module.css';
4 |
5 | import AboutEN from './_en.mdx';
6 | import AboutZH from './_zh.mdx';
7 |
8 | export default function About() {
9 | const { i18n } = useLingui();
10 | return (
11 | {i18n.locale === 'zh' ?
:
}
11 | {i18n.locale === 'zh' ?
13 | );
14 | }
15 |
--------------------------------------------------------------------------------
/src/pages/doc/readme/_en.mdx:
--------------------------------------------------------------------------------
1 | import styles from '../../../css/doc.module.css';
2 |
3 | # Manual
4 |
5 |
6 | 
7 |
8 | ## New item
9 | New items will appear at the top of the list, with a red dot indicating unread. This is a new homework, labeled with the number of days remaining.
10 |
11 |
13 | 
14 |
15 | ## Starred item
16 | Starred items will always remain at the top of the list. This is a starred notification, click to see its details.
17 |
18 |
20 | 
21 |
22 | ## Homework
23 | There are three colors: red, orange, and blue indicating the remaining time, and a submit button in the lower left corner. Homeworks that are submitted is marked with a green tick.
24 |
25 |
27 | 
28 |
29 | ## Expired homework
30 | Homeworks that have passed the deadline will become grey, and display the score and the reviewer if graded.
31 |
32 |
35 | 
36 |
37 | ## File
38 | Click on the title to download the file, or directly mark it as read (not synchronized to Web Learning).
39 |
40 |
43 | 
44 |
45 | ## Switch content
46 | Switch to view the overview panel of different type of items, with the corner mark showing unread count.
47 |
48 |
51 | 
52 |
53 | ## Switch course
54 | Click on the course name on the left to view the contents of the course, or open the course homepage on Web Learning.
55 |
56 |
59 | 
60 |
61 | ## Filter
62 | Use filters to easily find the one you want among hundreds or thousands of items.
63 |
64 |
67 | 
68 |
69 | ## Extension settings
70 | You can hide part of the content of some courses. And we also thoughtfully provide a one-click function to mark everying as read.
71 |
72 |
75 | 
76 |
77 | ## Other settings
78 | If you encounter an error, try refreshing, clearing data or logging out.
79 |
80 |
6 | 
7 |
8 | ## 未读项目
9 | 新的项目会出现在列表顶部，红色的点表示未读。这是一份新作业，标有剩余天数。
10 |
11 |
13 | 
14 |
15 | ## 星标项目
16 | 加星标的项目会始终保持在列表顶部。这是一条加星的通知，点击即可进入详情。
17 |
18 |
20 | 
21 |
22 | ## 作业提示
23 | 有红、橙、蓝三种颜色对应剩余时间，左下角有提交按钮。已交的作业是绿色的勾。
24 |
25 |
27 | 
28 |
29 | ## 截止作业
30 | 过了截止日期的作业是灰色的笔或者勾，会显示提交和批阅状态（分数和评阅人）。
31 |
32 |
35 | 
36 |
37 | ## 课程文件
38 | 点击标题即可下载文件，也可直接标记为已读（不同步到网络学堂）。
39 |
40 |
43 | 
44 |
45 | ## 切换内容
46 | 在左上角可以切换查看各项信息的总览面板，角标是未读数量。
47 |
48 |
51 | 
52 |
53 | ## 切换课程
54 | 点击左侧课程名字，可以查看该课程的各项内容，或者打开课程主页。
55 |
56 |
59 | 
60 |
61 | ## 卡片过滤
62 | 使用过滤器，轻松地在成百上千个卡片中找到你要的那一个。
63 |
64 |
67 | 
68 |
69 | ## 插件设置
70 | 可以隐藏某些课程的部分内容以免刷屏，也贴心地提供了一键解决强迫症的功能。
71 |
72 |
75 | 
76 |
77 | ## 其他设置
78 | 遇到错误不妨试一下，强制刷新、清空缓存、退出登录，总有一个适合你！
79 |
80 |
28 |
29 | 管理隐藏项
30 |
31 |
32 |
33 | 此处的更改在下一次刷新时生效，并且只在汇总功能中起作用。
34 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 | 课程名称
45 |
46 | {Object.values(COURSE_MAIN_FUNC).map((func) => (
47 |
48 | {_(func.name)}
49 |
50 | ))}
51 |
52 |
53 |
54 | {Object.entries(contentIgnore).map(([cid, ignore]) => (
55 |
56 |
57 | {_({ id: `course-${courses[cid].id}` })}
58 |
59 | {Object.values(COURSE_MAIN_FUNC).map((func) => (
60 |
61 | {
64 | dispatch(
65 | toggleContentIgnore({
66 | id: cid,
67 | type: func.type,
68 | state: !ignore[func.type],
69 | }),
70 | );
71 | }}
72 | />
73 |
74 | ))}
75 |
76 | ))}
77 |
78 |
79 |
80 |
81 | {
85 | dispatch(resetContentIgnore());
86 | }}
87 | >
88 | 重置
89 |
90 |
91 |
92 |
93 | );
94 | };
95 |
96 | export default ContentIgnoreSetting;
97 |
--------------------------------------------------------------------------------
/src/pages/web.tsx:
--------------------------------------------------------------------------------
1 | import { useParams } from 'wouter';
2 |
3 | import IframeWrapper from '../components/IframeWrapper';
4 | import styles from '../css/main.module.css';
5 |
6 | export default function Web() {
7 | const { url } = useParams();
8 |
9 | return (
10 | url && (
11 |
18 | )
19 | );
20 | }
21 |
--------------------------------------------------------------------------------
/src/pages/welcome.tsx:
--------------------------------------------------------------------------------
1 | import { Trans } from '@lingui/react/macro';
2 | import classNames from 'classnames';
3 | import { Link } from 'wouter';
4 |
5 | import styles from '../css/doc.module.css';
6 | import bg from '../image/bg.png';
7 | import bgDark from '../image/bg_dark.png';
8 |
9 | const Welcome = () => {
10 | return (
11 |
12 |
13 |
14 |
17 |
18 | 使用手册
20 |
21 | {' | '}
22 | 关于我们
24 |
25 | {' | '}
26 | 更新记录
28 |
29 |
35 | Chrome Store
36 |
37 | {' | '}
38 |
43 | Edge Addons
44 |
45 | {' | '}
46 |
47 | FireFox / 开发版
48 |
49 |
50 | {__GIT_VERSION__} (built on {__BUILD_HOSTNAME__} at {__BUILD_TIME__})
51 |
53 |
54 | thu-learn-lib: v{__THU_LEARN_LIB_VERSION__}
58 |
59 |
60 |
67 |
68 | );
69 | };
70 |
71 | export default Welcome;
72 |
--------------------------------------------------------------------------------
/src/redux/actions.ts:
--------------------------------------------------------------------------------
1 | import { i18n } from '@lingui/core';
2 | import { t } from '@lingui/core/macro';
3 | import { compileMessage } from '@lingui/message-utils/compileMessage';
4 | import type { Action, ThunkAction } from '@reduxjs/toolkit';
5 | import { compare as compareVersion } from 'compare-versions';
6 | import { enqueueSnackbar } from 'notistack';
7 | import { type ApiError, ContentType, CourseType, type Language, SemesterType } from 'thu-learn-lib';
8 |
9 | import { version as currentVersion } from '../../package.json';
10 | import { STORAGE_KEY_REDUX, STORAGE_KEY_REDUX_LEGACY, STORAGE_KEY_VERSION } from '../constants';
11 | import type { ContentInfo, FileInfo } from '../types/data';
12 | import { initiateFileDownload } from '../utils/download';
13 | import { failReasonToString } from '../utils/format';
14 | import { getStoredCredential, storeCredential } from '../utils/storage';
15 |
16 | import { dataSlice } from './reducers/data';
17 | import { helperSlice } from './reducers/helper';
18 | import { uiSlice } from './reducers/ui';
19 | import { selectContentIgnore, selectDataLists } from './selectors';
20 | import type { RootState } from './store';
21 |
22 | export const {
23 | newSemester,
24 | insistSemester,
25 | updateSemesterList,
26 | updateSemester,
27 | syncSemester,
28 | updateCourses,
29 | updateNotification,
30 | updateFile,
31 | updateHomework,
32 | updateDiscussion,
33 | updateQuestion,
34 | updateFinished,
35 | toggleReadState,
36 | toggleStarState,
37 | toggleIgnoreState,
38 | toggleContentIgnore,
39 | resetContentIgnore,
40 | markAllRead,
41 | clearAllData,
42 | clearFetchedData,
43 | loadData,
44 | } = dataSlice.actions;
45 | export const { loggedIn, loggedOut } = helperSlice.actions;
46 | export const {
47 | setLoadingProgress,
48 | togglePaneHidden,
49 | toggleLoginDialog,
50 | toggleLoginDialogProgress,
51 | loginEnd,
52 | toggleNetworkErrorDialog,
53 | toggleNewSemesterDialog,
54 | toggleIgnoreWrongSemester,
55 | toggleLogoutDialog,
56 | toggleClearDataDialog,
57 | toggleChangeSemesterDialog,
58 | resetCardVisibilityThreshold,
59 | loadMoreCard,
60 | setCardList,
61 | setCardFilter,
62 | setTitleFilter,
63 | } = uiSlice.actions;
64 |
65 | export type AppThunk = ThunkAction;
66 |
67 | // here we don't catch errors in login(), for there are two cases:
68 | // 1. silent login when starting, then NetworkErrorDialog should be shown
69 | // 2. explicit login in LoginDialog, then login dialog should still be shown
70 | export const login =
71 | (username: string, password: string, save: boolean): AppThunk> =>
72 | async (dispatch, getState) => {
73 | dispatch(toggleLoginDialogProgress(true));
74 | const helperState = getState().helper;
75 | const helper = helperState.helper;
76 |
77 | // wait at most 5 seconds for timeout
78 | const timeout = new Promise((_, reject) => {
79 | setTimeout(() => {
80 | reject({ reason: 'TIMEOUT' });
81 | }, 5000);
82 | });
83 |
84 | try {
85 | await Promise.race([helper.login(username, password), timeout]);
86 | } catch (e) {
87 | const error = e as ApiError;
88 | enqueueSnackbar(
89 | t`登录失败：${failReasonToString(error?.reason) ?? error.toString() ?? t`未知错误`}`,
90 | { variant: 'error' },
91 | );
92 | dispatch(loginEnd());
93 | return Promise.reject(`login failed: ${error}`);
94 | }
95 |
96 | // login succeeded
97 | // hide login dialog (if shown), show success notice
98 | enqueueSnackbar(t`登录成功`, { variant: 'success' });
99 | // save salted user credential if asked
100 | if (save) {
101 | await storeCredential(username, password);
102 | }
103 | dispatch(loggedIn());
104 | dispatch(loginEnd());
105 | dispatch(syncLanguage());
106 | return Promise.resolve();
107 | };
108 |
109 | export const refreshIfNeeded = (): AppThunk> => async (dispatch, getState) => {
110 | const data = getState().data;
111 | const justUpdated = new Date().getTime() - data.lastUpdateTime.getTime() <= 15 * 60 * 1000;
112 | if (data.updateFinished && justUpdated) {
113 | enqueueSnackbar(t`离上次成功刷新不足15分钟，若需要可手动刷新`, { variant: 'info' });
114 | } else {
115 | await dispatch(refresh());
116 | }
117 | };
118 |
119 | export const refresh = (): AppThunk> => async (dispatch, getState) => {
120 | dispatch(setLoadingProgress(0));
121 | const helperState = getState().helper;
122 | const helper = helperState.helper;
123 |
124 | let allCourseIds: string[] = [];
125 |
126 | const progresses = [0, 10, 20, 38, 52, 68, 84, 100];
127 | const nextProgress = () => {
128 | const uiState = getState().ui;
129 | const currentProgress = uiState.loadingProgress!;
130 | const index = progresses.indexOf(currentProgress);
131 | let nextProgress = 100;
132 | if (index >= 0 && index < progresses.length) {
133 | nextProgress = progresses[index + 1];
134 | } else {
135 | console.warn(`Next progress not found, current ${currentProgress}`, progresses);
136 | }
137 | dispatch(setLoadingProgress(nextProgress));
138 | };
139 |
140 | try {
141 | // login on every refresh (if stored)
142 | const credential = await getStoredCredential();
143 | credential && (await helper.login(credential.username, credential.password));
144 | dispatch(loggedIn());
145 |
146 | const semesters = await helper.getSemesterIdList();
147 | dispatch(updateSemesterList(semesters));
148 |
149 | const s = await helper.getCurrentSemester();
150 | dispatch(newSemester(s));
151 |
152 | // user required to ignore semester problem
153 | const data = getState().data;
154 | const ui = getState().ui;
155 | const ignoreSemester = data.insistSemester || ui.ignoreWrongSemester;
156 |
157 | if (data.semester.type === SemesterType.UNKNOWN) {
158 | // no semester info yet
159 | dispatch(updateSemester(s));
160 | } else if (s.id !== data.semester.id && !ignoreSemester) {
161 | // stored semester differ with fetched one
162 | dispatch(toggleNewSemesterDialog(true));
163 | return;
164 | }
165 |
166 | nextProgress();
167 |
168 | // get the latest semester id, since it can either be changed or not
169 | const currentSemesterId = getState().data.semester.id;
170 | // get all courses
171 | const courses = await helper.getCourseList(currentSemesterId);
172 | allCourseIds = courses.map((c) => c.id);
173 | dispatch(updateCourses(courses));
174 |
175 | dispatch(updateCourseNames());
176 | nextProgress();
177 | } catch (e) {
178 | console.error(e);
179 | dispatch(setLoadingProgress());
180 | dispatch(toggleNetworkErrorDialog(true));
181 | return;
182 | }
183 |
184 | // send all requests in parallel
185 | const fetchAll = [
186 | async () => {
187 | const res = await helper.getAllContents(
188 | allCourseIds,
189 | ContentType.NOTIFICATION,
190 | CourseType.STUDENT,
191 | true,
192 | );
193 | dispatch(updateNotification(res));
194 | nextProgress();
195 | },
196 | async () => {
197 | const res = await helper.getAllContents(
198 | allCourseIds,
199 | ContentType.HOMEWORK,
200 | CourseType.STUDENT,
201 | true,
202 | );
203 | dispatch(updateHomework(res));
204 | nextProgress();
205 | },
206 | async () => {
207 | const res = await helper.getAllContents(
208 | allCourseIds,
209 | ContentType.FILE,
210 | CourseType.STUDENT,
211 | true,
212 | );
213 | dispatch(updateFile(res));
214 | nextProgress();
215 | },
216 | async () => {
217 | const res = await helper.getAllContents(
218 | allCourseIds,
219 | ContentType.DISCUSSION,
220 | CourseType.STUDENT,
221 | true,
222 | );
223 | dispatch(updateDiscussion(res));
224 | nextProgress();
225 | },
226 | async () => {
227 | const res = await helper.getAllContents(
228 | allCourseIds,
229 | ContentType.QUESTION,
230 | CourseType.STUDENT,
231 | true,
232 | );
233 | dispatch(updateQuestion(res));
234 | nextProgress();
235 | },
236 | ];
237 |
238 | // check results
239 | const failures = (await Promise.allSettled(fetchAll.map((f) => f()))).filter(
240 | (p) => p.status === 'rejected',
241 | );
242 | const allSuccess = failures.length === 0;
243 | if (allSuccess) {
244 | enqueueSnackbar(t`更新成功`, { variant: 'success' });
245 | } else {
246 | enqueueSnackbar(t`部分内容更新失败`, { variant: 'warning' });
247 | console.warn('Failures occurred in fetching data', failures);
248 | }
249 |
250 | // finish refreshing
251 | dispatch(updateFinished());
252 | dispatch(refreshCardList());
253 |
254 | // wait some time before hiding progress bar
255 | new Promise((resolve) => {
256 | setTimeout(() => {
257 | dispatch(setLoadingProgress());
258 | resolve();
259 | }, 1000);
260 | });
261 | };
262 |
263 | export const syncLanguage = (): AppThunk> => async (_dispatch, getState) => {
264 | // try to sync language with Web Learning
265 | const { helper } = getState().helper;
266 | try {
267 | await helper.setLanguage(i18n.locale as Language);
268 | } catch (e) {
269 | const error = e as ApiError;
270 | enqueueSnackbar(
271 | t`设置网络学堂语言失败：${
272 | failReasonToString(error?.reason) ?? error.toString() ?? t`未知错误`
273 | }`,
274 | { variant: 'error' },
275 | );
276 | }
277 | };
278 |
279 | export const updateCourseNames = (): AppThunk => (_dispatch, getState) => {
280 | const { courseMap } = getState().data;
281 | // load course names to i18n
282 | i18n.load(
283 | 'zh',
284 | Object.fromEntries(
285 | Object.values(courseMap).map(({ id, chineseName }) => [
286 | `course-${id}`,
287 | compileMessage(chineseName),
288 | ]),
289 | ),
290 | );
291 | i18n.load(
292 | 'en',
293 | Object.fromEntries(
294 | Object.values(courseMap).map(({ id, englishName }) => [
295 | `course-${id}`,
296 | compileMessage(englishName),
297 | ]),
298 | ),
299 | );
300 | };
301 |
302 | const compareBoolean = (a: boolean, b: boolean) => {
303 | if (a === b) return 0;
304 | if (a) return -1;
305 | if (b) return 1;
306 | };
307 |
308 | export const refreshCardList = (): AppThunk => (dispatch, getState) => {
309 | const state = getState();
310 | const data = selectDataLists(state);
311 | const contentIgnore = selectContentIgnore(state);
312 | const { type, courseId } = state.ui.cardFilter;
313 |
314 | let contents: ContentInfo[];
315 | if (type && type !== 'ignored') {
316 | contents = data[`${type}List`].slice(0);
317 | } else {
318 | contents = ([] as ContentInfo[]).concat(
319 | data.notificationList,
320 | data.fileList,
321 | data.homeworkList,
322 | data.discussionList,
323 | data.questionList,
324 | );
325 | }
326 |
327 | dispatch(
328 | setCardList(
329 | contents
330 | .filter((c) =>
331 | type === 'ignored'
332 | ? c.ignored
333 | : courseId
334 | ? c.courseId === courseId
335 | : !contentIgnore[c.courseId]?.[c.type] && !c.ignored,
336 | )
337 | .sort((a, b) => {
338 | const aNotDue =
339 | a.type === ContentType.HOMEWORK && a.date.getTime() > new Date().getTime();
340 | const bNotDue =
341 | b.type === ContentType.HOMEWORK && b.date.getTime() > new Date().getTime();
342 | return (
343 | compareBoolean(a.starred, b.starred) ||
344 | compareBoolean(!a.hasRead, !b.hasRead) ||
345 | compareBoolean(aNotDue, bNotDue) ||
346 | compareBoolean(aNotDue && !a.submitted, bNotDue && !b.submitted) ||
347 | (a.date.getTime() - b.date.getTime()) * (aNotDue && bNotDue ? 1 : -1)
348 | );
349 | })
350 | .map(({ type, id }) => ({ type, id })),
351 | ),
352 | );
353 | dispatch(resetCardVisibilityThreshold());
354 | };
355 |
356 | export const downloadAllUnreadFiles =
357 | (contents: ContentInfo[]): AppThunk> =>
358 | async (dispatch, getState) => {
359 | const helper = getState().helper.helper;
360 | try {
361 | await helper.getSemesterIdList();
362 | } catch (e) {
363 | enqueueSnackbar(t`登录已过期，请刷新后重试`, { variant: 'error' });
364 | return;
365 | }
366 | for (const c of contents) {
367 | if (c.type === ContentType.FILE && !c.hasRead) {
368 | const file = c as FileInfo;
369 | initiateFileDownload(file.downloadUrl);
370 | dispatch(toggleReadState({ id: file.id, type: ContentType.FILE, state: true }));
371 | }
372 | }
373 | };
374 |
375 | export interface LoadResult {
376 | navigate?: 'readme' | 'changelog';
377 | }
378 |
379 | export const loadApp = (): AppThunk> => async (dispatch) => {
380 | if (import.meta.env.DEV) {
381 | const { VITE_USERNAME: username, VITE_PASSWORD: password } = import.meta.env;
382 | if (username && password) {
383 | await browser.storage.local.set({ [STORAGE_KEY_VERSION]: currentVersion });
384 | await storeCredential(username, password);
385 | }
386 | }
387 |
388 | const { [STORAGE_KEY_VERSION]: oldVersion, [STORAGE_KEY_REDUX]: oldData } =
389 | await browser.storage.local.get([STORAGE_KEY_VERSION, STORAGE_KEY_REDUX]);
390 |
391 | const result: LoadResult = {};
392 |
393 | if (oldVersion === undefined) {
394 | // migrate from version < 4.0.0 or newly installed, clearing all data
395 | console.info('Migrating from legacy version, all data cleaned');
396 | await browser.storage.local.clear();
397 | await browser.storage.local.set({
398 | [STORAGE_KEY_VERSION]: currentVersion,
399 | });
400 | result.navigate = 'readme';
401 | enqueueSnackbar(t`升级成功，所有本地数据已经被清除`, { variant: 'warning' });
402 | } else if (oldVersion !== currentVersion) {
403 | // for future migration
404 | result.navigate = 'changelog';
405 | // set stored version to current one
406 | console.info(`Migrating from version ${oldVersion} to ${currentVersion}`);
407 | await browser.storage.local.set({
408 | [STORAGE_KEY_VERSION]: currentVersion,
409 | });
410 |
411 | // migrate from < 4.5, clearing all data except credential & config
412 | if (compareVersion(oldVersion, '4.5.0', '<')) {
413 | dispatch(clearFetchedData());
414 | enqueueSnackbar(t`升级成功，所有本地数据（除配置）已经被清除`, { variant: 'warning' });
415 | } else {
416 | try {
417 | if (compareVersion(oldVersion, '4.6.0', '<')) {
418 | dispatch(
419 | loadData(
420 | JSON.parse(
421 | JSON.parse(
422 | JSON.parse(
423 | (await browser.storage.local.get([STORAGE_KEY_REDUX_LEGACY]))[
424 | STORAGE_KEY_REDUX_LEGACY
425 | ],
426 | ).data,
427 | ),
428 | (key, value) => {
429 | if (typeof value === 'object' && '$jsan' in value) {
430 | // parse jsan
431 | // from https://github.com/kolodny/jsan/blob/7216568a9a7969dfa81b834236595e862fdde984/lib/utils.js#L23C48-L23C48
432 | const type = value.$jsan[0];
433 | const rest = value.$jsan.slice(1);
434 | if (type === 'd') return new Date(+rest);
435 | if (type === 'u') return undefined;
436 | // other types is not needed;
437 | }
438 | if (key.endsWith('Map')) return value.data;
439 | return value;
440 | },
441 | ),
442 | ),
443 | );
444 | }
445 | enqueueSnackbar(t`升级成功，数据没有受到影响`, { variant: 'info' });
446 | } catch (e) {
447 | await browser.storage.local.clear();
448 | enqueueSnackbar(t`迁移失败，已清除全部数据`, { variant: 'error' });
449 | }
450 | }
451 | } else {
452 | console.info('Migration not necessary.');
453 |
454 | if (oldData !== undefined) {
455 | try {
456 | dispatch(
457 | loadData(
458 | JSON.parse(oldData, (key, value) => {
459 | if (
460 | key === 'date' ||
461 | key === 'deadline' ||
462 | key.endsWith('Date') ||
463 | key.endsWith('Time')
464 | )
465 | return new Date(value);
466 | return value;
467 | }),
468 | ),
469 | );
470 | } catch (e) {
471 | await browser.storage.local.remove(STORAGE_KEY_REDUX);
472 | enqueueSnackbar(t`加载数据失败，已清除数据`, { variant: 'error' });
473 | }
474 | }
475 | }
476 |
477 | dispatch(updateCourseNames());
478 | dispatch(refreshCardList());
479 | dispatch(tryLoginSilently());
480 | return result;
481 | };
482 |
483 | export const tryLoginSilently = (): AppThunk> => async (dispatch) => {
484 | const credential = await getStoredCredential();
485 | if (!credential) {
486 | dispatch(toggleLoginDialog(true));
487 | return;
488 | }
489 | try {
490 | await dispatch(login(credential.username, credential.password, false));
491 | await dispatch(refreshIfNeeded());
492 | } catch (e) {
493 | // here we catch only login problems
494 | // for refresh() has a try-catch block in itself
495 | dispatch(toggleNetworkErrorDialog(true));
496 | }
497 | };
498 |
--------------------------------------------------------------------------------
/src/redux/hooks.ts:
--------------------------------------------------------------------------------
1 | import { type TypedUseSelectorHook, useDispatch, useSelector } from 'react-redux';
2 | import type { AppDispatch, RootState } from './store';
3 |
4 | // Use throughout your app instead of plain `useDispatch` and `useSelector`
5 | export const useAppDispatch: () => AppDispatch = useDispatch;
6 | export const useAppSelector: TypedUseSelectorHook = useSelector;
7 |
--------------------------------------------------------------------------------
/src/redux/reducers/data.ts:
--------------------------------------------------------------------------------
1 | import { type PayloadAction, createSlice } from '@reduxjs/toolkit';
2 | import {
3 | ContentType,
4 | type CourseContent,
5 | type CourseInfo,
6 | type Homework,
7 | type SemesterInfo,
8 | SemesterType,
9 | } from 'thu-learn-lib';
10 |
11 | import type {
12 | DiscussionInfo,
13 | FileInfo,
14 | HomeworkInfo,
15 | NotificationInfo,
16 | QuestionInfo,
17 | SupportedContentType,
18 | } from '../../types/data';
19 |
20 | interface IContentIgnore {
21 | [courseId: string]: {
22 | [type: string]: boolean;
23 | };
24 | }
25 |
26 | export interface DataState {
27 | semesters: string[]; // all available semesters return by Web Learning
28 | semester: SemesterInfo; // current semester of Learn Helper
29 | fetchedSemester: SemesterInfo; // current semester of Web Learning
30 | insistSemester: boolean;
31 | courseMap: Record;
32 | notificationMap: Record;
33 | fileMap: Record;
34 | homeworkMap: Record;
35 | discussionMap: Record;
36 | questionMap: Record;
37 | lastUpdateTime: Date;
38 | updateFinished: boolean;
39 | contentIgnore: IContentIgnore;
40 | }
41 |
42 | const semesterPlaceholder: SemesterInfo = {
43 | id: '',
44 | startDate: new Date(),
45 | endDate: new Date(),
46 | startYear: 0,
47 | endYear: 0,
48 | type: SemesterType.UNKNOWN,
49 | };
50 |
51 | const initialState: DataState = {
52 | semesters: [],
53 | semester: semesterPlaceholder,
54 | fetchedSemester: semesterPlaceholder,
55 | insistSemester: false,
56 | courseMap: {},
57 | notificationMap: {},
58 | fileMap: {},
59 | homeworkMap: {},
60 | discussionMap: {},
61 | questionMap: {},
62 | lastUpdateTime: new Date(0),
63 | updateFinished: false,
64 | contentIgnore: {},
65 | };
66 |
67 | function update(
68 | state: DataState,
69 | contentType: T,
70 | fetchedData: CourseContent,
71 | ) {
72 | const oldData = state[`${contentType}Map`];
73 |
74 | const result = {} as typeof oldData;
75 | const dateKeyMap = {
76 | [ContentType.NOTIFICATION]: 'publishTime',
77 | [ContentType.FILE]: 'uploadTime',
78 | [ContentType.HOMEWORK]: 'deadline',
79 | [ContentType.DISCUSSION]: 'publishTime',
80 | [ContentType.QUESTION]: 'publishTime',
81 | } as const;
82 | const dateKey = dateKeyMap[contentType];
83 |
84 | // we always use the fetched data
85 | for (const [cid, contents] of Object.entries(fetchedData)) {
86 | for (const c of contents) {
87 | // compare the time of two contents (including undefined)
88 | // if they differ, mark the content as unread
89 | const oldContent = oldData[c.id];
90 | // FIXME: type issues
91 | const newDate = c[dateKey];
92 | let updated = true;
93 | if (oldContent) {
94 | if (newDate.getTime() === oldContent[dateKey].getTime()) {
95 | // the date is not modified
96 | updated = false;
97 | if (contentType === ContentType.HOMEWORK) {
98 | const oldGradeTime = (oldContent as Homework).gradeTime;
99 | const newGradeTime = (c as Homework).gradeTime;
100 | if (newGradeTime && !oldGradeTime) {
101 | // newly-graded homework
102 | updated = true;
103 | } else if (
104 | newGradeTime &&
105 | oldGradeTime &&
106 | // re-graded homework
107 | newGradeTime.getTime() !== oldGradeTime.getTime()
108 | ) {
109 | updated = true;
110 | }
111 | }
112 | }
113 | }
114 | // copy other attributes either way
115 | result[c.id] = {
116 | ...c,
117 | courseId: cid,
118 | ignored: oldContent?.ignored ?? false,
119 | type: contentType,
120 | date: newDate,
121 | hasRead: !updated && (oldContent?.hasRead ?? false),
122 | starred: oldContent?.starred ?? false,
123 | };
124 | }
125 | }
126 |
127 | state[`${contentType}Map`] = result;
128 | }
129 |
130 | interface ToggleStatePayload {
131 | id: string;
132 | type: SupportedContentType;
133 | state: boolean;
134 | }
135 |
136 | const IGNORE_UNSET_ALL = {
137 | [ContentType.NOTIFICATION]: false,
138 | [ContentType.FILE]: false,
139 | [ContentType.HOMEWORK]: false,
140 | [ContentType.QUESTION]: false,
141 | [ContentType.DISCUSSION]: false,
142 | };
143 |
144 | export const dataSlice = createSlice({
145 | name: 'data',
146 | initialState,
147 | reducers: {
148 | newSemester: (state, action: PayloadAction) => {
149 | state.fetchedSemester = action.payload;
150 | },
151 | insistSemester: (state, action: PayloadAction) => {
152 | state.insistSemester = action.payload;
153 | },
154 | updateSemesterList: (state, action: PayloadAction) => {
155 | state.semesters = action.payload;
156 | },
157 | updateSemester: (state, action: PayloadAction) => {
158 | state.semester = action.payload;
159 | },
160 | syncSemester: (state) => {
161 | state.semester = state.fetchedSemester;
162 | },
163 | updateCourses: (state, action: PayloadAction) => {
164 | action.payload.sort((a, b) => a.id.localeCompare(b.id));
165 | state.courseMap = Object.fromEntries(action.payload.map((course) => [course.id, course]));
166 | for (const cid of Object.keys(state.contentIgnore)) {
167 | if (!state.courseMap[cid]) delete state.contentIgnore[cid];
168 | }
169 | for (const cid of Object.keys(state.courseMap)) {
170 | state.contentIgnore[cid] ??= { ...IGNORE_UNSET_ALL };
171 | }
172 | },
173 | updateNotification: (state, action: PayloadAction>) => {
174 | update(state, ContentType.NOTIFICATION, action.payload);
175 | state.lastUpdateTime = new Date();
176 | state.updateFinished = false;
177 | },
178 | updateFile: (state, action: PayloadAction>) => {
179 | update(state, ContentType.FILE, action.payload);
180 | state.lastUpdateTime = new Date();
181 | state.updateFinished = false;
182 | },
183 | updateHomework: (state, action: PayloadAction>) => {
184 | update(state, ContentType.HOMEWORK, action.payload);
185 | state.lastUpdateTime = new Date();
186 | state.updateFinished = false;
187 | },
188 | updateDiscussion: (state, action: PayloadAction>) => {
189 | update(state, ContentType.DISCUSSION, action.payload);
190 | state.lastUpdateTime = new Date();
191 | state.updateFinished = false;
192 | },
193 | updateQuestion: (state, action: PayloadAction>) => {
194 | update(state, ContentType.QUESTION, action.payload);
195 | state.lastUpdateTime = new Date();
196 | state.updateFinished = false;
197 | },
198 | updateFinished: (state) => {
199 | state.updateFinished = true;
200 | },
201 | toggleReadState: (state, action: PayloadAction) => {
202 | state[`${action.payload.type}Map`][action.payload.id].hasRead = action.payload.state;
203 | },
204 | toggleStarState: (state, action: PayloadAction) => {
205 | state[`${action.payload.type}Map`][action.payload.id].starred = action.payload.state;
206 | },
207 | toggleIgnoreState: (state, action: PayloadAction) => {
208 | state[`${action.payload.type}Map`][action.payload.id].ignored = action.payload.state;
209 | },
210 | toggleContentIgnore: (state, action: PayloadAction) => {
211 | state.contentIgnore[action.payload.id][action.payload.type] = action.payload.state;
212 | },
213 | resetContentIgnore: (state) => {
214 | state.contentIgnore = Object.fromEntries(
215 | Object.keys(state.courseMap).map((cid) => [cid, { ...IGNORE_UNSET_ALL }]),
216 | );
217 | state.updateFinished = false;
218 | },
219 | markAllRead: (state) => {
220 | for (const c of Object.values(state.notificationMap)) c.hasRead = true;
221 | for (const c of Object.values(state.fileMap)) c.hasRead = true;
222 | for (const c of Object.values(state.homeworkMap)) c.hasRead = true;
223 | for (const c of Object.values(state.discussionMap)) c.hasRead = true;
224 | for (const c of Object.values(state.questionMap)) c.hasRead = true;
225 | },
226 | clearAllData: () => {
227 | return initialState;
228 | },
229 | clearFetchedData: (state) => {
230 | state.courseMap = {};
231 | state.notificationMap = {};
232 | state.fileMap = {};
233 | state.homeworkMap = {};
234 | state.discussionMap = {};
235 | state.questionMap = {};
236 | state.lastUpdateTime = new Date(0);
237 | },
238 | loadData: (_state, action: PayloadAction>) => {
239 | return { ...initialState, ...action.payload };
240 | },
241 | },
242 | });
243 |
244 | export default dataSlice.reducer;
245 |
--------------------------------------------------------------------------------
/src/redux/reducers/helper.ts:
--------------------------------------------------------------------------------
1 | import { createSlice } from '@reduxjs/toolkit';
2 | import { type HelperConfig, Learn2018Helper } from 'thu-learn-lib';
3 |
4 | export interface HelperState {
5 | helper: Learn2018Helper;
6 | loggedIn: boolean;
7 | }
8 |
9 | const config: HelperConfig = {};
10 |
11 | const initialState: HelperState = {
12 | helper: new Learn2018Helper(config),
13 | loggedIn: false,
14 | };
15 |
16 | export const helperSlice = createSlice({
17 | name: 'helper',
18 | initialState,
19 | reducers: {
20 | loggedIn: (state) => {
21 | state.loggedIn = true;
22 | },
23 | loggedOut: (state) => {
24 | state.helper = new Learn2018Helper(config);
25 | state.loggedIn = false;
26 | },
27 | },
28 | });
29 |
30 | export default helperSlice.reducer;
31 |
--------------------------------------------------------------------------------
/src/redux/reducers/ui.ts:
--------------------------------------------------------------------------------
1 | import { type PayloadAction, createSlice } from '@reduxjs/toolkit';
2 |
3 | import { CARD_BATCH_LOAD_SIZE } from '../../constants';
4 | import type { SupportedContentType } from '../../types/data';
5 |
6 | interface CardEntry {
7 | type: SupportedContentType;
8 | id: string;
9 | }
10 | interface CardFilter {
11 | type?: SupportedContentType | 'ignored';
12 | courseId?: string;
13 | }
14 |
15 | export interface UiState {
16 | loadingProgress?: number;
17 | paneHidden: boolean;
18 | showLoginDialog: boolean;
19 | inLoginProgress: boolean;
20 | showNetworkErrorDialog: boolean;
21 | showNewSemesterDialog: boolean;
22 | showChangeSemesterDialog: boolean;
23 | ignoreWrongSemester: boolean;
24 | showLogoutDialog: boolean;
25 | showClearDataDialog: boolean;
26 | cardVisibilityThreshold: number;
27 | cardList: CardEntry[];
28 | cardFilter: CardFilter;
29 | titleFilter?: string;
30 | }
31 |
32 | const initialState: UiState = {
33 | loadingProgress: undefined,
34 | paneHidden: false,
35 | showLoginDialog: false,
36 | inLoginProgress: false,
37 | showNetworkErrorDialog: false,
38 | showNewSemesterDialog: false,
39 | ignoreWrongSemester: false,
40 | showLogoutDialog: false,
41 | showClearDataDialog: false,
42 | showChangeSemesterDialog: false,
43 | cardVisibilityThreshold: CARD_BATCH_LOAD_SIZE,
44 | cardList: [],
45 | cardFilter: {},
46 | titleFilter: undefined,
47 | };
48 |
49 | export const uiSlice = createSlice({
50 | name: 'ui',
51 | initialState,
52 | reducers: {
53 | setLoadingProgress: (state, action: PayloadAction) => {
54 | state.loadingProgress = action.payload;
55 | },
56 | togglePaneHidden: (state, action: PayloadAction) => {
57 | state.paneHidden = action.payload;
58 | },
59 | toggleLoginDialog: (state, action: PayloadAction) => {
60 | state.showLoginDialog = action.payload;
61 | },
62 | toggleLoginDialogProgress: (state, action: PayloadAction) => {
63 | state.inLoginProgress = action.payload;
64 | },
65 | loginEnd: (state) => {
66 | state.showLoginDialog = false;
67 | state.inLoginProgress = false;
68 | },
69 | toggleNetworkErrorDialog: (state, action: PayloadAction) => {
70 | state.showNetworkErrorDialog = action.payload;
71 | },
72 | toggleNewSemesterDialog: (state, action: PayloadAction) => {
73 | state.showNewSemesterDialog = action.payload;
74 | },
75 | toggleIgnoreWrongSemester: (state, action: PayloadAction) => {
76 | state.ignoreWrongSemester = action.payload;
77 | },
78 | toggleLogoutDialog: (state, action: PayloadAction) => {
79 | state.showLogoutDialog = action.payload;
80 | },
81 | toggleClearDataDialog: (state, action: PayloadAction) => {
82 | state.showClearDataDialog = action.payload;
83 | },
84 | toggleChangeSemesterDialog: (state, action: PayloadAction) => {
85 | state.showChangeSemesterDialog = action.payload;
86 | },
87 | resetCardVisibilityThreshold: (state) => {
88 | state.cardVisibilityThreshold = CARD_BATCH_LOAD_SIZE;
89 | },
90 | loadMoreCard: (state) => {
91 | state.cardVisibilityThreshold += CARD_BATCH_LOAD_SIZE;
92 | },
93 | setCardList: (state, action: PayloadAction) => {
94 | state.cardList = action.payload;
95 | },
96 | setCardFilter: (state, action: PayloadAction) => {
97 | state.cardFilter = action.payload;
98 | },
99 | setTitleFilter: (state, action: PayloadAction) => {
100 | state.titleFilter = action.payload;
101 | },
102 | },
103 | });
104 |
105 | export default uiSlice.reducer;
106 |
--------------------------------------------------------------------------------
/src/redux/selectors.ts:
--------------------------------------------------------------------------------
1 | import type { MessageDescriptor } from '@lingui/core';
2 | import { msg } from '@lingui/core/macro';
3 | import { memoize } from 'proxy-memoize';
4 | import { ContentType } from 'thu-learn-lib';
5 |
6 | import { UI_NAME_COURSE, UI_NAME_SUMMARY } from '../constants/ui';
7 | import type { ContentInfo } from '../types/data';
8 | import type { RootState } from './store';
9 |
10 | export const selectCourseList = memoize((state: RootState) => Object.values(state.data.courseMap));
11 |
12 | export const selectNotificationList = memoize((state: RootState) =>
13 | Object.values(state.data.notificationMap),
14 | );
15 | export const selectFileList = memoize((state: RootState) => Object.values(state.data.fileMap));
16 | export const selectHomeworkList = memoize((state: RootState) =>
17 | Object.values(state.data.homeworkMap),
18 | );
19 | export const selectDiscussionList = memoize((state: RootState) =>
20 | Object.values(state.data.discussionMap),
21 | );
22 | export const selectQuestionList = memoize((state: RootState) =>
23 | Object.values(state.data.questionMap),
24 | );
25 | export const selectDataLists = memoize((state: RootState) => ({
26 | notificationList: selectNotificationList(state),
27 | fileList: selectFileList(state),
28 | homeworkList: selectHomeworkList(state),
29 | discussionList: selectDiscussionList(state),
30 | questionList: selectQuestionList(state),
31 | }));
32 |
33 | export const selectContentIgnore = (state: RootState) => state.data.contentIgnore;
34 |
35 | export const selectUnreadMap = memoize((state: RootState) => {
36 | const { notificationList, fileList, homeworkList, discussionList, questionList } =
37 | selectDataLists(state);
38 | const contentIgnore = selectContentIgnore(state);
39 |
40 | const count = (type: ContentType, list: ContentInfo[]) =>
41 | list.reduce(
42 | (cnt, c) =>
43 | cnt +
44 | Number(
45 | !c.ignored &&
46 | contentIgnore[c.courseId]?.[type] === false &&
47 | (!c.hasRead || // all unread content
48 | // unfinished homework before deadline
49 | (c.type === ContentType.HOMEWORK &&
50 | !c.submitted &&
51 | c?.deadline?.getTime() > new Date().getTime())),
52 | ),
53 | 0,
54 | );
55 |
56 | return state.helper.loggedIn
57 | ? {
58 | notification: count(ContentType.NOTIFICATION, notificationList),
59 | file: count(ContentType.FILE, fileList),
60 | homework: count(ContentType.HOMEWORK, homeworkList),
61 | discussion: count(ContentType.DISCUSSION, discussionList),
62 | question: count(ContentType.QUESTION, questionList),
63 | ignored: 0,
64 | }
65 | : {};
66 | });
67 |
68 | export const selectSemesters = memoize((state: RootState) => {
69 | const { semesters, fetchedSemester } = state.data;
70 | if (!semesters.includes(fetchedSemester.id)) return [fetchedSemester.id, ...semesters];
71 | return semesters;
72 | });
73 |
74 | export const selectCardListTitle = memoize((state: RootState): MessageDescriptor[] => {
75 | if (state.helper.loggedIn) {
76 | if (state.ui.cardFilter.courseId && state.ui.cardFilter.type !== 'ignored') {
77 | return [
78 | UI_NAME_COURSE[state.ui.cardFilter.type ?? 'summary'],
79 | { id: `course-${state.ui.cardFilter.courseId}` },
80 | ];
81 | }
82 | return [UI_NAME_SUMMARY[state.ui.cardFilter.type ?? 'summary']];
83 | }
84 | return [msg`加载中...`];
85 | });
86 |
--------------------------------------------------------------------------------
/src/redux/store.ts:
--------------------------------------------------------------------------------
1 | import {
2 | type Action,
3 | type TypedStartListening,
4 | configureStore,
5 | createListenerMiddleware,
6 | } from '@reduxjs/toolkit';
7 | import logger from 'redux-logger';
8 |
9 | import { STORAGE_KEY_REDUX } from '../constants';
10 | import data from './reducers/data';
11 | import helper from './reducers/helper';
12 | import ui from './reducers/ui';
13 |
14 | const listenerMiddleware = createListenerMiddleware();
15 |
16 | export const store = configureStore({
17 | reducer: {
18 | data,
19 | helper,
20 | ui,
21 | },
22 | middleware: (getDefaultMiddleware) =>
23 | getDefaultMiddleware({ serializableCheck: false })
24 | .prepend(listenerMiddleware.middleware)
25 | .concat(logger),
26 | });
27 |
28 | export type RootState = ReturnType;
29 | export type AppDispatch = typeof store.dispatch;
30 |
31 | export type AppStartListening = TypedStartListening;
32 | export const startAppListening = listenerMiddleware.startListening as AppStartListening;
33 |
34 | startAppListening({
35 | matcher: (action: Action): action is Action =>
36 | typeof action.type === 'string' && action.type.startsWith('data/'),
37 | effect: (_action, { getState }) => {
38 | const { data } = getState();
39 | browser.storage.local.set({ [STORAGE_KEY_REDUX]: JSON.stringify(data) });
40 | },
41 | });
42 |
--------------------------------------------------------------------------------
/src/theme.ts:
--------------------------------------------------------------------------------
1 | import { createTheme } from '@mui/material';
2 |
3 | export const theme = createTheme({
4 | colorSchemes: { light: true, dark: true },
5 | cssVariables: {
6 | colorSchemeSelector: 'data',
7 | },
8 | });
9 |
--------------------------------------------------------------------------------
/src/types/data.ts:
--------------------------------------------------------------------------------
1 | import type {
2 | ContentType,
3 | Discussion,
4 | File,
5 | Homework,
6 | Notification,
7 | Question,
8 | } from 'thu-learn-lib';
9 |
10 | interface ICourseRef {
11 | courseId: string;
12 | }
13 |
14 | interface ICardStatus {
15 | type: ContentType;
16 | id: string;
17 | date: Date;
18 | hasRead: boolean;
19 | starred: boolean;
20 | ignored: boolean;
21 | }
22 |
23 | type ICardData = ICourseRef & ICardStatus;
24 |
25 | export interface NotificationInfo extends Notification, ICardData {
26 | type: ContentType.NOTIFICATION;
27 | }
28 | export interface HomeworkInfo extends Homework, ICardData {
29 | type: ContentType.HOMEWORK;
30 | }
31 | export interface FileInfo extends File, ICardData {
32 | type: ContentType.FILE;
33 | }
34 | export interface DiscussionInfo extends Discussion, ICardData {
35 | type: ContentType.DISCUSSION;
36 | }
37 | export interface QuestionInfo extends Question, ICardData {
38 | type: ContentType.QUESTION;
39 | }
40 |
41 | export type ContentInfo =
42 | | NotificationInfo
43 | | HomeworkInfo
44 | | FileInfo
45 | | DiscussionInfo
46 | | QuestionInfo;
47 |
48 | export type SupportedContentType = Exclude;
49 |
--------------------------------------------------------------------------------
/src/types/ui.ts:
--------------------------------------------------------------------------------
1 | export type ColorMode = 'system' | 'light' | 'dark';
2 |
--------------------------------------------------------------------------------
/src/utils/console.ts:
--------------------------------------------------------------------------------
1 | const MESSAGE_FORMAT = 'color: blue; font-size: larger';
2 |
3 | export const printWelcomeMessage = () => {
4 | console.log('%c欢迎使用 Learn Helper！', MESSAGE_FORMAT);
5 | console.log('%c诚邀一起参与开发工作，详见 GitHub Harry-Chen/Learn-Helper', MESSAGE_FORMAT);
6 | };
7 |
--------------------------------------------------------------------------------
/src/utils/crypto.ts:
--------------------------------------------------------------------------------
1 | const textToChars = (text: string) => text.split('').map((c) => c.charCodeAt(0));
2 | const byteHex = (n: number) => `0${Number(n).toString(16)}`.slice(-2);
3 | const applySaltToChar = (salt: string) => (code: number) =>
4 | textToChars(salt).reduce((a, b) => a ^ b, code);
5 |
6 | export const cipher = (salt: string) => (text: string) =>
7 | textToChars(text).map(applySaltToChar(salt)).map(byteHex).join('');
8 |
9 | export const decipher = (salt: string) => (encoded: string) =>
10 | encoded
11 | .match(/.{1,2}/g)!
12 | .map((hex) => Number.parseInt(hex, 16))
13 | .map(applySaltToChar(salt))
14 | .map((charCode) => String.fromCharCode(charCode))
15 | .join('');
16 |
--------------------------------------------------------------------------------
/src/utils/csrf.ts:
--------------------------------------------------------------------------------
1 | const id = 1;
2 |
3 | export async function interceptCsrfRequest(csrf: string) {
4 | if (await browser.permissions.contains({ permissions: ['declarativeNetRequest'] })) {
5 | browser.declarativeNetRequest.updateDynamicRules({ removeRuleIds: [id] });
6 | browser.declarativeNetRequest.updateSessionRules({
7 | removeRuleIds: [id],
8 | addRules: [
9 | {
10 | id,
11 | condition: {
12 | requestDomains: ['learn.tsinghua.edu.cn'],
13 | tabIds: [(await browser.tabs.getCurrent())!.id!],
14 | },
15 | action: {
16 | type: browser.declarativeNetRequest.RuleActionType.REDIRECT,
17 | redirect: {
18 | transform: {
19 | queryTransform: {
20 | // @ts-expect-error wrong type @types/chrome
21 | addOrReplaceParams: [{ key: '_csrf', value: csrf, replaceOnly: true }],
22 | },
23 | },
24 | },
25 | },
26 | },
27 | ],
28 | });
29 | }
30 | }
31 |
--------------------------------------------------------------------------------
/src/utils/download.ts:
--------------------------------------------------------------------------------
1 | export async function initiateFileDownload(url: string, filename?: string) {
2 | try {
3 | const id = await browser.downloads.download({
4 | url,
5 | filename,
6 | });
7 | console.log(`Download ${url} starts with id ${id}`);
8 | } catch (e) {
9 | console.log(`Download ${url} failed: ${e}`);
10 | }
11 | }
12 |
--------------------------------------------------------------------------------
/src/utils/format.ts:
--------------------------------------------------------------------------------
1 | import { type MessageDescriptor, i18n } from '@lingui/core';
2 | import { msg, t } from '@lingui/core/macro';
3 | import {
4 | FailReason,
5 | HomeworkCompletionType,
6 | HomeworkGradeLevel,
7 | HomeworkSubmissionType,
8 | type SemesterInfo,
9 | SemesterType,
10 | } from 'thu-learn-lib';
11 |
12 | export function html2text(html: string): string {
13 | const node = document.createElement('div');
14 | node.innerHTML = html;
15 | return node.innerText.trim();
16 | }
17 |
18 | const semesterName = {
19 | [SemesterType.FALL]: msg`秋季学期`,
20 | [SemesterType.SPRING]: msg`春季学期`,
21 | [SemesterType.SUMMER]: msg`夏季学期`,
22 | };
23 |
24 | export function formatSemester(semester: SemesterInfo): string {
25 | if (semester.type !== SemesterType.UNKNOWN) {
26 | return `${semester.startYear}-${semester.endYear}-${i18n._(semesterName[semester.type])}`;
27 | }
28 | return SemesterType.UNKNOWN;
29 | }
30 |
31 | export function semesterFromId(id: string): SemesterInfo {
32 | let type = SemesterType.UNKNOWN;
33 | switch (id.charAt(id.length - 1)) {
34 | case '1':
35 | type = SemesterType.FALL;
36 | break;
37 | case '2':
38 | type = SemesterType.SPRING;
39 | break;
40 | case '3':
41 | type = SemesterType.SUMMER;
42 | break;
43 | }
44 | return {
45 | id,
46 | startDate: new Date(),
47 | endDate: new Date(),
48 | startYear: Number.parseInt(id.substring(0, 4)),
49 | endYear: Number.parseInt(id.substring(5, 9)),
50 | type,
51 | };
52 | }
53 |
54 | export function formatSemesterId(id: string): string {
55 | return formatSemester(semesterFromId(id));
56 | }
57 |
58 | function zeroPad(num: number, length: number): string {
59 | const zero = length - num.toString().length + 1;
60 | return Array(+(zero > 0 && zero)).join('0') + num;
61 | }
62 |
63 | function toDateString(date: Date, padding: boolean): string {
64 | if (padding) {
65 | return `${date.getFullYear()}-${zeroPad(date.getMonth() + 1, 2)}-${zeroPad(date.getDate(), 2)}`;
66 | }
67 | return `${date.getFullYear()}-${date.getMonth() + 1}-${date.getDate()}`;
68 | }
69 |
70 | function toTimeString(date: Date): string {
71 | return `${zeroPad(date.getHours(), 2)}:${zeroPad(date.getMinutes(), 2)}:${zeroPad(
72 | date.getSeconds(),
73 | 2,
74 | )}`;
75 | }
76 |
77 | export function formatDate(date?: Date): string {
78 | if (date === undefined) {
79 | return t`无`;
80 | }
81 | return `${toDateString(date, false)}`;
82 | }
83 |
84 | export function formatDateTime(date?: Date): string {
85 | if (date === undefined) {
86 | return t`无`;
87 | }
88 | return `${toDateString(date, true)} ${toTimeString(date)}`;
89 | }
90 |
91 | const FAIL_REASON_MAPPING = {
92 | [FailReason.BAD_CREDENTIAL]: msg`用户名或密码错误`,
93 | [FailReason.ERROR_FETCH_FROM_ID]: msg`无法从 id.tsinghua.edu.cn 获取票据`,
94 | [FailReason.ERROR_ROAMING]: msg`无法使用票据漫游至 learn.tsinghua.edu.cn`,
95 | [FailReason.NOT_IMPLEMENTED]: msg`功能尚未实现`,
96 | [FailReason.NOT_LOGGED_IN]: msg`尚未登录`,
97 | [FailReason.NO_CREDENTIAL]: msg`未提供用户名或密码`,
98 | [FailReason.UNEXPECTED_STATUS]: msg`非预期的 HTTP 响应状态`,
99 | [FailReason.INVALID_RESPONSE]: msg`无效的 HTTP 响应`,
100 | [FailReason.OPERATION_FAILED]: msg`操作失败`,
101 | TIMEOUT: msg`请求超时`,
102 | UNKNOWN: msg`未知错误`,
103 | };
104 |
105 | export function failReasonToString(reason: FailReason): string {
106 | return i18n._(FAIL_REASON_MAPPING[reason] ?? FAIL_REASON_MAPPING.UNKNOWN);
107 | }
108 |
109 | const HomeworkGradeLevelNames = {
110 | [HomeworkGradeLevel.CHECKED]: msg`已阅`,
111 | [HomeworkGradeLevel.DISTINCTION]: msg`优秀`,
112 | [HomeworkGradeLevel.EXEMPTED_COURSE]: msg`免课`,
113 | [HomeworkGradeLevel.EXEMPTION]: msg`免修`,
114 | [HomeworkGradeLevel.PASS]: msg`通过`,
115 | [HomeworkGradeLevel.FAILURE]: msg`不通过`,
116 | [HomeworkGradeLevel.INCOMPLETE]: msg`缓考`,
117 | };
118 |
119 | export function formatHomeworkGradeLevel(gradeLevel: HomeworkGradeLevel): MessageDescriptor;
120 | export function formatHomeworkGradeLevel(gradeLevel: undefined): undefined;
121 | export function formatHomeworkGradeLevel(
122 | gradeLevel?: HomeworkGradeLevel,
123 | ): MessageDescriptor | undefined {
124 | if (gradeLevel) {
125 | return gradeLevel in HomeworkGradeLevelNames
126 | ? HomeworkGradeLevelNames[gradeLevel as keyof typeof HomeworkGradeLevelNames]
127 | : { id: gradeLevel };
128 | }
129 | }
130 |
131 | const HomeworkCompletionTypeNames = {
132 | [HomeworkCompletionType.INDIVIDUAL]: msg`每人独立完成一份作业`,
133 | [HomeworkCompletionType.GROUP]: msg`每组共同完成一份作业`,
134 | };
135 |
136 | export function formatHomeworkCompletionType(
137 | completionType: HomeworkCompletionType,
138 | ): MessageDescriptor {
139 | return HomeworkCompletionTypeNames[completionType];
140 | }
141 |
142 | const HomeworkSubmissionTypeNames = {
143 | [HomeworkSubmissionType.WEB_LEARNING]: msg`网络学堂`,
144 | [HomeworkSubmissionType.OFFLINE]: msg`无需在网络学堂提交`,
145 | };
146 |
147 | export function formatHomeworkSubmissionType(
148 | submissionType: HomeworkSubmissionType,
149 | ): MessageDescriptor {
150 | return HomeworkSubmissionTypeNames[submissionType];
151 | }
152 |
--------------------------------------------------------------------------------
/src/utils/permission.ts:
--------------------------------------------------------------------------------
1 | // firefox only issue
2 | export async function requestPermission() {
3 | await browser.permissions.request({
4 | origins: ['*://learn.tsinghua.edu.cn/*', '*://id.tsinghua.edu.cn/*'],
5 | });
6 | }
7 |
--------------------------------------------------------------------------------
/src/utils/storage.ts:
--------------------------------------------------------------------------------
1 | import { STORAGE_KEY_PASSWORD, STORAGE_KEY_USERNAME, STORAGE_SALT } from '../constants';
2 | import { cipher, decipher } from './crypto';
3 |
4 | export async function storeCredential(username: string, password: string) {
5 | const cipherImpl = cipher(STORAGE_SALT);
6 | await browser.storage.local.set({
7 | [STORAGE_KEY_USERNAME]: cipherImpl(username),
8 | [STORAGE_KEY_PASSWORD]: cipherImpl(password),
9 | });
10 | }
11 |
12 | export async function getStoredCredential() {
13 | const res = await browser.storage.local.get([STORAGE_KEY_USERNAME, STORAGE_KEY_PASSWORD]);
14 | const username = res[STORAGE_KEY_USERNAME];
15 | const password = res[STORAGE_KEY_PASSWORD];
16 | if (username !== undefined && password !== undefined) {
17 | const decipherImpl = decipher(STORAGE_SALT);
18 | return {
19 | username: decipherImpl(username),
20 | password: decipherImpl(password),
21 | };
22 | }
23 | return undefined;
24 | }
25 |
26 | export async function removeStoredCredential() {
27 | await browser.storage.local.remove([STORAGE_KEY_USERNAME, STORAGE_KEY_PASSWORD]);
28 | }
29 |
--------------------------------------------------------------------------------
/src/vite-env.d.ts:
--------------------------------------------------------------------------------
1 | ///