diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..549e00a --- /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/MavenWrapperDownloader.java b/.mvn/wrapper/MavenWrapperDownloader.java new file mode 100644 index 0000000..a45eb6b --- /dev/null +++ b/.mvn/wrapper/MavenWrapperDownloader.java @@ -0,0 +1,118 @@ +/* + * Copyright 2007-present the original author or 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. + */ + +import java.net.*; +import java.io.*; +import java.nio.channels.*; +import java.util.Properties; + +public class MavenWrapperDownloader { + + private static final String WRAPPER_VERSION = "0.5.6"; + /** + * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided. + */ + private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/" + + WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar"; + + /** + * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to + * use instead of the default one. + */ + private static final String MAVEN_WRAPPER_PROPERTIES_PATH = + ".mvn/wrapper/maven-wrapper.properties"; + + /** + * Path where the maven-wrapper.jar will be saved to. + */ + private static final String MAVEN_WRAPPER_JAR_PATH = + ".mvn/wrapper/maven-wrapper.jar"; + + /** + * Name of the property which should be used to override the default download url for the wrapper. + */ + private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl"; + + public static void main(String args[]) { + System.out.println("- Downloader started"); + File baseDirectory = new File(args[0]); + System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath()); + + // If the maven-wrapper.properties exists, read it and check if it contains a custom + // wrapperUrl parameter. + File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH); + String url = DEFAULT_DOWNLOAD_URL; + if (mavenWrapperPropertyFile.exists()) { + FileInputStream mavenWrapperPropertyFileInputStream = null; + try { + mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile); + Properties mavenWrapperProperties = new Properties(); + mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream); + url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url); + } catch (IOException e) { + System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'"); + } finally { + try { + if (mavenWrapperPropertyFileInputStream != null) { + mavenWrapperPropertyFileInputStream.close(); + } + } catch (IOException e) { + // Ignore ... + } + } + } + System.out.println("- Downloading from: " + url); + + File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH); + if (!outputFile.getParentFile().exists()) { + if (!outputFile.getParentFile().mkdirs()) { + System.out.println( + "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'"); + } + } + System.out.println("- Downloading to: " + outputFile.getAbsolutePath()); + try { + downloadFileFromURL(url, outputFile); + System.out.println("Done"); + System.exit(0); + } catch (Throwable e) { + System.out.println("- Error downloading"); + e.printStackTrace(); + System.exit(1); + } + } + + private static void downloadFileFromURL(String urlString, File destination) throws Exception { + if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) { + String username = System.getenv("MVNW_USERNAME"); + char[] password = System.getenv("MVNW_PASSWORD").toCharArray(); + Authenticator.setDefault(new Authenticator() { + @Override + protected PasswordAuthentication getPasswordAuthentication() { + return new PasswordAuthentication(username, password); + } + }); + } + URL website = new URL(urlString); + ReadableByteChannel rbc; + rbc = Channels.newChannel(website.openStream()); + FileOutputStream fos = new FileOutputStream(destination); + fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE); + fos.close(); + rbc.close(); + } + +} diff --git a/.mvn/wrapper/maven-wrapper.jar b/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000..2cc7d4a 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 0000000..a9f1ef8 --- /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.8.3/apache-maven-3.8.3-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar diff --git a/mvnw b/mvnw new file mode 100644 index 0000000..a16b543 --- /dev/null +++ b/mvnw @@ -0,0 +1,310 @@ +#!/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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Maven Start Up Batch script +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# M2_HOME - location of maven2's installed home dir +# 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 /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 + export JAVA_HOME="`/usr/libexec/java_home`" + else + export JAVA_HOME="/Library/Java/Home" + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=`java-config --jre-home` + fi +fi + +if [ -z "$M2_HOME" ] ; then + ## resolve links - $0 may be a link to maven's home + PRG="$0" + + # need this for relative symlinks + while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG="`dirname "$PRG"`/$link" + fi + done + + saveddir=`pwd` + + M2_HOME=`dirname "$PRG"`/.. + + # make it fully qualified + M2_HOME=`cd "$M2_HOME" && pwd` + + cd "$saveddir" + # echo Using m2 at $M2_HOME +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --unix "$M2_HOME"` + [ -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 "$M2_HOME" ] && + M2_HOME="`(cd "$M2_HOME"; pwd)`" + [ -n "$JAVA_HOME" ] && + JAVA_HOME="`(cd "$JAVA_HOME"; 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="`which 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 + +CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher + +# 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/.."; pwd` + fi + # end of workaround + done + echo "${basedir}" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + echo "$(tr -s '\n' ' ' < "$1")" + fi +} + +BASE_DIR=`find_maven_basedir "$(pwd)"` +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +########################################################################################## +# 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. +########################################################################################## +if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found .mvn/wrapper/maven-wrapper.jar" + fi +else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." + fi + if [ -n "$MVNW_REPOURL" ]; then + jarUrl="$MVNW_REPOURL/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" + else + jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" + fi + while IFS="=" read key value; do + case "$key" in (wrapperUrl) jarUrl="$value"; break ;; + esac + done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" + if [ "$MVNW_VERBOSE" = true ]; then + echo "Downloading from: $jarUrl" + fi + wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" + if $cygwin; then + wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` + fi + + if command -v wget > /dev/null; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found wget ... using wget" + fi + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget "$jarUrl" -O "$wrapperJarPath" + else + wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found curl ... using curl" + fi + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl -o "$wrapperJarPath" "$jarUrl" -f + else + curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f + fi + + else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Falling back to using Java to download" + fi + javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaClass=`cygpath --path --windows "$javaClass"` + fi + if [ -e "$javaClass" ]; then + if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Compiling MavenWrapperDownloader.java ..." + fi + # Compiling the Java class + ("$JAVA_HOME/bin/javac" "$javaClass") + fi + if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then + # Running the downloader + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Running MavenWrapperDownloader.java ..." + fi + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} +if [ "$MVNW_VERBOSE" = true ]; then + echo $MAVEN_PROJECTBASEDIR +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 "$M2_HOME" ] && + M2_HOME=`cygpath --path --windows "$M2_HOME"` + [ -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 + +exec "$JAVACMD" \ + $MAVEN_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 0000000..c8d4337 --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,182 @@ +@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 Maven Start Up Batch script +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM M2_HOME - location of maven2's installed home dir +@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 "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" +if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\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 DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" + +FOR /F "tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET DOWNLOAD_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 DOWNLOAD_URL="%MVNW_REPOURL%/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %DOWNLOAD_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('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@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 "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" +if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\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% + +exit /B %ERROR_CODE% diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..c320e2d --- /dev/null +++ b/pom.xml @@ -0,0 +1,65 @@ + + + 4.0.0 + + + org.springframework.boot + spring-boot-starter-parent + 2.6.1 + + + + com.yourcodereview.java01 + YourPersonalFinancesBot + 0.0.1-SNAPSHOT + + YourPersonalFinancesBot + + Telegram bot to track your personal finances + + + 11 + + + + + + org.springframework.boot + spring-boot-starter-web + + + + org.springframework.boot + spring-boot-starter-data-jpa + + + + com.h2database + h2 + runtime + + + + org.springframework.boot + spring-boot-starter-test + test + + + + org.telegram + telegrambots-spring-boot-starter + 5.5.0 + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + + diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/YourPersonalFinancesBotApplication.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/YourPersonalFinancesBotApplication.java new file mode 100644 index 0000000..23bbffe --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/YourPersonalFinancesBotApplication.java @@ -0,0 +1,13 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class YourPersonalFinancesBotApplication { + + public static void main(String[] args) { + + SpringApplication.run(YourPersonalFinancesBotApplication.class, args); + } +} diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/BotState.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/BotState.java new file mode 100644 index 0000000..65e3ed5 --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/BotState.java @@ -0,0 +1,8 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot.bot; + +public enum BotState { + SHOW_MAIN_MENU, + ADD_EXPENSE, + ADD_INCOME +} + diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/BotStateContext.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/BotStateContext.java new file mode 100644 index 0000000..6199b3c --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/BotStateContext.java @@ -0,0 +1,41 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot.bot; + +import org.springframework.stereotype.Component; +import org.telegram.telegrambots.meta.api.methods.send.SendMessage; +import org.telegram.telegrambots.meta.api.objects.Message; + +import java.util.HashMap; +import java.util.Map; + +@Component +public class BotStateContext { + private Map messageHandlers = new HashMap<>(); + + public BotStateContext(Map messageHandlers) { + this.messageHandlers = messageHandlers; + } + + public SendMessage processInputMessage(BotState currentState, Message message) { + + InputMessageHandler currentMessageHandler = findMessageHandler(currentState); + + return currentMessageHandler.handle(message); + } + + private InputMessageHandler findMessageHandler(BotState currentState) { + if (isFillingProfileState(currentState)) { + return messageHandlers.get(BotState.SHOW_MAIN_MENU); + } + return messageHandlers.get(currentState); + } + + private boolean isFillingProfileState(BotState currentState) { + switch (currentState) { + case ADD_EXPENSE: + case ADD_INCOME: + return true; + default: + return false; + } + } +} diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/InputMessageHandler.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/InputMessageHandler.java new file mode 100644 index 0000000..c8000d3 --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/InputMessageHandler.java @@ -0,0 +1,11 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot.bot; + +import org.telegram.telegrambots.meta.api.methods.send.SendMessage; +import org.telegram.telegrambots.meta.api.objects.Message; + +public interface InputMessageHandler { + + SendMessage handle(Message message); + + BotState getHandlerName(); +} diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/PersonalFinancesBot.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/PersonalFinancesBot.java new file mode 100644 index 0000000..6b35b08 --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/PersonalFinancesBot.java @@ -0,0 +1,51 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot.bot; + +import org.telegram.telegrambots.bots.TelegramWebhookBot; +import org.telegram.telegrambots.meta.api.methods.BotApiMethod; +import org.telegram.telegrambots.meta.api.objects.Update; + +public class PersonalFinancesBot extends TelegramWebhookBot { + private String botName; + private String botToken; + private String botPath; + + private TelegramFacade telegramFacade; + + public PersonalFinancesBot(TelegramFacade telegramFacade) { + this.telegramFacade = telegramFacade; + } + + @Override + public String getBotUsername() { + return botName; + } + + @Override + public String getBotToken() { + return botToken; + } + + @Override + public String getBotPath() { + return botPath; + } + + @Override + public BotApiMethod onWebhookUpdateReceived(Update update) { + BotApiMethod replyMessageToUser = telegramFacade.handleUpdate(update); + + return replyMessageToUser; + } + + public void setBotName(String botName) { + this.botName = botName; + } + + public void setBotToken(String botToken) { + this.botToken = botToken; + } + + public void setBotPath(String botPath) { + this.botPath = botPath; + } +} diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/TelegramFacade.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/TelegramFacade.java new file mode 100644 index 0000000..1dfcb1d --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/bot/TelegramFacade.java @@ -0,0 +1,104 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot.bot; + +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.springframework.stereotype.Component; +import org.telegram.telegrambots.meta.api.methods.send.SendMessage; +import org.telegram.telegrambots.meta.api.objects.CallbackQuery; +import org.telegram.telegrambots.meta.api.objects.Message; +import org.telegram.telegrambots.meta.api.objects.Update; +import org.telegram.telegrambots.meta.api.objects.replykeyboard.InlineKeyboardMarkup; +import org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.InlineKeyboardButton; + +import java.util.ArrayList; +import java.util.List; + +@Component +public class TelegramFacade { + private BotStateContext botStateContext; + + private static final Logger LOGGER = LogManager.getLogger(); + + public TelegramFacade(BotStateContext botStateContext) { + this.botStateContext = botStateContext; + } + + public SendMessage handleUpdate(Update update) { + SendMessage replyMessage = null; + + if (update.hasCallbackQuery()) { + CallbackQuery callbackQuery = update.getCallbackQuery(); + LOGGER.info("New callbackQuery from User: {}, userId: {}, with data: {}", + update.getCallbackQuery().getFrom().getUserName(), + callbackQuery.getFrom().getId(), + update.getCallbackQuery().getData()); + return null; + } + + Message message = update.getMessage(); + if (message != null && message.hasText()) { + LOGGER.info("New message from User: {}, userId: {}, chatId: {}, with text: {}", + message.getFrom().getUserName(), message.getFrom().getId(), message.getChatId(), message.getText()); + replyMessage = handleInputMessage(message); + } + return replyMessage; + } + + private SendMessage handleInputMessage(Message message) { + String inputMessage = "Please choose category"; + String chatId = message.getFrom().getId().toString(); + BotState botState; + + SendMessage replyMessage = createMessageWithKeyboard(chatId, inputMessage, getInlineMessageButtons()); + + return replyMessage; + } + + private SendMessage createMessageWithKeyboard(String chatId, + String textMessage, + final InlineKeyboardMarkup replyKeyboardMarkup) { + final SendMessage sendMessage = new SendMessage(); + sendMessage.enableMarkdown(true); + sendMessage.setChatId(chatId); + sendMessage.setText(textMessage); + if (replyKeyboardMarkup != null) { + sendMessage.setReplyMarkup(replyKeyboardMarkup); + } + return sendMessage; + } + + private InlineKeyboardMarkup getInlineMessageButtons() { + InlineKeyboardMarkup inlineKeyboardMarkup = new InlineKeyboardMarkup(); + + InlineKeyboardButton expenseButton = new InlineKeyboardButton(); + InlineKeyboardButton incomeButton = new InlineKeyboardButton(); + InlineKeyboardButton monthExpenseButton = new InlineKeyboardButton(); + InlineKeyboardButton statsButton = new InlineKeyboardButton(); + + expenseButton.setText("Add expense"); + incomeButton.setText("Add income"); + monthExpenseButton.setText("Show month expense"); + statsButton.setText("Show statistics"); + + expenseButton.setCallbackData("AddExpense"); + incomeButton.setCallbackData("AddIncome"); + monthExpenseButton.setCallbackData("ShowMonthExpense"); + statsButton.setCallbackData("ShowStatistics"); + + List keyboardButtonsRow1 = new ArrayList<>(); + keyboardButtonsRow1.add(expenseButton); + keyboardButtonsRow1.add(incomeButton); + + List keyboardButtonsRow2 = new ArrayList<>(); + keyboardButtonsRow2.add(monthExpenseButton); + keyboardButtonsRow2.add(statsButton); + + List> rowList = new ArrayList<>(); + rowList.add(keyboardButtonsRow1); + rowList.add(keyboardButtonsRow2); + + inlineKeyboardMarkup.setKeyboard(rowList); + + return inlineKeyboardMarkup; + } +} diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/config/PersonalFinancesBotConfig.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/config/PersonalFinancesBotConfig.java new file mode 100644 index 0000000..5d2de55 --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/config/PersonalFinancesBotConfig.java @@ -0,0 +1,36 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot.config; + +import com.yourcodereview.java01.yourpersonalfinancesbot.bot.PersonalFinancesBot; +import com.yourcodereview.java01.yourpersonalfinancesbot.bot.TelegramFacade; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.PropertySource; + +@Configuration +@ComponentScan(basePackages = "com.yourcodereview.java01.yourpersonalfinancesbot") +@PropertySource("classpath:application.properties") +public class PersonalFinancesBotConfig { + + @Value("${telegrambot.userName}") + private String botName; + + @Value("${telegrambot.botToken}") + private String botToken; + + @Value("${telegrambot.webHookPath}") + private String botPath; + + @Bean + public PersonalFinancesBot personalFinancesBot(TelegramFacade telegramFacade) { + + PersonalFinancesBot personalFinancesBot = new PersonalFinancesBot(telegramFacade); + + personalFinancesBot.setBotName(botName); + personalFinancesBot.setBotToken(botToken); + personalFinancesBot.setBotPath(botPath); + + return personalFinancesBot; + } +} diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/controllers/WebHookController.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/controllers/WebHookController.java new file mode 100644 index 0000000..4dd473d --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/controllers/WebHookController.java @@ -0,0 +1,23 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot.controllers; + +import com.yourcodereview.java01.yourpersonalfinancesbot.bot.PersonalFinancesBot; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RestController; +import org.telegram.telegrambots.meta.api.methods.BotApiMethod; +import org.telegram.telegrambots.meta.api.objects.Update; + +@RestController +public class WebHookController { + + private PersonalFinancesBot telegramBot; + + public WebHookController(PersonalFinancesBot telegramBot) { + this.telegramBot = telegramBot; + } + + @PostMapping("/") + public BotApiMethod onUpdateReceived(@RequestBody Update update) { + return telegramBot.onWebhookUpdateReceived(update); + } +} diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/BankAccount.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/BankAccount.java new file mode 100644 index 0000000..870a747 --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/BankAccount.java @@ -0,0 +1,52 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot.entities; + +import javax.persistence.*; + +@Entity +public class BankAccount { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private long id; + + @ManyToOne + private BotUser botUser; + + @Column(nullable = false, unique = true) + private String name; + + @Column(nullable = false) + private long currencyAmount; + + public long getId() { + return id; + } + + public void setId(long id) { + this.id = id; + } + + public BotUser getBotUser() { + return botUser; + } + + public void setBotUser(BotUser botUser) { + this.botUser = botUser; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public long getCurrencyAmount() { + return currencyAmount; + } + + public void setCurrencyAmount(long currencyAmount) { + this.currencyAmount = currencyAmount; + } +} diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/BotUser.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/BotUser.java new file mode 100644 index 0000000..44dd63e --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/BotUser.java @@ -0,0 +1,30 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot.entities; + +import javax.persistence.*; + +@Entity +public class BotUser { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private long id; + + @Column(nullable = false, unique = true) + private String chatId; + + public long getId() { + return id; + } + + public void setId(long id) { + this.id = id; + } + + public String getChatId() { + return chatId; + } + + public void setChatId(String chatId) { + this.chatId = chatId; + } +} diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/Expense.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/Expense.java new file mode 100644 index 0000000..a4ce58f --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/Expense.java @@ -0,0 +1,75 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot.entities; + +import javax.persistence.*; +import java.sql.Date; + +@Entity +public class Expense { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private long id; + + @ManyToOne + private BotUser botUser; + + @Column(nullable = false) + private Date date; + + @Column(nullable = false) + private long amount; + + @ManyToOne + private ExpenseCategory expenseCategory; + + @ManyToOne + private BankAccount bankAccount; + + public long getId() { + return id; + } + + public void setId(long id) { + this.id = id; + } + + public BotUser getBotUser() { + return botUser; + } + + public void setBotUser(BotUser botUser) { + this.botUser = botUser; + } + + public Date getDate() { + return date; + } + + public void setDate(Date date) { + this.date = date; + } + + public long getAmount() { + return amount; + } + + public void setAmount(long amount) { + this.amount = amount; + } + + public ExpenseCategory getExpenseCategory() { + return expenseCategory; + } + + public void setExpenseCategory(ExpenseCategory expenseCategory) { + this.expenseCategory = expenseCategory; + } + + public BankAccount getBankAccount() { + return bankAccount; + } + + public void setBankAccount(BankAccount bankAccount) { + this.bankAccount = bankAccount; + } +} diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/ExpenseCategory.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/ExpenseCategory.java new file mode 100644 index 0000000..154e02a --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/ExpenseCategory.java @@ -0,0 +1,41 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot.entities; + +import javax.persistence.*; + +@Entity +public class ExpenseCategory { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private long id; + + @ManyToOne + private BotUser botUser; + + @Column(nullable = false, unique = true) + private String name; + + public long getId() { + return id; + } + + public void setId(long id) { + this.id = id; + } + + public BotUser getBotUser() { + return botUser; + } + + public void setBotUser(BotUser botUser) { + this.botUser = botUser; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } +} diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/Income.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/Income.java new file mode 100644 index 0000000..f8bd42c --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/Income.java @@ -0,0 +1,75 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot.entities; + +import javax.persistence.*; +import java.sql.Date; + +@Entity +public class Income { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private long id; + + @ManyToOne + private BotUser botUser; + + @Column(nullable = false) + private Date date; + + @Column(nullable = false) + private long amount; + + @ManyToOne + private IncomeSource incomeSource; + + @ManyToOne + private BankAccount bankAccount; + + public long getId() { + return id; + } + + public void setId(long id) { + this.id = id; + } + + public BotUser getBotUser() { + return botUser; + } + + public void setBotUser(BotUser botUser) { + this.botUser = botUser; + } + + public Date getDate() { + return date; + } + + public void setDate(Date date) { + this.date = date; + } + + public long getAmount() { + return amount; + } + + public void setAmount(long amount) { + this.amount = amount; + } + + public IncomeSource getIncomeSource() { + return incomeSource; + } + + public void setIncomeSource(IncomeSource incomeSource) { + this.incomeSource = incomeSource; + } + + public BankAccount getBankAccount() { + return bankAccount; + } + + public void setBankAccount(BankAccount bankAccount) { + this.bankAccount = bankAccount; + } +} diff --git a/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/IncomeSource.java b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/IncomeSource.java new file mode 100644 index 0000000..b8a4a59 --- /dev/null +++ b/src/main/java/com/yourcodereview/java01/yourpersonalfinancesbot/entities/IncomeSource.java @@ -0,0 +1,41 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot.entities; + +import javax.persistence.*; + +@Entity +public class IncomeSource { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private long id; + + @ManyToOne + private BotUser botUser; + + @Column(nullable = false, unique = true) + private String name; + + public long getId() { + return id; + } + + public void setId(long id) { + this.id = id; + } + + public BotUser getBotUser() { + return botUser; + } + + public void setBotUser(BotUser botUser) { + this.botUser = botUser; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } +} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties new file mode 100644 index 0000000..17bd99e --- /dev/null +++ b/src/main/resources/application.properties @@ -0,0 +1,8 @@ +# +# Telegram bot properties +# +telegrambot.userName=@YourPersonalFinancesBot +telegrambot.botToken=5081965209:AAEqZLb0UW0kLvgt3rl7PCqHPD0t8MTJ3hY +telegrambot.webHookPath=https://3a23-185-141-232-97.ngrok.io + + diff --git a/src/test/java/com/yourcodereview/java01/yourpersonalfinancesbot/YourPersonalFinancesBotApplicationTests.java b/src/test/java/com/yourcodereview/java01/yourpersonalfinancesbot/YourPersonalFinancesBotApplicationTests.java new file mode 100644 index 0000000..b23771c --- /dev/null +++ b/src/test/java/com/yourcodereview/java01/yourpersonalfinancesbot/YourPersonalFinancesBotApplicationTests.java @@ -0,0 +1,13 @@ +package com.yourcodereview.java01.yourpersonalfinancesbot; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class YourPersonalFinancesBotApplicationTests { + + @Test + void contextLoads() { + } + +}