junit5

.gitattributes

@@ -0,0 +1 @@
+src/test/resources/* linguist-vendored

.github/workflows/develop-pre-release.yml

@@ -0,0 +1,52 @@
+name: Develop Pre-Release
+on:
+  push:
+    branches:
+      - "develop"
+
+jobs:
+  develop-pre-release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 21
+        uses: actions/setup-java@v1
+        with:
+          java-version: 21
+          java-package: jdk+fx
+      - name: Cache local Maven repository
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+      - name: Build and test
+        run: ./mvnw -B package docker:build -P docker
+
+      - name: SonarCloud Scan
+        run: ./mvnw -B org.jacoco:jacoco-maven-plugin:prepare-agent sonar:sonar -Dsonar.projectKey=mediathekview_MServer -Dsonar.organization=mediathekview -Dsonar.host.url=https://sonarcloud.io -Dsonar.login=$SONAR_TOKEN
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+
+      - name: Publish docker container
+        run: ./mvnw -B docker:push -P docker -DskipTests -Ddocker.username=$DOCKER_USERNAME -Ddocker.password=$DOCKER_PASSWORD
+        env:
+          DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Publish GitHub pre-Release
+        uses: marvinpinto/action-automatic-releases@latest
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          automatic_release_tag: "latest-develop"
+          prerelease: true
+          title: "Development Build"
+          files: |
+            LICENSE.md
+            target/*.jar
+            target/*.tar.*
+            target/*.zip
+            target/classes/THIRD-PARTY.txt

.github/workflows/maven.yml

@@ -0,0 +1,30 @@
+name: Build and test develop
+
+on: [ push,pull_request ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 21
+        uses: actions/setup-java@v1
+        with:
+          java-version: 21
+          java-package: jdk+fx
+      - name: Cache local Maven repository
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+      - name: Build and test with Maven
+        run: ./mvnw -B clean verify
+      - name: SonarCloud Scan
+        run: ./mvnw -B sonar:sonar -Dsonar.projectKey=mediathekview_MServer -Dsonar.organization=mediathekview -Dsonar.host.url=https://sonarcloud.io -Dsonar.login=$SONAR_TOKEN -Dsonar.coverage.jacoco.xmlReportPaths=target/site/jacoco/jacoco.xml -Dsonar.junit.reportPaths=target/surefire-reports
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitignore

@@ -15,10 +15,16 @@ start*.sh
 .classpath
 .project
 .settings/
-
+*.iml
 .idea
+out/
 build/
 
-/src/main/resources/version.properties
+version.properties
 RepoZugang.properties
 
+/logs/
+
+logs/
+/target/
+/.checkstyle

.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar

ARCHITECTURE_OVERVIEW.adoc

@@ -0,0 +1,93 @@
+= Architecture Overview
+:toc: macro
+
+MServer is a free open-source software that crawls the media libraries of the German-speaking public broadcasters and prepares them as a machine-readable list for clients such as https://github.com/mediathekview/MediathekView[MediathekView].
+
+toc::[]
+
+== Context
+
+image:docs/architecture/images/System_Context.svg[System context]
+
+A simplified overview of the MediathekView system context.
+
+=== Administrator (user)
+
+The only real user of MServer is the administrator who configures and runs it.
+
+=== Public broadcaster media libraries (external system)
+
+Each public broadcaster media library is an own external system and needs its own crawler.
+For some media libraries, no API exists, in which case the website itself is examined.
+
+=== MediathekView (external system)
+
+https://github.com/mediathekview/MediathekView[MediathekView] is the main supported client in the form of a desktop application.
+
+=== MediathekViewWeb (external system)
+
+https://github.com/mediathekview/MediathekViewWeb[MediathekViewWeb] is the second most important client in the form of a web application.
+
+=== Other clients (external system)
+
+Other clients like https://github.com/mediathekview/zapp[Zapp]
+, https://github.com/mediathekview/plugin.video.mediathekview[MediathekView Kodi Plugin] and other, often unknown, clients.
+
+== Quality Goals
+
+[cols="<,>"]
+|===
+|Quality Goal |Motivation/description
+
+|Easy to configure and operate (Configurability) |For the administrator, it is very easy and quick to configure and operate MServer
+|Good performance (Efficiency) |The application runs very fast and uses the system resources as good as possible
+|Machine-readable output (Interoperability) |Results are machine-readable and easy for clients to consume
+|Good maintainability |It's easy to change and adapt to the changes in the media libraries
+|Good reliability |It doesn't crash despite errors, but continues to run until its task is completed
+|===
+
+== Solution Strategy
+
+[cols="<,>"]
+|===
+|Quality Goal |Matching approaches in the solution
+
+|Easy to configure and operate (Configurability) a|
+* A YAML configuration file for the entire application with overridable default values and comments in the configuration
+* Packaged as executable JAR and Docker container
+|Good performance (Efficiency) |Using the Java Fork/Join framework to run all crawlers at the same time and divide up their work
+|Machine-readable output (Interoperability) |The results can be saved as a normal JSON file or as the custom JSON-like legacy format used by the old server
+|Good maintainability a|
+* Each media library has its own crawler which is stored in its own package
+* The Java version and dependencies are kept up to date
+* Clean code is emphasized and checked via SonarQube
+* Every change is reviewed via a code review
+
+|Good reliability |All exceptions are handled and none are passed through to the outside
+|===
+
+== Architectural Overview Diagram
+
+image:docs/architecture/images/Architectural_Overview.svg[Architectural Overview]
+
+An informal architecture overview diagram for MServer
+
+=== YAML Configuration
+
+How many threads are allowed to use, which crawlers should run and crawler configurations are set in the YAML configuration of MServer.
+
+=== Yacl4J
+
+A library to read the YAML configuration as objects.
+
+=== Crawler Manager
+
+Starts all configured crawlers, collects the results and start the filmlist writing.
+
+=== AbstractCrawler
+
+Contains basic logic needed in every crawler like the work splitting.
+
+=== Crawler
+
+The heart of MServer crawlers for the public broadcaster media libraries.

CODE_OF_CONDUCT.md

@@ -0,0 +1,70 @@
+# Code of Conduct - MediathekView
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban
+temporarily or permanently any contributor for other behaviors that they deem
+inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at <info@mediathekview.de>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
+[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
+[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
+and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).