From 259ed6d530260a55b8719b889121d9cd95352ae4 Mon Sep 17 00:00:00 2001 From: Robinson Date: Fri, 9 Apr 2021 13:23:55 +0200 Subject: [PATCH] Initial release --- .gitignore | 121 ++++++++++++++++++ LICENSE | 20 +++ LICENSE.Apachev2 | 218 +++++++++++++++++++++++++++++++++ build.gradle.kts | 142 +++++++++++++++++++++ settings.gradle.kts | 15 +++ src/dorkbox/updates/Updates.kt | 181 +++++++++++++++++++++++++++ 6 files changed, 697 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 LICENSE.Apachev2 create mode 100644 build.gradle.kts create mode 100644 settings.gradle.kts create mode 100644 src/dorkbox/updates/Updates.kt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..826f7b0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,121 @@ +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff: +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/dictionaries +.idea/**/codeStyles/ +.idea/**/codeStyleSettings.xml + +# Sensitive or high-churn files: +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.xml +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/shelf/ + + +# Gradle: +.idea/**/gradle.xml +.idea/**/libraries + +# CMake +cmake-build-debug/ + +# Mongo Explorer plugin: +.idea/**/mongoSettings.xml + +## File-based project format: +*.iws + +## Plugin-specific files: + + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +###################### +# End JetBrains IDEs # +###################### + + +# From https://github.com/github/gitignore/blob/master/Gradle.gitignore +.gradle +/build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar +!gradle-wrapper.properties + +# Cache of project +.gradletasknamecache + + + + +# From https://github.com/github/gitignore/blob/master/Java.gitignore +*.class + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* + +*.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + + + +########################################################## +# Specific to this module + +# iml files are generated by intellij/gradle now +**/*.iml diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4b0c24d --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ + - 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 + + - PropertyLoader - Property annotation and loader for fields + [The Apache Software License, Version 2.0] + https://git.dorkbox.com/dorkbox/PropertyLoader + Copyright 2021 + Dorkbox LLC 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/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..7d2e162 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,142 @@ +/* + * 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. + */ + +import dorkbox.gradle.kotlin +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! +gradle.startParameter.warningMode = WarningMode.All + +plugins { + java + + id("com.dorkbox.GradleUtils") version "1.17" + id("com.dorkbox.Licensing") version "2.5.5" + id("com.dorkbox.VersionUpdate") version "2.3" + id("com.dorkbox.GradlePublish") version "1.10" + + kotlin("jvm") version "1.4.32" +} + +object Extras { + // set for the project + const val description = "Software Update Management" + const val group = "com.dorkbox" + const val version = "1.0" + + // set as project.ext + const val name = "Updates" + const val id = "Updates" + const val vendor = "Dorkbox LLC" + const val vendorUrl = "https://dorkbox.com" + const val url = "https://git.dorkbox.com/dorkbox/Updates" + + val buildDate = Instant.now().toString() +} + +/////////////////////////////// +///// assign 'Extras' +/////////////////////////////// +GradleUtils.load("$projectDir/../../gradle.properties", Extras) +GradleUtils.fixIntellijPaths() +GradleUtils.defaultResolutionStrategy() +GradleUtils.compileConfiguration(JavaVersion.VERSION_1_8) + +licensing { + license(License.APACHE_2) { + description(Extras.description) + author(Extras.vendor) + url(Extras.url) + } +} + +sourceSets { + main { + kotlin { + setSrcDirs(listOf("src")) + + // want to add files for the source. 'setSrcDirs' resets includes... + include("**/*.kt") + } + } + + test { + kotlin { + setSrcDirs(listOf("test")) + + // want to add files for the source. 'setSrcDirs' resets includes... + include("**/*.kt") + } + } +} + +repositories { + mavenLocal() // this must be first! + jcenter() +} + +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 + + attributes["Automatic-Module-Name"] = Extras.id + } +} + +dependencies { + // MINIMAL DEPENDENCIES! + implementation("com.dorkbox:PropertyLoader:1.0") +} + + +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/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..ec55c25 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,15 @@ +/* + * 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. + */ diff --git a/src/dorkbox/updates/Updates.kt b/src/dorkbox/updates/Updates.kt new file mode 100644 index 0000000..aae217c --- /dev/null +++ b/src/dorkbox/updates/Updates.kt @@ -0,0 +1,181 @@ +package dorkbox.updates + +import dorkbox.propertyLoader.Property +import java.io.DataOutputStream +import java.net.HttpURLConnection +import java.net.URL +import java.net.URLDecoder +import java.util.* +import java.util.concurrent.TimeUnit +import kotlin.concurrent.fixedRateTimer + + +object Updates { + data class UpdateInfo(val uuid: String, val data: String) { + override fun toString(): String { + return "$uuid:$data" + } + } + + /** + * Enables the use of the update system, which verifies this class + UUID + data information with the update server. + */ + @Property + @Volatile + var ENABLE = true + + private var SERVER = "updates.dorkbox.com" + + private val instanceUuid = UUID.randomUUID().toString().replace("-", "") + + // create a map of all UUIDs. and only run an update once all have been collected. + // This runs max 1x every 4 hours (5 minutes after startup) - and only a SINGLE request is made for all checked UUIDs. + private val updates = mutableMapOf, MutableList>() + + init { + fixedRateTimer("update-system", true, TimeUnit.MINUTES.toMillis(5), TimeUnit.HOURS.toMillis(4)) { + if (ENABLE) { + runAtTimedInterval() + } + } + } + + private fun runAtTimedInterval() { + // convert the hashmap into something serialized. This is super, super simple and not optimized. Again, no dependencies! + val buffer = StringBuilder() + buffer.append(instanceUuid) + + synchronized(updates) { + val entries = updates.entries + if (entries.size > 0) { + buffer.append(':') + } + + entries.forEachIndexed { i, (key, value) -> + buffer.append(key.name) // classNameOnly + buffer.append('[') + value.forEachIndexed { j, it -> + buffer.append(it) + if (j < value.size - 1) { + buffer.append(',') + } + } + buffer.append(']') + + if (i < entries.size - 1) { + buffer.append(':') + } + } + } + + val sendData = buffer.toString().toByteArray() + + // default is http! This way we don't have to deal with crypto, and since there is nothing PRIVATE about the connection, + // this is fine - at least for now. We DO want to support redirects, in case OLD code is running in the wild. + var location = "http://$SERVER/" + + var base: URL + var next: URL + val visited = mutableMapOf() + var visitedCount: Int + + + while (true) { + visitedCount = (visited[location] ?: 0) + 1 + visited[location] = visitedCount + + if (visitedCount > 3) { +// println("Stuck in a loop") + return + } + + try { + base = URL(location) + with(base.openConnection() as HttpURLConnection) { + requestMethod = "POST" + doOutput = true + useCaches = false + instanceFollowRedirects = true + setRequestProperty("User-Agent", "Dorkbox-Updates") + setRequestProperty("Content-Type", "application/x-www-form-urlencoded") + setRequestProperty("charset", "utf-8") + setRequestProperty("Content-Length", sendData.size.toString()) + + // must write data to the server (the server might not even read this, especially if there is no connection) + DataOutputStream(outputStream).use { + it.write(sendData) + } + +// println("URL : $url") +// println("Response Code : $responseCode") + + when (responseCode) { + HttpURLConnection.HTTP_MOVED_PERM, HttpURLConnection.HTTP_MOVED_TEMP -> { + location = getHeaderField("Location") + location = URLDecoder.decode(location, "UTF-8") + +// println("Response redirect to: $location") + + next = URL(base, location) // Deal with relative URLs + location = next.toExternalForm() + return@with + } + HttpURLConnection.HTTP_OK -> { +// InputStreamReader(inputStream).useLines { +// it.forEach { +// println("Response : $it") +// } +// } + + // done + return + } + else -> { +// println("Response error: $location") + // done + return + } + } + } + } catch (e: Exception) { +// e.printStackTrace() + } + } + } + + + + /** + * Verifies this class + UUID + version information with the update server. + * + * + * Only the class + UUID + version information is tracked, saved, and used by dorkbox, llc. Nothing else. + * + * Specifically, IP address/machine info/time/http headers/user info/names/etc is not used, saved, or tracked. + * + * In accordance with the GDPR, there is absolutely NO DATA specific to the machine, connection, or user that is saved, read or used. + * + * While this is trivial to override/modify/replace to do absolutely nothing, the purpose of this is to manage the update info + * and usage across all projects and systems owned by dorkbox, llc. + * + * @param class the class that is to be registered + * @param uuid the uuid assigned to the class + * @param data any extra data specific to the class + */ + fun add(`class`: Class<*>, uuid: String, data: String) { + val updateInfo = UpdateInfo(uuid, data) + + synchronized(updates) { + var mutableList = updates[`class`] + + if (mutableList == null) { + mutableList = mutableListOf() + updates[`class`] = mutableList + } + + if (!mutableList.contains(updateInfo)) { + mutableList.add(updateInfo) + } + } + } +}