diff --git a/app/build.gradle b/app/build.gradle index c6f34cc68..0ccc38f60 100644 --- a/app/build.gradle +++ b/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' diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml index cc6576aad..a2c33778f 100644 --- a/app/src/main/AndroidManifest.xml +++ b/app/src/main/AndroidManifest.xml @@ -110,6 +110,12 @@ + + FilePicker.openCustomSelector(activity, 0), + R.string.storage_permission_title, + R.string.write_storage_permission_rationale); + } + + /** * Open chooser for gallery uploads */ diff --git a/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListFragment.java b/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListFragment.java index 5cc900931..44b042436 100644 --- a/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListFragment.java +++ b/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListFragment.java @@ -5,6 +5,7 @@ import static android.view.View.VISIBLE; 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.RecyclerView.OnItemTouchListener; 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 @@ public class ContributionsListFragment extends CommonsDaggerSupportFragment impl }); } + /** + * 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; } } diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/database/UploadedDao.kt b/app/src/main/java/fr/free/nrw/commons/customselector/database/UploadedDao.kt new file mode 100644 index 000000000..49a1f61c3 --- /dev/null +++ b/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) + } +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/database/UploadedStatus.kt b/app/src/main/java/fr/free/nrw/commons/customselector/database/UploadedStatus.kt new file mode 100644 index 000000000..93e4a8243 --- /dev/null +++ b/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 +) diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/helper/ImageHelper.kt b/app/src/main/java/fr/free/nrw/commons/customselector/helper/ImageHelper.kt new file mode 100644 index 000000000..06ec4c36c --- /dev/null +++ b/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): ArrayList { + val folderMap: MutableMap = 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, bukketId: Long?): ArrayList { + if (bukketId == null) return images + + val filteredImages = arrayListOf() + 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): Int { + return list.indexOf(image) + } + + /** + * getIndex: Returns the index of image in given list. + */ + fun getIndexFromId(list: ArrayList, 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, masterList: ArrayList): ArrayList { + + // Can be optimised as masterList is sorted by time. + + val indexes = arrayListOf() + for(image in list) { + val index = getIndex(masterList, image) + if (index == -1) { + continue + } + indexes.add(index) + } + return indexes + } +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/listeners/FolderClickListener.kt b/app/src/main/java/fr/free/nrw/commons/customselector/listeners/FolderClickListener.kt new file mode 100644 index 000000000..bc3bd518d --- /dev/null +++ b/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) +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/listeners/ImageLoaderListener.kt b/app/src/main/java/fr/free/nrw/commons/customselector/listeners/ImageLoaderListener.kt new file mode 100644 index 000000000..5ba43082d --- /dev/null +++ b/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) + + /** + * On failed + * @param throwable : throwable exception on failure. + */ + fun onFailed(throwable: Throwable) +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/listeners/ImageSelectListener.kt b/app/src/main/java/fr/free/nrw/commons/customselector/listeners/ImageSelectListener.kt new file mode 100644 index 000000000..1d7310b1d --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/listeners/ImageSelectListener.kt @@ -0,0 +1,22 @@ +package fr.free.nrw.commons.customselector.listeners + +import android.net.Uri +import fr.free.nrw.commons.customselector.model.Image + +/** + * Custom selector Image select listener + */ +interface ImageSelectListener { + + /** + * onSelectedImagesChanged + * @param selectedImages : new selected images. + */ + fun onSelectedImagesChanged(selectedImages: ArrayList) + + /** + * onLongPress + * @param imageUri : uri of image + */ + fun onLongPress(imageUri: Uri) +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/model/CallbackStatus.kt b/app/src/main/java/fr/free/nrw/commons/customselector/model/CallbackStatus.kt new file mode 100644 index 000000000..5cdcfb9bf --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/model/CallbackStatus.kt @@ -0,0 +1,22 @@ +package fr.free.nrw.commons.customselector.model + +/** + * sealed class Callback Status. + * Current status of the device image query. + */ +sealed class CallbackStatus { + /** + IDLE : The callback is idle , doing nothing. + */ + object IDLE : CallbackStatus() + + /** + FETCHING : Fetching images. + */ + object FETCHING : CallbackStatus() + + /** + SUCCESS : Success fetching images. + */ + object SUCCESS : CallbackStatus() +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/model/Folder.kt b/app/src/main/java/fr/free/nrw/commons/customselector/model/Folder.kt new file mode 100644 index 000000000..6857589bd --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/model/Folder.kt @@ -0,0 +1,47 @@ +package fr.free.nrw.commons.customselector.model + +/** + * Custom selector data class Folder. + */ +data class Folder( + /** + bucketId : Unique directory id, eg 540528482 + */ + var bucketId: Long, + + /** + name : bucket/folder name, eg Camera + */ + var name: String, + + /** + images : folder images, list of all images under this folder. + */ + var images: ArrayList = arrayListOf() + + +) { + /** + * Indicates whether some other object is "equal to" this one. + */ + override fun equals(other: Any?): Boolean { + + if (javaClass != other?.javaClass) { + return false + } + + other as Folder + + if (bucketId != other.bucketId) { + return false + } + if (name != other.name) { + return false + } + if (images != other.images) { + return false + } + + return true + } +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/model/Image.kt b/app/src/main/java/fr/free/nrw/commons/customselector/model/Image.kt new file mode 100644 index 000000000..12e75580d --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/model/Image.kt @@ -0,0 +1,128 @@ +package fr.free.nrw.commons.customselector.model + +import android.net.Uri +import android.os.Parcel +import android.os.Parcelable + +/** + * Custom selector data class Image. + */ +data class Image( + /** + id : Unique image id, primary key of image in device, eg 104950 + */ + var id: Long, + + /** + name : Name of the image with extension, eg CommonsLogo.jpeg + */ + var name: String, + + /** + uri : Uri of the image, points to image location or name, eg content://media/external/images/camera/10495 (Android 10) + */ + var uri: Uri, + + /** + path : System path of the image, eg storage/emulated/0/camera/CommonsLogo.jpeg + */ + var path: String, + + /** + bucketId : bucketId of folder, eg 540528482 + */ + var bucketId: Long = 0, + + /** + bucketName : name of folder, eg Camera + */ + var bucketName: String = "", + + /** + sha1 : sha1 of original image. + */ + var sha1: String = "" +) : Parcelable { + + /** + default parcelable constructor. + */ + constructor(parcel: Parcel): + this(parcel.readLong(), + parcel.readString()!!, + parcel.readParcelable(Uri::class.java.classLoader)!!, + parcel.readString()!!, + parcel.readLong(), + parcel.readString()!!, + parcel.readString()!! + ) + + /** + Write to parcel method. + */ + override fun writeToParcel(parcel: Parcel, flags: Int) { + parcel.writeLong(id) + parcel.writeString(name) + parcel.writeParcelable(uri, flags) + parcel.writeString(path) + parcel.writeLong(bucketId) + parcel.writeString(bucketName) + parcel.writeString(sha1) + } + + /** + * Describe the kinds of special objects contained in this Parcelable + */ + override fun describeContents(): Int { + return 0 + } + + /** + * Indicates whether some other object is "equal to" this one. + */ + override fun equals(other: Any?): Boolean { + + if(javaClass != other?.javaClass) { + return false + } + + other as Image + + if(id != other.id) { + return false; + } + if(name != other.name) { + return false; + } + if(uri != other.uri) { + return false; + } + if(path != other.path) { + return false; + } + if(bucketId != other.bucketId) { + return false; + } + if(bucketName != other.bucketName) { + return false; + } + if(sha1 != other.sha1) { + return false; + } + + return true + } + + /** + * Parcelable companion object + */ + companion object CREATOR : Parcelable.Creator { + override fun createFromParcel(parcel: Parcel): Image { + return Image(parcel) + } + + override fun newArray(size: Int): Array { + return arrayOfNulls(size) + } + } +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/model/Result.kt b/app/src/main/java/fr/free/nrw/commons/customselector/model/Result.kt new file mode 100644 index 000000000..11ed8ef00 --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/model/Result.kt @@ -0,0 +1,16 @@ +package fr.free.nrw.commons.customselector.model + +/** + * Custom selector data class Result. + */ +data class Result( + /** + * CallbackStatus : stores the result status + */ + val status:CallbackStatus, + + /** + * Images : images retrieved + */ + val images: ArrayList) { +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/adapter/FolderAdapter.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/adapter/FolderAdapter.kt new file mode 100644 index 000000000..60d299491 --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/ui/adapter/FolderAdapter.kt @@ -0,0 +1,163 @@ +package fr.free.nrw.commons.customselector.ui.adapter + +import android.content.Context +import android.view.View +import android.view.ViewGroup +import android.widget.ImageView +import android.widget.TextView +import androidx.recyclerview.widget.DiffUtil +import androidx.recyclerview.widget.RecyclerView +import com.bumptech.glide.Glide +import fr.free.nrw.commons.R +import fr.free.nrw.commons.customselector.listeners.FolderClickListener +import fr.free.nrw.commons.customselector.model.Folder +import fr.free.nrw.commons.customselector.model.Image + +/** + * Custom selector FolderAdapter. + */ +class FolderAdapter( + /** + * Application context. + */ + context: Context, + + /** + * Folder Click listener for click events. + */ + private val itemClickListener: FolderClickListener + +) : RecyclerViewAdapter(context) { + + /** + * List of folders. + */ + private var folders: MutableList = mutableListOf() + + /** + * Create view holder, returns View holder item. + */ + override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): FolderViewHolder { + val itemView = inflater.inflate(R.layout.item_custom_selector_folder, parent, false) + return FolderViewHolder(itemView) + } + + /** + * Bind view holder, setup the item view, title, count and click listener + */ + override fun onBindViewHolder(holder: FolderViewHolder, position: Int) { + val folder = folders[position] + val toBeRemoved = ArrayList() + + for(image in folder.images) { + // Remove all the top images that do not exist anymore + if(context.contentResolver.getType(image.uri) == null){ + // File not found + toBeRemoved.add(image) + } else { + break + } + } + holder.image.setImageDrawable (null) + folder.images.removeAll(toBeRemoved) + val count = folder.images.size + + if(count == 0) { + // Folder is empty, remove folder from the adapter. + holder.itemView.post{ + val updatePosition = folders.indexOf(folder) + folders.removeAt(updatePosition) + notifyItemRemoved(updatePosition) + notifyItemRangeChanged(updatePosition, folders.size) + } + } else { + val previewImage = folder.images[0] + Glide.with(holder.image).load(previewImage.uri).into(holder.image) + holder.name.text = folder.name + holder.count.text = count.toString() + holder.itemView.setOnClickListener { + itemClickListener.onFolderClick(folder.bucketId, folder.name, 0) + } + } + } + + /** + * Initialise the data set. + */ + fun init(newFolders: List) { + val oldFolderList: MutableList = folders + val newFolderList = newFolders.toMutableList() + val diffResult = DiffUtil.calculateDiff( + FoldersDiffCallback(oldFolderList, newFolderList) + ) + folders = newFolderList + diffResult.dispatchUpdatesTo(this) + } + + /** + * returns item count. + */ + override fun getItemCount(): Int { + return folders.size + } + + /** + * Folder view holder. + */ + class FolderViewHolder(itemView:View) : RecyclerView.ViewHolder(itemView) { + + /** + * Folder thumbnail image view. + */ + val image: ImageView = itemView.findViewById(R.id.folder_thumbnail) + + /** + * Folder/album name + */ + val name: TextView = itemView.findViewById(R.id.folder_name) + + /** + * Item count in Folder/Item + */ + val count: TextView = itemView.findViewById(R.id.folder_count) + } + + /** + * DiffUtilCallback. + */ + class FoldersDiffCallback( + var oldFolders: MutableList, + var newFolders: MutableList + ) : DiffUtil.Callback() { + /** + * Returns the size of the old list. + */ + override fun getOldListSize(): Int { + return oldFolders.size + } + + /** + * Returns the size of the new list. + */ + override fun getNewListSize(): Int { + return newFolders.size + } + + /** + * Called by the DiffUtil to decide whether two object represent the same Item. + */ + override fun areItemsTheSame(oldItemPosition: Int, newItemPosition: Int): Boolean { + return oldFolders.get(oldItemPosition).bucketId == newFolders.get(newItemPosition).bucketId + } + + /** + * Called by the DiffUtil when it wants to check whether two items have the same data. + * DiffUtil uses this information to detect if the contents of an item has changed. + */ + override fun areContentsTheSame(oldItemPosition: Int, newItemPosition: Int): Boolean { + return oldFolders.get(oldItemPosition).equals(newFolders.get(newItemPosition)) + } + + } + +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/adapter/ImageAdapter.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/adapter/ImageAdapter.kt new file mode 100644 index 000000000..f3fce1cc0 --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/ui/adapter/ImageAdapter.kt @@ -0,0 +1,236 @@ +package fr.free.nrw.commons.customselector.ui.adapter + +import android.content.Context +import android.view.View +import android.view.ViewGroup +import android.widget.ImageView +import android.widget.TextView +import android.widget.Toast +import androidx.constraintlayout.widget.Group +import androidx.recyclerview.widget.DiffUtil +import androidx.recyclerview.widget.RecyclerView +import com.bumptech.glide.Glide +import fr.free.nrw.commons.R +import fr.free.nrw.commons.customselector.helper.ImageHelper +import fr.free.nrw.commons.customselector.listeners.ImageSelectListener +import fr.free.nrw.commons.customselector.model.Image +import fr.free.nrw.commons.customselector.ui.selector.ImageLoader + +/** + * Custom selector ImageAdapter. + */ +class ImageAdapter( + /** + * Application Context. + */ + context: Context, + + /** + * Image select listener for click events on image. + */ + private var imageSelectListener: ImageSelectListener, + + /** + * ImageLoader queries images. + */ + private var imageLoader: ImageLoader +): + + RecyclerViewAdapter(context) { + + /** + * ImageSelectedOrUpdated payload class. + */ + class ImageSelectedOrUpdated + + /** + * ImageUnselected payload class. + */ + class ImageUnselected + + /** + * Currently selected images. + */ + private var selectedImages = arrayListOf() + + /** + * List of all images in adapter. + */ + private var images: ArrayList = ArrayList() + + /** + * Create View holder. + */ + override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ImageViewHolder { + val itemView = inflater.inflate(R.layout.item_custom_selector_image, parent, false) + return ImageViewHolder(itemView) + } + + /** + * Bind View holder, load image, selected view, click listeners. + */ + override fun onBindViewHolder(holder: ImageViewHolder, position: Int) { + val image=images[position] + holder.image.setImageDrawable (null) + if (context.contentResolver.getType(image.uri) == null) { + // Image does not exist anymore, update adapter. + holder.itemView.post { + val updatedPosition = images.indexOf(image) + images.remove(image) + notifyItemRemoved(updatedPosition) + notifyItemRangeChanged(updatedPosition, images.size) + } + } else { + val selectedIndex = ImageHelper.getIndex(selectedImages, image) + val isSelected = selectedIndex != -1 + if (isSelected) { + holder.itemSelected(selectedIndex + 1) + } else { + holder.itemUnselected(); + } + Glide.with(holder.image).load(image.uri).thumbnail(0.3f).into(holder.image) + imageLoader.queryAndSetView(holder, image) + holder.itemView.setOnClickListener { + selectOrRemoveImage(holder, position) + } + + // launch media preview on long click. + holder.itemView.setOnLongClickListener { + imageSelectListener.onLongPress(image.uri) + true + } + } + } + + /** + * Handle click event on an image, update counter on images. + */ + private fun selectOrRemoveImage(holder: ImageViewHolder, position: Int){ + val clickedIndex = ImageHelper.getIndex(selectedImages, images[position]) + if (clickedIndex != -1) { + selectedImages.removeAt(clickedIndex) + notifyItemChanged(position, ImageUnselected()) + val indexes = ImageHelper.getIndexList(selectedImages, images) + for (index in indexes) { + notifyItemChanged(index, ImageSelectedOrUpdated()) + } + } else { + if(holder.isItemUploaded()){ + Toast.makeText(context, R.string.custom_selector_already_uploaded_image_text, Toast.LENGTH_SHORT).show() + } else { + selectedImages.add(images[position]) + notifyItemChanged(position, ImageSelectedOrUpdated()) + } + } + imageSelectListener.onSelectedImagesChanged(selectedImages) + } + + /** + * Initialize the data set. + */ + fun init(newImages: List) { + val oldImageList:ArrayList = images + val newImageList:ArrayList = ArrayList(newImages) + val diffResult = DiffUtil.calculateDiff( + ImagesDiffCallback(oldImageList, newImageList) + ) + images = newImageList + diffResult.dispatchUpdatesTo(this) + } + + /** + * Returns the total number of items in the data set held by the adapter. + * + * @return The total number of items in this adapter. + */ + override fun getItemCount(): Int { + return images.size + } + + fun getImageIdAt(position: Int): Long { + return images.get(position).id + } + + /** + * Image view holder. + */ + class ImageViewHolder(itemView: View): RecyclerView.ViewHolder(itemView) { + val image: ImageView = itemView.findViewById(R.id.image_thumbnail) + private val selectedNumber: TextView = itemView.findViewById(R.id.selected_count) + private val uploadedGroup: Group = itemView.findViewById(R.id.uploaded_group) + private val selectedGroup: Group = itemView.findViewById(R.id.selected_group) + + /** + * Item selected view. + */ + fun itemSelected(index: Int) { + selectedGroup.visibility = View.VISIBLE + selectedNumber.text = index.toString() + } + + /** + * Item Unselected view. + */ + fun itemUnselected() { + selectedGroup.visibility = View.GONE + } + + /** + * Item Uploaded view. + */ + fun itemUploaded() { + uploadedGroup.visibility = View.VISIBLE + } + + fun isItemUploaded():Boolean { + return uploadedGroup.visibility == View.VISIBLE + } + /** + * Item Not Uploaded view. + */ + fun itemNotUploaded() { + uploadedGroup.visibility = View.GONE + } + + } + + /** + * DiffUtilCallback. + */ + class ImagesDiffCallback( + var oldImageList: ArrayList, + var newImageList: ArrayList + ) : DiffUtil.Callback(){ + + /** + * Returns the size of the old list. + */ + override fun getOldListSize(): Int { + return oldImageList.size + } + + /** + * Returns the size of the new list. + */ + override fun getNewListSize(): Int { + return newImageList.size + } + + /** + * Called by the DiffUtil to decide whether two object represent the same Item. + */ + override fun areItemsTheSame(oldItemPosition: Int, newItemPosition: Int): Boolean { + return newImageList[newItemPosition].id == oldImageList[oldItemPosition].id + } + + /** + * Called by the DiffUtil when it wants to check whether two items have the same data. + * DiffUtil uses this information to detect if the contents of an item has changed. + */ + override fun areContentsTheSame(oldItemPosition: Int, newItemPosition: Int): Boolean { + return oldImageList[oldItemPosition].equals(newImageList[newItemPosition]) + } + + } + +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/adapter/RecyclerViewAdapter.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/adapter/RecyclerViewAdapter.kt new file mode 100644 index 000000000..75f935302 --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/ui/adapter/RecyclerViewAdapter.kt @@ -0,0 +1,12 @@ +package fr.free.nrw.commons.customselector.ui.adapter + +import android.content.Context +import android.view.LayoutInflater +import androidx.recyclerview.widget.RecyclerView + +/** + * Generic Recycler view adapter. + */ +abstract class RecyclerViewAdapter(val context: Context): RecyclerView.Adapter() { + val inflater: LayoutInflater = LayoutInflater.from(context) +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorActivity.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorActivity.kt new file mode 100644 index 000000000..8dffe7306 --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorActivity.kt @@ -0,0 +1,235 @@ +package fr.free.nrw.commons.customselector.ui.selector + +import android.app.Activity +import android.app.Dialog +import android.content.Intent +import android.content.SharedPreferences +import android.net.Uri +import android.os.Bundle +import android.view.View +import android.view.Window +import android.widget.Button +import android.widget.ImageButton +import android.widget.TextView +import androidx.lifecycle.ViewModelProvider +import fr.free.nrw.commons.R +import fr.free.nrw.commons.customselector.listeners.FolderClickListener +import fr.free.nrw.commons.customselector.listeners.ImageSelectListener +import fr.free.nrw.commons.customselector.model.Image +import fr.free.nrw.commons.media.ZoomableActivity +import fr.free.nrw.commons.theme.BaseActivity +import java.io.File +import javax.inject.Inject + + +/** + * Custom Selector Activity. + */ +class CustomSelectorActivity: BaseActivity(), FolderClickListener, ImageSelectListener { + + /** + * View model. + */ + private lateinit var viewModel: CustomSelectorViewModel + + /** + * isImageFragmentOpen is true when the image fragment is in view. + */ + private var isImageFragmentOpen = false + + /** + * Current ImageFragment attributes. + */ + private var bucketId: Long = 0L + private lateinit var bucketName: String + + /** + * Pref for saving selector state. + */ + private lateinit var prefs: SharedPreferences + + /** + * View Model Factory. + */ + @Inject lateinit var customSelectorViewModelFactory: CustomSelectorViewModelFactory + + /** + * onCreate Activity, sets theme, initialises the view model, setup view. + */ + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + setContentView(R.layout.activity_custom_selector) + + prefs = applicationContext.getSharedPreferences("CustomSelector", MODE_PRIVATE) + viewModel = ViewModelProvider(this, customSelectorViewModelFactory).get( + CustomSelectorViewModel::class.java + ) + + setupViews() + + if(prefs.getBoolean("customSelectorFirstLaunch", true)) { + // show welcome dialog on first launch + showWelcomeDialog() + prefs.edit().putBoolean("customSelectorFirstLaunch", false).apply() + } + + // Open folder if saved in prefs. + if(prefs.contains(FOLDER_ID)){ + val lastOpenFolderId: Long = prefs.getLong(FOLDER_ID, 0L) + val lastOpenFolderName: String? = prefs.getString(FOLDER_NAME, null) + val lastItemId: Long = prefs.getLong(ITEM_ID, 0) + lastOpenFolderName?.let { onFolderClick(lastOpenFolderId, it, lastItemId) } + } + } + + /** + * Show Custom Selector Welcome Dialog. + */ + private fun showWelcomeDialog() { + val dialog = Dialog(this) + dialog.requestWindowFeature(Window.FEATURE_NO_TITLE) + dialog.setContentView(R.layout.custom_selector_info_dialog) + (dialog.findViewById(R.id.btn_ok) as Button).setOnClickListener { dialog.dismiss() } + dialog.show() + } + + /** + * Set up view, default folder view. + */ + private fun setupViews() { + supportFragmentManager.beginTransaction() + .replace(R.id.fragment_container, FolderFragment.newInstance()) + .commit() + fetchData() + setUpToolbar() + } + + /** + * Start data fetch in view model. + */ + private fun fetchData() { + viewModel.fetchImages() + } + + /** + * Change the title of the toolbar. + */ + private fun changeTitle(title: String) { + val titleText = findViewById(R.id.title) + if(titleText != null) { + titleText.text = title + } + } + + /** + * Set up the toolbar, back listener, done listener. + */ + private fun setUpToolbar() { + val back : ImageButton = findViewById(R.id.back) + back.setOnClickListener { onBackPressed() } + + val done : ImageButton = findViewById(R.id.done) + done.setOnClickListener { onDone() } + } + + /** + * override on folder click, change the toolbar title on folder click. + */ + override fun onFolderClick(folderId: Long, folderName: String, lastItemId: Long) { + supportFragmentManager.beginTransaction() + .add(R.id.fragment_container, ImageFragment.newInstance(folderId, lastItemId)) + .addToBackStack(null) + .commit() + + changeTitle(folderName) + + bucketId = folderId + bucketName = folderName + isImageFragmentOpen = true + } + + /** + * override Selected Images Change, update view model selected images. + */ + override fun onSelectedImagesChanged(selectedImages: ArrayList) { + viewModel.selectedImages.value = selectedImages + + val done : ImageButton = findViewById(R.id.done) + done.visibility = if (selectedImages.isEmpty()) View.INVISIBLE else View.VISIBLE + } + + /** + * onLongPress + * @param imageUri : uri of image + */ + override fun onLongPress(imageUri: Uri) { + val intent = Intent(this, ZoomableActivity::class.java).setData(imageUri); + startActivity(intent) + } + + /** + * OnDone clicked. + * Get the selected images. Remove any non existent file, forward the data to finish selector. + */ + fun onDone() { + val selectedImages = viewModel.selectedImages.value + if(selectedImages.isNullOrEmpty()) { + finishPickImages(arrayListOf()) + return + } + var i = 0 + while (i < selectedImages.size) { + val path = selectedImages[i].path + val file = File(path) + if (!file.exists()) { + selectedImages.removeAt(i) + i-- + } + i++ + } + finishPickImages(selectedImages) + } + + /** + * finishPickImages, Load the data to the intent and set result. + * Finish the activity. + */ + private fun finishPickImages(images: ArrayList) { + val data = Intent() + data.putParcelableArrayListExtra("Images", images) + setResult(Activity.RESULT_OK, data) + finish() + } + + /** + * Back pressed. + * Change toolbar title. + */ + override fun onBackPressed() { + super.onBackPressed() + val fragment = supportFragmentManager.findFragmentById(R.id.fragment_container) + if(fragment != null && fragment is FolderFragment){ + isImageFragmentOpen = false + changeTitle(getString(R.string.custom_selector_title)) + } + } + + /** + * On activity destroy + * If image fragment is open, overwrite its attributes otherwise discard the values. + */ + override fun onDestroy() { + if(isImageFragmentOpen){ + prefs.edit().putLong(FOLDER_ID, bucketId).putString(FOLDER_NAME, bucketName).apply() + } else { + prefs.edit().remove(FOLDER_ID).remove(FOLDER_NAME).apply() + } + super.onDestroy() + } + + companion object { + const val FOLDER_ID : String = "FolderId" + const val FOLDER_NAME : String = "FolderName" + const val ITEM_ID : String = "ItemId" + } +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorViewModel.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorViewModel.kt new file mode 100644 index 000000000..cd7858d1b --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorViewModel.kt @@ -0,0 +1,58 @@ +package fr.free.nrw.commons.customselector.ui.selector + +import android.content.Context +import androidx.lifecycle.MutableLiveData +import androidx.lifecycle.ViewModel +import fr.free.nrw.commons.customselector.listeners.ImageLoaderListener +import fr.free.nrw.commons.customselector.model.CallbackStatus +import fr.free.nrw.commons.customselector.model.Image +import fr.free.nrw.commons.customselector.model.Result +import kotlinx.coroutines.CoroutineScope +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.cancel + +/** + * Custom Selector view model. + */ +class CustomSelectorViewModel(var context: Context,var imageFileLoader: ImageFileLoader) : ViewModel() { + + /** + * Scope for coroutine task (image fetch). + */ + private val scope = CoroutineScope(Dispatchers.Main) + + /** + * Stores selected images. + */ + var selectedImages: MutableLiveData> = MutableLiveData() + + /** + * Result Live Data. + */ + val result = MutableLiveData(Result(CallbackStatus.IDLE, arrayListOf())) + + /** + * Fetch Images and supply to result. + */ + fun fetchImages() { + result.postValue(Result(CallbackStatus.FETCHING, arrayListOf())) + scope.cancel() + imageFileLoader.loadDeviceImages(object: ImageLoaderListener { + override fun onImageLoaded(images: ArrayList) { + result.postValue(Result(CallbackStatus.SUCCESS, images)) + } + + override fun onFailed(throwable: Throwable) { + result.postValue(Result(CallbackStatus.SUCCESS, arrayListOf())) + } + },scope) + } + + /** + * Clear the coroutine task linked with context. + */ + override fun onCleared() { + scope.cancel() + super.onCleared() + } +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorViewModelFactory.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorViewModelFactory.kt new file mode 100644 index 000000000..d7a7d42f4 --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorViewModelFactory.kt @@ -0,0 +1,17 @@ +package fr.free.nrw.commons.customselector.ui.selector + +import android.content.Context +import androidx.lifecycle.ViewModel +import androidx.lifecycle.ViewModelProvider +import javax.inject.Inject + +/** + * View Model Factory. + */ +class CustomSelectorViewModelFactory @Inject constructor(val context: Context,val imageFileLoader: ImageFileLoader) : ViewModelProvider.Factory { + + override fun create(modelClass: Class) : CustomSelectorViewModel { + return CustomSelectorViewModel(context,imageFileLoader) as CustomSelectorViewModel + } + +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/FolderFragment.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/FolderFragment.kt new file mode 100644 index 000000000..456c14831 --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/FolderFragment.kt @@ -0,0 +1,142 @@ +package fr.free.nrw.commons.customselector.ui.selector + +import android.os.Bundle +import android.view.LayoutInflater +import android.view.View +import android.view.ViewGroup +import android.widget.ProgressBar +import androidx.lifecycle.Observer +import androidx.lifecycle.ViewModelProvider +import androidx.recyclerview.widget.GridLayoutManager +import androidx.recyclerview.widget.RecyclerView +import fr.free.nrw.commons.R +import fr.free.nrw.commons.customselector.helper.ImageHelper +import fr.free.nrw.commons.customselector.model.Result +import fr.free.nrw.commons.customselector.listeners.FolderClickListener +import fr.free.nrw.commons.customselector.model.CallbackStatus +import fr.free.nrw.commons.customselector.model.Folder +import fr.free.nrw.commons.customselector.ui.adapter.FolderAdapter +import fr.free.nrw.commons.di.CommonsDaggerSupportFragment +import fr.free.nrw.commons.media.MediaClient +import fr.free.nrw.commons.upload.FileProcessor +import kotlinx.android.synthetic.main.fragment_custom_selector.view.* +import javax.inject.Inject + +/** + * Custom selector folder fragment. + */ +class FolderFragment : CommonsDaggerSupportFragment() { + + /** + * View Model for images. + */ + private var viewModel: CustomSelectorViewModel? = null + + /** + * View Elements + */ + private var selectorRV: RecyclerView? = null + private var loader: ProgressBar? = null + + /** + * View Model Factory. + */ + var customSelectorViewModelFactory: CustomSelectorViewModelFactory? = null + @Inject set + + var fileProcessor: FileProcessor? = null + @Inject set + + var mediaClient: MediaClient? = null + @Inject set + /** + * Folder Adapter. + */ + private lateinit var folderAdapter: FolderAdapter + + /** + * Grid Layout Manager for recycler view. + */ + private lateinit var gridLayoutManager: GridLayoutManager + + /** + * Folder List. + */ + private lateinit var folders : ArrayList + + /** + * Companion newInstance. + */ + companion object{ + fun newInstance(): FolderFragment { + return FolderFragment() + } + } + + /** + * OnCreate Fragment, get the view model. + */ + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + + viewModel = ViewModelProvider(requireActivity(),customSelectorViewModelFactory!!).get(CustomSelectorViewModel::class.java) + + } + + /** + * OnCreateView. + * Inflate Layout, init adapter, init gridLayoutManager, setUp recycler view, observe the view model for result. + */ + override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? { + val root = inflater.inflate(R.layout.fragment_custom_selector, container, false) + folderAdapter = FolderAdapter(activity!!, activity as FolderClickListener) + gridLayoutManager = GridLayoutManager(context, columnCount()) + selectorRV = root.selector_rv + loader = root.loader + with(root.selector_rv){ + this.layoutManager = gridLayoutManager + setHasFixedSize(true) + this.adapter = folderAdapter + } + viewModel?.result?.observe(viewLifecycleOwner, Observer { + handleResult(it) + }) + return root + } + + /** + * Handle view model result. + * Get folders from images. + * Load adapter. + */ + private fun handleResult(result: Result) { + if(result.status is CallbackStatus.SUCCESS){ + folders = ImageHelper.folderListFromImages(result.images) + folderAdapter.init(folders) + folderAdapter.notifyDataSetChanged() + selectorRV?.let { + it.visibility = View.VISIBLE + } + } + loader?.let { + it.visibility = if (result.status is CallbackStatus.FETCHING) View.VISIBLE else View.GONE + } + } + + /** + * onResume + * notifyDataSetChanged, rebuild the holder views to account for deleted images, folders. + */ + override fun onResume() { + folderAdapter.notifyDataSetChanged() + super.onResume() + } + + /** + * Return Column count ie span count for grid view adapter. + */ + private fun columnCount(): Int { + return 2 + // todo change column count depending on the orientation of the device. + } +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/ImageFileLoader.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/ImageFileLoader.kt new file mode 100644 index 000000000..12e883a14 --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/ImageFileLoader.kt @@ -0,0 +1,112 @@ +package fr.free.nrw.commons.customselector.ui.selector + +import android.content.ContentUris +import android.content.Context +import android.provider.MediaStore +import fr.free.nrw.commons.customselector.listeners.ImageLoaderListener +import fr.free.nrw.commons.customselector.model.Image +import kotlinx.coroutines.* +import java.io.File +import kotlin.coroutines.CoroutineContext + +/** + * Custom Selector Image File Loader. + * Loads device images. + */ +class ImageFileLoader(val context: Context) : CoroutineScope{ + + /** + * Coroutine context for fetching images. + */ + override val coroutineContext: CoroutineContext = Dispatchers.Main + + /** + * Media paramerters required. + */ + private val projection = arrayOf( + MediaStore.Images.Media._ID, + MediaStore.Images.Media.DISPLAY_NAME, + MediaStore.Images.Media.DATA, + MediaStore.Images.Media.BUCKET_ID, + MediaStore.Images.Media.BUCKET_DISPLAY_NAME) + + /** + * Load Device Images under coroutine. + */ + fun loadDeviceImages(listener: ImageLoaderListener, scope: CoroutineScope) { + launch(Dispatchers.Main) { + withContext(Dispatchers.IO) { + getImages(listener) + } + } + } + + + /** + * Load Device images using cursor + */ + private fun getImages(listener:ImageLoaderListener) { + val cursor = context.contentResolver.query(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, projection, null, null, MediaStore.Images.Media.DATE_ADDED + " DESC") + if (cursor == null) { + listener.onFailed(NullPointerException()) + return + } + + val idColumn = cursor.getColumnIndex(MediaStore.Images.Media._ID) + val nameColumn = cursor.getColumnIndex(MediaStore.Images.Media.DISPLAY_NAME) + val dataColumn = cursor.getColumnIndex(MediaStore.Images.Media.DATA) + val bucketIdColumn = cursor.getColumnIndex(MediaStore.Images.Media.BUCKET_ID) + val bucketNameColumn = cursor.getColumnIndex(MediaStore.Images.Media.BUCKET_DISPLAY_NAME) + + val images = arrayListOf() + if (cursor.moveToFirst()) { + do { + if (Thread.interrupted()) { + listener.onFailed(NullPointerException()) + return + } + val id = cursor.getLong(idColumn) + val name = cursor.getString(nameColumn) + val path = cursor.getString(dataColumn) + val bucketId = cursor.getLong(bucketIdColumn) + val bucketName = cursor.getString(bucketNameColumn) + + val file = + if (path == null || path.isEmpty()) { + null + } else try { + File(path) + } catch (ignored: Exception) { + null + } + + + if (file != null && file.exists()) { + if (id != null && name != null && path != null && bucketId != null && bucketName != null) { + val uri = ContentUris.withAppendedId(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, id) + val image = Image(id, name, uri, path, bucketId, bucketName) + images.add(image) + } + } + + } while (cursor.moveToNext()) + } + cursor.close() + listener.onImageLoaded(images) + } + + + /** + * Abort loading images. + */ + fun abortLoadImage(){ + //todo Abort loading images. + } + + /* + * + * TODO + * Sha1 for image (original image). + * + */ +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/ImageFragment.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/ImageFragment.kt new file mode 100644 index 000000000..ef9ae1fce --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/ImageFragment.kt @@ -0,0 +1,210 @@ +package fr.free.nrw.commons.customselector.ui.selector + +import android.net.Uri +import android.os.Bundle +import android.util.Log +import android.view.LayoutInflater +import android.view.View +import android.view.ViewGroup +import android.widget.ProgressBar +import androidx.lifecycle.Observer +import androidx.lifecycle.ViewModelProvider +import androidx.recyclerview.widget.GridLayoutManager +import androidx.recyclerview.widget.RecyclerView +import fr.free.nrw.commons.R +import fr.free.nrw.commons.customselector.helper.ImageHelper +import fr.free.nrw.commons.customselector.listeners.ImageSelectListener +import fr.free.nrw.commons.customselector.model.CallbackStatus +import fr.free.nrw.commons.customselector.model.Image +import fr.free.nrw.commons.customselector.model.Result +import fr.free.nrw.commons.customselector.ui.adapter.ImageAdapter +import fr.free.nrw.commons.di.CommonsDaggerSupportFragment +import fr.free.nrw.commons.theme.BaseActivity +import kotlinx.android.synthetic.main.fragment_custom_selector.view.* +import java.io.File +import java.io.FileInputStream +import java.net.URI +import javax.inject.Inject + +/** + * Custom Selector Image Fragment. + */ +class ImageFragment: CommonsDaggerSupportFragment() { + + /** + * Current bucketId. + */ + private var bucketId: Long? = null + + /** + * Last ImageItem Id. + */ + private var lastItemId: Long? = null + + /** + * View model for images. + */ + private var viewModel: CustomSelectorViewModel? = null + + /** + * View Elements. + */ + private var selectorRV: RecyclerView? = null + private var loader: ProgressBar? = null + lateinit var filteredImages: ArrayList; + + /** + * View model Factory. + */ + lateinit var customSelectorViewModelFactory: CustomSelectorViewModelFactory + @Inject set + + /** + * Image loader for adapter. + */ + var imageLoader: ImageLoader? = null + @Inject set + + /** + * Image Adapter for recycle view. + */ + private lateinit var imageAdapter: ImageAdapter + + /** + * GridLayoutManager for recycler view. + */ + private lateinit var gridLayoutManager: GridLayoutManager + + + companion object { + + /** + * BucketId args name + */ + const val BUCKET_ID = "BucketId" + const val LAST_ITEM_ID = "LastItemId" + + /** + * newInstance from bucketId. + */ + fun newInstance(bucketId: Long, lastItemId: Long): ImageFragment { + val fragment = ImageFragment() + val args = Bundle() + args.putLong(BUCKET_ID, bucketId) + args.putLong(LAST_ITEM_ID, lastItemId) + fragment.arguments = args + return fragment + } + } + + /** + * OnCreate + * Get BucketId, view Model. + */ + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + bucketId = arguments?.getLong(BUCKET_ID) + lastItemId = arguments?.getLong(LAST_ITEM_ID, 0) + viewModel = ViewModelProvider(requireActivity(),customSelectorViewModelFactory).get(CustomSelectorViewModel::class.java) + } + + /** + * OnCreateView + * Init imageAdapter, gridLayoutManger. + * SetUp recycler view. + */ + override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? { + + val root = inflater.inflate(R.layout.fragment_custom_selector, container, false) + imageAdapter = ImageAdapter(requireActivity(), activity as ImageSelectListener, imageLoader!!) + gridLayoutManager = GridLayoutManager(context,getSpanCount()) + with(root.selector_rv){ + this.layoutManager = gridLayoutManager + setHasFixedSize(true) + this.adapter = imageAdapter + } + + viewModel?.result?.observe(viewLifecycleOwner, Observer{ + handleResult(it) + }) + + selectorRV = root.selector_rv + loader = root.loader + + return root + } + + /** + * Handle view model result. + */ + private fun handleResult(result:Result){ + if(result.status is CallbackStatus.SUCCESS){ + val images = result.images + if(images.isNotEmpty()) { + filteredImages = ImageHelper.filterImages(images, bucketId) + imageAdapter.init(filteredImages) + selectorRV?.let { + it.visibility = View.VISIBLE + lastItemId?.let { pos -> + (it.layoutManager as GridLayoutManager) + .scrollToPosition(ImageHelper.getIndexFromId(filteredImages, pos)) + } + } + } + else{ + selectorRV?.let{ + it.visibility = View.GONE + } + } + } + loader?.let { + it.visibility = if (result.status is CallbackStatus.FETCHING) View.VISIBLE else View.GONE + } + } + + /** + * getSpanCount for GridViewManager. + * + * @return spanCount. + */ + private fun getSpanCount(): Int { + return 3 + // todo change span count depending on the device orientation and other factos. + } + + /** + * onResume + * notifyDataSetChanged, rebuild the holder views to account for deleted images. + */ + override fun onResume() { + imageAdapter.notifyDataSetChanged() + super.onResume() + } + + /** + * OnDestroy + * Cleanup the imageLoader coroutine. + * Save the Image Fragment state. + */ + override fun onDestroy() { + imageLoader?.cleanUP() + + val position = (selectorRV?.layoutManager as GridLayoutManager) + .findFirstVisibleItemPosition() + + // Check for empty RecyclerView. + if (position != -1) { + context?.let { context -> + context.getSharedPreferences( + "CustomSelector", + BaseActivity.MODE_PRIVATE + )?.let { prefs -> + prefs.edit()?.let { editor -> + editor.putLong("ItemId", imageAdapter.getImageIdAt(position))?.apply() + } + } + } + } + super.onDestroy() + } +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/ImageLoader.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/ImageLoader.kt new file mode 100644 index 000000000..cf45a87c1 --- /dev/null +++ b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/ImageLoader.kt @@ -0,0 +1,280 @@ +package fr.free.nrw.commons.customselector.ui.selector + +import android.content.Context +import android.net.Uri +import androidx.exifinterface.media.ExifInterface +import fr.free.nrw.commons.customselector.database.UploadedStatus +import fr.free.nrw.commons.customselector.database.UploadedStatusDao +import fr.free.nrw.commons.customselector.model.Image +import fr.free.nrw.commons.customselector.ui.adapter.ImageAdapter.ImageViewHolder +import fr.free.nrw.commons.filepicker.PickedFiles +import fr.free.nrw.commons.media.MediaClient +import fr.free.nrw.commons.upload.FileProcessor +import fr.free.nrw.commons.upload.FileUtilsWrapper +import kotlinx.coroutines.* +import timber.log.Timber +import java.io.FileNotFoundException +import java.io.IOException +import java.net.UnknownHostException +import java.util.* +import java.util.concurrent.TimeUnit +import javax.inject.Inject +import kotlin.collections.HashMap + +/** + * Image Loader class, loads images, depending on API results. + */ +class ImageLoader @Inject constructor( + + /** + * MediaClient for SHA1 query. + */ + var mediaClient: MediaClient, + + /** + * FileProcessor to pre-process the file. + */ + var fileProcessor: FileProcessor, + + /** + * File Utils Wrapper for SHA1 + */ + var fileUtilsWrapper: FileUtilsWrapper, + + /** + * UploadedStatusDao for cache query. + */ + var uploadedStatusDao: UploadedStatusDao, + + /** + * Context for coroutine. + */ + val context: Context +) { + + /** + * Maps to facilitate image query. + */ + private var mapModifiedImageSHA1: HashMap = HashMap() + private var mapHolderImage : HashMap = HashMap() + private var mapResult: HashMap = HashMap() + private var mapImageSHA1: HashMap = HashMap() + + /** + * Coroutine Dispatchers and Scope. + */ + private var defaultDispatcher : CoroutineDispatcher = Dispatchers.Default + private var ioDispatcher : CoroutineDispatcher = Dispatchers.IO + private val scope : CoroutineScope = MainScope() + + /** + * Query image and setUp the view. + */ + fun queryAndSetView(holder: ImageViewHolder, image: Image) { + + /** + * Recycler view uses same view holder, so we can identify the latest query image from holder. + */ + mapHolderImage[holder] = image + holder.itemNotUploaded() + + scope.launch { + + var result: Result = Result.NOTFOUND + + if (mapHolderImage[holder] != image) { + return@launch + } + + val imageSHA1 = getImageSHA1(image.uri) + if(imageSHA1.isEmpty()) + return@launch + val uploadedStatus = getFromUploaded(imageSHA1) + + val sha1 = uploadedStatus?.let { + result = getResultFromUploadedStatus(uploadedStatus) + uploadedStatus.modifiedImageSHA1 + } ?: run { + if (mapHolderImage[holder] == image) { + getSHA1(image) + } else { + "" + } + } + + if (mapHolderImage[holder] != image) { + return@launch + } + + if (result in arrayOf(Result.NOTFOUND, Result.INVALID) && sha1.isNotEmpty()) { + // Query original image. + result = querySHA1(imageSHA1) + if (result is Result.TRUE) { + // Original image found. + insertIntoUploaded(imageSHA1, sha1, result is Result.TRUE, false) + } else { + // Original image not found, query modified image. + result = querySHA1(sha1) + if (result != Result.ERROR) { + insertIntoUploaded(imageSHA1, sha1, false, result is Result.TRUE) + } + } + } + if(mapHolderImage[holder] == image) { + if (result is Result.TRUE) holder.itemUploaded() else holder.itemNotUploaded() + } + } + } + + /** + * Query SHA1, return result if previously queried, otherwise start a new query. + * + * @return Query result. + */ + + suspend fun querySHA1(SHA1: String): Result { + return withContext(ioDispatcher) { + mapResult[SHA1]?.let { + return@withContext it + } + var result: Result = Result.FALSE + try { + if (mediaClient.checkFileExistsUsingSha(SHA1).blockingGet()) { + mapResult[SHA1] = Result.TRUE + result = Result.TRUE + } + } catch (e: Exception) { + if (e is UnknownHostException) { + // Handle no network connection. + Timber.e(e, "Network Connection Error") + } + result = Result.ERROR + e.printStackTrace() + } + result + } + } + + /** + * Get SHA1, return SHA1 if available, otherwise generate and store the SHA1. + * + * @return sha1 of the image + */ + suspend fun getSHA1(image: Image): String { + mapModifiedImageSHA1[image]?.let{ + return it + } + val sha1 = generateModifiedSHA1(image); + mapModifiedImageSHA1[image] = sha1; + return sha1; + } + + /** + * Get the uploaded status entry from the database. + */ + suspend fun getFromUploaded(imageSha1:String): UploadedStatus? { + return uploadedStatusDao.getUploadedFromImageSHA1(imageSha1) + } + + /** + * Insert into uploaded status table. + */ + suspend fun insertIntoUploaded(imageSha1:String, modifiedImageSha1:String, imageResult:Boolean, modifiedImageResult: Boolean){ + uploadedStatusDao.insertUploaded( + UploadedStatus( + imageSha1, + modifiedImageSha1, + imageResult, + modifiedImageResult + ) + ) + } + + /** + * Get image sha1 from uri, used to retrieve the original image sha1. + */ + suspend fun getImageSHA1(uri: Uri): String { + return withContext(ioDispatcher) { + mapImageSHA1[uri]?.let{ + return@withContext it + } + try { + val result = fileUtilsWrapper.getSHA1(context.contentResolver.openInputStream(uri)) + mapImageSHA1[uri] = result + result + } catch (e: FileNotFoundException){ + e.printStackTrace() + "" + } + } + } + + /** + * Get result data from database. + */ + fun getResultFromUploadedStatus(uploadedStatus: UploadedStatus): Result { + if (uploadedStatus.imageResult || uploadedStatus.modifiedImageResult) { + return Result.TRUE + } else { + uploadedStatus.lastUpdated?.let { + val duration = Calendar.getInstance().time.time - it.time + if (TimeUnit.MILLISECONDS.toDays(duration) < INVALIDATE_DAY_COUNT) { + return Result.FALSE + } + } + } + return Result.INVALID + } + + /** + * Generate Modified SHA1 using present Exif settings. + * + * @return modified sha1 + */ + private suspend fun generateModifiedSHA1(image: Image) : String { + return withContext(defaultDispatcher) { + val uploadableFile = PickedFiles.pickedExistingPicture(context, image.uri) + val exifInterface: ExifInterface? = try { + ExifInterface(uploadableFile.file!!) + } catch (e: IOException) { + Timber.e(e) + null + } + fileProcessor.redactExifTags(exifInterface, fileProcessor.getExifTagsToRedact()) + val sha1 = + fileUtilsWrapper.getSHA1(fileUtilsWrapper.getFileInputStream(uploadableFile.filePath)) + uploadableFile.file.delete() + sha1 + } + } + + /** + * CleanUp function. + */ + fun cleanUP() { + scope.cancel() + } + + /** + * Sealed Result class. + */ + sealed class Result { + object TRUE : Result() + object FALSE : Result() + object INVALID : Result() + object NOTFOUND : Result() + object ERROR : Result() + } + + /** + * Companion Object + */ + companion object { + /** + * Invalidate Day count. + * False Database Entries are invalid after INVALIDATE_DAY_COUNT and need to be re-queried. + */ + const val INVALIDATE_DAY_COUNT: Long = 7 + } + +} \ No newline at end of file diff --git a/app/src/main/java/fr/free/nrw/commons/data/DBOpenHelper.java b/app/src/main/java/fr/free/nrw/commons/data/DBOpenHelper.java index 315bafe41..f9ba4a5ae 100644 --- a/app/src/main/java/fr/free/nrw/commons/data/DBOpenHelper.java +++ b/app/src/main/java/fr/free/nrw/commons/data/DBOpenHelper.java @@ -13,7 +13,7 @@ import fr.free.nrw.commons.explore.recentsearches.RecentSearchesDao; public class DBOpenHelper extends SQLiteOpenHelper { private static final String DATABASE_NAME = "commons.db"; - private static final int DATABASE_VERSION = 17; + private static final int DATABASE_VERSION = 18; public static final String CONTRIBUTIONS_TABLE = "contributions"; private final String DROP_TABLE_STATEMENT="DROP TABLE IF EXISTS %s"; diff --git a/app/src/main/java/fr/free/nrw/commons/db/AppDatabase.kt b/app/src/main/java/fr/free/nrw/commons/db/AppDatabase.kt index c408ea5f7..7f6ea7027 100644 --- a/app/src/main/java/fr/free/nrw/commons/db/AppDatabase.kt +++ b/app/src/main/java/fr/free/nrw/commons/db/AppDatabase.kt @@ -5,6 +5,8 @@ import androidx.room.RoomDatabase import androidx.room.TypeConverters import fr.free.nrw.commons.contributions.Contribution import fr.free.nrw.commons.contributions.ContributionDao +import fr.free.nrw.commons.customselector.database.UploadedStatus +import fr.free.nrw.commons.customselector.database.UploadedStatusDao import fr.free.nrw.commons.upload.depicts.Depicts import fr.free.nrw.commons.upload.depicts.DepictsDao @@ -12,9 +14,10 @@ import fr.free.nrw.commons.upload.depicts.DepictsDao * The database for accessing the respective DAOs * */ -@Database(entities = [Contribution::class, Depicts::class], version = 8, exportSchema = false) +@Database(entities = [Contribution::class, Depicts::class, UploadedStatus::class], version = 8, exportSchema = false) @TypeConverters(Converters::class) abstract class AppDatabase : RoomDatabase() { abstract fun contributionDao(): ContributionDao abstract fun DepictsDao(): DepictsDao; + abstract fun UploadedStatusDao(): UploadedStatusDao; } diff --git a/app/src/main/java/fr/free/nrw/commons/di/ActivityBuilderModule.java b/app/src/main/java/fr/free/nrw/commons/di/ActivityBuilderModule.java index 28c79c612..6381bdc8e 100644 --- a/app/src/main/java/fr/free/nrw/commons/di/ActivityBuilderModule.java +++ b/app/src/main/java/fr/free/nrw/commons/di/ActivityBuilderModule.java @@ -8,6 +8,7 @@ import fr.free.nrw.commons.auth.LoginActivity; import fr.free.nrw.commons.auth.SignupActivity; import fr.free.nrw.commons.category.CategoryDetailsActivity; import fr.free.nrw.commons.contributions.MainActivity; +import fr.free.nrw.commons.customselector.ui.selector.CustomSelectorActivity; import fr.free.nrw.commons.explore.depictions.WikidataItemDetailsActivity; import fr.free.nrw.commons.explore.SearchActivity; import fr.free.nrw.commons.notification.NotificationActivity; @@ -34,6 +35,9 @@ public abstract class ActivityBuilderModule { @ContributesAndroidInjector abstract MainActivity bindContributionsActivity(); + @ContributesAndroidInjector + abstract CustomSelectorActivity bindCustomSelectorActivity(); + @ContributesAndroidInjector abstract SettingsActivity bindSettingsActivity(); diff --git a/app/src/main/java/fr/free/nrw/commons/di/CommonsApplicationModule.java b/app/src/main/java/fr/free/nrw/commons/di/CommonsApplicationModule.java index 1e19de5f4..bffda8332 100644 --- a/app/src/main/java/fr/free/nrw/commons/di/CommonsApplicationModule.java +++ b/app/src/main/java/fr/free/nrw/commons/di/CommonsApplicationModule.java @@ -17,6 +17,8 @@ import fr.free.nrw.commons.R; import fr.free.nrw.commons.auth.AccountUtil; import fr.free.nrw.commons.auth.SessionManager; import fr.free.nrw.commons.contributions.ContributionDao; +import fr.free.nrw.commons.customselector.database.UploadedStatusDao; +import fr.free.nrw.commons.customselector.ui.selector.ImageFileLoader; import fr.free.nrw.commons.data.DBOpenHelper; import fr.free.nrw.commons.db.AppDatabase; import fr.free.nrw.commons.kvstore.JsonKvStore; @@ -66,6 +68,16 @@ public class CommonsApplicationModule { this.applicationContext = applicationContext; } + /** + * Provides ImageFileLoader used to fetch device images. + * @param context + * @return + */ + @Provides + public ImageFileLoader providesImageFileLoader(Context context) { + return new ImageFileLoader(context); + } + @Provides public Context providesApplicationContext() { return this.applicationContext; @@ -244,13 +256,21 @@ public class CommonsApplicationModule { } /** - * Get the reference of DepictsDao class + * Get the reference of DepictsDao class. */ @Provides public DepictsDao providesDepictDao(AppDatabase appDatabase) { return appDatabase.DepictsDao(); } + /** + * Get the reference of UploadedStatus class. + */ + @Provides + public UploadedStatusDao providesUploadedStatusDao(AppDatabase appDatabase) { + return appDatabase.UploadedStatusDao(); + } + @Provides public ContentResolver providesContentResolver(Context context){ return context.getContentResolver(); diff --git a/app/src/main/java/fr/free/nrw/commons/di/FragmentBuilderModule.java b/app/src/main/java/fr/free/nrw/commons/di/FragmentBuilderModule.java index 3757a2147..f255134ea 100644 --- a/app/src/main/java/fr/free/nrw/commons/di/FragmentBuilderModule.java +++ b/app/src/main/java/fr/free/nrw/commons/di/FragmentBuilderModule.java @@ -8,6 +8,8 @@ import fr.free.nrw.commons.bookmarks.locations.BookmarkLocationsFragment; import fr.free.nrw.commons.bookmarks.pictures.BookmarkPicturesFragment; import fr.free.nrw.commons.contributions.ContributionsFragment; import fr.free.nrw.commons.contributions.ContributionsListFragment; +import fr.free.nrw.commons.customselector.ui.selector.FolderFragment; +import fr.free.nrw.commons.customselector.ui.selector.ImageFragment; import fr.free.nrw.commons.explore.ExploreFragment; import fr.free.nrw.commons.explore.ExploreListRootFragment; import fr.free.nrw.commons.explore.categories.media.CategoriesMediaFragment; @@ -49,6 +51,12 @@ public abstract class FragmentBuilderModule { @ContributesAndroidInjector abstract MediaDetailFragment bindMediaDetailFragment(); + @ContributesAndroidInjector + abstract FolderFragment bindFolderFragment(); + + @ContributesAndroidInjector + abstract ImageFragment bindImageFragment(); + @ContributesAndroidInjector abstract MediaDetailPagerFragment bindMediaDetailPagerFragment(); diff --git a/app/src/main/java/fr/free/nrw/commons/explore/ExploreListRootFragment.java b/app/src/main/java/fr/free/nrw/commons/explore/ExploreListRootFragment.java index 32b38fea7..e88f14b55 100644 --- a/app/src/main/java/fr/free/nrw/commons/explore/ExploreListRootFragment.java +++ b/app/src/main/java/fr/free/nrw/commons/explore/ExploreListRootFragment.java @@ -40,7 +40,7 @@ public class ExploreListRootFragment extends CommonsDaggerSupportFragment implem featuredArguments.putString("categoryName", title); listFragment.setArguments(featuredArguments); } - + @Nullable @Override public View onCreateView(@NonNull final LayoutInflater inflater, diff --git a/app/src/main/java/fr/free/nrw/commons/filepicker/Constants.java b/app/src/main/java/fr/free/nrw/commons/filepicker/Constants.java index 83d838bc2..4b5b91e68 100644 --- a/app/src/main/java/fr/free/nrw/commons/filepicker/Constants.java +++ b/app/src/main/java/fr/free/nrw/commons/filepicker/Constants.java @@ -10,6 +10,7 @@ public interface Constants { int FILE_PICKER_IMAGE_IDENTIFICATOR = 0b1101101100; //876 int SOURCE_CHOOSER = 1 << 15; + int PICK_PICTURE_FROM_CUSTOM_SELECTOR = FILE_PICKER_IMAGE_IDENTIFICATOR + (1 << 10); int PICK_PICTURE_FROM_DOCUMENTS = FILE_PICKER_IMAGE_IDENTIFICATOR + (1 << 11); int PICK_PICTURE_FROM_GALLERY = FILE_PICKER_IMAGE_IDENTIFICATOR + (1 << 12); int TAKE_PICTURE = FILE_PICKER_IMAGE_IDENTIFICATOR + (1 << 13); diff --git a/app/src/main/java/fr/free/nrw/commons/filepicker/FilePicker.java b/app/src/main/java/fr/free/nrw/commons/filepicker/FilePicker.java index 698e2d51f..bc43cb154 100644 --- a/app/src/main/java/fr/free/nrw/commons/filepicker/FilePicker.java +++ b/app/src/main/java/fr/free/nrw/commons/filepicker/FilePicker.java @@ -15,6 +15,8 @@ import android.text.TextUtils; import androidx.annotation.NonNull; import androidx.annotation.Nullable; +import fr.free.nrw.commons.customselector.model.Image; +import fr.free.nrw.commons.customselector.ui.selector.CustomSelectorActivity; import java.io.File; import java.io.IOException; import java.net.URISyntaxException; @@ -51,6 +53,17 @@ public class FilePicker implements Constants { .putExtra(Intent.EXTRA_ALLOW_MULTIPLE, configuration(context).allowsMultiplePickingInGallery()); } + /** + * CreateCustomSectorIntent, creates intent for custom selector activity. + * @param context + * @param type + * @return Custom selector intent + */ + private static Intent createCustomSelectorIntent(@NonNull Context context, int type) { + storeType(context, type); + return new Intent(context, CustomSelectorActivity.class); + } + private static Intent createCameraForImageIntent(@NonNull Context context, int type) { storeType(context, type); @@ -97,6 +110,14 @@ public class FilePicker implements Constants { activity.startActivityForResult(intent, RequestCodes.PICK_PICTURE_FROM_GALLERY); } + /** + * Opens Custom Selector + */ + public static void openCustomSelector(Activity activity, int type) { + Intent intent = createCustomSelectorIntent(activity, type); + activity.startActivityForResult(intent, RequestCodes.PICK_PICTURE_FROM_CUSTOM_SELECTOR); + } + /** * Opens the camera app to pick image clicked by user */ @@ -135,12 +156,15 @@ public class FilePicker implements Constants { if (requestCode == RequestCodes.PICK_PICTURE_FROM_GALLERY || requestCode == RequestCodes.TAKE_PICTURE || requestCode == RequestCodes.CAPTURE_VIDEO || - requestCode == RequestCodes.PICK_PICTURE_FROM_DOCUMENTS) { + requestCode == RequestCodes.PICK_PICTURE_FROM_DOCUMENTS || + requestCode == RequestCodes.PICK_PICTURE_FROM_CUSTOM_SELECTOR) { if (resultCode == Activity.RESULT_OK) { if (requestCode == RequestCodes.PICK_PICTURE_FROM_DOCUMENTS && !isPhoto(data)) { onPictureReturnedFromDocuments(data, activity, callbacks); } else if (requestCode == RequestCodes.PICK_PICTURE_FROM_GALLERY && !isPhoto(data)) { onPictureReturnedFromGallery(data, activity, callbacks); + } else if (requestCode == RequestCodes.PICK_PICTURE_FROM_CUSTOM_SELECTOR) { + onPictureReturnedFromCustomSelector(data, activity, callbacks); } else if (requestCode == RequestCodes.TAKE_PICTURE) { onPictureReturnedFromCamera(activity, callbacks); } else if (requestCode == RequestCodes.CAPTURE_VIDEO) { @@ -197,6 +221,40 @@ public class FilePicker implements Constants { } } + /** + * onPictureReturnedFromCustomSelector. + * Retrieve and forward the images to upload wizard through callback. + */ + private static void onPictureReturnedFromCustomSelector(Intent data, Activity activity, @NonNull FilePicker.Callbacks callbacks) { + try { + List files = getFilesFromCustomSelector(data, activity); + callbacks.onImagesPicked(files, ImageSource.CUSTOM_SELECTOR, restoreType(activity)); + } catch (Exception e) { + e.printStackTrace(); + callbacks.onImagePickerError(e, ImageSource.CUSTOM_SELECTOR, restoreType(activity)); + } + } + + /** + * Get files from custom selector + * Retrieve and process the selected images from the custom selector. + */ + private static List getFilesFromCustomSelector(Intent data, Activity activity) throws IOException, SecurityException { + List files = new ArrayList<>(); + ArrayList images = data.getParcelableArrayListExtra("Images"); + for(Image image : images) { + Uri uri = image.getUri(); + UploadableFile file = PickedFiles.pickedExistingPicture(activity, uri); + files.add(file); + } + + if (configuration(activity).shouldCopyPickedImagesToPublicGalleryAppFolder()) { + PickedFiles.copyFilesInSeparateThread(activity, files); + } + + return files; + } + private static void onPictureReturnedFromGallery(Intent data, Activity activity, @NonNull FilePicker.Callbacks callbacks) { try { List files = getFilesFromGalleryPictures(data, activity); @@ -301,7 +359,7 @@ public class FilePicker implements Constants { public enum ImageSource { - GALLERY, DOCUMENTS, CAMERA_IMAGE, CAMERA_VIDEO + GALLERY, DOCUMENTS, CAMERA_IMAGE, CAMERA_VIDEO, CUSTOM_SELECTOR } public interface Callbacks { diff --git a/app/src/main/java/fr/free/nrw/commons/filepicker/PickedFiles.java b/app/src/main/java/fr/free/nrw/commons/filepicker/PickedFiles.java index 01e68c940..ea5983173 100644 --- a/app/src/main/java/fr/free/nrw/commons/filepicker/PickedFiles.java +++ b/app/src/main/java/fr/free/nrw/commons/filepicker/PickedFiles.java @@ -24,19 +24,38 @@ import java.util.UUID; import timber.log.Timber; +/** + * PickedFiles. + * Process the upload items. + */ +public class PickedFiles implements Constants { -class PickedFiles implements Constants { - + /** + * Get Folder Name + * @param context + * @return default application folder name. + */ private static String getFolderName(@NonNull Context context) { return FilePicker.configuration(context).getFolderName(); } + /** + * tempImageDirectory + * @param context + * @return temporary image directory to copy and perform exif changes. + */ private static File tempImageDirectory(@NonNull Context context) { File privateTempDir = new File(context.getCacheDir(), DEFAULT_FOLDER_NAME); if (!privateTempDir.exists()) privateTempDir.mkdirs(); return privateTempDir; } + /** + * writeToFile + * writes inputStream data to the destination file. + * @param in input stream of source file. + * @param file destination file + */ private static void writeToFile(InputStream in, File file) { try { OutputStream out = new FileOutputStream(file); @@ -52,11 +71,24 @@ class PickedFiles implements Constants { } } + /** + * Copy file function. + * Copies source file to destination file. + * @param src source file + * @param dst destination file + * @throws IOException (File input stream exception) + */ private static void copyFile(File src, File dst) throws IOException { InputStream in = new FileInputStream(src); writeToFile(in, dst); } + /** + * Copy files in separate thread. + * Copies all the uploadable files to the temp image folder on background thread. + * @param context + * @param filesToCopy uploadable file list to be copied. + */ static void copyFilesInSeparateThread(final Context context, final List filesToCopy) { new Thread(() -> { List copiedFiles = new ArrayList<>(); @@ -64,7 +96,9 @@ class PickedFiles implements Constants { for (UploadableFile uploadableFile : filesToCopy) { File fileToCopy = uploadableFile.getFile(); File dstDir = new File(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_PICTURES), getFolderName(context)); - if (!dstDir.exists()) dstDir.mkdirs(); + if (!dstDir.exists()) { + dstDir.mkdirs(); + } String[] filenameSplit = fileToCopy.getName().split("\\."); String extension = "." + filenameSplit[filenameSplit.length - 1]; @@ -84,12 +118,24 @@ class PickedFiles implements Constants { }).run(); } + /** + * singleFileList. + * converts a single uploadableFile to list of uploadableFile. + * @param file uploadable file + * @return + */ static List singleFileList(UploadableFile file) { List list = new ArrayList<>(); list.add(file); return list; } + /** + * ScanCopiedImages + * Scan copied images metadata using media scanner. + * @param context + * @param copiedImages copied images list. + */ static void scanCopiedImages(Context context, List copiedImages) { String[] paths = new String[copiedImages.size()]; for (int i = 0; i < copiedImages.size(); i++) { @@ -104,7 +150,13 @@ class PickedFiles implements Constants { }); } - static UploadableFile pickedExistingPicture(@NonNull Context context, Uri photoUri) throws IOException, SecurityException {// SecurityException for those file providers who share URI but forget to grant necessary permissions + /** + * pickedExistingPicture + * convert the image into uploadable file. + * @param photoUri Uri of the image. + * @return Uploadable file ready for tag redaction. + */ + public static UploadableFile pickedExistingPicture(@NonNull Context context, Uri photoUri) throws IOException, SecurityException {// SecurityException for those file providers who share URI but forget to grant necessary permissions InputStream pictureInputStream = context.getContentResolver().openInputStream(photoUri); File directory = tempImageDirectory(context); File photoFile = new File(directory, UUID.randomUUID().toString() + "." + getMimeType(context, photoUri)); @@ -116,6 +168,9 @@ class PickedFiles implements Constants { return new UploadableFile(photoUri, photoFile); } + /** + * getCameraPictureLocation + */ static File getCameraPicturesLocation(@NonNull Context context) throws IOException { File dir = tempImageDirectory(context); return File.createTempFile(UUID.randomUUID().toString(), ".jpg", dir); @@ -142,6 +197,11 @@ class PickedFiles implements Constants { return extension; } + /** + * GetUriToFile + * @param file get uri of file + * @return uri of requested file. + */ static Uri getUriToFile(@NonNull Context context, @NonNull File file) { String packageName = context.getApplicationContext().getPackageName(); String authority = packageName + ".provider"; diff --git a/app/src/main/java/fr/free/nrw/commons/media/MediaDetailPagerFragment.java b/app/src/main/java/fr/free/nrw/commons/media/MediaDetailPagerFragment.java index 52f8b7385..ce6585b52 100644 --- a/app/src/main/java/fr/free/nrw/commons/media/MediaDetailPagerFragment.java +++ b/app/src/main/java/fr/free/nrw/commons/media/MediaDetailPagerFragment.java @@ -102,6 +102,7 @@ public class MediaDetailPagerFragment extends CommonsDaggerSupportFragment imple pager.addOnPageChangeListener(this); adapter = new MediaDetailAdapter(getChildFragmentManager()); + ((BaseActivity)getActivity()).getSupportActionBar().setDisplayHomeAsUpEnabled(true); if (getActivity() != null) { final ActionBar actionBar = ((AppCompatActivity) getActivity()).getSupportActionBar(); diff --git a/app/src/main/java/fr/free/nrw/commons/upload/FileProcessor.kt b/app/src/main/java/fr/free/nrw/commons/upload/FileProcessor.kt index ff3f63eb8..5ad6952ee 100644 --- a/app/src/main/java/fr/free/nrw/commons/upload/FileProcessor.kt +++ b/app/src/main/java/fr/free/nrw/commons/upload/FileProcessor.kt @@ -77,7 +77,7 @@ class FileProcessor @Inject constructor( * * @return tags to be redacted */ - private fun getExifTagsToRedact(): Set { + fun getExifTagsToRedact(): Set { val prefManageEXIFTags = defaultKvStore.getStringSet(Prefs.MANAGED_EXIF_TAGS) ?: emptySet() val redactTags: Set = @@ -91,7 +91,7 @@ class FileProcessor @Inject constructor( * @param exifInterface ExifInterface object * @param redactTags tags to be redacted */ - private fun redactExifTags(exifInterface: ExifInterface?, redactTags: Set) { + fun redactExifTags(exifInterface: ExifInterface?, redactTags: Set) { compositeDisposable.add( Observable.fromIterable(redactTags) .flatMap { Observable.fromArray(*FileMetadataUtils.getTagsFromPref(it)) } diff --git a/app/src/main/java/fr/free/nrw/commons/upload/UploadItem.java b/app/src/main/java/fr/free/nrw/commons/upload/UploadItem.java index 0487fd87f..1b482717f 100644 --- a/app/src/main/java/fr/free/nrw/commons/upload/UploadItem.java +++ b/app/src/main/java/fr/free/nrw/commons/upload/UploadItem.java @@ -24,6 +24,12 @@ public class UploadItem { private final BehaviorSubject imageQuality; private boolean hasInvalidLocation; + /** + * Uri of uploadItem + * Uri points to image location or name, eg content://media/external/images/camera/10495 (Android 10) + */ + private final Uri contentUri; + @SuppressLint("CheckResult") UploadItem(final Uri mediaUri, @@ -31,7 +37,8 @@ public class UploadItem { final ImageCoordinates gpsCoords, final Place place, final long createdTimestamp, - final String createdTimestampSource) { + final String createdTimestampSource, + final Uri contentUri) { this.createdTimestampSource = createdTimestampSource; uploadMediaDetails = new ArrayList<>(Collections.singletonList(new UploadMediaDetail())); this.place = place; @@ -39,6 +46,7 @@ public class UploadItem { this.mimeType = mimeType; this.gpsCoords = gpsCoords; this.createdTimestamp = createdTimestamp; + this.contentUri = contentUri; imageQuality = BehaviorSubject.createDefault(ImageUtils.IMAGE_WAIT); } @@ -66,8 +74,15 @@ public class UploadItem { return imageQuality.getValue(); } + /** + * getContentUri. + * @return Uri of uploadItem + * Uri points to image location or name, eg content://media/external/images/camera/10495 (Android 10) + */ + public Uri getContentUri() { return contentUri; } + public void setImageQuality(final int imageQuality) { - this.imageQuality.onNext(imageQuality); + this.imageQuality.onNext(imageQuality); } /** diff --git a/app/src/main/java/fr/free/nrw/commons/upload/UploadModel.java b/app/src/main/java/fr/free/nrw/commons/upload/UploadModel.java index cf72fa5d6..1d1b7117f 100644 --- a/app/src/main/java/fr/free/nrw/commons/upload/UploadModel.java +++ b/app/src/main/java/fr/free/nrw/commons/upload/UploadModel.java @@ -106,7 +106,8 @@ public class UploadModel { final UploadItem uploadItem = new UploadItem( Uri.parse(uploadableFile.getFilePath()), uploadableFile.getMimeType(context), imageCoordinates, place, fileCreatedDate, - createdTimestampSource); + createdTimestampSource, + uploadableFile.getContentUri()); if (place != null) { uploadItem.getUploadMediaDetails().set(0, new UploadMediaDetail(place)); } diff --git a/app/src/main/java/fr/free/nrw/commons/upload/worker/UploadWorker.kt b/app/src/main/java/fr/free/nrw/commons/upload/worker/UploadWorker.kt index ad0c08c4c..d46c5e4ac 100644 --- a/app/src/main/java/fr/free/nrw/commons/upload/worker/UploadWorker.kt +++ b/app/src/main/java/fr/free/nrw/commons/upload/worker/UploadWorker.kt @@ -18,17 +18,22 @@ import fr.free.nrw.commons.auth.SessionManager import fr.free.nrw.commons.contributions.ChunkInfo import fr.free.nrw.commons.contributions.Contribution import fr.free.nrw.commons.contributions.ContributionDao +import fr.free.nrw.commons.customselector.database.UploadedStatus +import fr.free.nrw.commons.customselector.database.UploadedStatusDao import fr.free.nrw.commons.di.ApplicationlessInjection import fr.free.nrw.commons.location.LatLng import fr.free.nrw.commons.media.MediaClient +import fr.free.nrw.commons.upload.FileUtilsWrapper import fr.free.nrw.commons.upload.StashUploadState import fr.free.nrw.commons.upload.UploadClient import fr.free.nrw.commons.upload.UploadResult import fr.free.nrw.commons.wikidata.WikidataEditService import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.MainScope import kotlinx.coroutines.flow.asFlow import kotlinx.coroutines.flow.collect import kotlinx.coroutines.flow.map +import kotlinx.coroutines.launch import kotlinx.coroutines.withContext import timber.log.Timber import java.io.IOException @@ -51,12 +56,18 @@ class UploadWorker(var appContext: Context, workerParams: WorkerParameters) : @Inject lateinit var contributionDao: ContributionDao + @Inject + lateinit var uploadedStatusDao: UploadedStatusDao + @Inject lateinit var uploadClient: UploadClient @Inject lateinit var mediaClient: MediaClient + @Inject + lateinit var fileUtilsWrapper: FileUtilsWrapper + private val PROCESSING_UPLOADS_NOTIFICATION_TAG = BuildConfig.APPLICATION_ID + " : upload_tag" private val PROCESSING_UPLOADS_NOTIFICATION_ID = 101 @@ -417,6 +428,29 @@ class UploadWorker(var appContext: Context, workerParams: WorkerParameters) : .blockingGet() contributionFromUpload.dateModified=Date() contributionDao.deleteAndSaveContribution(contribution, contributionFromUpload) + + // Upload success, save to uploaded status. + saveIntoUploadedStatus(contribution) + } + + /** + * Save to uploadedStatusDao. + */ + private fun saveIntoUploadedStatus(contribution: Contribution) { + contribution.contentUri?.let { + val imageSha1 = fileUtilsWrapper.getSHA1(appContext.contentResolver.openInputStream(it)) + val modifiedSha1 = fileUtilsWrapper.getSHA1(fileUtilsWrapper.getFileInputStream(contribution.localUri?.path)) + MainScope().launch { + uploadedStatusDao.insertUploaded( + UploadedStatus( + imageSha1, + modifiedSha1, + imageSha1 == modifiedSha1, + true + ) + ); + } + } } private fun findUniqueFileName(fileName: String): String { diff --git a/app/src/main/res/drawable-ldpi/circle_shape.xml b/app/src/main/res/drawable-ldpi/circle_shape.xml new file mode 100644 index 000000000..d581bfb9f --- /dev/null +++ b/app/src/main/res/drawable-ldpi/circle_shape.xml @@ -0,0 +1,4 @@ + + + \ No newline at end of file diff --git a/app/src/main/res/drawable-ldpi/commons.xml b/app/src/main/res/drawable-ldpi/commons.xml new file mode 100644 index 000000000..4c2e6cabf --- /dev/null +++ b/app/src/main/res/drawable-ldpi/commons.xml @@ -0,0 +1,62 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/app/src/main/res/drawable/ic_arrow_back_black.xml b/app/src/main/res/drawable/ic_arrow_back_black.xml new file mode 100644 index 000000000..b5487b3ea --- /dev/null +++ b/app/src/main/res/drawable/ic_arrow_back_black.xml @@ -0,0 +1,10 @@ + + + diff --git a/app/src/main/res/drawable/ic_custom_image_picker.xml b/app/src/main/res/drawable/ic_custom_image_picker.xml new file mode 100644 index 000000000..7dd39280a --- /dev/null +++ b/app/src/main/res/drawable/ic_custom_image_picker.xml @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/app/src/main/res/drawable/ic_done_black.xml b/app/src/main/res/drawable/ic_done_black.xml new file mode 100644 index 000000000..2d3858a70 --- /dev/null +++ b/app/src/main/res/drawable/ic_done_black.xml @@ -0,0 +1,10 @@ + + + diff --git a/app/src/main/res/drawable/ic_done_white.xml b/app/src/main/res/drawable/ic_done_white.xml new file mode 100644 index 000000000..2728880b7 --- /dev/null +++ b/app/src/main/res/drawable/ic_done_white.xml @@ -0,0 +1,5 @@ + + + diff --git a/app/src/main/res/layout/activity_custom_selector.xml b/app/src/main/res/layout/activity_custom_selector.xml new file mode 100644 index 000000000..d96918fee --- /dev/null +++ b/app/src/main/res/layout/activity_custom_selector.xml @@ -0,0 +1,19 @@ + + + + + + + + \ No newline at end of file diff --git a/app/src/main/res/layout/bottom_container_location_picker.xml b/app/src/main/res/layout/bottom_container_location_picker.xml index 98a8216c5..2eafaa4b6 100644 --- a/app/src/main/res/layout/bottom_container_location_picker.xml +++ b/app/src/main/res/layout/bottom_container_location_picker.xml @@ -77,5 +77,4 @@ - \ No newline at end of file diff --git a/app/src/main/res/layout/custom_selector_info_dialog.xml b/app/src/main/res/layout/custom_selector_info_dialog.xml new file mode 100644 index 000000000..a34f247dd --- /dev/null +++ b/app/src/main/res/layout/custom_selector_info_dialog.xml @@ -0,0 +1,133 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app/src/main/res/layout/custom_selector_toolbar.xml b/app/src/main/res/layout/custom_selector_toolbar.xml new file mode 100644 index 000000000..72ab6386a --- /dev/null +++ b/app/src/main/res/layout/custom_selector_toolbar.xml @@ -0,0 +1,56 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/app/src/main/res/layout/fragment_contributions_list.xml b/app/src/main/res/layout/fragment_contributions_list.xml index 49e4e60c7..923cc8343 100644 --- a/app/src/main/res/layout/fragment_contributions_list.xml +++ b/app/src/main/res/layout/fragment_contributions_list.xml @@ -69,6 +69,19 @@ app:fabSize="mini" app:srcCompat="@drawable/ic_photo_white_24dp" /> + + + + + + + + + + + + \ No newline at end of file diff --git a/app/src/main/res/layout/item_custom_selector_folder.xml b/app/src/main/res/layout/item_custom_selector_folder.xml new file mode 100644 index 000000000..0f2a72828 --- /dev/null +++ b/app/src/main/res/layout/item_custom_selector_folder.xml @@ -0,0 +1,77 @@ + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app/src/main/res/layout/item_custom_selector_image.xml b/app/src/main/res/layout/item_custom_selector_image.xml new file mode 100644 index 000000000..f04a71922 --- /dev/null +++ b/app/src/main/res/layout/item_custom_selector_image.xml @@ -0,0 +1,88 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app/src/main/res/values/attrs.xml b/app/src/main/res/values/attrs.xml index 5387ca117..f43772fb5 100644 --- a/app/src/main/res/values/attrs.xml +++ b/app/src/main/res/values/attrs.xml @@ -49,6 +49,8 @@ + + diff --git a/app/src/main/res/values/dimens.xml b/app/src/main/res/values/dimens.xml index ac5d31cf7..b3fb6d1a4 100644 --- a/app/src/main/res/values/dimens.xml +++ b/app/src/main/res/values/dimens.xml @@ -58,6 +58,7 @@ 0dp + 2dp 6dp 10dp 20dp diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml index e0cf7d790..b594d182d 100644 --- a/app/src/main/res/values/strings.xml +++ b/app/src/main/res/values/strings.xml @@ -100,6 +100,7 @@ Settings Sign Up Featured Images + Custom Selector Category Peer Review About @@ -639,6 +640,15 @@ Upload your first media by tapping on the add button. The shadow of the image view of the location picker Image Location Check whether location is correct + Custom Selector + No Images + Done + Back + Welcome to Custom Picture Selector + This picker shows differently pictures that are already to Commons. + Unlike the picture on the left, the picture on the right has the Commons logo indicating it is already uploaded. + Awesome + This image has already been uploaded to Commons. WLM You are contributing to Wiki Loves Monuments Campaign. Related templates will be added accordingly. Display monuments @@ -646,5 +656,4 @@ Upload your first media by tapping on the add button. LEARN MORE Wiki Loves Monuments Wiki Loves Monuments is an international photo contest for monuments organised by Wikimedia - diff --git a/app/src/main/res/values/styles.xml b/app/src/main/res/values/styles.xml index 308291dea..1ae9e0a7c 100644 --- a/app/src/main/res/values/styles.xml +++ b/app/src/main/res/values/styles.xml @@ -55,6 +55,8 @@ @color/white @color/white @drawable/ic_search_white_24dp + @drawable/ic_done_white + @drawable/ic_arrow_back_white false false @@ -113,6 +115,8 @@ @color/disabled_button_text_color_dark @color/primaryDarkColor @drawable/ic_search_blue_24dp + @drawable/ic_done_black + @drawable/ic_arrow_back_black false false diff --git a/app/src/test/kotlin/fr/free/nrw/commons/customselector/helper/ImageHelperTest.kt b/app/src/test/kotlin/fr/free/nrw/commons/customselector/helper/ImageHelperTest.kt new file mode 100644 index 000000000..2fe382368 --- /dev/null +++ b/app/src/test/kotlin/fr/free/nrw/commons/customselector/helper/ImageHelperTest.kt @@ -0,0 +1,55 @@ +package fr.free.nrw.commons.customselector.helper + +import android.net.Uri +import fr.free.nrw.commons.customselector.model.Folder +import fr.free.nrw.commons.customselector.model.Image +import org.junit.jupiter.api.Assertions.* + +import org.junit.jupiter.api.Test +import org.mockito.Mockito.mock + +/** + * Custom Selector Image Helper Test + */ +internal class ImageHelperTest { + + var uri: Uri = mock(Uri::class.java) + private val folderImage1 = Image(1, "image1", uri, "abc/abc", 1, "bucket1") + private val folderImage2 = Image(2, "image1", uri, "xyz/xyz", 2, "bucket2") + private val mockImageList = ArrayList(listOf(folderImage1, folderImage2)) + private val folderImageList1 = ArrayList(listOf(folderImage1)) + private val folderImageList2 = ArrayList(listOf(folderImage2)) + + /** + * Test folder list from images. + */ + @Test + fun folderListFromImages() { + val folderList = ArrayList(listOf(Folder(1, "bucket1", folderImageList1), Folder(2, "bucket2", folderImageList2))) + assertEquals(folderList, ImageHelper.folderListFromImages(mockImageList)) + } + + /** + * Test filter images. + */ + @Test + fun filterImages() { + assertEquals(folderImageList1, ImageHelper.filterImages(mockImageList, 1)) + } + + /** + * Test get index from image list. + */ + @Test + fun getIndex() { + assertEquals(1,ImageHelper.getIndex(mockImageList, folderImage2)) + } + + /** + * Test get index list. + */ + @Test + fun getIndexList() { + assertEquals(ArrayList(listOf(0)), ImageHelper.getIndexList(mockImageList, folderImageList2)) + } +} \ No newline at end of file diff --git a/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/adapter/FolderAdapterTest.kt b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/adapter/FolderAdapterTest.kt new file mode 100644 index 000000000..1c2a663f3 --- /dev/null +++ b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/adapter/FolderAdapterTest.kt @@ -0,0 +1,99 @@ +package fr.free.nrw.commons.customselector.ui.adapter + +import android.content.ContentResolver +import fr.free.nrw.commons.R +import android.content.Context +import android.net.Uri +import android.view.LayoutInflater +import android.view.View +import android.widget.GridLayout +import com.nhaarman.mockitokotlin2.any +import com.nhaarman.mockitokotlin2.whenever +import fr.free.nrw.commons.TestCommonsApplication +import fr.free.nrw.commons.customselector.listeners.FolderClickListener +import fr.free.nrw.commons.customselector.model.Folder +import fr.free.nrw.commons.customselector.model.Image +import fr.free.nrw.commons.customselector.ui.selector.CustomSelectorActivity +import org.junit.Before +import org.junit.Test +import org.junit.jupiter.api.Assertions.assertEquals +import org.junit.runner.RunWith +import org.mockito.Mock +import org.mockito.Mockito +import org.mockito.MockitoAnnotations +import org.powermock.reflect.Whitebox +import org.robolectric.Robolectric +import org.robolectric.RobolectricTestRunner +import org.robolectric.annotation.Config + +/** + * Custom Selector Folder Adapter Test. + */ +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [21], application = TestCommonsApplication::class) +class FolderAdapterTest { + + private var uri: Uri = Mockito.mock(Uri::class.java) + private lateinit var activity: CustomSelectorActivity + private lateinit var folderAdapter: FolderAdapter + private lateinit var image: Image + private lateinit var folder: Folder + private lateinit var folderList: ArrayList + + @Mock + private lateinit var context: Context + + @Mock + private lateinit var mockContentResolver: ContentResolver + + @Before + @Throws(Exception::class) + fun setUp() { + MockitoAnnotations.initMocks(this) + + activity = Robolectric.buildActivity(CustomSelectorActivity::class.java).get() + image = Image(1, "image", uri, "abc/abc", 1, "bucket1") + folder = Folder(1, "bucket1", ArrayList(listOf(image))) + folderList = ArrayList(listOf(folder, folder, folder)) + folderAdapter = FolderAdapter(activity, activity as FolderClickListener) + } + + /** + * Test on create view holder. + */ + @Test + fun onCreateViewHolder() { + folderAdapter.createViewHolder(GridLayout(activity), 0) + } + + /** + * Test on bind view holder. + */ + @Test + fun onBindViewHolder() { + val inflater = activity.getSystemService(Context.LAYOUT_INFLATER_SERVICE) as LayoutInflater + val listItemView: View = inflater.inflate(R.layout.item_custom_selector_folder, null, false) + + whenever(context.contentResolver).thenReturn(mockContentResolver) + whenever(mockContentResolver.getType(any())).thenReturn("jpg") + Whitebox.setInternalState(folderAdapter, "context", context) + folderAdapter.init(folderList) + folderAdapter.onBindViewHolder(FolderAdapter.FolderViewHolder(listItemView), 0) + } + + /** + * Test init. + */ + @Test + fun init() { + folderAdapter.init(folderList) + } + + /** + * Test get item count. + */ + @Test + fun getItemCount() { + assertEquals(0, folderAdapter.itemCount) + } +} \ No newline at end of file diff --git a/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/adapter/ImageAdapterTest.kt b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/adapter/ImageAdapterTest.kt new file mode 100644 index 000000000..fac24cb32 --- /dev/null +++ b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/adapter/ImageAdapterTest.kt @@ -0,0 +1,145 @@ +package fr.free.nrw.commons.customselector.ui.adapter + +import android.content.ContentResolver +import android.content.Context +import android.net.Uri +import android.view.LayoutInflater +import android.view.View +import android.widget.GridLayout +import com.nhaarman.mockitokotlin2.whenever +import fr.free.nrw.commons.R +import fr.free.nrw.commons.TestCommonsApplication +import fr.free.nrw.commons.customselector.listeners.ImageSelectListener +import fr.free.nrw.commons.customselector.model.Image +import fr.free.nrw.commons.customselector.ui.selector.CustomSelectorActivity +import fr.free.nrw.commons.customselector.ui.selector.ImageLoader +import org.junit.Before +import org.junit.Test +import org.junit.jupiter.api.Assertions +import org.junit.runner.RunWith +import org.mockito.* +import org.powermock.reflect.Whitebox +import org.robolectric.Robolectric +import org.robolectric.RobolectricTestRunner +import org.robolectric.annotation.Config +import java.lang.reflect.Field + +/** + * Custom Selector image adapter test. + */ +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [21], application = TestCommonsApplication::class) +class ImageAdapterTest { + @Mock + private lateinit var imageLoader: ImageLoader + @Mock + private lateinit var imageSelectListener: ImageSelectListener + @Mock + private lateinit var context: Context + @Mock + private lateinit var mockContentResolver: ContentResolver + + private lateinit var activity: CustomSelectorActivity + private lateinit var imageAdapter: ImageAdapter + private lateinit var images : ArrayList + private lateinit var holder: ImageAdapter.ImageViewHolder + private lateinit var selectedImageField: Field + private var uri: Uri = Mockito.mock(Uri::class.java) + private lateinit var image: Image + + + /** + * Set up variables. + */ + @Before + @Throws(Exception::class) + fun setUp() { + MockitoAnnotations.initMocks(this) + activity = Robolectric.buildActivity(CustomSelectorActivity::class.java).get() + imageAdapter = ImageAdapter(activity, imageSelectListener, imageLoader) + image = Image(1, "image", uri, "abc/abc", 1, "bucket1") + images = ArrayList() + + val inflater = activity.getSystemService(Context.LAYOUT_INFLATER_SERVICE) as LayoutInflater + val listItemView: View = inflater.inflate(R.layout.item_custom_selector_image, null, false) + holder = ImageAdapter.ImageViewHolder(listItemView) + + selectedImageField = imageAdapter.javaClass.getDeclaredField("selectedImages") + selectedImageField.isAccessible = true + } + + /** + * Test on create view holder. + */ + @Test + fun onCreateViewHolder() { + imageAdapter.createViewHolder(GridLayout(activity), 0) + } + + /** + * Test on bind view holder. + */ + @Test + fun onBindViewHolder() { + + whenever(context.contentResolver).thenReturn(mockContentResolver) + whenever(mockContentResolver.getType(uri)).thenReturn("jpg") + Whitebox.setInternalState(imageAdapter, "context", context) + + // Parameters. + images.add(image) + imageAdapter.init(images) + + // Test conditions. + imageAdapter.onBindViewHolder(holder, 0) + selectedImageField.set(imageAdapter, images) + imageAdapter.onBindViewHolder(holder, 0) + } + + /** + * Test init. + */ + @Test + fun init() { + imageAdapter.init(images) + } + + /** + * Test private function select or remove image. + */ + @Test + fun selectOrRemoveImage() { + // Access function + val func = imageAdapter.javaClass.getDeclaredMethod("selectOrRemoveImage", ImageAdapter.ImageViewHolder::class.java, Int::class.java) + func.isAccessible = true + + // Parameters + images.addAll(listOf(image, image)) + imageAdapter.init(images) + + // Test conditions + holder.itemUploaded() + func.invoke(imageAdapter, holder, 0) + holder.itemNotUploaded() + func.invoke(imageAdapter, holder, 0) + selectedImageField.set(imageAdapter, images) + func.invoke(imageAdapter, holder, 1) + } + + /** + * Test get item count. + */ + @Test + fun getItemCount() { + Assertions.assertEquals(0, imageAdapter.itemCount) + } + + /** + * Test getImageId + */ + @Test + fun getImageIdAt() { + imageAdapter.init(listOf(image)) + Assertions.assertEquals(1, imageAdapter.getImageIdAt(0)) + } +} \ No newline at end of file diff --git a/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorActivityTest.kt b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorActivityTest.kt new file mode 100644 index 000000000..21007daeb --- /dev/null +++ b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorActivityTest.kt @@ -0,0 +1,119 @@ +package fr.free.nrw.commons.customselector.ui.selector + +import android.net.Uri +import android.os.Bundle +import android.os.Looper +import android.os.Looper.getMainLooper +import fr.free.nrw.commons.TestAppAdapter +import fr.free.nrw.commons.TestCommonsApplication +import fr.free.nrw.commons.contributions.MainActivity +import fr.free.nrw.commons.customselector.model.Folder +import fr.free.nrw.commons.customselector.model.Image +import org.junit.Before +import org.junit.Test +import org.junit.jupiter.api.Assertions.assertNotNull +import org.junit.runner.RunWith +import org.mockito.MockitoAnnotations +import org.robolectric.Robolectric +import org.robolectric.RobolectricTestRunner +import org.robolectric.Shadows +import org.robolectric.Shadows.shadowOf +import org.robolectric.annotation.Config +import org.wikipedia.AppAdapter +import java.lang.reflect.Method + +/** + * Custom Selector Activity Test + */ +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [21], application = TestCommonsApplication::class) +class CustomSelectorActivityTest { + + private lateinit var activity: CustomSelectorActivity + + /** + * Set up the tests. + */ + @Before + fun setUp() { + MockitoAnnotations.initMocks(this) + AppAdapter.set(TestAppAdapter()) + + activity = Robolectric.buildActivity(CustomSelectorActivity::class.java) + .get() + val onCreate = activity.javaClass.getDeclaredMethod("onCreate", Bundle::class.java) + onCreate.isAccessible = true + onCreate.invoke(activity, null) + } + + /** + * Test activity not null. + */ + @Test + @Throws(Exception::class) + fun testActivityNotNull() { + assertNotNull(activity) + } + + /** + * Test changeTitle function. + */ + @Test + @Throws(Exception::class) + fun testChangeTitle() { + val func = activity.javaClass.getDeclaredMethod("changeTitle", String::class.java) + func.isAccessible = true + func.invoke(activity, "test") + } + + /** + * Test onFolderClick function. + */ + @Test + @Throws(Exception::class) + fun testOnFolderClick() { + activity.onFolderClick(1, "test", 0); + } + + /** + * Test selectedImagesChanged function. + */ + @Test + @Throws(Exception::class) + fun testOnSelectedImagesChanged() { + activity.onSelectedImagesChanged(ArrayList()) + } + + /** + * Test onDone function. + */ + @Test + @Throws(Exception::class) + fun testOnDone() { + activity.onDone() + activity.onSelectedImagesChanged(ArrayList(arrayListOf(Image(1, "test", Uri.parse("test"), "test", 1)))); + activity.onDone() + } + + /** + * Test onBackPressed Function. + */ + @Test + @Throws(Exception::class) + fun testOnBackPressed() { + activity.onBackPressed() + } + + /** + * Test onDestroy Function. + */ + @Test + @Throws(Exception::class) + fun testOnDestroy() { + val method: Method = CustomSelectorActivity::class.java.getDeclaredMethod( + "onDestroy" + ) + method.isAccessible = true + method.invoke(activity) + } +} \ No newline at end of file diff --git a/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorViewModelTest.kt b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorViewModelTest.kt new file mode 100644 index 000000000..309392d4d --- /dev/null +++ b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorViewModelTest.kt @@ -0,0 +1,41 @@ +package fr.free.nrw.commons.customselector.ui.selector + +import android.content.Context +import org.junit.Before +import org.junit.Test +import org.mockito.Mock +import org.mockito.MockitoAnnotations + +/** + * Custom Selector View Model test. + */ +class CustomSelectorViewModelTest { + + private lateinit var viewModel: CustomSelectorViewModel + + @Mock + private lateinit var imageFileLoader: ImageFileLoader + + @Mock + private lateinit var context: Context + + /** + * Set up the test. + */ + @Before + fun setUp(){ + MockitoAnnotations.initMocks(this) + viewModel = CustomSelectorViewModel(context, imageFileLoader); + } + + /** + * Test onCleared(); + */ + @Test + fun testOnCleared(){ + val func = viewModel.javaClass.getDeclaredMethod("onCleared") + func.isAccessible = true + func.invoke(viewModel); + } + +} \ No newline at end of file diff --git a/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/FolderFragmentTest.kt b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/FolderFragmentTest.kt new file mode 100644 index 000000000..c77f24342 --- /dev/null +++ b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/FolderFragmentTest.kt @@ -0,0 +1,141 @@ +package fr.free.nrw.commons.customselector.ui.selector + +import android.content.Context +import android.os.Bundle +import android.os.Looper +import android.view.LayoutInflater +import android.view.View +import fr.free.nrw.commons.customselector.model.Result +import android.widget.ProgressBar +import androidx.fragment.app.FragmentManager +import androidx.fragment.app.FragmentTransaction +import androidx.recyclerview.widget.RecyclerView +import com.facebook.drawee.backends.pipeline.Fresco +import com.facebook.soloader.SoLoader +import fr.free.nrw.commons.R +import fr.free.nrw.commons.TestAppAdapter +import fr.free.nrw.commons.TestCommonsApplication +import fr.free.nrw.commons.customselector.model.CallbackStatus +import fr.free.nrw.commons.customselector.ui.adapter.FolderAdapter +import org.junit.Before +import org.junit.Test +import org.junit.jupiter.api.Assertions.assertEquals +import org.junit.runner.RunWith +import org.mockito.Mock +import org.mockito.MockitoAnnotations +import org.powermock.reflect.Whitebox +import org.robolectric.Robolectric +import org.robolectric.RobolectricTestRunner +import org.robolectric.RuntimeEnvironment +import org.robolectric.Shadows +import org.robolectric.annotation.Config +import org.robolectric.annotation.LooperMode +import org.wikipedia.AppAdapter +import java.lang.reflect.Field + +/** + * Custom Selector Folder Fragment Test. + */ +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [21], application = TestCommonsApplication::class) +@LooperMode(LooperMode.Mode.PAUSED) +class FolderFragmentTest { + + private lateinit var fragment: FolderFragment + private lateinit var view: View + private lateinit var selectorRV : RecyclerView + private lateinit var loader : ProgressBar + private lateinit var layoutInflater: LayoutInflater + private lateinit var context: Context + private lateinit var viewModelField:Field + + @Mock + private lateinit var adapter: FolderAdapter + + @Mock + private lateinit var savedInstanceState: Bundle + + /** + * Setup the folder fragment. + */ + @Before + fun setUp() { + MockitoAnnotations.initMocks(this) + context = RuntimeEnvironment.application.applicationContext + AppAdapter.set(TestAppAdapter()) + SoLoader.setInTestMode() + Fresco.initialize(context) + val activity = Robolectric.buildActivity(CustomSelectorActivity::class.java).create().get() + + fragment = FolderFragment.newInstance() + val fragmentManager: FragmentManager = activity.supportFragmentManager + val fragmentTransaction: FragmentTransaction = fragmentManager.beginTransaction() + fragmentTransaction.add(fragment, null) + fragmentTransaction.commit() + + layoutInflater = LayoutInflater.from(activity) + view = layoutInflater.inflate(R.layout.fragment_custom_selector, null) as View + + selectorRV = view.findViewById(R.id.selector_rv) + loader = view.findViewById(R.id.loader) + + Whitebox.setInternalState(fragment, "folderAdapter", adapter) + Whitebox.setInternalState(fragment, "selectorRV", selectorRV ) + Whitebox.setInternalState(fragment, "loader", loader) + + viewModelField = fragment.javaClass.getDeclaredField("viewModel") + viewModelField.isAccessible = true + } + + /** + * Test onCreateView + */ + @Test + @Throws(Exception::class) + fun testOnCreateView() { + Shadows.shadowOf(Looper.getMainLooper()).idle() + viewModelField.set(fragment, null) + fragment.onCreateView(layoutInflater, null, savedInstanceState) + } + + /** + * Test onCreate + */ + @Test + @Throws(Exception::class) + fun testOnCreate() { + Shadows.shadowOf(Looper.getMainLooper()).idle() + fragment.onCreate(savedInstanceState) + } + + /** + * Test columnCount. + */ + @Test + fun testColumnCount() { + val func = fragment.javaClass.getDeclaredMethod("columnCount") + func.isAccessible = true + assertEquals(2, func.invoke(fragment)) + } + + /** + * Test handleResult. + */ + @Test + fun testHandleResult() { + val func = fragment.javaClass.getDeclaredMethod("handleResult", Result::class.java) + func.isAccessible = true + func.invoke(fragment, Result(CallbackStatus.SUCCESS, arrayListOf())) + } + + /** + * Test onResume. + */ + @Test + fun testOnResume() { + val func = fragment.javaClass.getDeclaredMethod("onResume") + func.isAccessible = true + func.invoke(fragment) + } + +} \ No newline at end of file diff --git a/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/ImageFileLoaderTest.kt b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/ImageFileLoaderTest.kt new file mode 100644 index 000000000..e30d47216 --- /dev/null +++ b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/ImageFileLoaderTest.kt @@ -0,0 +1,123 @@ +package fr.free.nrw.commons.customselector.ui.selector + +import android.content.ContentResolver +import android.content.Context +import android.provider.MediaStore +import com.nhaarman.mockitokotlin2.anyOrNull +import com.nhaarman.mockitokotlin2.doReturn +import com.nhaarman.mockitokotlin2.mock +import com.nhaarman.mockitokotlin2.same +import fr.free.nrw.commons.TestCommonsApplication +import fr.free.nrw.commons.customselector.listeners.ImageLoaderListener +import kotlinx.coroutines.CoroutineScope +import kotlinx.coroutines.Dispatchers +import org.junit.Before +import org.junit.Test +import org.junit.runner.RunWith +import org.mockito.Mock +import org.mockito.Mockito.`when` +import org.mockito.MockitoAnnotations +import org.powermock.reflect.Whitebox +import org.robolectric.RobolectricTestRunner +import org.robolectric.annotation.Config +import org.robolectric.annotation.LooperMode +import org.robolectric.fakes.RoboCursor +import java.io.File +import kotlin.coroutines.CoroutineContext + +/** + * Custom Selector Image File loader test. + */ +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [21], application = TestCommonsApplication::class) +@LooperMode(LooperMode.Mode.PAUSED) +class ImageFileLoaderTest { + + @Mock + private lateinit var mockContentResolver: ContentResolver + + @Mock + private lateinit var context: Context; + + @Mock + private lateinit var imageLoaderListener: ImageLoaderListener + + @Mock + private lateinit var coroutineScope: CoroutineScope + + private lateinit var imageCursor: RoboCursor + private lateinit var coroutineContext: CoroutineContext + private lateinit var projection: List + private lateinit var imageFileLoader: ImageFileLoader + + /** + * Setup before tests. + */ + @Before + fun setup() { + MockitoAnnotations.initMocks(this) + coroutineContext = Dispatchers.Main + imageCursor = RoboCursor() + imageFileLoader = ImageFileLoader(context) + projection = listOf( + MediaStore.Images.Media._ID, + MediaStore.Images.Media.DISPLAY_NAME, + MediaStore.Images.Media.DATA, + MediaStore.Images.Media.BUCKET_ID, + MediaStore.Images.Media.BUCKET_DISPLAY_NAME + ) + + Whitebox.setInternalState(imageFileLoader, "coroutineContext", coroutineContext) + } + + /** + * Test loading device images. + */ + @Test + fun testLoadDeviceImages() { + imageFileLoader.loadDeviceImages(imageLoaderListener, coroutineScope) + } + + /** + * Test get images from the device function. + */ + @Test + fun testGetImages() { + val func = imageFileLoader.javaClass.getDeclaredMethod( + "getImages", + ImageLoaderListener::class.java + ) + func.isAccessible = true + + val image1 = arrayOf(1, "imageLoaderTestFile", "src/test/resources/imageLoaderTestFile", 1, "downloads") + val image2 = arrayOf(2, "imageLoaderTestFile", null, 1, "downloads") + File("src/test/resources/imageLoaderTestFile").createNewFile() + + imageCursor.setColumnNames(projection) + imageCursor.setResults(arrayOf(image1, image2)); + + val contentResolver: ContentResolver = mock { + on { + query( + same(MediaStore.Images.Media.EXTERNAL_CONTENT_URI), + anyOrNull(), + anyOrNull(), + anyOrNull(), + anyOrNull() + ) + } doReturn imageCursor; + } + + // test null cursor. + `when`( + context.contentResolver + ).thenReturn(mockContentResolver) + func.invoke(imageFileLoader, imageLoaderListener); + + // test demo cursor. + `when`( + context.contentResolver + ).thenReturn(contentResolver) + func.invoke(imageFileLoader, imageLoaderListener); + } +} \ No newline at end of file diff --git a/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/ImageFragmentTest.kt b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/ImageFragmentTest.kt new file mode 100644 index 000000000..10ebcc4e8 --- /dev/null +++ b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/ImageFragmentTest.kt @@ -0,0 +1,166 @@ +package fr.free.nrw.commons.customselector.ui.selector + +import android.content.Context +import android.os.Bundle +import android.os.Looper +import android.os.Looper.getMainLooper +import android.view.LayoutInflater +import android.view.View +import android.widget.ProgressBar +import androidx.fragment.app.FragmentManager +import androidx.fragment.app.FragmentTransaction +import androidx.recyclerview.widget.GridLayoutManager +import androidx.recyclerview.widget.RecyclerView +import com.facebook.drawee.backends.pipeline.Fresco +import com.facebook.soloader.SoLoader +import com.nhaarman.mockitokotlin2.whenever +import fr.free.nrw.commons.R +import fr.free.nrw.commons.TestAppAdapter +import fr.free.nrw.commons.TestCommonsApplication +import fr.free.nrw.commons.customselector.model.CallbackStatus +import fr.free.nrw.commons.customselector.model.Image +import fr.free.nrw.commons.customselector.model.Result +import fr.free.nrw.commons.customselector.ui.adapter.ImageAdapter +import org.junit.Before +import org.junit.Test +import org.junit.jupiter.api.Assertions.assertEquals +import org.junit.runner.RunWith +import org.mockito.Mock +import org.mockito.MockitoAnnotations +import org.powermock.reflect.Whitebox +import org.robolectric.Robolectric +import org.robolectric.RobolectricTestRunner +import org.robolectric.RuntimeEnvironment +import org.robolectric.Shadows +import org.robolectric.Shadows.shadowOf +import org.robolectric.annotation.Config +import org.robolectric.annotation.LooperMode +import org.wikipedia.AppAdapter +import java.lang.reflect.Field + +/** + * Custom Selector Image Fragment Test. + */ +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [21], application = TestCommonsApplication::class) +@LooperMode(LooperMode.Mode.PAUSED) +class ImageFragmentTest { + + private lateinit var fragment: ImageFragment + private lateinit var view: View + private lateinit var selectorRV : RecyclerView + private lateinit var loader : ProgressBar + private lateinit var layoutInflater: LayoutInflater + private lateinit var context: Context + private lateinit var viewModelField: Field + + @Mock + private lateinit var layoutManager: GridLayoutManager + + @Mock + private lateinit var image: Image + + @Mock + private lateinit var adapter: ImageAdapter + + @Mock + private lateinit var savedInstanceState: Bundle + + /** + * Setup the image fragment. + */ + @Before + fun setUp(){ + MockitoAnnotations.initMocks(this) + context = RuntimeEnvironment.application.applicationContext + AppAdapter.set(TestAppAdapter()) + SoLoader.setInTestMode() + Fresco.initialize(context) + val activity = Robolectric.buildActivity(CustomSelectorActivity::class.java).create().get() + + fragment = ImageFragment.newInstance(1,0) + val fragmentManager: FragmentManager = activity.supportFragmentManager + val fragmentTransaction: FragmentTransaction = fragmentManager.beginTransaction() + fragmentTransaction.add(fragment, null) + fragmentTransaction.commit() + + layoutInflater = LayoutInflater.from(activity) + view = layoutInflater.inflate(R.layout.fragment_custom_selector, null, false) as View + selectorRV = view.findViewById(R.id.selector_rv) + loader = view.findViewById(R.id.loader) + + Whitebox.setInternalState(fragment, "imageAdapter", adapter) + Whitebox.setInternalState(fragment, "selectorRV", selectorRV ) + Whitebox.setInternalState(fragment, "loader", loader) + + viewModelField = fragment.javaClass.getDeclaredField("viewModel") + viewModelField.isAccessible = true + } + + /** + * Test onCreate + */ + @Test + @Throws(Exception::class) + fun testOnCreate(){ + Shadows.shadowOf(Looper.getMainLooper()).idle() + fragment.onCreate(savedInstanceState); + } + + /** + * Test onCreateView + */ + @Test + @Throws(Exception::class) + fun testOnCreateView() { + Shadows.shadowOf(Looper.getMainLooper()).idle() + viewModelField.set(fragment, null) + fragment.onCreateView(layoutInflater, null, savedInstanceState) + } + + /** + * Test handleResult. + */ + @Test + fun testHandleResult(){ + val func = fragment.javaClass.getDeclaredMethod("handleResult", Result::class.java) + func.isAccessible = true + func.invoke(fragment, Result(CallbackStatus.SUCCESS, arrayListOf())) + func.invoke(fragment, Result(CallbackStatus.SUCCESS, arrayListOf(image,image))) + } + + /** + * Test getSpanCount. + */ + @Test + fun testGetSpanCount() { + val func = fragment.javaClass.getDeclaredMethod("getSpanCount") + func.isAccessible = true + assertEquals(3, func.invoke(fragment)) + } + + + /** + * Test onResume. + */ + @Test + fun testOnResume() { + val func = fragment.javaClass.getDeclaredMethod("onResume") + func.isAccessible = true + func.invoke(fragment) + } + + /** + * Test onDestroy. + */ + @Test + fun testOnDestroy() { + shadowOf(getMainLooper()).idle() + selectorRV.layoutManager = layoutManager + whenever(layoutManager.findFirstVisibleItemPosition()).thenReturn(1) + val func = fragment.javaClass.getDeclaredMethod("onDestroy") + func.isAccessible = true + func.invoke(fragment) + } + +} \ No newline at end of file diff --git a/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/ImageLoaderTest.kt b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/ImageLoaderTest.kt new file mode 100644 index 000000000..fe26921e5 --- /dev/null +++ b/app/src/test/kotlin/fr/free/nrw/commons/customselector/ui/selector/ImageLoaderTest.kt @@ -0,0 +1,220 @@ +package fr.free.nrw.commons.customselector.ui.selector + +import android.content.ContentResolver +import android.content.Context +import android.net.Uri +import com.nhaarman.mockitokotlin2.* +import fr.free.nrw.commons.TestCommonsApplication +import fr.free.nrw.commons.customselector.database.UploadedStatus +import fr.free.nrw.commons.customselector.database.UploadedStatusDao +import fr.free.nrw.commons.customselector.model.Image +import fr.free.nrw.commons.customselector.ui.adapter.ImageAdapter +import fr.free.nrw.commons.filepicker.PickedFiles +import fr.free.nrw.commons.filepicker.UploadableFile +import fr.free.nrw.commons.media.MediaClient +import fr.free.nrw.commons.upload.FileProcessor +import fr.free.nrw.commons.upload.FileUtilsWrapper +import io.reactivex.Single +import junit.framework.Assert +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.ExperimentalCoroutinesApi +import kotlinx.coroutines.test.* +import org.junit.After +import org.junit.Before +import org.junit.Test +import org.junit.runner.RunWith +import org.mockito.* +import org.powermock.api.mockito.PowerMockito +import org.powermock.core.classloader.annotations.PrepareForTest +import org.powermock.modules.junit4.PowerMockRunner +import org.powermock.reflect.Whitebox +import org.robolectric.annotation.Config +import java.io.File +import java.io.FileInputStream +import java.util.* +import kotlin.collections.HashMap + +/** + * Image Loader Test. + */ +@RunWith(PowerMockRunner::class) +@PrepareForTest(PickedFiles::class) +@Config(sdk = [21], application = TestCommonsApplication::class) +@ExperimentalCoroutinesApi +class ImageLoaderTest { + + @Mock + private lateinit var uri:Uri + + @Mock + private lateinit var mediaClient: MediaClient + + @Mock + private lateinit var single: Single + + @Mock + private lateinit var fileProcessor: FileProcessor + + @Mock + private lateinit var fileUtilsWrapper: FileUtilsWrapper + + @Mock + private lateinit var uploadedStatusDao: UploadedStatusDao + + @Mock + private lateinit var holder: ImageAdapter.ImageViewHolder + + @Mock + private lateinit var context: Context + + @Mock + private lateinit var uploadableFile: UploadableFile + + @Mock + private lateinit var inputStream: FileInputStream + + @Mock + private lateinit var contentResolver: ContentResolver + + @ExperimentalCoroutinesApi + private val testDispacher = TestCoroutineDispatcher() + + private lateinit var imageLoader: ImageLoader; + private var mapImageSHA1: HashMap = HashMap() + private var mapHolderImage : HashMap = HashMap() + private var mapResult: HashMap = HashMap() + private var mapModifiedImageSHA1: HashMap = HashMap() + private lateinit var image: Image; + private lateinit var uploadedStatus: UploadedStatus; + + /** + * Setup before test. + */ + @Before + @ExperimentalCoroutinesApi + fun setup() { + Dispatchers.setMain(testDispacher) + MockitoAnnotations.initMocks(this) + + imageLoader = + ImageLoader(mediaClient, fileProcessor, fileUtilsWrapper, uploadedStatusDao, context) + uploadedStatus= UploadedStatus( + "testSha1", + "testSha1", + false, + false, + Calendar.getInstance().time + ) + image = Image(1, "test", uri, "test", 0, "test") + + Whitebox.setInternalState(imageLoader, "mapImageSHA1", mapImageSHA1); + Whitebox.setInternalState(imageLoader, "mapHolderImage", mapHolderImage); + Whitebox.setInternalState(imageLoader, "mapModifiedImageSHA1", mapModifiedImageSHA1); + Whitebox.setInternalState(imageLoader, "mapResult", mapResult); + Whitebox.setInternalState(imageLoader, "context", context) + Whitebox.setInternalState(imageLoader, "ioDispatcher", testDispacher) + Whitebox.setInternalState(imageLoader, "defaultDispatcher", testDispacher) + + whenever(contentResolver.openInputStream(uri)).thenReturn(inputStream) + whenever(context.contentResolver).thenReturn(contentResolver) + whenever(fileUtilsWrapper.getSHA1(inputStream)).thenReturn("testSha1") + } + + /** + * Reset Dispatchers. + */ + @After + @ExperimentalCoroutinesApi + fun tearDown() { + Dispatchers.resetMain() + testDispacher.cleanupTestCoroutines() + } + + /** + * Test queryAndSetView with upload Status as null. + */ + @Test + fun testQueryAndSetViewUploadedStatusNull() = testDispacher.runBlockingTest { + whenever(uploadedStatusDao.getUploadedFromImageSHA1(any())).thenReturn(null) + mapModifiedImageSHA1[image] = "testSha1" + mapImageSHA1[uri] = "testSha1" + + mapResult["testSha1"] = ImageLoader.Result.TRUE + imageLoader.queryAndSetView(holder, image) + + mapResult["testSha1"] = ImageLoader.Result.FALSE + imageLoader.queryAndSetView(holder, image) + } + + /** + * Test queryAndSetView with upload Status not null (ie retrieved from table) + */ + @Test + fun testQueryAndSetViewUploadedStatusNotNull() = testDispacher.runBlockingTest { + whenever(uploadedStatusDao.getUploadedFromImageSHA1(any())).thenReturn(uploadedStatus) + imageLoader.queryAndSetView(holder, image) + } + + /** + * Test querySha1 + */ + @Test + fun testQuerySha1() = testDispacher.runBlockingTest { + + whenever(single.blockingGet()).thenReturn(true) + whenever(mediaClient.checkFileExistsUsingSha("testSha1")).thenReturn(single) + whenever(fileUtilsWrapper.getSHA1(any())).thenReturn("testSha1") + + imageLoader.querySHA1("testSha1") + } + + /** + * Test getSha1 + */ + @Test + @ExperimentalCoroutinesApi + fun testGetSha1() = testDispacher.runBlockingTest { + + PowerMockito.mockStatic(PickedFiles::class.java) + BDDMockito.given(PickedFiles.pickedExistingPicture(context, image.uri)) + .willReturn(UploadableFile(uri, File("ABC"))) + + + whenever(fileUtilsWrapper.getFileInputStream("ABC")).thenReturn(inputStream) + whenever(fileUtilsWrapper.getSHA1(inputStream)).thenReturn("testSha1") + + Assert.assertEquals("testSha1", imageLoader.getSHA1(image)); + whenever(PickedFiles.pickedExistingPicture(context, Uri.parse("test"))).thenReturn( + uploadableFile + ) + + mapModifiedImageSHA1[image] = "testSha2" + Assert.assertEquals("testSha2", imageLoader.getSHA1(image)); + } + + /** + * Test getResultFromUploadedStatus. + */ + @Test + fun testGetResultFromUploadedStatus() { + val func = imageLoader.javaClass.getDeclaredMethod( + "getResultFromUploadedStatus", + UploadedStatus::class.java) + func.isAccessible = true + + // test Result.INVALID + uploadedStatus.lastUpdated = Date(0); + Assert.assertEquals(ImageLoader.Result.INVALID, + imageLoader.getResultFromUploadedStatus(uploadedStatus)) + + // test Result.TRUE + uploadedStatus.imageResult = true; + Assert.assertEquals(ImageLoader.Result.TRUE, + imageLoader.getResultFromUploadedStatus(uploadedStatus)) + } + + @Test + fun testCleanUP() { + imageLoader.cleanUP() + } +} \ No newline at end of file diff --git a/app/src/test/kotlin/fr/free/nrw/commons/filepicker/FilePickerTest.kt b/app/src/test/kotlin/fr/free/nrw/commons/filepicker/FilePickerTest.kt index b9712df04..ae841cd1c 100644 --- a/app/src/test/kotlin/fr/free/nrw/commons/filepicker/FilePickerTest.kt +++ b/app/src/test/kotlin/fr/free/nrw/commons/filepicker/FilePickerTest.kt @@ -54,4 +54,14 @@ class FilePickerTest { verify(activity).startActivityForResult(ArgumentMatchers.anyObject(), requestCodeCaptor?.capture()?.toInt()!!) assertEquals(requestCodeCaptor?.value, RequestCodes.TAKE_PICTURE) } + + @Test + fun testOpenCustomSelectorRequestCode() { + `when`(PreferenceManager.getDefaultSharedPreferences(activity)).thenReturn(sharedPref) + `when`(sharedPref.edit()).thenReturn(sharedPreferencesEditor) + `when`(sharedPref.edit().putInt("type", 0)).thenReturn(sharedPreferencesEditor) + FilePicker.openCustomSelector(activity, 0) + verify(activity).startActivityForResult(ArgumentMatchers.anyObject(), requestCodeCaptor?.capture()?.toInt()!!) + assertEquals(requestCodeCaptor?.value, RequestCodes.PICK_PICTURE_FROM_CUSTOM_SELECTOR) + } } \ No newline at end of file diff --git a/app/src/test/resources/imageLoaderTestFile b/app/src/test/resources/imageLoaderTestFile new file mode 100644 index 000000000..e69de29bb