#408 Android: Add a wifi only flag to the downloader (#754)

lyio · web-flow · commit 29d0dc810ad0 · 2022-11-22T17:33:07.000+01:00
- Add `allowCellular` flag to Dart and default 
- Add flag to Android code and pass it to the `WorkManager`
- Migrate the database on Android
diff --git a/android/src/main/kotlin/vn/hunghd/flutterdownloader/DownloadTask.kt b/android/src/main/kotlin/vn/hunghd/flutterdownloader/DownloadTask.kt
@@ -14,5 +14,6 @@ data class DownloadTask(
     var showNotification: Boolean,
     var openFileFromNotification: Boolean,
     var timeCreated: Long,
-    var saveInPublicStorage: Boolean
+    var saveInPublicStorage: Boolean,
+    var allowCellular: Boolean
 )
diff --git a/android/src/main/kotlin/vn/hunghd/flutterdownloader/DownloadWorker.kt b/android/src/main/kotlin/vn/hunghd/flutterdownloader/DownloadWorker.kt
@@ -41,6 +41,7 @@ import java.net.URL
 import java.net.URLDecoder
 import java.security.SecureRandom
 import java.security.cert.X509Certificate
+import java.util.ArrayDeque
 import java.util.Locale
 import java.util.concurrent.atomic.AtomicBoolean
 import java.util.regex.Pattern
@@ -49,9 +50,6 @@ import javax.net.ssl.HttpsURLConnection
 import javax.net.ssl.SSLContext
 import javax.net.ssl.TrustManager
 import javax.net.ssl.X509TrustManager
-import java.util.ArrayDeque
-import kotlin.collections.ArrayList
-import kotlin.collections.HashMap
 
 class DownloadWorker(context: Context, params: WorkerParameters) :
     Worker(context, params),
@@ -158,7 +156,7 @@ class DownloadWorker(context: Context, params: WorkerParameters) :
         val headers: String = inputData.getString(ARG_HEADERS)
             ?: throw IllegalArgumentException("Argument '$ARG_HEADERS' should not be null")
         var isResume: Boolean = inputData.getBoolean(ARG_IS_RESUME, false)
-        var timeout: Int = inputData.getInt(ARG_TIMEOUT, 15000)
+        val timeout: Int = inputData.getInt(ARG_TIMEOUT, 15000)
         debug = inputData.getBoolean(ARG_DEBUG, false)
         step = inputData.getInt(ARG_STEP, 10)
         ignoreSsl = inputData.getBoolean(ARG_IGNORESSL, false)
@@ -172,9 +170,9 @@ class DownloadWorker(context: Context, params: WorkerParameters) :
         val task = taskDao?.loadTask(id.toString())
         log(
             "DownloadWorker{url=$url,filename=$filename,savedDir=$savedDir,header=$headers,isResume=$isResume,status=" + (
-                    task?.status
-                        ?: "GONE"
-                    )
+                task?.status
+                    ?: "GONE"
+                )
         )
 
         // Task has been deleted or cancelled
@@ -258,10 +256,10 @@ class DownloadWorker(context: Context, params: WorkerParameters) :
         savedDir: String,
         filename: String?,
         headers: String,
-        isResume: Boolean, 
-        timeout: Int, 
+        isResume: Boolean,
+        timeout: Int,
     ) {
-        var filename = filename
+        var actualFilename = filename
         var url = fileURL
         var resourceUrl: URL
         var base: URL?
@@ -274,7 +272,7 @@ class DownloadWorker(context: Context, params: WorkerParameters) :
         var downloadedBytes: Long = 0
         var responseCode: Int
         var times: Int
-        var timeout = timeout
+        var actualTimeout = timeout
         visited = HashMap()
         try {
             val task = taskDao?.loadTask(id.toString())
@@ -306,16 +304,16 @@ class DownloadWorker(context: Context, params: WorkerParameters) :
                     resourceUrl.openConnection() as HttpsURLConnection
                 }
                 log("Open connection to $url")
-                httpConn.connectTimeout = timeout
-                httpConn.readTimeout = timeout
+                httpConn.connectTimeout = actualTimeout
+                httpConn.readTimeout = actualTimeout
                 httpConn.instanceFollowRedirects = false // Make the logic below easier to detect redirections
                 httpConn.setRequestProperty("User-Agent", "Mozilla/5.0...")
 
                 // setup request headers if it is set
                 setupHeaders(httpConn, headers)
                 // try to continue downloading a file from its partial downloaded data.
                 if (isResume) {
-                    downloadedBytes = setupPartialDownloadedDataHeader(httpConn, filename, savedDir)
+                    downloadedBytes = setupPartialDownloadedDataHeader(httpConn, actualFilename, savedDir)
                 }
                 responseCode = httpConn.responseCode
                 when (responseCode) {
@@ -348,25 +346,25 @@ class DownloadWorker(context: Context, params: WorkerParameters) :
                 log("Charset = $charset")
                 if (!isResume) {
                     // try to extract filename from HTTP headers if it is not given by user
-                    if (filename == null) {
+                    if (actualFilename == null) {
                         val disposition: String? = httpConn.getHeaderField("Content-Disposition")
                         log("Content-Disposition = $disposition")
                         if (!disposition.isNullOrEmpty()) {
-                            filename = getFileNameFromContentDisposition(disposition, charset)
+                            actualFilename = getFileNameFromContentDisposition(disposition, charset)
                         }
-                        if (filename.isNullOrEmpty()) {
-                            filename = url.substring(url.lastIndexOf("/") + 1)
+                        if (actualFilename.isNullOrEmpty()) {
+                            actualFilename = url.substring(url.lastIndexOf("/") + 1)
                             try {
-                                filename = URLDecoder.decode(filename, "UTF-8")
+                                actualFilename = URLDecoder.decode(actualFilename, "UTF-8")
                             } catch (e: IllegalArgumentException) {
                                 /* ok, just let filename be not encoded */
                                 e.printStackTrace()
                             }
                         }
                     }
                 }
-                log("fileName = $filename")
-                taskDao?.updateTask(id.toString(), filename, contentType)
+                log("fileName = $actualFilename")
+                taskDao?.updateTask(id.toString(), actualFilename, contentType)
 
                 // opens input stream from the HTTP connection
                 inputStream = httpConn.inputStream
@@ -375,7 +373,7 @@ class DownloadWorker(context: Context, params: WorkerParameters) :
                 // there are two case:
                 if (isResume) {
                     // 1. continue downloading (append data to partial downloaded file)
-                    savedFilePath = savedDir + File.separator + filename
+                    savedFilePath = savedDir + File.separator + actualFilename
                     outputStream = FileOutputStream(savedFilePath, true)
                 } else {
                     // 2. new download, create new file
@@ -384,11 +382,11 @@ class DownloadWorker(context: Context, params: WorkerParameters) :
                     // or public shared download directory (external storage).
                     // The second option will ignore `savedDir` parameter.
                     if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q && saveInPublicStorage) {
-                        val uri = createFileInPublicDownloadsDir(filename, contentType)
+                        val uri = createFileInPublicDownloadsDir(actualFilename, contentType)
                         savedFilePath = getMediaStoreEntryPathApi29(uri!!)
                         outputStream = context.contentResolver.openOutputStream(uri, "w")
                     } else {
-                        val file = createFileInAppSpecificDir(filename!!, savedDir)
+                        val file = createFileInAppSpecificDir(actualFilename!!, savedDir)
                         savedFilePath = file!!.path
                         outputStream = FileOutputStream(file, false)
                     }
@@ -413,7 +411,7 @@ class DownloadWorker(context: Context, params: WorkerParameters) :
                         taskDao!!.updateTask(id.toString(), DownloadStatus.RUNNING, progress)
                         updateNotification(
                             context,
-                            filename,
+                            actualFilename,
                             DownloadStatus.RUNNING,
                             progress,
                             null,
@@ -434,7 +432,7 @@ class DownloadWorker(context: Context, params: WorkerParameters) :
                     if (Build.VERSION.SDK_INT < Build.VERSION_CODES.Q) {
                         if (isImageOrVideoFile(contentType) && isExternalStoragePath(savedFilePath)) {
                             addImageOrVideoToGallery(
-                                filename,
+                                actualFilename,
                                 savedFilePath,
                                 getContentTypeWithoutCharset(contentType)
                             )
@@ -459,19 +457,19 @@ class DownloadWorker(context: Context, params: WorkerParameters) :
                     }
                 }
                 taskDao!!.updateTask(id.toString(), status, progress)
-                updateNotification(context, filename, status, progress, pendingIntent, true)
+                updateNotification(context, actualFilename, status, progress, pendingIntent, true)
                 log(if (isStopped) "Download canceled" else "File downloaded")
             } else {
                 val task = taskDao!!.loadTask(id.toString())
                 val status =
                     if (isStopped) if (task!!.resumable) DownloadStatus.PAUSED else DownloadStatus.CANCELED else DownloadStatus.FAILED
                 taskDao!!.updateTask(id.toString(), status, lastProgress)
-                updateNotification(context, filename ?: fileURL, status, -1, null, true)
+                updateNotification(context, actualFilename ?: fileURL, status, -1, null, true)
                 log(if (isStopped) "Download canceled" else "Server replied HTTP code: $responseCode")
             }
         } catch (e: IOException) {
             taskDao!!.updateTask(id.toString(), DownloadStatus.FAILED, lastProgress)
-            updateNotification(context, filename ?: fileURL, DownloadStatus.FAILED, -1, null, true)
+            updateNotification(context, actualFilename ?: fileURL, DownloadStatus.FAILED, -1, null, true)
             e.printStackTrace()
         } finally {
             if (outputStream != null) {
diff --git a/android/src/main/kotlin/vn/hunghd/flutterdownloader/FlutterDownloaderPlugin.kt b/android/src/main/kotlin/vn/hunghd/flutterdownloader/FlutterDownloaderPlugin.kt
@@ -22,8 +22,6 @@ import io.flutter.plugin.common.MethodChannel
 import java.io.File
 import java.util.UUID
 import java.util.concurrent.TimeUnit
-import kotlin.collections.ArrayList
-import kotlin.collections.HashMap
 
 private const val invalidTaskId = "invalid_task_id"
 private const val invalidStatus = "invalid_status"
@@ -91,14 +89,15 @@ class FlutterDownloaderPlugin : MethodChannel.MethodCallHandler, FlutterPlugin {
         openFileFromNotification: Boolean,
         isResume: Boolean,
         requiresStorageNotLow: Boolean,
-        saveInPublicStorage: Boolean,
+        saveInPublicStorage: Boolean, 
         timeout: Int,
+        allowCellular: Boolean,
     ): WorkRequest {
         return OneTimeWorkRequest.Builder(DownloadWorker::class.java)
             .setConstraints(
                 Constraints.Builder()
                     .setRequiresStorageNotLow(requiresStorageNotLow)
-                    .setRequiredNetworkType(NetworkType.CONNECTED)
+                    .setRequiredNetworkType(if (allowCellular) NetworkType.CONNECTED else NetworkType.UNMETERED)
                     .build()
             )
             .addTag(TAG)
@@ -169,17 +168,18 @@ class FlutterDownloaderPlugin : MethodChannel.MethodCallHandler, FlutterPlugin {
         val openFileFromNotification: Boolean = call.requireArgument("open_file_from_notification")
         val requiresStorageNotLow: Boolean = call.requireArgument("requires_storage_not_low")
         val saveInPublicStorage: Boolean = call.requireArgument("save_in_public_storage")
+        val allowCellular: Boolean = call.requireArgument("allow_cellular")
         val request: WorkRequest = buildRequest(
             url, savedDir, filename, headers, showNotification,
-            openFileFromNotification, false, requiresStorageNotLow, saveInPublicStorage, timeout
+            openFileFromNotification, false, requiresStorageNotLow, saveInPublicStorage, timeout, allowCellular = allowCellular
         )
         WorkManager.getInstance(requireContext()).enqueue(request)
         val taskId: String = request.id.toString()
         result.success(taskId)
         sendUpdateProgress(taskId, DownloadStatus.ENQUEUED, 0)
         taskDao!!.insertOrUpdateNewTask(
             taskId, url, DownloadStatus.ENQUEUED, 0, filename,
-            savedDir, headers, showNotification, openFileFromNotification, saveInPublicStorage
+            savedDir, headers, showNotification, openFileFromNotification, saveInPublicStorage, allowCellular = allowCellular
         )
     }
 
@@ -195,6 +195,7 @@ class FlutterDownloaderPlugin : MethodChannel.MethodCallHandler, FlutterPlugin {
             item["file_name"] = task.filename
             item["saved_dir"] = task.savedDir
             item["time_created"] = task.timeCreated
+            item["allow_cellular"] = task.allowCellular
             array.add(item)
         }
         result.success(array)
@@ -256,7 +257,7 @@ class FlutterDownloaderPlugin : MethodChannel.MethodCallHandler, FlutterPlugin {
                     val request: WorkRequest = buildRequest(
                         task.url, task.savedDir, task.filename,
                         task.headers, task.showNotification, task.openFileFromNotification,
-                        true, requiresStorageNotLow, task.saveInPublicStorage, timeout
+                        true, requiresStorageNotLow, task.saveInPublicStorage, timeout, allowCellular = task.allowCellular
                     )
                     val newTaskId: String = request.id.toString()
                     result.success(newTaskId)
@@ -295,7 +296,7 @@ class FlutterDownloaderPlugin : MethodChannel.MethodCallHandler, FlutterPlugin {
                 val request: WorkRequest = buildRequest(
                     task.url, task.savedDir, task.filename,
                     task.headers, task.showNotification, task.openFileFromNotification,
-                    false, requiresStorageNotLow, task.saveInPublicStorage, timeout
+                    false, requiresStorageNotLow, task.saveInPublicStorage, timeout, allowCellular = task.allowCellular
                 )
                 val newTaskId: String = request.id.toString()
                 result.success(newTaskId)
diff --git a/android/src/main/kotlin/vn/hunghd/flutterdownloader/TaskDao.kt b/android/src/main/kotlin/vn/hunghd/flutterdownloader/TaskDao.kt
@@ -20,7 +20,8 @@ class TaskDao(private val dbHelper: TaskDbHelper) {
         TaskEntry.COLUMN_NAME_OPEN_FILE_FROM_NOTIFICATION,
         TaskEntry.COLUMN_NAME_SHOW_NOTIFICATION,
         TaskEntry.COLUMN_NAME_TIME_CREATED,
-        TaskEntry.COLUMN_SAVE_IN_PUBLIC_STORAGE
+        TaskEntry.COLUMN_SAVE_IN_PUBLIC_STORAGE,
+        TaskEntry.COLUMN_ALLOW_CELLULAR,
     )
 
     fun insertOrUpdateNewTask(
@@ -33,7 +34,8 @@ class TaskDao(private val dbHelper: TaskDbHelper) {
         headers: String?,
         showNotification: Boolean,
         openFileFromNotification: Boolean,
-        saveInPublicStorage: Boolean
+        saveInPublicStorage: Boolean,
+        allowCellular: Boolean
     ) {
         val db = dbHelper.writableDatabase
         val values = ContentValues()
@@ -53,6 +55,7 @@ class TaskDao(private val dbHelper: TaskDbHelper) {
         values.put(TaskEntry.COLUMN_NAME_RESUMABLE, 0)
         values.put(TaskEntry.COLUMN_NAME_TIME_CREATED, System.currentTimeMillis())
         values.put(TaskEntry.COLUMN_SAVE_IN_PUBLIC_STORAGE, if (saveInPublicStorage) 1 else 0)
+        values.put(TaskEntry.COLUMN_ALLOW_CELLULAR, if(allowCellular) 1 else 0)
         db.beginTransaction()
         try {
             db.insertWithOnConflict(
@@ -243,6 +246,7 @@ class TaskDao(private val dbHelper: TaskDbHelper) {
         val clickToOpenDownloadedFile = cursor.getShort(cursor.getColumnIndexOrThrow(TaskEntry.COLUMN_NAME_OPEN_FILE_FROM_NOTIFICATION)).toInt()
         val timeCreated = cursor.getLong(cursor.getColumnIndexOrThrow(TaskEntry.COLUMN_NAME_TIME_CREATED))
         val saveInPublicStorage = cursor.getShort(cursor.getColumnIndexOrThrow(TaskEntry.COLUMN_SAVE_IN_PUBLIC_STORAGE)).toInt()
+        val allowCelluar = cursor.getShort(cursor.getColumnIndexOrThrow(TaskEntry.COLUMN_ALLOW_CELLULAR)).toInt()
         return DownloadTask(
             primaryId,
             taskId,
@@ -257,7 +261,8 @@ class TaskDao(private val dbHelper: TaskDbHelper) {
             showNotification == 1,
             clickToOpenDownloadedFile == 1,
             timeCreated,
-            saveInPublicStorage == 1
+            saveInPublicStorage == 1,
+            allowCellular = allowCelluar == 1
         )
     }
 }
diff --git a/android/src/main/kotlin/vn/hunghd/flutterdownloader/TaskDbHelper.kt b/android/src/main/kotlin/vn/hunghd/flutterdownloader/TaskDbHelper.kt
@@ -12,7 +12,10 @@ class TaskDbHelper private constructor(context: Context) :
     }
 
     override fun onUpgrade(db: SQLiteDatabase, oldVersion: Int, newVersion: Int) {
-        if (oldVersion == 2 && newVersion == 3) {
+        if(newVersion == 4) {
+            db.execSQL("ALTER TABLE ${TaskEntry.TABLE_NAME} ADD COLUMN ${TaskEntry.COLUMN_ALLOW_CELLULAR} TINYINT DEFAULT 1")
+        }
+        else if (oldVersion == 2 && newVersion == 3) {
             db.execSQL("ALTER TABLE " + TaskEntry.TABLE_NAME + " ADD COLUMN " + TaskEntry.COLUMN_SAVE_IN_PUBLIC_STORAGE + " TINYINT DEFAULT 0")
         } else {
             db.execSQL(SQL_DELETE_ENTRIES)
@@ -25,7 +28,7 @@ class TaskDbHelper private constructor(context: Context) :
     }
 
     companion object {
-        const val DATABASE_VERSION = 3
+        const val DATABASE_VERSION = 4
         const val DATABASE_NAME = "download_tasks.db"
         private var instance: TaskDbHelper? = null
         private const val SQL_CREATE_ENTRIES = (
@@ -43,10 +46,11 @@ class TaskDbHelper private constructor(context: Context) :
                 TaskEntry.COLUMN_NAME_SHOW_NOTIFICATION + " TINYINT DEFAULT 0, " +
                 TaskEntry.COLUMN_NAME_OPEN_FILE_FROM_NOTIFICATION + " TINYINT DEFAULT 0, " +
                 TaskEntry.COLUMN_NAME_TIME_CREATED + " INTEGER DEFAULT 0, " +
-                TaskEntry.COLUMN_SAVE_IN_PUBLIC_STORAGE + " TINYINT DEFAULT 0" +
+                TaskEntry.COLUMN_SAVE_IN_PUBLIC_STORAGE + " TINYINT DEFAULT 0, " +
+                TaskEntry.COLUMN_ALLOW_CELLULAR + " TINYINT DEFAULT 1" +
                 ")"
             )
-        private const val SQL_DELETE_ENTRIES = "DROP TABLE IF EXISTS " + TaskEntry.TABLE_NAME
+        private const val SQL_DELETE_ENTRIES = "DROP TABLE IF EXISTS ${TaskEntry.TABLE_NAME}"
 
         fun getInstance(ctx: Context?): TaskDbHelper {
             // Use the application context, which will ensure that you
diff --git a/android/src/main/kotlin/vn/hunghd/flutterdownloader/TaskEntry.kt b/android/src/main/kotlin/vn/hunghd/flutterdownloader/TaskEntry.kt
@@ -17,4 +17,5 @@ object TaskEntry : BaseColumns {
     const val COLUMN_NAME_OPEN_FILE_FROM_NOTIFICATION = "open_file_from_notification"
     const val COLUMN_NAME_TIME_CREATED = "time_created"
     const val COLUMN_SAVE_IN_PUBLIC_STORAGE = "save_in_public_storage"
+    const val COLUMN_ALLOW_CELLULAR = "allow_cellular"
 }
diff --git a/lib/src/downloader.dart b/lib/src/downloader.dart
@@ -10,7 +10,7 @@ import 'package:flutter_downloader/src/exceptions.dart';
 import 'callback_dispatcher.dart';
 import 'models.dart';
 
-/// Singature for a function which is called when the download state of a task
+/// Signature for a function which is called when the download state of a task
 /// with [id] changes.
 typedef DownloadCallback = void Function(
   String id,
@@ -101,6 +101,7 @@ class FlutterDownloader {
     bool openFileFromNotification = true,
     bool requiresStorageNotLow = true,
     bool saveInPublicStorage = false,
+    bool allowCellular = true,
     int timeout = 15000,
   }) async {
     assert(_initialized, 'plugin flutter_downloader is not initialized');
@@ -117,6 +118,7 @@ class FlutterDownloader {
         'requires_storage_not_low': requiresStorageNotLow,
         'save_in_public_storage': saveInPublicStorage,
         'timeout': timeout,
+        'allow_cellular': allowCellular,
       });
 
       if (taskId == null) {
@@ -160,6 +162,7 @@ class FlutterDownloader {
             filename: item['file_name'] as String?,
             savedDir: item['saved_dir'] as String,
             timeCreated: item['time_created'] as int,
+            allowCellular: item['allow_cellular'] as bool,
           );
         },
       ).toList();
@@ -217,6 +220,7 @@ class FlutterDownloader {
             filename: item['file_name'] as String?,
             savedDir: item['saved_dir'] as String,
             timeCreated: item['time_created'] as int,
+            allowCellular: item['allow_cellular'] as bool,
           );
         },
       ).toList();
diff --git a/lib/src/models.dart b/lib/src/models.dart

Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,6 @@ data class DownloadTask(`
`14`	`14`	`var showNotification: Boolean,`
`15`	`15`	`var openFileFromNotification: Boolean,`
`16`	`16`	`var timeCreated: Long,`
`17`		`- var saveInPublicStorage: Boolean`
	`17`	`+ var saveInPublicStorage: Boolean,`
	`18`	`+ var allowCellular: Boolean`
`18`	`19`	`)`
Original file line number	Diff line number	Diff line change
`@@ -17,4 +17,5 @@ object TaskEntry : BaseColumns {`
`17`	`17`	`const val COLUMN_NAME_OPEN_FILE_FROM_NOTIFICATION = "open_file_from_notification"`
`18`	`18`	`const val COLUMN_NAME_TIME_CREATED = "time_created"`
`19`	`19`	`const val COLUMN_SAVE_IN_PUBLIC_STORAGE = "save_in_public_storage"`
	`20`	`+ const val COLUMN_ALLOW_CELLULAR = "allow_cellular"`
`20`	`21`	`}`