Compare commits

...

13 Commits

Author SHA1 Message Date
6f4cb9fd66
Small improvements
- Improve formatting
- Fix some typos
- Mini code improvements
2021-10-13 22:21:43 +02:00
1f1374f112
Make the update scheduling more readable (hopefully) 2021-10-13 22:21:43 +02:00
b783fb6c4f
StatusController: use properties instead of getters 2021-10-13 22:21:42 +02:00
65dc8ea5d2
Also set JVM target to 11 for Java 2021-10-13 22:21:42 +02:00
97efbd0877
Dependency updates
This also replaces JCenter with Maven Central since JCenter is now read-only
2021-10-13 22:21:42 +02:00
c62f576ace
Timetable fixes
- Only one request is made to get the timetable HTML document for parsing the timetable and the weekNumberYear
- On timeouts or other errors, the cached data won't be overwritten with emptiness anymore
- The scheduled updates will now also update the weekNumberYear
2021-10-13 22:21:42 +02:00
8ac78d29b1
Update Kotlin to 1.5.31 2021-10-13 22:21:41 +02:00
024f2b04ce „README.md“ ändern
All checks were successful
continuous-integration/drone the build was successful
2021-10-13 20:09:46 +02:00
bf71d62dc5
version 1.2.8
Some checks failed
continuous-integration/drone the build failed
2021-10-13 20:03:14 +02:00
7dce2c6cfd Merge pull request 'updated mensa URL' (#16) from fix/mensa_url into master
All checks were successful
continuous-integration/drone the build was successful
Reviewed-on: #16
2021-10-13 19:49:53 +02:00
a1dc5656b8
updated mensa URL, thanks to Hannes B.
All checks were successful
continuous-integration/drone the build was successful
2021-10-13 19:47:38 +02:00
dd4c5259d2 Merge pull request 'move ci config from drone to woodpecker' (#18) from fix/ci into master
Some checks failed
continuous-integration/drone the build failed
Reviewed-on: #18
2021-10-13 19:45:32 +02:00
884aab08ed
move ci config from drone to woodpecker
Some checks failed
continuous-integration/drone the build failed
2021-10-13 19:39:37 +02:00
15 changed files with 167 additions and 147 deletions

View File

@ -1,30 +0,0 @@
kind: pipeline
name: default
steps:
- name: test
image: gradle:jdk11
commands:
- gradle test
- name: build
image: gradle:jdk11
commands:
- gradle bootJar
when:
event:
- tag
- name: docker
image: plugins/docker
settings:
username:
from_secret: docker_username
password:
from_secret: docker_password
repo: mosadxyz/tcor
tags:
- latest
when:
event:
- tag

22
.woodpecker.yml Normal file
View File

@ -0,0 +1,22 @@
pipeline:
test:
image: gradle:jdk11
commands:
- gradle test
build:
image: gradle:jdk11
commands:
- gradle bootJar
when:
event:
- tag
docker:
image: plugins/docker
repo: mosadxyz/tcor
tags: latest
secrets:
- username: docker_username
password: docker_password
when:
event:
- tag

View File

@ -1,5 +1,5 @@
![Website](https://img.shields.io/website?down_color=red&down_message=offline&label=tcor.mosad.xyz&up_color=brightgreen&up_message=online&url=https%3A%2F%2Ftcor.mosad.xyz%2Fhealth) ![Website](https://img.shields.io/website?down_color=red&down_message=offline&label=tcor.mosad.xyz&up_color=brightgreen&up_message=online&url=https%3A%2F%2Ftcor.mosad.xyz%2Fhealth)
[![Build Status](https://drone.mosad.xyz/api/badges/Seil0/TheCitadelofRicks/status.svg)](https://drone.mosad.xyz/Seil0/TheCitadelofRicks) [![Build Status](https://ci.mosad.xyz/api/badges/Seil0/TheCitadelofRicks/status.svg)](https://ci.mosad.xyz/Seil0/TheCitadelofRicks)
[![Release](https://img.shields.io/badge/dynamic/json.svg?label=release&url=https://git.mosad.xyz/api/v1/repos/Seil0/TheCitadelofRicks/releases&query=$[0].tag_name)](https://git.mosad.xyz/Seil0/TheCitadelofRicks/releases) [![Release](https://img.shields.io/badge/dynamic/json.svg?label=release&url=https://git.mosad.xyz/api/v1/repos/Seil0/TheCitadelofRicks/releases&query=$[0].tag_name)](https://git.mosad.xyz/Seil0/TheCitadelofRicks/releases)
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
# TheCitadelofRicks # TheCitadelofRicks

View File

@ -1,25 +1,25 @@
plugins { plugins {
id 'org.jetbrains.kotlin.jvm' version '1.4.10' id 'org.jetbrains.kotlin.jvm' version '1.5.31'
id 'org.jetbrains.kotlin.plugin.spring' version '1.4.10' id 'org.jetbrains.kotlin.plugin.spring' version '1.5.31'
id 'org.springframework.boot' version '2.3.3.RELEASE' id 'org.springframework.boot' version '2.5.5'
id 'io.spring.dependency-management' version '1.0.9.RELEASE' id 'io.spring.dependency-management' version '1.0.11.RELEASE'
} }
group 'org.mosad' group 'org.mosad'
version '1.2.7' version '1.2.7'
repositories { repositories {
jcenter() mavenCentral()
} }
dependencies { dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web' implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'org.jetbrains.kotlin:kotlin-stdlib' implementation 'org.jetbrains.kotlin:kotlin-stdlib'
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.8' implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.2'
implementation 'org.jsoup:jsoup:1.13.1' implementation 'org.jsoup:jsoup:1.14.3'
implementation 'com.google.code.gson:gson:2.8.6' implementation 'com.google.code.gson:gson:2.8.8'
testImplementation 'org.junit.jupiter:junit-jupiter:5.6.2' testImplementation 'org.junit.jupiter:junit-jupiter:5.8.1'
} }
test { test {
@ -30,9 +30,17 @@ test {
} }
} }
def jvmTargetVersion = "11"
compileKotlin { compileKotlin {
kotlinOptions.jvmTarget = "11" kotlinOptions.jvmTarget = jvmTargetVersion
kotlinOptions.freeCompilerArgs += "-Xopt-in=kotlin.RequiresOptIn"
}
compileJava {
targetCompatibility = jvmTargetVersion
} }
compileTestKotlin { compileTestKotlin {
kotlinOptions.jvmTarget = "11" kotlinOptions.jvmTarget = jvmTargetVersion
}
compileTestJava {
targetCompatibility = jvmTargetVersion
} }

View File

@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.6.1-bin.zip distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip
zipStoreBase=GRADLE_USER_HOME zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists zipStorePath=wrapper/dists

View File

@ -49,7 +49,7 @@ class APIController {
companion object { companion object {
const val apiVersion = "1.2.0" const val apiVersion = "1.2.0"
const val softwareVersion = "1.2.7" const val softwareVersion = "1.2.8"
val startTime = System.currentTimeMillis() / 1000 val startTime = System.currentTimeMillis() / 1000
} }

View File

@ -58,7 +58,7 @@ data class TimetableDay(val timeslots: Array<ArrayList<Lesson>> = Array(6) { Arr
data class TimetableWeek(val days: Array<TimetableDay> = Array(6) { TimetableDay() }) data class TimetableWeek(val days: Array<TimetableDay> = Array(6) { TimetableDay() })
data class TimetableCourseMeta(var updateTime: Long = 0, val courseName: String = "", val weekIndex: Int = 0, val weekNumberYear: Int = 0, val link: String = "") data class TimetableCourseMeta(var updateTime: Long = 0, val courseName: String = "", val weekIndex: Int = 0, var weekNumberYear: Int = 0, val link: String = "")
data class TimetableCourseWeek(val meta: TimetableCourseMeta = TimetableCourseMeta(), var timetable: TimetableWeek = TimetableWeek()) data class TimetableCourseWeek(val meta: TimetableCourseMeta = TimetableCourseMeta(), var timetable: TimetableWeek = TimetableWeek())

View File

@ -38,6 +38,8 @@ import kotlin.collections.ArrayList
import kotlin.collections.HashMap import kotlin.collections.HashMap
import kotlin.collections.HashSet import kotlin.collections.HashSet
import kotlin.concurrent.scheduleAtFixedRate import kotlin.concurrent.scheduleAtFixedRate
import kotlin.time.Duration
import kotlin.time.ExperimentalTime
class CacheController { class CacheController {
@ -46,11 +48,11 @@ class CacheController {
scheduledUpdates() scheduledUpdates()
} }
companion object{ companion object {
private val logger: Logger = LoggerFactory.getLogger(CacheController::class.java) private val logger: Logger = LoggerFactory.getLogger(CacheController::class.java)
var courseList = CoursesList(CoursesMeta(), sortedMapOf()) var courseList = CoursesList(CoursesMeta(), sortedMapOf())
var mensaMenu = MensaMenu(MensaMeta(0,""), MensaWeek(), MensaWeek()) var mensaMenu = MensaMenu(MensaMeta(0, ""), MensaWeek(), MensaWeek())
var timetableList = HashMap<String, TimetableCourseWeek>() // this list contains all timetables var timetableList = HashMap<String, TimetableCourseWeek>() // this list contains all timetables
/** /**
@ -59,36 +61,52 @@ class CacheController {
* @param weekIndex request week number (current week = 0) * @param weekIndex request week number (current week = 0)
* @return timetable of the course (Type: [TimetableCourseWeek]) * @return timetable of the course (Type: [TimetableCourseWeek])
*/ */
fun getTimetable(courseName: String, weekIndex: Int): TimetableCourseWeek = runBlocking { fun getTimetable(courseName: String, weekIndex: Int): TimetableCourseWeek {
// TODO just for testing // TODO just for testing
if (courseName == "TEST_A" || courseName == "TEST_B") { if (courseName == "TEST_A" || courseName == "TEST_B") {
val currentTime = System.currentTimeMillis() / 1000 val currentTime = System.currentTimeMillis() / 1000
val timetableLink = "https://mosad.xyz" val timetableLink = "https://mosad.xyz"
val weekNumberYear = 0 val weekNumberYear = 0
val instr = javaClass.getResourceAsStream("/html/Timetable_normal-week.html") val instr = CacheController::class.java.getResourceAsStream("/html/Timetable_normal-week.html")
val htmlDoc = Jsoup.parse(instr,"UTF-8", "https://www.hs-offenburg.de/") val timetableParser =
val timetableTest = TimetableParser().parseTimeTable(htmlDoc) TimetableParser(htmlDoc = Jsoup.parse(instr, "UTF-8", "https://www.hs-offenburg.de/"))
val timetableTest = timetableParser.parseTimeTable()
return@runBlocking TimetableCourseWeek(TimetableCourseMeta(currentTime, courseName, weekIndex, weekNumberYear, timetableLink), timetableTest) return TimetableCourseWeek(
TimetableCourseMeta(
currentTime,
courseName,
weekIndex,
weekNumberYear,
timetableLink
), timetableTest ?: TimetableWeek()
)
} }
return@runBlocking timetableList.getOrPut("$courseName-$weekIndex") { val key = "$courseName-$weekIndex"
return if (timetableList.contains(key)) {
timetableList[key]!!
} else {
val timetableLink = courseList.courses[courseName] val timetableLink = courseList.courses[courseName]
?.courseLink ?.courseLink
?.replace("week=0", "week=$weekIndex") ?: "" ?.replace("week=0", "week=$weekIndex") ?: ""
val currentTime = System.currentTimeMillis() / 1000 val currentTime = System.currentTimeMillis() / 1000
var timetable = TimetableWeek()
var weekNumberYear = 0
val timetableJobs = listOf( val timetableParser = TimetableParser(timetableLink)
async { timetable = TimetableParser().getTimeTable(timetableLink) }, val weekNumberYear = timetableParser.parseWeekNumberYear()
async { weekNumberYear = TimetableParser().getWeekNumberYear(timetableLink) } val timetable = timetableParser.parseTimeTable()
)
timetableJobs.awaitAll() TimetableCourseWeek(
TimetableCourseWeek(TimetableCourseMeta(currentTime, courseName, weekIndex, weekNumberYear, timetableLink), timetable) TimetableCourseMeta(
currentTime,
courseName,
weekIndex,
weekNumberYear ?: 0,
timetableLink
), timetable ?: TimetableWeek()
).also { timetableList[key] = it }
} }
} }
@ -133,7 +151,7 @@ class CacheController {
/** /**
* this function updates the courseList * this function updates the courseList
* during the update process the old data will be returned for a API request * during the update process the old data will be returned for an API request
*/ */
private fun asyncUpdateCourseList() = GlobalScope.launch { private fun asyncUpdateCourseList() = GlobalScope.launch {
CourseListParser().getCourseLinks(StartupController.courseListURL)?.let { CourseListParser().getCourseLinks(StartupController.courseListURL)?.let {
@ -149,7 +167,7 @@ class CacheController {
/** /**
* this function updates the mensa menu list * this function updates the mensa menu list
* during the update process the old data will be returned for a API request * during the update process the old data will be returned for an API request
*/ */
private fun asyncUpdateMensa() = GlobalScope.launch { private fun asyncUpdateMensa() = GlobalScope.launch {
val mensaCurrentWeek = MensaParser().getMensaMenu(StartupController.mensaMenuURL) val mensaCurrentWeek = MensaParser().getMensaMenu(StartupController.mensaMenuURL)
@ -165,7 +183,7 @@ class CacheController {
/** /**
* this function updates all existing timetables * this function updates all existing timetables
* during the update process the old data will be returned for a API request * during the update process the old data will be returned for an API request
* a FixedThreadPool is used to make parallel requests for faster updates * a FixedThreadPool is used to make parallel requests for faster updates
*/ */
private fun asyncUpdateTimetables() = GlobalScope.launch { private fun asyncUpdateTimetables() = GlobalScope.launch {
@ -177,7 +195,10 @@ class CacheController {
try { try {
timetableList.forEach { timetableCourse -> timetableList.forEach { timetableCourse ->
executor.execute { executor.execute {
timetableCourse.value.timetable = TimetableParser().getTimeTable(timetableCourse.value.meta.link) val timetableParser = TimetableParser(timetableCourse.value.meta.link)
timetableCourse.value.timetable = timetableParser.parseTimeTable() ?: return@execute
timetableCourse.value.meta.weekNumberYear =
timetableParser.parseWeekNumberYear() ?: return@execute
timetableCourse.value.meta.updateTime = System.currentTimeMillis() / 1000 timetableCourse.value.meta.updateTime = System.currentTimeMillis() / 1000
saveTimetableToCache(timetableCourse.value) // save the updated timetable to the cache directory saveTimetableToCache(timetableCourse.value) // save the updated timetable to the cache directory
@ -228,30 +249,39 @@ class CacheController {
* update the CourseList every 24h, the Timetables every 3h and the Mensa Menu every hour * update the CourseList every 24h, the Timetables every 3h and the Mensa Menu every hour
* doesn't account the change between winter and summer time! * doesn't account the change between winter and summer time!
*/ */
@OptIn(ExperimentalTime::class)
private fun scheduledUpdates() { private fun scheduledUpdates() {
val currentTime = System.currentTimeMillis() val currentTime = System.currentTimeMillis()
val initDelay24h = (86400000 - ((currentTime + 3600000) % 86400000)) + 60000
val initDelay3h = (10800000 - ((currentTime + 3600000) % 10800000)) + 60000 val duration24h = Duration.hours(24).inWholeMilliseconds
val initDelay1h = (3600000 - ((currentTime + 3600000) % 3600000)) + 60000 val duration3h = Duration.hours(3).inWholeMilliseconds
val duration1h = Duration.hours(1).inWholeMilliseconds
val duration1m = Duration.minutes(1).inWholeMilliseconds
// Calculate the initial delay to make the update time independent of the start time
fun calcInitDelay(period: Long) = (period - ((currentTime + duration1h) % period)) + duration1m
val initDelay24h = calcInitDelay(duration24h)
val initDelay3h = calcInitDelay(duration3h)
val initDelay1h = calcInitDelay(duration1h)
// update courseList every 24 hours (time in ms) // update courseList every 24 hours (time in ms)
Timer().scheduleAtFixedRate(initDelay24h, 86400000) { Timer().scheduleAtFixedRate(initDelay24h, duration24h) {
asyncUpdateCourseList() asyncUpdateCourseList()
} }
// update all already existing timetables every 3 hours (time in ms) // update all already existing timetables every 3 hours (time in ms)
Timer().scheduleAtFixedRate(initDelay3h, 10800000) { Timer().scheduleAtFixedRate(initDelay3h, duration3h) {
asyncUpdateTimetables() asyncUpdateTimetables()
} }
// update courses every hour (time in ms) // update courses every hour (time in ms)
Timer().scheduleAtFixedRate(initDelay1h, 3600000) { Timer().scheduleAtFixedRate(initDelay1h, duration1h) {
asyncUpdateMensa() asyncUpdateMensa()
} }
// post to status.mosad.xyz every hour, if an API key is present // post to status.mosad.xyz every hour, if an API key is present
if (StartupController.cachetAPIKey != "0") { if (StartupController.cachetAPIKey != "0") {
Timer().scheduleAtFixedRate(initDelay1h, 3600000) { Timer().scheduleAtFixedRate(initDelay1h, duration1h) {
CachetAPIController.postTotalRequests() CachetAPIController.postTotalRequests()
} }
} }

View File

@ -22,7 +22,7 @@
package org.mosad.thecitadelofricks.controller package org.mosad.thecitadelofricks.controller
import org.mosad.thecitadelofricks.controller.StatusController.Companion.getTotalRequests import org.mosad.thecitadelofricks.controller.StatusController.Companion.totalRequests
import org.slf4j.Logger import org.slf4j.Logger
import org.slf4j.LoggerFactory import org.slf4j.LoggerFactory
import java.io.BufferedReader import java.io.BufferedReader
@ -42,8 +42,8 @@ class CachetAPIController {
fun postTotalRequests() { fun postTotalRequests() {
try { try {
val url = URL("${StartupController.cachetBaseURL}/api/v1/metrics/1/points") val url = URL("${StartupController.cachetBaseURL}/api/v1/metrics/1/points")
val jsonInputString = "{\"value\": ${getTotalRequests() -oldTotalRequests}, \"timestamp\": \"${(System.currentTimeMillis() / 1000)}\"}" val jsonInputString = "{\"value\": ${totalRequests -oldTotalRequests}, \"timestamp\": \"${(System.currentTimeMillis() / 1000)}\"}"
oldTotalRequests = getTotalRequests() oldTotalRequests = totalRequests
val con = url.openConnection() as HttpURLConnection val con = url.openConnection() as HttpURLConnection
con.requestMethod = "POST" con.requestMethod = "POST"

View File

@ -44,7 +44,7 @@ class StartupController {
var cachetAPIKey = "0" var cachetAPIKey = "0"
var cachetBaseURL = "https://status.mosad.xyz" var cachetBaseURL = "https://status.mosad.xyz"
var courseListURL = "https://www.hs-offenburg.de/studium/vorlesungsplaene/" var courseListURL = "https://www.hs-offenburg.de/studium/vorlesungsplaene/"
var mensaMenuURL = "https://www.swfr.de/de/essen-trinken/speiseplaene/mensa-offenburg/" var mensaMenuURL = "https://www.swfr.de/essen-trinken/speiseplaene/mensa-offenburg/"
var mensaName = "Offenburg" var mensaName = "Offenburg"
} }
@ -92,7 +92,7 @@ class StartupController {
mensaMenuURL = try { mensaMenuURL = try {
properties.getProperty("mensaMenuURL") properties.getProperty("mensaMenuURL")
} catch (ex: Exception) { } catch (ex: Exception) {
"https://www.swfr.de/de/essen-trinken/speiseplaene/mensa-offenburg/" "https://www.swfr.de/essen-trinken/speiseplaene/mensa-offenburg/"
} }
mensaName = try { mensaName = try {
@ -113,7 +113,7 @@ class StartupController {
properties.setProperty("cachetAPIKey", "0") properties.setProperty("cachetAPIKey", "0")
properties.setProperty("cachetBaseURL", "https://status.mosad.xyz") properties.setProperty("cachetBaseURL", "https://status.mosad.xyz")
properties.setProperty("mensaMenuURL", "https://www.swfr.de/de/essen-trinken/speiseplaene/mensa-offenburg/") properties.setProperty("mensaMenuURL", "https://www.swfr.de/essen-trinken/speiseplaene/mensa-offenburg/")
properties.setProperty("mensaName", "Offenburg") properties.setProperty("mensaName", "Offenburg")
val outputStream = FileOutputStream(fileConfig) val outputStream = FileOutputStream(fileConfig)
@ -135,7 +135,8 @@ class StartupController {
try { try {
val timetableObject = JsonParser.parseString(bufferedReader.readLine()).asJsonObject val timetableObject = JsonParser.parseString(bufferedReader.readLine()).asJsonObject
val timetable = Gson().fromJson(timetableObject, TimetableCourseWeek().javaClass) val timetable = Gson().fromJson(timetableObject, TimetableCourseWeek().javaClass)
CacheController.timetableList.put("${timetable.meta.courseName}-${timetable.meta.weekIndex}", timetable) CacheController.timetableList["${timetable.meta.courseName}-${timetable.meta.weekIndex}"] =
timetable
} catch (ex: Exception) { } catch (ex: Exception) {
logger.error("error while reading cache", ex) logger.error("error while reading cache", ex)
} finally { } finally {
@ -145,4 +146,4 @@ class StartupController {
} }
} }
} }
} }

View File

@ -39,10 +39,14 @@ class StatusController {
companion object { companion object {
private val logger: Logger = LoggerFactory.getLogger(StatusController::class.java) private val logger: Logger = LoggerFactory.getLogger(StatusController::class.java)
private var totalRequests = 0 var totalRequests = 0
private var mensaMenuRequests = 0 private set
private var courseListRequests = 0 var mensaMenuRequests = 0
private var timetableRequests = HashMap<String, Int>() private set
var courseListRequests = 0
private set
var timetableRequests = HashMap<String, Int>()
private set
/** /**
* if a mensamenu/courseList/timetable is requested update the specific and total request count * if a mensamenu/courseList/timetable is requested update the specific and total request count
@ -58,29 +62,10 @@ class StatusController {
} }
fun updateTimetableRequests(courseName: String) { fun updateTimetableRequests(courseName: String) {
timetableRequests[courseName] = timetableRequests.getOrPut(courseName) {0} + 1 timetableRequests[courseName] = (timetableRequests[courseName] ?: 0) + 1
totalRequests++ totalRequests++
} }
/**
* getters and setters
*/
fun getTotalRequests(): Int {
return totalRequests
}
fun getMensaMenuRequests(): Int {
return mensaMenuRequests
}
fun getCourseListRequests(): Int {
return courseListRequests
}
fun getTimetableRequests(): HashMap<String, Int> {
return timetableRequests
}
fun getStatus(): Status { fun getStatus(): Status {
val currentTime = System.currentTimeMillis() / 1000 val currentTime = System.currentTimeMillis() / 1000
val minutes = (currentTime - startTime) % 3600 / 60 val minutes = (currentTime - startTime) % 3600 / 60
@ -112,10 +97,10 @@ class StatusController {
"$days days, $hours:$minutes", "$days days, $hours:$minutes",
apiVersion, apiVersion,
softwareVersion, softwareVersion,
getTotalRequests(), totalRequests,
getMensaMenuRequests(), mensaMenuRequests,
getCourseListRequests(), courseListRequests,
getTimetableRequests(), timetableRequests,
CacheController.timetableList.size, CacheController.timetableList.size,
Date(CacheController.courseList.meta.updateTime * 1000), Date(CacheController.courseList.meta.updateTime * 1000),
Date(CacheController.mensaMenu.meta.updateTime * 1000), Date(CacheController.mensaMenu.meta.updateTime * 1000),

View File

@ -28,26 +28,37 @@ import org.mosad.thecitadelofricks.Lesson
import org.mosad.thecitadelofricks.TimetableWeek import org.mosad.thecitadelofricks.TimetableWeek
import org.slf4j.LoggerFactory import org.slf4j.LoggerFactory
class TimetableParser { /**
* @param timetableURL the URL of the timetable you want to get
* @param htmlDoc the html document to use (the timetableURL will be ignored if this value is present)
*/
class TimetableParser(timetableURL: String? = null, htmlDoc: Document? = null) {
private var logger: org.slf4j.Logger = LoggerFactory.getLogger(TimetableParser::class.java) private var logger: org.slf4j.Logger = LoggerFactory.getLogger(TimetableParser::class.java)
private val days = arrayOf("Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday") private val days = arrayOf("Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday")
private val htmlDoc: Document? =
htmlDoc
?: if (timetableURL == null) {
null
} else {
try {
Jsoup.connect(timetableURL).get()
} catch (gex: Exception) {
logger.error("general TimetableParser error", gex)
null
}
}
/** /**
* get the timetable from the given url * parse the timetable from the previously given url
* the timetable is organised per row not per column; * the timetable is organised per row not per column;
* Mon 1, Tue 1, Wed 1, Thur 1, Fri 1, Sat 1, Mon 2 and so on * Mon 1, Tue 1, Wed 1, Thur 1, Fri 1, Sat 1, Mon 2 and so on
* @param timetableURL the URL of the timetable you want to get
*/ */
fun getTimeTable(timetableURL: String): TimetableWeek { fun parseTimeTable(): TimetableWeek? {
return try { if (htmlDoc == null) {
parseTimeTable(Jsoup.connect(timetableURL).get()) return null
} catch (gex: Exception) {
logger.error("general TimetableParser error", gex)
TimetableWeek()
} }
}
fun parseTimeTable(htmlDoc: Document): TimetableWeek {
val timetableWeek = TimetableWeek() val timetableWeek = TimetableWeek()
val rows = htmlDoc.select("table.timetable").select("tr[scope=\"row\"]") val rows = htmlDoc.select("table.timetable").select("tr[scope=\"row\"]")
@ -61,7 +72,7 @@ class TimetableParser {
var lessonIndexDay = 0 // the index of the lesson per timeslot var lessonIndexDay = 0 // the index of the lesson per timeslot
// elements are now all lessons, including empty ones // elements are now all lessons, including empty ones
row.select("td.lastcol, td[style]").forEach {element -> row.select("td.lastcol, td[style]").forEach { element ->
// if there is a lecture with rowspan="2", we need to shift everything by one to the left. This is stupid and ugly there needs to bee an API // if there is a lecture with rowspan="2", we need to shift everything by one to the left. This is stupid and ugly there needs to bee an API
if ((sDay > -1 && sRow > -1) && (sDay == day && ((sRow + 1) == rowIndex))) { if ((sDay > -1 && sRow > -1) && (sDay == day && ((sRow + 1) == rowIndex))) {
@ -104,8 +115,7 @@ class TimetableParser {
lessonIndexDay++ lessonIndexDay++
if (element.hasClass("lastcol")) if (element.hasClass("lastcol")) {
{
day++ day++
lessonIndexDay = 0 lessonIndexDay = 0
} }
@ -117,19 +127,13 @@ class TimetableParser {
} }
/** /**
* get the week number of the year for the timetable * parse the week number of the year for the timetable
* @param timetableURL the URL of the timetable you want to get
*/ */
fun getWeekNumberYear(timetableURL: String): Int { fun parseWeekNumberYear(): Int? {
return try { if (htmlDoc == null) {
parseWeekNumberYear(Jsoup.connect(timetableURL).get()) return null
} catch (gex: Exception) {
logger.error("general TimetableParser error", gex)
0
} }
}
fun parseWeekNumberYear(htmlDoc: Document): Int {
return htmlDoc.select("h1.timetable-caption").text().substringAfter("- ") return htmlDoc.select("h1.timetable-caption").text().substringAfter("- ")
.substringBefore(".").replace(" ", "").toInt() .substringBefore(".").replace(" ", "").toInt()
} }

View File

@ -28,7 +28,7 @@ import org.junit.jupiter.api.Test
import java.io.File import java.io.File
internal class MensaParserTest { internal class MensaParserTest {
private val mensaMenuURL = "https://www.swfr.de/de/essen-trinken/speiseplaene/mensa-offenburg/" private val mensaMenuURL = "https://www.swfr.de/essen-trinken/speiseplaene/mensa-offenburg/"
@Test @Test
fun parseMensaMenuNormalWeek() { fun parseMensaMenuNormalWeek() {
@ -57,4 +57,4 @@ internal class MensaParserTest {
val urlNextWeek = MensaParser().getMenuLinkNextWeek(mensaMenuURL) // this need a connection to the swfr server val urlNextWeek = MensaParser().getMenuLinkNextWeek(mensaMenuURL) // this need a connection to the swfr server
Assertions.assertNotNull(urlNextWeek) Assertions.assertNotNull(urlNextWeek)
} }
} }

View File

@ -32,8 +32,8 @@ class TimetableParserTest {
@Test @Test
fun parseTimetableNormalWeek() { fun parseTimetableNormalWeek() {
val htmlFile = File(TimetableParserTest::class.java.getResource("/html/Timetable_normal-week.html").path) val htmlFile = File(TimetableParserTest::class.java.getResource("/html/Timetable_normal-week.html").path)
val htmlDoc = Jsoup.parse(htmlFile,"UTF-8", "https://www.hs-offenburg.de/") val htmlDoc = Jsoup.parse(htmlFile, "UTF-8", "https://www.hs-offenburg.de/")
val actualTimetable = TimetableParser().parseTimeTable(htmlDoc).toString().trim() val actualTimetable = TimetableParser(htmlDoc = htmlDoc).parseTimeTable().toString().trim()
val expectedTimetable = TimetableParserTest::class.java.getResource("/expected/Timetable_normal-week.txt").readText().trim() val expectedTimetable = TimetableParserTest::class.java.getResource("/expected/Timetable_normal-week.txt").readText().trim()
Assertions.assertEquals(expectedTimetable, actualTimetable) Assertions.assertEquals(expectedTimetable, actualTimetable)
@ -42,8 +42,8 @@ class TimetableParserTest {
@Test @Test
fun parseTimetableEmptyWeek() { fun parseTimetableEmptyWeek() {
val htmlFile = File(TimetableParserTest::class.java.getResource("/html/Timetable_empty-week.html").path) val htmlFile = File(TimetableParserTest::class.java.getResource("/html/Timetable_empty-week.html").path)
val htmlDoc = Jsoup.parse(htmlFile,"UTF-8", "https://www.hs-offenburg.de/") val htmlDoc = Jsoup.parse(htmlFile, "UTF-8", "https://www.hs-offenburg.de/")
val actualTimetable = TimetableParser().parseTimeTable(htmlDoc).toString().trim() val actualTimetable = TimetableParser(htmlDoc = htmlDoc).parseTimeTable().toString().trim()
val expectedTimetable = TimetableParserTest::class.java.getResource("/expected/Timetable_empty-week.txt").readText().trim() val expectedTimetable = TimetableParserTest::class.java.getResource("/expected/Timetable_empty-week.txt").readText().trim()
Assertions.assertEquals(expectedTimetable, actualTimetable) Assertions.assertEquals(expectedTimetable, actualTimetable)
@ -52,8 +52,8 @@ class TimetableParserTest {
@Test @Test
fun parseWeekNumberYear() { fun parseWeekNumberYear() {
val htmlFile = File(TimetableParserTest::class.java.getResource("/html/Timetable_normal-week.html").path) val htmlFile = File(TimetableParserTest::class.java.getResource("/html/Timetable_normal-week.html").path)
val htmlDoc = Jsoup.parse(htmlFile,"UTF-8", "https://www.hs-offenburg.de/") val htmlDoc = Jsoup.parse(htmlFile, "UTF-8", "https://www.hs-offenburg.de/")
val actualWeekNumberYear = TimetableParser().parseWeekNumberYear(htmlDoc) val actualWeekNumberYear = TimetableParser(htmlDoc = htmlDoc).parseWeekNumberYear()
Assertions.assertEquals(42, actualWeekNumberYear) Assertions.assertEquals(42, actualWeekNumberYear)
} }

View File

@ -1,7 +1,7 @@
<div id="speiseplan-tabs"> <div id="speiseplan-tabs">
<div id="tab-menu-container" class="row"> <div id="tab-menu-container" class="row">
<div class="col-md-1 col-xs-6"> <div class="col-md-1 col-xs-6">
<a class="prev-week" title="eine Woche zurück" href="/de/essen-trinken/speiseplaene/mensa-offenburg/?tx_swfrspeiseplan_pi1%5BweekToShow%5D=0&amp;tx_swfrspeiseplan_pi1%5Baction%5D=show&amp;tx_swfrspeiseplan_pi1%5Bcontroller%5D=Speiseplan&amp;cHash=ad074b11cc01a680e4c0d0675dd1f91c"><img src="/fileadmin/templates/images/keil-grau-links.png" width="16" height="16" alt="" /><span class="d-inline d-sm-none">vorherige Woche</span></a> <a class="prev-week" title="eine Woche zurück" href="/essen-trinken/speiseplaene/mensa-offenburg/?tx_swfrspeiseplan_pi1%5BweekToShow%5D=0&amp;tx_swfrspeiseplan_pi1%5Baction%5D=show&amp;tx_swfrspeiseplan_pi1%5Bcontroller%5D=Speiseplan&amp;cHash=ad074b11cc01a680e4c0d0675dd1f91c"><img src="/fileadmin/templates/images/keil-grau-links.png" width="16" height="16" alt="" /><span class="d-inline d-sm-none">vorherige Woche</span></a>
</div> </div>
<div class="col-md-10"> <div class="col-md-10">
<ul class="nav classic-tabs tabs-primary" role="tablist"> <ul class="nav classic-tabs tabs-primary" role="tablist">
@ -13,7 +13,7 @@
<li class="col-md-2"><a href="#tab-sat" class="nav-link" data-toggle="tab" role="tab">Sa 14.03.</a></li> <li class="col-md-2"><a href="#tab-sat" class="nav-link" data-toggle="tab" role="tab">Sa 14.03.</a></li>
</ul> </ul>
</div> </div>
<div class="col-md-1 col-xs-6 pull-right"><a class="next-week text-right" title="eine Woche weiter" href="/de/essen-trinken/speiseplaene/mensa-offenburg/?tx_swfrspeiseplan_pi1%5BweekToShow%5D=2&amp;tx_swfrspeiseplan_pi1%5Baction%5D=show&amp;tx_swfrspeiseplan_pi1%5Bcontroller%5D=Speiseplan&amp;cHash=3c3048ebdd7f42a104bd780a0a6a0fd1"><span class="d-inline d-sm-none">nächste Woche</span><img src="/fileadmin/templates/images/keil-grau-rechts.png" width="16" height="16" alt="" /></a></div> <div class="col-md-1 col-xs-6 pull-right"><a class="next-week text-right" title="eine Woche weiter" href="/essen-trinken/speiseplaene/mensa-offenburg/?tx_swfrspeiseplan_pi1%5BweekToShow%5D=2&amp;tx_swfrspeiseplan_pi1%5Baction%5D=show&amp;tx_swfrspeiseplan_pi1%5Bcontroller%5D=Speiseplan&amp;cHash=3c3048ebdd7f42a104bd780a0a6a0fd1"><span class="d-inline d-sm-none">nächste Woche</span><img src="/fileadmin/templates/images/keil-grau-rechts.png" width="16" height="16" alt="" /></a></div>
</div> </div>
<div class="row"> <div class="row">
<div class="col-sm-4"> <div class="col-sm-4">
@ -34,12 +34,12 @@
</div> </div>
<div class="col-sm-4 pt-3"> <div class="col-sm-4 pt-3">
<div class="hide-with-allergenes"> <div class="hide-with-allergenes">
<p><a download="Mensa_Offenburg_KW_11-2020.pdf" title="Wochenplan in Farbe herunterladen" target="_blank" href="/de/essen-trinken/speiseplaene/mensa-offenburg/?type=99&amp;tx_swfrspeiseplan_pi1%5BweekToShow%5D=1&amp;tx_swfrspeiseplan_pi1%5Bcolored%5D=1&amp;tx_swfrspeiseplan_pi1%5Bort%5D=651&amp;tx_swfrspeiseplan_pi1%5Baction%5D=buildPdf&amp;tx_swfrspeiseplan_pi1%5Bcontroller%5D=Speiseplan&amp;cHash=4de091579c564e42f79473da2701f179"><i class="fas fa-file-download" aria-hidden="true"></i> Wochenplan farbig</a></p> <p><a download="Mensa_Offenburg_KW_11-2020.pdf" title="Wochenplan in Farbe herunterladen" target="_blank" href="/essen-trinken/speiseplaene/mensa-offenburg/?type=99&amp;tx_swfrspeiseplan_pi1%5BweekToShow%5D=1&amp;tx_swfrspeiseplan_pi1%5Bcolored%5D=1&amp;tx_swfrspeiseplan_pi1%5Bort%5D=651&amp;tx_swfrspeiseplan_pi1%5Baction%5D=buildPdf&amp;tx_swfrspeiseplan_pi1%5Bcontroller%5D=Speiseplan&amp;cHash=4de091579c564e42f79473da2701f179"><i class="fas fa-file-download" aria-hidden="true"></i> Wochenplan farbig</a></p>
<p><a download="Mensa_Offenburg_KW_11-2020.pdf" title="Wochenplan in schwarz-weiß herunterladen" target="_blank" href="/de/essen-trinken/speiseplaene/mensa-offenburg/?type=99&amp;tx_swfrspeiseplan_pi1%5BweekToShow%5D=1&amp;tx_swfrspeiseplan_pi1%5Bcolored%5D=0&amp;tx_swfrspeiseplan_pi1%5Bort%5D=651&amp;tx_swfrspeiseplan_pi1%5Baction%5D=buildPdf&amp;tx_swfrspeiseplan_pi1%5Bcontroller%5D=Speiseplan&amp;cHash=84edf4562bdc95f103b70ef99e4d7af6"><i class="fas fa-file-download" aria-hidden="true"></i> Wochenplan s/w</a></p> <p><a download="Mensa_Offenburg_KW_11-2020.pdf" title="Wochenplan in schwarz-weiß herunterladen" target="_blank" href="/essen-trinken/speiseplaene/mensa-offenburg/?type=99&amp;tx_swfrspeiseplan_pi1%5BweekToShow%5D=1&amp;tx_swfrspeiseplan_pi1%5Bcolored%5D=0&amp;tx_swfrspeiseplan_pi1%5Bort%5D=651&amp;tx_swfrspeiseplan_pi1%5Baction%5D=buildPdf&amp;tx_swfrspeiseplan_pi1%5Bcontroller%5D=Speiseplan&amp;cHash=84edf4562bdc95f103b70ef99e4d7af6"><i class="fas fa-file-download" aria-hidden="true"></i> Wochenplan s/w</a></p>
</div> </div>
<div class="show-with-allergenes"> <div class="show-with-allergenes">
<p><a download="Mensa_Offenburg_KW_11-2020.pdf" title="Wochenplan in Farbe herunterladen" target="_blank" href="/de/essen-trinken/speiseplaene/mensa-offenburg/?type=99&amp;tx_swfrspeiseplan_pi1%5BweekToShow%5D=1&amp;tx_swfrspeiseplan_pi1%5Bcolored%5D=1&amp;tx_swfrspeiseplan_pi1%5Bort%5D=651&amp;tx_swfrspeiseplan_pi1%5Baction%5D=buildPdfAllergenes&amp;tx_swfrspeiseplan_pi1%5Bcontroller%5D=Speiseplan&amp;cHash=51f0f1e0083f9ef48038920dfb676eb6"><i class="fas fa-file-download" aria-hidden="true"></i> Wochenplan farbig</a></p> <p><a download="Mensa_Offenburg_KW_11-2020.pdf" title="Wochenplan in Farbe herunterladen" target="_blank" href="/essen-trinken/speiseplaene/mensa-offenburg/?type=99&amp;tx_swfrspeiseplan_pi1%5BweekToShow%5D=1&amp;tx_swfrspeiseplan_pi1%5Bcolored%5D=1&amp;tx_swfrspeiseplan_pi1%5Bort%5D=651&amp;tx_swfrspeiseplan_pi1%5Baction%5D=buildPdfAllergenes&amp;tx_swfrspeiseplan_pi1%5Bcontroller%5D=Speiseplan&amp;cHash=51f0f1e0083f9ef48038920dfb676eb6"><i class="fas fa-file-download" aria-hidden="true"></i> Wochenplan farbig</a></p>
<p><a download="Mensa_Offenburg_KW_11-2020.pdf" title="Wochenplan in schwarz-weiß herunterladen" target="_blank" href="/de/essen-trinken/speiseplaene/mensa-offenburg/?type=99&amp;tx_swfrspeiseplan_pi1%5BweekToShow%5D=1&amp;tx_swfrspeiseplan_pi1%5Bcolored%5D=0&amp;tx_swfrspeiseplan_pi1%5Bort%5D=651&amp;tx_swfrspeiseplan_pi1%5Baction%5D=buildPdfAllergenes&amp;tx_swfrspeiseplan_pi1%5Bcontroller%5D=Speiseplan&amp;cHash=c3a9d1eafce78d8f8d281c6060be989c"><i class="fas fa-file-download" aria-hidden="true"></i> Wochenplan s/w</a></p> <p><a download="Mensa_Offenburg_KW_11-2020.pdf" title="Wochenplan in schwarz-weiß herunterladen" target="_blank" href="/essen-trinken/speiseplaene/mensa-offenburg/?type=99&amp;tx_swfrspeiseplan_pi1%5BweekToShow%5D=1&amp;tx_swfrspeiseplan_pi1%5Bcolored%5D=0&amp;tx_swfrspeiseplan_pi1%5Bort%5D=651&amp;tx_swfrspeiseplan_pi1%5Baction%5D=buildPdfAllergenes&amp;tx_swfrspeiseplan_pi1%5Bcontroller%5D=Speiseplan&amp;cHash=c3a9d1eafce78d8f8d281c6060be989c"><i class="fas fa-file-download" aria-hidden="true"></i> Wochenplan s/w</a></p>
</div> </div>
</div> </div>
<div class="col-sm-4 pt-3"> <div class="col-sm-4 pt-3">
@ -510,4 +510,4 @@
</div> </div>
</div> </div>
</div> </div>
</div> </div>