diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml new file mode 100644 index 00000000..e5247f5b --- /dev/null +++ b/.github/workflows/maven.yml @@ -0,0 +1,35 @@ +# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven + +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +name: Java CI with Maven + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Set up JDK 17 + uses: actions/setup-java@v3 + with: + java-version: '17' + distribution: 'temurin' + cache: maven + - name: Build with Maven + run: mvn -B package --file pom.xml + + # Optional: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive + - name: Update dependency graph + uses: advanced-security/maven-dependency-submission-action@571e99aab1055c2e71a1e2309b9691de18d6b7d6 diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..549e00a2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,33 @@ +HELP.md +target/ +!.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ diff --git a/.mvn/wrapper/maven-wrapper.jar b/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 00000000..cb28b0e3 Binary files /dev/null and b/.mvn/wrapper/maven-wrapper.jar differ diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 00000000..5f0536eb --- /dev/null +++ b/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,2 @@ +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.5/apache-maven-3.9.5-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar diff --git a/mvnw b/mvnw new file mode 100755 index 00000000..66df2854 --- /dev/null +++ b/mvnw @@ -0,0 +1,308 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# 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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.2.0 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "$(uname)" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && + JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin ; then + javaHome="$(dirname "\"$javaExecutable\"")" + javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "\"$javaExecutable\"")" + fi + javaHome="$(dirname "\"$javaExecutable\"")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + 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 + else + JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$(cd "$wdir/.." || exit 1; pwd) + fi + # end of workaround + done + printf '%s' "$(cd "$basedir" || exit 1; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' < "$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; + esac + done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget > /dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; + esac +done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 00000000..95ba6f54 --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,205 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. 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, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.2.0 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/pom.xml b/pom.xml new file mode 100644 index 00000000..73bbccc6 --- /dev/null +++ b/pom.xml @@ -0,0 +1,74 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 3.2.0 + + + com.prgrms + ShortenUrl + 0.0.1-SNAPSHOT + ShortenUrl + ShortenUrl + + 17 + + + + org.springframework.boot + spring-boot-starter-data-jpa + + + com.h2database + h2 + 2.1.214 + + + + org.springframework.boot + spring-boot-starter-thymeleaf + + + org.springframework.boot + spring-boot-starter-web + + + + com.google.guava + guava + 32.1.2-jre + + + + org.projectlombok + lombok + true + + + org.springframework.boot + spring-boot-starter-test + test + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + org.projectlombok + lombok + + + + + + + + diff --git a/src/main/java/com/prgrms/shortenurl/ShortenUrlApplication.java b/src/main/java/com/prgrms/shortenurl/ShortenUrlApplication.java new file mode 100644 index 00000000..2b7dffe6 --- /dev/null +++ b/src/main/java/com/prgrms/shortenurl/ShortenUrlApplication.java @@ -0,0 +1,15 @@ +package com.prgrms.shortenurl; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.data.jpa.repository.config.EnableJpaAuditing; + +@EnableJpaAuditing +@SpringBootApplication +public class ShortenUrlApplication { + + public static void main(String[] args) { + SpringApplication.run(ShortenUrlApplication.class, args); + } + +} diff --git a/src/main/java/com/prgrms/shortenurl/controller/UrlRestController.java b/src/main/java/com/prgrms/shortenurl/controller/UrlRestController.java new file mode 100644 index 00000000..135b4825 --- /dev/null +++ b/src/main/java/com/prgrms/shortenurl/controller/UrlRestController.java @@ -0,0 +1,31 @@ +package com.prgrms.shortenurl.controller; + +import com.prgrms.shortenurl.controller.dto.UrlRequestDto; +import com.prgrms.shortenurl.service.UrlService; +import com.prgrms.shortenurl.domain.Url; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.*; + +@RestController +@RequestMapping("/api/v1/shortenUrl") +public class UrlRestController { + private final UrlService urlService; + + public UrlRestController(UrlService urlService) { + this.urlService = urlService; + } + + @PostMapping + @ResponseBody + public ResponseEntity shortenUrl(@ModelAttribute UrlRequestDto urlRequestDto) { + Url shortenUrl = urlService.addLink(urlRequestDto.originUrl(), urlRequestDto.encodingType()); + return ResponseEntity.ok(shortenUrl.getOriginUrl()); + } + + @GetMapping(value = "/{key}") + @ResponseBody + public ResponseEntity getUrl(@PathVariable String key) { + String url = urlService.getUrlByKey(key); + return ResponseEntity.ok(url); + } +} diff --git a/src/main/java/com/prgrms/shortenurl/controller/UrlWebController.java b/src/main/java/com/prgrms/shortenurl/controller/UrlWebController.java new file mode 100644 index 00000000..bc2faf08 --- /dev/null +++ b/src/main/java/com/prgrms/shortenurl/controller/UrlWebController.java @@ -0,0 +1,38 @@ +package com.prgrms.shortenurl.controller; + +import com.prgrms.shortenurl.controller.dto.UrlRequestDto; +import com.prgrms.shortenurl.service.UrlService; +import com.prgrms.shortenurl.domain.Url; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.stereotype.Controller; +import org.springframework.ui.Model; +import org.springframework.web.bind.annotation.*; + +import java.net.URI; +import java.net.URISyntaxException; + +@Controller +public class UrlWebController { + private final UrlService urlService; + public UrlWebController(UrlService urlService) { + this.urlService = urlService; + } + + @PostMapping("/shorten") + public String shorten(@ModelAttribute UrlRequestDto urlRequestDto, + Model model) { + Url shortenUrl = urlService.addLink(urlRequestDto.originUrl(), urlRequestDto.encodingType()); + model.addAttribute("shortenUrl", shortenUrl.getShortenUrl()); + return "index"; + } + + @GetMapping("/{key}") + public ResponseEntity redirect(@PathVariable String key) throws URISyntaxException { + URI redirectUri = new URI(urlService.getUrlByKey(key)); + HttpHeaders httpHeaders = new HttpHeaders(); + httpHeaders.setLocation(redirectUri); + return new ResponseEntity<>(httpHeaders, HttpStatus.SEE_OTHER); + } +} diff --git a/src/main/java/com/prgrms/shortenurl/controller/dto/UrlRequestDto.java b/src/main/java/com/prgrms/shortenurl/controller/dto/UrlRequestDto.java new file mode 100644 index 00000000..7daa690d --- /dev/null +++ b/src/main/java/com/prgrms/shortenurl/controller/dto/UrlRequestDto.java @@ -0,0 +1,7 @@ +package com.prgrms.shortenurl.controller.dto; + +import lombok.Builder; + +@Builder +public record UrlRequestDto(String originUrl, String encodingType) { +} diff --git a/src/main/java/com/prgrms/shortenurl/domain/Url.java b/src/main/java/com/prgrms/shortenurl/domain/Url.java new file mode 100644 index 00000000..2a371016 --- /dev/null +++ b/src/main/java/com/prgrms/shortenurl/domain/Url.java @@ -0,0 +1,72 @@ +package com.prgrms.shortenurl.domain; + +import jakarta.persistence.*; +import lombok.*; +import org.springframework.data.annotation.CreatedDate; +import org.springframework.data.annotation.LastModifiedDate; +import org.springframework.data.jpa.domain.support.AuditingEntityListener; + +import java.net.MalformedURLException; +import java.net.URISyntaxException; +import java.net.URL; +import java.time.LocalDateTime; + +@Getter +@Entity +@EntityListeners(AuditingEntityListener.class) +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class Url { + + @Id + @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "shortenUrl") + @SequenceGenerator(name = "shortenUrl", sequenceName = "shortenUrl", allocationSize = 1, initialValue = 100) + private Long id; + + @Column(name = "shorten_key") + private String shortenKey; + + @NonNull + @Column(name = "orgin_url") + private String originUrl; + + @Column(name = "shorten_url", unique = true) + private String shortenUrl; + + @Column(name = "count") + private int count; + + @Column(name = "created_at") + @CreatedDate + private LocalDateTime created_at; + + @Column(name = "updated_at") + @LastModifiedDate + private LocalDateTime updated_at; + + @Builder + public Url(@NonNull String originUrl) { + if (isValidUrl(originUrl)) { + this.originUrl = originUrl; + } else { + throw new IllegalArgumentException("Invalid URL: " + originUrl); + } + } + + private boolean isValidUrl(String url) { + try { + new URL(url).toURI(); + return true; + } catch (MalformedURLException | URISyntaxException e) { + return false; + } + } + + public void updateShortenUrl(String shortenKey) { + this.shortenKey = shortenKey; + this.shortenUrl = "http://localhost:8090/"+shortenKey; + } + + public void updateCount() { + this.count += 1; + } +} diff --git a/src/main/java/com/prgrms/shortenurl/domain/UrlRepository.java b/src/main/java/com/prgrms/shortenurl/domain/UrlRepository.java new file mode 100644 index 00000000..035e7ac7 --- /dev/null +++ b/src/main/java/com/prgrms/shortenurl/domain/UrlRepository.java @@ -0,0 +1,11 @@ +package com.prgrms.shortenurl.domain; + +import org.springframework.data.annotation.Id; +import org.springframework.data.jpa.repository.JpaRepository; + +import java.util.Optional; + +public interface UrlRepository extends JpaRepository { + Optional findByShortenKey(String key); + Optional findByOriginUrl(String originUrl); +} diff --git a/src/main/java/com/prgrms/shortenurl/exception/GlobalExceptionHandler.java b/src/main/java/com/prgrms/shortenurl/exception/GlobalExceptionHandler.java new file mode 100644 index 00000000..8f78495d --- /dev/null +++ b/src/main/java/com/prgrms/shortenurl/exception/GlobalExceptionHandler.java @@ -0,0 +1,19 @@ +package com.prgrms.shortenurl.exception; + +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.ControllerAdvice; +import org.springframework.web.bind.annotation.ExceptionHandler; + +@ControllerAdvice +public class GlobalExceptionHandler { + @ExceptionHandler(UrlNotFoundException.class) + public ResponseEntity notFoundException(IllegalArgumentException e) { + return ResponseEntity.status(HttpStatus.NOT_FOUND).body(e.getMessage()); + } + + @ExceptionHandler(RuntimeException.class) + public ResponseEntity internalServerError(RuntimeException e) { + return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(e.getMessage()); + } +} diff --git a/src/main/java/com/prgrms/shortenurl/exception/UrlNotFoundException.java b/src/main/java/com/prgrms/shortenurl/exception/UrlNotFoundException.java new file mode 100644 index 00000000..8581e186 --- /dev/null +++ b/src/main/java/com/prgrms/shortenurl/exception/UrlNotFoundException.java @@ -0,0 +1,9 @@ +package com.prgrms.shortenurl.exception; + +public class UrlNotFoundException extends IllegalArgumentException { + private String message; + + public UrlNotFoundException() { + this.message = "해당 키에 맞는 url을 찾을 수 없습니다."; + } +} diff --git a/src/main/java/com/prgrms/shortenurl/service/Base62Encoding.java b/src/main/java/com/prgrms/shortenurl/service/Base62Encoding.java new file mode 100644 index 00000000..a916a429 --- /dev/null +++ b/src/main/java/com/prgrms/shortenurl/service/Base62Encoding.java @@ -0,0 +1,27 @@ +package com.prgrms.shortenurl.service; + +public class Base62Encoding { + + private static final int BASE62 = 62; + private static final String BASE62_CHAR = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"; + + public static String encode(long param, int length) { + StringBuffer sb = new StringBuffer(); + while (param > 0 || sb.length() < length) { + sb.append(BASE62_CHAR.charAt((int) (param % BASE62))); + param /= BASE62; + } + return sb.toString(); + } + + public static long decode(String param) { + long sum = 0; + long power = 1; + for (int i = 0; i < param.length(); i++) { + sum += BASE62_CHAR.indexOf(param.charAt(i)) * power; + power *= BASE62; + } + return sum; + } + +} diff --git a/src/main/java/com/prgrms/shortenurl/service/EncodingType.java b/src/main/java/com/prgrms/shortenurl/service/EncodingType.java new file mode 100644 index 00000000..9ce15a43 --- /dev/null +++ b/src/main/java/com/prgrms/shortenurl/service/EncodingType.java @@ -0,0 +1,22 @@ +package com.prgrms.shortenurl.service; + +import com.prgrms.shortenurl.domain.Url; + +import java.util.function.Function; + +public enum EncodingType { + Base62("Base62", UrlService::shortenUrlByBase62), + Murmur("MurMur", UrlService::shortenUrlByMurMur); + + private final String name; + private final Function encoder; + + EncodingType(String name, Function encoder) { + this.name = name; + this.encoder = encoder; + } + + public String encode(Url url) { + return encoder.apply(url); + } +} diff --git a/src/main/java/com/prgrms/shortenurl/service/EnumConverter.java b/src/main/java/com/prgrms/shortenurl/service/EnumConverter.java new file mode 100644 index 00000000..aeb04056 --- /dev/null +++ b/src/main/java/com/prgrms/shortenurl/service/EnumConverter.java @@ -0,0 +1,17 @@ +package com.prgrms.shortenurl.service; + +import java.util.HashMap; +import java.util.Map; + +public class EnumConverter { + private static final Map stringToEnumMap = new HashMap<>(); + + static { + stringToEnumMap.put("Base62", EncodingType.Base62); + stringToEnumMap.put("MurMur", EncodingType.Murmur); + } + + public static EncodingType convert(String value) { + return stringToEnumMap.get(value); + } +} diff --git a/src/main/java/com/prgrms/shortenurl/service/RadixConverter.java b/src/main/java/com/prgrms/shortenurl/service/RadixConverter.java new file mode 100644 index 00000000..e156488a --- /dev/null +++ b/src/main/java/com/prgrms/shortenurl/service/RadixConverter.java @@ -0,0 +1,31 @@ +package com.prgrms.shortenurl.service; + +public class RadixConverter { + public static String convertToBinary(int number) { + int quotient = number; + StringBuilder binaryString = new StringBuilder(); + + while (quotient >= 2) { + binaryString.append(quotient % 2); + quotient = Math.floorDiv(quotient, 2); + } + binaryString.append(quotient); + + return binaryString.reverse().toString(); + } + + public static String convertToHex(int number) { + int quotient = number; + StringBuilder hexString = new StringBuilder(); + char[] codes = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'}; + + while (quotient >= 16) { + int remainder = quotient % 16; + hexString.append(codes[remainder]); + quotient = Math.floorDiv(quotient, 16); + } + hexString.append(codes[quotient]); + + return hexString.reverse().toString(); + } +} diff --git a/src/main/java/com/prgrms/shortenurl/service/UrlService.java b/src/main/java/com/prgrms/shortenurl/service/UrlService.java new file mode 100644 index 00000000..36bc7f15 --- /dev/null +++ b/src/main/java/com/prgrms/shortenurl/service/UrlService.java @@ -0,0 +1,66 @@ +package com.prgrms.shortenurl.service; + +import com.google.common.hash.Hashing; +import com.prgrms.shortenurl.domain.Url; +import com.prgrms.shortenurl.domain.UrlRepository; +import com.prgrms.shortenurl.exception.UrlNotFoundException; +import lombok.NonNull; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import java.nio.charset.Charset; +import java.util.HexFormat; + +@Service +public class UrlService { + + private final Logger logger = LoggerFactory.getLogger(getClass()); + private final UrlRepository urlRepository; + + public UrlService(UrlRepository urlRepository) { + this.urlRepository = urlRepository; + } + + private Url save(@NonNull String originUrl) { + return urlRepository.save(Url.builder() + .originUrl(originUrl).build()); + } + + public static String shortenUrlByMurMur(@NonNull Url url) { + return Hashing.murmur3_32_fixed().hashString(url.getOriginUrl(), Charset.defaultCharset()).toString(); + } + + public static String shortenUrlByBase62(@NonNull Url url) { + int intKey = Math.toIntExact(url.getId()); + + // 이진수 변환 + String binary = RadixConverter.convertToBinary(intKey); + + // 16진수 변환 + String hex = RadixConverter.convertToHex(Integer.parseInt(binary)); + + return Base62Encoding.encode(HexFormat.fromHexDigits(hex), 6); + } + + @Transactional + public Url addLink(@NonNull String originUrl, @NonNull String encodingType) { + Url url = urlRepository.findByOriginUrl(originUrl) + .orElse( + save(originUrl) + ); + String key = EnumConverter.convert(encodingType).encode(url); + url.updateShortenUrl(key); + + return url; + } + + @Transactional + public String getUrlByKey(@NonNull String key) { + Url url = urlRepository.findByShortenKey(key) + .orElseThrow(UrlNotFoundException::new); + url.updateCount(); + return url.getOriginUrl(); + } +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 00000000..cdb7e918 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,25 @@ +spring: + datasource: + driver-class-name: org.h2.Driver + hikari: + jdbc-url: jdbc:h2:mem:spring_test;NON_KEYWORDS=USER;MODE=MySQL; + username: sa + password: 1234 + h2: + console: + enabled: true + path: /h2-console + jpa: + generate-ddl: false + database: h2 + show-sql: true + open-in-view: false + properties: + hibernate: + dialect: org.hibernate.dialect.H2Dialect + query.in_clause_parameter_padding: true + hbm2ddl: + auto: create + format_sql: true +server: + port: 8090 diff --git a/src/main/resources/templates/index.html b/src/main/resources/templates/index.html new file mode 100644 index 00000000..276ebb8c --- /dev/null +++ b/src/main/resources/templates/index.html @@ -0,0 +1,68 @@ + + + + + Shorten URL Generator + + + + + +
+

Shorten URL Generator

+ + +
+
+ + +
+ + +
+ +
+ + +
+
+ + +
+
+ + +
+ + +
+

Shortened URL:

+
+ +
+ +
+
+
+
+ + + + + + + + + diff --git a/src/test/java/com/prgrms/shortenurl/ShortenUrlApplicationTests.java b/src/test/java/com/prgrms/shortenurl/ShortenUrlApplicationTests.java new file mode 100644 index 00000000..5db32556 --- /dev/null +++ b/src/test/java/com/prgrms/shortenurl/ShortenUrlApplicationTests.java @@ -0,0 +1,13 @@ +package com.prgrms.shortenurl; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class ShortenUrlApplicationTests { + + @Test + void contextLoads() { + } + +}