Update routing to Ktor style

Author: MukjepScarlet

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 #Mon Sep 02 03:41:15 CEST 2024
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.5.0-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/main/kotlin/net/ccbluex/netty/http/HttpConductor.kt

@@ -21,11 +21,12 @@ package net.ccbluex.netty.http
 
 import io.netty.handler.codec.http.*
 import net.ccbluex.netty.http.HttpServer.Companion.logger
+import net.ccbluex.netty.http.application.ApplicationCall
+import net.ccbluex.netty.http.application.ResponseException
 import net.ccbluex.netty.http.model.RequestContext
 import net.ccbluex.netty.http.util.httpBadRequest
 import net.ccbluex.netty.http.util.httpInternalServerError
 import net.ccbluex.netty.http.util.httpNotFound
-import net.ccbluex.netty.http.model.RequestObject
 import net.ccbluex.netty.http.util.httpNoContent
 
 /**
@@ -54,18 +55,23 @@ internal suspend fun HttpServer.processRequestContext(context: RequestContext) =
         return@runCatching httpNotFound(context.path, "Route not found")
 
     logger.debug("Found destination {}", node)
-    val requestObject = RequestObject(
+    val call = ApplicationCall(
         uri = context.uri,
         path = context.path,
         remainingPath = remaining,
         method = method,
         body = content.toString(Charsets.UTF_8),
-        params = params,
-        queryParams = context.params,
+        parameters = params,
+        queryParameters = context.params,
         headers = context.headers
     )
 
-    return@runCatching node.handle(requestObject)
+    return@runCatching node.handle(call)
+}.recoverCatching {
+    if (it is ResponseException) {
+        return@recoverCatching it.response
+    }
+    throw it
 }.getOrElse {
     logger.error("Error while processing request object: $context", it)
     httpInternalServerError(it.message ?: "Unknown error")

src/main/kotlin/net/ccbluex/netty/http/application/ApplicationCall.kt

@@ -0,0 +1,95 @@
+package net.ccbluex.netty.http.application
+
+import com.google.gson.Gson
+import com.google.gson.JsonElement
+import io.netty.handler.codec.http.FullHttpResponse
+import io.netty.handler.codec.http.HttpHeaders
+import io.netty.handler.codec.http.HttpMethod
+import io.netty.handler.codec.http.HttpResponseStatus
+import net.ccbluex.netty.http.util.DEFAULT_GSON
+import net.ccbluex.netty.http.util.httpBadRequest
+import net.ccbluex.netty.http.util.httpFile
+import net.ccbluex.netty.http.util.httpFileStream
+import net.ccbluex.netty.http.util.httpForbidden
+import net.ccbluex.netty.http.util.httpInternalServerError
+import net.ccbluex.netty.http.util.httpNoContent
+import net.ccbluex.netty.http.util.httpNotFound
+import net.ccbluex.netty.http.util.httpResponse
+import net.ccbluex.netty.http.util.httpUnauthorized
+import java.io.File
+import java.io.InputStream
+
+open class ApplicationCall(
+    val uri: String,
+    val path: String,
+    val remainingPath: String,
+    val method: HttpMethod,
+    val body: String,
+    val parameters: Map<String, String>,
+    val queryParameters: Map<String, String>,
+    val headers: HttpHeaders
+) {
+
+    private var response: FullHttpResponse? = null
+
+    inline fun <reified T> receive(gson: Gson = DEFAULT_GSON): T = gson.fromJson(body, T::class.java)
+
+    fun respond(response: FullHttpResponse) {
+        this.response = response
+    }
+
+    @JvmOverloads
+    fun respond(status: HttpResponseStatus, body: JsonElement, gson: Gson = DEFAULT_GSON) {
+        respond(httpResponse(status, body, gson))
+    }
+
+    @JvmOverloads
+    fun respond(status: HttpResponseStatus, body: Any, gson: Gson = DEFAULT_GSON) {
+        respond(httpResponse(status, body, gson))
+    }
+
+    @JvmOverloads
+    fun respond(body: JsonElement, gson: Gson = DEFAULT_GSON) {
+        respond(HttpResponseStatus.OK, body, gson)
+    }
+
+    @JvmOverloads
+    fun respond(body: Any, gson: Gson = DEFAULT_GSON) {
+        respond(HttpResponseStatus.OK, body, gson)
+    }
+
+    fun respondNoContent() {
+        respond(httpNoContent())
+    }
+
+    fun respondFile(file: File) {
+        respond(httpFile(file))
+    }
+
+    @JvmOverloads
+    fun respondFileStream(
+        stream: InputStream,
+        contentType: String? = null,
+        contentLength: Int = 256,
+    ) {
+        respond(httpFileStream(stream, contentType, contentLength))
+    }
+
+    fun takeResponse(): FullHttpResponse {
+        return response ?: throw IllegalStateException("Route handler completed without responding for $method $path")
+    }
+
+    fun badRequest(reason: String): Nothing = abort(httpBadRequest(reason))
+
+    fun forbidden(reason: String): Nothing = abort(httpForbidden(reason))
+
+    fun unauthorized(reason: String): Nothing = abort(httpUnauthorized(reason))
+
+    fun notFound(path: String, reason: String): Nothing = abort(httpNotFound(path, reason))
+
+    fun internalServerError(reason: String): Nothing = abort(httpInternalServerError(reason))
+
+    private fun abort(response: FullHttpResponse): Nothing = throw ResponseException(response)
+}
+
+class ResponseException(val response: FullHttpResponse) : RuntimeException(null, null, false, false)

src/main/kotlin/net/ccbluex/netty/http/model/RequestObject.kt

@@ -21,43 +21,50 @@ package net.ccbluex.netty.http.model
 
 import io.netty.handler.codec.http.HttpHeaders
 import io.netty.handler.codec.http.HttpMethod
+import net.ccbluex.netty.http.application.ApplicationCall
 import net.ccbluex.netty.http.util.DEFAULT_GSON
 
 /**
- * Represents an HTTP request object.
+ * Compatibility wrapper for the pre-2.6 request API.
  *
- * @property uri The full URI of the request.
- * @property path The path of the request.
- * @property remainingPath The ending part of the path which was not matched by the route.
- * @property method The HTTP method of the request.
- * @property body The body of the request.
- * @property params The inline URI parameters of the request.
- * @property queryParams The query parameters of the request.
- * @property headers The headers of the request.
+ * New code should use [ApplicationCall] inside a routing context instead.
  */
-data class RequestObject(
-    val uri: String,
-    val path: String,
-    val remainingPath: String,
-    val method: HttpMethod,
-    val body: String,
-    val params: Map<String, String>,
-    val queryParams: Map<String, String>,
-    val headers: HttpHeaders
+@Deprecated("Use ApplicationCall within RoutingContext handlers")
+class RequestObject(
+    uri: String,
+    path: String,
+    remainingPath: String,
+    method: HttpMethod,
+    body: String,
+    params: Map<String, String>,
+    queryParams: Map<String, String>,
+    headers: HttpHeaders
+) : ApplicationCall(
+    uri = uri,
+    path = path,
+    remainingPath = remainingPath,
+    method = method,
+    body = body,
+    parameters = params,
+    queryParameters = queryParams,
+    headers = headers
 ) {
 
+    val params: Map<String, String> get() = parameters
+    val queryParams: Map<String, String> get() = queryParameters
+
     /**
      * Converts the body of the request to a JSON object of the specified type.
      *
      * @return The JSON object of the specified type.
      */
     inline fun <reified T> asJson(): T {
-        return GSON_INSTANCE.fromJson(body, T::class.java)
+        return receive(GSON_INSTANCE)
     }
 
     companion object {
         @JvmField
         val GSON_INSTANCE = DEFAULT_GSON
     }
 
-}
+}

src/main/kotlin/net/ccbluex/netty/http/rest/FileServant.kt

@@ -21,10 +21,10 @@ package net.ccbluex.netty.http.rest
 
 import io.netty.handler.codec.http.FullHttpResponse
 import io.netty.handler.codec.http.HttpMethod
+import net.ccbluex.netty.http.application.ApplicationCall
 import net.ccbluex.netty.http.util.httpFile
 import net.ccbluex.netty.http.util.httpForbidden
 import net.ccbluex.netty.http.util.httpNotFound
-import net.ccbluex.netty.http.model.RequestObject
 import java.io.File
 
 /**
@@ -37,8 +37,8 @@ class FileServant(part: String, private val baseFolder: File) : Node(part) {
 
     override val isExecutable = true
 
-    override suspend fun handle(request: RequestObject): FullHttpResponse {
-        val path = request.remainingPath
+    override suspend fun handle(call: ApplicationCall): FullHttpResponse {
+        val path = call.remainingPath
         val sanitizedPath = path.replace("..", "")
         val file = baseFolder.resolve(sanitizedPath)
 
@@ -59,7 +59,6 @@ class FileServant(part: String, private val baseFolder: File) : Node(part) {
 
     override fun matches(index: Int, part: String) = super.matches(index, part) || index == 0 && isRoot
 
-    override fun matchesMethod(method: HttpMethod) =
-        method == HttpMethod.GET && super.matchesMethod(method)
+    override fun matchesMethod(method: HttpMethod) = method == HttpMethod.GET
 
-}
+}