apps-android-commons/app/src/main/java/fr/free/nrw/commons/Media.kt

package fr.free.nrw.commons

import android.os.Parcelable
import fr.free.nrw.commons.BuildConfig.COMMONS_URL
import fr.free.nrw.commons.location.LatLng
import fr.free.nrw.commons.wikidata.model.WikiSite
import fr.free.nrw.commons.wikidata.model.page.PageTitle
import kotlinx.parcelize.IgnoredOnParcel
import kotlinx.parcelize.Parcelize
import java.util.Date
import java.util.Locale
import java.util.UUID

@Parcelize
class Media constructor(
    /**
     * @return pageId for the current media object
     * Wikibase Identifier associated with media files
     */
    var pageId: String = UUID.randomUUID().toString(),
    var thumbUrl: String? = null,
    /**
     * Gets image URL
     * @return Image URL
     */
    var imageUrl: String? = null,
    /**
     * Gets the name of the file.
     * @return file name as a string
     */
    var filename: String? = null,
    /**
     * The fallback description of the file, used if no other description is provided.
     */
    var fallbackDescription: String? = null,
    /**
     * Gets the upload date of the file.
     * Can be null.
     * @return upload date as a Date
     */
    var dateUploaded: Date? = null,
    /**
     * The license name of the file.
     */
    var license: String? = null,
    /**
     * The URL corresponding to the license.
     */
    var licenseUrl: String? = null,
    /**
     * The name of the creator of the file.
     */
    var author: String? = null,
    /**
     * The username of the uploader.
     */
    var user: String? = null,
    /**
     * The full name of the file's creator, if different from username.
     */
    var creatorName: String? = null,
    /**
     * Gets the categories the file falls under.
     * @return file categories as an ArrayList of Strings
     */
    var categories: List<String>? = null,
    /**
     * Gets the coordinates of where the file was created.
     * @return file coordinates as a LatLng
     */
    var coordinates: LatLng? = null,
    var captions: Map<String, String> = emptyMap(),
    var descriptions: Map<String, String> = emptyMap(),
    var depictionIds: List<String> = emptyList(),
    var creatorIds: List<String> = emptyList(),
    /**
     * This field was added to find non-hidden categories
     * Stores the mapping of category title to hidden attribute
     * Example: "Mountains" => false, "CC-BY-SA-2.0" => true
     */
    var categoriesHiddenStatus: Map<String, Boolean> = emptyMap(),
) : Parcelable {
    constructor(
        captions: Map<String, String>,
        categories: List<String>?,
        filename: String?,
        fallbackDescription: String?,
        author: String?,
        user: String?,
    ) : this(
        filename = filename,
        fallbackDescription = fallbackDescription,
        dateUploaded = Date(),
        author = author,
        user = user,
        categories = categories,
        captions = captions,
    )

    constructor(
        captions: Map<String, String>,
        categories: List<String>?,
        filename: String?,
        fallbackDescription: String?,
        author: String?,
        user: String?,
        dateUploaded: Date? = Date(),
        license: String? = null,
        licenseUrl: String? = null,
        imageUrl: String? = null,
        thumbUrl: String? = null,
        coordinates: LatLng? = null,
        descriptions: Map<String, String> = emptyMap(),
        depictionIds: List<String> = emptyList(),
        categoriesHiddenStatus: Map<String, Boolean> = emptyMap()
    ) : this(
        pageId = UUID.randomUUID().toString(),
        filename = filename,
        fallbackDescription = fallbackDescription,
        dateUploaded = dateUploaded,
        author = author,
        user = user,
        categories = categories,
        captions = captions,
        license = license,
        licenseUrl = licenseUrl,
        imageUrl = imageUrl,
        thumbUrl = thumbUrl,
        coordinates = coordinates,
        descriptions = descriptions,
        depictionIds = depictionIds,
        categoriesHiddenStatus = categoriesHiddenStatus
    )

    /**
     * Returns Author if it's not null or empty, otherwise
     * returns user
     * @return Author or User
     */
    @Deprecated("Use user for uploader username. Use attributedAuthor() for attribution. Note that the uploader may not be the creator/author.")
    fun getAuthorOrUser(): String? {
        return if (!author.isNullOrEmpty()) {
            author
        } else{
            user
        }
    }

    /**
     * Returns author if it's not null or empty, otherwise
     * returns creator name
     * @return name of author or creator
     */
    fun getAttributedAuthor(): String? {
        return if (!author.isNullOrEmpty()) {
            author
        } else{
            creatorName
        }
    }

    /**
     * Gets media display title
     * @return Media title
     */
    val displayTitle: String
        get() =
            if (filename != null) {
                pageTitle.displayTextWithoutNamespace.replaceFirst("[.][^.]+$".toRegex(), "")
            } else {
                ""
            }

    /**
     * Gets file page title
     * @return New media page title
     */
    val pageTitle: PageTitle
        get() = PageTitle(filename!!, WikiSite(COMMONS_URL))

    /**
     * Returns wikicode to use the media file on a MediaWiki site
     * @return
     */
    val wikiCode: String
        get() = String.format("[[%s|thumb|%s]]", filename, mostRelevantCaption)

    val mostRelevantCaption: String
        get() =
            captions[Locale.getDefault().language]
                ?: captions.values.firstOrNull()
                ?: displayTitle

    /**
     * Gets the categories the file falls under.
     * @return file categories as an ArrayList of Strings
     */
    @IgnoredOnParcel
    var addedCategories: List<String>? = null
        // TODO added categories should be removed. It is added for a short fix. On category update,
        //  categories should be re-fetched instead
        get() = field // getter
        set(value) {
            field = value
        } // setter
}