From 75b568f74ac9971b2b93f327789f41713d45ce1c Mon Sep 17 00:00:00 2001 From: Aref Date: Sat, 6 Oct 2018 15:08:19 +0330 Subject: [PATCH] Initial Commit --- LICENSE | 202 ++++++++++++++++++ README.md | 164 ++++++++++++++ lib/build.gradle | 5 +- lib/src/main/AndroidManifest.xml | 2 +- .../{PRDownloader.java => EPRDownloader.java} | 20 +- ...erConfig.java => EPRDownloaderConfig.java} | 8 +- .../internal/ComponentHolder.java | 8 +- 7 files changed, 387 insertions(+), 22 deletions(-) create mode 100644 LICENSE create mode 100644 README.md rename lib/src/main/java/com/arefbhrn/eprdownloader/{PRDownloader.java => EPRDownloader.java} (89%) rename lib/src/main/java/com/arefbhrn/eprdownloader/{PRDownloaderConfig.java => EPRDownloaderConfig.java} (94%) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7a4a3ea --- /dev/null +++ b/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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..8123a5f --- /dev/null +++ b/README.md @@ -0,0 +1,164 @@ +# EPRDownloader +### An extension of ["PRDownloader" by "Mindorks"](https://github.com/MindorksOpenSource/PRDownloader) having a DownloaderQueue to control downloads properly +### A file downloader library for Android with pause and resume support +# +[![](https://jitpack.io/v/arefbhrn/EPRDownloader.svg)](https://jitpack.io/#arefbhrn/EPRDownloader) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) + +## Demo + + +### Overview of EPRDownloader library +* EPRDownloader can be used to download any type of files like image, video, pdf, apk and etc. +* Supports pause and resume while downloading a file. +* Supports large file download. +* Simple interface to make download request. +* We can check if the status of downloading with the given download Id. +* EPRDownloader gives callbacks for everything like onProgress, onCancel, onStart, onError and etc while downloading a file. (Resetable anytime) +* Supports proper request canceling. +* Many requests can be made in parallel. +* All types of customization are possible. +* -> Has a Request Queue to handle download requests properly. + +## Using EPRDownloader Library in your Android application + +Add this in your build.gradle +```groovy +implementation 'com.github.arefbhrn:EPRDownloader:1.0.0' +``` +Do not forget to add internet permission in manifest if already not present +```xml + +``` +Then initialize it in onCreate() Method of application class : +```java +EPRDownloader.initialize(getApplicationContext()); +``` +Initializing it with some customization +```java +// Enabling database for resume support even after the application is killed: +EPRDownloaderConfig config = EPRDownloaderConfig.newBuilder() + .setDatabaseEnabled(true) + .build(); +EPRDownloader.initialize(getApplicationContext(), config); + +// Setting timeout globally for the download network requests: +EPRDownloaderConfig config = EPRDownloaderConfig.newBuilder() + .setReadTimeout(30_000) + .setConnectTimeout(30_000) + .build(); +EPRDownloader.initialize(getApplicationContext(), config); +``` + +### Make a download request +```java +DownloadRequest download = EPRDownloader.download("", "/", "").build() + .setOnStartOrResumeListener(new OnStartOrResumeListener() { + @Override + public void onStartOrResume() { + + } + }) + .setOnPauseListener(new OnPauseListener() { + @Override + public void onPause() { + + } + }) + .setOnCancelListener(new OnCancelListener() { + @Override + public void onCancel() { + + } + }) + .setOnProgressListener(new OnProgressListener() { + @Override + public void onProgress(Progress progress) { + + } + }) + .setOnDownloadListener(new OnDownloadListener() { + @Override + public void onDownloadComplete() { + + } + + @Override + public void onError(Error error) { + + } + }); +download.start(); +``` + +### Pause a download request +```java +EPRDownloader.pause(downloadId); +``` + +### Resume a download request +```java +EPRDownloader.resume(downloadId); +``` + +### Cancel a download request +```java +// Cancel with the download id +EPRDownloader.cancel(downloadId); +// The tag can be set to any request and then can be used to cancel the request +EPRDownloader.cancel(TAG); +// Cancel all the requests +EPRDownloader.cancelAll(); +``` + +### Generate ID of a download request +```java +int downloadId = Utils.getUniqueId(url, folderName + "/", fileName); +``` +Or if download object is already defined: +```java +int downloadId = download.getDownloadId(); +``` + +### Status of a download request +```java +Status status = EPRDownloader.getStatus(downloadId); +``` + +### Clean up resumed files if database enabled +```java +// Method to clean up temporary resumed files which is older than the given day +EPRDownloader.cleanUp(days); +``` + +Using DownloaderQueue += +```java +DownloaderQueue.setRunningLimit(3); // set maximum number of concurrent downloads +int downloadId = Utils.getUniqueId(url, folderName + "/", fileName); +DownloadRequest download = DownloaderQueue.get(downloadId); +``` +Other downloads in this FIFO queue will wait until they can meet conditions to start. + +### Add to DownloaderQueue +```java +DownloaderQueue.add(download); +``` + +### Get download from DownloaderQueue (not remove it) +```java +download = DownloaderQueue.get(downloadId); +``` + +### Remove download from DownloaderQueue +```java +DownloaderQueue.remove(downloadId); +``` + +## +### If this library helps you in anyway, show your love :heart: by putting a :star: on this project :v: +## + +License += +This project is licensed under the Apache 2.0 License - see the [LICENSE.md](LICENSE.md) file for details \ No newline at end of file diff --git a/lib/build.gradle b/lib/build.gradle index b3fb966..0da76ff 100644 --- a/lib/build.gradle +++ b/lib/build.gradle @@ -26,7 +26,6 @@ dependencies { testImplementation 'junit:junit:4.12' androidTestImplementation 'com.android.support.test:runner:1.0.2' androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2' - implementation 'com.mindorks.android:prdownloader:0.4.0' } install { @@ -44,8 +43,8 @@ install { licenses { license { - name 'The MIT License (MIT)' - url 'https://opensource.org/licenses/MIT' + name 'The Apache License 2.0' + url 'https://opensource.org/licenses/Apache-2.0' } } scm { diff --git a/lib/src/main/AndroidManifest.xml b/lib/src/main/AndroidManifest.xml index a24d4a5..7331fa0 100644 --- a/lib/src/main/AndroidManifest.xml +++ b/lib/src/main/AndroidManifest.xml @@ -1,5 +1,5 @@ diff --git a/lib/src/main/java/com/arefbhrn/eprdownloader/PRDownloader.java b/lib/src/main/java/com/arefbhrn/eprdownloader/EPRDownloader.java similarity index 89% rename from lib/src/main/java/com/arefbhrn/eprdownloader/PRDownloader.java rename to lib/src/main/java/com/arefbhrn/eprdownloader/EPRDownloader.java index 56f6e7b..15e1dc3 100644 --- a/lib/src/main/java/com/arefbhrn/eprdownloader/PRDownloader.java +++ b/lib/src/main/java/com/arefbhrn/eprdownloader/EPRDownloader.java @@ -29,34 +29,34 @@ import com.arefbhrn.eprdownloader.utils.Utils; /** - * PRDownloader entry point. + * EPRDownloader entry point. * You must initialize this class before use. The simplest way is to just do - * {#code PRDownloader.initialize(context)}. + * {#code EPRDownloader.initialize(context)}. */ -public class PRDownloader { +public class EPRDownloader { /** * private constructor to prevent instantiation of this class */ - private PRDownloader() { + private EPRDownloader() { } /** - * Initializes PRDownloader with the default config. + * Initializes EPRDownloader with the default config. * * @param context The context */ public static void initialize(Context context) { - initialize(context, PRDownloaderConfig.newBuilder().build()); + initialize(context, EPRDownloaderConfig.newBuilder().build()); } /** - * Initializes PRDownloader with the custom config. + * Initializes EPRDownloader with the custom config. * * @param context The context - * @param config The PRDownloaderConfig + * @param config The EPRDownloaderConfig */ - public static void initialize(Context context, PRDownloaderConfig config) { + public static void initialize(Context context, EPRDownloaderConfig config) { ComponentHolder.getInstance().init(context, config); DownloadRequestQueue.initialize(); } @@ -136,7 +136,7 @@ public static void cleanUp(int days) { } /** - * Shuts PRDownloader down + * Shuts EPRDownloader down */ public static void shutDown() { Core.shutDown(); diff --git a/lib/src/main/java/com/arefbhrn/eprdownloader/PRDownloaderConfig.java b/lib/src/main/java/com/arefbhrn/eprdownloader/EPRDownloaderConfig.java similarity index 94% rename from lib/src/main/java/com/arefbhrn/eprdownloader/PRDownloaderConfig.java rename to lib/src/main/java/com/arefbhrn/eprdownloader/EPRDownloaderConfig.java index 9c5a0df..262da25 100644 --- a/lib/src/main/java/com/arefbhrn/eprdownloader/PRDownloaderConfig.java +++ b/lib/src/main/java/com/arefbhrn/eprdownloader/EPRDownloaderConfig.java @@ -23,7 +23,7 @@ * Created by amitshekhar on 13/11/17. */ -public class PRDownloaderConfig { +public class EPRDownloaderConfig { private int readTimeout; private int connectTimeout; @@ -31,7 +31,7 @@ public class PRDownloaderConfig { private HttpClient httpClient; private boolean databaseEnabled; - private PRDownloaderConfig(Builder builder) { + private EPRDownloaderConfig(Builder builder) { this.readTimeout = builder.readTimeout; this.connectTimeout = builder.connectTimeout; this.userAgent = builder.userAgent; @@ -116,8 +116,8 @@ public Builder setDatabaseEnabled(boolean databaseEnabled) { return this; } - public PRDownloaderConfig build() { - return new PRDownloaderConfig(this); + public EPRDownloaderConfig build() { + return new EPRDownloaderConfig(this); } } } diff --git a/lib/src/main/java/com/arefbhrn/eprdownloader/internal/ComponentHolder.java b/lib/src/main/java/com/arefbhrn/eprdownloader/internal/ComponentHolder.java index 4f8a7b6..538c538 100644 --- a/lib/src/main/java/com/arefbhrn/eprdownloader/internal/ComponentHolder.java +++ b/lib/src/main/java/com/arefbhrn/eprdownloader/internal/ComponentHolder.java @@ -19,8 +19,8 @@ import android.content.Context; import com.arefbhrn.eprdownloader.Constants; -import com.arefbhrn.eprdownloader.PRDownloader; -import com.arefbhrn.eprdownloader.PRDownloaderConfig; +import com.arefbhrn.eprdownloader.EPRDownloader; +import com.arefbhrn.eprdownloader.EPRDownloaderConfig; import com.arefbhrn.eprdownloader.database.AppDbHelper; import com.arefbhrn.eprdownloader.database.DbHelper; import com.arefbhrn.eprdownloader.database.NoOpsDbHelper; @@ -44,14 +44,14 @@ public static ComponentHolder getInstance() { return INSTANCE; } - public void init(Context context, PRDownloaderConfig config) { + public void init(Context context, EPRDownloaderConfig config) { this.readTimeout = config.getReadTimeout(); this.connectTimeout = config.getConnectTimeout(); this.userAgent = config.getUserAgent(); this.httpClient = config.getHttpClient(); this.dbHelper = config.isDatabaseEnabled() ? new AppDbHelper(context) : new NoOpsDbHelper(); if (config.isDatabaseEnabled()) { - PRDownloader.cleanUp(30); + EPRDownloader.cleanUp(30); } }