From 8b3e0f83aed9d34964919d7bffe15b6d158d2b00 Mon Sep 17 00:00:00 2001 From: Torsten Grote Date: Wed, 27 Apr 2022 10:25:01 -0300 Subject: [PATCH] Publish download library to maven central and add a different license for it. --- README.md | 8 ++ build.gradle | 1 + download/LICENSE | 202 +++++++++++++++++++++++++++++++ download/README.md | 15 +++ download/build.gradle | 6 + download/gradle.properties | 7 ++ gradle.properties | 18 +++ gradle/verification-metadata.xml | 67 +++++++++- 8 files changed, 323 insertions(+), 1 deletion(-) create mode 100644 download/LICENSE create mode 100644 download/gradle.properties diff --git a/README.md b/README.md index 4eb6b4317..3fda4aeaa 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,13 @@ for Android. You can [download the application](https://f-droid.org/FDroid.apk) directly from our site or [browse it in the repo](https://f-droid.org/app/org.fdroid.fdroid). +## Libraries + +Core F-Droid functionality is split into re-usable libraries +to make using F-Droid technology in your own projects as easy as possible. + +* [download](download) library for handling (multi-platform) HTTP download of repository indexes and APKs + ## Contributing See our [Contributing doc](CONTRIBUTING.md) for information on how to report @@ -39,6 +46,7 @@ to what Google Play does. This used to be the case, but no longer is. Now the [Privileged Extension](https://gitlab.com/fdroid/privileged-extension) is the one that should be placed in the system. It can be bundled with a ROM or installed via a zip. + ## License This program is Free Software: You can use, study share and improve it at your diff --git a/build.gradle b/build.gradle index 2d3162e3b..94d7c3ca7 100644 --- a/build.gradle +++ b/build.gradle @@ -6,6 +6,7 @@ buildscript { dependencies { classpath 'com.android.tools.build:gradle:3.6.3' classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.6.20" + classpath 'com.vanniktech:gradle-maven-publish-plugin:0.18.0' } } allprojects { diff --git a/download/LICENSE b/download/LICENSE new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/download/LICENSE @@ -0,0 +1,202 @@ + + 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. + + "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. diff --git a/download/README.md b/download/README.md index a447727db..5d9e5d8b9 100644 --- a/download/README.md +++ b/download/README.md @@ -7,3 +7,18 @@ Note that advanced security and privacy features are only available for Android: * short TLS session timeout to prevent tracking and key re-use Other platforms besides Android have not been tested and might need additional work. + +## How to include in your project + +Add this to your `build.gradle` file +and replace `[version]` with the [latest version](gradle.properties): + + implementation 'org.fdroid:download:[version]' + +## License + +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 diff --git a/download/build.gradle b/download/build.gradle index a15234844..cfa7edde8 100644 --- a/download/build.gradle +++ b/download/build.gradle @@ -2,6 +2,7 @@ plugins { id 'org.jetbrains.kotlin.multiplatform' id 'com.android.library' id "org.jlleitschuh.gradle.ktlint" version "10.2.1" + id 'com.vanniktech.maven.publish' } group = 'org.fdroid' @@ -12,6 +13,7 @@ kotlin { compilations.all { kotlinOptions.jvmTarget = '1.8' } + publishLibraryVariants("release") } // def hostOs = System.getProperty("os.name") // def isMingwX64 = hostOs.startsWith("Windows") @@ -109,4 +111,8 @@ android { } } +signing { + useGpgCmd() +} + apply from: "${rootProject.rootDir}/gradle/ktlint.gradle" diff --git a/download/gradle.properties b/download/gradle.properties new file mode 100644 index 000000000..e0f0103f8 --- /dev/null +++ b/download/gradle.properties @@ -0,0 +1,7 @@ +POM_ARTIFACT_ID=download +VERSION_NAME=0.1.0 + +POM_NAME=F-Droid download library +POM_DESCRIPTION=A Kotlin multi-platform library to download F-Droid related files via HTTP. +POM_INCEPTION_YEAR=2022 +POM_URL=https://gitlab.com/fdroid/fdroidclient/-/tree/master/download diff --git a/gradle.properties b/gradle.properties index baf7a83fc..19188ec49 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,3 +6,21 @@ kotlin.code.style=official kotlin.mpp.stability.nowarn=true kotlin.mpp.enableGranularSourceSetsMetadata=true kotlin.native.enableDependencyPropagation=false + +# Gradle Maven Publish Info below (https://github.com/vanniktech/gradle-maven-publish-plugin) +# These are common for all libraries in gradle submodules. +# Specifics for each library are defined in the submodule's gradle.properties file. + +GROUP=org.fdroid + +POM_LICENSE_NAME=Apache-2.0 +POM_LICENSE_URL=http://www.apache.org/licenses/LICENSE-2.0 +POM_LICENSE_DIST=repo + +POM_SCM_URL=https://gitlab.com/fdroid/fdroidclient/ +POM_SCM_CONNECTION=scm:git:git://gitlab.com:fdroid/fdroidclient.git +POM_SCM_DEV_CONNECTION=scm:git:ssh://git@gitlab.com:fdroid/fdroidclient.git + +POM_DEVELOPER_ID=grote +POM_DEVELOPER_NAME=Torsten Grote +POM_DEVELOPER_URL=https://github.com/grote/ diff --git a/gradle/verification-metadata.xml b/gradle/verification-metadata.xml index 78f51aac7..002ce0887 100644 --- a/gradle/verification-metadata.xml +++ b/gradle/verification-metadata.xml @@ -2,7 +2,7 @@ false - true + false @@ -2070,6 +2070,21 @@ + + + + + + + + + + + + + + + @@ -2080,6 +2095,11 @@ + + + + + @@ -2095,6 +2115,16 @@ + + + + + + + + + + @@ -2156,6 +2186,11 @@ + + + + + @@ -4070,11 +4105,21 @@ + + + + + + + + + + @@ -4090,11 +4135,21 @@ + + + + + + + + + + @@ -4115,6 +4170,11 @@ + + + + + @@ -4140,6 +4200,11 @@ + + + + +