commonMain.com.multiplatform.webview.cookie.Cookie.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of compose-webview-multiplatform Show documentation

WebView for JetBrains Compose Multiplatform

There is a newer version: 1.9.40-alpha04

Show newest version

package com.multiplatform.webview.cookie

/**
 * Cookie data class.
 */
data class Cookie(
    /**
     * The cookie name.
     * */
    val name: String,
    /**
     * The cookie value.
     * */
    val value: String,
    /**
     * The cookie domain.
     * available on `Android` only if [androidx.webkit.WebViewFeature.GET_COOKIE_INFO] feature is supported.
     * */
    val domain: String? = null,
    /**
     * The cookie expiration date in milliseconds.
     * available on `Android` only if [androidx.webkit.WebViewFeature.GET_COOKIE_INFO] feature is supported.
     * */
    val path: String? = null,
    /**
     * The cookie expiration date in milliseconds.
     * available on `Android` only if [androidx.webkit.WebViewFeature.GET_COOKIE_INFO] feature is supported.
     * */
    val expiresDate: Long? = null,
    /**
     * Whether the cookie is only valid for the current session.
     * */
    val isSessionOnly: Boolean = false,
    /**
     * The cookie same site policy.
     * available on `Android` only if [androidx.webkit.WebViewFeature.GET_COOKIE_INFO] feature is supported.
     * */
    val sameSite: HTTPCookieSameSitePolicy? = null,
    /**
     * Whether the cookie is secure.
     * available on `Android` only if [androidx.webkit.WebViewFeature.GET_COOKIE_INFO] feature is supported.
     * */
    val isSecure: Boolean? = null,
    /**
     * Whether the cookie is HTTP only.
     * available on `Android` only if [androidx.webkit.WebViewFeature.GET_COOKIE_INFO] feature is supported.
     * */
    val isHttpOnly: Boolean? = null,
    /**
     * The cookie maximum age in seconds.
     * available on `Android` only if [androidx.webkit.WebViewFeature.GET_COOKIE_INFO] feature is supported.
     * */
    val maxAge: Long? = null,
) {
    enum class HTTPCookieSameSitePolicy {
        /**
         * The default value; allows cookies to be sent normally.
         */
        NONE,

        /**
         * Cookies are not sent with cross-site requests.
         */
        LAX,

        /**
         * Cookies are only sent with requests originating from the same website.
         */
        STRICT,
    }

    override fun toString(): String {
        var cookieValue = "$name=$value; Path=$path"

        if (domain != null) cookieValue += "; Domain=$domain"

        if (expiresDate != null) cookieValue += "; Expires=" + getCookieExpirationDate(expiresDate)

        if (maxAge != null) cookieValue += "; Max-Age=$maxAge"

        if (isSecure != null && isSecure) cookieValue += "; Secure"

        if (isHttpOnly != null && isHttpOnly) cookieValue += "; HttpOnly"

        if (sameSite != null) cookieValue += "; SameSite=$sameSite"

        cookieValue += ";"

        return cookieValue
    }
}

/**
 * Get cookie expiration date.
 * @param expiresDate The cookie expiration date in milliseconds.
 * @return The cookie expiration date in [String] format.
 * */
expect fun getCookieExpirationDate(expiresDate: Long): String