Http.kt
package com.hexagonkt.http
import com.hexagonkt.core.GMT_ZONE
import com.hexagonkt.core.assertEnabled
import com.hexagonkt.core.Jvm
import com.hexagonkt.core.media.MediaType
import com.hexagonkt.core.text.encodeToBase64
import com.hexagonkt.http.model.*
import java.net.URLDecoder
import java.net.URLEncoder
import java.nio.charset.Charset
import java.time.*
import java.time.ZoneOffset.UTC
import java.time.format.DateTimeFormatter
import java.time.format.DateTimeFormatter.RFC_1123_DATE_TIME
/** Headers handled by HTTP model as headers with special meaning. */
val CHECKED_HEADERS: List<String> by lazy {
listOf("content-type", "accept", "set-cookie", "authorization")
}
internal val HTTP_DATE_FORMATTER: DateTimeFormatter by lazy { RFC_1123_DATE_TIME.withZone(UTC) }
fun basicAuth(user: String, password: String = ""): String =
"$user:$password".encodeToBase64()
fun checkHeaders(headers: Headers) {
if (!assertEnabled)
return
val headersKeys = headers.httpFields.keys
val invalidHeaders = CHECKED_HEADERS.filter { headersKeys.contains(it) }
check(invalidHeaders.isEmpty()) {
val invalidHeadersText = invalidHeaders.joinToString(",") { "'$it'" }
"""
Special headers should be handled with their respective properties (i.e.: contentType)
instead setting them in the headers map. Ignored headers: $invalidHeadersText
""".trimIndent()
}
}
/**
* Parse query string such as `paramA=valueA¶mB=valueB` into a map of several key-value pairs
* separated by '&' where *key* is the param name before '=' as String and *value* is the string
* after '=' as a list of String (as a query parameter may have many values).
*
* Note: Missing the '=' sign, or missing value after '=' (e.g. `foo=` or `foo`) will result into an
* empty string value.
*
* @param query URL query string. E.g.: `param=value&foo=bar`.
* @return Map with query parameter keys bound to a list with their values.
*
*/
fun parseQueryString(query: String): QueryParameters =
if (query.isBlank())
QueryParameters()
else
QueryParameters(
query
.split("&".toRegex())
.map {
val keyValue = it.split("=").map(String::trim)
val key = keyValue[0]
val value = if (keyValue.size == 2) keyValue[1] else ""
key.urlDecode() to value.urlDecode()
}
.filter { it.first.isNotBlank() }
.groupBy { it.first }
.mapValues { pair -> pair.value.map { it.second } }
.map { (k, v) -> QueryParameter(k, v) }
)
fun formatQueryString(parameters: QueryParameters): String =
parameters
.flatMap { (k, v) -> v.strings().map { k to it } }
.filter { it.first.isNotBlank() }
.joinToString("&") { (k, v) ->
if (v.isBlank()) k.urlEncode()
else "${k.urlEncode()}=${v.urlEncode()}"
}
fun String.urlDecode(): String =
URLDecoder.decode(this, Jvm.charset)
fun String.urlEncode(): String =
URLEncoder.encode(this, Jvm.charset)
fun LocalDateTime.toHttpFormat(): String =
HTTP_DATE_FORMATTER.format(ZonedDateTime.of(this, Jvm.zoneId).withZoneSameInstant(GMT_ZONE))
fun Instant.toHttpFormat(): String =
HTTP_DATE_FORMATTER.format(this)
fun parseContentType(contentType: String): ContentType {
val typeParameter = contentType.split(";")
val fullType = typeParameter.first().trim()
val mimeType = MediaType(fullType)
return when (typeParameter.size) {
1 -> ContentType(mimeType)
2 -> {
val parameter = typeParameter.last()
val nameValue = parameter.split("=")
if (nameValue.size != 2)
error("Invalid content type format: $contentType")
val name = nameValue.first().trim()
val value = nameValue.last().trim()
when (name.trim().lowercase()) {
"boundary" -> ContentType(mimeType, boundary = value)
"charset" -> ContentType(mimeType, charset = Charset.forName(value))
"q" -> ContentType(mimeType, q = value.toDouble())
else -> error("Invalid content type format: $contentType")
}
}
else -> error("Invalid content type format: $contentType")
}
}