Merge pull request #64 from Marchuck/feature/mime_types

Limit mime types while choosing a gallery image

Author: Dhaval2404

imagepicker/build.gradle

@@ -20,6 +20,9 @@ android {
     }
 
     buildTypes {
+        debug{
+
+        }
         release {
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'

imagepicker/src/main/kotlin/com/github/dhaval2404/imagepicker/ImagePicker.kt

@@ -39,6 +39,7 @@ open class ImagePicker {
 
         internal const val EXTRA_ERROR = "extra.error"
         internal const val EXTRA_FILE_PATH = "extra.file_path"
+        internal const val EXTRA_GALLERY_MIME_TYPES = "extra.gallery.mime.types"
 
         /**
          * Use this to use ImagePicker in Activity Class
@@ -96,6 +97,9 @@ open class ImagePicker {
         // Image Provider
         private var imageProvider = BOTH
 
+        //mime types restrictions for gallery. by default all mime types are valid
+        private var mimeTypes: Array<String> = emptyArray()
+
         /*
          * Crop Parameters
          */
@@ -149,6 +153,17 @@ open class ImagePicker {
             return this
         }
 
+        /**
+         * restrict mime types during gallery fetching, for instance if you do not want GIF images,
+         * you can use arrayOf("image/png","image/jpeg","image/jpg")
+         * by default array is empty, which indicates no additional restrictions, just images
+         * @param mimeTypes
+         */
+        fun galleryMimeTypes(mimeTypes: Array<String>): Builder {
+            this.mimeTypes = mimeTypes
+            return this
+        }
+
         /**
          * Set an aspect ratio for crop bounds.
          * User won't see the menu with other ratios options.
@@ -270,19 +285,21 @@ open class ImagePicker {
          * Get Bundle for ImagePickerActivity
          */
         private fun getBundle(): Bundle {
-            val bundle = Bundle()
-            bundle.putSerializable(EXTRA_IMAGE_PROVIDER, imageProvider)
+            return Bundle().apply {
+                putSerializable(EXTRA_IMAGE_PROVIDER, imageProvider)
 
-            bundle.putBoolean(EXTRA_CROP, crop)
-            bundle.putFloat(EXTRA_CROP_X, cropX)
-            bundle.putFloat(EXTRA_CROP_Y, cropY)
+                putStringArray(EXTRA_GALLERY_MIME_TYPES, mimeTypes)
 
-            bundle.putInt(EXTRA_MAX_WIDTH, maxWidth)
-            bundle.putInt(EXTRA_MAX_HEIGHT, maxHeight)
+                putBoolean(EXTRA_CROP, crop)
 
-            bundle.putLong(EXTRA_IMAGE_MAX_SIZE, maxSize)
+                putFloat(EXTRA_CROP_X, cropX)
+                putFloat(EXTRA_CROP_Y, cropY)
 
-            return bundle
+                putInt(EXTRA_MAX_WIDTH, maxWidth)
+                putInt(EXTRA_MAX_HEIGHT, maxHeight)
+
+                putLong(EXTRA_IMAGE_MAX_SIZE, maxSize)
+            }
         }
 
         /**

imagepicker/src/main/kotlin/com/github/dhaval2404/imagepicker/ImagePickerActivity.kt

@@ -89,11 +89,12 @@ class ImagePickerActivity : AppCompatActivity() {
         // Retrieve Image Provider
         val provider: ImageProvider? =
             intent?.getSerializableExtra(ImagePicker.EXTRA_IMAGE_PROVIDER) as ImageProvider?
+        val mimeTypes: Array<String> = intent?.getStringArrayExtra(ImagePicker.EXTRA_GALLERY_MIME_TYPES) ?: emptyArray()
 
         // Create Gallery/Camera Provider
         when (provider) {
             ImageProvider.GALLERY -> {
-                mGalleryProvider = GalleryProvider(this)
+                mGalleryProvider = GalleryProvider(this, mimeTypes)
                 // Pick Gallery Image
                 savedInstanceState ?: mGalleryProvider?.startIntent()
             }

imagepicker/src/main/kotlin/com/github/dhaval2404/imagepicker/provider/GalleryProvider.kt

@@ -18,7 +18,8 @@ import java.io.File
  * @version 1.0
  * @since 04 January 2019
  */
-class GalleryProvider(activity: ImagePickerActivity) : BaseProvider(activity) {
+class GalleryProvider(activity: ImagePickerActivity, private val mimeTypes: Array<String>) :
+    BaseProvider(activity) {
 
     companion object {
         /**
@@ -48,15 +49,15 @@ class GalleryProvider(activity: ImagePickerActivity) : BaseProvider(activity) {
         if (!PermissionUtil.isPermissionGranted(this, REQUIRED_PERMISSIONS)) {
             requestPermissions(activity, REQUIRED_PERMISSIONS, PERMISSION_INTENT_REQ_CODE)
         } else {
-            startGalleryIntent()
+            startGalleryIntent(mimeTypes)
         }
     }
 
     /**
      * Start Gallery Intent
      */
-    private fun startGalleryIntent() {
-        val galleryIntent = IntentUtils.getGalleryIntent(activity)
+    private fun startGalleryIntent(mimeTypes: Array<String>) {
+        val galleryIntent = IntentUtils.getGalleryIntent(activity, mimeTypes)
         activity.startActivityForResult(galleryIntent, GALLERY_INTENT_REQ_CODE)
     }
 
@@ -68,7 +69,7 @@ class GalleryProvider(activity: ImagePickerActivity) : BaseProvider(activity) {
             // Check again if permission is granted
             if (PermissionUtil.isPermissionGranted(this, REQUIRED_PERMISSIONS)) {
                 // Permission is granted, Start Camera Intent
-                startGalleryIntent()
+                startGalleryIntent(mimeTypes)
             } else {
                 // Exit with error message
                 setError(getString(R.string.permission_gallery_denied))

imagepicker/src/main/kotlin/com/github/dhaval2404/imagepicker/util/IntentUtils.kt

@@ -22,45 +22,42 @@ object IntentUtils {
     /**
      * @return Intent Gallery Intent
      */
-    fun getGalleryIntent(context: Context): Intent {
-        return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
-            var intent = getGalleryDocumentIntent()
-            if (intent.resolveActivity(context.packageManager) == null) {
-                // No Activity found that can handle this intent.
-                intent = getGalleryPickIntent()
+    fun getGalleryIntent(context: Context, mimeTypes: Array<String>): Intent {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
+            val intent = getGalleryDocumentIntent(mimeTypes)
+            if (intent.resolveActivity(context.packageManager) != null) {
+                return intent
             }
-            intent
-        } else {
-            getGalleryPickIntent()
         }
+        return getLegacyGalleryPickIntent(mimeTypes)
     }
 
     /**
      * @return Intent Gallery Document Intent
      */
-    private fun getGalleryDocumentIntent(): Intent {
+    private fun getGalleryDocumentIntent(mimeTypes: Array<String>): Intent {
         // Show Document Intent
-        val intent = Intent(Intent.ACTION_OPEN_DOCUMENT)
-
+        val intent = Intent(Intent.ACTION_OPEN_DOCUMENT).applyImageTypes(mimeTypes)
         intent.addCategory(Intent.CATEGORY_OPENABLE)
-
-        // Apply filter to show image only in intent
-        intent.type = "image/*"
-
         return intent
     }
 
     /**
      * @return Intent Gallery Pick Intent
      */
-    private fun getGalleryPickIntent(): Intent {
+    private fun getLegacyGalleryPickIntent(mimeTypes: Array<String>): Intent {
         // Show Gallery Intent, Will open google photos
-        val intent = Intent(Intent.ACTION_PICK)
+        val intent = Intent(Intent.ACTION_PICK).applyImageTypes(mimeTypes)
+        return intent
+    }
 
+    private fun Intent.applyImageTypes(mimeTypes: Array<String>): Intent {
         // Apply filter to show image only in intent
-        intent.type = "image/*"
-
-        return intent
+        type = "image/*"
+        if (mimeTypes.isNotEmpty()) {
+            putExtra(Intent.EXTRA_MIME_TYPES, mimeTypes)
+        }
+        return this
     }
 
     /**
@@ -71,7 +68,8 @@ object IntentUtils {
 
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
             // authority = com.github.dhaval2404.imagepicker.provider
-            val authority = context.packageName + context.getString(R.string.image_picker_provider_authority_suffix)
+            val authority =
+                context.packageName + context.getString(R.string.image_picker_provider_authority_suffix)
             val photoURI = FileProvider.getUriForFile(context, authority, file)
             intent.putExtra(MediaStore.EXTRA_OUTPUT, photoURI)
         } else {

imagepicker/src/main/res/xml/image_picker_provider_paths.xml

@@ -3,4 +3,8 @@
     <external-path
         name="external_files"
         path="." />
+
+    <external-cache-path
+        name="external_files"
+        path="." />
 </paths>

sample/src/main/kotlin/com.github.dhaval2404.imagepicker/sample/MainActivity.kt

@@ -13,11 +13,11 @@ import androidx.appcompat.app.AppCompatActivity
 import com.github.dhaval2404.imagepicker.ImagePicker
 import com.github.dhaval2404.imagepicker.sample.util.FileUtil
 import com.github.dhaval2404.imagepicker.sample.util.IntentUtil
-import java.io.File
 import kotlinx.android.synthetic.main.activity_main.*
 import kotlinx.android.synthetic.main.content_camera_only.*
 import kotlinx.android.synthetic.main.content_gallery_only.*
 import kotlinx.android.synthetic.main.content_profile.*
+import java.io.File
 
 class MainActivity : AppCompatActivity() {
 
@@ -71,6 +71,14 @@ class MainActivity : AppCompatActivity() {
             .crop()
             // User can only select image from Gallery
             .galleryOnly()
+
+            .galleryMimeTypes(  //no gif images at all
+                mimeTypes = arrayOf(
+                    "image/png",
+                    "image/jpg",
+                    "image/jpeg"
+                )
+            )
             // Image resolution will be less than 1080 x 1920
             .maxResultSize(1080, 1920)
             .start(GALLERY_IMAGE_REQ_CODE)