Add file ext to media type

ogesaku · ogesaku · commit 68a1c476f7ee · 2025-05-21T09:05:27.000+02:00
diff --git a/README.md b/README.md
@@ -26,7 +26,6 @@ dependencies {
 
 ## TBD
 
-- Handle head
 - Handle 405 response - Method not allowed
 - Handle 406 response - Not Acceptable
 - Upload file
diff --git a/kttp-api/src/main/kotlin/com/coditory/kttp/headers/MediaType.kt b/kttp-api/src/main/kotlin/com/coditory/kttp/headers/MediaType.kt
diff --git a/kttp-api/src/test/kotlin/com/coditory/kttp/headers/MediaTypeSpec.kt b/kttp-api/src/test/kotlin/com/coditory/kttp/headers/MediaTypeSpec.kt
@@ -115,4 +115,28 @@ class MediaTypeSpec : FunSpec({
             }
         }
     }
+
+    context("should match MediaType with file ext") {
+        listOf(
+            tuple("image/png", listOf("png")),
+            tuple("application/json", listOf("json")),
+            tuple("application/vnd.ms-excel", listOf("xls", "xlm", "xla", "xlc", "xlt", "xlw")),
+        ).forEach { t ->
+            val exts = t.b
+            val firstExt = exts.first()
+            val mediaTypeValue = t.a
+            val mediaType = MediaType.parse(mediaTypeValue)!!
+            test("$mediaType -> $exts") {
+                MediaType.getAllFileExtByMediaType(mediaType) shouldBe exts
+                MediaType.getAllFileExtByMediaTypeValue(mediaTypeValue) shouldBe exts
+                MediaType.getExtByMediaTypeValue(mediaTypeValue) shouldBe firstExt
+                MediaType.getExtByMediaType(mediaType) shouldBe firstExt
+                mediaType.fileExt() shouldBe firstExt
+                exts.forEach { ext ->
+                    MediaType.getMediaTypeByExt(ext) shouldBe mediaType
+                    MediaType.getMediaTypeValueByExt(ext) shouldBe mediaTypeValue
+                }
+            }
+        }
+    }
 })
diff --git a/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/HttpRequest.kt b/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/HttpRequest.kt
@@ -16,6 +16,21 @@ class HttpRequest(
     private val deserializer: Deserializer,
     val source: Source,
 ) {
+    fun copy(
+        method: HttpRequestMethod = this.method,
+        uri: URI = this.uri,
+        headers: HttpHeaders = this.headers,
+        source: Source = this.source,
+    ): HttpRequest {
+        return HttpRequest(
+            method = method,
+            uri = uri,
+            headers = headers,
+            source = source,
+            deserializer = this.deserializer,
+        )
+    }
+
     suspend fun readBodyAsString() = source.readString()
 
     suspend fun <T> readBodyAs(strategy: DeserializationStrategy<T>): T {
diff --git a/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/HttpResponse.kt b/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/HttpResponse.kt
@@ -3,6 +3,7 @@ package com.coditory.kttp.server
 import com.coditory.kttp.HttpResponseHead
 import com.coditory.kttp.HttpStatus
 import com.coditory.kttp.headers.HttpHeaders
+import com.coditory.kttp.headers.MediaType
 import kotlinx.serialization.SerializationStrategy
 
 sealed interface HttpResponse {
@@ -27,7 +28,7 @@ sealed interface HttpResponse {
     data class TextResponse(
         val body: String,
         override val status: HttpStatus = HttpStatus.OK,
-        override val headers: HttpHeaders = HttpHeaders.empty(),
+        override val headers: HttpHeaders = HttpHeaders.from(HttpHeaders.ContentType to MediaType.Text.Plain.value),
     ) : HttpResponse
 
     data class SerializableResponse<T>(
diff --git a/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/HttpRoute.kt b/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/HttpRoute.kt
@@ -4,6 +4,8 @@ import com.coditory.kttp.HttpRequestMethod
 import com.coditory.kttp.headers.MediaType
 
 interface HttpRoute {
+    fun routing(config: HttpRoute.() -> Unit) = routing(HttpRequestMatcher.matchingAll(), config)
+
     fun routing(matcher: HttpRequestMatcher, config: HttpRoute.() -> Unit)
 
     fun routing(
@@ -24,6 +26,8 @@ interface HttpRoute {
         routing(matcher, config)
     }
 
+    fun filter(filter: HttpFilter) = filter(HttpRequestMatcher.matchingAll(), filter)
+
     fun filter(matcher: HttpRequestMatcher, filter: HttpFilter)
 
     fun filter(path: String? = null, method: HttpRequestMethod? = null, produces: MediaType? = null, consumes: MediaType? = null, predicate: HttpRequestPredicate? = null, filter: HttpFilter) {
@@ -37,6 +41,8 @@ interface HttpRoute {
         filter(matcher, filter)
     }
 
+    fun handler(handler: HttpHandler) = handler(HttpRequestMatcher.matchingAll(), handler)
+
     fun handler(matcher: HttpRequestMatcher, handler: HttpHandler)
 
     fun handler(path: String? = null, method: HttpRequestMethod? = null, produces: MediaType? = null, consumes: MediaType? = null, predicate: HttpRequestPredicate? = null, action: HttpHandler) {
diff --git a/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/HttpRouter.kt b/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/HttpRouter.kt
@@ -1,9 +1,14 @@
 package com.coditory.kttp.server
 
 import com.coditory.kttp.HttpRequestHead
+import kotlin.reflect.KClass
 
 interface HttpRouter : HttpRoute {
+    fun hasHandler(request: HttpRequestHead): Boolean
+    fun getRequestMatchers(path: String): List<HttpRequestMatcher>
+    fun removeHandler(handler: KClass<HttpHandler>)
     fun removeHandler(handler: HttpHandler)
+    fun removeFilter(filter: KClass<HttpFilter>)
     fun removeFilter(filter: HttpFilter)
     fun chain(request: HttpRequestHead): HttpChain
 }
diff --git a/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/filter/CorsHttpFilter.kt b/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/filter/CorsHttpFilter.kt
@@ -0,0 +1,98 @@
+package com.coditory.kttp.server.filter
+
+import com.coditory.kttp.HttpRequestMethod
+import com.coditory.kttp.HttpStatus
+import com.coditory.kttp.headers.HttpHeaders
+import com.coditory.kttp.headers.MutableHttpHeaders
+import com.coditory.kttp.server.HttpChain
+import com.coditory.kttp.server.HttpExchange
+import com.coditory.kttp.server.HttpFilter
+import com.coditory.kttp.server.HttpRequest
+import com.coditory.kttp.server.HttpRequestMatcher
+import com.coditory.kttp.server.HttpResponse
+import com.coditory.kttp.server.HttpRouter
+import kotlin.time.Duration
+
+class CorsHttpFilter(
+    private val router: HttpRouter,
+    private val additionalMethods: Set<HttpRequestMethod> = emptySet(),
+    methods: Set<HttpRequestMethod> = emptySet(),
+    headers: Set<String> = emptySet(),
+    private val allowOriginAny: Boolean = false,
+    private val allowOrigins: Set<String>? = null,
+    private val maxAge: Duration? = null,
+) : HttpFilter {
+    private val allowMethods = CorsSafelist.methods.plus(methods)
+    private val allowHeaders = CorsSafelist.headers.plus(headers).map { it.lowercase() }.toSet()
+
+    override suspend fun doFilter(exchange: HttpExchange, chain: HttpChain): HttpResponse {
+        if (exchange.request.method != HttpRequestMethod.OPTIONS) {
+            return chain.doFilter(exchange)
+        }
+        if (!exchange.request.headers.contains(HttpHeaders.AccessControlRequestMethod)) {
+            return chain.doFilter(exchange)
+        }
+        val matchers = router.getRequestMatchers(exchange.request.uri.path)
+        if (matchers.isEmpty()) {
+            HttpResponse.StatusResponse(HttpStatus.NotFound)
+        }
+        val headers = MutableHttpHeaders.empty()
+        handleOrigin(exchange.request, headers)
+        handleMethods(matchers, headers)
+        handleHeaders(exchange.request, headers)
+        handleMaxAge(headers)
+        return HttpResponse.StatusResponse(HttpStatus.OK, headers)
+    }
+
+    private fun handleOrigin(request: HttpRequest, headers: MutableHttpHeaders) {
+        val origin = request.headers[HttpHeaders.Origin]
+        if (allowOriginAny) {
+            headers.add(HttpHeaders.AccessControlAllowOrigin, "*")
+        } else if (origin != null && allowOrigins?.contains(origin) ?: true) {
+            headers.add(HttpHeaders.AccessControlAllowOrigin, origin)
+        } else if (!allowOrigins.isNullOrEmpty()) {
+            headers.add(HttpHeaders.AccessControlAllowOrigin, allowOrigins.first())
+        }
+    }
+
+    private fun handleMethods(matchers: List<HttpRequestMatcher>, headers: MutableHttpHeaders) {
+        val methods = matchers.map { it.methods }
+            .flatMap { it }
+            .plus(additionalMethods)
+            .filter { allowMethods.contains(it) }
+            .toSet()
+        headers.add(HttpHeaders.AccessControlAllowMethods, methods.joinToString(", "))
+    }
+
+    private fun handleHeaders(request: HttpRequest, headers: MutableHttpHeaders) {
+        val controlHeaders = request.headers[HttpHeaders.AccessControlAllowHeaders]?.split(" *, *")
+        if (controlHeaders.isNullOrEmpty()) {
+            return
+        }
+        val allowed = controlHeaders
+            .map { it.lowercase() }
+            .filter { allowHeaders.contains(it.lowercase()) }
+            .toList()
+        headers.add(HttpHeaders.AccessControlAllowHeaders, allowed)
+    }
+
+    private fun handleMaxAge(headers: MutableHttpHeaders) {
+        if (maxAge == null) return
+        headers.add(HttpHeaders.AccessControlMaxAge, maxAge.inWholeSeconds.toString())
+    }
+
+    private object CorsSafelist {
+        val headers = setOf(
+            HttpHeaders.Accept,
+            HttpHeaders.AcceptLanguage,
+            HttpHeaders.ContentLanguage,
+            HttpHeaders.ContentType,
+            HttpHeaders.Range,
+        ).map { it.lowercase() }.toSet()
+        val methods = setOf(
+            HttpRequestMethod.GET,
+            HttpRequestMethod.POST,
+            HttpRequestMethod.HEAD,
+        )
+    }
+}
diff --git a/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/filter/HeadHttpFilter.kt b/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/filter/HeadHttpFilter.kt
@@ -0,0 +1,33 @@
+package com.coditory.kttp.server.filter
+
+import com.coditory.kttp.HttpRequestMethod
+import com.coditory.kttp.server.HttpChain
+import com.coditory.kttp.server.HttpExchange
+import com.coditory.kttp.server.HttpFilter
+import com.coditory.kttp.server.HttpResponse
+import com.coditory.kttp.server.HttpRouter
+
+class HeadHttpFilter(
+    private val router: HttpRouter,
+) : HttpFilter {
+    override suspend fun doFilter(exchange: HttpExchange, chain: HttpChain): HttpResponse {
+        if (exchange.request.method != HttpRequestMethod.HEAD) {
+            return chain.doFilter(exchange)
+        }
+        if (router.hasHandler(exchange.request.toHead())) {
+            return chain.doFilter(exchange)
+        }
+        val getRequest = exchange.request.copy(
+            method = HttpRequestMethod.GET,
+        )
+        val exchangeWithGet = exchange.copy(
+            request = getRequest,
+        )
+        val getChain = router.chain(getRequest.toHead())
+        val getResponse = getChain.doFilter(exchangeWithGet)
+        if (getResponse is HttpResponse.SentResponse) {
+            return getResponse
+        }
+        return HttpResponse.StatusResponse(getResponse.status, getResponse.headers)
+    }
+}
diff --git a/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/filter/NotAcceptableHttpFilter.kt b/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/filter/NotAcceptableHttpFilter.kt
@@ -0,0 +1,39 @@
+package com.coditory.kttp.server.filter
+
+import com.coditory.kttp.HttpStatus
+import com.coditory.kttp.server.HttpChain
+import com.coditory.kttp.server.HttpExchange
+import com.coditory.kttp.server.HttpFilter
+import com.coditory.kttp.server.HttpResponse
+import com.coditory.kttp.server.HttpRouter
+
+class NotAcceptableHttpFilter(
+    private val router: HttpRouter,
+) : HttpFilter {
+    override suspend fun doFilter(
+        exchange: HttpExchange,
+        chain: HttpChain,
+    ): HttpResponse {
+        if (router.hasHandler(exchange.request.toHead())) {
+            return chain.doFilter(exchange)
+        }
+        val matchers = router.getRequestMatchers(exchange.request.uri.path)
+        if (matchers.isEmpty()) {
+            return chain.doFilter(exchange)
+        }
+        val methods = matchers.map { it.methods }
+            .flatMap { it }
+            .toSet()
+        if (!methods.contains(exchange.request.method)) {
+            return HttpResponse.StatusResponse(HttpStatus.MethodNotAllowed)
+        }
+        val accept = exchange.request.headers.accept()
+        if (accept == null) {
+            return chain.doFilter(exchange)
+        }
+        if (matchers.any { it.matchesAccept(accept) }) {
+            return chain.doFilter(exchange)
+        }
+        return HttpResponse.StatusResponse(HttpStatus.NotAcceptable)
+    }
+}
diff --git a/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/filter/OptionsHttpFilter.kt b/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/filter/OptionsHttpFilter.kt
@@ -0,0 +1,38 @@
+package com.coditory.kttp.server.filter
+
+import com.coditory.kttp.HttpRequestMethod
+import com.coditory.kttp.HttpStatus
+import com.coditory.kttp.headers.HttpHeaders
+import com.coditory.kttp.server.HttpChain
+import com.coditory.kttp.server.HttpExchange
+import com.coditory.kttp.server.HttpFilter
+import com.coditory.kttp.server.HttpResponse
+import com.coditory.kttp.server.HttpRouter
+
+class OptionsHttpFilter(
+    private val router: HttpRouter,
+    private val additionalMethods: Set<HttpRequestMethod> = emptySet(),
+) : HttpFilter {
+    override suspend fun doFilter(exchange: HttpExchange, chain: HttpChain): HttpResponse {
+        if (exchange.request.method != HttpRequestMethod.OPTIONS) {
+            return chain.doFilter(exchange)
+        }
+        if (exchange.request.headers.contains(HttpHeaders.AccessControlRequestMethod)) {
+            return chain.doFilter(exchange)
+        }
+        val matchers = router.getRequestMatchers(exchange.request.uri.path)
+        if (matchers.isEmpty()) {
+            HttpResponse.StatusResponse(HttpStatus.NotFound)
+        }
+        val methods = matchers.map { it.methods }
+            .flatMap { it }
+            .plus(additionalMethods)
+            .toSet()
+        return HttpResponse.StatusResponse(
+            HttpStatus.NoContent,
+            HttpHeaders.from(
+                HttpHeaders.Allow to methods.joinToString(", "),
+            ),
+        )
+    }
+}
diff --git a/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/handler/NotFoundHttpHandler.kt b/kttp-server/api/src/main/kotlin/com/coditory/kttp/server/handler/NotFoundHttpHandler.kt
@@ -1,6 +1,9 @@
-package com.coditory.kttp.server
+package com.coditory.kttp.server.handler
 
 import com.coditory.kttp.HttpStatus
+import com.coditory.kttp.server.HttpExchange
+import com.coditory.kttp.server.HttpHandler
+import com.coditory.kttp.server.HttpResponse
 
 class NotFoundHttpHandler : HttpHandler {
     override suspend fun handle(exchange: HttpExchange): HttpResponse {
diff --git a/kttp-server/core/src/main/kotlin/com/coditory/kttp/server/core/HttpExchangeExecutor.kt b/kttp-server/core/src/main/kotlin/com/coditory/kttp/server/core/HttpExchangeExecutor.kt
@@ -7,7 +7,10 @@ import com.coditory.kttp.server.HttpHandler
 import com.coditory.kttp.server.HttpResponse
 import com.coditory.kttp.server.HttpResponseSender
 import com.coditory.kttp.server.HttpRouter
-import com.coditory.kttp.server.NotFoundHttpHandler
+import com.coditory.kttp.server.filter.HeadHttpFilter
+import com.coditory.kttp.server.filter.NotAcceptableHttpFilter
+import com.coditory.kttp.server.filter.OptionsHttpFilter
+import com.coditory.kttp.server.handler.NotFoundHttpHandler
 
 class HttpExchangeExecutor private constructor(
     private val responseSender: HttpResponseSender,
@@ -20,6 +23,12 @@ class HttpExchangeExecutor private constructor(
         notFoundHandler: HttpHandler = NotFoundHttpHandler(),
     ) : this(responseSender, errorHandler, HttpTreeRouter(notFoundHandler))
 
+    init {
+        router.filter(HeadHttpFilter(this))
+        router.filter(OptionsHttpFilter(this))
+        router.filter(NotAcceptableHttpFilter(this))
+    }
+
     private val log = Klog.logger(HttpRouter::class)
     private val exchangeMonitor = HttpExchangeCounter()
 
diff --git a/kttp-server/core/src/main/kotlin/com/coditory/kttp/server/core/HttpMatchingFilter.kt b/kttp-server/core/src/main/kotlin/com/coditory/kttp/server/core/HttpMatchingFilter.kt
@@ -13,4 +13,10 @@ internal data class HttpMatchingFilter(
     override suspend fun doFilter(exchange: HttpExchange, chain: HttpChain): HttpResponse {
         return filter.doFilter(exchange, chain)
     }
+
+    companion object {
+        fun matchingAll(filter: HttpFilter): HttpMatchingFilter {
+            return HttpMatchingFilter(HttpRequestMatcher.matchingAll(), filter)
+        }
+    }
 }
diff --git a/kttp-server/core/src/main/kotlin/com/coditory/kttp/server/core/HttpTreeRouter.kt b/kttp-server/core/src/main/kotlin/com/coditory/kttp/server/core/HttpTreeRouter.kt
diff --git a/kttp-server/core/src/main/kotlin/com/coditory/kttp/server/core/HttpTreeRouterNode.kt b/kttp-server/core/src/main/kotlin/com/coditory/kttp/server/core/HttpTreeRouterNode.kt
diff --git a/kttp-server/jdk/src/main/kotlin/com/coditory/kttp/server/jdk/JdkHttpResponseSender.kt b/kttp-server/jdk/src/main/kotlin/com/coditory/kttp/server/jdk/JdkHttpResponseSender.kt
diff --git a/kttp-server/jdk/src/main/kotlin/com/coditory/kttp/server/jdk/JdkHttpServer.kt b/kttp-server/jdk/src/main/kotlin/com/coditory/kttp/server/jdk/JdkHttpServer.kt
diff --git a/kttp-server/samples/src/main/kotlin/com/coditory/kttp/server/samples/JdkHttpServerRunner.kt b/kttp-server/samples/src/main/kotlin/com/coditory/kttp/server/samples/JdkHttpServerRunner.kt
