commit c81f3ea29e62bb9409618d3c636496197700110f Author: Hartmut Bauer Date: Wed Mar 12 00:30:40 2025 +0100 initial commit diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..f91f646 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,12 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + +# Binary files should be left untouched +*.jar binary + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1b6985c --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..13566b8 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/google-java-format.xml b/.idea/google-java-format.xml new file mode 100644 index 0000000..05946a8 --- /dev/null +++ b/.idea/google-java-format.xml @@ -0,0 +1,7 @@ + + + + + \ No newline at end of file diff --git a/.idea/gradle.xml b/.idea/gradle.xml new file mode 100644 index 0000000..ce1c62c --- /dev/null +++ b/.idea/gradle.xml @@ -0,0 +1,16 @@ + + + + + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml new file mode 100644 index 0000000..8d66637 --- /dev/null +++ b/.idea/inspectionProfiles/Project_Default.xml @@ -0,0 +1,5 @@ + + + + \ No newline at end of file diff --git a/.idea/kotlinc.xml b/.idea/kotlinc.xml new file mode 100644 index 0000000..178471d --- /dev/null +++ b/.idea/kotlinc.xml @@ -0,0 +1,16 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..52871e3 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..f92f716 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,60 @@ +plugins { + kotlin("jvm") version masterLibs.versions.kotlinVersion + `java-library` + `maven-publish` + alias(masterLibs.plugins.dokkaPlugin) + alias(masterLibs.plugins.versionPlugin) +} + +group = "net.keinekekse" +version = masterLibs.versions.utilLibraryVersion.get() +description = "Kotlin Utility Library" +extra["displayname"] = "Utility Library" +extra["copyright"] = "Copyright (c) 2025 Hartmut Bauer" + +repositories { + maven("https://nexus.keinekekse.net/repository/maven-public/") +} + +dependencies {} + +java { + toolchain { + languageVersion.set(JavaLanguageVersion.of(masterLibs.versions.javaVersion.get())) + } + withSourcesJar() +} + +/* Generierte Dokka-Doku als javadoc.jar ausgeben (s.a. "publishing") +tasks.register("dokkaJar") { + group = "build" + description = "Assembles a JAR containing the Dokka documentation." + dependsOn(tasks.dokkaGeneratePublicationHtml) // Ensure Dokka is generated before creating the JAR +// dependsOn(tasks.dokkaGeneratePublicationJavadoc) // Ensure Dokka is generated before creating the JAR + archiveClassifier.set("javadoc") + from(layout.buildDirectory.dir("dokka")) // Use the output directory of Dokka +} +*/ + +publishing { + repositories { + maven { + credentials { + username = "admin" + password = "admin123" + } + url = uri("https://nexus.keinekekse.net/repository/maven-releases/") + } + } + publications.create("maven") { + from(components["java"]) +// artifact(tasks["dokkaJar"]) + } +} + +// ./gradlew dokkaGenerate +dokka { + dokkaPublications.html { + outputDirectory.set(project.file("docs/api")) + } +} diff --git a/buildnumber.properties b/buildnumber.properties new file mode 100644 index 0000000..7cb1aa6 --- /dev/null +++ b/buildnumber.properties @@ -0,0 +1,3 @@ +#auto generated +#Sun Mar 09 18:10:28 CET 2025 +build.number=66 diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..9832217 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,3 @@ +kotlin.code.style=official +org.gradle.configuration-cache=true +org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..5845de2 --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,8 @@ +[versions] +junit-jupiter-engine = "5.11.1" + +[libraries] +junit-jupiter-engine = { module = "org.junit.jupiter:junit-jupiter-engine", version.ref = "junit-jupiter-engine" } + +[plugins] +kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version = "2.0.21" } diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..a4b76b9 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..37f853b --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..f3b75f3 --- /dev/null +++ b/gradlew @@ -0,0 +1,251 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed 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. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +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 + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..9d21a21 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,94 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +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" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +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 %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..081e190 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,24 @@ +pluginManagement { + repositories { + maven("https://nexus.keinekekse.net/repository/maven-public/") + gradlePluginPortal() + } +} + +plugins { + // Apply the foojay-resolver plugin to allow automatic download of JDKs + id("org.gradle.toolchains.foojay-resolver-convention") version "0.9.0" +} + +rootProject.name = "util" + +dependencyResolutionManagement { + repositories { + maven("https://nexus.keinekekse.net/repository/maven-public/") + } + versionCatalogs { + create("masterLibs") { + from("net.keinekekse:version-catalog:55") + } + } +} diff --git a/src/main/kotlin/net/keinekekse/config/config.kt b/src/main/kotlin/net/keinekekse/config/config.kt new file mode 100644 index 0000000..26fc738 --- /dev/null +++ b/src/main/kotlin/net/keinekekse/config/config.kt @@ -0,0 +1,40 @@ +package net.keinekekse.config + +import java.io.InputStream +import java.util.* + +private const val CONFIG_FILE_NAME = "config.properties" +private const val ERROR_LOADING_CONFIG = "Could not load configuration from $CONFIG_FILE_NAME" + +// TODO mit WAR testen wg. Pfad zu config.properties +/** + * Projekt-Properties + * + * Die Datei ```config.properties``` wird aus dem JAR-root geladen. + * (-> in ```main/resources``` anlegen) + * + * ``` + * val prop: String = ConfigProperties.get("some.prop") + * ``` + */ +object ConfigProperties { + private val properties = Properties() + + init { + loadConfigFile() + } + + private fun loadConfigFile() { + val configFileStream: InputStream? = + javaClass.classLoader.getResourceAsStream(CONFIG_FILE_NAME) + if (configFileStream == null) { + throw IllegalStateException(ERROR_LOADING_CONFIG) + } + + configFileStream.use { + properties.load(it) + } + } + + fun get(key: String): String = properties.getProperty(key) +} diff --git a/src/main/kotlin/net/keinekekse/exec/exec.kt b/src/main/kotlin/net/keinekekse/exec/exec.kt new file mode 100644 index 0000000..ee9a5bd --- /dev/null +++ b/src/main/kotlin/net/keinekekse/exec/exec.kt @@ -0,0 +1,94 @@ +package net.keinekekse.exec + +import java.io.File +import java.io.IOException +import java.util.concurrent.TimeUnit + +class CommandExecutionException(message: String) : Exception(message) + +private const val IO_EXCEPTION_CODE = 0x10000 +private const val INTERRUPTED_EXCEPTION_CODE = 0x10001 +private const val GENERIC_EXCEPTION_CODE = 0x10002 + +/** + * Runs program in list [arguments] and saves result to [stdout], [stderr] and [rc]. + * + * A return code of >=0x10000 in [rc] signals an exception with the stack trace + * in [stderr]. + * + * ``` + * val runResult = ExecutionResult(listOf("ebook-meta", "/path/to/epub", "--title", "New Title")) + * println("RC = ${runResult.rc}") + * ``` + * @param arguments program and arguments to run + * @param throwAtError throw exception at `rc != 0` (defaults to true) + * @param workingDir working directory for the program (defaults to ".") + * @param timeoutSec timeout in seconds (defaults to 60) + * + * @property stdout program output to STDOUT + * @property stderr program output to STDERR + * @property rc return code + * + * @throws CommandExecutionException if [throwAtError] is true and [rc] is not 0 + */ +class ExecutionResult( + val arguments: List, + val throwAtError: Boolean = true, + val workingDir: String = ".", + val timeoutSec: Long = 60, +) { + val stdout: String + val stderr: String + val rc: Int + + init { + val executionResult = try { + executeProcess() + } catch (e: Exception) { + handleProcessException(e) + } + stdout = executionResult.first + stderr = executionResult.second + rc = executionResult.third + + if (rc != 0) { + logExecutionError() + if (throwAtError) { + throw CommandExecutionException("Error executing ${arguments}\nRC = $rc") + } + } + } + + private fun executeProcess(): Triple { + return ProcessBuilder(arguments) + .directory(File(workingDir)) + .start() + .run { + waitFor(timeoutSec, TimeUnit.SECONDS) + Triple( + inputStream.bufferedReader().use { it.readText() }, + errorStream.bufferedReader().use { it.readText() }, + exitValue() + ) + } + } + + private fun handleProcessException(exception: Exception): Triple { + val errorCode = when (exception) { + is IOException -> IO_EXCEPTION_CODE + is InterruptedException -> INTERRUPTED_EXCEPTION_CODE + else -> GENERIC_EXCEPTION_CODE + } + val errorMessage = + "${exception::class.simpleName}: ${exception.message}\n${exception.stackTraceToString()}" + return Triple("", errorMessage, errorCode) + } + + private fun logExecutionError() { + println("\n*** ERROR executing $arguments") + println("RC = $rc") + println("STDOUT:\n$stdout") + println("STDERR:\n$stderr") + println("***") + } +} diff --git a/src/main/kotlin/net/keinekekse/version/version.kt b/src/main/kotlin/net/keinekekse/version/version.kt new file mode 100644 index 0000000..94f49d2 --- /dev/null +++ b/src/main/kotlin/net/keinekekse/version/version.kt @@ -0,0 +1,218 @@ +package net.keinekekse.version + +import java.io.File +import java.io.IOException +import java.net.URI +import java.time.Instant +import java.time.format.DateTimeFormatter +import java.time.format.DateTimeParseException +import java.util.* +import java.util.concurrent.ConcurrentHashMap +import java.util.jar.Manifest +import java.util.regex.Pattern + +/** + * Version-Info für .jar oder .war + * + * + * Die Versions-Informationen werden aus der Datei META-INF/MANIFEST.MF gelesen. + * + * Fürs Setzen der Werte in der MANIFEST.MF ist das Gradle version-plugin verantwortlich. + * + * Das Auslesen der Datei funktioniert für .jar (liegt in /META-INF) und .war (liegt in + * /WEB-INF/classes/META-INF) die auf einem Wildfly-Server deployed wurden (für alles Andere wäre es + * zu testen) + * + * @param clazz Klasse aus der jeweiligen .jar oder .war + * + * ``` + * val version = Version(this::class.java) + * val libraryVersion = Version(Version::class.java) + * ``` + */ +class Version(clazz: Class<*>) { + + val versionObject: VersionNumber + private val attributes: MutableMap + + init { + val manifestPath = determineManifestPath(clazz) + attributes = loadManifestAttributes(manifestPath) + versionObject = initializeVersionNumbers() + } + + // TODO noch nicht für WAR getestet!! + private fun determineManifestPath(clazz: Class<*>): String { + val classResourcePath = clazz.getResource("${clazz.simpleName}.class")?.toString() ?: "" + val baseFolder = if (classResourcePath.contains(WEB_INF_PATH)) { + classResourcePath.substringBefore(WEB_INF_PATH) + MANIFEST_FILE_PATH + } else { + classResourcePath.substringBefore( + clazz.name.replace( + '.', + File.separatorChar + ) + CLASS_EXTENSION + ) + MANIFEST_FILE_PATH + } + return baseFolder + } + + private fun loadManifestAttributes(manifestPath: String): MutableMap { + val attributes = ConcurrentHashMap() + + try { + URI(manifestPath).toURL().openStream().use { + val manifest = Manifest(it) + manifest.mainAttributes.forEach { key, value -> + attributes[key.toString()] = value.toString() + } + } + } catch (e: IOException) { + throw RuntimeException("Failed to read MANIFEST.MF at $manifestPath", e) + } + + return attributes + } + + private fun initializeVersionNumbers(): VersionNumber { + return VersionNumber( + attributes[PROP_VERSION] ?: "", + attributes[PROP_BUILD_TIMESTAMP] ?: "", + attributes[PROP_BUILD_NUMBER] ?: "" + ) + } + + val infoString: String + get() = "$displayname $fullVersion $copyright" + + val displayname: String + get() = attributes[PROP_DISPLAYNAME] ?: "" + + val copyright: String + get() = attributes[PROP_COPYRIGHT] ?: "" + + val name: String + get() = attributes[PROP_NAME] ?: "" + + val description: String + get() = attributes[PROP_DESCRIPTION] ?: "" + + val version: String + get() = versionObject.version + + val fullVersion: String + get() = versionObject.fullVersion + + val major: Int + get() = versionObject.major + + val minor: Int + get() = versionObject.minor + + val patch: Int + get() = versionObject.patch + + val identifier: String + get() = versionObject.identifier + + val build: String + get() = versionObject.build + + val buildTimestamp: String + get() = versionObject.buildTimestamp + + companion object { + private const val PROP_NAME = "module-name" + private const val PROP_DISPLAYNAME = "displayname" + private const val PROP_COPYRIGHT = "copyright" + private const val PROP_DESCRIPTION = "description" + private const val PROP_VERSION = "version" + private const val PROP_BUILD_TIMESTAMP = "build-timestamp" + private const val PROP_BUILD_NUMBER = "build-number" + + private const val MANIFEST_FILE_PATH = "META-INF/MANIFEST.MF" + private const val CLASS_EXTENSION = ".class" + private const val WEB_INF_PATH = "WEB-INF/classes" + } +} + +/** + * Versions-Nr. zerlegen

+ *

+ * Folgendes Format wird verstanden: [v]int[.int[.int]][-|.alpha|rc ..][-|.build-Nr. o.ä.]

+ * Ergebnis:

+ * + * 
`String.format("%d.%d.%d-%s-%s", getMajor(), getMinor(), getPatch(), getIdentifier(), getBuild());
+`
* + * + *

+ * Außerdem wird Der Maven Build-Timestamp als String des Formats `"yyyy-MM-dd @HH:mm:ss"` + * sowie als `long mavenEpochSeconds` gespeichert. Falls die übergebene Version keinen + * Build-String enthält wird statt dessen `mavenEpochSeconds` verwendet. + */ +class VersionNumber(val version: String, timestamp: String, buildNumber: String = "") { + private companion object { + const val VERSION_REGEX = """v?(\d+)(?:\.(\d+))?(?:\.(\d+))?(?:[-.](\w+))?(?:[-.](.*))?""" + val DATE_TIME_FORMATTER: DateTimeFormatter = + DateTimeFormatter.ofPattern("yyyy-MM-dd @HH:mm:ss") + } + + var major: Int = 0 + private set + var minor: Int = 0 + private set + var patch: Int = 0 + private set + var identifier: String = "" // e.g., "alpha", etc. + private set + var build: String = "" // Build metadata, e.g., "Timestamp" or "SNAPSHOT" + private set + var buildTimestamp: String = "" + private set + var buildEpochSeconds: Long = 0 + private set + + init { + parseVersion(version) + initializeBuildTimestamp(timestamp) + if (buildNumber.isNotEmpty()) { + build = buildNumber + } + } + + val fullVersion: String + get() = if (identifier.isEmpty()) { + "$major.$minor.$patch (build $build)" + } else { + "$major.$minor.$patch-$identifier-$build" + } + + private fun parseVersion(version: String) { + val pattern = Pattern.compile(VERSION_REGEX) + val matcher = pattern.matcher(version) + if (matcher.matches()) { + major = parseVersionComponent(matcher.group(1)) + minor = parseVersionComponent(matcher.group(2)) + patch = parseVersionComponent(matcher.group(3)) + identifier = matcher.group(4) ?: "" + build = resolveBuildMetadata(matcher.group(5) ?: "") + } + } + + private fun parseVersionComponent(value: String?) = value?.toIntOrNull() ?: 0 + + private fun resolveBuildMetadata(extractedBuild: String): String { + return if (extractedBuild.isNotEmpty()) extractedBuild else buildEpochSeconds.toString() + } + + private fun initializeBuildTimestamp(timestamp: String) { + try { + val instant = Instant.parse(timestamp) + val date = instant.atZone(TimeZone.getDefault().toZoneId()) + buildEpochSeconds = date.toEpochSecond() + buildTimestamp = date.format(DATE_TIME_FORMATTER) + } catch (e: DateTimeParseException) { + buildTimestamp = "Invalid timestamp" + } + } +}