Merge pull request #71 from tarna/update-checker

feat: added update checker

Author: TheMeinerLP

README.md

@@ -19,6 +19,7 @@ Discord: https://discord.onelitefeather.net
 
 ## Permissions
 - `attollo.use` - Allows the player to use the elevator
+- `attollo.update` - Allows the player to receive update notifications
 
 ## Configuration
 ```yaml

build.gradle.kts

@@ -46,7 +46,7 @@ repositories {
 dependencies {
     compileOnly("io.papermc.paper:paper-api:$minecraftVersion-R0.1-SNAPSHOT")
     implementation("net.kyori:adventure-text-minimessage:4.17.0")
-
+    implementation("com.github.zafarkhaja:java-semver:0.10.2")
 
     // testing
     testImplementation(kotlin("test"))
@@ -77,6 +77,10 @@ bukkit {
             description = "Allows the player to use the plugin"
             default = Default.TRUE
         }
+        register("attollo.update") {
+            description = "Allows the player to see update notifications"
+            default = Default.OP
+        }
     }
     commands {
         register("attollo") {

src/main/kotlin/dev/themeinerlp/attollo/Attollo.kt

@@ -1,13 +1,16 @@
 package dev.themeinerlp.attollo
 
 import dev.themeinerlp.attollo.listener.AttolloListener
+import dev.themeinerlp.attollo.listener.UpdateCheckerListener
+import dev.themeinerlp.attollo.service.UpdateService
 import org.bukkit.Material
 import org.bukkit.plugin.java.JavaPlugin
 
 open class Attollo : JavaPlugin() {
 
-
     lateinit var elevatorBlock: Material
+    lateinit var updateService: UpdateService
+
     override fun onLoad() {
         saveDefaultConfig()
     }
@@ -23,6 +26,18 @@ open class Attollo : JavaPlugin() {
         elevatorBlock = material ?: Material.DAYLIGHT_DETECTOR
         logger.info("Using elevatorBlock: $elevatorBlock")
         server.pluginManager.registerEvents(AttolloListener(this), this)
+        updateChecker()
+    }
+
+    override fun onDisable() {
+        updateService.shutdown()
+    }
+
+    private fun updateChecker() {
+        updateService = UpdateService(this)
+        updateService.run()
+        updateService.notifyConsole(componentLogger)
+        server.pluginManager.registerEvents(UpdateCheckerListener(this), this)
     }
 
-}
+}

src/main/kotlin/dev/themeinerlp/attollo/constants.kt

@@ -1,4 +1,16 @@
 package dev.themeinerlp.attollo
 
+import java.net.URI
+import java.net.http.HttpRequest
+
+
+
 const val USE_PERMISSION = "attollo.use"
-const val BYTEBIN_BASE_URL = "https://paste.grim.ac/data"
+const val NOTIFY_UPDATE_PERMISSION = "attollo.update"
+const val BYTEBIN_BASE_URL = "https://paste.grim.ac/data"
+
+const val NOTIFY_PLAYER_UPDATE_MESSAGE = "<yellow><download_url>Your version (<local_version>) is older than our latest published version (<remote_version>). Please update as soon as possible to get continued support. Or click me to get on the download page!"
+const val NOTIFY_CONSOLE_UPDATE_MESSAGE = "<yellow>Your version (<local_version>) is older than our latest published version (<remote_version>). Please update as soon as possible to get continued support. Or use this link <download_url>."
+
+val LATEST_RELEASE_VERSION_URI = URI.create("https://hangar.papermc.io/api/v1/projects/Attollo/latestrelease")
+val LATEST_RELEASE_VERSION_REQUEST = HttpRequest.newBuilder().GET().uri(LATEST_RELEASE_VERSION_URI).build()

src/main/kotlin/dev/themeinerlp/attollo/listener/UpdateCheckerListener.kt

@@ -0,0 +1,19 @@
+package dev.themeinerlp.attollo.listener
+
+import dev.themeinerlp.attollo.Attollo
+import dev.themeinerlp.attollo.NOTIFY_UPDATE_PERMISSION
+import org.bukkit.event.EventHandler
+import org.bukkit.event.Listener
+import org.bukkit.event.player.PlayerJoinEvent
+
+class UpdateCheckerListener(private val attollo: Attollo) : Listener {
+
+    @EventHandler
+    fun onJoin(event: PlayerJoinEvent) {
+        val player = event.player
+        if (player.isOp || player.hasPermission(NOTIFY_UPDATE_PERMISSION)) {
+            attollo.updateService.notifyPlayer(player)
+        }
+    }
+
+}

src/main/kotlin/dev/themeinerlp/attollo/service/UpdateService.kt

@@ -0,0 +1,90 @@
+package dev.themeinerlp.attollo.service
+
+import com.github.zafarkhaja.semver.Version
+import dev.themeinerlp.attollo.*
+import net.kyori.adventure.text.Component
+import net.kyori.adventure.text.event.ClickEvent
+import net.kyori.adventure.text.logger.slf4j.ComponentLogger
+import net.kyori.adventure.text.minimessage.MiniMessage
+import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder
+import org.bukkit.Bukkit
+import org.bukkit.entity.Player
+import org.slf4j.LoggerFactory
+import java.io.IOException
+import java.net.http.HttpClient
+import java.net.http.HttpResponse
+
+class UpdateService(plugin: Attollo) : Runnable {
+    private val hangarClient = HttpClient.newBuilder().build()
+    private val LOGGER = LoggerFactory.getLogger(UpdateService::class.java)
+    private val localVersion = Version.parse(plugin.pluginMeta.version)
+    private var remoteVersion: Version? = null
+    private val scheduler = Bukkit.getScheduler().runTaskTimerAsynchronously(plugin, this, 0, 20 * 60 * 60 * 3)
+    private val DOWNLOAD_URL = "https://hangar.papermc.io/OneLiteFeather/Attollo/versions/%s"
+
+
+    override fun run() {
+        val remoteVersion: Version? = getNewerVersion()
+        if (remoteVersion != null) {
+            this.remoteVersion = remoteVersion
+            for (onlinePlayer in Bukkit.getOnlinePlayers()) {
+                if (onlinePlayer.isOp || onlinePlayer.hasPermission(NOTIFY_UPDATE_PERMISSION)) {
+                    notifyPlayer(localVersion, remoteVersion, onlinePlayer)
+                }
+            }
+        }
+    }
+
+    fun notifyConsole(logger: ComponentLogger) {
+        if (this.remoteVersion != null && remoteVersion?.isHigherThan(this.localVersion) == true) {
+            logger.warn(
+                MiniMessage.miniMessage().deserialize(
+                    NOTIFY_CONSOLE_UPDATE_MESSAGE,
+                    Placeholder.component("local_version", Component.text(localVersion.toString())),
+                    Placeholder.component("remote_version", Component.text(remoteVersion.toString())),
+                    Placeholder.component("download_url", Component.text(DOWNLOAD_URL.format(remoteVersion.toString())))
+                )
+            )
+        }
+    }
+
+    fun notifyPlayer(player: Player) {
+        if (this.remoteVersion != null && remoteVersion?.isHigherThan(this.localVersion) == true) {
+            notifyPlayer(this.localVersion, this.remoteVersion, player)
+        }
+    }
+
+    private fun notifyPlayer(localVersion: Version, remoteVersion: Version?, player: Player) {
+        player.sendMessage(
+            MiniMessage.miniMessage().deserialize(
+                NOTIFY_PLAYER_UPDATE_MESSAGE,
+                Placeholder.component("local_version", Component.text(localVersion.toString())),
+                Placeholder.component("remote_version", Component.text(remoteVersion.toString())),
+                Placeholder.styling("download_url", ClickEvent.openUrl(DOWNLOAD_URL.format(remoteVersion.toString())))
+            )
+        )
+    }
+
+    private fun getNewerVersion(): Version? {
+        try {
+            val httpResponse = hangarClient.send(
+                LATEST_RELEASE_VERSION_REQUEST,
+                HttpResponse.BodyHandlers.ofString()
+            )
+            val remoteVersion = Version.parse(httpResponse.body())
+            if (remoteVersion.isHigherThan(this.localVersion)) {
+                return remoteVersion
+            }
+        } catch (e: IOException) {
+            LOGGER.error("Something went wrong to check updates", e)
+        } catch (e: InterruptedException) {
+            LOGGER.error("Something went wrong to check updates", e)
+        }
+        return null
+    }
+
+    fun shutdown() {
+        hangarClient.shutdownNow()
+        scheduler.cancel()
+    }
+}