version 1.2.7

* update coroutines 1.3.7 -> 1.3.8

.drone.yml

@@ -7,3 +7,24 @@ steps:
   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

Dockerfile

@@ -0,0 +1,8 @@
+FROM adoptopenjdk/openjdk11:alpine-jre
+RUN addgroup -S spring && adduser -S spring -G spring
+#RUN groupadd -r spring && useradd -r -g spring spring # for openjdk:xx builds
+USER spring:spring
+ARG JAR_FILE=build/libs/*.jar
+COPY ${JAR_FILE} thecitadelofricks.jar
+ENTRYPOINT ["java","-Djavax.net.ssl.trustStore=/tcor/cacerts", "-Djavax.net.ssl.trustStorePassword=changeit", "-jar","/thecitadelofricks.jar"]
+VOLUME /tcor

README.md

@@ -1,3 +1,4 @@
+![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)
 [![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)

build.gradle

@@ -1,12 +1,12 @@
 plugins {
-    id 'org.jetbrains.kotlin.jvm' version '1.3.70'
+    id 'org.jetbrains.kotlin.jvm' version '1.3.72'
-    id 'org.jetbrains.kotlin.plugin.spring' version '1.3.70'
+    id 'org.jetbrains.kotlin.plugin.spring' version '1.3.72'
-    id 'org.springframework.boot' version '2.2.5.RELEASE'
+    id 'org.springframework.boot' version '2.3.2.RELEASE'
     id 'io.spring.dependency-management' version '1.0.9.RELEASE'
 }
 
 group 'org.mosad'
-version '1.2.2'
+version '1.2.7'
 
 repositories {
     jcenter()
@@ -14,13 +14,12 @@ repositories {
 
 dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-web'
-    implementation 'org.jetbrains.kotlin:kotlin-reflect'
     implementation 'org.jetbrains.kotlin:kotlin-stdlib'
-    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.3'
+    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.8'
-    implementation 'org.jsoup:jsoup:1.12.2'
+    implementation 'org.jsoup:jsoup:1.13.1'
     implementation 'com.google.code.gson:gson:2.8.6'
 
-    testImplementation 'org.junit.jupiter:junit-jupiter:5.6.0'
+    testImplementation 'org.junit.jupiter:junit-jupiter:5.6.2'
 }
 
 test {

gradle/wrapper/gradle-wrapper.properties

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

gradlew

@@ -82,6 +82,7 @@ esac
 
 CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
 
+
 # Determine the Java command to use to start the JVM.
 if [ -n "$JAVA_HOME" ] ; then
     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
@@ -129,6 +130,7 @@ fi
 if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
     APP_HOME=`cygpath --path --mixed "$APP_HOME"`
     CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    
     JAVACMD=`cygpath --unix "$JAVACMD"`
 
     # We build the pattern for arguments to be converted via cygpath

gradlew.bat

@@ -29,6 +29,9 @@ if "%DIRNAME%" == "" set DIRNAME=.
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
 @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
 
@@ -81,6 +84,7 @@ set CMD_LINE_ARGS=%*
 
 set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
+
 @rem Execute Gradle
 "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
 

src/main/kotlin/org/mosad/thecitadelofricks/APIController.kt

@@ -40,6 +40,7 @@ import org.springframework.web.bind.annotation.RequestParam
 import org.springframework.web.bind.annotation.RestController
 import java.time.LocalDateTime
 import java.util.*
+import kotlin.collections.ArrayList
 
 @RestController
 class APIController {
@@ -47,8 +48,8 @@ class APIController {
     private val logger: Logger = LoggerFactory.getLogger(APIController::class.java)
 
     companion object {
-        const val apiVersion = "1.1.4"
+        const val apiVersion = "1.2.0"
-        const val softwareVersion = "1.2.2"
+        const val softwareVersion = "1.2.7"
         val startTime = System.currentTimeMillis() / 1000
     }
 
@@ -57,18 +58,12 @@ class APIController {
         CacheController()
     }
 
-    // TODO remove this with API version 2.0.0
-    @Deprecated("courses is replaced by courseList", replaceWith = ReplaceWith("courseList()"))
-    @RequestMapping("/courses")
-    fun courses(): CoursesList {
-        return courseList()
-    }
-
     @RequestMapping("/courseList")
-    fun courseList(): CoursesList {
+    fun courseList(): CoursesListRet {
         logger.info("courseList request at ${LocalDateTime.now()}!")
         updateCourseListRequests()
-        return courseList
+
+        return CoursesListRet(courseList.meta, ArrayList(courseList.courses.values))
     }
 
     @RequestMapping("/mensamenu")
@@ -80,7 +75,7 @@ class APIController {
 
     @RequestMapping("/timetable")
     fun timetable(
-        @RequestParam(value = "courseName", defaultValue = "AI4") courseName: String,
+        @RequestParam(value = "course", defaultValue = "AI4") courseName: String,
         @RequestParam(value = "week", defaultValue = "0") week: Int
     ): TimetableCourseWeek {
         logger.info("timetable request at ${LocalDateTime.now()}!")
@@ -88,20 +83,20 @@ class APIController {
         return getTimetable(courseName, week)
     }
 
-    @RequestMapping("/lessonSubjectList")
+    @RequestMapping("/subjectList")
     fun lessonSubjectList(
-        @RequestParam(value = "courseName", defaultValue = "AI4") courseName: String,
+        @RequestParam(value = "course", defaultValue = "AI4") courseName: String,
         @RequestParam(value = "week", defaultValue = "0") week: Int
     ): HashSet<String> {
-        logger.info("lessonSubjectList request at ${LocalDateTime.now()}!")
+        logger.info("subjectList request at ${LocalDateTime.now()}!")
         updateTimetableRequests(courseName)
         return getLessonSubjectList(courseName, week)
     }
 
     @RequestMapping("/lessons")
     fun lesson(
-        @RequestParam(value = "courseName", defaultValue = "AI4") courseName: String,
+        @RequestParam(value = "course", defaultValue = "AI4") courseName: String,
-        @RequestParam(value = "lessonSubject", defaultValue = "Mathematik 4") lessonSubject: String,
+        @RequestParam(value = "subject", defaultValue = "Mathematik 4") lessonSubject: String,
         @RequestParam(value = "week", defaultValue = "0") week: Int
     ): ArrayList<Lesson> {
         logger.info("lesson request at ${LocalDateTime.now()}!")
@@ -121,4 +116,25 @@ class APIController {
         return 200
     }
 
+    /**
+     * Deprecated section
+     */
+
+    // TODO remove this with API version 2.0.0
+    @Deprecated("courses is replaced by courseList", replaceWith = ReplaceWith("courseList()"))
+    @RequestMapping("/courses")
+    fun courses(): CoursesListRet {
+        return courseList()
+    }
+
+    // TODO remove this with API version 2.0.0
+    @Deprecated("the parameter courseName is deprecated please use course", ReplaceWith("timetable(courseName, week)"))
+    @RequestMapping("/timetable", params= ["courseName", "week"])
+    fun timetableDep(
+        @RequestParam(value = "courseName", defaultValue = "AI4") courseName: String,
+        @RequestParam(value = "week", defaultValue = "0") week: Int
+    ): TimetableCourseWeek {
+       return timetable(courseName, week)
+    }
+
 }

src/main/kotlin/org/mosad/thecitadelofricks/DataTypes.kt

@@ -24,13 +24,15 @@ package org.mosad.thecitadelofricks
 
 import java.time.LocalDateTime
 import java.util.*
+import kotlin.collections.HashMap
 
 // data classes for the course part
 data class Course(val courseName: String, val courseLink: String)
 
-data class CoursesMeta(val updateTime: Long, val totalCourses: Int)
+data class CoursesMeta(val updateTime: Long = 0, val totalCourses: Int = 0)
 
-data class CoursesList(val meta: CoursesMeta, val courses: ArrayList<Course>)
+data class CoursesList(val meta: CoursesMeta = CoursesMeta(), val courses: SortedMap<String, Course>)
+data class CoursesListRet(val meta: CoursesMeta = CoursesMeta(), val courses: ArrayList<Course> = ArrayList())
 
 // data classes for the Mensa part
 data class Meal(val day: String, val heading: String, val parts: ArrayList<String>, val additives: String)
@@ -62,7 +64,6 @@ data class TimetableCourseWeek(val meta: TimetableCourseMeta = TimetableCourseMe
 
 
 // data classes for the status part
-data class TimetableCounter(var courseName: String, var requests: Int)
 
 data class Status(
     val time: LocalDateTime,
@@ -72,7 +73,7 @@ data class Status(
     val totalRequests: Int,
     val mensaMenuRequests: Int,
     val courseListRequests: Int,
-    val timetableRequests: ArrayList<TimetableCounter>,
+    val timetableRequests: HashMap<String, Int>,
     val timetableListSize: Int,
     val coursesLastUpdate: Date,
     val mensaLastUpdate: Date,

src/main/kotlin/org/mosad/thecitadelofricks/controller/CacheController.kt

@@ -23,22 +23,19 @@
 package org.mosad.thecitadelofricks.controller
 
 import com.google.gson.Gson
-import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.*
-import kotlinx.coroutines.async
+import org.jsoup.Jsoup
-import kotlinx.coroutines.launch
-import kotlinx.coroutines.runBlocking
 import org.mosad.thecitadelofricks.*
 import org.mosad.thecitadelofricks.hsoparser.CourseListParser
 import org.mosad.thecitadelofricks.hsoparser.MensaParser
 import org.mosad.thecitadelofricks.hsoparser.TimetableParser
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
-import java.io.BufferedWriter
+import java.io.*
-import java.io.File
-import java.io.FileWriter
 import java.util.*
 import java.util.concurrent.Executors
 import kotlin.collections.ArrayList
+import kotlin.collections.HashMap
 import kotlin.collections.HashSet
 import kotlin.concurrent.scheduleAtFixedRate
 
@@ -52,9 +49,9 @@ class CacheController {
     companion object{
         private val logger: Logger = LoggerFactory.getLogger(CacheController::class.java)
 
-        var courseList = CoursesList(CoursesMeta(0, 0), ArrayList())
+        var courseList = CoursesList(CoursesMeta(), sortedMapOf())
         var mensaMenu = MensaMenu(MensaMeta(0,""), MensaWeek(), MensaWeek())
-        var timetableList = ArrayList<TimetableCourseWeek>() // this list contains all timetables
+        var timetableList = HashMap<String, TimetableCourseWeek>() // this list contains all timetables
 
         /**
          * get a timetable, since they may not be cached, we need to make sure it's cached, otherwise download
@@ -63,30 +60,36 @@ class CacheController {
          * @return timetable of the course (Type: [TimetableCourseWeek])
          */
         fun getTimetable(courseName: String, weekIndex: Int): TimetableCourseWeek = runBlocking {
-            val currentTime = System.currentTimeMillis() / 1000
-            var timetable = TimetableWeek()
-            var weekNumberYear = 0
 
-            // check if the timetable already exists and is up to date
+            // TODO just for testing
-            when (timetableList.stream().filter { x -> x.meta.courseName == courseName && x.meta.weekIndex == weekIndex }.findAny().orElse(null)) {
+            if (courseName == "TEST_A" || courseName == "TEST_B") {
-                // there is no such course yet, create one
+                val currentTime = System.currentTimeMillis() / 1000
-                null -> {
+                val timetableLink = "https://mosad.xyz"
-                    val courseLink = courseList.courses.stream().filter { x -> x.courseName == courseName }.findFirst().orElse(null).courseLink
+                val weekNumberYear = 0
-                    val timetableLink = courseLink.replace("week=0","week=$weekIndex")
+                val instr = javaClass.getResourceAsStream("/html/Timetable_normal-week.html")
 
-                    val jobTimetable = async {
+                val htmlDoc = Jsoup.parse(instr,"UTF-8", "https://www.hs-offenburg.de/")
-                        timetable = TimetableParser().getTimeTable(timetableLink)
+                val timetableTest = TimetableParser().parseTimeTable(htmlDoc)
-                        weekNumberYear = TimetableParser().getWeekNumberYear(timetableLink)
-                    }
 
-                    jobTimetable.await()
+                return@runBlocking TimetableCourseWeek(TimetableCourseMeta(currentTime, courseName, weekIndex, weekNumberYear, timetableLink), timetableTest)
-                    timetableList.add(TimetableCourseWeek(TimetableCourseMeta(currentTime, courseName, weekIndex, weekNumberYear, timetableLink), timetable))
-
-                    logger.info("added new timetable for $courseName, week $weekIndex")
-                }
             }
 
-            return@runBlocking timetableList.stream().filter { x -> x.meta.courseName == courseName && x.meta.weekIndex == weekIndex }.findAny().orElse(null)
+            return@runBlocking timetableList.getOrPut("$courseName-$weekIndex") {
+                val timetableLink = courseList.courses[courseName]
+                    ?.courseLink
+                    ?.replace("week=0", "week=$weekIndex") ?: ""
+                val currentTime = System.currentTimeMillis() / 1000
+                var timetable = TimetableWeek()
+                var weekNumberYear = 0
+
+                val timetableJobs = listOf(
+                    async { timetable = TimetableParser().getTimeTable(timetableLink) },
+                    async { weekNumberYear = TimetableParser().getWeekNumberYear(timetableLink) }
+                )
+
+                timetableJobs.awaitAll()
+                TimetableCourseWeek(TimetableCourseMeta(currentTime, courseName, weekIndex, weekNumberYear, timetableLink), timetable)
+            }
         }
 
         /**
@@ -134,9 +137,13 @@ class CacheController {
          */
         private fun asyncUpdateCourseList() = GlobalScope.launch {
             CourseListParser().getCourseLinks(StartupController.courseListURL)?.let {
-                courseList = CoursesList(CoursesMeta(System.currentTimeMillis() / 1000, it.size), it)
+                courseList = CoursesList(CoursesMeta(System.currentTimeMillis() / 1000, it.size), it.toSortedMap())
             }
 
+            // TODO just for testing
+            courseList.courses["TEST_A"] = Course("TEST_A", "https://mosad.xyz")
+            courseList.courses["TEST_B"] = Course("TEST_B", "https://mosad.xyz")
+
             logger.info("Updated courses successful at ${Date(courseList.meta.updateTime * 1000)}")
         }
 
@@ -170,10 +177,10 @@ class CacheController {
             try {
                 timetableList.forEach { timetableCourse ->
                     executor.execute {
-                        timetableCourse.timetable = TimetableParser().getTimeTable(timetableCourse.meta.link)
+                        timetableCourse.value.timetable = TimetableParser().getTimeTable(timetableCourse.value.meta.link)
-                        timetableCourse.meta.updateTime = System.currentTimeMillis() / 1000
+                        timetableCourse.value.meta.updateTime = System.currentTimeMillis() / 1000
 
-                        saveTimetableToCache(timetableCourse) // save the updated timetable to the cache directory
+                        saveTimetableToCache(timetableCourse.value) // save the updated timetable to the cache directory
                     }
 
                 }
@@ -190,12 +197,16 @@ class CacheController {
          * @param timetable a timetable of the type [TimetableCourseWeek]
          */
         private fun saveTimetableToCache(timetable: TimetableCourseWeek) {
-            println(timetable.timetable.toString())
-
             val file = File(StartupController.dirTcorCache, "timetable-${timetable.meta.courseName}-${timetable.meta.weekIndex}.json")
             val writer = BufferedWriter(FileWriter(file))
-            writer.write(Gson().toJson(timetable))
+
-            writer.close()
+            try {
+                writer.write(Gson().toJson(timetable))
+            } catch (e: Exception) {
+                logger.error("something went wrong while trying to write a cache file", e)
+            } finally {
+                writer.close()
+            }
         }
 
         /**

src/main/kotlin/org/mosad/thecitadelofricks/controller/StartupController.kt

@@ -134,7 +134,8 @@ class StartupController {
 
                 try {
                     val timetableObject = JsonParser.parseString(bufferedReader.readLine()).asJsonObject
-                    CacheController.timetableList.add(Gson().fromJson(timetableObject, TimetableCourseWeek().javaClass))
+                    val timetable = Gson().fromJson(timetableObject, TimetableCourseWeek().javaClass)
+                    CacheController.timetableList.put("${timetable.meta.courseName}-${timetable.meta.weekIndex}", timetable)
                 } catch (ex: Exception) {
                     logger.error("error while reading cache", ex)
                 } finally {

src/main/kotlin/org/mosad/thecitadelofricks/controller/StatusController.kt

@@ -26,14 +26,13 @@ import org.mosad.thecitadelofricks.APIController.Companion.apiVersion
 import org.mosad.thecitadelofricks.APIController.Companion.softwareVersion
 import org.mosad.thecitadelofricks.APIController.Companion.startTime
 import org.mosad.thecitadelofricks.Status
-import org.mosad.thecitadelofricks.TimetableCounter
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 import java.net.HttpURLConnection
 import java.net.URL
 import java.time.LocalDateTime
 import java.util.*
-import kotlin.collections.ArrayList
+import kotlin.collections.HashMap
 
 class StatusController {
 
@@ -43,7 +42,7 @@ class StatusController {
         private var totalRequests = 0
         private var mensaMenuRequests = 0
         private var courseListRequests = 0
-        private var timetableRequests = ArrayList<TimetableCounter>()
+        private var timetableRequests = HashMap<String, Int>()
 
         /**
          * if a mensamenu/courseList/timetable is requested update the specific and total request count
@@ -59,11 +58,7 @@ class StatusController {
         }
 
         fun updateTimetableRequests(courseName: String) {
-            timetableRequests.stream().filter { it.courseName == courseName }.findFirst().ifPresentOrElse({
+            timetableRequests[courseName] = timetableRequests.getOrPut(courseName) {0} + 1
-                it.requests++
-            }, {
-                timetableRequests.add(TimetableCounter(courseName, 1))
-            })
             totalRequests++
         }
 
@@ -82,7 +77,7 @@ class StatusController {
             return courseListRequests
         }
 
-        fun getTimetableRequests(): ArrayList<TimetableCounter> {
+        fun getTimetableRequests(): HashMap<String, Int> {
             return timetableRequests
         }
 

src/main/kotlin/org/mosad/thecitadelofricks/hsoparser/CourseListParser.kt

@@ -29,26 +29,25 @@ import java.net.SocketTimeoutException
 
 class CourseListParser {
 
-    var logger: org.slf4j.Logger = LoggerFactory.getLogger(MensaParser::class.java)
+    private var logger: org.slf4j.Logger = LoggerFactory.getLogger(CourseListParser::class.java)
 
     /**
      * return a list of all courses at courseListURL
      * @param courseListURL the url to the course list page
      * @return a ArrayList<Course> with all courses or null if the request was not successful
      */
-    fun getCourseLinks(courseListURL: String): ArrayList<Course>? {
+    fun getCourseLinks(courseListURL: String): HashMap<String, Course>? {
-        val courseLinkList = ArrayList<Course>()
+        val courseLinkList = HashMap<String, Course>()
         try {
             val courseHTML = Jsoup.connect(courseListURL).get()
 
             courseHTML.select("ul.index-group").select("li.Class").select("a[href]").forEachIndexed { _, element ->
-                courseLinkList.add(
+                courseLinkList[element.text()] = Course(
-                    Course(
+                    element.text(),
-                        element.text(),
+                    element.attr("href").replace("http", "https")
-                        element.attr("href").replace("http", "https")
-                    )
                 )
             }
+            logger.info("successfully retrieved course List")
         } catch (ex: SocketTimeoutException) {
             logger.warn("timeout from hs-offenburg.de, updating on next attempt!")
             return null

src/main/kotlin/org/mosad/thecitadelofricks/hsoparser/TimetableParser.kt

@@ -181,4 +181,5 @@ class TimetableParser {
 
         println(" \n")
     }
+
 }

src/main/resources/application.properties

@@ -11,5 +11,5 @@ logging.level.org.springframework.web=INFO
 # ----------------------------------------
 
 # EMBEDDED SERVER CONFIGURATION (ServerProperties)
-server.address=127.0.0.1
+server.address=0.0.0.0
 server.port=8080