commonMain.io.ktor.client.request.utils.kt Maven / Gradle / Ivy

Go to download
/*
* Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
*/

package io.ktor.client.request

import io.ktor.http.*
import io.ktor.util.*
import io.ktor.util.date.*

/**
 * Gets the associated URL's host.
 */
public var HttpRequestBuilder.host: String
    get() = url.host
    set(value) {
        url.host = value
    }

/**
 * Gets the associated URL's port.
 */
public var HttpRequestBuilder.port: Int
    get() = url.port
    set(value) {
        url.port = value
    }

/**
 * Appends a single header of [key] with a specific [value] if the value is not null.
 */
public fun HttpMessageBuilder.header(key: String, value: Any?): Unit =
    value?.let { headers.append(key, it.toString()) } ?: Unit

/**
 * Appends a single header of [key] with a specific [value] if the value is not null.
 */
public fun HttpMessageBuilder.cookie(
    name: String,
    value: String,
    maxAge: Int = 0,
    expires: GMTDate? = null,
    domain: String? = null,
    path: String? = null,
    secure: Boolean = false,
    httpOnly: Boolean = false,
    extensions: Map = emptyMap()
): Unit { // ktlint-disable no-unit-return
    val renderedCookie = Cookie(
        name = name,
        value = value,
        maxAge = maxAge,
        expires = expires,
        domain = domain,
        path = path,
        secure = secure,
        httpOnly = httpOnly,
        extensions = extensions
    ).let(::renderCookieHeader)

    if (HttpHeaders.Cookie !in headers) {
        headers.append(HttpHeaders.Cookie, renderedCookie)
        return
    }
    // Client cookies are stored in a single header "Cookies" and multiple values are separated with ";"
    headers[HttpHeaders.Cookie] = headers[HttpHeaders.Cookie] + "; " + renderedCookie
}

/**
 * Appends a single URL query parameter of [key] with a specific [value] if the value is not null. Can not be used to set
 * form parameters in the body.
 */
public fun HttpRequestBuilder.parameter(key: String, value: Any?): Unit =
    value?.let { url.parameters.append(key, it.toString()) } ?: Unit

/**
 * Appends the `Accept` header with a specific [contentType].
 */
public fun HttpMessageBuilder.accept(contentType: ContentType): Unit =
    headers.append(HttpHeaders.Accept, contentType.toString())

/**
 * Appends the [HttpHeaders.Authorization] to Basic Authorization with the provided [username] and [password].
 * For advanced configuration use the `io.ktor:ktor-client-auth` plugin.
 */
public fun HttpMessageBuilder.basicAuth(username: String, password: String): Unit =
    header(HttpHeaders.Authorization, "Basic ${"$username:$password".encodeBase64()}")

/**
 * Appends the [HttpHeaders.Authorization] to Bearer Authorization with the provided [token].
 * For advanced configuration use the `io.ktor:ktor-client-auth` plugin.
 */
public fun HttpMessageBuilder.bearerAuth(token: String): Unit =
    header(HttpHeaders.Authorization, "Bearer $token")