Added report issue endpoint (#237)

Signed-off-by: Arnau Mora <[email protected]>

Author: ArnyminerZ

build.gradle.kts

@@ -53,6 +53,9 @@ dependencies {
     // Firebase
     implementation(libs.firebase.admin)
 
+    // For sending emails
+    implementation(libs.sendgrid)
+
 
     testImplementation(libs.kotlin.test)
 

gradle/libs.versions.toml

@@ -1,5 +1,4 @@
 [versions]
-crowdin = "1.25.0"
 exposed = "0.61.0"
 firebase-admin = "9.4.3"
 h2 = "2.3.232"
@@ -10,10 +9,9 @@ kotlin-serialization = "1.8.1"
 ktor = "3.1.3"
 postgresql = "42.7.5"
 progressbar = "0.10.1"
-sqlite = "3.49.1.0"
+sendgrid = "4.10.3"
 
 [libraries]
-crowdin = { module = "com.github.crowdin:crowdin-api-client-java", version.ref = "crowdin" }
 firebase-admin = { module = "com.google.firebase:firebase-admin", version.ref = "firebase-admin" }
 h2 = { module = "com.h2database:h2", version.ref = "h2" }
 imageio-webp = { module = "org.sejda.imageio:webp-imageio", version.ref = "imageio-webp" }
@@ -39,7 +37,7 @@ exposed-javaTime = { module = "org.jetbrains.exposed:exposed-java-time", version
 exposed-json = { module = "org.jetbrains.exposed:exposed-json", version.ref = "exposed" }
 postgresql = { module = "org.postgresql:postgresql", version.ref = "postgresql" }
 progressbar = { module = "me.tongfei:progressbar", version.ref = "progressbar" }
-sqlite = { module = "org.xerial:sqlite-jdbc", version.ref = "sqlite" }
+sendgrid = { module = "com.sendgrid:sendgrid-java", version.ref = "sendgrid" }
 
 [plugins]
 kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }

src/main/kotlin/server/endpoints/contact/ReportIssueEndpoint.kt

@@ -0,0 +1,92 @@
+package server.endpoints.contact
+
+import com.sendgrid.Method
+import com.sendgrid.Request
+import com.sendgrid.SendGrid
+import com.sendgrid.helpers.mail.Mail
+import com.sendgrid.helpers.mail.objects.Attachments
+import com.sendgrid.helpers.mail.objects.Content
+import com.sendgrid.helpers.mail.objects.Email
+import io.ktor.http.HttpStatusCode
+import io.ktor.server.routing.RoutingContext
+import io.ktor.util.encodeBase64
+import java.io.File
+import server.endpoints.EndpointBase
+import server.request.saveFile
+import server.response.respondSuccess
+import system.EnvironmentVariables
+
+object ReportIssueEndpoint : EndpointBase("/report") {
+    private val fromEmailAddress = EnvironmentVariables.Services.SendGrid.FromEmail.value!!
+    private val toEmailAddress = EnvironmentVariables.Services.SendGrid.ToEmail.value!!
+
+    override suspend fun RoutingContext.endpoint() {
+        val sendGridApiKey = EnvironmentVariables.Services.SendGrid.ApiKey.value
+        if (sendGridApiKey == null) {
+            return respondSuccess(HttpStatusCode.ServiceUnavailable)
+        }
+
+        var name: String? = null
+        var email: String? = null
+        var message: String? = null
+        val attachments = mutableListOf<File>()
+
+        receiveMultipart(
+            forEachFormItem = { item ->
+                when (item.name) {
+                    "name" -> name = item.value
+                    "email" -> email = item.value
+                    "message" -> message = item.value
+                }
+            },
+            forEachFileItem = { partData ->
+                val tempFile = File.createTempFile("report_issue_", null).apply {
+                    deleteOnExit()
+                }
+                partData.saveFile(tempFile)
+                attachments.add(tempFile)
+            },
+        )
+
+        if (message.isNullOrEmpty()) {
+            return respondSuccess(HttpStatusCode.NoContent)
+        }
+
+        val sg = SendGrid(sendGridApiKey)
+        val request = Request().apply {
+            method = Method.POST
+            endpoint = "mail/send"
+
+            val fromEmail = Email(fromEmailAddress)
+            val toEmail = Email(toEmailAddress)
+            body = Mail(
+                fromEmail,
+                "New report from ${name ?: "N/A"}",
+                toEmail,
+                Content("text/plain", message),
+            ).apply {
+                val replyTo = email?.let { Email(it) }
+                name?.let { replyTo?.name = it }
+                replyTo?.let { setReplyTo(it) }
+
+                attachments.forEach { file ->
+                    addAttachments(
+                        Attachments().apply {
+                            content = file.readBytes().encodeBase64()
+                            type = "application/octet-stream"
+                            filename = file.name
+                            disposition = "attachment"
+                        }
+                    )
+                }
+            }.build()
+        }
+        val response = sg.api(request)
+
+        if (response.statusCode in 200..299) {
+            respondSuccess()
+        } else {
+            respondSuccess(HttpStatusCode.InternalServerError)
+        }
+    }
+}

src/main/kotlin/server/plugins/Routing.kt

@@ -13,6 +13,7 @@ import server.endpoints.blocking.DeleteBlockEndpoint
 import server.endpoints.blocking.GetAllBlocksEndpoint
 import server.endpoints.blocking.GetBlockEndpoint
 import server.endpoints.blocking.PatchBlockEndpoint
+import server.endpoints.contact.ReportIssueEndpoint
 import server.endpoints.create.NewAreaEndpoint
 import server.endpoints.create.NewPathEndpoint
 import server.endpoints.create.NewSectorEndpoint
@@ -87,5 +88,7 @@ fun Application.configureEndpoints() {
         get(RequestFileEndpoint)
         get(RequestFilesEndpoint)
         get(DownloadFileEndpoint)
+
+        post(ReportIssueEndpoint)
     }
 }

src/main/kotlin/server/request/MultipartExtensions.kt

@@ -10,19 +10,16 @@ import kotlin.io.path.exists
 import kotlin.io.path.outputStream
 
 /**
- * Saves the FileItem to a specified root directory. Creates any necessary parent directories.
+ * Saves the FileItem to a specified file. Creates any necessary parent directories.
  *
- * @param rootDir The root directory to save the FileItem to.
- * @param uuid The UUID for the name of the file. Defaults to a random one.
+ * @param file The file to save the FileItem to.
  *
  * @throws IOException If there's a problem while writing to the file system.
  */
-suspend fun PartData.FileItem.save(rootDir: File, uuid: UUID? = null): File {
-    rootDir.mkdirs()
+suspend fun PartData.FileItem.saveFile(file: File): File {
+    file.parentFile.mkdirs()
 
-    val fileExtension = originalFileName?.takeLastWhile { it != '.' }
-    val fileName = "${uuid ?: UUID.randomUUID()}.$fileExtension"
-    val targetFile = File(rootDir, fileName).toPath()
+    val targetFile = file.toPath()
 
     if (targetFile.exists()) {
         Files.delete(targetFile)
@@ -37,3 +34,21 @@ suspend fun PartData.FileItem.save(rootDir: File, uuid: UUID? = null): File {
 
     return targetFile.toFile()
 }
+
+/**
+ * Saves the FileItem to a specified root directory. Creates any necessary parent directories.
+ *
+ * @param rootDir The root directory to save the FileItem to.
+ * @param uuid The UUID for the name of the file. Defaults to a random one.
+ *
+ * @throws IOException If there's a problem while writing to the file system.
+ */
+suspend fun PartData.FileItem.save(rootDir: File, uuid: UUID? = null): File {
+    rootDir.mkdirs()
+
+    val fileExtension = originalFileName?.takeLastWhile { it != '.' }
+    val fileName = "${uuid ?: UUID.randomUUID()}.$fileExtension"
+    val targetFile = File(rootDir, fileName)
+
+    return saveFile(targetFile)
+}

src/main/kotlin/system/EnvironmentVariables.kt

@@ -84,6 +84,18 @@ object EnvironmentVariables {
                 "/var/lib/escalaralcoiaicomtat/google-services.json"
             )
         }
+
+        @KoverIgnore
+        object SendGrid {
+            @KoverIgnore
+            data object ApiKey : EnvironmentVariable("SENDGRID_API_KEY")
+
+            @KoverIgnore
+            data object FromEmail : EnvironmentVariable("FROM_EMAIL", "[email protected]")
+
+            @KoverIgnore
+            data object ToEmail : EnvironmentVariable("TO_EMAIL", "[email protected]")
+        }
     }
 
     @KoverIgnore