diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f87b13a --- /dev/null +++ b/LICENSE @@ -0,0 +1,83 @@ + - Config - Configuration properties that can be defined via the CLI, system properties, environment variables, or file. + [The Apache Software License, Version 2.0] + https://git.dorkbox.com/dorkbox/Config + Copyright 2022 + Dorkbox LLC + + Extra license information + - Moshi - A modern JSON library for Kotlin and Java + [The Apache Software License, Version 2.0] + https://github.com/square/moshi + Copyright 2022 + Square, Inc + + - OkIO - A modern I/O library for Android, Kotlin, and Java + [The Apache Software License, Version 2.0] + https://github.com/square/okio + Copyright 2022 + Square, Inc + + - kotlin-logging - Lightweight logging framework for Kotlin + [The Apache Software License, Version 2.0] + https://github.com/MicroUtils/kotlin-logging + Copyright 2022 + Ohad Shai + + - SLF4J - Simple facade or abstraction for various logging frameworks + [MIT License] + http://www.slf4j.org + Copyright 2022 + QOS.ch + + - Kotlin - + [The Apache Software License, Version 2.0] + https://github.com/JetBrains/kotlin + Copyright 2020 + JetBrains s.r.o. and Kotlin Programming Language contributors + Kotlin Compiler, Test Data+Libraries, and Tools repository contain third-party code, to which different licenses may apply + See: https://github.com/JetBrains/kotlin/blob/master/license/README.md + + - Updates - Software Update Management + [The Apache Software License, Version 2.0] + https://git.dorkbox.com/dorkbox/Updates + Copyright 2021 + Dorkbox LLC + + Extra license information + - Kotlin - + [The Apache Software License, Version 2.0] + https://github.com/JetBrains/kotlin + Copyright 2020 + JetBrains s.r.o. and Kotlin Programming Language contributors + Kotlin Compiler, Test Data+Libraries, and Tools repository contain third-party code, to which different licenses may apply + See: https://github.com/JetBrains/kotlin/blob/master/license/README.md + + - OS - Information about the system, Java runtime, OS, Window Manager, and Desktop Environment. + [The Apache Software License, Version 2.0] + https://git.dorkbox.com/dorkbox/OS + Copyright 2022 + Dorkbox LLC + + Extra license information + - Kotlin - + [The Apache Software License, Version 2.0] + https://github.com/JetBrains/kotlin + Copyright 2020 + JetBrains s.r.o. and Kotlin Programming Language contributors + Kotlin Compiler, Test Data+Libraries, and Tools repository contain third-party code, to which different licenses may apply + See: https://github.com/JetBrains/kotlin/blob/master/license/README.md + + - Updates - Software Update Management + [The Apache Software License, Version 2.0] + https://git.dorkbox.com/dorkbox/Updates + Copyright 2021 + Dorkbox LLC + + Extra license information + - Kotlin - + [The Apache Software License, Version 2.0] + https://github.com/JetBrains/kotlin + Copyright 2020 + JetBrains s.r.o. and Kotlin Programming Language contributors + Kotlin Compiler, Test Data+Libraries, and Tools repository contain third-party code, to which different licenses may apply + See: https://github.com/JetBrains/kotlin/blob/master/license/README.md diff --git a/LICENSE.Apachev2 b/LICENSE.Apachev2 new file mode 100644 index 0000000..79d1b97 --- /dev/null +++ b/LICENSE.Apachev2 @@ -0,0 +1,218 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included + in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS + OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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 + + 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. \ No newline at end of file diff --git a/LICENSE.MIT b/LICENSE.MIT new file mode 100644 index 0000000..2e9f5aa --- /dev/null +++ b/LICENSE.MIT @@ -0,0 +1,21 @@ + MIT License + + + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100755 index 0000000..46c62c2 --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +Configuration properties that can be defined via the CLI, system properties, environment variables, or file. + +###### [![Dorkbox](https://badge.dorkbox.com/dorkbox.svg "Dorkbox")](https://git.dorkbox.com/dorkbox/Config) [![Github](https://badge.dorkbox.com/github.svg "Github")](https://github.com/dorkbox/Config) [![Gitlab](https://badge.dorkbox.com/gitlab.svg "Gitlab")](https://gitlab.com/dorkbox/Config) + + +This project provides configuration properties, such that ANYTHING in the config file can ALSO be passed in on the command line or as an env/system property + +``` +commandline > system property > environment variable > properties file +``` +Once a property has been defined, it cannot be overloaded again via a different method, as specified in the above hierarchy, + +During a save operation, overloaded values will be ignored unless they were manually changed to something different + + +Additionally, it is possible to set an environment variable names that might conflict with the standard set of names, for example, + ``` + PATH + ``` +* The system uses PATH, but if we want to use path for something different, we can via setting the prefix. +* For example, setting the prefix to `CONFIG__` means that for us to set the `path` property, we set it via + +``` +CONFIG__path="/home/blah/whatever" +``` + * And this way, **OUR** path does not conflict with the system path. + + +Maven Info +--------- +``` + + ... + + com.dorkbox + Config + 1.0 + + +``` + +Gradle Info +--------- +``` +dependencies { + ... + implementation("com.dorkbox:Config:1.0") +} +``` + +License +--------- +This project is © 2022 dorkbox llc, and is distributed under the terms of the Apache v2.0 License. See file "LICENSE" for further +references. diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..5916919 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,129 @@ +/* + * Copyright 2020 dorkbox, llc + * + * 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 + * + * 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. + */ + +import java.time.Instant + +/////////////////////////////// +////// PUBLISH TO SONATYPE / MAVEN CENTRAL +////// TESTING : (to local maven repo) <'publish and release' - 'publishToMavenLocal'> +////// RELEASE : (to sonatype/maven central), <'publish and release' - 'publishToSonatypeAndRelease'> +/////////////////////////////// + +gradle.startParameter.showStacktrace = ShowStacktrace.ALWAYS // always show the stacktrace! + + +plugins { + id("com.dorkbox.GradleUtils") version "2.16" + id("com.dorkbox.Licensing") version "2.12" + id("com.dorkbox.VersionUpdate") version "2.4" + id("com.dorkbox.GradlePublish") version "1.12" + + kotlin("jvm") version "1.6.10" +} + +object Extras { + // set for the project + const val description = "Configuration properties that can be defined via the CLI, system properties, environment variables, or file." + const val group = "com.dorkbox" + const val version = "1.0" + + // set as project.ext + const val name = "Config" + const val id = "Config" // this is the maven ID! + const val vendor = "Dorkbox LLC" + const val vendorUrl = "https://dorkbox.com" + const val url = "https://git.dorkbox.com/dorkbox/Config" + + val buildDate = Instant.now().toString() +} + +/////////////////////////////// +///// assign 'Extras' +/////////////////////////////// +GradleUtils.load("$projectDir/../../gradle.properties", Extras) +GradleUtils.defaults() +GradleUtils.compileConfiguration(JavaVersion.VERSION_1_8) { + // see: https://kotlinlang.org/docs/reference/using-gradle.html + freeCompilerArgs = listOf( + // enable the use of experimental methods + "-Xopt-in=kotlin.RequiresOptIn" + ) +} +//GradleUtils.jpms(JavaVersion.VERSION_1_9) moshi doesn't support JPMS yet + + +licensing { + license(License.APACHE_2) { + description(Extras.description) + author(Extras.vendor) + url(Extras.url) + } +} + +tasks.jar.get().apply { + manifest { + // https://docs.oracle.com/javase/tutorial/deployment/jar/packageman.html + attributes["Name"] = Extras.name + + attributes["Specification-Title"] = Extras.name + attributes["Specification-Version"] = Extras.version + attributes["Specification-Vendor"] = Extras.vendor + + attributes["Implementation-Title"] = "${Extras.group}.${Extras.id}" + attributes["Implementation-Version"] = Extras.buildDate + attributes["Implementation-Vendor"] = Extras.vendor + } +} + +dependencies { + api("com.dorkbox:Updates:1.1") + api("com.dorkbox:OS:1.0") + + val moshiVer = "1.13.0" + + // For JSON serialization + api("com.squareup.moshi:moshi:$moshiVer") + api("com.squareup.moshi:moshi-kotlin:$moshiVer") + api("com.squareup.okio:okio:3.0.0") + + // https://github.com/MicroUtils/kotlin-logging + api("io.github.microutils:kotlin-logging:2.1.21") + api("org.slf4j:slf4j-api:1.8.0-beta4") +} + +publishToSonatype { + groupId = Extras.group + artifactId = Extras.id + version = Extras.version + + name = Extras.name + description = Extras.description + url = Extras.url + + vendor = Extras.vendor + vendorUrl = Extras.vendorUrl + + issueManagement { + url = "${Extras.url}/issues" + nickname = "Gitea Issues" + } + + developer { + id = "dorkbox" + name = Extras.vendor + email = "email@dorkbox.com" + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..44dcb84 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,15 @@ +# https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties +org.gradle.jvmargs=-Dfile.encoding=UTF-8 + +#org.gradle.warning.mode=(all,fail,none,summary) +org.gradle.warning.mode=all + +#org.gradle.daemon=false +# default is 3 hours, this is 1 minute +org.gradle.daemon.idletimeout=60000 + +#org.gradle.console=(auto,plain,rich,verbose) +org.gradle.console=auto + +#org.gradle.logging.level=(quiet,warn,lifecycle,info,debug) +org.gradle.logging.level=lifecycle diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..7454180 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..b1159fc --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-all.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/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/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..ac1b06f --- /dev/null +++ b/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/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..cce9d6c --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,15 @@ +/* + * Copyright 2018 dorkbox, llc + * + * 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 + * + * 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. + */ diff --git a/src/dorkbox/config/Config.kt b/src/dorkbox/config/Config.kt new file mode 100644 index 0000000..884ca10 --- /dev/null +++ b/src/dorkbox/config/Config.kt @@ -0,0 +1,412 @@ +package dorkbox.config + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonAdapter +import com.squareup.moshi.JsonClass +import com.squareup.moshi.Moshi +import dorkbox.os.OS +import mu.KLogger +import java.io.File +import java.lang.reflect.Modifier +import java.util.* +import mu.KotlinLogging.logger +import kotlin.reflect.KProperty +import kotlin.reflect.full.declaredMemberProperties +import kotlin.reflect.full.findAnnotations +import kotlin.reflect.full.hasAnnotation +import kotlin.reflect.full.isSubclassOf +import kotlin.reflect.jvm.javaField +import kotlin.reflect.jvm.jvmErasure +import kotlin.system.exitProcess + +/** + * we want to support configuration properties, such that ANYTHING in the config file can ALSO be passed in on the command line or as an env/system property + * + * ``` + * commandline > system property > environment variable > properties file + * ``` + * Once a property has been defined, it cannot be overloaded again via a different method, as specified in the above hierarchy, + * + * During a save operation, overloaded values will be ignored unless they were manually changed to something different + */ +@Suppress("MemberVisibilityCanBePrivate", "unused") +open class Config( + /** + * Enables setting environment variable names that might conflict with the standard set of names, for example, + * PATH... + * + * The system uses PATH, but if we want to use path for something different, we can via setting the prefix. + * For example, setting the prefix to "CONFIG__" means that for us to set the `path` property, we set it via + * + *``` + * CONFIG__path="/home/blah/whatever" + *``` + * And this way, **OUR** path does not conflict with the system path. + */ + private val environmentVarPrefix: String = "", + moshiAdapter: Moshi.Builder.() -> JsonAdapter) { + + + companion object { + private val regexEquals = "=".toRegex() + private val locale = Locale.getDefault() + + /** + * Gets the version number. + */ + const val version = "1.0" + + init { + // Add this project to the updates system, which verifies this class + UUID + version information + dorkbox.updates.Updates.add(Config::class.java, "a2afbd7d98084a9eb6eb663570dbec77", version) + } + } + + private val logger: KLogger = logger() {} + + private val moshi = moshiAdapter(Moshi.Builder()) + + private lateinit var configFile: File + + private lateinit var originalConfig: T + private lateinit var originalConfigMap: Map + + private lateinit var configMap: Map + private lateinit var config: T + + private val arguments = ArrayList() + + + /** Contains a list of the changed properties (via overloading) */ + private val trackedConfigProperties = mutableMapOf() + private val originalOverloadedProperties = mutableMapOf() + + fun load(configFile: File, createDefaultObject: () -> T): T { + this.configFile = configFile + var localConfig: T? = null + if (configFile.canRead()) { + val argFileContents = configFile.readText(Charsets.UTF_8) + if (argFileContents.isNotEmpty()) { + try { + // we want to make ALL NEW configs, each referencing a DIFFERENT object + localConfig = moshi.fromJson(argFileContents)!! + } + catch (ignored: Exception) { + } + } + } + + if (localConfig == null) { + localConfig = createDefaultObject() + save() + } + + // now, we make a COPY of the original values from the file (so when saving, we know what the overloaded values are and not save them) + originalConfig = localConfig + // create the map that knows what members have what values + originalConfigMap = createConfigMap(originalConfig) + + + // let's also make a deep copy. + config = moshi.fromJson(moshi.toJson(originalConfig))!! + // create the map that knows what members have what values + configMap = createConfigMap(config) + + return config + } + + fun save() { + val possiblyOverloadedConfigMap = configMap + + // now, when we SAVE, we want to make sure that we DO NOT save overloaded values! + // we ONLY save the original values + any values that have been modified. + val changedProperties = mutableListOf() + trackedConfigProperties.entries.forEach { (key, _) -> + // check to see if our overloaded value has been changed... + val inMemoryProperty = possiblyOverloadedConfigMap[key] + val originalOverloadedProp = originalOverloadedProperties[key] + + // if it has changed, then REMOVE IT from the list of things to ignore + if (inMemoryProperty!!.get() != originalOverloadedProp) { + changedProperties.add(key) + } + } + changedProperties.forEach { + trackedConfigProperties.remove(it) + } + + + // copy all the in-memory values to the "original" config, but SKIP the ones that are overloaded (and unchanged). + // this is a tad slow, but makes sure that our saves do not include properties that have been overloaded + if (trackedConfigProperties.isNotEmpty()) { + possiblyOverloadedConfigMap.entries.forEach { (key, value) -> + if (!trackedConfigProperties.containsKey(key)) { + originalConfigMap[key]!!.set(value.get()) + } + } + } + + val configToString = moshi.toJson(originalConfig) + configFile.writeText(configToString, Charsets.UTF_8) + } + + /** + * process the arguments, and if applicable perform a `get` or `set` operation + */ + fun process(arguments: Array, onSaveAction: () -> Unit): List { + this.arguments.addAll(arguments) + + // now we have to see if there are any OVERLOADED properties + manageOverloadProperties() + manageGetAndSet(onSaveAction) + + return this.arguments + } + + + private fun createConfigMap(config: Any): Map { + // this creates an EASY-to-use map of all arguments we have + val argumentMap = mutableMapOf() + + val kClass = config::class + require(kClass.hasAnnotation()) { "Cannot parse configuraion if it is not annotated with @JsonClass"} + + // get all the members of this class. + for (member in kClass.declaredMemberProperties) { + @Suppress("UNCHECKED_CAST") + assignFieldsToMap(argumentMap, member as KProperty, config, member.getter.call(config)!!, "", -1) + } + + return argumentMap + } + + // the class is treated as lowercase, but the VALUE of properties is treated as case-sensitive + @OptIn(ExperimentalStdlibApi::class) + private fun assignFieldsToMap(argMap: MutableMap, field: KProperty, + parentObj: Any, obj: Any, + prefix: String, index: Int = -1) + + { + if (Modifier.isTransient(field.javaField!!.modifiers)) { + // ignore transient fields! + return + } + + var jsonName = (field.findAnnotations().firstOrNull()?.name ?: field.name).lowercase(locale) + jsonName = when { + prefix.isEmpty() -> jsonName + else ->"$prefix.$jsonName".lowercase(locale) + } + + if (index > -1) { + jsonName += "[$index]" + } + + val kClass = obj::class + if (kClass.hasAnnotation()) { + // get all the members of this class. + for (member in kClass.declaredMemberProperties) { + @Suppress("UNCHECKED_CAST") + assignFieldsToMap(argMap, member as KProperty, obj, member.getter.call(obj)!!, jsonName, -1) + } + } else { + if (field.returnType.jvmErasure.isSubclassOf(List::class)) { + // iterate over the collection, but assign the index with the name. + @Suppress("UNCHECKED_CAST") + val collection = obj as List + collection.forEachIndexed { i, any -> + assignFieldsToMap(argMap, field, obj, any, prefix, i) + } + } else { + // only add fields to map that are ones we care about + @Suppress("UNCHECKED_CAST") + argMap[jsonName] = ConfigProp(parentObj, field) + } + } + } + + private fun logAndExit(message: String) { + println(message) + exitProcess(0) + } + private fun logAndExit(argProp: ConfigProp?) { + if (argProp != null) { + println(argProp.get().toString()) + } else { + println() + } + exitProcess(0) + } + + /** + * Allows the ability to `get` or `set` configuration properties. Will call System.exit() if a get/set was done + */ + private fun manageGetAndSet(onSaveAction: () -> Unit) { + if ((arguments.isEmpty())) { + // nothing to do + return + } + + val args = arguments.map { it.lowercase(locale) } + val getIndex = args.indexOf("get") + val setIndex = args.indexOf("set") + + if (getIndex > -1) { + val propIndex = getIndex + 1 + if (propIndex > arguments.size - 1) { + logAndExit("Must specify property to get. For Example: 'get server.ip'") + } + + val propToQuery = arguments[propIndex] + val prop = configMap[propToQuery] + logAndExit(prop) + } else if (setIndex > -1) { + val propIndex = setIndex + 1 + if (propIndex > arguments.size - 1) { + logAndExit("Must specify property to set. For Example: 'set server.ip 127.0.0.1'") + } + + val valueIndex = setIndex + 2 + if (valueIndex > arguments.size - 1) { + logAndExit("Must specify property value to set. For Example: 'set server.ip 127.0.0.1'") + } + + val propToSet = arguments[propIndex] + val valueToSet = arguments[valueIndex] + + val prop = configMap[propToSet] + if (prop != null) { + // we output the OLD value, in case we want it from the CLI + val oldValue = prop.set(valueToSet) + + // we ALWAYS want to re-save this file back + onSaveAction() + + logAndExit(oldValue.toString()) + } else { + // prop wasn't found + logAndExit("") + } + } + + return + } + + /** + * Overloaded properties can be of the form + * For strings (and all other supported types) + * config.z="flag" (for a string) + * config.x="true" (for a boolean) + * + * Additional support for booleans + * config.x (absent any value is a 'true') + */ + @Suppress("UNCHECKED_CAST", "DuplicatedCode") + private fun manageOverloadProperties() { + configMap.forEach { (arg, prop) -> + val returnType = prop.member.returnType.jvmErasure + + if (prop.isSupported()) { + //// + // CLI CHECK IF PROPERTY EXIST (explicit check for arg=value) + // if arg is found, no more processing happens + //// + var foundArg = arguments.firstOrNull { it.startsWith("$arg=") } + if (foundArg != null) { + // we know that split[0] == 'arg=' because we already checked for that + val split = foundArg.split(regexEquals)[1].trim() + + // save this, so we can figure out what the values are on save (and not save overloaded properties, that are unchanged) + val get = prop.get() + if (get != split) { + // only track it if it's different + trackedConfigProperties[arg] = get + originalOverloadedProperties[arg] = split + prop.set(split) + } + + arguments.remove(arg) + return@forEach + } + + //// + // CLI CHECK IF PROPERTY EXIST (check if 'arg' exists, and is a boolean) + // if arg is found, no more processing happens + //// + if (returnType.isSubclassOf(Boolean::class)) { + // this is a boolean type? if present then we make it TRUE + foundArg = arguments.firstOrNull { it.startsWith(arg) } + if (foundArg != null) { + // save this, so we can figure out what the values are on save (and not save overloaded properties, that are unchanged) + val get = prop.get() + if (get != true) { + // only track it if it's different + trackedConfigProperties[arg] = get + originalOverloadedProperties[arg] = true + prop.set(true) + } + + arguments.remove(arg) + return@forEach + } + } + + + //// + // SYSTEM PROPERTY CHECK + //// + var sysProperty: String? = OS.getProperty(arg)?.trim() + + // try lowercase + if (sysProperty.isNullOrEmpty()) { + sysProperty = OS.getProperty(arg.lowercase(Locale.getDefault()))?.trim() + } + // try uppercase + if (sysProperty.isNullOrEmpty()) { + sysProperty = OS.getProperty(arg.uppercase(Locale.getDefault()))?.trim() + } + + if (!sysProperty.isNullOrEmpty()) { + val get = prop.get() + if (get != sysProperty) { + // only track it if it's different + trackedConfigProperties[arg] = get + originalOverloadedProperties[arg] = sysProperty + prop.set(sysProperty) + } + + return@forEach + } + + + //// + // ENVIRONMENT VARIABLE CHECK + //// + var envProperty = OS.getEnv(environmentVarPrefix + arg)?.trim() + + // try lowercase + if (envProperty.isNullOrEmpty()) { + envProperty = OS.getEnv(environmentVarPrefix + arg.lowercase(Locale.getDefault()))?.trim() + } + // try uppercase + if (envProperty.isNullOrEmpty()) { + envProperty = OS.getEnv(environmentVarPrefix + arg.uppercase(Locale.getDefault()))?.trim() + } + + if (!envProperty.isNullOrEmpty()) { + val get = prop.get() + if (get != envProperty) { + // only track it if it's different + trackedConfigProperties[arg] = get + originalOverloadedProperties[arg] = envProperty + prop.set(envProperty) + } + + return@forEach + } + } else { + logger.error("${prop.member.name} (${returnType.javaObjectType.simpleName}) overloading is not supported. Ignoring") + } + } + } +} diff --git a/src/dorkbox/config/ConfigProp.kt b/src/dorkbox/config/ConfigProp.kt new file mode 100644 index 0000000..28ef43e --- /dev/null +++ b/src/dorkbox/config/ConfigProp.kt @@ -0,0 +1,23 @@ +package dorkbox.config + +import kotlin.reflect.KMutableProperty +import kotlin.reflect.KProperty +import kotlin.reflect.jvm.jvmErasure + +data class ConfigProp(val parent: Any, val member: KProperty) { + fun isSupported(): Boolean { + return member is KMutableProperty<*> + } + + fun get(): Any { + return member.getter.call(parent) + } + + fun set(value: Any): Any { + require(member is KMutableProperty<*>) { "Cannot set the immutable type ${member.returnType.jvmErasure}" } + + val originalValue = get() + member.setter.call(parent, value) + return originalValue + } +} diff --git a/src/dorkbox/config/package-info.java b/src/dorkbox/config/package-info.java new file mode 100644 index 0000000..54c64e1 --- /dev/null +++ b/src/dorkbox/config/package-info.java @@ -0,0 +1,17 @@ +/* + * Copyright 2021 dorkbox, llc + * + * 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 + * + * 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. + */ + +package dorkbox.config; diff --git a/src9/dorkbox/config/EmptyClass.java b/src9/dorkbox/config/EmptyClass.java new file mode 100644 index 0000000..db4dbd7 --- /dev/null +++ b/src9/dorkbox/config/EmptyClass.java @@ -0,0 +1,24 @@ +/* + * Copyright 2021 dorkbox, llc + * + * 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 + * + * 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. + */ + +package dorkbox.config; + +/** + * Required for intellij to not complain regarding `module-info` for a multi-release jar. + * This file is completely ignored by the gradle build process + */ +public +class EmptyClass {} diff --git a/src9/module-info.java b/src9/module-info.java new file mode 100644 index 0000000..59b9889 --- /dev/null +++ b/src9/module-info.java @@ -0,0 +1,11 @@ +module dorkbox.config { + exports dorkbox.config; + + requires java.base; + requires moshi; + requires kotlin.stdlib; + requires dorkbox.updates; + requires kotlin.reflect; + requires dorkbox.os; + requires kotlin.logging.jvm; +}