Feature/move server frontend mapping to the frontend (#591)

* Convert "WebInterfaceManager" to singleton

* Move server webUI mapping to the webUI

* Extract logic into functions

* Retry failed download

* Validate downloaded webUI

* Automatically check for webUI updates

* Add logic to support different webUIs

* Update logs

* Close ZipFile after extracting it

server/build.gradle.kts

@@ -105,11 +105,8 @@ buildConfig {
     buildConfigField("String", "BUILD_TYPE", quoteWrap(if (System.getenv("ProductBuildType") == "Stable") "Stable" else "Preview"))
     buildConfigField("long", "BUILD_TIME", Instant.now().epochSecond.toString())
 
-
-    buildConfigField("String", "WEBUI_REPO", quoteWrap("https://github.com/Suwayomi/Tachidesk-WebUI-preview"))
     buildConfigField("String", "WEBUI_TAG", quoteWrap(webUIRevisionTag))
 
-
     buildConfigField("String", "GITHUB", quoteWrap("https://github.com/Suwayomi/Tachidesk-Server"))
     buildConfigField("String", "DISCORD", quoteWrap("https://discord.gg/DDZdqZWaHA"))
 }

server/src/main/kotlin/suwayomi/tachidesk/server/JavalinSetup.kt

@@ -27,7 +27,7 @@ import suwayomi.tachidesk.global.GlobalAPI
 import suwayomi.tachidesk.graphql.GraphQL
 import suwayomi.tachidesk.manga.MangaAPI
 import suwayomi.tachidesk.server.util.Browser
-import suwayomi.tachidesk.server.util.setupWebInterface
+import suwayomi.tachidesk.server.util.WebInterfaceManager
 import java.io.IOException
 import java.lang.IllegalArgumentException
 import java.util.concurrent.CompletableFuture
@@ -47,7 +47,7 @@ object JavalinSetup {
     fun javalinSetup() {
         val app = Javalin.create { config ->
             if (serverConfig.webUIEnabled) {
-                setupWebInterface()
+                WebInterfaceManager.setupWebUI()
 
                 logger.info { "Serving web static files for ${serverConfig.webUIFlavor}" }
                 config.addStaticFiles(applicationDirs.webUIRoot, Location.EXTERNAL)

server/src/main/kotlin/suwayomi/tachidesk/server/ServerConfig.kt

@@ -28,6 +28,8 @@ class ServerConfig(getConfig: () -> Config, moduleName: String = MODULE_NAME) :
     var initialOpenInBrowserEnabled: Boolean by overridableConfig
     var webUIInterface: String by overridableConfig
     var electronPath: String by overridableConfig
+    var webUIChannel: String by overridableConfig
+    var webUIUpdateCheckInterval: Double by overridableConfig
 
     // downloader
     var downloadAsCbz: Boolean by overridableConfig

server/src/main/kotlin/suwayomi/tachidesk/server/util/WebInterfaceManager.kt

@@ -7,130 +7,389 @@ package suwayomi.tachidesk.server.util
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 
+import kotlinx.serialization.decodeFromString
 import kotlinx.serialization.json.Json
+import kotlinx.serialization.json.JsonObject
+import kotlinx.serialization.json.jsonPrimitive
 import mu.KotlinLogging
 import net.lingala.zip4j.ZipFile
+import org.json.JSONArray
 import org.kodein.di.DI
 import org.kodein.di.conf.global
 import org.kodein.di.instance
 import suwayomi.tachidesk.server.ApplicationDirs
 import suwayomi.tachidesk.server.BuildConfig
 import suwayomi.tachidesk.server.serverConfig
-import uy.kohesive.injekt.injectLazy
+import suwayomi.tachidesk.util.HAScheduler
 import java.io.File
 import java.io.InputStream
 import java.net.HttpURLConnection
 import java.net.URL
 import java.nio.charset.StandardCharsets
 import java.security.MessageDigest
+import java.util.Date
+import java.util.prefs.Preferences
+import kotlin.time.Duration.Companion.hours
 
-private val logger = KotlinLogging.logger {}
 private val applicationDirs by DI.global.instance<ApplicationDirs>()
-private val json: Json by injectLazy()
 private val tmpDir = System.getProperty("java.io.tmpdir")
 
 private fun ByteArray.toHex(): String = joinToString(separator = "") { eachByte -> "%02x".format(eachByte) }
 
-private fun directoryMD5(fileDir: String): String {
+enum class WebUIChannel {
-    var sum = ""
+    BUNDLED, // the default webUI version bundled with the server release
-    File(fileDir).walk().toList().sortedBy { it.path }.forEach { file ->
+    STABLE,
-        if (file.isFile) {
+    PREVIEW;
-            val md5 = MessageDigest.getInstance("MD5")
-            md5.update(file.readBytes())
-            val digest = md5.digest()
-            sum += digest.toHex()
-        }
-    }
 
-    val md5 = MessageDigest.getInstance("MD5")
+    companion object {
-    md5.update(sum.toByteArray(StandardCharsets.UTF_8))
+        fun doesConfigChannelEqual(channel: WebUIChannel): Boolean {
-    val digest = md5.digest()
+            return serverConfig.webUIChannel.equals(channel.toString(), true)
-    return digest.toHex()
-}
-
-/** Make sure a valid web interface installation is available */
-fun setupWebInterface() {
-    when (serverConfig.webUIFlavor) {
-        "WebUI" -> setupWebUI()
-        "Custom" -> {
-            /* do nothing */
         }
-        else -> setupWebUI()
     }
 }
 
-/** Make sure a valid copy of WebUI is available */
+enum class WebUI(val repoUrl: String, val versionMappingUrl: String, val latestReleaseInfoUrl: String, val baseFileName: String) {
-fun setupWebUI() {
+    WEBUI(
-    // check if we have webUI installed and is correct version
+        "https://github.com/Suwayomi/Tachidesk-WebUI-preview",
-    val webUIRevisionFile = File(applicationDirs.webUIRoot + "/revision")
+        "https://raw.githubusercontent.com/Suwayomi/Tachidesk-WebUI/master/versionToServerVersionMapping.json",
-    if (webUIRevisionFile.exists() && webUIRevisionFile.readText().trim() == BuildConfig.WEBUI_TAG) {
+        "https://api.github.com/repos/Suwayomi/Tachidesk-WebUI-preview/releases/latest",
-        logger.info { "WebUI Static files exists and is the correct revision" }
+        "Tachidesk-WebUI"
-        logger.info { "Verifying WebUI Static files..." }
+    );
-        logger.info { "md5: " + directoryMD5(applicationDirs.webUIRoot) }
+}
-    } else {
+
+const val DEFAULT_WEB_UI = "WebUI"
+
+object WebInterfaceManager {
+    private val logger = KotlinLogging.logger {}
+    private const val webUIPreviewVersion = "PREVIEW"
+    private const val lastWebUIUpdateCheckKey = "lastWebUIUpdateCheckKey"
+    private val preferences = Preferences.userNodeForPackage(WebInterfaceManager::class.java)
+
+    private var currentUpdateTaskId: String = ""
+
+    init {
+        scheduleWebUIUpdateCheck()
+    }
+
+    private fun isAutoUpdateEnabled(): Boolean {
+        return serverConfig.webUIUpdateCheckInterval.toInt() != 0
+    }
+
+    private fun scheduleWebUIUpdateCheck() {
+        HAScheduler.deschedule(currentUpdateTaskId)
+
+        val isAutoUpdateDisabled = !isAutoUpdateEnabled() || serverConfig.webUIFlavor == "Custom"
+        if (isAutoUpdateDisabled) {
+            return
+        }
+
+        val updateInterval = serverConfig.webUIUpdateCheckInterval.hours.coerceAtLeast(1.hours).coerceAtMost(23.hours)
+        val lastAutomatedUpdate = preferences.getLong(lastWebUIUpdateCheckKey, System.currentTimeMillis())
+
+        val task = {
+            logger.debug { "Checking for webUI update (channel= ${serverConfig.webUIChannel}, interval= ${serverConfig.webUIUpdateCheckInterval}h, lastAutomatedUpdate= ${Date(lastAutomatedUpdate)})" }
+            checkForUpdate()
+        }
+
+        val wasPreviousUpdateCheckTriggered = (System.currentTimeMillis() - lastAutomatedUpdate) < updateInterval.inWholeMilliseconds
+        if (!wasPreviousUpdateCheckTriggered) {
+            task()
+        }
+
+        HAScheduler.deschedule(currentUpdateTaskId)
+        currentUpdateTaskId = HAScheduler.schedule(task, "0 */${updateInterval.inWholeHours} * * *", "webUI-update-checker")
+    }
+
+    fun setupWebUI() {
+        if (serverConfig.webUIFlavor == "Custom") {
+            return
+        }
+
+        if (doesLocalWebUIExist(applicationDirs.webUIRoot)) {
+            val currentVersion = getLocalVersion(applicationDirs.webUIRoot)
+
+            logger.info { "setupWebUI: found webUI files - flavor= ${serverConfig.webUIFlavor}, version= $currentVersion" }
+
+            if (!isLocalWebUIValid(applicationDirs.webUIRoot)) {
+                doInitialSetup()
+                return
+            }
+
+            if (isAutoUpdateEnabled()) {
+                checkForUpdate()
+            }
+
+            return
+        }
+
+        logger.warn { "setupWebUI: no webUI files found, starting download..." }
+        doInitialSetup()
+    }
+
+    /**
+     * Tries to download the latest compatible version for the selected webUI and falls back to the default webUI in case of errors.
+     */
+    private fun doInitialSetup() {
+        val downloadSucceeded = downloadLatestCompatibleVersion()
+
+        val fallbackToDefaultWebUI = !downloadSucceeded
+        if (!fallbackToDefaultWebUI) {
+            return
+        }
+
+        if (serverConfig.webUIFlavor != DEFAULT_WEB_UI) {
+            logger.warn { "doInitialSetup: fallback to default webUI \"$DEFAULT_WEB_UI\"" }
+
+            serverConfig.webUIFlavor = DEFAULT_WEB_UI
+
+            val fallbackToBundledVersion = !downloadLatestCompatibleVersion()
+            if (!fallbackToBundledVersion) {
+                return
+            }
+        }
+
+        logger.warn { "doInitialSetup: fallback to bundled default webUI \"$DEFAULT_WEB_UI\"" }
+
+        extractBundledWebUI()
+    }
+
+    private fun extractBundledWebUI() {
+        val resourceWebUI: InputStream = BuildConfig::class.java.getResourceAsStream("/WebUI.zip") ?: throw Error("extractBundledWebUI: No bundled webUI version found")
+
+        logger.info { "extractBundledWebUI: Using the bundled WebUI zip..." }
+
+        val webUIZip = WebUI.WEBUI.baseFileName
+        val webUIZipPath = "$tmpDir/$webUIZip"
+        val webUIZipFile = File(webUIZipPath)
+        resourceWebUI.use { input ->
+            webUIZipFile.outputStream().use { output ->
+                input.copyTo(output)
+            }
+        }
+
         File(applicationDirs.webUIRoot).deleteRecursively()
+        extractDownload(webUIZipPath, applicationDirs.webUIRoot)
+    }
 
-        val webUIZip = "Tachidesk-WebUI-${BuildConfig.WEBUI_TAG}.zip"
+    private fun checkForUpdate() {
+        val localVersion = getLocalVersion(applicationDirs.webUIRoot)
+        if (!isUpdateAvailable(localVersion)) {
+            logger.debug { "checkForUpdate(${serverConfig.webUIFlavor}, $localVersion): local version is the latest one" }
+            return
+        }
+
+        logger.info { "checkForUpdate(${serverConfig.webUIFlavor}, $localVersion): An update is available, starting download..." }
+        downloadLatestCompatibleVersion()
+        preferences.putLong(lastWebUIUpdateCheckKey, System.currentTimeMillis())
+    }
+
+    private fun getDownloadUrlFor(version: String): String {
+        val baseReleasesUrl = "${WebUI.WEBUI.repoUrl}/releases"
+        val downloadSpecificVersionBaseUrl = "$baseReleasesUrl/download"
+        val downloadLatestVersionBaseUrl = "$baseReleasesUrl/latest/download"
+
+        return if (version == webUIPreviewVersion) downloadLatestVersionBaseUrl else "$downloadSpecificVersionBaseUrl/$version"
+    }
+
+    private fun getLocalVersion(path: String): String {
+        return File("$path/revision").readText().trim()
+    }
+
+    private fun doesLocalWebUIExist(path: String): Boolean {
+        // check if we have webUI installed and is correct version
+        val webUIRevisionFile = File("$path/revision")
+        return webUIRevisionFile.exists()
+    }
+
+    private fun isLocalWebUIValid(path: String): Boolean {
+        if (!doesLocalWebUIExist(path)) {
+            return false
+        }
+
+        logger.info { "isLocalWebUIValid: Verifying WebUI files..." }
+
+        val currentVersion = getLocalVersion(path)
+        val localMD5Sum = getLocalMD5Sum(path)
+        val currentVersionMD5Sum = fetchMD5SumFor(currentVersion)
+        val validationSucceeded = currentVersionMD5Sum == localMD5Sum
+
+        logger.info { "isLocalWebUIValid: Validation ${if (validationSucceeded) "succeeded" else "failed"} - md5: local= $localMD5Sum; expected= $currentVersionMD5Sum" }
+
+        return validationSucceeded
+    }
+
+    private fun getLocalMD5Sum(fileDir: String): String {
+        var sum = ""
+        File(fileDir).walk().toList().sortedBy { it.path }.forEach { file ->
+            if (file.isFile) {
+                val md5 = MessageDigest.getInstance("MD5")
+                md5.update(file.readBytes())
+                val digest = md5.digest()
+                sum += digest.toHex()
+            }
+        }
+
+        val md5 = MessageDigest.getInstance("MD5")
+        md5.update(sum.toByteArray(StandardCharsets.UTF_8))
+        val digest = md5.digest()
+        return digest.toHex()
+    }
+
+    private fun fetchMD5SumFor(version: String): String {
+        return try {
+            val url = "${getDownloadUrlFor(version)}/md5sum"
+            URL(url).readText().trim()
+        } catch (e: Exception) {
+            ""
+        }
+    }
+
+    private fun extractVersion(versionString: String): Int {
+        // version string is of format "r<number>"
+        return versionString.substring(1).toInt()
+    }
+
+    private fun fetchPreviewVersion(): String {
+        val releaseInfoJson = URL(WebUI.WEBUI.latestReleaseInfoUrl).readText()
+        return Json.decodeFromString<JsonObject>(releaseInfoJson)["tag_name"]?.jsonPrimitive?.content ?: ""
+    }
+
+    private fun getLatestCompatibleVersion(): String {
+        if (WebUIChannel.doesConfigChannelEqual(WebUIChannel.BUNDLED)) {
+            logger.debug { "getLatestCompatibleVersion: Channel is \"${WebUIChannel.BUNDLED}\", do not check for update" }
+            return BuildConfig.WEBUI_TAG
+        }
+
+        val currentServerVersionNumber = extractVersion(BuildConfig.REVISION)
+        val webUIToServerVersionMappings = JSONArray(URL(WebUI.WEBUI.versionMappingUrl).readText())
+
+        logger.debug { "getLatestCompatibleVersion: webUIChannel= ${serverConfig.webUIChannel}, currentServerVersion= ${BuildConfig.REVISION}, mappingFile= $webUIToServerVersionMappings" }
+
+        for (i in 0 until webUIToServerVersionMappings.length()) {
+            val webUIToServerVersionEntry = webUIToServerVersionMappings.getJSONObject(i)
+            val webUIVersion = webUIToServerVersionEntry.getString("uiVersion")
+            val minServerVersionString = webUIToServerVersionEntry.getString("serverVersion")
+            val minServerVersionNumber = extractVersion(minServerVersionString)
+
+            val ignorePreviewVersion = !WebUIChannel.doesConfigChannelEqual(WebUIChannel.PREVIEW) && webUIVersion == webUIPreviewVersion
+            if (ignorePreviewVersion) {
+                continue
+            }
+
+            val isCompatibleVersion = minServerVersionNumber <= currentServerVersionNumber
+            if (isCompatibleVersion) {
+                return webUIVersion
+            }
+        }
+
+        throw Exception("No compatible webUI version found")
+    }
+
+    fun downloadLatestCompatibleVersion(retryCount: Int = 0): Boolean {
+        val latestCompatibleVersion = try {
+            val version = getLatestCompatibleVersion()
+
+            if (version == webUIPreviewVersion) {
+                fetchPreviewVersion()
+            } else {
+                version
+            }
+        } catch (e: Exception) {
+            BuildConfig.WEBUI_TAG
+        }
+
+        val webUIZip = "${WebUI.WEBUI.baseFileName}-$latestCompatibleVersion.zip"
         val webUIZipPath = "$tmpDir/$webUIZip"
         val webUIZipFile = File(webUIZipPath)
 
-        // try with resources first
+        logger.info { "downloadLatestCompatibleVersion: Downloading WebUI (flavor= ${serverConfig.webUIFlavor}, version \"$latestCompatibleVersion\") zip from the Internet..." }
-        val resourceWebUI: InputStream? = try {
+
-            BuildConfig::class.java.getResourceAsStream("/WebUI.zip")
+        try {
-        } catch (e: NullPointerException) {
+            val webUIZipURL = "${getDownloadUrlFor(latestCompatibleVersion)}/$webUIZip"
-            logger.info { "No bundled WebUI.zip found!" }
+            downloadVersion(webUIZipURL, webUIZipFile)
-            null
+
+            if (!isDownloadValid(webUIZip, webUIZipPath)) {
+                throw Exception("Download is invalid")
+            }
+        } catch (e: Exception) {
+            val retry = retryCount < 3
+            logger.error { "downloadLatestCompatibleVersion: Download failed${if (retry) ", retrying ${retryCount + 1}/3" else ""} - error: $e" }
+
+            if (retry) {
+                return downloadLatestCompatibleVersion(retryCount + 1)
+            }
+
+            return false
         }
 
-        if (resourceWebUI == null) { // is not bundled
+        File(applicationDirs.webUIRoot).deleteRecursively()
-            // download webUI zip
-            val webUIZipURL = "${BuildConfig.WEBUI_REPO}/releases/download/${BuildConfig.WEBUI_TAG}/$webUIZip"
-            webUIZipFile.delete()
-
-            logger.info { "Downloading WebUI zip from the Internet..." }
-            val data = ByteArray(1024)
-
-            webUIZipFile.outputStream().use { webUIZipFileOut ->
-
-                val connection = URL(webUIZipURL).openConnection() as HttpURLConnection
-                connection.connect()
-                val contentLength = connection.contentLength
-
-                connection.inputStream.buffered().use { inp ->
-                    var totalCount = 0
-
-                    print("Download progress: % 00")
-                    while (true) {
-                        val count = inp.read(data, 0, 1024)
-
-                        if (count == -1) {
-                            break
-                        }
-
-                        totalCount += count
-                        val percentage = (totalCount.toFloat() / contentLength * 100).toInt().toString().padStart(2, '0')
-                        print("\b\b$percentage")
-
-                        webUIZipFileOut.write(data, 0, count)
-                    }
-                    println()
-                    logger.info { "Downloading WebUI Done." }
-                }
-            }
-        } else {
-            logger.info { "Using the bundled WebUI zip..." }
-
-            resourceWebUI.use { input ->
-                webUIZipFile.outputStream().use { output ->
-                    input.copyTo(output)
-                }
-            }
-        }
 
         // extract webUI zip
-        logger.info { "Extracting WebUI zip..." }
+        logger.info { "downloadLatestCompatibleVersion: Extracting WebUI zip..." }
-        File(applicationDirs.webUIRoot).mkdirs()
+        extractDownload(webUIZipPath, applicationDirs.webUIRoot)
-        ZipFile(webUIZipPath).extractAll(applicationDirs.webUIRoot)
+        logger.info { "downloadLatestCompatibleVersion: Extracting WebUI zip Done." }
-        logger.info { "Extracting WebUI zip Done." }
+
+        return true
+    }
+
+    private fun downloadVersion(url: String, zipFile: File) {
+        zipFile.delete()
+        val data = ByteArray(1024)
+
+        zipFile.outputStream().use { webUIZipFileOut ->
+
+            val connection = URL(url).openConnection() as HttpURLConnection
+            connection.connect()
+            val contentLength = connection.contentLength
+
+            connection.inputStream.buffered().use { inp ->
+                var totalCount = 0
+
+                print("downloadVersion: Download progress: % 00")
+                while (true) {
+                    val count = inp.read(data, 0, 1024)
+
+                    if (count == -1) {
+                        break
+                    }
+
+                    totalCount += count
+                    val percentage =
+                        (totalCount.toFloat() / contentLength * 100).toInt().toString().padStart(2, '0')
+                    print("\b\b$percentage")
+
+                    webUIZipFileOut.write(data, 0, count)
+                }
+                println()
+                logger.info { "downloadVersion: Downloading WebUI Done." }
+            }
+        }
+    }
+
+    private fun isDownloadValid(zipFileName: String, zipFilePath: String): Boolean {
+        val tempUnzippedWebUIFolderPath = zipFileName.replace(".zip", "")
+
+        extractDownload(zipFilePath, tempUnzippedWebUIFolderPath)
+
+        val isDownloadValid = isLocalWebUIValid(tempUnzippedWebUIFolderPath)
+
+        File(tempUnzippedWebUIFolderPath).deleteRecursively()
+
+        return isDownloadValid
+    }
+
+    private fun extractDownload(zipFilePath: String, targetPath: String) {
+        File(targetPath).mkdirs()
+        ZipFile(zipFilePath).use { it.extractAll(targetPath) }
+    }
+
+    fun isUpdateAvailable(currentVersion: String): Boolean {
+        return try {
+            val latestCompatibleVersion = getLatestCompatibleVersion()
+            latestCompatibleVersion != currentVersion
+        } catch (e: Exception) {
+            logger.debug { "isUpdateAvailable: check failed due to $e" }
+            false
+        }
     }
 }

server/src/main/resources/server-reference.conf

@@ -13,6 +13,8 @@ server.webUIFlavor = "WebUI" # "WebUI" or "Custom"
 server.initialOpenInBrowserEnabled = true
 server.webUIInterface = "browser" # "browser" or "electron"
 server.electronPath = ""
+server.webUIChannel = "stable" # "bundled" (the version bundled with the server release), "stable" or "preview" - the webUI version that should be used
+server.webUIUpdateCheckInterval = 23 # time in hours - 0 to disable auto update - range: 1 <= n < 24 - default 23 hours - how often the server should check for webUI updates
 
 # downloader
 server.downloadAsCbz = false

server/src/test/resources/server-reference.conf

@@ -28,6 +28,8 @@ server.webUIEnabled = true
 server.initialOpenInBrowserEnabled = true
 server.webUIInterface = "browser" # "browser" or "electron"
 server.electronPath = ""
+server.webUIChannel = "stable"
+server.webUIUpdateCheckInterval = 24
 
 # backup
 server.backupPath = ""