Can now use your own unique id for a request.

Version 2.0.0-RC8
- Can now use your own unique id for a request.
- Added new methods removeAllWithStatus(status: Status) and fun deleteAllWithStatus(status: Status)
- RxJava library update

Author: tonyofrancis

CHANGELOG

@@ -1,3 +1,8 @@
+Version 2.0.0-RC8
+- Can now use your own unique id for a request.
+- Added new methods removeAllWithStatus(status: Status) and fun deleteAllWithStatus(status: Status)
+- RxJava library update
+
 Version 2.0.0-RC7
 - Kotlin update.
 - Fixed download priority issue.

README.md

@@ -1,5 +1,5 @@
 [![Build Status](https://travis-ci.org/tonyofrancis/Fetch.svg?branch=v2)](https://travis-ci.org/tonyofrancis/Fetch)
-[ ![Download](https://api.bintray.com/packages/tonyofrancis/maven/fetch2/images/download.svg?version=2.0.0-RC7) ](https://bintray.com/tonyofrancis/maven/fetch2/2.0.0-RC7/link)
+[ ![Download](https://api.bintray.com/packages/tonyofrancis/maven/fetch2/images/download.svg?version=2.0.0-RC8) ](https://bintray.com/tonyofrancis/maven/fetch2/2.0.0-RC8/link)
 [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Android%20Networking-blue.svg?style=flat)](https://android-arsenal.com/details/1/5196)
 [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/tonyofrancis/Fetch/blob/master/LICENSE)
 
@@ -44,7 +44,7 @@ How to use Fetch
 Using Fetch is easy! Just add the Gradle dependency to your application's build.gradle file.
 
 ```java
-implementation "com.tonyodev.fetch2:fetch2:2.0.0-RC7"
+implementation "com.tonyodev.fetch2:fetch2:2.0.0-RC8"
 ```
 
 Next, get an instance of Fetch using the builder, and request a download.
@@ -239,7 +239,7 @@ to use the OkHttp Downloader instead. You can create your own custom downloaders
 if necessary. See the Java docs for details.
 
 ```java
-implementation "com.tonyodev.fetch2downloaders:fetch2downloaders:2.0.0-RC7"
+implementation "com.tonyodev.fetch2downloaders:fetch2downloaders:2.0.0-RC8"
 ```
 Set the OkHttp Downloader for Fetch to use.
 ```java
@@ -260,7 +260,7 @@ If you would like to take advantage of RxJava2 features when using Fetch,
 add the following gradle dependency to your application's build.gradle file.
 
 ```java
-implementation "com.tonyodev.fetch2rx:fetch2rx:2.0.0-RC7"
+implementation "com.tonyodev.fetch2rx:fetch2rx:2.0.0-RC8"
 ```
 
 RxFetch makes it super easy to enqueue download requests and query downloads using rxJava2 functional methods.
@@ -292,7 +292,7 @@ Fetch1 Migration
 
 Migrate downloads from Fetch1 to Fetch2 using the migration assistant. Add the following gradle dependency to your application's build.gradle file.
 ```java
-implementation "com.tonyodev.fetchmigrator:fetchmigrator:2.0.0-RC7"
+implementation "com.tonyodev.fetchmigrator:fetchmigrator:2.0.0-RC8"
 ```
 
 Then run the Migrator.

fetch2/src/main/java/com/tonyodev/fetch2/Error.kt

@@ -53,7 +53,17 @@ enum class Error constructor(val value: Int) {
      * This error is thrown by the FetchBuilder.
      * @see com.tonyodev.fetch2.Fetch.Builder
      * */
-    FETCH_ALREADY_EXIST(12);
+    FETCH_ALREADY_EXIST(12),
+
+    /** Indicates that a request in the Fetch database already has this unique id.
+     * Ids must be unique.*/
+    REQUEST_WITH_ID_ALREADY_EXIST(13),
+
+    /** Indicates that a request in the Fetch database already has this file path. File Paths
+     * have to be unique for each request. This limitation maintains consistency and prevents data lose.
+     * Fetch cannot write data to two different downloads with the same file path.
+     * */
+    REQUEST_WITH_FILE_PATH_ALREADY_EXIST(14);
 
     companion object {
 
@@ -74,6 +84,8 @@ enum class Error constructor(val value: Int) {
                 10 -> DOWNLOAD_NOT_FOUND
                 11 -> FETCH_DATABASE_ERROR
                 12 -> FETCH_ALREADY_EXIST
+                13 -> REQUEST_WITH_ID_ALREADY_EXIST
+                14 -> REQUEST_WITH_FILE_PATH_ALREADY_EXIST
                 else -> UNKNOWN
             }
         }

fetch2/src/main/java/com/tonyodev/fetch2/Fetch.kt

@@ -117,6 +117,14 @@ interface Fetch {
      * */
     fun removeAll()
 
+    /**
+     * Remove all downloads with the specified status in this instance of Fetch.
+     * The downloaded files for removed downloads are not deleted.
+     * @param status status
+     * @throws FetchException if this instance of Fetch has been closed.
+     * */
+    fun removeAllWithStatus(status: Status)
+
     /**
      * Delete a download managed by this instance of Fetch.
      * The downloaded file is deleted.
@@ -140,6 +148,14 @@ interface Fetch {
      * */
     fun deleteAll()
 
+    /**
+     * Deletes all downloads with the specified status in this instance of Fetch.
+     * The downloaded files are also deleted.
+     * @param status status
+     * @throws FetchException if this instance of Fetch has been closed.
+     * */
+    fun deleteAllWithStatus(status: Status)
+
     /**
      * Cancel a non completed download managed by this instance of Fetch.
      * The downloaded file for the cancelled download is not deleted.

fetch2/src/main/java/com/tonyodev/fetch2/FetchErrorUtils.kt

@@ -11,6 +11,10 @@ fun getErrorFromThrowable(throwable: Throwable): Error {
 fun getErrorFromMessage(message: String?): Error {
     return if (message == null) {
         Error.UNKNOWN
+    } else if (message.contains(UNIQUE_ID_DATABASE)) {
+        Error.REQUEST_WITH_ID_ALREADY_EXIST
+    } else if (message.contains(UNIQUE_FILE_PATH_DATABASE)) {
+        Error.REQUEST_WITH_FILE_PATH_ALREADY_EXIST
     } else if (message.equals(EMPTY_RESPONSE_BODY, true)) {
         Error.EMPTY_RESPONSE_FROM_SERVER
     } else if (message.equals(FNC, ignoreCase = true) || message.equals(ENOENT, ignoreCase = true)) {

fetch2/src/main/java/com/tonyodev/fetch2/Request.kt

@@ -5,15 +5,23 @@ package com.tonyodev.fetch2
  * begin the download process.
  * */
 open class Request constructor(
+        /** Used to identify a download. Must be UNIQUE.*/
+        val id: Int,
+
         /** The url where the file will be downloaded from.*/
         val url: String,
 
         /** The file eg(/files/download.txt) where the file will be
          * downloaded to and saved on disk.*/
         val file: String) : RequestInfo() {
 
-    /** Used to identify a download.*/
-    val id: Int = (url.hashCode() * 31) + file.hashCode()
+    constructor(
+            /** The url where the file will be downloaded from.*/
+            url: String,
+
+            /** The file eg(/files/download.txt) where the file will be
+             * downloaded to and saved on disk.*/
+            file: String) : this((url.hashCode() * 31) + file.hashCode(), url, file)
 
     override fun equals(other: Any?): Boolean {
         if (this === other) return true

fetch2/src/main/java/com/tonyodev/fetch2/fetch/FetchHandler.kt

@@ -24,9 +24,11 @@ interface FetchHandler : Closeable {
     fun remove(ids: IntArray): List<Download>
     fun removeGroup(id: Int): List<Download>
     fun removeAll(): List<Download>
+    fun removeAllWithStatus(status: Status): List<Download>
     fun delete(ids: IntArray): List<Download>
     fun deleteGroup(id: Int): List<Download>
     fun deleteAll(): List<Download>
+    fun deleteAllWithStatus(status: Status): List<Download>
     fun cancel(ids: IntArray): List<Download>
     fun cancelGroup(id: Int): List<Download>
     fun cancelAll(): List<Download>

fetch2/src/main/java/com/tonyodev/fetch2/fetch/FetchHandlerImpl.kt

@@ -202,6 +202,22 @@ open class FetchHandlerImpl(val namespace: String,
         return downloadInfoList
     }
 
+    override fun removeAllWithStatus(status: Status): List<Download> {
+        throwExceptionIfClosed()
+        val downloadInfoList = databaseManager.getByStatus(status)
+        downloadInfoList.forEach {
+            if (isDownloading(it.id)) {
+                cancelDownload(it.id)
+            }
+        }
+        databaseManager.delete(downloadInfoList)
+        val removedStatus = Status.REMOVED
+        downloadInfoList.forEach {
+            it.status = removedStatus
+        }
+        return downloadInfoList
+    }
+
     override fun delete(ids: IntArray): List<Download> {
         throwExceptionIfClosed()
         ids.forEach {
@@ -270,6 +286,30 @@ open class FetchHandlerImpl(val namespace: String,
         return downloadInfoList
     }
 
+    override fun deleteAllWithStatus(status: Status): List<Download> {
+        throwExceptionIfClosed()
+        val downloadInfoList = databaseManager.getByStatus(status)
+        downloadInfoList.forEach {
+            if (isDownloading(it.id)) {
+                cancelDownload(it.id)
+            }
+        }
+        databaseManager.delete(downloadInfoList)
+        val deletedStatus = Status.DELETED
+        downloadInfoList.forEach {
+            it.status = deletedStatus
+            try {
+                val file = File(it.file)
+                if (file.exists()) {
+                    file.delete()
+                }
+            } catch (e: Exception) {
+                logger.d("Failed to delete file ${it.file}", e)
+            }
+        }
+        return downloadInfoList
+    }
+
     override fun cancel(ids: IntArray): List<Download> {
         throwExceptionIfClosed()
         ids.forEach {

fetch2/src/main/java/com/tonyodev/fetch2/fetch/FetchImpl.kt

@@ -244,6 +244,25 @@ open class FetchImpl constructor(override val namespace: String,
         }
     }
 
+    override fun removeAllWithStatus(status: Status) {
+        synchronized(lock) {
+            fetchHandler.throwExceptionIfClosed()
+            handler.post {
+                try {
+                    val downloads = fetchHandler.removeAllWithStatus(status)
+                    uiHandler.post {
+                        downloads.forEach {
+                            logger.d("Removed download $it")
+                            fetchListenerProvider.mainListener.onRemoved(it)
+                        }
+                    }
+                } catch (e: FetchException) {
+                    logger.e("Fetch with namespace $namespace error", e)
+                }
+            }
+        }
+    }
+
     override fun delete(vararg ids: Int) {
         synchronized(lock) {
             fetchHandler.throwExceptionIfClosed()
@@ -301,6 +320,25 @@ open class FetchImpl constructor(override val namespace: String,
         }
     }
 
+    override fun deleteAllWithStatus(status: Status) {
+        synchronized(lock) {
+            fetchHandler.throwExceptionIfClosed()
+            handler.post {
+                try {
+                    val downloads = fetchHandler.deleteAllWithStatus(status)
+                    uiHandler.post {
+                        downloads.forEach {
+                            logger.d("Deleted download $it")
+                            fetchListenerProvider.mainListener.onDeleted(it)
+                        }
+                    }
+                } catch (e: FetchException) {
+                    logger.e("Fetch with namespace $namespace error", e)
+                }
+            }
+        }
+    }
+
     override fun cancel(vararg ids: Int) {
         synchronized(lock) {
             fetchHandler.throwExceptionIfClosed()

fetch2/src/main/java/com/tonyodev/fetch2/util/ErrorStrings.kt

@@ -19,4 +19,6 @@ const val ENOSPC = "write failed: ENOSPC (No space left on device)"
 const val DATABASE_DISK_FULL = "database or disk is full (code 13)"
 const val FETCH_DATABASE_ERROR = "Fetch data base error"
 const val FETCH_ALREADY_EXIST = "already exists. You cannot have more than one active " +
-        "instance of Fetch with the same namespace. Did your forget to call close the old instance?"
+        "instance of Fetch with the same namespace. Did your forget to call close the old instance?"
+const val UNIQUE_ID_DATABASE = "UNIQUE constraint failed: requests._id"
+const val UNIQUE_FILE_PATH_DATABASE = "UNIQUE constraint failed: requests._file"

versions.gradle

@@ -12,10 +12,10 @@ ext {
     library_target_version = 27
     library_build_tools_version = "27.0.3"
     gradle_tools_version = "3.0.1"
-    rxJava2_version = "2.1.8"
+    rxJava2_version = "2.1.9"
     rxAndroid2_version = "2.0.1"
     timber_version = "4.6.0"
     novoda_bintray_version = "0.8.0"
-    library_version = "2.0.0-RC7"
-    library_version_code = 8
+    library_version = "2.0.0-RC8"
+    library_version_code = 9
 }