diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 5ace460..b6006ef 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,6 +1,12 @@ version: 2 updates: - - package-ecosystem: "github-actions" + + - package-ecosystem: "maven" directory: "/" schedule: interval: "weekly" + + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..de2aad9 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,25 @@ +name: Java CI + +on: + schedule: + - cron: '42 0 * * 4' + push: + branches: + - master + pull_request: + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v6 + - name: Set up JDK 21 + uses: actions/setup-java@v5 + with: + distribution: temurin + java-version: 21 + cache: 'maven' + - name: Build & run tests with Maven + run: ./mvnw -V verify diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml deleted file mode 100644 index e23f679..0000000 --- a/.github/workflows/maven.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: Java CI - -on: [push] - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v6 - - name: Set up JDK 17 - uses: actions/setup-java@v5 - with: - distribution: temurin - java-version: 17 - - name: Build with Maven - run: mvn -B test-compile - - name: Run tests with Maven - timeout-minutes: 10 - run: mvn -B test diff --git a/.mvn/maven.config b/.mvn/maven.config new file mode 100644 index 0000000..18c894e --- /dev/null +++ b/.mvn/maven.config @@ -0,0 +1,7 @@ +--strict-checksums +-Daether.checksums.algorithms=SHA-512,SHA-1,MD5 +-Daether.trustedChecksumsSource.summaryFile=true +-Daether.trustedChecksumsSource.summaryFile.basedir=${session.rootDirectory}/.mvn/checksums/ +-Daether.artifactResolver.postProcessor.trustedChecksums=true +-Daether.artifactResolver.postProcessor.trustedChecksums.checksumAlgorithms=SHA-512 +-Daether.artifactResolver.postProcessor.trustedChecksums.failIfMissing=false diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..533e775 --- /dev/null +++ b/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,4 @@ +wrapperVersion=3.3.4 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.12/apache-maven-3.9.12-bin.zip +distributionSha256Sum=305773a68d6ddfd413df58c82b3f8050e89778e777f3a745c8e5b8cbea4018ef diff --git a/mvnw b/mvnw new file mode 100755 index 0000000..bd8896b --- /dev/null +++ b/mvnw @@ -0,0 +1,295 @@ +#!/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 +# +# http://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.3.4 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + 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" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +scriptDir="$(dirname "$0")" +scriptName="$(basename "$0")" + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"$scriptDir/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${scriptName#mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c - >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +actualDistributionDir="" + +# First try the expected directory name (for regular distributions) +if [ -d "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" ]; then + if [ -f "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/bin/$MVN_CMD" ]; then + actualDistributionDir="$distributionUrlNameMain" + fi +fi + +# If not found, search for any directory with the Maven executable (for snapshots) +if [ -z "$actualDistributionDir" ]; then + # enable globbing to iterate over items + set +f + for dir in "$TMP_DOWNLOAD_DIR"/*; do + if [ -d "$dir" ]; then + if [ -f "$dir/bin/$MVN_CMD" ]; then + actualDistributionDir="$(basename "$dir")" + break + fi + fi + done + set -f +fi + +if [ -z "$actualDistributionDir" ]; then + verbose "Contents of $TMP_DOWNLOAD_DIR:" + verbose "$(ls -la "$TMP_DOWNLOAD_DIR")" + die "Could not find Maven distribution directory in extracted archive" +fi + +verbose "Found extracted Maven distribution directory: $actualDistributionDir" +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$actualDistributionDir/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$actualDistributionDir" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 0000000..5761d94 --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,189 @@ +<# : batch portion +@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 http://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.3.4 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" ("%__MVNW_CMD__%" %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND -eq $False) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace "^.*$MVNW_REPO_PATTERN",'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' + +$MAVEN_M2_PATH = "$HOME/.m2" +if ($env:MAVEN_USER_HOME) { + $MAVEN_M2_PATH = "$env:MAVEN_USER_HOME" +} + +if (-not (Test-Path -Path $MAVEN_M2_PATH)) { + New-Item -Path $MAVEN_M2_PATH -ItemType Directory | Out-Null +} + +$MAVEN_WRAPPER_DISTS = $null +if ((Get-Item $MAVEN_M2_PATH).Target[0] -eq $null) { + $MAVEN_WRAPPER_DISTS = "$MAVEN_M2_PATH/wrapper/dists" +} else { + $MAVEN_WRAPPER_DISTS = (Get-Item $MAVEN_M2_PATH).Target[0] + "/wrapper/dists" +} + +$MAVEN_HOME_PARENT = "$MAVEN_WRAPPER_DISTS/$distributionUrlNameMain" +$MAVEN_HOME_NAME = ([System.Security.Cryptography.SHA256]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +$actualDistributionDir = "" + +# First try the expected directory name (for regular distributions) +$expectedPath = Join-Path "$TMP_DOWNLOAD_DIR" "$distributionUrlNameMain" +$expectedMvnPath = Join-Path "$expectedPath" "bin/$MVN_CMD" +if ((Test-Path -Path $expectedPath -PathType Container) -and (Test-Path -Path $expectedMvnPath -PathType Leaf)) { + $actualDistributionDir = $distributionUrlNameMain +} + +# If not found, search for any directory with the Maven executable (for snapshots) +if (!$actualDistributionDir) { + Get-ChildItem -Path "$TMP_DOWNLOAD_DIR" -Directory | ForEach-Object { + $testPath = Join-Path $_.FullName "bin/$MVN_CMD" + if (Test-Path -Path $testPath -PathType Leaf) { + $actualDistributionDir = $_.Name + } + } +} + +if (!$actualDistributionDir) { + Write-Error "Could not find Maven distribution directory in extracted archive" +} + +Write-Verbose "Found extracted Maven distribution directory: $actualDistributionDir" +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$actualDistributionDir" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/pom.xml b/pom.xml index 01032ea..8697c62 100644 --- a/pom.xml +++ b/pom.xml @@ -1,111 +1,172 @@ - - 4.0.0 + + + 4.0.0 - com.github.ipld - java-cid - 1.3.10 - jar + com.github.ipld + java-cid + 1.3.11-SNAPSHOT + jar - cid - https://github.com/ipld/java-cid + multibase + https://github.com/multiformats/java-multibase - - https://github.com/ipld/java-cid/issues - GitHub Issues - + + + MIT License + https://github.com/multiformats/java-multiaddr/blob/master/LICENSE + repo + + - - https://github.com/ipld/java-cid - scm:git:git://github.com/ipld/java-cid.git - scm:git:git@github.com:ipld/java-cid.git - + + scm:git:git://github.com/multiformats/java-multibase.git + scm:git:git@github.com:multiformats/java-multibase.git + HEAD + https://github.com/multiformats/java-multibase + - - - MIT License - https://github.com/ipld/java-cid/blob/master/LICENSE - repo - - + + GitHub Issues + https://github.com/multiformats/java-multibase/issues + - - UTF-8 - UTF-8 - 5.11.0 - 2.2 - 1.3.6 - + + 2026-01-20T00:00:00Z + UTF-8 + UTF-8 + 11 + 6.0.2 + 1.4.0 + - - - jitpack.io - https://jitpack.io - - + + + com.github.multiformats + java-multihash + ${version.multihash} + + + org.junit.jupiter + junit-jupiter-api + ${version.junit} + test + + - - - com.github.multiformats - java-multihash - ${version.multihash} - - - org.junit.jupiter - junit-jupiter - ${version.junit} - test - - - org.hamcrest - hamcrest-core - ${version.hamcrest} - test - - + + + jitpack.io + https://jitpack.io + + - - - - org.apache.maven.plugins - maven-compiler-plugin - 3.13.0 - - 17 - UTF-8 - - -Xlint:-serial,all - -Werror - -XDcompilePolicy=simple - --should-stop=ifError=FLOW - -Xplugin:ErrorProne - - - - com.google.errorprone - error_prone_core - 2.36.0 - - - - - - org.apache.maven.plugins - maven-surefire-plugin - 3.1.2 - - - org.apache.maven.plugins - maven-jar-plugin - 3.0.2 - - - - true - - - - - - + + + + org.apache.maven.plugins + maven-enforcer-plugin + 3.6.2 + + + + 3.9.6 + + + 21 + + + + + + enforce + + enforce + + validate + + + + + com.diffplug.spotless + spotless-maven-plugin + 3.1.0 + + + + 1.33.0 + + + google-java-format + + + + + + false + + true + true + + + + true + + + + + + ${spotless.action} + + process-sources + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.14.1 + + + org.apache.maven.plugins + maven-surefire-plugin + 3.5.4 + + + org.apache.maven.plugins + maven-jar-plugin + 3.5.0 + + + + true + + + + + + + + + format-check + + + env.CI + + + + check + + + + format + + + !env.CI + + + + apply + + + diff --git a/src/main/java/io/ipfs/cid/Cid.java b/src/main/java/io/ipfs/cid/Cid.java index d853614..bc75225 100644 --- a/src/main/java/io/ipfs/cid/Cid.java +++ b/src/main/java/io/ipfs/cid/Cid.java @@ -1,5 +1,7 @@ package io.ipfs.cid; +import io.ipfs.multibase.Multibase; +import io.ipfs.multihash.Multihash; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; @@ -9,208 +11,195 @@ import java.util.Map; import java.util.TreeMap; -import io.ipfs.multibase.Multibase; -import io.ipfs.multihash.Multihash; - public class Cid extends Multihash { - public static final class CidEncodingException extends RuntimeException { - - public CidEncodingException(String message) { - super(message); - } - - public CidEncodingException(String message, Throwable cause) { - super(message, cause); - } - } - - public enum Codec { - // https://github.com/multiformats/multicodec/blob/master/table.csv - Cbor(0x51, "cbor"), - Raw(0x55, "raw"), - DagProtobuf(0x70, "dag-pb"), - DagCbor(0x71, "dag-cbor"), - Libp2pKey(0x72, "libp2p-key"), - EthereumBlock(0x90, "eth-block"), - EthereumTx(0x91, "eth-block-list"), - BitcoinBlock(0xb0, "bitcoin-block"), - BitcoinTx(0xb1, "bitcoin-tx"), - ZcashBlock(0xc0, "zcash-block"), - ZcashTx(0xc1, "zcash-tx"); - - public final long type; - public final String name; - - Codec(long type, String name) { - this.type = type; - this.name = name; - } - - private static Map lookup = new TreeMap<>(); - private static Map nameLookup = new TreeMap<>(); - static { - for (Codec c : Codec.values()) { - lookup.put(c.type, c); - nameLookup.put(c.name, c); - } - } - - public static Codec lookup(long c) { - Codec codec = lookup.get(c); - if (codec == null) - throw new IllegalStateException("Unknown Codec type: " + c); - return codec; - } - - public static Codec lookupIPLDName(String name) { - Codec codec = nameLookup.get(name); - if (codec == null) - throw new IllegalStateException("Unknown Codec type: " + name); - return codec; - } - } - - public final long version; - public final Codec codec; + public static final class CidEncodingException extends RuntimeException { - public Cid(long version, Codec codec, Multihash.Type type, byte[] hash) { - super(type, hash); - this.version = version; - this.codec = codec; + public CidEncodingException(String message) { + super(message); } - public static Cid build(long version, Codec codec, Multihash h) { - return new Cid(version, codec, h.getType(), h.getHash()); + public CidEncodingException(String message, Throwable cause) { + super(message, cause); } + } - private byte[] toBytesV0() { - return super.toBytes(); - } + public enum Codec { + // https://github.com/multiformats/multicodec/blob/master/table.csv + Cbor(0x51, "cbor"), + Raw(0x55, "raw"), + DagProtobuf(0x70, "dag-pb"), + DagCbor(0x71, "dag-cbor"), + Libp2pKey(0x72, "libp2p-key"), + EthereumBlock(0x90, "eth-block"), + EthereumTx(0x91, "eth-block-list"), + BitcoinBlock(0xb0, "bitcoin-block"), + BitcoinTx(0xb1, "bitcoin-tx"), + ZcashBlock(0xc0, "zcash-block"), + ZcashTx(0xc1, "zcash-tx"); - private byte[] toBytesV1() { - try { - ByteArrayOutputStream res = new ByteArrayOutputStream(); - putUvarint(res, version); - putUvarint(res, codec.type); - super.serialize(res); - return res.toByteArray(); - } catch (IOException e) { - throw new UncheckedIOException(e); - } - } + public final long type; + public final String name; - @Override - public byte[] toBytes() { - if (version == 0) - return toBytesV0(); - else if (version == 1) - return toBytesV1(); - throw new IllegalStateException("Unknown CID version: " + version); + Codec(long type, String name) { + this.type = type; + this.name = name; } - @Override - public String toString() { - if (version == 0) { - return super.toString(); - } else if (version == 1) { - return Multibase.encode(Multibase.Base.Base32, toBytesV1()); - } - throw new IllegalStateException("Unknown CID version: " + version); - } - - @Override - public Multihash bareMultihash() { - return new Multihash(getType(), getHash()); - } - - @Override - public boolean equals(Object o) { - if (this == o) - return true; - if (!(o instanceof Multihash)) - return false; - if (!super.equals(o)) - return false; - - if (o instanceof Cid) { - Cid cid = (Cid) o; - - if (version != cid.version) - return false; - return codec == cid.codec; - } - // o must be a Multihash - return version == 0 && super.equals(o); - } + private static Map lookup = new TreeMap<>(); + private static Map nameLookup = new TreeMap<>(); - @Override - public int hashCode() { - int result = super.hashCode(); - if (version == 0) - return result; - result = 31 * result + (int) (version ^ (version >>> 32)); - result = 31 * result + (codec != null ? codec.hashCode() : 0); - return result; - } - - public static Cid buildV0(Multihash h) { - return Cid.build(0, Codec.DagProtobuf, h); - } - - public static Cid buildCidV1(Codec c, Multihash.Type type, byte[] hash) { - return new Cid(1, c, type, hash); - } - - public static Cid decode(String v) { - if (v.length() < 2) - throw new IllegalStateException("CID too short: " + v); - - // support legacy format - if (v.length() == 46 && v.startsWith("Qm")) - return buildV0(Multihash.fromBase58(v)); - - byte[] data = Multibase.decode(v); - return cast(data); - } - - public static Cid cast(byte[] data) { - if (data.length == 34 && data[0] == 18 && data[1] == 32) - return buildV0(new Multihash(Type.lookup(data[0] & 0xff), Arrays.copyOfRange(data, 2, data.length))); - - InputStream in = new ByteArrayInputStream(data); - try { - long version = readVarint(in); - if (version != 0 && version != 1) - throw new CidEncodingException("Invalid CID version number: " + version); - - long codec = readVarint(in); - Multihash hash = Multihash.deserialize(in); - - return new Cid(version, Codec.lookup(codec), hash.getType(), hash.getHash()); - } catch (CidEncodingException cee) { - throw cee; - } catch (Exception e) { - throw new CidEncodingException("Invalid CID bytes: " + bytesToHex(data), e); - } - } - - private static String[] HEX_DIGITS = new String[] { - "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "a", "b", "c", "d", "e", "f" }; - private static String[] HEX = new String[256]; static { - for (int i = 0; i < 256; i++) - HEX[i] = HEX_DIGITS[(i >> 4) & 0xF] + HEX_DIGITS[i & 0xF]; - } - - private static String byteToHex(byte b) { - return HEX[b & 0xFF]; - } - - private static String bytesToHex(byte[] data) { - StringBuilder s = new StringBuilder(data.length * 2); - for (byte b : data) - s.append(byteToHex(b)); - return s.toString(); - } + for (Codec c : Codec.values()) { + lookup.put(c.type, c); + nameLookup.put(c.name, c); + } + } + + public static Codec lookup(long c) { + Codec codec = lookup.get(c); + if (codec == null) throw new IllegalStateException("Unknown Codec type: " + c); + return codec; + } + + public static Codec lookupIPLDName(String name) { + Codec codec = nameLookup.get(name); + if (codec == null) throw new IllegalStateException("Unknown Codec type: " + name); + return codec; + } + } + + public final long version; + public final Codec codec; + + public Cid(long version, Codec codec, Multihash.Type type, byte[] hash) { + super(type, hash); + this.version = version; + this.codec = codec; + } + + public static Cid build(long version, Codec codec, Multihash h) { + return new Cid(version, codec, h.getType(), h.getHash()); + } + + private byte[] toBytesV0() { + return super.toBytes(); + } + + private byte[] toBytesV1() { + try { + ByteArrayOutputStream res = new ByteArrayOutputStream(); + putUvarint(res, version); + putUvarint(res, codec.type); + super.serialize(res); + return res.toByteArray(); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } + + @Override + public byte[] toBytes() { + if (version == 0) return toBytesV0(); + else if (version == 1) return toBytesV1(); + throw new IllegalStateException("Unknown CID version: " + version); + } + + @Override + public String toString() { + if (version == 0) { + return super.toString(); + } else if (version == 1) { + return Multibase.encode(Multibase.Base.Base32, toBytesV1()); + } + throw new IllegalStateException("Unknown CID version: " + version); + } + + @Override + public Multihash bareMultihash() { + return new Multihash(getType(), getHash()); + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (!(o instanceof Multihash)) return false; + if (!super.equals(o)) return false; + + if (o instanceof Cid) { + Cid cid = (Cid) o; + + if (version != cid.version) return false; + return codec == cid.codec; + } + // o must be a Multihash + return version == 0 && super.equals(o); + } + + @Override + public int hashCode() { + int result = super.hashCode(); + if (version == 0) return result; + result = 31 * result + (int) (version ^ (version >>> 32)); + result = 31 * result + (codec != null ? codec.hashCode() : 0); + return result; + } + + public static Cid buildV0(Multihash h) { + return Cid.build(0, Codec.DagProtobuf, h); + } + + public static Cid buildCidV1(Codec c, Multihash.Type type, byte[] hash) { + return new Cid(1, c, type, hash); + } + + public static Cid decode(String v) { + if (v.length() < 2) throw new IllegalStateException("CID too short: " + v); + + // support legacy format + if (v.length() == 46 && v.startsWith("Qm")) return buildV0(Multihash.fromBase58(v)); + + byte[] data = Multibase.decode(v); + return cast(data); + } + + public static Cid cast(byte[] data) { + if (data.length == 34 && data[0] == 18 && data[1] == 32) + return buildV0( + new Multihash(Type.lookup(data[0] & 0xff), Arrays.copyOfRange(data, 2, data.length))); + + InputStream in = new ByteArrayInputStream(data); + try { + long version = readVarint(in); + if (version != 0 && version != 1) + throw new CidEncodingException("Invalid CID version number: " + version); + + long codec = readVarint(in); + Multihash hash = Multihash.deserialize(in); + + return new Cid(version, Codec.lookup(codec), hash.getType(), hash.getHash()); + } catch (CidEncodingException cee) { + throw cee; + } catch (Exception e) { + throw new CidEncodingException("Invalid CID bytes: " + bytesToHex(data), e); + } + } + + private static String[] HEX_DIGITS = + new String[] {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "a", "b", "c", "d", "e", "f"}; + private static String[] HEX = new String[256]; + + static { + for (int i = 0; i < 256; i++) HEX[i] = HEX_DIGITS[(i >> 4) & 0xF] + HEX_DIGITS[i & 0xF]; + } + + private static String byteToHex(byte b) { + return HEX[b & 0xFF]; + } + + private static String bytesToHex(byte[] data) { + StringBuilder s = new StringBuilder(data.length * 2); + for (byte b : data) s.append(byteToHex(b)); + return s.toString(); + } } diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java new file mode 100644 index 0000000..75958f6 --- /dev/null +++ b/src/main/java/module-info.java @@ -0,0 +1,6 @@ +module io.ipfs.cid { + requires io.ipfs.multihash; + requires io.ipfs.multibase; + + exports io.ipfs.cid; +} diff --git a/src/test/java/io/ipfs/cid/CidTest.java b/src/test/java/io/ipfs/cid/CidTest.java index 8dd0ff1..1a4a042 100755 --- a/src/test/java/io/ipfs/cid/CidTest.java +++ b/src/test/java/io/ipfs/cid/CidTest.java @@ -2,83 +2,79 @@ import static java.nio.charset.StandardCharsets.UTF_8; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertThrows; +import io.ipfs.multihash.Multihash; import java.io.IOException; import java.security.MessageDigest; import java.util.Arrays; import java.util.List; - import org.junit.jupiter.api.Test; -import io.ipfs.multihash.Multihash; - class CidTest { - @Test - void validStrings() { - List examples = Arrays.asList( - "QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB", - "QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy", - "bafyreigivjmlrue5db7rpwmbonv7oq57hvnp7yzhlsoy3fbwi5jzhwgali"); - for (String example : examples) { - Cid cid = Cid.decode(example); - String encoded = cid.toString(); - if (!encoded.equals(example)) - throw new IllegalStateException("Incorrect cid string! " + example + " => " + encoded); - } - } - - @Test - void emptyStringShouldFail() throws IOException { - try { - Cid.decode(""); - throw new RuntimeException(); - } catch (IllegalStateException e) { - // Expected! - } - } - - @Test - void basicMarshalling() throws Exception { - MessageDigest hasher = MessageDigest.getInstance("SHA-512"); - byte[] hash = hasher.digest("TEST".getBytes(UTF_8)); - - Cid cid = new Cid(1, Cid.Codec.Raw, Multihash.Type.sha2_512, hash); - byte[] data = cid.toBytes(); - - Cid cast = Cid.cast(data); - assertEquals(cast, cid, "Invertible serialization"); - - Cid fromString = Cid.decode(cid.toString()); - assertEquals(fromString, cid, "Invertible toString"); + @Test + void validStrings() { + List examples = + Arrays.asList( + "QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB", + "QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy", + "bafyreigivjmlrue5db7rpwmbonv7oq57hvnp7yzhlsoy3fbwi5jzhwgali"); + for (String example : examples) { + Cid cid = Cid.decode(example); + String encoded = cid.toString(); + if (!encoded.equals(example)) + throw new IllegalStateException("Incorrect cid string! " + example + " => " + encoded); } - - @Test - void version0Handling() throws Exception { - String hashString = "QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB"; - Cid cid = Cid.decode(hashString); - - assertEquals(0, cid.version, "version 0"); - - assertEquals(cid.toString(), hashString, "Correct hash"); - } - - @Test - void version0Error() throws Exception { - String invalidString = "QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zIII"; - try { - Cid.decode(invalidString); - throw new RuntimeException(); - } catch (IllegalStateException e) { - // Expected! - } - } - - @Test - void lookByOfficialIPLDName() { - Cid.Codec raw = Cid.Codec.lookupIPLDName("raw"); - assertEquals("Raw", raw.name(), "Raw Codec"); - Cid.Codec dagcbor = Cid.Codec.lookupIPLDName("dag-cbor"); - assertEquals("DagCbor", dagcbor.name(), "DagCbor Codec"); + } + + @Test + void emptyStringShouldFail() throws IOException { + try { + Cid.decode(""); + throw new RuntimeException(); + } catch (IllegalStateException e) { + // Expected! } + } + + @Test + void basicMarshalling() throws Exception { + MessageDigest hasher = MessageDigest.getInstance("SHA-512"); + byte[] hash = hasher.digest("TEST".getBytes(UTF_8)); + + Cid cid = new Cid(1, Cid.Codec.Raw, Multihash.Type.sha2_512, hash); + byte[] data = cid.toBytes(); + + Cid cast = Cid.cast(data); + assertEquals(cast, cid, "Invertible serialization"); + + Cid fromString = Cid.decode(cid.toString()); + assertEquals(fromString, cid, "Invertible toString"); + } + + @Test + void version0Handling() throws Exception { + String hashString = "QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB"; + Cid cid = Cid.decode(hashString); + + assertEquals(0, cid.version, "version 0"); + + assertEquals(cid.toString(), hashString, "Correct hash"); + } + + @Test + void version0Error() { + assertThrows( + IllegalArgumentException.class, + () -> Cid.decode("QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zIII")); + } + + @Test + void lookByOfficialIPLDName() { + Cid.Codec raw = Cid.Codec.lookupIPLDName("raw"); + assertEquals("Raw", raw.name(), "Raw Codec"); + Cid.Codec dagcbor = Cid.Codec.lookupIPLDName("dag-cbor"); + assertEquals("DagCbor", dagcbor.name(), "DagCbor Codec"); + } }