Merge pull request #52 from jachzen/feature/mlkit_fallback

Added Fallback when mlkit is unavailable
jachzen · Mar 6, 2024 · 1eafd45 · 1eafd45
2 parents 4697cb5 + 1685519
commit 1eafd45
Show file tree

Hide file tree

Showing 33 changed files with 1,780 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## 1.2.1
+* Add fallback for Android devices < 1.7GB RAM
+
 ## 1.2.0
 * Use ML kit on Android
 * dropped nocrop support

diff --git a/android/src/main/AndroidManifest.xml b/android/src/main/AndroidManifest.xml
@@ -6,5 +6,20 @@
     <uses-feature android:name="android.hardware.camera"
                   android:required="true" />
     <application android:theme="@style/Theme.AppCompat.NoActionBar">
+        <activity
+            android:name=".fallback.DocumentScannerActivity"
+            android:configChanges="orientation|screenSize"
+            android:screenOrientation="portrait"
+            android:theme="@style/Theme.FullScreen" />
+
+        <provider
+            android:name="biz.cunning.cunning_document_scanner.fallback.DocumentScannerFileProvider"
+            android:authorities="${applicationId}.DocumentScannerFileProvider"
+            android:exported="false"
+            android:grantUriPermissions="true">
+            <meta-data
+                android:name="android.support.FILE_PROVIDER_PATHS"
+                android:resource="@xml/file_paths" />
+        </provider>
     </application>
 </manifest>
diff --git a/android/src/main/kotlin/biz/cunning/cunning_document_scanner/CunningDocumentScannerPlugin.kt b/android/src/main/kotlin/biz/cunning/cunning_document_scanner/CunningDocumentScannerPlugin.kt
@@ -1,7 +1,13 @@
 package biz.cunning.cunning_document_scanner
 
 import android.app.Activity
+import android.content.ActivityNotFoundException
+import android.content.Intent
 import android.content.IntentSender
+import androidx.core.app.ActivityCompat
+import biz.cunning.cunning_document_scanner.fallback.DocumentScannerActivity
+import biz.cunning.cunning_document_scanner.fallback.constants.DocumentScannerExtra
+import com.google.mlkit.common.MlKitException
 import com.google.mlkit.vision.documentscanner.GmsDocumentScannerOptions
 import com.google.mlkit.vision.documentscanner.GmsDocumentScannerOptions.RESULT_FORMAT_JPEG
 import com.google.mlkit.vision.documentscanner.GmsDocumentScannerOptions.SCANNER_MODE_FULL
@@ -24,6 +30,7 @@ class CunningDocumentScannerPlugin : FlutterPlugin, MethodCallHandler, ActivityA
     private var pendingResult: Result? = null
     private lateinit var activity: Activity
     private val START_DOCUMENT_ACTIVITY: Int = 0x362738
+    private val START_DOCUMENT_FB_ACTIVITY: Int = 0x362737
 
 
     /// The MethodChannel that will the communication between Flutter and native Android
@@ -63,35 +70,76 @@ class CunningDocumentScannerPlugin : FlutterPlugin, MethodCallHandler, ActivityA
         this.binding = binding
         if (this.delegate == null) {
             this.delegate = PluginRegistry.ActivityResultListener { requestCode, resultCode, data ->
-                if (requestCode != START_DOCUMENT_ACTIVITY) {
+                if (requestCode != START_DOCUMENT_ACTIVITY && requestCode != START_DOCUMENT_FB_ACTIVITY) {
                     return@ActivityResultListener false
                 }
-                when (resultCode) {
-                    Activity.RESULT_OK -> {
-                        // check for errors
-                        val error = data?.extras?.getString("error")
-                        if (error != null) {
-                            throw Exception("error - $error")
+                if (requestCode == START_DOCUMENT_ACTIVITY) {
+                    when (resultCode) {
+                        Activity.RESULT_OK -> {
+                            // check for errors
+                            val error = data?.extras?.getString("error")
+                            if (error != null) {
+                                throw Exception("error - $error")
+                            }
+
+                            // get an array with scanned document file paths
+                            val scanningResult: GmsDocumentScanningResult =
+                                data?.extras?.getParcelable<GmsDocumentScanningResult>("extra_scanning_result")
+                                    ?: return@ActivityResultListener false
+
+                            val successResponse = scanningResult.pages?.map {
+                                it.imageUri.toString().removePrefix("file://")
+                            }?.toList()
+
+                            // trigger the success event handler with an array of cropped images
+                            this.pendingResult?.success(successResponse)
+                            return@ActivityResultListener true
                         }
 
-                        // get an array with scanned document file paths
-                        val scanningResult: GmsDocumentScanningResult = data?.extras?.get("extra_scanning_result") as GmsDocumentScanningResult
-
-                        val successResponse = scanningResult.pages?.map {
-                            it.imageUri.toString().removePrefix("file://")
-                        }?.toList()
+                        Activity.RESULT_CANCELED -> {
+                            // user closed camera
+                            this.pendingResult?.success(emptyList<String>())
+                            return@ActivityResultListener true
+                        }
 
-                        // trigger the success event handler with an array of cropped images
-                        this.pendingResult?.success(successResponse)
-                        return@ActivityResultListener true
-                    }
-                    Activity.RESULT_CANCELED -> {
-                        // user closed camera
-                        this.pendingResult?.success(emptyList<String>())
-                        return@ActivityResultListener true
+                        else -> {
+                            return@ActivityResultListener false
+                        }
                     }
-                    else -> {
-                        return@ActivityResultListener false
+                } else {
+                    when (resultCode) {
+                        Activity.RESULT_OK -> {
+                            // check for errors
+                            val error = data?.extras?.getString("error")
+                            if (error != null) {
+                                throw Exception("error - $error")
+                            }
+
+                            // get an array with scanned document file paths
+                            val croppedImageResults =
+                                data?.getStringArrayListExtra("croppedImageResults")?.toList()
+                                    ?: throw Exception("No cropped images returned")
+
+                            // return a list of file paths
+                            // removing file uri prefix as Flutter file will have problems with it
+                            val successResponse = croppedImageResults.map {
+                                it.removePrefix("file://")
+                            }.toList()
+
+                            // trigger the success event handler with an array of cropped images
+                            this.pendingResult?.success(successResponse)
+                            return@ActivityResultListener true
+                        }
+
+                        Activity.RESULT_CANCELED -> {
+                            // user closed camera
+                            this.pendingResult?.success(emptyList<String>())
+                            return@ActivityResultListener true
+                        }
+
+                        else -> {
+                            return@ActivityResultListener false
+                        }
                     }
                 }
             }
@@ -103,6 +151,21 @@ class CunningDocumentScannerPlugin : FlutterPlugin, MethodCallHandler, ActivityA
     }
 
 
+    /**
+     * create intent to launch document scanner and set custom options
+     */
+    private fun createDocumentScanIntent(noOfPages: Int): Intent {
+        val documentScanIntent = Intent(activity, DocumentScannerActivity::class.java)
+
+        documentScanIntent.putExtra(
+            DocumentScannerExtra.EXTRA_MAX_NUM_DOCUMENTS,
+            noOfPages
+        )
+
+        return documentScanIntent
+    }
+
+
     /**
      * add document scanner result handler and launch the document scanner
      */
@@ -123,7 +186,21 @@ class CunningDocumentScannerPlugin : FlutterPlugin, MethodCallHandler, ActivityA
                 pendingResult?.error("ERROR", "Failed to start document scanner", null)
             }
         }.addOnFailureListener {
-            pendingResult?.error("ERROR", "Failed to start document scanner Intent", null)
+            if (it is MlKitException) {
+                val intent = createDocumentScanIntent(noOfPages)
+                try {
+                    ActivityCompat.startActivityForResult(
+                        this.activity,
+                        intent,
+                        START_DOCUMENT_FB_ACTIVITY,
+                        null
+                    )
+                } catch (e: ActivityNotFoundException) {
+                    pendingResult?.error("ERROR", "FAILED TO START ACTIVITY", null)
+                }
+            } else {
+                pendingResult?.error("ERROR", "Failed to start document scanner Intent", null)
+            }
         }
     }