Add new DependencyManager

gradle.properties

@@ -1,2 +1,2 @@
-version=3.3.1
+version=3.4.0
 plugin-name=VelocityReport

src/main/java/ir/syrent/velocityreport/spigot/VelocityReportSpigot.kt

@@ -8,7 +8,7 @@ import ir.syrent.velocityreport.spigot.bridge.BukkitBridge
 import ir.syrent.velocityreport.spigot.bridge.BukkitBridgeManager
 import ir.syrent.velocityreport.spigot.command.report.ReportCommand
 import ir.syrent.velocityreport.spigot.command.reportadmin.ReportAdminCommand
-import ir.syrent.velocityreport.spigot.core.DependencyChecker
+import ir.syrent.velocityreport.spigot.hook.DependencyManager
 import ir.syrent.velocityreport.spigot.listener.PlayerJoinListener
 import ir.syrent.velocityreport.spigot.listener.PlayerQuitListener
 import ir.syrent.velocityreport.spigot.listener.PreReportListener
@@ -43,7 +43,6 @@ class VelocityReportSpigot : RUoMPlugin() {
         initializeInstances()
         sendFiglet()
         sendWarningMessages()
-        registerDependencies()
         fetchData()
         registerCommands()
         registerListeners()
@@ -86,10 +85,7 @@ class VelocityReportSpigot : RUoMPlugin() {
             Ruom.warn("Please consider updating your server to 1.16.5 or higher.")
         }
         PaperLib.suggestPaper(this)
-    }
-
-    private fun registerDependencies() {
-        DependencyChecker.register("VelocityVanish")
+        DependencyManager
     }
 
     fun enableMetrics() {

src/main/java/ir/syrent/velocityreport/spigot/command/report/ReportCommand.kt

@@ -5,15 +5,14 @@ import ir.syrent.velocityreport.spigot.Ruom
 import ir.syrent.velocityreport.spigot.VelocityReportSpigot
 import ir.syrent.velocityreport.spigot.adventure.ComponentUtils
 import ir.syrent.velocityreport.spigot.command.library.PluginCommand
-import ir.syrent.velocityreport.spigot.core.DependencyChecker
+import ir.syrent.velocityreport.spigot.hook.DependencyManager
 import ir.syrent.velocityreport.spigot.storage.Message
 import ir.syrent.velocityreport.spigot.storage.Settings
 import ir.syrent.velocityreport.utils.TextReplacement
 import ir.syrent.velocityreport.utils.component
 import ir.syrent.velocityreport.utils.openBook
 import ir.syrent.velocityreport.utils.sendMessage
 import ir.syrent.velocityvanish.spigot.VelocityVanishSpigot
-import ir.syrent.velocityvanish.velocity.VelocityVanish
 import me.mohamad82.ruom.utils.MilliCounter
 import net.kyori.adventure.inventory.Book
 import net.kyori.adventure.text.Component
@@ -67,7 +66,7 @@ class ReportCommand(
             /*
             * Prevent players from reporting vanished players if VelocityVanish installed on server
             */
-            if (DependencyChecker.isRegistered("VelocityVanish")) {
+            if (DependencyManager.velocityVanishHook.exists) {
                 if (VelocityVanishSpigot.instance.vanishedNames.map { it.lowercase() }.contains(target)) {
                     sender.sendMessage(Message.NO_TARGET)
                     return

src/main/java/ir/syrent/velocityreport/spigot/hook/Dependency.kt

@@ -0,0 +1,52 @@
+package ir.syrent.velocityreport.spigot.hook
+
+import ir.syrent.velocityreport.spigot.Ruom
+import ir.syrent.velocityreport.spigot.adventure.AdventureApi
+import ir.syrent.velocityreport.spigot.storage.Settings
+import ir.syrent.velocityreport.utils.component
+
+abstract class Dependency constructor(val name: String) {
+
+    val exists = Ruom.hasPlugin(name)
+
+    fun register() {
+        if (Settings.showDependencySuggestions) {
+            sendDescription()
+            sendFeatures()
+        }
+    }
+
+    fun sendDescription() {
+        description().map {
+            AdventureApi.get().console().sendMessage("${Settings.getConsolePrefix()} $it".component())
+        }
+    }
+
+    fun sendFeatures() {
+        features().map {
+            AdventureApi.get().console().sendMessage("${Settings.getConsolePrefix()} ${formatFeature(it)}".component())
+        }
+    }
+
+    open fun features(): List<String> {
+       return emptyList()
+    }
+
+    open fun description(): List<String> {
+        return if (exists) {
+            mutableListOf(
+                "<green>$name found! dependency hook activated."
+            )
+        } else {
+            mutableListOf(
+                "<yellow>You may need to install <green>$name</green> to take full advantage of the plugin features."
+            )
+        }.apply {
+            if (features().isNotEmpty()) this.add("<white>$name advantages are listed below:")
+        }
+    }
+
+    open fun formatFeature(feature: String): String {
+        return "<white>⬤ <gray>$feature"
+    }
+}

src/main/java/ir/syrent/velocityreport/spigot/hook/DependencyManager.kt

@@ -0,0 +1,15 @@
+package ir.syrent.velocityreport.spigot.hook
+
+object DependencyManager {
+
+    var velocityVanishHook: VelocityVanishHook
+        private set
+
+    init {
+        VelocityVanishHook("VelocityVanish").apply {
+            this.register()
+            velocityVanishHook = this
+        }
+    }
+
+}

src/main/java/ir/syrent/velocityreport/spigot/hook/VelocityVanishHook.kt

@@ -0,0 +1,11 @@
+package ir.syrent.velocityreport.spigot.hook
+
+class VelocityVanishHook constructor(name: String) : Dependency(name) {
+
+    override fun features(): List<String> {
+        return mutableListOf(
+            "Prevent players from reporting vanished players."
+        )
+    }
+
+}

src/main/java/ir/syrent/velocityreport/spigot/storage/Settings.kt

@@ -6,8 +6,10 @@ import com.cryptomorin.xseries.XSound
 import ir.syrent.velocityreport.report.Category
 import ir.syrent.velocityreport.report.Reason
 import ir.syrent.velocityreport.spigot.Ruom
+import ir.syrent.velocityreport.spigot.adventure.AdventureApi
 import ir.syrent.velocityreport.spigot.configuration.YamlConfig
 import ir.syrent.velocityreport.utils.TextReplacement
+import ir.syrent.velocityreport.utils.component
 import org.bukkit.Sound
 import org.bukkit.configuration.file.FileConfiguration
 import java.io.File
@@ -33,6 +35,7 @@ object Settings {
     var settingsConfigVersion = 1
     var languageConfigVersion = 1
     lateinit var defaultLanguage: String
+    var showDependencySuggestions = true
     var velocitySupport = false
     var bstats = true
 
@@ -83,17 +86,20 @@ object Settings {
         settingsConfigVersion = settingsConfig.getInt("config_version", 1)
 
         if (settingsConfigVersion < latestSettingsConfigVersion) {
+            val backupFileName = "settings.yml-bak-${LocalDate.now()}"
             val settingsFile = File(Ruom.getPlugin().dataFolder, "settings.yml")
-            val backupFile = File(Ruom.getPlugin().dataFolder, "settings.yml-bak-${LocalDate.now()}")
+            val backupFile = File(Ruom.getPlugin().dataFolder, backupFileName)
             if (backupFile.exists()) backupFile.delete()
             Files.copy(settingsFile.toPath(), backupFile.toPath())
             settingsFile.delete()
             settings = YamlConfig(Ruom.getPlugin().dataFolder, "settings.yml")
             settingsConfig = settings.config
+            sendBackupMessage(backupFileName)
         }
 
         defaultLanguage = settingsConfig.getString("default_language") ?: "en_US"
         velocitySupport = settingsConfig.getBoolean("velocity_support")
+        showDependencySuggestions = settingsConfig.getBoolean("show_dependency_suggestions")
         bstats = settingsConfig.getBoolean("bstats")
 
         commandSound = XSound.valueOf(settingsConfig.getString("sounds.command")!!).parseSound() ?: Sound.valueOf("CLICK")
@@ -134,13 +140,15 @@ object Settings {
         languageConfigVersion = languageConfig.getInt("config_version", 1)
 
         if (languageConfigVersion < latestLanguageConfigVersion) {
+            val backupFileName = "languages/$defaultLanguage.yml-bak-${LocalDate.now()}"
             val languageFile = File(Ruom.getPlugin().dataFolder, "languages/$defaultLanguage.yml")
-            val backupFile = File(Ruom.getPlugin().dataFolder, "languages/$defaultLanguage.yml-bak-${LocalDate.now()}")
+            val backupFile = File(Ruom.getPlugin().dataFolder, backupFileName)
             if (backupFile.exists()) backupFile.delete()
             Files.copy(languageFile.toPath(), backupFile.toPath())
             languageFile.delete()
             language = YamlConfig(Ruom.getPlugin().dataFolder, "languages/$defaultLanguage.yml")
             languageConfig = language.config
+            sendBackupMessage(backupFileName)
         }
 
         categories.apply {
@@ -254,4 +262,11 @@ object Settings {
     fun getConsolePrefix(): String {
         return getMessage(Message.CONSOLE_PREFIX)
     }
+
+    private fun sendBackupMessage(fileName: String) {
+        AdventureApi.get().console().sendMessage("<red>=============================================================".component())
+        AdventureApi.get().console().sendMessage("<red>Config version updated to $settingsConfigVersion. Please set your prefred values again.".component())
+        AdventureApi.get().console().sendMessage("<gray>Previous values are still accessible via $fileName in plugin folder.".component())
+        AdventureApi.get().console().sendMessage("<red>=============================================================".component())
+    }
 }

src/main/resources/settings.yml

@@ -4,6 +4,7 @@
 config_version: 4
 default_language: en_US
 velocity_support: false
+show_dependency_suggestions: true
 bstats: true
 sounds:
     command: "ENTITY_EXPERIENCE_ORB_PICKUP"

src/main/resources/velocity-plugin.json

@@ -1 +1 @@
-{"id":"velocityreport","name":"VelocityReport","version":"3.3.1","description":"Report plugin for velocity servers","url":"syrent.ir","authors":["Syrent"],"dependencies":[],"main":"ir.syrent.velocityreport.VelocityReport"}
+{"id":"velocityreport","name":"VelocityReport","version":"3.4.0","description":"Report plugin for velocity servers","url":"syrent.ir","authors":["Syrent"],"dependencies":[],"main":"ir.syrent.velocityreport.VelocityReport"}