Initial commit

This commit is contained in:
Jason 2025-03-22 17:46:00 +01:00
commit 918956d9f1
7 changed files with 556 additions and 0 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
node_modules

27
README.md Normal file
View File

@ -0,0 +1,27 @@
# Virtueller Stundenplan
This project is a unofficial NodeJS library for the [Virtueller Stundenplan](https://virtueller-stundenplan.org).
# Installation
You can install this library from [npm](https://npmjs.com/package/virtueller-stundenplan).
# Usage
This is a example on how to use the package:
```javascript
const { VirtuellerStundenplan } = require("virtueller-stundenplan");
const vs = new VirtuellerStundenplan("user@example.com", "Password");
(async() => {
const timetable = await vs.getMyTimetable();
console.log(timetable);
})()
```
# Note
This project in **very early developement**, except things to break and change.

View File

@ -0,0 +1,32 @@
const crypto = require('node:crypto');
class EncryptionHelper {
static encryptDataAESGCM(plainText, key) {
try {
const iv = crypto.randomBytes(12);
const cipher = crypto.createCipheriv('aes-256-gcm', key, iv);
const encryptedText = Buffer.concat([cipher.update(plainText, 'utf8'), cipher.final()]);
const authTag = cipher.getAuthTag();
return Buffer.concat([iv, encryptedText, authTag]);
} catch (error) {
console.error("Encryption failed:", error);
return null;
}
}
static makeEncryptedParameter(username, key) {
const timestamp = new Date().toISOString().replace('T', ' ').split('.')[0];
const plainText = `${timestamp} ${username}`;
const hash = crypto.createHash('sha256').update(key, 'utf8').digest();
const encryptedData = this.encryptDataAESGCM(plainText, hash);
const base64Encoded = encryptedData.toString('base64');
return base64Encoded;
}
}
module.exports = EncryptionHelper

View File

@ -0,0 +1,175 @@
const axios = require("axios");
const EncryptionHelper = require("./EncryptionHelper");
class VirtuellerStundenplan {
baseUrl = "https://virtueller-stundenplan.de/Reservierung/";
constructor(username, password, key) {
this.username = username;
this.password = password;
if(key) this.key = key;
}
async fetchKey(returnKey=false) {
const url = new URL("RestGetKeyphrase.php", this.baseUrl);
try {
const req = await axios(url.href, {
headers: {
Authorization: "Basic " + Buffer.from(this.username + ":" + this.password).toString('base64'),
},
});
this.key = req.data.KeyPhrase;
} catch (err) {
return false;
}
return returnKey ? this.key : true;
}
async getEnabledFunctions() {
return await this.request("RESTEnabledFunctions.php");
}
async getCourseList() {
return await this.request("RESTKursliste.php");
}
async getMessages() {
return await this.request("RESTMessages.php");
}
/**
* Returns all Homework (Classbook) entries.
* Date arguments are inclusive.
*
* @param {String|Date} from
* @param {String|Date} to
* @returns {Object}
*/
async getHomework(from=new Date(), to=new Date()) {
const query = new URLSearchParams();
query.set("KlaBuDateVon", this.getDateString(from));
query.set("KlaBuDateBis", this.getDateString(to));
return await this.request("RESTHausaufgaben.php", query);
}
async getSchoolYears() {
return await this.request("RESTSchuljahre.php");
}
/**
*
* @param {string|number} schoolYear ID of the school year
* @returns
*/
async getMyGrades(schoolYear) {
const query = new URLSearchParams();
query.set("SJ", schoolYear);
return await this.request("RESTMeineNoten.php", query);
}
async getMyTimetable(from=new Date()) {
const query = new URLSearchParams();
query.set("KlaBuDateVon", this.getDateString(from));
return await this.request("RESTMeinStundenplan.php", query);
}
async getTimetable(Class, from=new Date()) {
const query = new URLSearchParams();
query.set("KlaBuDateVon", this.getDateString(from));
query.set("KLASSE", Class);
return await this.request("RESTKlassenStundenplan.php", query);
}
async getMyInfos() {
return await this.request("RESTSuSInfo.php");
}
async getMyPicture() {
return await this.request("RESTSuSMeinBild.php");
}
/**
* BBS ID QR
*/
async getMyBBSIDQR() {
return await this.request("RESTBBSIDQR.php");
}
/**
* BBS GUID QR
*/
async getMyBBSGUID() {
return await this.request("RESTBBSIDGUID.php");
}
async reportAsSick(from=new Date(), to=new Date()) {
const query = new URLSearchParams();
query.set("KlaBuDateVon", this.getDateString(from));
query.set("KlaBuDateBis", this.getDateString(to));
return await this.request("RESTSuSKrankmelden.php", query);
}
async getAbsentDays(from=new Date(), to=new Date()) {
const query = new URLSearchParams();
query.set("KlaBuDateVon", this.getDateString(from));
query.set("KlaBuDateBis", this.getDateString(to));
return await this.request("RESTFehltageliste.php", query);
}
async getExamList(from=new Date(), to=new Date()) {
const query = new URLSearchParams();
query.set("KlaBuDateVon", this.getDateString(from));
query.set("KlaBuDateBis", this.getDateString(to));
return await this.request("RESTKlausurliste.php", query);
}
async subscribeToNotifications(Token, Register, IOS) {
const query = new URLSearchParams();
query.set("Token", Token);
query.set("Register", Register);
query.set("IOS", IOS);
return await this.request("RESTDeviceToken.php", query);
}
getDateString(date) {
if(typeof date === "string" && /^\d{4}\-\d{2}\-\d{2}$/.test(date)) {
return date;
}
if(date instanceof Date) {
return date.toISOString().slice(0, 10);
}
throw new Error(`"${date}" is not a valid type for date.`);
}
/**
*
* @param {string} url
* @param {URLSearchParams} query Query parameters
* @returns {Any} Response from Server. Error when an error occoured.
*/
async request(url, query) {
if(!this.key && await this.fetchKey() === false) return false;
url = new URL(url, this.baseUrl);
if(query) url.search = query.toString();
url.searchParams.set("key", EncryptionHelper.makeEncryptedParameter(this.username, this.key));
let req;
try {
req = await axios(url.href, {
headers: {
Authorization: "Basic " + Buffer.from(this.username + ":" + this.password).toString('base64'),
},
});
} catch (err) {
return err;
}
return req.data;
}
}
module.exports = VirtuellerStundenplan

4
index.js Normal file
View File

@ -0,0 +1,4 @@
module.exports = {
EncryptionHelper: require("./classes/EncryptionHelper"),
VirtuellerStundenplan: require("./classes/VirtuellerStundenplan"),
}

294
npm-shrinkwrap.json generated Normal file
View File

@ -0,0 +1,294 @@
{
"name": "virtueller-stundenplan",
"version": "0.0.1",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "virtueller-stundenplan",
"version": "0.0.1",
"license": "CC-BY-NC-4.0",
"dependencies": {
"axios": "^1.8.4"
}
},
"node_modules/asynckit": {
"version": "0.4.0",
"resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz",
"integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==",
"license": "MIT"
},
"node_modules/axios": {
"version": "1.8.4",
"resolved": "https://registry.npmjs.org/axios/-/axios-1.8.4.tgz",
"integrity": "sha512-eBSYY4Y68NNlHbHBMdeDmKNtDgXWhQsJcGqzO3iLUM0GraQFSS9cVgPX5I9b3lbdFKyYoAEGAZF1DwhTaljNAw==",
"license": "MIT",
"dependencies": {
"follow-redirects": "^1.15.6",
"form-data": "^4.0.0",
"proxy-from-env": "^1.1.0"
}
},
"node_modules/call-bind-apply-helpers": {
"version": "1.0.2",
"resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz",
"integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==",
"license": "MIT",
"dependencies": {
"es-errors": "^1.3.0",
"function-bind": "^1.1.2"
},
"engines": {
"node": ">= 0.4"
}
},
"node_modules/combined-stream": {
"version": "1.0.8",
"resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
"integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==",
"license": "MIT",
"dependencies": {
"delayed-stream": "~1.0.0"
},
"engines": {
"node": ">= 0.8"
}
},
"node_modules/delayed-stream": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
"integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==",
"license": "MIT",
"engines": {
"node": ">=0.4.0"
}
},
"node_modules/dunder-proto": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz",
"integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==",
"license": "MIT",
"dependencies": {
"call-bind-apply-helpers": "^1.0.1",
"es-errors": "^1.3.0",
"gopd": "^1.2.0"
},
"engines": {
"node": ">= 0.4"
}
},
"node_modules/es-define-property": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz",
"integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==",
"license": "MIT",
"engines": {
"node": ">= 0.4"
}
},
"node_modules/es-errors": {
"version": "1.3.0",
"resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz",
"integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==",
"license": "MIT",
"engines": {
"node": ">= 0.4"
}
},
"node_modules/es-object-atoms": {
"version": "1.1.1",
"resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz",
"integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==",
"license": "MIT",
"dependencies": {
"es-errors": "^1.3.0"
},
"engines": {
"node": ">= 0.4"
}
},
"node_modules/es-set-tostringtag": {
"version": "2.1.0",
"resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.1.0.tgz",
"integrity": "sha512-j6vWzfrGVfyXxge+O0x5sh6cvxAog0a/4Rdd2K36zCMV5eJ+/+tOAngRO8cODMNWbVRdVlmGZQL2YS3yR8bIUA==",
"license": "MIT",
"dependencies": {
"es-errors": "^1.3.0",
"get-intrinsic": "^1.2.6",
"has-tostringtag": "^1.0.2",
"hasown": "^2.0.2"
},
"engines": {
"node": ">= 0.4"
}
},
"node_modules/follow-redirects": {
"version": "1.15.9",
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.9.tgz",
"integrity": "sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ==",
"funding": [
{
"type": "individual",
"url": "https://github.com/sponsors/RubenVerborgh"
}
],
"license": "MIT",
"engines": {
"node": ">=4.0"
},
"peerDependenciesMeta": {
"debug": {
"optional": true
}
}
},
"node_modules/form-data": {
"version": "4.0.2",
"resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.2.tgz",
"integrity": "sha512-hGfm/slu0ZabnNt4oaRZ6uREyfCj6P4fT/n6A1rGV+Z0VdGXjfOhVUpkn6qVQONHGIFwmveGXyDs75+nr6FM8w==",
"license": "MIT",
"dependencies": {
"asynckit": "^0.4.0",
"combined-stream": "^1.0.8",
"es-set-tostringtag": "^2.1.0",
"mime-types": "^2.1.12"
},
"engines": {
"node": ">= 6"
}
},
"node_modules/function-bind": {
"version": "1.1.2",
"resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz",
"integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==",
"license": "MIT",
"funding": {
"url": "https://github.com/sponsors/ljharb"
}
},
"node_modules/get-intrinsic": {
"version": "1.3.0",
"resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz",
"integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==",
"license": "MIT",
"dependencies": {
"call-bind-apply-helpers": "^1.0.2",
"es-define-property": "^1.0.1",
"es-errors": "^1.3.0",
"es-object-atoms": "^1.1.1",
"function-bind": "^1.1.2",
"get-proto": "^1.0.1",
"gopd": "^1.2.0",
"has-symbols": "^1.1.0",
"hasown": "^2.0.2",
"math-intrinsics": "^1.1.0"
},
"engines": {
"node": ">= 0.4"
},
"funding": {
"url": "https://github.com/sponsors/ljharb"
}
},
"node_modules/get-proto": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz",
"integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==",
"license": "MIT",
"dependencies": {
"dunder-proto": "^1.0.1",
"es-object-atoms": "^1.0.0"
},
"engines": {
"node": ">= 0.4"
}
},
"node_modules/gopd": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz",
"integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==",
"license": "MIT",
"engines": {
"node": ">= 0.4"
},
"funding": {
"url": "https://github.com/sponsors/ljharb"
}
},
"node_modules/has-symbols": {
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz",
"integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==",
"license": "MIT",
"engines": {
"node": ">= 0.4"
},
"funding": {
"url": "https://github.com/sponsors/ljharb"
}
},
"node_modules/has-tostringtag": {
"version": "1.0.2",
"resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz",
"integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==",
"license": "MIT",
"dependencies": {
"has-symbols": "^1.0.3"
},
"engines": {
"node": ">= 0.4"
},
"funding": {
"url": "https://github.com/sponsors/ljharb"
}
},
"node_modules/hasown": {
"version": "2.0.2",
"resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz",
"integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==",
"license": "MIT",
"dependencies": {
"function-bind": "^1.1.2"
},
"engines": {
"node": ">= 0.4"
}
},
"node_modules/math-intrinsics": {
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz",
"integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==",
"license": "MIT",
"engines": {
"node": ">= 0.4"
}
},
"node_modules/mime-db": {
"version": "1.52.0",
"resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz",
"integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==",
"license": "MIT",
"engines": {
"node": ">= 0.6"
}
},
"node_modules/mime-types": {
"version": "2.1.35",
"resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz",
"integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==",
"license": "MIT",
"dependencies": {
"mime-db": "1.52.0"
},
"engines": {
"node": ">= 0.6"
}
},
"node_modules/proxy-from-env": {
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz",
"integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==",
"license": "MIT"
}
}
}

23
package.json Normal file
View File

@ -0,0 +1,23 @@
{
"name": "virtueller-stundenplan",
"version": "0.0.1",
"description": "A library to access the data from virtueller-stundenplan.org",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"homepage": "https://git.jason.red/Jason/virtueller-stundenplan#readme",
"repository": {
"type": "git",
"url": "https://git.jason.red/Jason/virtueller-stundenplan.git"
},
"author": {
"name": "Jason",
"email": "jason@tzsrv.net",
"url": "https://git.jason.red/jason"
},
"license": "CC-BY-NC-4.0",
"dependencies": {
"axios": "^1.8.4"
}
}