iceraven-browser/app/src/main/java/org/mozilla/fenix/wallpapers/LegacyWallpaperFileManager.kt

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

package org.mozilla.fenix.wallpapers

import kotlinx.coroutines.CoroutineDispatcher
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch
import kotlinx.coroutines.withContext
import java.io.File

/**
 * Manages various functions related to the locally-stored wallpaper assets.
 *
 * @property rootDirectory The top level app-local storage directory.
 * @param coroutineDispatcher Dispatcher used to execute suspending functions. Default parameter
 * should be likely be used except for when under test.
 */
class LegacyWallpaperFileManager(
    private val rootDirectory: File,
    coroutineDispatcher: CoroutineDispatcher = Dispatchers.IO,
) {
    private val scope = CoroutineScope(coroutineDispatcher)
    private val portraitDirectory = File(rootDirectory, "wallpapers/portrait")
    private val landscapeDirectory = File(rootDirectory, "wallpapers/landscape")

    /**
     * Lookup all the files for a wallpaper name. This lookup will fail if there are not
     * files for each of the following orientation and theme combinations:
     * light/portrait - light/landscape - dark/portrait - dark/landscape
     */
    suspend fun lookupExpiredWallpaper(name: String): Wallpaper? = withContext(Dispatchers.IO) {
        if (getAllLocalWallpaperPaths(name).all { File(rootDirectory, it).exists() }) {
            Wallpaper(
                name = name,
                collection = Wallpaper.DefaultCollection,
                textColor = null,
                cardColorLight = null,
                cardColorDark = null,
                thumbnailFileState = Wallpaper.ImageFileState.Unavailable,
                assetsFileState = Wallpaper.ImageFileState.Downloaded,
            )
        } else {
            null
        }
    }

    private fun getAllLocalWallpaperPaths(name: String): List<String> =
        listOf("landscape", "portrait").flatMap { orientation ->
            listOf("light", "dark").map { theme ->
                Wallpaper.legacyGetLocalPath(orientation, theme, name)
            }
        }

    /**
     * Remove all wallpapers that are not the [currentWallpaper] or in [availableWallpapers].
     */
    fun clean(currentWallpaper: Wallpaper, availableWallpapers: List<Wallpaper>) {
        scope.launch {
            val wallpapersToKeep = (listOf(currentWallpaper) + availableWallpapers).map { it.name }
            cleanChildren(portraitDirectory, wallpapersToKeep)
            cleanChildren(landscapeDirectory, wallpapersToKeep)
        }
    }

    private fun cleanChildren(dir: File, wallpapersToKeep: List<String>) {
        for (file in dir.walkTopDown()) {
            if (file.isDirectory || file.nameWithoutExtension in wallpapersToKeep) continue
            file.delete()
        }
    }
}