Updated bStats to comply with the Ore guidelines

Author: randombyte-developer

build.gradle

@@ -38,7 +38,7 @@ configurations {
 
 dependencies {
     shadow "org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.3.11"
-    kapt "org.spongepowered:spongeapi:7.0.0"
+    kapt "org.spongepowered:spongeapi:7.1.0"
     shadow("com.github.randombyte-developer.kosp:kosp:v2.2.3") { transitive = false }
     shadow "org.bstats:bstats-sponge:1.4"
 }

src/main/kotlin/de/randombyte/commandutils/CommandUtils.kt

@@ -19,21 +19,29 @@ import de.randombyte.commandutils.execute.whenonline.PlayerJoinListener
 import de.randombyte.commandutils.executeonserverstartup.ServerStartupListener
 import de.randombyte.commandutils.service.CommandUtilsService
 import de.randombyte.commandutils.service.CommandUtilsServiceImpl
+import de.randombyte.kosp.extensions.getPlayer
+import de.randombyte.kosp.extensions.sendTo
 import de.randombyte.kosp.extensions.toText
+import org.apache.commons.lang3.RandomUtils
 import org.bstats.sponge.Metrics2
 import org.slf4j.Logger
 import org.spongepowered.api.Sponge
 import org.spongepowered.api.command.args.GenericArguments.*
 import org.spongepowered.api.command.spec.CommandSpec
 import org.spongepowered.api.config.ConfigDir
 import org.spongepowered.api.data.type.HandTypes
+import org.spongepowered.api.entity.living.player.Player
 import org.spongepowered.api.event.Listener
 import org.spongepowered.api.event.game.GameReloadEvent
 import org.spongepowered.api.event.game.state.GameInitializationEvent
 import org.spongepowered.api.event.game.state.GamePostInitializationEvent
+import org.spongepowered.api.event.network.ClientConnectionEvent
 import org.spongepowered.api.plugin.Dependency
 import org.spongepowered.api.plugin.Plugin
+import org.spongepowered.api.scheduler.Task
 import java.nio.file.Path
+import java.util.*
+import java.util.concurrent.TimeUnit
 
 @Plugin(id = ID,
         name = NAME,
@@ -82,6 +90,13 @@ class CommandUtils @Inject constructor(
         ConfigUpdater.from1_8(configAccessor, logger)
         configAccessor.reloadAll()
         registerCommands()
+
+        if (needsMotivationalSpeech()) {
+            Task.builder()
+                    .delay(RandomUtils.nextLong(80, 130), TimeUnit.SECONDS)
+                    .execute { -> Messages.motivationalSpeech.forEach { it.sendTo(Sponge.getServer().console) } }
+                    .submit(this)
+        }
     }
 
     @Listener
@@ -252,4 +267,25 @@ class CommandUtils @Inject constructor(
 
                 .build(), "commandutils", "cmdutils", "cu")
     }
+
+    val metricsNoteSent = mutableSetOf<UUID>()
+
+    @Listener
+    fun onPlayerJoin(event: ClientConnectionEvent.Join) {
+        val uuid = event.targetEntity.uniqueId
+        if (needsMotivationalSpeech(event.targetEntity)) {
+            Task.builder()
+                    .delay(RandomUtils.nextLong(10, 50), TimeUnit.SECONDS)
+                    .execute { ->
+                        val player = uuid.getPlayer() ?: return@execute
+                        metricsNoteSent += uuid
+                        Messages.motivationalSpeech.forEach { it.sendTo(player) }
+                    }
+                    .submit(this)
+        }
+    }
+
+    private fun needsMotivationalSpeech(player: Player? = null) = configAccessor.general.get().enableMetricsMessages &&
+            !Sponge.getMetricsConfigManager().areMetricsEnabled(this) &&
+            ((player == null) || player.uniqueId !in metricsNoteSent && player.hasPermission("nucleus.mute.base")) // also passes OPs without Nucleus
 }

src/main/kotlin/de/randombyte/commandutils/Messages.kt

@@ -0,0 +1,11 @@
+package de.randombyte.commandutils
+
+import de.randombyte.kosp.extensions.*
+
+object Messages {
+    val motivationalSpeech = listOf(
+            "[${CommandUtils.NAME}] ".yellow() + "Metrics are disabled for this plugin or globally! Please consider enabling metrics.".aqua(),
+            "Metrics are anonymous usage data (how many players are on the server, which minecraft version the server is on, etc.)".green(),
+            "With that data the developer can check how many servers use the plugin. Plugins with many users motivate me more to release new updates. :)".gold(),
+            "To disable this message, go to the Sponge global config, and enable metrics collection for at least this plugin, thanks! ;)".lightPurple())
+}

src/main/kotlin/de/randombyte/commandutils/config/ConfigAccessor.kt

@@ -1,15 +1,15 @@
 package de.randombyte.commandutils.config
 
 import de.randombyte.kosp.config.ConfigAccessor
-import de.randombyte.kosp.config.ConfigHolder
 import java.nio.file.Path
 
 class ConfigAccessor(configPath: Path) : ConfigAccessor(configPath) {
 
-    val aliases: ConfigHolder<AliasConfig> = getConfigHolder("aliases.conf")
-    val executeWhenOnline: ConfigHolder<ExecuteWhenOnlineConfig> = getConfigHolder("execute-when-online.conf")
-    val executeOnServerStartup: ConfigHolder<ExecuteOnServerStartupConfig> = getConfigHolder("execute-on-server-startup.conf")
-    val lastAliasExecutions: ConfigHolder<LastAliasExecutionsConfig> = getConfigHolder("last-alias-executions.conf")
+    val general = getConfigHolder<GeneralConfig>("general.conf")
+    val aliases = getConfigHolder<AliasConfig>("aliases.conf")
+    val executeWhenOnline = getConfigHolder<ExecuteWhenOnlineConfig>("execute-when-online.conf")
+    val executeOnServerStartup = getConfigHolder<ExecuteOnServerStartupConfig>("execute-on-server-startup.conf")
+    val lastAliasExecutions = getConfigHolder<LastAliasExecutionsConfig>("last-alias-executions.conf")
 
-    override val holders = listOf(aliases, executeWhenOnline, executeOnServerStartup, lastAliasExecutions)
+    override val holders = listOf(general, aliases, executeWhenOnline, executeOnServerStartup, lastAliasExecutions)
 }

src/main/kotlin/de/randombyte/commandutils/config/GeneralConfig.kt

@@ -0,0 +1,15 @@
+package de.randombyte.commandutils.config
+
+import ninja.leaping.configurate.objectmapping.Setting
+import ninja.leaping.configurate.objectmapping.serialize.ConfigSerializable
+
+@ConfigSerializable
+class GeneralConfig (
+        @Setting("enable-metrics-messages", comment =
+                "Since you are already editing configs, how about enabling metrics for at least this plugin? ;)\n" +
+                "Go to the 'config/sponge/global.conf', scroll to the 'metrics' section and enable metrics.\n" +
+                "Anonymous metrics data collection enables the developer to see how many people and servers are using this plugin.\n" +
+                "Seeing that my plugin is being used is a big factor in motivating me to provide future support and updates.\n" +
+                "If you really don't want to enable metrics and don't want to receive any messages anymore, you can disable this config option ;("
+        ) val enableMetricsMessages: Boolean = true
+)