classes.ts 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523
  1. import { defineStore } from "pinia";
  2. import {
  3. MinFullNameSearchLength,
  4. bbClassRe,
  5. contextClassRe,
  6. dayMap,
  7. englishClassRe,
  8. firstPhaseClassRe,
  9. parsePDFVersion,
  10. toTime,
  11. } from "../helpers";
  12. import {
  13. ClassSelectorColumn,
  14. Ordering,
  15. FilterRule,
  16. ModuleLanguages,
  17. ClassesVersion,
  18. } from "../types";
  19. import { useClassVersionStore } from "./ClassVersion";
  20. import { useModulesStore } from "./modules";
  21. import { usePlanningStore } from "./planning";
  22. import { useStateStore } from "./state";
  23. import { useStudenthubStore } from "./studenthub";
  24. import { getBlockmodules } from "../api/modules/semesters/blockmodules";
  25. import { TaughtClass } from "../api/types/semesters/versions/class";
  26. import { getClasses } from "../api/modules/semesters/versions/classes";
  27. import { getConfig } from "../api/modules/semesters/config";
  28. import { SemesterConfiguration } from "../api/types/semesters/config";
  29. // eslint-disable-next-line
  30. type SortingFunction = (o1: any, o2: any) => number;
  31. export const useClassesStore = defineStore("classes", {
  32. state: () => {
  33. const stateStore = useStateStore();
  34. const cvStore = useClassVersionStore();
  35. return {
  36. data: {} as Record<string, ClassesVersion>,
  37. filterRules: [
  38. {
  39. column: ClassSelectorColumn.Degree,
  40. filterData: { degree: `${stateStore.lastSelectedDegreeProgram}` },
  41. pk: Math.floor(Math.random() * 1e20),
  42. enabled: true,
  43. },
  44. {
  45. column: ClassSelectorColumn.Module,
  46. filterData: { term: "" },
  47. pk: Math.floor(Math.random() * 1e20),
  48. enabled: true,
  49. },
  50. ] as FilterRule[],
  51. sortBy: {} as Record<string, SortingFunction>,
  52. cvStore,
  53. };
  54. },
  55. getters: {
  56. allClasses(): TaughtClass[] {
  57. const cd = this.currentData;
  58. if (cd == null) return [];
  59. return [...cd.taughtClasses, ...cd.blockClasses];
  60. },
  61. classesFilteredByCompletion(): TaughtClass[] {
  62. const stateStore = useStateStore();
  63. if (!stateStore.hideCompletedClasses) return this.allClasses;
  64. const studenthubStore = useStudenthubStore();
  65. return this.allClasses.filter((c) => {
  66. const m = c.module;
  67. if (m?.module_id == null) return true;
  68. return !studenthubStore.hasCompletedModule(m.module_id);
  69. });
  70. },
  71. getAllSortedClasses(): TaughtClass[] {
  72. const keys = Object.keys(this.sortBy);
  73. const numberOfProperties = keys.length;
  74. let modules = [...this.classesFilteredByCompletion];
  75. if (numberOfProperties > 0) {
  76. modules = modules.sort((obj1, obj2) => {
  77. let i = 0;
  78. let result = 0;
  79. while (result === 0 && i < numberOfProperties) {
  80. result = this.sortBy[keys[i]](obj1, obj2);
  81. i++;
  82. }
  83. return result;
  84. });
  85. }
  86. return modules;
  87. },
  88. filteredModules(): TaughtClass[] {
  89. let classes = this.getAllSortedClasses;
  90. const transformedRules = {} as Record<ClassSelectorColumn, FilterRule[]>;
  91. this.filterRules.forEach((rule) => {
  92. if (!rule.enabled) return;
  93. if (rule.column in transformedRules)
  94. transformedRules[rule.column].push(rule);
  95. else transformedRules[rule.column] = [rule];
  96. });
  97. Object.keys(transformedRules).forEach((column) => {
  98. const foundClasses = [] as TaughtClass[];
  99. let didFilter = false;
  100. if (column == ClassSelectorColumn.Time) {
  101. transformedRules[column].forEach((rule) =>
  102. foundClasses.push(...filterTimeColumn(classes, rule))
  103. );
  104. classes = [...new Set(foundClasses)];
  105. return;
  106. }
  107. if (column == ClassSelectorColumn.Degree) {
  108. let shouldFilter = true;
  109. transformedRules[column].forEach((rule) => {
  110. const degree = rule.filterData?.degree ?? "";
  111. if (degree.length == 0) {
  112. shouldFilter = false;
  113. return;
  114. }
  115. didFilter = true;
  116. foundClasses.push(
  117. ...classes.filter((c) => c.degree_prg == rule.filterData.degree)
  118. );
  119. });
  120. if (shouldFilter && didFilter) classes = [...new Set(foundClasses)];
  121. return;
  122. }
  123. switch (column) {
  124. case ClassSelectorColumn.Module:
  125. transformedRules[column].forEach((rule) => {
  126. const term = rule.filterData?.term?.toLowerCase() ?? "";
  127. const checkName = term.length >= MinFullNameSearchLength;
  128. if (term.length == 0) return;
  129. didFilter = true;
  130. foundClasses.push(
  131. ...classes.filter(
  132. (c) =>
  133. c.name.toLowerCase().includes(term) ||
  134. (checkName &&
  135. c.module?.name.toLocaleLowerCase().includes(term))
  136. )
  137. );
  138. });
  139. break;
  140. case ClassSelectorColumn.Room:
  141. transformedRules[column].forEach((rule) => {
  142. const term = rule.filterData?.term?.toLowerCase() ?? "";
  143. if (term.length == 0) return;
  144. didFilter = true;
  145. const clsss = classes.filter((c) => {
  146. if (c.rooms.length == 0) return false;
  147. return c.rooms.join(" ").toLowerCase().includes(term);
  148. });
  149. foundClasses.push(...clsss);
  150. });
  151. break;
  152. case ClassSelectorColumn.Class:
  153. transformedRules[column].forEach((rule) => {
  154. const term = rule.filterData?.term?.toLowerCase() ?? "";
  155. if (term.length == 0) return;
  156. didFilter = true;
  157. foundClasses.push(
  158. ...classes.filter((c) => c.class.toLowerCase().includes(term))
  159. );
  160. });
  161. break;
  162. case ClassSelectorColumn.Lecturer:
  163. transformedRules[column].forEach((rule) => {
  164. const term = rule.filterData?.term?.toLowerCase() ?? "";
  165. if (term.length == 0) return;
  166. didFilter = true;
  167. foundClasses.push(
  168. ...classes.filter((c) =>
  169. c.teachers.join().toLowerCase().includes(term)
  170. )
  171. );
  172. });
  173. break;
  174. case ClassSelectorColumn.TeachingType:
  175. transformedRules[column].forEach((rule) => {
  176. if (rule.filterData.teachingType?.length == 0) return;
  177. didFilter = true;
  178. foundClasses.push(
  179. ...classes.filter(
  180. (c) => c.teaching_type == rule.filterData.teachingType
  181. )
  182. );
  183. });
  184. break;
  185. default:
  186. console.warn(`Filter type ${column} is not supported!`);
  187. return;
  188. }
  189. if (didFilter) classes = [...new Set(foundClasses)];
  190. });
  191. return classes;
  192. },
  193. degreePrograms(): string[] {
  194. const cd = this.currentData;
  195. if (cd == null) return [];
  196. return cd.degreePrograms;
  197. },
  198. currentData(): ClassesVersion | null {
  199. const version = this.cvStore.semVerString;
  200. if (version == null) return null;
  201. if (!(version in this.data)) {
  202. console.error(`The version ${version} has not yet been loaded!`);
  203. return null;
  204. }
  205. return this.data[version];
  206. },
  207. },
  208. actions: {
  209. fetchData(version: string | null = null): Promise<null> | undefined {
  210. if (version == null) {
  211. version = this.cvStore.semVerString;
  212. if (version == null) {
  213. // console.error("The current semester/version was unexpectedly null!");
  214. return new Promise((res, rej) => rej);
  215. }
  216. }
  217. // Check if the data has already been loaded
  218. if (version in this.data)
  219. return this.data[version].ready ?? new Promise((res, rej) => rej);
  220. const semVerStr = version;
  221. this.data[semVerStr] = {
  222. version: semVerStr,
  223. ready: null,
  224. loaded: false,
  225. teachers: [],
  226. rooms: [],
  227. classes: [],
  228. days: [],
  229. taughtClasses: [],
  230. blockClasses: [],
  231. degreePrograms: [],
  232. config: { blockclass_file: "block.pdf" },
  233. };
  234. const semVer = parsePDFVersion(semVerStr);
  235. if (semVer === undefined) {
  236. console.error(
  237. `Failed to find the semester in the given string: ${version}`
  238. );
  239. return undefined;
  240. }
  241. this.data[semVerStr].ready = new Promise((resolve, reject) => {
  242. const fe = getClasses(semVer);
  243. const bc = getBlockmodules(semVer);
  244. const sc = getConfig(semVer);
  245. const modulesStore = useModulesStore();
  246. const addModuleGetters = (cls: TaughtClass) => {
  247. Object.defineProperty(cls, "module", {
  248. get: function () {
  249. return (
  250. this._module ||
  251. (this._module = modulesStore.fromModuleShort(cls.name))
  252. );
  253. },
  254. });
  255. cls.isBB = cls.class.match(bbClassRe) !== null;
  256. cls.isFirstPhase = cls.class.match(firstPhaseClassRe) !== null;
  257. cls.isEnglish = cls.class.match(englishClassRe) !== null;
  258. cls.isContext = cls.class.match(contextClassRe) !== null;
  259. cls.languageString = cls.isEnglish
  260. ? ModuleLanguages.EN
  261. : ModuleLanguages.DE;
  262. cls.executionTime =
  263. cls.weekday !== null
  264. ? `${dayMap[cls.weekday]}, ${toTime(cls.from)}-${toTime(cls.to)}`
  265. : "Blockmodul";
  266. };
  267. /**
  268. * Process the block modules
  269. */
  270. const bmReady = new Promise((resolveBM) => {
  271. Promise.all([bc, modulesStore.ready])
  272. .then(([data]: [TaughtClass[], unknown]) => {
  273. data.forEach(addModuleGetters);
  274. this.data[semVerStr].blockClasses = data;
  275. resolveBM(null);
  276. })
  277. .catch((error) => {
  278. console.error(error);
  279. this.data[semVerStr].blockClasses = [];
  280. resolveBM(null); // We will resolve and not reject, as it's okay to not have a blockmodules.json on the server
  281. });
  282. });
  283. /**
  284. * Process the semester config
  285. */
  286. const scReady = new Promise((resolveSC) => {
  287. Promise.all([sc, modulesStore.ready])
  288. .then(([data]: [SemesterConfiguration, unknown]) => {
  289. this.data[semVerStr].config = data;
  290. resolveSC(null);
  291. })
  292. .catch((error) => {
  293. console.error(error);
  294. this.data[semVerStr].config = { blockclass_file: "block.pdf" };
  295. resolveSC(null); // We will resolve and not reject, as it's okay to not have a config.json on the server
  296. });
  297. });
  298. /**
  299. * Process the standard classes
  300. */
  301. Promise.all([fe, bmReady, scReady, modulesStore.ready])
  302. .then(([data]: [TaughtClass[], unknown, unknown, unknown]) => {
  303. data.forEach(addModuleGetters);
  304. this.data[semVerStr].taughtClasses = data;
  305. this.updateUniqueDegreePrograms(semVerStr);
  306. this.data[semVerStr].loaded = true;
  307. const planningStore = usePlanningStore();
  308. planningStore.loadFromStorage();
  309. resolve(null);
  310. })
  311. .catch((error) => {
  312. console.error(error);
  313. // TODO
  314. this.data[semVerStr].taughtClasses = [];
  315. reject(null);
  316. });
  317. });
  318. return this.data[version].ready ?? new Promise((res, rej) => rej);
  319. },
  320. updateUniqueDegreePrograms(version: string) {
  321. this.data[version].degreePrograms = [];
  322. this.allClasses.forEach((m) => {
  323. if (!this.data[version].degreePrograms.includes(m.degree_prg))
  324. this.data[version].degreePrograms.push(m.degree_prg);
  325. });
  326. this.data[version].degreePrograms.sort((a, b) =>
  327. a.toLowerCase().localeCompare(b.toLowerCase())
  328. );
  329. },
  330. getById(module_id: string): TaughtClass | null {
  331. const matched = this.allClasses.filter((c) => c.id == module_id);
  332. if (matched.length == 0) return null;
  333. return matched[0];
  334. },
  335. updateOrdering(col: ClassSelectorColumn, dir: Ordering) {
  336. const colName = col.valueOf();
  337. if (dir == Ordering.None && col in this.sortBy) {
  338. delete this.sortBy[col];
  339. return;
  340. }
  341. switch (col) {
  342. case ClassSelectorColumn.Time:
  343. this.sortBy[col] = (a: TaughtClass, b: TaughtClass) => {
  344. const ta = 86400 * (a.weekday ?? 0) + a.from;
  345. const tb = 86400 * (b.weekday ?? 0) + b.from;
  346. return (ta - tb) * dir;
  347. };
  348. break;
  349. case ClassSelectorColumn.Lecturer:
  350. this.sortBy[col] = (a: TaughtClass, b: TaughtClass) => {
  351. const ta = a.teachers.join("").toLowerCase();
  352. const tb = b.teachers.join("").toLowerCase();
  353. return (ta < tb ? -1 : ta > tb ? 1 : 0) * dir;
  354. };
  355. break;
  356. case ClassSelectorColumn.TeachingType:
  357. this.sortBy[col] = (a: TaughtClass, b: TaughtClass) => {
  358. const ta = a.teaching_type;
  359. const tb = b.teaching_type;
  360. return (ta < tb ? -1 : ta > tb ? 1 : 0) * dir;
  361. };
  362. break;
  363. case ClassSelectorColumn.Room:
  364. this.sortBy[col] = (a: TaughtClass, b: TaughtClass) => {
  365. const ta = a.rooms.join("").toLowerCase();
  366. const tb = b.rooms.join("").toLowerCase();
  367. return (ta < tb ? -1 : ta > tb ? 1 : 0) * dir;
  368. };
  369. break;
  370. case ClassSelectorColumn.MSP:
  371. this.sortBy[col] = (a: TaughtClass, b: TaughtClass) => {
  372. const aMSP = a.module?.hasMSP === true;
  373. const bMSP = b.module?.hasMSP === true;
  374. return (aMSP == bMSP ? 0 : aMSP ? -1 : 1) * dir;
  375. };
  376. break;
  377. case ClassSelectorColumn.Module:
  378. case ClassSelectorColumn.Class:
  379. this.sortBy[col] = (a, b) =>
  380. (a[colName] < b[colName] ? -1 : a[colName] > b[colName] ? 1 : 0) *
  381. dir;
  382. break;
  383. default:
  384. console.error("Unhandled sorting!");
  385. break;
  386. }
  387. },
  388. insertFilter(afterFilter: FilterRule | null) {
  389. const emptyFilter = {
  390. column: ClassSelectorColumn.Module,
  391. filterData: { term: "" },
  392. pk: Math.floor(Math.random() * 1e20),
  393. enabled: true,
  394. } as FilterRule;
  395. if (!afterFilter) {
  396. this.filterRules.push(emptyFilter);
  397. return;
  398. }
  399. const idx = this.filterRules.findIndex((r) => r.pk == afterFilter.pk);
  400. if (idx == -1) {
  401. this.filterRules.push(emptyFilter);
  402. return;
  403. }
  404. this.filterRules.splice(idx + 1, 0, emptyFilter);
  405. },
  406. removeFilter(filterRule: FilterRule) {
  407. const idx = this.filterRules.findIndex((r) => r.pk == filterRule.pk);
  408. if (idx == -1) {
  409. console.error("Failed to find the filter rule in the current set!");
  410. return;
  411. }
  412. this.filterRules.splice(idx, 1);
  413. },
  414. classesForModule(short: string): TaughtClass[] {
  415. const cd = this.currentData;
  416. if (cd == null) return [];
  417. return cd.taughtClasses.filter((c) => c.name == short);
  418. },
  419. },
  420. });
  421. function filterTimeColumn(
  422. modules: TaughtClass[],
  423. filterset: FilterRule
  424. ): TaughtClass[] {
  425. const timeData = filterset.filterData as Record<string, number>;
  426. const start = timeData.startTime;
  427. const end = timeData.endTime;
  428. if (start == undefined && end == undefined) return modules;
  429. let startingDay = -1;
  430. if (start != undefined) {
  431. if (start < 0) {
  432. const pStart = -1 * start;
  433. modules = modules.filter((m) => m.from >= pStart);
  434. } else {
  435. startingDay = Math.floor(start / 86400);
  436. const startingTime = start - startingDay * 86400;
  437. modules = modules.filter(
  438. (m) =>
  439. ((m.weekday ?? 0) == startingDay && m.from >= startingTime) ||
  440. (m.weekday ?? 0) > startingDay
  441. );
  442. }
  443. }
  444. if (end != undefined) {
  445. let aEnd = end;
  446. if (aEnd < 0) {
  447. if (startingDay >= 0) {
  448. const endingTime = aEnd * -1 - startingDay * 86400;
  449. modules = modules.filter(
  450. (m) =>
  451. (m.weekday ?? 0) == startingDay &&
  452. (endingTime == 0 || m.to <= endingTime)
  453. );
  454. } else {
  455. aEnd *= -1;
  456. modules = modules.filter((m) => m.to <= aEnd);
  457. }
  458. } else {
  459. const endingDay = Math.floor(aEnd / 86400);
  460. const endingTime = aEnd - endingDay * 86400;
  461. modules = modules.filter(
  462. (m) =>
  463. (m.weekday ?? 0) < endingDay ||
  464. ((m.weekday ?? 0) == endingDay &&
  465. (endingTime == 0 || m.to <= endingTime))
  466. );
  467. }
  468. }
  469. return modules;
  470. }