@robertying/thu-learn-lib 0.0.0-stage → 5.0.0

package/src/urls.ts

@@ -0,0 +1,257 @@
+import { FormData } from 'node-fetch-native';
+import type { ContentType, IHomeworkSubmitAttachment, QuestionnaireType } from './types.ts';
+import { CourseType, Language } from './types.ts';
+import { CONTENT_TYPE_MAP, getMkFromType } from './utils.ts';
+
+export const ID_PREFIX = 'https://id.tsinghua.edu.cn';
+export const LEARN_PREFIX = 'https://learn.tsinghua.edu.cn';
+export const REGISTRAR_PREFIX = 'https://zhjw.cic.tsinghua.edu.cn';
+
+const MAX_SIZE = 200;
+
+export const ID_LOGIN = () => 'https://id.tsinghua.edu.cn/do/off/ui/auth/login/form/bb5df85216504820be7bba2b0ae1535b/0';
+
+export const ID_LOGIN_CHECK = () => 'https://id.tsinghua.edu.cn/do/off/ui/auth/login/check';
+
+export const LEARN_AUTH_ROAM = (ticket: string) =>
+  `${LEARN_PREFIX}/b/j_spring_security_thauth_roaming_entry?ticket=${ticket}`;
+
+export const LEARN_LOGOUT = () => `${LEARN_PREFIX}/f/j_spring_security_logout`;
+
+export const LEARN_HOMEPAGE = (courseType: CourseType) => {
+  if (courseType === CourseType.STUDENT) {
+    return `${LEARN_PREFIX}/f/wlxt/index/course/student/`;
+  } else {
+    return `${LEARN_PREFIX}/f/wlxt/index/course/teacher/`;
+  }
+};
+
+export const LEARN_STUDENT_COURSE_LIST_PAGE = () => `${LEARN_PREFIX}/f/wlxt/index/course/student/`;
+
+export const LEARN_SEMESTER_LIST = () => `${LEARN_PREFIX}/b/wlxt/kc/v_wlkc_xs_xktjb_coassb/queryxnxq`;
+
+export const LEARN_CURRENT_SEMESTER = () => `${LEARN_PREFIX}/b/kc/zhjw_v_code_xnxq/getCurrentAndNextSemester`;
+
+export const LEARN_COURSE_LIST = (semester: string, courseType: CourseType, lang: Language) =>
+  courseType === CourseType.STUDENT
+    ? `${LEARN_PREFIX}/b/wlxt/kc/v_wlkc_xs_xkb_kcb_extend/student/loadCourseBySemesterId/${semester}/${lang}`
+    : `${LEARN_PREFIX}/b/kc/v_wlkc_kcb/queryAsorCoCourseList/${semester}/0`;
+
+export const LEARN_COURSE_PAGE = (courseID: string, courseType: CourseType) =>
+  `${LEARN_PREFIX}/f/wlxt/index/course/${courseType}/course?wlkcid=${courseID}`;
+
+export const LEARN_COURSE_TIME_LOCATION = (courseID: string) =>
+  `${LEARN_PREFIX}/b/kc/v_wlkc_xk_sjddb/detail?id=${courseID}`;
+
+export const LEARN_FILE_LIST = (courseID: string, courseType: CourseType) =>
+  courseType === CourseType.STUDENT
+    ? `${LEARN_PREFIX}/b/wlxt/kj/wlkc_kjxxb/student/kjxxbByWlkcidAndSizeForStudent?wlkcid=${courseID}&size=${MAX_SIZE}`
+    : `${LEARN_PREFIX}/b/wlxt/kj/v_kjxxb_wjwjb/teacher/queryByWlkcid?wlkcid=${courseID}&size=${MAX_SIZE}`;
+
+export const LEARN_FILE_CATEGORY_LIST = (courseID: string, courseType: CourseType) =>
+  `${LEARN_PREFIX}/b/wlxt/kj/wlkc_kjflb/${courseType}/pageList?wlkcid=${courseID}`;
+
+export const LEARN_FILE_LIST_BY_CATEGORY_STUDENT = (courseID: string, categoryId: string) =>
+  `${LEARN_PREFIX}/b/wlxt/kj/wlkc_kjxxb/student/kjxxb/${courseID}/${categoryId}`;
+
+export const LEARN_FILE_LIST_BY_CATEGORY_TEACHER = `${LEARN_PREFIX}/b/wlxt/kj/v_kjxxb_wjwjb/teacher/pageList`;
+
+export const LEARN_FILE_LIST_BY_CATEGORY_TEACHER_FORM_DATA = (courseID: string, categoryId: string) => {
+  const form = new FormData();
+  form.append(
+    'aoData',
+    JSON.stringify([
+      { name: 'wlkcid', value: courseID },
+      { name: 'kjflid', value: categoryId },
+    ]),
+  );
+  return form;
+};
+
+export const LEARN_FILE_DOWNLOAD = (fileID: string, courseType: CourseType) =>
+  `${LEARN_PREFIX}/b/wlxt/kj/wlkc_kjxxb/${courseType}/downloadFile?sfgk=0&wjid=${fileID}`;
+
+export const LEARN_FILE_PREVIEW = (type: ContentType, fileID: string, courseType: CourseType, firstPageOnly = false) =>
+  `${LEARN_PREFIX}/f/wlxt/kc/wj_wjb/${courseType}/beforePlay?wjid=${fileID}&mk=${getMkFromType(
+    type,
+  )}&browser=-1&sfgk=0&pageType=${firstPageOnly ? 'first' : 'all'}`;
+
+export const LEARN_NOTIFICATION_LIST = (courseType: CourseType, expired: boolean) =>
+  `${LEARN_PREFIX}/b/wlxt/kcgg/wlkc_ggb/` +
+  (courseType === CourseType.STUDENT ? 'student/pageListXsby' : 'teacher/pageListby') +
+  (expired ? 'Ygq' : 'Wgq');
+
+export const LEARN_NOTIFICATION_DETAIL = (courseID: string, notificationID: string, courseType: CourseType) =>
+  courseType === CourseType.STUDENT
+    ? `${LEARN_PREFIX}/f/wlxt/kcgg/wlkc_ggb/student/beforeViewXs?wlkcid=${courseID}&id=${notificationID}`
+    : `${LEARN_PREFIX}/f/wlxt/kcgg/wlkc_ggb/teacher/beforeViewJs?wlkcid=${courseID}&id=${notificationID}`;
+
+export const LEARN_NOTIFICATION_EDIT = (courseType: CourseType): string =>
+  `${LEARN_PREFIX}/b/wlxt/kcgg/wlkc_ggb/${courseType}/editKcgg`;
+
+export const LEARN_HOMEWORK_LIST_NEW = `${LEARN_PREFIX}/b/wlxt/kczy/zy/student/zyListWj`;
+export const LEARN_HOMEWORK_LIST_SUBMITTED = `${LEARN_PREFIX}/b/wlxt/kczy/zy/student/zyListYjwg`;
+export const LEARN_HOMEWORK_LIST_GRADED = `${LEARN_PREFIX}/b/wlxt/kczy/zy/student/zyListYpg`;
+export const LEARN_HOMEWORK_LIST_EXCELLENT = `${LEARN_PREFIX}/b/wlxt/kczy/zy/student/yxzylist`;
+export const LEARN_HOMEWORK_LIST_SOURCE = [
+  {
+    url: LEARN_HOMEWORK_LIST_NEW,
+    status: {
+      submitted: false,
+      graded: false,
+    },
+  },
+  {
+    url: LEARN_HOMEWORK_LIST_SUBMITTED,
+    status: {
+      submitted: true,
+      graded: false,
+    },
+  },
+  {
+    url: LEARN_HOMEWORK_LIST_GRADED,
+    status: {
+      submitted: true,
+      graded: true,
+    },
+  },
+];
+
+export const LEARN_HOMEWORK_PAGE = (courseID: string, id: string) =>
+  `${LEARN_PREFIX}/f/wlxt/kczy/zy/student/viewCj?wlkcid=${courseID}&xszyid=${id}`;
+
+export const LEARN_HOMEWORK_EXCELLENT_PAGE = (courseID: string, id: string) =>
+  `${LEARN_PREFIX}/f/wlxt/kczy/zy/student/viewYxzy?wlkcid=${courseID}&xszyid=${id}`;
+
+export const LEARN_HOMEWORK_DETAIL = `${LEARN_PREFIX}/b/wlxt/kczy/zy/student/detail`;
+
+export const LEARN_HOMEWORK_DETAIL_FORM_DATA = (baseId: string) => {
+  const form = new FormData();
+  form.append('id', baseId);
+  return form;
+};
+
+export const LEARN_HOMEWORK_DOWNLOAD = (courseID: string, attachmentID: string) =>
+  `${LEARN_PREFIX}/b/wlxt/kczy/zy/student/downloadFile/${courseID}/${attachmentID}`;
+
+export const LEARN_HOMEWORK_SUBMIT_PAGE = (courseID: string, id: string) =>
+  `${LEARN_PREFIX}/f/wlxt/kczy/zy/student/tijiao?wlkcid=${courseID}&xszyid=${id}`;
+
+export const LEARN_HOMEWORK_SUBMIT = () => `${LEARN_PREFIX}/b/wlxt/kczy/zy/student/tjzy`;
+
+export const LEARN_HOMEWORK_SUBMIT_FORM_DATA = (
+  id: string,
+  content = '',
+  attachment?: IHomeworkSubmitAttachment,
+  removeAttachment = false,
+) => {
+  const form = new FormData();
+  form.append('xszyid', id);
+  form.append('zynr', content ?? '');
+  if (attachment) form.append('fileupload', attachment.content, attachment.filename);
+  else form.append('fileupload', 'undefined');
+  if (removeAttachment) form.append('isDeleted', '1');
+  else form.append('isDeleted', '0');
+  return form;
+};
+
+export const LEARN_HOMEWORK_LIST_TEACHER = `${LEARN_PREFIX}/b/wlxt/kczy/zy/teacher/pageList`;
+
+export const LEARN_HOMEWORK_DETAIL_TEACHER = (courseID: string, homeworkID: string) =>
+  `${LEARN_PREFIX}/f/wlxt/kczy/xszy/teacher/beforePageList?zyid=${homeworkID}&wlkcid=${courseID}`;
+
+export const LEARN_DISCUSSION_LIST = (courseID: string, courseType: CourseType) =>
+  `${LEARN_PREFIX}/b/wlxt/bbs/bbs_tltb/${courseType}/kctlList?wlkcid=${courseID}&size=${MAX_SIZE}`;
+
+export const LEARN_DISCUSSION_DETAIL = (
+  courseID: string,
+  boardID: string,
+  discussionID: string,
+  courseType: CourseType,
+  tabId = 1,
+) =>
+  `${LEARN_PREFIX}/f/wlxt/bbs/bbs_tltb/${courseType}/viewTlById?wlkcid=${courseID}&id=${discussionID}&tabbh=${tabId}&bqid=${boardID}`;
+
+export const LEARN_QUESTION_LIST_ANSWERED = (courseID: string, courseType: CourseType) =>
+  `${LEARN_PREFIX}/b/wlxt/bbs/bbs_tltb/${courseType}/kcdyList?wlkcid=${courseID}&size=${MAX_SIZE}`;
+
+export const LEARN_QUESTION_DETAIL = (courseID: string, questionID: string, courseType: CourseType) =>
+  courseType === CourseType.STUDENT
+    ? `${LEARN_PREFIX}/f/wlxt/bbs/bbs_kcdy/student/viewDyById?wlkcid=${courseID}&id=${questionID}`
+    : `${LEARN_PREFIX}/f/wlxt/bbs/bbs_kcdy/teacher/beforeEditDy?wlkcid=${courseID}&id=${questionID}`;
+
+export const LEARN_QNR_LIST_ONGOING = `${LEARN_PREFIX}/b/wlxt/kcwj/wlkc_wjb/student/pageListWks`;
+export const LEARN_QNR_LIST_ENDED = `${LEARN_PREFIX}/b/wlxt/kcwj/wlkc_wjb/student/pageListYjs`;
+/** Note: This page is accessible even with an invalid `qnrID` as long as you have access to the given `courseID`. */
+export const LEARN_QNR_SUBMIT_PAGE = (courseID: string, qnrID: string, type: QuestionnaireType) =>
+  `${LEARN_PREFIX}/f/wlxt/kcwj/wlkc_wjb/student/beforeAdd?wlkcid=${courseID}&wjid=${qnrID}&wjlx=${type}&jswj=no`;
+export const LEARN_QNR_DETAIL = `${LEARN_PREFIX}/b/wlxt/kcwj/wlkc_wjb/student/getWjnr`;
+
+export const LEARN_QNR_DETAIL_FORM = (courseID: string, qnrID: string) => {
+  const form = new FormData();
+  form.append('wlkcid', courseID);
+  form.append('wjid', qnrID);
+  return form;
+};
+
+export const WebsiteShowLanguage = {
+  [Language.ZH]: 'zh_CN',
+  [Language.EN]: 'en_US',
+};
+
+export const LEARN_WEBSITE_LANGUAGE = (lang: Language) =>
+  `${LEARN_PREFIX}/f/wlxt/common/language?websiteShowLanguage=${WebsiteShowLanguage[lang]}`;
+
+export const LEARN_FAVORITE_ADD = (type: ContentType, id: string) =>
+  `${LEARN_PREFIX}/b/xt/wlkc_xsscb/student/add?ywid=${id}&ywlx=${CONTENT_TYPE_MAP.get(type)}`;
+
+export const LEARN_FAVORITE_REMOVE = (id: string) => `${LEARN_PREFIX}/b/xt/wlkc_xsscb/student/delete?ywid=${id}`;
+
+export const LEARN_FAVORITE_LIST = (type?: ContentType) =>
+  `${LEARN_PREFIX}/b/xt/wlkc_xsscb/student/pageList?ywlx=${type ? CONTENT_TYPE_MAP.get(type) : 'ALL'}`;
+
+export const LEARN_FAVORITE_PIN = `${LEARN_PREFIX}/b/xt/wlkc_xsscb/student/addZd`;
+
+export const LEARN_FAVORITE_UNPIN = `${LEARN_PREFIX}/b/xt/wlkc_xsscb/student/delZd`;
+
+export const LEARN_FAVORITE_PIN_UNPIN_FORM_DATA = (id: string) => {
+  const form = new FormData();
+  form.append('ywid', id);
+  return form;
+};
+
+export const LEARN_COMMENT_SET = `${LEARN_PREFIX}/b/wlxt/xt/wlkc_xsbjb/add`;
+
+export const LEARN_COMMENT_SET_FORM_DATA = (type: ContentType, id: string, content: string) => {
+  const form = new FormData();
+  form.append('ywlx', CONTENT_TYPE_MAP.get(type) ?? '');
+  form.append('ywid', id);
+  form.append('bznr', content);
+  return form;
+};
+
+export const LEARN_COMMENT_LIST = (type?: ContentType) =>
+  `${LEARN_PREFIX}/b/wlxt/xt/wlkc_xsbjb/student/pageList?ywlx=${type ? CONTENT_TYPE_MAP.get(type) : 'ALL'}`;
+
+export const LEARN_PAGE_LIST_FORM_DATA = (courseID?: string) => {
+  const form = new FormData();
+  form.append('aoData', JSON.stringify(courseID ? [{ name: 'wlkcid', value: courseID }] : []));
+  return form;
+};
+
+export const LEARN_SORT_COURSES = `${LEARN_PREFIX}/b/wlxt/kc/wlkc_kcpxb/addorUpdate`;
+
+export const REGISTRAR_TICKET_FORM_DATA = () => {
+  const form = new FormData();
+  form.append('appId', 'ALL_ZHJW');
+  return form;
+};
+
+export const REGISTRAR_TICKET = () => `${LEARN_PREFIX}/b/wlxt/common/auth/gnt`;
+
+export const REGISTRAR_AUTH = (ticket: string) => `${REGISTRAR_PREFIX}/j_acegi_login.do?url=/&ticket=${ticket}`;
+
+export const REGISTRAR_CALENDAR = (startDate: string, endDate: string, graduate = false, callbackName = 'unknown') =>
+  `${REGISTRAR_PREFIX}/jxmh_out.do?m=${
+    graduate ? 'yjs' : 'bks'
+  }_jxrl_all&p_start_date=${startDate}&p_end_date=${endDate}&jsoncallback=${callbackName}`;

package/src/user.ts

@@ -0,0 +1,28 @@
+// User info and website language.
+
+import type { Session } from './request.ts';
+import { $ } from './request.ts';
+import type { UserInfo, Language } from './types.ts';
+import { CourseType } from './types.ts';
+import * as URLS from './urls.ts';
+
+/** get user's name and department */
+export async function getUserInfo(s: Session, courseType = CourseType.STUDENT): Promise<UserInfo> {
+  const content = await (await s.fetchWithToken(URLS.LEARN_HOMEPAGE(courseType))).text();
+
+  const dom = $(content);
+  const name = dom('a.user-log').text().trim();
+  const department = dom('.fl.up-img-info p:nth-child(2) label').text().trim();
+
+  return {
+    name,
+    department,
+  };
+}
+
+export async function setLanguage(s: Session, lang: Language): Promise<void> {
+  await s.fetchWithToken(URLS.LEARN_WEBSITE_LANGUAGE(lang), {
+    method: 'POST',
+  });
+  s.lang = lang;
+}

package/src/utils.ts

@@ -0,0 +1,125 @@
+import { decodeHTML as _decodeHTML } from 'entities';
+
+import type { DetailSelector } from './types.ts';
+import { ContentType, FailReason, HomeworkGradeLevel, QuestionnaireType, SemesterType } from './types.ts';
+
+export function parseSemesterType(n: number): SemesterType {
+  if (n === 1) {
+    return SemesterType.FALL;
+  } else if (n === 2) {
+    return SemesterType.SPRING;
+  } else if (n === 3) {
+    return SemesterType.SUMMER;
+  } else {
+    return SemesterType.UNKNOWN;
+  }
+}
+
+const CONTENT_TYPE_MK_MAP = {
+  [ContentType.NOTIFICATION]: 'kcgg',
+  [ContentType.FILE]: 'kcwj',
+  [ContentType.HOMEWORK]: 'kczy',
+  [ContentType.DISCUSSION]: '',
+  [ContentType.QUESTION]: '',
+  [ContentType.QUESTIONNAIRE]: '',
+};
+
+export function getMkFromType(type: ContentType): string {
+  return 'mk_' + (CONTENT_TYPE_MK_MAP[type] ?? 'UNKNOWN');
+}
+
+export function decodeHTML(html: string): string {
+  const text = _decodeHTML(html ?? '');
+  // remove strange prefixes returned by web learning
+  return text.startsWith('\xC2\x9E\xC3\xA9\x65')
+    ? text.slice(5)
+    : text.startsWith('\x9E\xE9\x65')
+      ? text.slice(3)
+      : text.startsWith('\xE9\x65')
+        ? text.slice(2)
+        : text;
+}
+
+export function trimAndDefine(text: string | undefined | null): string | undefined {
+  if (text === undefined || text === null) {
+    return undefined;
+  }
+  const trimmed = text.trim();
+  return trimmed === '' ? undefined : decodeHTML(trimmed);
+}
+
+export const GRADE_LEVEL_MAP = new Map([
+  [-100, HomeworkGradeLevel.CHECKED],
+  [-99, HomeworkGradeLevel.A_PLUS],
+  [-98, HomeworkGradeLevel.A],
+  [-92, HomeworkGradeLevel.A_MINUS],
+  [-87, HomeworkGradeLevel.B_PLUS],
+  [-85, HomeworkGradeLevel.DISTINCTION],
+  [-82, HomeworkGradeLevel.B],
+  [-78, HomeworkGradeLevel.B_MINUS],
+  [-74, HomeworkGradeLevel.C_PLUS],
+  [-71, HomeworkGradeLevel.C],
+  [-68, HomeworkGradeLevel.C_MINUS],
+  [-67, HomeworkGradeLevel.G],
+  [-66, HomeworkGradeLevel.D_PLUS],
+  [-64, HomeworkGradeLevel.D],
+  [-65, HomeworkGradeLevel.EXEMPTED_COURSE],
+  [-63, HomeworkGradeLevel.PASS],
+  [-62, HomeworkGradeLevel.EX],
+  [-61, HomeworkGradeLevel.EXEMPTION],
+  [-60, HomeworkGradeLevel.PASS],
+  [-59, HomeworkGradeLevel.FAILURE],
+  [-55, HomeworkGradeLevel.W],
+  [-51, HomeworkGradeLevel.I],
+  [-50, HomeworkGradeLevel.INCOMPLETE],
+  [-31, HomeworkGradeLevel.NA],
+  [-30, HomeworkGradeLevel.F],
+]);
+
+export const JSONP_EXTRACTOR_NAME = 'thu_learn_lib_jsonp_extractor';
+
+export function extractJSONPResult(jsonp: string): any {
+  // check jsonp format
+  if (!jsonp.startsWith(JSONP_EXTRACTOR_NAME)) {
+    throw FailReason.INVALID_RESPONSE;
+  }
+  // evaluate the result
+  // oxlint-disable-next-line typescript/no-implied-eval -- JSONP from the registrar is a JS expression, not JSON
+  return Function(`"use strict";const ${JSONP_EXTRACTOR_NAME}=(s)=>s;return ${jsonp};`)();
+}
+
+export function formatFileSize(size: number): string {
+  // this logic is extracted from `judgeSize` function from Web Learning
+  if (size < 1024) return size + 'B';
+  if (size < 1024 * 1024) return (size / 1024).toFixed(2) + 'K';
+  if (size < 1024 * 1024 * 1024) return (size / 1024 / 1024).toFixed(2) + 'M';
+  return (size / 1024 / 1024 / 1024).toFixed(2) + 'G';
+}
+
+export const CONTENT_TYPE_MAP = new Map([
+  [ContentType.NOTIFICATION, 'KCGG'],
+  [ContentType.FILE, 'KCKJ'],
+  [ContentType.HOMEWORK, 'KCZY'],
+  [ContentType.DISCUSSION, 'KCTL'],
+  [ContentType.QUESTION, 'KCDY'],
+  [ContentType.QUESTIONNAIRE, 'KCWJ'],
+  // omitted: 课表(KCKB)
+]);
+export const CONTENT_TYPE_MAP_REVERSE = new Map([
+  [CONTENT_TYPE_MAP.get(ContentType.NOTIFICATION)!, ContentType.NOTIFICATION],
+  [CONTENT_TYPE_MAP.get(ContentType.FILE)!, ContentType.FILE],
+  [CONTENT_TYPE_MAP.get(ContentType.HOMEWORK)!, ContentType.HOMEWORK],
+  [CONTENT_TYPE_MAP.get(ContentType.DISCUSSION)!, ContentType.DISCUSSION],
+  [CONTENT_TYPE_MAP.get(ContentType.QUESTION)!, ContentType.QUESTION],
+  [CONTENT_TYPE_MAP.get(ContentType.QUESTIONNAIRE)!, ContentType.QUESTIONNAIRE],
+]);
+
+export const QNR_TYPE_MAP = new Map([
+  ['投票', QuestionnaireType.VOTE],
+  ['填表', QuestionnaireType.FORM],
+  ['问卷', QuestionnaireType.SURVEY],
+]);
+
+/** whether `item` is selected by a `DetailSelector` (`undefined` means `'none'`) */
+export const isSelected = <T>(selector: DetailSelector<T> | undefined, item: T): boolean =>
+  selector === 'all' || (typeof selector === 'function' && selector(item));