GSoC 2021 custom picture selector

app/build.gradle

@@ -93,6 +93,7 @@ dependencies {
     testImplementation "org.junit.jupiter:junit-jupiter-api:5.3.1"
     testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:5.3.1"
     testImplementation 'com.facebook.soloader:soloader:0.9.0'
+    testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-test:1.4.2"
 
     // Android testing
     androidTestImplementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$KOTLIN_VERSION"
@@ -142,6 +143,10 @@ dependencies {
     def work_version = "2.4.0"
     // Kotlin + coroutines
     implementation "androidx.work:work-runtime-ktx:$work_version"
+
+    //Glide
+    implementation 'com.github.bumptech.glide:glide:4.12.0'
+    annotationProcessor 'com.github.bumptech.glide:compiler:4.12.0'
 }
 
 android {
@@ -204,7 +209,7 @@ android {
             }
         }
         debug {
-            minifyEnabled true
+            minifyEnabled false
             testCoverageEnabled project.hasProperty('coverage')
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.txt'
             testProguardFile 'test-proguard-rules.txt'

app/src/main/AndroidManifest.xml

@@ -110,6 +110,12 @@
         <activity android:name=".quiz.QuizResultActivity"
             android:label="@string/result"/>
 
+        <activity
+            android:name=".customselector.ui.selector.CustomSelectorActivity"
+            android:label="@string/title_activity_custom_selector"
+            android:configChanges="screenSize|keyboard|orientation"
+            android:parentActivityName=".contributions.MainActivity" />
+
         <activity
             android:name=".category.CategoryDetailsActivity"
             android:label="@string/title_activity_featured_images"

app/src/main/java/fr/free/nrw/commons/contributions/Contribution.kt

@@ -39,7 +39,8 @@ data class Contribution constructor(
     var dataLength: Long = 0,
     var dateCreated: Date? = null,
     var dateModified: Date? = null,
-    var hasInvalidLocation : Int =  0
+    var hasInvalidLocation : Int =  0,
+    var contentUri: Uri? = null
 ) : Parcelable {
 
     fun completeWith(media: Media): Contribution {
@@ -64,7 +65,8 @@ data class Contribution constructor(
         decimalCoords = item.gpsCoords.decimalCoords,
         dateCreatedSource = "",
         depictedItems = depictedItems,
-        wikidataPlace = from(item.place)
+        wikidataPlace = from(item.place),
+        contentUri = item.contentUri
     )
 
     /**

app/src/main/java/fr/free/nrw/commons/contributions/ContributionController.java

@@ -58,6 +58,20 @@ public void initiateGalleryPick(final Activity activity, final boolean allowMult
         initiateGalleryUpload(activity, allowMultipleUploads);
     }
 
+    /**
+     * Initiate gallery picker with permission
+     */
+    public void initiateCustomGalleryPickWithPermission(final Activity activity) {
+        setPickerConfiguration(activity,true);
+
+        PermissionUtils.checkPermissionsAndPerformAction(activity,
+            Manifest.permission.WRITE_EXTERNAL_STORAGE,
+            () -> FilePicker.openCustomSelector(activity, 0),
+            R.string.storage_permission_title,
+            R.string.write_storage_permission_rationale);
+    }
+
+
     /**
      * Open chooser for gallery uploads
      */

app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListFragment.java

@@ -5,6 +5,7 @@
 import static fr.free.nrw.commons.di.NetworkingModule.NAMED_LANGUAGE_WIKI_PEDIA_WIKI_SITE;
 
 import android.content.Context;
+import android.content.Intent;
 import android.content.res.Configuration;
 import android.net.Uri;
 import android.os.Bundle;
@@ -29,13 +30,16 @@
 import androidx.recyclerview.widget.SimpleItemAnimator;
 import butterknife.BindView;
 import butterknife.ButterKnife;
+import butterknife.OnClick;
 import com.google.android.material.floatingactionbutton.FloatingActionButton;
 import fr.free.nrw.commons.Media;
 import fr.free.nrw.commons.R;
 import fr.free.nrw.commons.Utils;
+import fr.free.nrw.commons.customselector.ui.selector.CustomSelectorActivity;
 import fr.free.nrw.commons.di.CommonsDaggerSupportFragment;
 import fr.free.nrw.commons.utils.DialogUtil;
 import fr.free.nrw.commons.media.MediaClient;
+import fr.free.nrw.commons.utils.SystemThemeUtils;
 import fr.free.nrw.commons.utils.ViewUtil;
 import java.util.Locale;
 import javax.inject.Inject;
@@ -52,7 +56,7 @@ public class ContributionsListFragment extends CommonsDaggerSupportFragment impl
     WikipediaInstructionsDialogFragment.Callback {
 
     private static final String RV_STATE = "rv_scroll_state";
-
+      
     @BindView(R.id.contributionsList)
     RecyclerView rvContributionsList;
     @BindView(R.id.loadingContributionsProgressBar)
@@ -67,6 +71,11 @@ public class ContributionsListFragment extends CommonsDaggerSupportFragment impl
     TextView noContributionsYet;
     @BindView(R.id.fab_layout)
     LinearLayout fab_layout;
+    @BindView(R.id.fab_custom_gallery)
+    FloatingActionButton fabCustomGallery;
+
+    @Inject
+    SystemThemeUtils systemThemeUtils;
 
     @Inject
     ContributionController controller;
@@ -260,23 +269,35 @@ private void setListeners() {
         });
     }
 
+    /**
+     * Launch Custom Selector.
+     */
+    @OnClick(R.id.fab_custom_gallery)
+    void launchCustomSelector(){
+        controller.initiateCustomGalleryPickWithPermission(getActivity());
+    }
+
     private void animateFAB(final boolean isFabOpen) {
         this.isFabOpen = !isFabOpen;
         if (fabPlus.isShown()) {
-            if (isFabOpen) {
-                fabPlus.startAnimation(rotate_backward);
-                fabCamera.startAnimation(fab_close);
-                fabGallery.startAnimation(fab_close);
-                fabCamera.hide();
-                fabGallery.hide();
-            } else {
-                fabPlus.startAnimation(rotate_forward);
-                fabCamera.startAnimation(fab_open);
-                fabGallery.startAnimation(fab_open);
-                fabCamera.show();
-                fabGallery.show();
-            }
-            this.isFabOpen = !isFabOpen;
+        if (isFabOpen) {
+            fabPlus.startAnimation(rotate_backward);
+            fabCamera.startAnimation(fab_close);
+            fabGallery.startAnimation(fab_close);
+            fabCustomGallery.startAnimation(fab_close);
+            fabCamera.hide();
+            fabGallery.hide();
+            fabCustomGallery.hide();
+        } else {
+            fabPlus.startAnimation(rotate_forward);
+            fabCamera.startAnimation(fab_open);
+            fabGallery.startAnimation(fab_open);
+            fabCustomGallery.startAnimation(fab_open);
+            fabCamera.show();
+            fabGallery.show();
+            fabCustomGallery.show();
+        }
+        this.isFabOpen = !isFabOpen;
         }
     }
 

app/src/main/java/fr/free/nrw/commons/customselector/database/UploadedDao.kt

@@ -0,0 +1,56 @@
+package fr.free.nrw.commons.customselector.database
+
+import androidx.room.*
+import java.util.*
+
+/**
+ * UploadedStatusDao for Custom Selector.
+ */
+@Dao
+abstract class UploadedStatusDao {
+
+    /**
+     * Insert into uploaded status.
+     */
+    @Insert( onConflict = OnConflictStrategy.REPLACE )
+    abstract suspend fun insert(uploadedStatus: UploadedStatus)
+
+    /**
+     * Update uploaded status entry.
+     */
+    @Update
+    abstract suspend fun update(uploadedStatus: UploadedStatus)
+
+    /**
+     * Delete uploaded status entry.
+     */
+    @Delete
+    abstract suspend fun delete(uploadedStatus: UploadedStatus)
+
+    /**
+     * Query uploaded status with image sha1.
+     */
+    @Query("SELECT * FROM uploaded_table WHERE imageSHA1 = (:imageSHA1) ")
+    abstract suspend fun getFromImageSHA1(imageSHA1 : String) : UploadedStatus?
+
+    /**
+     * Query uploaded status with modified image sha1.
+     */
+    @Query("SELECT * FROM uploaded_table WHERE modifiedImageSHA1 = (:modifiedImageSHA1) ")
+    abstract suspend fun getFromModifiedImageSHA1(modifiedImageSHA1 : String) : UploadedStatus?
+
+    /**
+     * Asynchronous insert into uploaded status table.
+     */
+    suspend fun insertUploaded(uploadedStatus: UploadedStatus) {
+        uploadedStatus.lastUpdated = Calendar.getInstance().time
+        insert(uploadedStatus)
+    }
+
+    /**
+     * Asynchronous image sha1 query.
+     */
+    suspend fun getUploadedFromImageSHA1(imageSHA1: String):UploadedStatus? {
+        return getFromImageSHA1(imageSHA1)
+    }
+}

app/src/main/java/fr/free/nrw/commons/customselector/database/UploadedStatus.kt

@@ -0,0 +1,39 @@
+package fr.free.nrw.commons.customselector.database
+
+import androidx.room.Entity
+import androidx.room.Index
+import androidx.room.PrimaryKey
+import java.util.*
+
+/**
+ * Entity class for Uploaded Status.
+ */
+@Entity(tableName = "uploaded_table", indices = [Index(value = ["modifiedImageSHA1"], unique = true)])
+data class UploadedStatus(
+
+    /**
+     * Original image sha1.
+     */
+    @PrimaryKey
+    val imageSHA1 : String,
+
+    /**
+     * Modified image sha1 (after exif changes).
+     */
+    val modifiedImageSHA1 : String,
+
+    /**
+     * imageSHA1 query result from API.
+     */
+    var imageResult : Boolean,
+
+    /**
+     * modifiedImageSHA1 query result from API.
+     */
+    var modifiedImageResult : Boolean,
+
+    /**
+     * lastUpdated for data validation.
+     */
+    var lastUpdated : Date? = null
+)

app/src/main/java/fr/free/nrw/commons/customselector/helper/ImageHelper.kt

@@ -0,0 +1,79 @@
+package fr.free.nrw.commons.customselector.helper
+
+import fr.free.nrw.commons.customselector.model.Folder
+import fr.free.nrw.commons.customselector.model.Image
+
+/**
+ * Image Helper object, includes all the static functions required by custom selector.
+ */
+object ImageHelper {
+
+    /**
+     * Returns the list of folders from given image list.
+     */
+    fun folderListFromImages(images: List<Image>): ArrayList<Folder> {
+        val folderMap: MutableMap<Long, Folder> = LinkedHashMap()
+        for (image in images) {
+            val bucketId = image.bucketId
+            val bucketName = image.bucketName
+            var folder = folderMap[bucketId]
+            if (folder == null) {
+                folder = Folder(bucketId, bucketName)
+                folderMap[bucketId] = folder
+            }
+            folder.images.add(image)
+        }
+        return ArrayList(folderMap.values)
+    }
+
+    /**
+     * Filters the images based on the given bucketId (folder)
+     */
+    fun filterImages(images: ArrayList<Image>, bukketId: Long?): ArrayList<Image> {
+        if (bukketId == null) return images
+
+        val filteredImages = arrayListOf<Image>()
+        for (image in images) {
+            if (image.bucketId == bukketId) {
+                filteredImages.add(image)
+            }
+        }
+        return filteredImages
+    }
+
+    /**
+     * getIndex: Returns the index of image in given list.
+     */
+    fun getIndex(list: ArrayList<Image>, image: Image): Int {
+        return list.indexOf(image)
+    }
+
+    /**
+     * getIndex: Returns the index of image in given list.
+     */
+    fun getIndexFromId(list: ArrayList<Image>, imageId: Long): Int {
+        for(i in list){
+            if(i.id == imageId)
+                return list.indexOf(i)
+        }
+        return 0;
+    }
+
+    /**
+     * Gets the list of indices from the master list.
+     */
+    fun getIndexList(list: ArrayList<Image>, masterList: ArrayList<Image>): ArrayList<Int> {
+
+         // Can be optimised as masterList is sorted by time.
+
+        val indexes = arrayListOf<Int>()
+        for(image in list) {
+            val index = getIndex(masterList, image)
+            if (index == -1) {
+                continue
+            }
+            indexes.add(index)
+        }
+        return indexes
+    }
+}

app/src/main/java/fr/free/nrw/commons/customselector/listeners/FolderClickListener.kt

@@ -0,0 +1,15 @@
+package fr.free.nrw.commons.customselector.listeners
+
+/**
+ * Custom Selector Folder Click Listener
+ */
+interface FolderClickListener {
+
+    /**
+     * onFolderClick
+     * @param folderId : folder id of the folder.
+     * @param folderName : folder name of the folder.
+     * @param lastItemId : last scroll position in the folder.
+     */
+    fun onFolderClick(folderId: Long, folderName: String, lastItemId: Long)
+}

app/src/main/java/fr/free/nrw/commons/customselector/listeners/ImageLoaderListener.kt

@@ -0,0 +1,22 @@
+package fr.free.nrw.commons.customselector.listeners
+
+import fr.free.nrw.commons.customselector.model.Image
+
+/**
+ * Custom Selector Image Loader Listener
+ * responds to the device image query.
+ */
+interface ImageLoaderListener {
+
+    /**
+     * On image loaded
+     * @param images : queried device images.
+     */
+    fun onImageLoaded(images: ArrayList<Image>)
+
+    /**
+     * On failed
+     * @param throwable : throwable exception on failure.
+     */
+    fun onFailed(throwable: Throwable)
+}