feat: Add SERVER_IS_CONFIGURED route and its content to provide information about the server.

Author: sakethpathike

build.gradle.kts

@@ -49,6 +49,8 @@ dependencies {
     implementation("com.oracle.database.jdbc:ojdbc8:12.2.0.1")
     implementation("org.postgresql:postgresql:42.7.5")
     implementation("com.microsoft.sqlserver:mssql-jdbc:9.4.1.jre8")
+
+    implementation("org.jetbrains:markdown:0.7.3")
 }
 
 tasks.named<JavaExec>("run") {

src/main/kotlin/com/sakethh/linkora/Application.kt

@@ -1,9 +1,11 @@
 package com.sakethh.linkora
 
 import com.sakethh.linkora.data.configureDatabase
+import com.sakethh.linkora.data.repository.MarkdownManagerRepoImpl
 import com.sakethh.linkora.domain.model.ServerConfig
-import com.sakethh.linkora.presentation.routing.websocket.configureEventsWebSocket
+import com.sakethh.linkora.domain.repository.MarkdownManagerRepo
 import com.sakethh.linkora.presentation.routing.configureRouting
+import com.sakethh.linkora.presentation.routing.websocket.configureEventsWebSocket
 import com.sakethh.linkora.utils.SysEnvKey
 import com.sakethh.linkora.utils.useSysEnvValues
 import io.ktor.server.application.*
@@ -116,7 +118,8 @@ fun Application.module() {
     configureDatabase()
     configureSecurity()
     configureSerialization()
-    configureRouting()
+    val mdManagerRepo: MarkdownManagerRepo = MarkdownManagerRepoImpl()
+    configureRouting(serverConfig = ServerConfiguration.readConfig(), markdownManagerRepo = mdManagerRepo)
     install(WebSockets) {
         pingPeriod = 15.seconds
         timeout = 15.seconds

src/main/kotlin/com/sakethh/linkora/data/Database.kt

@@ -27,7 +27,7 @@ fun configureDatabase() {
         println("Linkora database is operational and accessible.")
     } catch (e: Exception) {
 
-        if (e.message != "Unknown database 'linkora'") {
+        if (e.message.toString().contains("Unknown database").not()) {
             database?.connector?.invoke()?.close()
         }
 
@@ -39,7 +39,7 @@ fun configureDatabase() {
             }
             return
         }
-        if (e.message == "Unknown database 'linkora'") {
+        if (e.message.toString().contains("Unknown database")) {
             println("Linkora database does not exist; proceeding with creation.")
             Database.connect(
                 url = serverConfig.databaseUrl.substringBefore("/linkora"),

src/main/kotlin/com/sakethh/linkora/data/repository/MarkdownManagerRepoImpl.kt

@@ -0,0 +1,23 @@
+package com.sakethh.linkora.data.repository
+
+import com.sakethh.linkora.domain.PlaceHolder
+import com.sakethh.linkora.domain.PlaceHolderValue
+import com.sakethh.linkora.domain.repository.MarkdownManagerRepo
+import org.intellij.markdown.flavours.commonmark.CommonMarkFlavourDescriptor
+import org.intellij.markdown.html.HtmlGenerator
+import org.intellij.markdown.parser.MarkdownParser
+
+
+class MarkdownManagerRepoImpl : MarkdownManagerRepo {
+
+    private val markdownFlavour = CommonMarkFlavourDescriptor()
+    private val mdParser = MarkdownParser(markdownFlavour)
+
+    override fun getRawHtmlBasedOnMD(fileLocation: String, placeHolder: Pair<PlaceHolder, PlaceHolderValue>): String {
+        val file = this::class.java.getResourceAsStream(fileLocation)
+        val rawMDText = file.use { it?.bufferedReader()?.readText().toString() }
+            .replace(placeHolder.first, placeHolder.second)
+        val parseTree = mdParser.buildMarkdownTreeFromString(rawMDText)
+        return HtmlGenerator(markdownText = rawMDText, parseTree, markdownFlavour).generateHtml()
+    }
+}

src/main/kotlin/com/sakethh/linkora/domain/TypeAliases.kt

@@ -0,0 +1,5 @@
+package com.sakethh.linkora.domain
+
+typealias PlaceHolder = String
+
+typealias PlaceHolderValue = String

src/main/kotlin/com/sakethh/linkora/domain/repository/MarkdownManagerRepo.kt

@@ -0,0 +1,8 @@
+package com.sakethh.linkora.domain.repository
+
+import com.sakethh.linkora.domain.PlaceHolder
+import com.sakethh.linkora.domain.PlaceHolderValue
+
+interface MarkdownManagerRepo {
+    fun getRawHtmlBasedOnMD(fileLocation: String, placeHolder: Pair<PlaceHolder, PlaceHolderValue>): String
+}

src/main/kotlin/com/sakethh/linkora/domain/routes/SyncRoute.kt

@@ -4,5 +4,6 @@ enum class SyncRoute {
     TEST_BEARER,
     GET_UPDATES,
     GET_TOMBSTONES,
-    DELETE_EVERYTHING
+    DELETE_EVERYTHING,
+    SERVER_IS_CONFIGURED
 }

src/main/kotlin/com/sakethh/linkora/presentation/routing/Routing.kt

@@ -5,26 +5,50 @@ import com.sakethh.linkora.data.repository.FoldersImplementation
 import com.sakethh.linkora.data.repository.LinksImplementation
 import com.sakethh.linkora.data.repository.PanelsRepoImpl
 import com.sakethh.linkora.data.repository.SyncRepoImpl
-import com.sakethh.linkora.domain.repository.FoldersRepository
-import com.sakethh.linkora.domain.repository.LinksRepository
-import com.sakethh.linkora.domain.repository.PanelsRepository
-import com.sakethh.linkora.domain.repository.SyncRepo
+import com.sakethh.linkora.domain.model.ServerConfig
+import com.sakethh.linkora.domain.repository.*
+import com.sakethh.linkora.domain.routes.SyncRoute
 import com.sakethh.linkora.presentation.routing.http.foldersRouting
 import com.sakethh.linkora.presentation.routing.http.linksRouting
 import com.sakethh.linkora.presentation.routing.http.panelsRouting
 import com.sakethh.linkora.presentation.routing.http.syncRouting
+import com.sakethh.linkora.utils.SysEnvKey
+import com.sakethh.linkora.utils.useSysEnvValues
 import io.ktor.http.*
 import io.ktor.server.application.*
 import io.ktor.server.auth.*
 import io.ktor.server.response.*
 import io.ktor.server.routing.*
+import java.net.InetAddress
 
-fun Application.configureRouting() {
+fun Application.configureRouting(serverConfig: ServerConfig, markdownManagerRepo: MarkdownManagerRepo) {
     routing {
         authenticate(Security.BEARER.name) {
             get("/") {
                 call.respond(message = HttpStatusCode.OK, status = HttpStatusCode.OK)
             }
+            get(SyncRoute.TEST_BEARER.name) {
+                call.respond(message = HttpStatusCode.OK, status = HttpStatusCode.OK)
+            }
+        }
+        get(SyncRoute.SERVER_IS_CONFIGURED.name) {
+            val placeHolderValue =
+                if ((useSysEnvValues().not() && serverConfig.hostAddress != InetAddress.getLocalHost().hostAddress) || (useSysEnvValues() && System.getenv(
+                        SysEnvKey.LINKORA_HOST_ADDRESS.name
+                    ) != InetAddress.getLocalHost().hostAddress)
+                ) {
+                    """### **Local Hosting & IPv4 Address**
+- If you're **hosting locally**, ensure you're using an **IPv4 address** (${InetAddress.getLocalHost().hostAddress}) as `serverHost`.
+- If using environment variables, set `${SysEnvKey.LINKORA_HOST_ADDRESS.name}` to `${InetAddress.getLocalHost().hostAddress}`.
+- Otherwise, update `serverHost` in `linkoraConfig.json` so the Android app can connect.
+- If you're **only using Linkora on Desktop**, no changes are needed."""
+                } else {
+                    ""
+                }
+            val requiredHtml = markdownManagerRepo.getRawHtmlBasedOnMD(
+                fileLocation = "/raw/SERVER_IS_CONFIGURED.md", placeHolder = "#{PLACEHOLDER_1}" to placeHolderValue
+            )
+            call.respondText(contentType = ContentType.Text.Html, text = requiredHtml)
         }
     }
     val linksRepository: LinksRepository = LinksImplementation()

src/main/resources/raw/SERVER_IS_CONFIGURED.md

@@ -0,0 +1,41 @@
+It seems you've correctly configured the sync server.
+
+Before anything, check out this video where I explained how to connect the app and the server. That should clear up most things.
+
+This server is only meant to communicate with the **Linkora** apps that are available on both **Android** and **Desktop**. You can't use this server with them as there's no frontend client on web yet. Well, you can if you set up your own thing from scratch that connects to this server and does what it's supposed to do.
+
+## Important Notes
+
+#{PLACEHOLDER_1}
+
+### **HTTPS Support**
+- If you're **hosting locally**, you **can't connect** via **HTTPS** right now.
+- HTTPS requires a **trusted certificate** from a recognized Certificate Authority (CA), which isn’t typically applicable for local setups.
+- The other way is to manually generate a self-signed certificate and configure it, which may be added in future versions.
+- If you're **hosting on a cloud service**, you can use HTTPS by setting up an SSL certificate through your provider.
+
+### **Database & Data Syncing**
+- Apps have their **own databases**.
+- This server is **only meant to store your data** in the local system that you're currently running on.
+- If, for some reason, data gets deleted (maybe uninstalled or whatever), you can **connect to this server**, and the app will **pull everything** from the database that’s currently on your machine to its local database.
+- **i.e.,**
+    - The app has its **own database**.
+    - This server is now **connected to a database**.
+    - Linkora **app and server sync data** between the app and the database.
+
+### **Deletion Behavior**
+- If something gets **deleted from the Linkora app(s)** while you have a server saved on clients, even if the server is **not up**, it will be **deleted as soon as the server is up** and you open the Linkora app.
+- **It's gone, that’s it. You can't undo this.**
+- (*I should probably add a trash mechanism instead of deleting permanently, but for now, this can't be undone.*)
+
+### **LWW (Last-Write-Wins) Implementation**
+- This server follows **LWW (Last-Write-Wins)**.
+- Even if your clients have a saved connection, if the **server is offline**, the **most recently edited data** (from any client) will be updated in the database on your machine once the server is back online and the client apps reconnect.
+
+### **Blank Pages on Other Routes**
+- If you're seeing blank pages for other routes, that's completely normal since there's no UI with this server except for this page.
+
+## Troubleshooting & Additional Help
+- If something isn’t covered here, check out the **YouTube video** where I explained how to connect the app and the server.
+- Also, go through **GitHub issues**; you might find the solution there.
+- If not, **create an issue on GitHub**, and I'll fix it when I get some time.