diff --git a/build.gradle b/build.gradle index a5b74a058..c6fd2c03f 100644 --- a/build.gradle +++ b/build.gradle @@ -45,6 +45,9 @@ java.targetCompatibility = JavaVersion.VERSION_1_8 mainClassName = "net.yacy.yacy" applicationDefaultJvmArgs = ["-Xmx1024m"] +// create property store for filterTokens (here, to make sure it exist) +project.ext.filterTokens = new Properties() + parcl { exe { exeName = "YaCy" @@ -83,9 +86,6 @@ dependencies { jar { archiveFileName = 'yacycore.jar' destinationDirectory = new File('lib') - - // @TODO: class-path workaround until we've dependencies to use configurations.implementation instead of filetree. - FileTree libdir = fileTree("lib").include ("*.jar").exclude("yacycore.jar") manifest { attributes( "Main-Class": mainClassName , @@ -109,6 +109,42 @@ task copyDependenciesToLib(type: Copy) { } build.dependsOn(copyDependenciesToLib) } + +// runs the support tool which creates gitbuildnumber.properties from info of local git repository +task runGitComInf(type: JavaExec) { + classpath = files('libbuild/GitComInf-all.jar') + args = [project.projectDir.getPath(), project.projectDir.getPath() + "/build/tmp/gitbuildnumber.properties"] + mainClass = 'GitComInf' +} + +// prepare yacyBuildProperties.java from template (needed after commits or new versions) +// read values from property file generated by GitComInf tool +import org.apache.tools.ant.filters.ReplaceTokens +task prepYaCyProperties (type: Copy) { + mustRunAfter runGitComInf + def propfile = "build/tmp/gitbuildnumber.properties"; + if (project.file(propfile).exists()) { // must check otherwise any action may stop after clean on this error + file("build/tmp/gitbuildnumber.properties").withReader { + Properties props = new Properties() + props.load(it) + project.ext.filterTokens.putAll(props) + } + } else + logger.error("prepYaCyProperties: file " + propfile + " is missing, you should re-run runGitComInf") + + String fdirname = sourceSets.main.java.srcDirs[0].name + '/net/yacy/peers/operation' + copy { + from fdirname + include('yacyBuildProperties.java.template') + rename 'yacyBuildProperties.java.template', 'yacyBuildProperties.java' + into (fdirname) + + filter(org.apache.tools.ant.filters.ReplaceTokens, tokens: project.ext.filterTokens) + filter(ReplaceTokens, tokens: [REPL_VERSION: version, REPL_PKGMANAGER:"false", REPL_RESTARTCMD: "/etc/init.d/yacy restart"]) // gradle.project.version + some defaults from ant + } +} +prepYaCyProperties.dependsOn(runGitComInf) +compileJava.dependsOn(prepYaCyProperties) // must be executed before compile /** ----------------------------------------------------------- * Settings during the migration from Ant to Gradle build @@ -123,15 +159,5 @@ ant.importBuild('build.xml') { antTaskName -> "ant_${antTaskName}".toString() } tasks.matching { task -> task.name.startsWith('ant_') }*.group = 'Ant' // include compile of htroot servlets in Gradle lifecycle somewhere after compileJava -startScripts.dependsOn("ant_compile-htroot") - -tasks.named('ant_buildGitRevTask') { - doFirst { - println '=====================================' - println 'In case this imported Ant task fails' - println '(stop ant jvm which on failure keeps a lock on libbuild/GitRevTask.jar (making supsequent builds fail too)' - println '- run the normal ant build "ant all" ONCE (to complile the libbuild/GitRevTask.jar)' - println '- after this Gradle build should work' - println '=====================================' - } -} \ No newline at end of file +startScripts.dependsOn("ant_gradle-compile-htroot") + diff --git a/build.xml b/build.xml index 560bbb828..84d4bf8b2 100644 --- a/build.xml +++ b/build.xml @@ -330,6 +330,20 @@ + + + + + + + + + + diff --git a/libbuild/GitComInf-all.jar b/libbuild/GitComInf-all.jar new file mode 100644 index 000000000..e9c20f2a8 Binary files /dev/null and b/libbuild/GitComInf-all.jar differ diff --git a/libbuild/GitComInf/.gitattributes b/libbuild/GitComInf/.gitattributes new file mode 100644 index 000000000..00a51aff5 --- /dev/null +++ b/libbuild/GitComInf/.gitattributes @@ -0,0 +1,6 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# These are explicitly windows files and should use crlf +*.bat text eol=crlf + diff --git a/libbuild/GitComInf/.gitignore b/libbuild/GitComInf/.gitignore new file mode 100644 index 000000000..1b6985c00 --- /dev/null +++ b/libbuild/GitComInf/.gitignore @@ -0,0 +1,5 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build diff --git a/libbuild/GitComInf/build.gradle b/libbuild/GitComInf/build.gradle new file mode 100644 index 000000000..7ebb37db0 --- /dev/null +++ b/libbuild/GitComInf/build.gradle @@ -0,0 +1,43 @@ + +plugins { + id 'java' + id 'application' + id 'com.github.johnrengelman.shadow' version '7.1.2' +} + +apply plugin: 'java' +apply plugin: 'application' +apply plugin: 'com.github.johnrengelman.shadow' + +repositories { + mavenCentral() +} + +mainClassName = "GitComInf" + +tasks.withType(JavaCompile) { + options.encoding = 'UTF-8' +} + +dependencies { + implementation group: 'org.eclipse.jgit', name: 'org.eclipse.jgit', version: '5.13.0.202109080827-r' + implementation group: 'org.slf4j', name: 'slf4j-api', version: '1.7.33' // to prevent warning msg about missing binding + implementation group: 'org.slf4j', name: 'slf4j-simple', version: '1.7.33' +} +/* +jar { + manifest { + attributes( + "Main-Class": mainClassName , + "Class-Path": configurations.runtimeClasspath.collect { it.name }.join(' ') + ) + } +} +*/ +// copy fat-jar to deploy location .. +task installJar (type:Copy) { + from 'build/libs' + include 'GitComInf-all.jar' + into project.projectDir.getParent() +} + diff --git a/libbuild/GitComInf/gradle/wrapper/gradle-wrapper.jar b/libbuild/GitComInf/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..7454180f2 Binary files /dev/null and b/libbuild/GitComInf/gradle/wrapper/gradle-wrapper.jar differ diff --git a/libbuild/GitComInf/gradle/wrapper/gradle-wrapper.properties b/libbuild/GitComInf/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..e750102e0 --- /dev/null +++ b/libbuild/GitComInf/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.3-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/libbuild/GitComInf/gradlew b/libbuild/GitComInf/gradlew new file mode 100644 index 000000000..c53aefaa5 --- /dev/null +++ b/libbuild/GitComInf/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/libbuild/GitComInf/gradlew.bat b/libbuild/GitComInf/gradlew.bat new file mode 100644 index 000000000..107acd32c --- /dev/null +++ b/libbuild/GitComInf/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/libbuild/GitComInf/settings.gradle b/libbuild/GitComInf/settings.gradle new file mode 100644 index 000000000..15e6d6421 --- /dev/null +++ b/libbuild/GitComInf/settings.gradle @@ -0,0 +1,13 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * The settings file is used to specify which projects to include in your build. + * + * Detailed information about configuring a multi-project build in Gradle can be found + * in the user manual at https://docs.gradle.org/7.3/userguide/multi_project_builds.html + */ + +rootProject.name = 'GitComInf' + + + diff --git a/libbuild/GitComInf/src/main/java/GitComInf.java b/libbuild/GitComInf/src/main/java/GitComInf.java new file mode 100644 index 000000000..9540e6025 --- /dev/null +++ b/libbuild/GitComInf/src/main/java/GitComInf.java @@ -0,0 +1,149 @@ + +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.text.SimpleDateFormat; +import java.util.ArrayList; +import java.util.List; +import java.util.Properties; + +import org.eclipse.jgit.api.Git; +import org.eclipse.jgit.api.errors.GitAPIException; +import org.eclipse.jgit.lib.ObjectId; +import org.eclipse.jgit.lib.Ref; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.revwalk.RevCommit; +import org.eclipse.jgit.revwalk.RevWalk; +import org.eclipse.jgit.storage.file.FileRepositoryBuilder; + +public class GitComInf extends Properties { + + final private String BRANCHPROP_LABEL = "branch"; + final private String REVPROP_LABEL = "releaseNr"; // git commit number + final private String DATEPROP_LABEL = "DSTAMP"; // git commit date + private String repoPath; // path to repository root directory + + public void setRepoPath(final String repoPath) { + this.repoPath = repoPath; + } + + public void execute() { + + String branch = null; + String revision = null; + String lastTag = null; + String commitDate = null; + + Repository repo = null; + Git git = null; + RevWalk walk = null; + try { + final File src = new File(this.repoPath); + repo = new FileRepositoryBuilder().readEnvironment() + .findGitDir(src).build(); + branch = repo.getBranch(); + branch = "master".equals(branch) ? "" : "_" + branch; + this.setProperty(this.BRANCHPROP_LABEL, branch); + final ObjectId head = repo.resolve("HEAD"); + + git = new Git(repo); + final List tags = git.tagList().call(); + + walk = new RevWalk(repo); + final RevCommit headCommit = walk.parseCommit(head); + final SimpleDateFormat df = new SimpleDateFormat("yyyyMMdd"); + commitDate = df.format(headCommit.getAuthorIdent().getWhen()); + walk.markStart(headCommit); + int distance = 0; + + /* Peel known tags */ + final List peeledTags = new ArrayList<>(); + for (final Ref tag : tags) { + peeledTags.add(repo.peel(tag)); + } + + /* Look for the last tag commit and calculate distance with the HEAD commit */ + for (final RevCommit commit : walk) { + for (final Ref tag : peeledTags) { + if (commit.equals(tag.getPeeledObjectId()) || commit.equals(tag.getObjectId())) { + lastTag = commit.getShortMessage(); + break; + } + } + if (lastTag != null || distance++ > 90999) { + break; + } + } + walk.dispose(); + if (lastTag == null) { + revision = "0000"; + } else { + revision = Integer.toString(distance + 9000); + } + } catch (final IOException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } catch (GitAPIException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } finally { + /* In all cases, properly release resources */ + if (walk != null) { + walk.close(); + } + if (git != null) { + git.close(); + } + if (repo != null) { + repo.close(); + } + } + + this.setProperty(this.BRANCHPROP_LABEL, branch); +//this.setProperty(branch, branch) + this.setProperty(this.REVPROP_LABEL, revision); + this.setProperty("REPL_REVISION_NR", revision); + this.setProperty(this.DATEPROP_LABEL, commitDate); + this.setProperty("REPL_DATE", commitDate); + } + + /** + * use: GitComInf.jar pathtoGitRepro outputfile gitbuildnumber.properties + * + * @param args = path to Git repository (default . ) + * @param args (optional) = filename for result (default + * ./gitbuildnumber.properties) + */ + public static void main(String[] args) { + GitComInf gitRevTask = new GitComInf(); + if (args.length == 0) { + gitRevTask.setRepoPath("."); // path to root of git repository + } else { + gitRevTask.setRepoPath(args[0]); + } + + gitRevTask.execute(); + System.out.println("Git Commit Info: " + gitRevTask.toString()); + + // output result to property file + File f; + if (args.length > 1) { + f = new File(args[1]); + } else { + f = new File("gitbuildnumber.properties"); + } + try { + if (!f.exists()) { + f.getParentFile().mkdirs(); + // Files.createDirectories(f.getParentFile().toPath()); // just make sure missing dir is not a problem + } + f.createNewFile(); + FileWriter w = new FileWriter(f); + gitRevTask.store(w, ""); + w.close(); + } catch (final IOException ex) { + System.out.println(ex.toString()); + System.out.println (args[1]); + } + } +}