enhancement: allow camera access when using image occlusion (#15029)

criticalAY · web-flow · commit d4bea9356a87 · 2024-05-14T15:00:49.000+01:00
* enhancement: allow camera access when using image occlusion
* Use bottom sheet to display camera and gallery option

* reactor: Use generic method from ImageUtils to crop image in BasicImageFieldController

* refactor: updated IO layout to use linear layout instead on MaterialButton
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/NoteEditor.kt b/AnkiDroid/src/main/java/com/ichi2/anki/NoteEditor.kt
@@ -29,6 +29,7 @@ import android.content.res.Configuration
 import android.net.Uri
 import android.os.Build
 import android.os.Bundle
+import android.os.Environment
 import android.text.Editable
 import android.text.TextWatcher
 import android.view.*
@@ -46,6 +47,7 @@ import androidx.appcompat.view.menu.MenuBuilder
 import androidx.appcompat.widget.AppCompatButton
 import androidx.appcompat.widget.PopupMenu
 import androidx.appcompat.widget.TooltipCompat
+import androidx.core.content.FileProvider
 import androidx.core.content.IntentCompat
 import androidx.core.content.edit
 import androidx.core.content.res.ResourcesCompat
@@ -58,6 +60,7 @@ import com.google.android.material.snackbar.Snackbar
 import com.ichi2.anim.ActivityTransitionAnimation
 import com.ichi2.anki.CollectionManager.TR
 import com.ichi2.anki.CollectionManager.withCol
+import com.ichi2.anki.bottomsheet.ImageOcclusionBottomSheetFragment
 import com.ichi2.anki.dialogs.ConfirmationDialog
 import com.ichi2.anki.dialogs.DeckSelectionDialog.DeckSelectionListener
 import com.ichi2.anki.dialogs.DeckSelectionDialog.SelectableDeck
@@ -90,6 +93,7 @@ import com.ichi2.anki.snackbar.SnackbarBuilder
 import com.ichi2.anki.snackbar.showSnackbar
 import com.ichi2.anki.ui.setupNoteTypeSpinner
 import com.ichi2.anki.utils.ext.isImageOcclusion
+import com.ichi2.anki.utils.getTimestamp
 import com.ichi2.anki.widgets.DeckDropDownAdapter.SubtitleListener
 import com.ichi2.annotations.NeedsTest
 import com.ichi2.compat.CompatHelper.Companion.getSerializableCompat
@@ -98,12 +102,14 @@ import com.ichi2.libanki.Collection
 import com.ichi2.libanki.Decks.Companion.CURRENT_DECK
 import com.ichi2.libanki.Note.ClozeUtils
 import com.ichi2.libanki.Notetypes.Companion.NOT_FOUND_NOTE_TYPE
+import com.ichi2.libanki.utils.TimeManager
 import com.ichi2.utils.*
 import com.ichi2.utils.IntentUtil.resolveMimeType
 import com.ichi2.widget.WidgetStatus
 import org.json.JSONArray
 import org.json.JSONObject
 import timber.log.Timber
+import java.io.File
 import java.util.*
 import java.util.function.Consumer
 import kotlin.collections.ArrayList
@@ -152,6 +158,8 @@ class NoteEditor : AnkiActivity(), DeckSelectionListener, SubtitleListener, Tags
     // non-null after onCollectionLoaded
     private var editorNote: Note? = null
 
+    private var currentImageOccPath: String? = null
+
     /* Null if adding a new card. Presently NonNull if editing an existing note - but this is subject to change */
     private var currentEditedCard: Card? = null
     private var selectedTags: MutableList<String>? = null
@@ -529,8 +537,23 @@ class NoteEditor : AnkiActivity(), DeckSelectionListener, SubtitleListener, Tags
         if (addNote) {
             editOcclusionsButton?.visibility = View.GONE
             selectImageForOcclusionButton?.setOnClickListener {
-                ioEditorLauncher.launch("image/*")
+                val imageOcclusionBottomSheet = ImageOcclusionBottomSheetFragment()
+                imageOcclusionBottomSheet.listener =
+                    object : ImageOcclusionBottomSheetFragment.ImagePickerListener {
+                        override fun onCameraClicked() {
+                            dispatchCameraEvent()
+                        }
+
+                        override fun onGalleryClicked() {
+                            ioEditorLauncher.launch("image/*")
+                        }
+                    }
+                imageOcclusionBottomSheet.show(
+                    supportFragmentManager,
+                    "ImageOcclusionBottomSheetFragment"
+                )
             }
+
             pasteOcclusionImageButton?.text = TR.notetypesIoPasteImageFromClipboard()
             pasteOcclusionImageButton?.setOnClickListener {
                 // TODO: Support all extensions
@@ -669,6 +692,63 @@ class NoteEditor : AnkiActivity(), DeckSelectionListener, SubtitleListener, Tags
         }
     }
 
+    private val cameraLauncher =
+        registerForActivityResult(ActivityResultContracts.TakePicture()) { isPictureTaken ->
+            if (isPictureTaken) {
+                currentImageOccPath?.let { imagePath ->
+                    val photoFile = File(imagePath)
+                    val imageUri: Uri = FileProvider.getUriForFile(
+                        this,
+                        this.applicationContext.packageName + ".apkgfileprovider",
+                        photoFile
+                    )
+                    startCrop(imageUri)
+                }
+            } else {
+                Timber.d("Camera aborted or some interruption")
+            }
+        }
+
+    private fun startCrop(imageUri: Uri) {
+        ImageUtils.cropImage(activityResultRegistry, imageUri) { result ->
+            if (result != null && result.isSuccessful) {
+                val uriFilePath = result.getUriFilePath(this)
+                uriFilePath?.let { setupImageOcclusionEditor(it) }
+            } else {
+                Timber.v("Unable to crop the image")
+            }
+        }
+    }
+
+    private fun dispatchCameraEvent() {
+        val photoFile: File? = try {
+            createImageFile()
+        } catch (e: Exception) {
+            Timber.w("Error creating the file", e)
+            return
+        }
+        photoFile?.let {
+            val photoURI: Uri = FileProvider.getUriForFile(
+                this,
+                this.applicationContext.packageName + ".apkgfileprovider",
+                it
+            )
+            cameraLauncher.launch(photoURI)
+        }
+    }
+
+    private fun createImageFile(): File {
+        val currentDateTime = getTimestamp(TimeManager.time)
+        val storageDir: File? = getExternalFilesDir(Environment.DIRECTORY_PICTURES)
+        return File.createTempFile(
+            "ANKIDROID_$currentDateTime",
+            ".jpg",
+            storageDir
+        ).apply {
+            currentImageOccPath = absolutePath
+        }
+    }
+
     private fun modifyCurrentSelection(formatter: Toolbar.TextFormatter, textBox: FieldEditText) {
         // get the current text and selection locations
         val selectionStart = textBox.selectionStart
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/bottomsheet/ImageOcclusionBottomSheetFragment.kt b/AnkiDroid/src/main/java/com/ichi2/anki/bottomsheet/ImageOcclusionBottomSheetFragment.kt
@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2023 Ashish Yadav <mailtoashish693@gmail.com>
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free Software
+ * Foundation; either version 3 of the License, or (at your option) any later
+ * version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package com.ichi2.anki.bottomsheet
+
+import android.os.Bundle
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import android.widget.LinearLayout
+import com.google.android.material.bottomsheet.BottomSheetBehavior
+import com.google.android.material.bottomsheet.BottomSheetDialogFragment
+import com.ichi2.anki.R
+
+class ImageOcclusionBottomSheetFragment : BottomSheetDialogFragment() {
+
+    var listener: ImagePickerListener? = null
+
+    interface ImagePickerListener {
+        fun onCameraClicked()
+        fun onGalleryClicked()
+    }
+
+    override fun onCreateView(
+        inflater: LayoutInflater,
+        container: ViewGroup?,
+        savedInstanceState: Bundle?
+    ): View {
+        val view = inflater.inflate(R.layout.image_occlusion_options_layout, container, false)
+
+        view.findViewById<LinearLayout>(R.id.occlusion_action_camera).setOnClickListener {
+            listener?.onCameraClicked()
+            dismiss()
+        }
+        view.findViewById<LinearLayout>(R.id.occlusion_action_gallery).setOnClickListener {
+            listener?.onGalleryClicked()
+            dismiss()
+        }
+
+        return view
+    }
+
+    override fun onStart() {
+        super.onStart()
+        val behavior = BottomSheetBehavior.from(requireView().parent as View)
+        behavior.state = BottomSheetBehavior.STATE_EXPANDED
+    }
+}
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/multimediacard/fields/BasicImageFieldController.kt b/AnkiDroid/src/main/java/com/ichi2/anki/multimediacard/fields/BasicImageFieldController.kt
@@ -62,7 +62,6 @@ import com.ichi2.anki.DrawingActivity
 import com.ichi2.anki.R
 import com.ichi2.anki.multimediacard.activity.MultimediaEditFieldActivity
 import com.ichi2.anki.showThemedToast
-import com.ichi2.annotations.NeedsTest
 import com.ichi2.ui.FixedEditText
 import com.ichi2.utils.*
 import timber.log.Timber
@@ -96,7 +95,6 @@ class BasicImageFieldController : FieldControllerBase(), IFieldController {
 
             return min(height * 0.4, width * 0.6).toInt()
         }
-    private lateinit var cropImageRequest: ActivityResultLauncher<CropImageContractOptions>
 
     @VisibleForTesting
     lateinit var registryToUse: ActivityResultRegistry
@@ -225,27 +223,6 @@ class BasicImageFieldController : FieldControllerBase(), IFieldController {
     override fun setEditingActivity(activity: MultimediaEditFieldActivity) {
         super.setEditingActivity(activity)
         val registryToUse = if (this::registryToUse.isInitialized) registryToUse else this._activity.activityResultRegistry
-        @NeedsTest("check the happy/failure path for the crop action")
-        cropImageRequest = registryToUse.register(CROP_IMAGE_LAUNCHER_KEY, CropImageContract()) { cropResult ->
-            if (cropResult.isSuccessful) {
-                imageFileSizeWarning.visibility = View.GONE
-                handleCropResult(cropResult)
-                setPreviewImage(viewModel.imagePath, maxImageSize)
-            } else {
-                if (!previousImagePath.isNullOrEmpty()) {
-                    revertToPreviousImage()
-                }
-                // cropImage can give us more information. Not sure it is actionable so for now just log it.
-                val error: String = cropResult.error?.toString() ?: "Error info not available"
-                Timber.w(error, "cropImage threw an error")
-                // condition can be removed if #12768 get fixed by Canhub
-                if (cropResult.error is CropException.Cancellation) {
-                    Timber.i("CropException caught, seemingly nothing to do ", error)
-                } else {
-                    CrashReportService.sendExceptionReport(error, "cropImage threw an error")
-                }
-            }
-        }
 
         takePictureLauncher = registryToUse.register(
             TAKE_PICTURE_LAUNCHER_KEY,
@@ -548,9 +525,6 @@ class BasicImageFieldController : FieldControllerBase(), IFieldController {
 
     override fun onDone() {
         deletePreviousImage()
-        if (::cropImageRequest.isInitialized) {
-            cropImageRequest.unregister()
-        }
         if (::takePictureLauncher.isInitialized) {
             takePictureLauncher.unregister()
         }
@@ -687,13 +661,30 @@ class BasicImageFieldController : FieldControllerBase(), IFieldController {
         ret = viewModel.beforeCrop(imagePath, imageUri)
         setTemporaryMedia(imagePath)
         Timber.d("requestCrop()  destination image has path/uri %s/%s", ret.imagePath, ret.imageUri)
-        if (this::cropImageRequest.isInitialized) {
-            cropImageRequest.launch(
-                CropImageContractOptions(
-                    viewModel.imageUri,
-                    CropImageOptions()
-                )
-            )
+
+        viewModel.imageUri?.let {
+            ImageUtils.cropImage(_activity.activityResultRegistry, it) { cropResult ->
+                if (cropResult != null) {
+                    if (cropResult.isSuccessful) {
+                        imageFileSizeWarning.visibility = View.GONE
+                        handleCropResult(cropResult)
+                        setPreviewImage(viewModel.imagePath, maxImageSize)
+                    } else {
+                        if (!previousImagePath.isNullOrEmpty()) {
+                            revertToPreviousImage()
+                        }
+                        // cropImage can give us more information. Not sure it is actionable so for now just log it.
+                        val error: String = cropResult.error?.toString() ?: "Error info not available"
+                        Timber.w(error, "cropImage threw an error")
+                        // condition can be removed if #12768 get fixed by Canhub
+                        if (cropResult.error is CropException.Cancellation) {
+                            Timber.i("CropException caught, seemingly nothing to do ", error)
+                        } else {
+                            CrashReportService.sendExceptionReport(error, "cropImage threw an error")
+                        }
+                    }
+                }
+            }
         }
         return ret
     }
diff --git a/AnkiDroid/src/main/java/com/ichi2/utils/ImageUtils.kt b/AnkiDroid/src/main/java/com/ichi2/utils/ImageUtils.kt
@@ -0,0 +1,58 @@
+/*
+ *  Copyright (c) 2024 Ashish Yadav <mailtoashish693@gmail.com>
+ *
+ *  This program is free software; you can redistribute it and/or modify it under
+ *  the terms of the GNU General Public License as published by the Free Software
+ *  Foundation; either version 3 of the License, or (at your option) any later
+ *  version.
+ *
+ *  This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ *  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ *  PARTICULAR PURPOSE. See the GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License along with
+ *  this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package com.ichi2.utils
+
+import android.net.Uri
+import androidx.activity.result.ActivityResultRegistry
+import com.canhub.cropper.CropImageContract
+import com.canhub.cropper.CropImageContractOptions
+import com.canhub.cropper.CropImageOptions
+import com.canhub.cropper.CropImageView
+import timber.log.Timber
+
+object ImageUtils {
+    private const val CROP_IMAGE_KEY = "crop_image_launcher"
+
+    /**
+     * Initiates the image cropping process using the specified ActivityResultRegistry, URI of the image to crop,
+     * and a callback function to handle the result.
+     *
+     * @param registry The ActivityResultRegistry instance used for registering the activity result.
+     * @param uri The URI of the image to be cropped.
+     * @param callback The callback function that receives the crop result (CropImageView.CropResult) or null if the cropping operation fails.
+     */
+    fun cropImage(
+        registry: ActivityResultRegistry,
+        uri: Uri,
+        callback: (CropImageView.CropResult?) -> Unit
+    ) {
+        val cropImage = registry.register(CROP_IMAGE_KEY, CropImageContract()) { result ->
+            if (result.isSuccessful) {
+                callback(result)
+            } else {
+                Timber.v(result.error)
+                callback(null)
+            }
+        }
+        cropImage.launch(
+            CropImageContractOptions(
+                uri,
+                CropImageOptions()
+            )
+        )
+    }
+}
diff --git a/AnkiDroid/src/main/res/drawable/ic_camera.xml b/AnkiDroid/src/main/res/drawable/ic_camera.xml
@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:tint="?attr/colorControlNormal"
+    android:viewportWidth="960"
+    android:viewportHeight="960">
+  <path
+      android:fillColor="#FF000000"
+      android:pathData="M480,700q75,0 127.5,-52.5T660,520q0,-75 -52.5,-127.5T480,340q-75,0 -127.5,52.5T300,520q0,75 52.5,127.5T480,700ZM480,620q-42,0 -71,-29t-29,-71q0,-42 29,-71t71,-29q42,0 71,29t29,71q0,42 -29,71t-71,29ZM160,840q-33,0 -56.5,-23.5T80,760v-480q0,-33 23.5,-56.5T160,200h126l50,-54q11,-12 26.5,-19t32.5,-7h170q17,0 32.5,7t26.5,19l50,54h126q33,0 56.5,23.5T880,280v480q0,33 -23.5,56.5T800,840L160,840ZM160,760h640v-480L638,280l-73,-80L395,200l-73,80L160,280v480ZM480,520Z"/>
+</vector>
diff --git a/AnkiDroid/src/main/res/drawable/ic_gallery.xml b/AnkiDroid/src/main/res/drawable/ic_gallery.xml
@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:tint="?attr/colorControlNormal"
+    android:viewportWidth="960"
+    android:viewportHeight="960">
+  <path
+      android:fillColor="#FF000000"
+      android:pathData="M120,760q-33,0 -56.5,-23.5T40,680v-400q0,-33 23.5,-56.5T120,200h400q33,0 56.5,23.5T600,280v400q0,33 -23.5,56.5T520,760L120,760ZM720,440q-17,0 -28.5,-11.5T680,400v-160q0,-17 11.5,-28.5T720,200h160q17,0 28.5,11.5T920,240v160q0,17 -11.5,28.5T880,440L720,440ZM760,360h80v-80h-80v80ZM120,680h400v-400L120,280v400ZM200,600h240q12,0 18,-11t-2,-21l-65,-87q-6,-8 -16,-8t-16,8l-59,79 -39,-52q-6,-8 -16,-8t-16,8l-45,60q-8,10 -2,21t18,11ZM720,760q-17,0 -28.5,-11.5T680,720v-160q0,-17 11.5,-28.5T720,520h160q17,0 28.5,11.5T920,560v160q0,17 -11.5,28.5T880,760L720,760ZM760,680h80v-80h-80v80ZM120,680v-400,400ZM760,360v-80,80ZM760,680v-80,80Z"/>
+</vector>
diff --git a/AnkiDroid/src/main/res/drawable/ic_paste.xml b/AnkiDroid/src/main/res/drawable/ic_paste.xml
@@ -0,0 +1,9 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="960"
+    android:viewportHeight="960">
+  <path
+      android:fillColor="#FF000000"
+      android:pathData="M200,840q-33,0 -56.5,-23.5T120,760v-560q0,-33 23.5,-56.5T200,120h167q11,-35 43,-57.5t70,-22.5q40,0 71.5,22.5T594,120h166q33,0 56.5,23.5T840,200v560q0,33 -23.5,56.5T760,840L200,840ZM200,760h560v-560h-80v120L280,320v-120h-80v560ZM480,200q17,0 28.5,-11.5T520,160q0,-17 -11.5,-28.5T480,120q-17,0 -28.5,11.5T440,160q0,17 11.5,28.5T480,200Z"/>
+</vector>
diff --git a/AnkiDroid/src/main/res/layout/image_occlusion_options_layout.xml b/AnkiDroid/src/main/res/layout/image_occlusion_options_layout.xml
diff --git a/AnkiDroid/src/main/res/layout/note_editor.xml b/AnkiDroid/src/main/res/layout/note_editor.xml
