Added alias cooldowns

Author: randombyte-developer

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

@@ -58,7 +58,9 @@ class CommandUtils @Inject constructor(
  private val configManager = ConfigManager(
  configLoader = configurationLoader,
  clazz = Config::class.java,
- hyphenSeparatedKeys = true
+ hyphenSeparatedKeys = true,
+ simpleDateSerialization = true,
+ simpleDurationSerialization = true
  )
 
  private lateinit var config: Config

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

@@ -1,6 +1,7 @@
 package de.randombyte.commandutils
 
 import de.randombyte.commandutils.alias.AliasConfig
+import de.randombyte.commandutils.alias.LastAliasExecutionsConfig
 import de.randombyte.commandutils.executeonserverstartup.ExecuteOnServerStartupConfig
 import ninja.leaping.configurate.objectmapping.Setting
 import ninja.leaping.configurate.objectmapping.serialize.ConfigSerializable
@@ -10,7 +11,8 @@ import java.util.*
 data class Config(
  @Setting val executeWhenOnline: ExecuteWhenOnline = Config.ExecuteWhenOnline(),
  @Setting val alias: AliasConfig = AliasConfig(),
- @Setting val executeOnServerStartup: ExecuteOnServerStartupConfig = ExecuteOnServerStartupConfig()
+ @Setting val executeOnServerStartup: ExecuteOnServerStartupConfig = ExecuteOnServerStartupConfig(),
+ @Setting val lastAliasExecutionsConfig: LastAliasExecutionsConfig = LastAliasExecutionsConfig()
 ) {
  @ConfigSerializable
  data class ExecuteWhenOnline(

src/main/kotlin/de/randombyte/commandutils/alias/AliasConfig.kt

@@ -2,6 +2,7 @@ package de.randombyte.commandutils.alias
 
 import ninja.leaping.configurate.objectmapping.Setting
 import ninja.leaping.configurate.objectmapping.serialize.ConfigSerializable
+import java.time.Duration
 
 @ConfigSerializable
 class AliasConfig(
@@ -10,7 +11,8 @@ class AliasConfig(
  @ConfigSerializable
  class Alias(
  @Setting val permission: String = "",
- @Setting val commands: List<String> = emptyList()
+ @Setting val commands: List<String> = emptyList(),
+ @Setting val cooldown: Duration? = null
  )
 
  constructor() : this(
@@ -19,8 +21,9 @@ class AliasConfig(
  permission = "example.permission",
  commands = listOf(
  "*say Executed alias with argument {0}",
- "*give \$s minecraft:cookie 3"
- )
+ "*give \$p minecraft:cookie 3"
+ ),
+ cooldown = null
  )
  )
  )

src/main/kotlin/de/randombyte/commandutils/alias/CommandListener.kt

@@ -3,48 +3,69 @@ package de.randombyte.commandutils.alias
 import de.randombyte.commandutils.ConfigAccessor
 import de.randombyte.commandutils.execute
 import de.randombyte.commandutils.executeForPlayer
+import de.randombyte.kosp.config.serializers.duration.SimpleDurationTypeSerializer
+import de.randombyte.kosp.extensions.red
 import de.randombyte.kosp.extensions.toText
 import org.slf4j.Logger
 import org.spongepowered.api.command.CommandSource
 import org.spongepowered.api.entity.living.player.Player
 import org.spongepowered.api.event.Listener
 import org.spongepowered.api.event.command.SendCommandEvent
 import org.spongepowered.api.event.filter.cause.First
+import java.time.Instant
+import java.util.*
 
 class CommandListener(
  val logger: Logger,
  val configAccessor: ConfigAccessor
 ) {
  @Listener
  fun onCommand(event: SendCommandEvent, @First commandSource: CommandSource) {
+ val config = configAccessor.get()
+
  val wholeCommand = event.wholeCommand
- val matchedAliasedMap = configAccessor.get().alias.aliases.mapNotNull { (alias, aliasConfig) ->
+ val matchedAliasedMap = config.alias.aliases.mapNotNull { (alias, aliasConfig) ->
  (alias to aliasConfig) to (AliasParser.parse(alias, wholeCommand) ?: return@mapNotNull null)
  }.toList()
 
  if (matchedAliasedMap.isEmpty()) return // doesn't match any of our aliases
 
+ event.isCancelled = true
+
  if (matchedAliasedMap.size > 1) {
  val matchedAliasesString = matchedAliasedMap.joinToString(separator = ", ", prefix = "[", postfix = "]", transform = { "'${it.first.first}'" })
  logger.error("More than one alias matched! command: '$wholeCommand'; matched aliases: $matchedAliasesString")
  throw IllegalArgumentException("More than one alias matched, report to admin!")
  }
 
  val (aliasEntry, arguments) = matchedAliasedMap.single()
- val (_, aliasConfig) = aliasEntry
+ val (alias, aliasConfig) = aliasEntry
  if (!commandSource.hasPermission(aliasConfig.permission)) {
  commandSource.sendMessage("You don't have the permission to execute this command!".toText())
  return
  }
 
+ if (aliasConfig.cooldown != null && commandSource is Player) {
+ val lastExecution = config.lastAliasExecutionsConfig.get(commandSource.uniqueId, alias)
+ if (lastExecution != null) {
+ val remainingCooldown = config.lastAliasExecutionsConfig.remainingCooldown(lastExecution, aliasConfig.cooldown)
+ if (!remainingCooldown.isNegative) {
+ val cooldownString = SimpleDurationTypeSerializer.serialize(remainingCooldown, outputMilliseconds = false)
+ commandSource.sendMessage("The cooldown for this command is still up! Wait another $cooldownString.".red())
+ return
+ }
+ }
+
+ val newLastExecutionsConfig = config.lastAliasExecutionsConfig.add(commandSource.uniqueId, alias, Date.from(Instant.now()))
+ configAccessor.save(config.copy(lastAliasExecutionsConfig = newLastExecutionsConfig))
+ }
+
  aliasConfig.commands.forEach {
  var modifiedWholeCommand = it
  arguments.forEach { (parameter, argument) -> modifiedWholeCommand = modifiedWholeCommand.replace(parameter, argument) }
  if (commandSource is Player) executeForPlayer(modifiedWholeCommand, commandSource)
  else execute(modifiedWholeCommand, commandSource)
  }
-
- event.isCancelled = true
  }
 
  private val SendCommandEvent.wholeCommand: String

src/main/kotlin/de/randombyte/commandutils/alias/LastAliasExecutionsConfig.kt

@@ -0,0 +1,21 @@
+package de.randombyte.commandutils.alias
+
+import ninja.leaping.configurate.objectmapping.Setting
+import ninja.leaping.configurate.objectmapping.serialize.ConfigSerializable
+import java.time.Duration
+import java.time.Instant
+import java.util.*
+
+@ConfigSerializable
+data class LastAliasExecutionsConfig(
+ @Setting val aliases: Map<UUID, Map<String, Date>> = emptyMap()
+) {
+ fun add(player: UUID, alias: String, date: Date): LastAliasExecutionsConfig {
+ val newPlayerCooldowns = (aliases[player] ?: emptyMap()).plus(alias to date)
+ return copy(aliases = aliases.plus(player to newPlayerCooldowns))
+ }
+
+ fun get(player: UUID, alias: String): Date? = aliases[player]?.get(alias)
+
+ fun remainingCooldown(lastExecution: Date, cooldown: Duration) = Duration.ofMillis(lastExecution.time + cooldown.toMillis() - Date.from(Instant.now()).time)
+}