Skip to content

FolderDeletionHelper: Fix unintentional deletion of subfolders and non-images by custom selector #6027

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 13, 2024
Merged

FolderDeletionHelper: Fix unintentional deletion of subfolders and non-images by custom selector #6027

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0bed7e0
FolderDeletionHelper: Fix unintentional deletion
savsch Dec 13, 2024
95ae58a
Merge branch 'main' into fix/bug-subfolder-deletion
nicolas-raoul Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
153 changes: 76 additions & 77 deletions app/src/main/java/fr/free/nrw/commons/customselector/helper/FolderDeletionHelper.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,22 +30,29 @@ object FolderDeletionHelper {
folder: File,
trashFolderLauncher: ActivityResultLauncher<IntentSenderRequest>,
onDeletionComplete: (Boolean) -> Unit) {
val itemCount = countItemsInFolder(context, folder)
val folderPath = folder.absolutePath

//don't show this dialog on API 30+, it's handled automatically using MediaStore
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
val success = deleteFolderMain(context, folder, trashFolderLauncher)
val success = trashImagesInFolder(context, folder, trashFolderLauncher)
onDeletionComplete(success)

} else {
val imagePaths = listImagesInFolder(context, folder)
val imageCount = imagePaths.size
val folderPath = folder.absolutePath

AlertDialog.Builder(context)
.setTitle(context.getString(R.string.custom_selector_confirm_deletion_title))
.setMessage(context.getString(R.string.custom_selector_confirm_deletion_message, folderPath, itemCount))
.setMessage(
context.getString(
R.string.custom_selector_confirm_deletion_message,
folderPath,
imageCount
)
)
.setPositiveButton(context.getString(R.string.custom_selector_delete)) { _, _ ->

//proceed with deletion if user confirms
val success = deleteFolderMain(context, folder, trashFolderLauncher)
val success = deleteImagesLegacy(imagePaths)
onDeletionComplete(success)
}
.setNegativeButton(context.getString(R.string.custom_selector_cancel)) { dialog, _ ->
Expand All @@ -57,38 +64,16 @@ object FolderDeletionHelper {
}

/**
* Deletes the specified folder, handling different Android storage models based on the API
*
* @param context The context used to manage storage operations.
* @param folder The folder to delete.
* @param trashFolderLauncher An ActivityResultLauncher for handling the result of the trash request.
* @return `true` if the folder deletion was successful, `false` otherwise.
*/
private fun deleteFolderMain(
context: Context,
folder: File,
trashFolderLauncher: ActivityResultLauncher<IntentSenderRequest>): Boolean
{
return when {
//for API 30 and above, use MediaStore
Build.VERSION.SDK_INT >= Build.VERSION_CODES.R -> trashFolderContents(context, folder, trashFolderLauncher)

//for API 29 ('requestLegacyExternalStorage' is set to true in Manifest)
// and below use file system
else -> deleteFolderLegacy(folder)
}
}

/**
* Moves all contents of a specified folder to the trash on devices running
* Android 11 (API level 30) and above.
* Moves all images in a specified folder (but not within its subfolders) to the trash on
* devices running Android 11 (API level 30) and above.
*
* @param context The context used to access the content resolver.
* @param folder The folder whose contents are to be moved to the trash.
* @param trashFolderLauncher An ActivityResultLauncher for handling the result of the trash request.
* @param folder The folder whose top-level images are to be moved to the trash.
* @param trashFolderLauncher An ActivityResultLauncher for handling the result of the trash
* request.
* @return `true` if the trash request was initiated successfully, `false` otherwise.
*/
private fun trashFolderContents(
private fun trashImagesInFolder(
context: Context,
folder: File,
trashFolderLauncher: ActivityResultLauncher<IntentSenderRequest>): Boolean
Expand All @@ -99,66 +84,74 @@ object FolderDeletionHelper {
val folderPath = folder.absolutePath
val urisToTrash = mutableListOf<Uri>()

// Use URIs specific to media items
val mediaUris = listOf(
MediaStore.Images.Media.EXTERNAL_CONTENT_URI,
MediaStore.Video.Media.EXTERNAL_CONTENT_URI,
MediaStore.Audio.Media.EXTERNAL_CONTENT_URI
)

for (mediaUri in mediaUris) {
val selection = "${MediaStore.MediaColumns.DATA} LIKE ?"
val selectionArgs = arrayOf("$folderPath/%")

contentResolver.query(mediaUri, arrayOf(MediaStore.MediaColumns._ID), selection,
selectionArgs, null)
?.use{ cursor ->
val idColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns._ID)
while (cursor.moveToNext()) {
val id = cursor.getLong(idColumn)
val fileUri = ContentUris.withAppendedId(mediaUri, id)
urisToTrash.add(fileUri)
}
val mediaUri = MediaStore.Images.Media.EXTERNAL_CONTENT_URI

// select images contained in the folder but not within subfolders
val selection =
"${MediaStore.MediaColumns.DATA} LIKE ? AND ${MediaStore.MediaColumns.DATA} NOT LIKE ?"
val selectionArgs = arrayOf("$folderPath/%", "$folderPath/%/%")

contentResolver.query(
mediaUri, arrayOf(MediaStore.MediaColumns._ID), selection,
selectionArgs, null
)?.use { cursor ->
val idColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns._ID)
while (cursor.moveToNext()) {
val id = cursor.getLong(idColumn)
val fileUri = ContentUris.withAppendedId(mediaUri, id)
urisToTrash.add(fileUri)
}
}


//proceed with trashing if we have valid URIs
if (urisToTrash.isNotEmpty()) {
try {
val trashRequest = MediaStore.createTrashRequest(contentResolver, urisToTrash, true)
val intentSenderRequest = IntentSenderRequest.Builder(trashRequest.intentSender).build()
val intentSenderRequest =
IntentSenderRequest.Builder(trashRequest.intentSender).build()
trashFolderLauncher.launch(intentSenderRequest)
return true
} catch (e: SecurityException) {
Timber.tag("DeleteFolder").e(context.getString(R.string.custom_selector_error_trashing_folder_contents, e.message))
Timber.tag("DeleteFolder").e(
context.getString(
R.string.custom_selector_error_trashing_folder_contents,
e.message
)
)
}
}
return false
}


/**
* Counts the number of items in a specified folder, including items in subfolders.
* Lists all image file paths in the specified folder, excluding any subfolders.
*
* @param context The context used to access the content resolver.
* @param folder The folder in which to count items.
* @return The total number of items in the folder.
* @param folder The folder whose top-level images are to be listed.
* @return A list of file paths (as Strings) pointing to the images in the specified folder.
*/
private fun countItemsInFolder(context: Context, folder: File): Int {
private fun listImagesInFolder(context: Context, folder: File): List<String> {
val contentResolver = context.contentResolver
val folderPath = folder.absolutePath
val uri = MediaStore.Images.Media.EXTERNAL_CONTENT_URI
val selection = "${MediaStore.Images.Media.DATA} LIKE ?"
val selectionArgs = arrayOf("$folderPath/%")

return contentResolver.query(
uri,
arrayOf(MediaStore.Images.Media._ID),
selection,
selectionArgs,
null)?.use { cursor ->
cursor.count
} ?: 0
val mediaUri = MediaStore.Images.Media.EXTERNAL_CONTENT_URI
val selection =
"${MediaStore.MediaColumns.DATA} LIKE ? AND ${MediaStore.MediaColumns.DATA} NOT LIKE ?"
val selectionArgs = arrayOf("$folderPath/%", "$folderPath/%/%")
val imagePaths = mutableListOf<String>()

contentResolver.query(
mediaUri, arrayOf(MediaStore.MediaColumns.DATA), selection,
selectionArgs, null
)?.use { cursor ->
val dataColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DATA)
while (cursor.moveToNext()) {
val imagePath = cursor.getString(dataColumn)
imagePaths.add(imagePath)
}
}
return imagePaths
}


Expand All @@ -180,14 +173,20 @@ object FolderDeletionHelper {


/**
* Deletes a specified folder and all of its contents on devices running
* Deletes a list of image files specified by their paths, on
* Android 10 (API level 29) and below.
*
* @param folder The `File` object representing the folder to be deleted.
* @return `true` if the folder and all contents were deleted successfully; `false` otherwise.
* @param imagePaths A list of absolute file paths to image files that need to be deleted.
* @return `true` if all the images are successfully deleted, `false` otherwise.
*/
private fun deleteFolderLegacy(folder: File): Boolean {
return folder.deleteRecursively()
private fun deleteImagesLegacy(imagePaths: List<String>): Boolean {
var result = true
imagePaths.forEach {
val imageFile = File(it)
val deleted = imageFile.exists() && imageFile.delete()
result = result && deleted
}
return result
}


Expand Down