/*
 * Copyright (C) 2025 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.launcher3.homescreenfiles

import android.content.ContentResolver.NOTIFY_DELETE
import android.content.ContentResolver.NOTIFY_INSERT
import android.content.ContentResolver.NOTIFY_UPDATE
import android.net.Uri
import android.os.UserHandle
import androidx.annotation.VisibleForTesting
import com.android.launcher3.dagger.LauncherAppComponent
import com.android.launcher3.util.DaggerSingletonObject
import com.android.launcher3.util.ListenableStream
import java.util.concurrent.CompletableFuture
import java.util.concurrent.Future

/** Represents a single file or folder item queried by [HomeScreenFilesProvider]. */
data class HomeScreenFile(val displayName: String, val mimeType: String?, val isDirectory: Boolean)

/** An interface for managing file items to be shown on the home screen. */
interface HomeScreenFilesProvider {
    /**
     * Returns whether all URIs in the specified list can be moved to the home screen.
     *
     * @param uriList The list of URIs to consider.
     * @return Whether all URIs in the list can be moved.
     */
    fun canMoveToHomeScreen(uriList: List<Uri>?): Boolean

    /**
     * Attempts to asynchronously move all URIs in the specified list to the home screen.
     *
     * @param uriList The list of URIs to move.
     * @return List of futures indicating the success or failure of each move attempt. Futures are
     *   provided in the same order as the original list of URIs.
     */
    fun moveToHomeScreen(uriList: List<Uri>): List<CompletableFuture<Boolean>>

    /** Returns all eligible file items to be shown on the home screen. */
    fun query(): Lazy<Map<Uri, HomeScreenFile>>

    /**
     * Information about a change to a file item shown on the home screen.
     *
     * @param uri The URI of the item that was changed and
     * @param flags The bitmask describing the type of the file change (one of [NOTIFY_INSERT],
     *   [NOTIFY_UPDATE], [NOTIFY_DELETE]).
     * @param file Complete information about the file that is being changed.
     * @param user The user associated with this change event.
     */
    data class FileChange(
        val uri: Uri,
        val flags: Int,
        val file: Future<HomeScreenFile?>,
        val user: UserHandle,
    )

    /** A stream of changes to file items shown on the home screen. */
    val fileChanges: ListenableStream<FileChange>

    companion object {
        @JvmField
        @VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)
        val HOME_SCREEN_FOLDER_RELATIVE_PATH = "Home screen/"

        @JvmField
        val INSTANCE = DaggerSingletonObject(LauncherAppComponent::getHomeScreenFilesProvider)
    }
}