FileAction.kt

/*
 * Nextcloud - Android Client
 *
 * SPDX-FileCopyrightText: 2025 Alper Ozturk <alper.ozturk@nextcloud.com>
 * SPDX-FileCopyrightText: 2022 Álvaro Brey <alvaro@alvarobrey.com>
 * SPDX-FileCopyrightText: 2022 Nextcloud GmbH
 * SPDX-License-Identifier: AGPL-3.0-or-later OR GPL-2.0-only
 */
package com.nextcloud.ui.fileactions

import androidx.annotation.DrawableRes
import androidx.annotation.IdRes
import androidx.annotation.StringRes
import com.owncloud.android.R
import com.owncloud.android.datamodel.OCFile

enum class FileAction(
    @param:IdRes val id: Int,
    @param:StringRes val title: Int,
    @param:DrawableRes val icon: Int? = null
) {
    // selection
    SELECT_ALL(R.id.action_select_all_action_menu, R.string.select_all, R.drawable.ic_select_all),
    SELECT_NONE(R.id.action_deselect_all_action_menu, R.string.deselect_all, R.drawable.ic_select_none),

    // generic file actions
    EDIT(R.id.action_edit, R.string.action_edit, R.drawable.ic_edit),
    SEE_DETAILS(R.id.action_see_details, R.string.actionbar_see_details, R.drawable.ic_information_outline),
    REMOVE_FILE(R.id.action_remove_file, R.string.common_remove, R.drawable.ic_delete),
    LEAVE_SHARE(R.id.action_remove_file, R.string.common_leave_this_share, R.drawable.ic_cancel),

    // File moving
    RENAME_FILE(R.id.action_rename_file, R.string.common_rename, R.drawable.ic_rename),
    MOVE_OR_COPY(R.id.action_move_or_copy, R.string.actionbar_move_or_copy, R.drawable.ic_external),

    // favorites
    FAVORITE(R.id.action_favorite, R.string.favorite, R.drawable.ic_star_outline),
    UNSET_FAVORITE(R.id.action_unset_favorite, R.string.unset_favorite, R.drawable.ic_star),

    // Uploads and downloads
    DOWNLOAD_FILE(R.id.action_download_file, R.string.filedetails_download, R.drawable.ic_cloud_download),
    DOWNLOAD_FOLDER(R.id.action_sync_file, R.string.filedetails_sync_file, R.drawable.ic_sync),
    DOWNLOAD_FOLDER_RECURSIVE(R.id.action_sync_file_recursive, R.string.filedetails_sync_file_recursive, R.drawable.ic_sync),
    CANCEL_SYNC(R.id.action_cancel_sync, R.string.common_cancel_sync, R.drawable.ic_sync_off),

    // File sharing
    EXPORT_FILE(R.id.action_export_file, R.string.filedetails_export, R.drawable.ic_export),
    SEND_SHARE_FILE(R.id.action_send_share_file, R.string.action_send_share, R.drawable.ic_share),
    SEND_FILE(R.id.action_send_file, R.string.common_send, R.drawable.ic_share),
    OPEN_FILE_WITH(R.id.action_open_file_with, R.string.actionbar_open_with, R.drawable.ic_external),
    STREAM_MEDIA(R.id.action_stream_media, R.string.stream, R.drawable.ic_play_arrow),
    SET_AS_WALLPAPER(R.id.action_set_as_wallpaper, R.string.set_picture_as, R.drawable.ic_wallpaper),

    // Encryption
    SET_ENCRYPTED(R.id.action_encrypted, R.string.encrypted, R.drawable.ic_encrypt),
    UNSET_ENCRYPTED(R.id.action_unset_encrypted, R.string.unset_encrypted, R.drawable.ic_decrypt),

    // locks
    UNLOCK_FILE(R.id.action_unlock_file, R.string.unlock_file, R.drawable.ic_lock_open_white),
    LOCK_FILE(R.id.action_lock_file, R.string.lock_file, R.drawable.ic_lock),

    // Shortcuts
    PIN_TO_HOMESCREEN(R.id.action_pin_to_homescreen, R.string.pin_home, R.drawable.add_to_home_screen),

    // Retry for offline operation
    RETRY(R.id.action_retry, R.string.retry, R.drawable.ic_retry);

    constructor(id: Int, title: Int) : this(id, title, null)

    companion object {
        /**
         * All file actions, in the order they should be displayed
         */
        fun getActions(files: Collection<OCFile>): List<FileAction> {
            return mutableListOf(
                UNLOCK_FILE,
                EDIT,
                FAVORITE,
                UNSET_FAVORITE,
                SEE_DETAILS,
                LOCK_FILE,
                RENAME_FILE,
                MOVE_OR_COPY,
                DOWNLOAD_FILE,
                EXPORT_FILE,
                STREAM_MEDIA,
                SEND_SHARE_FILE,
                SEND_FILE,
                OPEN_FILE_WITH,
                DOWNLOAD_FOLDER,
                CANCEL_SYNC,
                SELECT_ALL,
                SELECT_NONE,
                SET_ENCRYPTED,
                UNSET_ENCRYPTED,
                SET_AS_WALLPAPER,
                PIN_TO_HOMESCREEN,
                RETRY
            ).apply {
                val deleteOrLeaveShareAction = getDeleteOrLeaveShareAction(files) ?: return@apply
                add(deleteOrLeaveShareAction)
            }
        }

        fun getFilePreviewActions(file: OCFile?): List<Int> {
            val result = mutableSetOf(
                R.id.action_rename_file,
                R.id.action_sync_file,
                R.id.action_move_or_copy,
                R.id.action_favorite,
                R.id.action_unset_favorite,
                R.id.action_pin_to_homescreen
            )

            if (file != null) {
                val actionsToHide = getActionsToHide(setOf(file))
                result.removeAll(actionsToHide)
            }

            return result.toList()
        }

        fun getFileDetailActions(file: OCFile?): List<Int> {
            val result = mutableSetOf(
                R.id.action_lock_file,
                R.id.action_unlock_file,
                R.id.action_edit,
                R.id.action_favorite,
                R.id.action_unset_favorite,
                R.id.action_see_details,
                R.id.action_move_or_copy,
                R.id.action_stream_media,
                R.id.action_send_share_file,
                R.id.action_pin_to_homescreen
            )

            if (file?.isFolder == true) {
                result.add(R.id.action_send_file)
                result.add(R.id.action_sync_file)
                result.add(R.id.action_sync_file_recursive)
            }

            if (file?.isAPKorAAB == true) {
                result.add(R.id.action_download_file)
                result.add(R.id.action_export_file)
            }

            if (file != null) {
                val actionsToHide = getActionsToHide(setOf(file))
                result.removeAll(actionsToHide)
            }

            return result.toList()
        }

        fun getFileListActionsToHide(checkedFiles: Set<OCFile>): List<Int> {
            val result = mutableSetOf<Int>()

            if (checkedFiles.any { it.isOfflineOperation }) {
                result.addAll(
                    listOf(
                        R.id.action_favorite,
                        R.id.action_move_or_copy,
                        R.id.action_sync_file,
                        R.id.action_encrypted,
                        R.id.action_unset_encrypted,
                        R.id.action_edit,
                        R.id.action_download_file,
                        R.id.action_export_file,
                        R.id.action_set_as_wallpaper
                    )
                )
            }

            if (checkedFiles.any { it.isAPKorAAB }) {
                result.addAll(
                    listOf(
                        R.id.action_send_share_file,
                        R.id.action_export_file,
                        R.id.action_sync_file,
                        R.id.action_download_file
                    )
                )
            }

            val actionsToHide = getActionsToHide(checkedFiles)
            result.addAll(actionsToHide)

            return result.toList()
        }

        fun getActionsToHide(files: Set<OCFile>): List<Int> {
            if (files.isEmpty()) return emptyList()

            val result = mutableListOf<Int>()

            if (files.any { !it.canReshare() }) {
                result.add(R.id.action_send_share_file)
            }

            if (files.any { !it.canRename() }) {
                result.add(R.id.action_rename_file)
            }

            if (files.any { !it.canMove() }) {
                result.add(R.id.action_move_or_copy)
            }

            if (files.any { !it.canWrite() }) {
                result.add(R.id.action_edit)
            }

            if (files.any { it.isRecommendedFile }) {
                val allowedForRecommended = setOf(
                    R.id.action_see_details,
                    R.id.action_set_as_wallpaper,
                    R.id.action_pin_to_homescreen,
                    R.id.action_open_file_with
                )

                val allActions = entries.map { it.id }
                result.addAll(allActions - allowedForRecommended)
            }

            return result
        }

        private fun getDeleteOrLeaveShareAction(files: Collection<OCFile>): FileAction? {
            if (files.any { !it.canDeleteOrLeaveShare() }) {
                return null
            }

            return if (files.any { it.isSharedWithMe }) {
                LEAVE_SHARE
            } else {
                REMOVE_FILE
            }
        }
    }
}