CommandUtils.java 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  1. package com.gmail.nossr50.util.commands;
  2. import com.gmail.nossr50.core.MetadataConstants;
  3. import com.gmail.nossr50.datatypes.player.McMMOPlayer;
  4. import com.gmail.nossr50.datatypes.player.PlayerProfile;
  5. import com.gmail.nossr50.datatypes.skills.PrimarySkillType;
  6. import com.gmail.nossr50.locale.LocaleLoader;
  7. import com.gmail.nossr50.mcMMO;
  8. import com.gmail.nossr50.util.Misc;
  9. import com.gmail.nossr50.util.StringUtils;
  10. import com.gmail.nossr50.util.player.UserManager;
  11. import com.gmail.nossr50.util.skills.SkillUtils;
  12. import com.google.common.collect.ImmutableList;
  13. import org.bukkit.OfflinePlayer;
  14. import org.bukkit.command.CommandSender;
  15. import org.bukkit.entity.Player;
  16. import java.util.ArrayList;
  17. import java.util.List;
  18. public final class CommandUtils {
  19. public static final List<String> TRUE_FALSE_OPTIONS = ImmutableList.of("on", "off", "true", "false", "enabled", "disabled");
  20. public static final List<String> RESET_OPTIONS = ImmutableList.of("clear", "reset");
  21. private CommandUtils() {
  22. }
  23. public static boolean isChildSkill(CommandSender sender, PrimarySkillType skill) {
  24. if (skill == null || !skill.isChildSkill()) {
  25. return false;
  26. }
  27. sender.sendMessage("Child skills are not supported by this command."); // TODO: Localize this
  28. return true;
  29. }
  30. public static boolean inspectOffline(CommandSender sender, PlayerProfile profile, boolean hasPermission) {
  31. if (unloadedProfile(sender, profile)) {
  32. return true;
  33. }
  34. if (!hasPermission && !mcMMO.getConfigManager().getConfigCommands().isAllowInspectOnOfflinePlayers()) {
  35. sender.sendMessage(LocaleLoader.getString("Inspect.Offline"));
  36. return true;
  37. }
  38. return false;
  39. }
  40. public static boolean tooFar(CommandSender sender, Player target, boolean hasPermission) {
  41. if (sender instanceof Player
  42. && mcMMO.getConfigManager().getConfigCommands().isLimitInspectRange()
  43. && !hasPermission
  44. && !Misc.isNear(((Player) sender).getLocation(),
  45. target.getLocation(),
  46. mcMMO.getConfigManager().getConfigCommands().getInspectCommandMaxDistance())) {
  47. sender.sendMessage(LocaleLoader.getString("Inspect.TooFar"));
  48. return true;
  49. }
  50. return false;
  51. }
  52. public static boolean hidden(CommandSender sender, Player target, boolean hasPermission) {
  53. return sender instanceof Player && !((Player) sender).canSee(target) && !hasPermission;
  54. }
  55. public static boolean noConsoleUsage(CommandSender sender) {
  56. if (sender instanceof Player) {
  57. return false;
  58. }
  59. sender.sendMessage(LocaleLoader.getString("Commands.NoConsole"));
  60. return true;
  61. }
  62. public static boolean isOffline(CommandSender sender, OfflinePlayer player) {
  63. if (player.isOnline()) {
  64. return false;
  65. }
  66. sender.sendMessage(LocaleLoader.getString("Commands.Offline"));
  67. return true;
  68. }
  69. /**
  70. * Checks if there is a valid mcMMOPlayer object.
  71. *
  72. * @param sender CommandSender who used the command
  73. * @param playerName name of the target player
  74. * @param mcMMOPlayer mcMMOPlayer object of the target player
  75. * @return true if the player is online and a valid mcMMOPlayer object was found
  76. */
  77. public static boolean checkPlayerExistence(CommandSender sender, String playerName, McMMOPlayer mcMMOPlayer) {
  78. if (mcMMOPlayer != null) {
  79. if (CommandUtils.hidden(sender, mcMMOPlayer.getPlayer(), false)) {
  80. sender.sendMessage(LocaleLoader.getString("Commands.Offline"));
  81. return false;
  82. }
  83. return true;
  84. }
  85. PlayerProfile profile = new PlayerProfile(playerName, false);
  86. if (unloadedProfile(sender, profile)) {
  87. return false;
  88. }
  89. sender.sendMessage(LocaleLoader.getString("Commands.DoesNotExist"));
  90. return false;
  91. }
  92. public static boolean unloadedProfile(CommandSender sender, PlayerProfile profile) {
  93. if (profile.isLoaded()) {
  94. return false;
  95. }
  96. sender.sendMessage(LocaleLoader.getString("Commands.Offline"));
  97. return true;
  98. }
  99. public static boolean hasPlayerDataKey(CommandSender sender) {
  100. if (!(sender instanceof Player)) {
  101. return false;
  102. }
  103. boolean hasPlayerDataKey = ((Player) sender).hasMetadata(MetadataConstants.PLAYER_DATA_METAKEY);
  104. if (!hasPlayerDataKey) {
  105. sender.sendMessage(LocaleLoader.getString("Commands.NotLoaded"));
  106. }
  107. return hasPlayerDataKey;
  108. }
  109. public static boolean isLoaded(CommandSender sender, PlayerProfile profile) {
  110. if (profile.isLoaded()) {
  111. return true;
  112. }
  113. sender.sendMessage(LocaleLoader.getString("Commands.NotLoaded"));
  114. return false;
  115. }
  116. public static boolean isInvalidInteger(CommandSender sender, String value) {
  117. if (StringUtils.isInt(value)) {
  118. return false;
  119. }
  120. sender.sendMessage("That is not a valid integer."); // TODO: Localize
  121. return true;
  122. }
  123. public static boolean isInvalidDouble(CommandSender sender, String value) {
  124. if (StringUtils.isDouble(value)) {
  125. return false;
  126. }
  127. sender.sendMessage("That is not a valid percentage."); // TODO: Localize
  128. return true;
  129. }
  130. public static boolean isInvalidSkill(CommandSender sender, String skillName) {
  131. if (SkillUtils.isSkill(skillName)) {
  132. return false;
  133. }
  134. sender.sendMessage(LocaleLoader.getString("Commands.Skill.Invalid"));
  135. return true;
  136. }
  137. public static boolean shouldEnableToggle(String arg) {
  138. return arg.equalsIgnoreCase("on") || arg.equalsIgnoreCase("true") || arg.equalsIgnoreCase("enabled");
  139. }
  140. public static boolean shouldDisableToggle(String arg) {
  141. return arg.equalsIgnoreCase("off") || arg.equalsIgnoreCase("false") || arg.equalsIgnoreCase("disabled");
  142. }
  143. /**
  144. * Print out details on Gathering skills. Only for online players.
  145. *
  146. * @param inspect The player to retrieve stats for
  147. * @param display The sender to display stats to
  148. */
  149. public static void printGatheringSkills(Player inspect, CommandSender display) {
  150. printGroupedSkillData(inspect, display, LocaleLoader.getString("Stats.Header.Gathering"), PrimarySkillType.GATHERING_SKILLS);
  151. }
  152. public static void printGatheringSkills(Player player) {
  153. printGatheringSkills(player, player);
  154. }
  155. /**
  156. * Print out details on Combat skills. Only for online players.
  157. *
  158. * @param inspect The player to retrieve stats for
  159. * @param display The sender to display stats to
  160. */
  161. public static void printCombatSkills(Player inspect, CommandSender display) {
  162. printGroupedSkillData(inspect, display, LocaleLoader.getString("Stats.Header.Combat"), PrimarySkillType.COMBAT_SKILLS);
  163. }
  164. public static void printCombatSkills(Player player) {
  165. printCombatSkills(player, player);
  166. }
  167. /**
  168. * Print out details on Misc skills. Only for online players.
  169. *
  170. * @param inspect The player to retrieve stats for
  171. * @param display The sender to display stats to
  172. */
  173. public static void printMiscSkills(Player inspect, CommandSender display) {
  174. printGroupedSkillData(inspect, display, LocaleLoader.getString("Stats.Header.Misc"), PrimarySkillType.MISC_SKILLS);
  175. }
  176. public static void printMiscSkills(Player player) {
  177. printMiscSkills(player, player);
  178. }
  179. public static String displaySkill(PlayerProfile profile, PrimarySkillType skill) {
  180. if (skill.isChildSkill()) {
  181. return LocaleLoader.getString("Skills.ChildStats", LocaleLoader.getString(StringUtils.getCapitalized(skill.toString()) + ".Listener") + " ", profile.getSkillLevel(skill));
  182. }
  183. return LocaleLoader.getString("Skills.Stats", LocaleLoader.getString(StringUtils.getCapitalized(skill.toString()) + ".Listener") + " ", profile.getSkillLevel(skill), profile.getSkillXpLevel(skill), profile.getXpToLevel(skill));
  184. }
  185. private static void printGroupedSkillData(Player inspect, CommandSender display, String header, List<PrimarySkillType> skillGroup) {
  186. if (UserManager.getPlayer(inspect) == null)
  187. return;
  188. PlayerProfile profile = UserManager.getPlayer(inspect).getProfile();
  189. List<String> displayData = new ArrayList<>();
  190. displayData.add(header);
  191. for (PrimarySkillType skill : skillGroup) {
  192. if (skill.getPermissions(inspect)) {
  193. displayData.add(displaySkill(profile, skill));
  194. }
  195. }
  196. int size = displayData.size();
  197. if (size > 1) {
  198. display.sendMessage(displayData.toArray(new String[size]));
  199. }
  200. }
  201. public static List<String> getOnlinePlayerNames(CommandSender sender) {
  202. Player player = sender instanceof Player ? (Player) sender : null;
  203. List<String> onlinePlayerNames = new ArrayList<>();
  204. for (Player onlinePlayer : mcMMO.p.getServer().getOnlinePlayers()) {
  205. if (player != null && player.canSee(onlinePlayer)) {
  206. onlinePlayerNames.add(onlinePlayer.getName());
  207. }
  208. }
  209. return onlinePlayerNames;
  210. }
  211. /**
  212. * Get a matched player name if one was found in the database.
  213. *
  214. * @param partialName Name to match
  215. * @return Matched name or {@code partialName} if no match was found
  216. */
  217. public static String getMatchedPlayerName(String partialName) {
  218. if (mcMMO.getConfigManager().getConfigCommands().getMisc().isMatchOfflinePlayers()) {
  219. List<String> matches = matchPlayer(partialName);
  220. if (matches.size() == 1) {
  221. partialName = matches.get(0);
  222. }
  223. } else {
  224. Player player = mcMMO.p.getServer().getPlayer(partialName);
  225. if (player != null) {
  226. partialName = player.getName();
  227. }
  228. }
  229. return partialName;
  230. }
  231. /**
  232. * Attempts to match any player names with the given name, and returns a list of all possibly matches.
  233. * <p>
  234. * This list is not sorted in any particular order.
  235. * If an exact match is found, the returned list will only contain a single result.
  236. *
  237. * @param partialName Name to match
  238. * @return List of all possible names
  239. */
  240. private static List<String> matchPlayer(String partialName) {
  241. List<String> matchedPlayers = new ArrayList<>();
  242. for (OfflinePlayer offlinePlayer : mcMMO.p.getServer().getOfflinePlayers()) {
  243. String playerName = offlinePlayer.getName();
  244. if (playerName == null) { //Do null checking here to detect corrupted data before sending it throuogh .equals
  245. System.err.println("[McMMO] Player data file with UIID " + offlinePlayer.getUniqueId() + " is missing a player name. This may be a legacy file from before bukkit.lastKnownName. This should be okay to ignore.");
  246. continue; //Don't let an error here interrupt the loop
  247. }
  248. if (partialName.equalsIgnoreCase(playerName)) {
  249. // Exact match
  250. matchedPlayers.clear();
  251. matchedPlayers.add(playerName);
  252. break;
  253. }
  254. if (playerName.toLowerCase().contains(partialName.toLowerCase())) {
  255. // Partial match
  256. matchedPlayers.add(playerName);
  257. }
  258. }
  259. return matchedPlayers;
  260. }
  261. }