CommandUtils.java 11 KB

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