diff --git a/src/main/java/fr/xephi/authme/AuthMe.java b/src/main/java/fr/xephi/authme/AuthMe.java index 6ad0226b..bdf8ad09 100644 --- a/src/main/java/fr/xephi/authme/AuthMe.java +++ b/src/main/java/fr/xephi/authme/AuthMe.java @@ -59,6 +59,8 @@ import fr.xephi.authme.util.Utils; import net.milkbowl.vault.permission.Permission; import net.minelink.ctplus.CombatTagPlus; +/** + */ public class AuthMe extends JavaPlugin { /** Defines the name of the plugin. */ @@ -111,30 +113,58 @@ public class AuthMe extends JavaPlugin { // In case we need to cache PlayerAuths, prevent connection before it's done private boolean canConnect = true; + /** + * Method canConnect. + * @return boolean + */ public boolean canConnect() { return canConnect; } + /** + * Method setCanConnect. + * @param canConnect boolean + */ public void setCanConnect(boolean canConnect) { this.canConnect = canConnect; } + /** + * Method getInstance. + * @return AuthMe + */ public static AuthMe getInstance() { return plugin; } + /** + * Method getSettings. + * @return Settings + */ public Settings getSettings() { return settings; } + /** + * Method setMessages. + * @param m Messages + */ public void setMessages(Messages m) { this.m = m; } + /** + * Method getMessages. + * @return Messages + */ public Messages getMessages() { return m; } + /** + * Method onEnable. + * @see org.bukkit.plugin.Plugin#onEnable() + */ @Override public void onEnable() { // Set the Instance @@ -362,6 +392,10 @@ public class AuthMe extends JavaPlugin { ConsoleLogger.info("AuthMe " + this.getDescription().getVersion() + " correctly enabled!"); } + /** + * Method onDisable. + * @see org.bukkit.plugin.Plugin#onDisable() + */ @Override public void onDisable() { // Save player data @@ -404,12 +438,20 @@ public class AuthMe extends JavaPlugin { // Show the exception message and stop/unload the server/plugin as defined // in the configuration + /** + * Method stopOrUnload. + * @param e Exception + */ public void stopOrUnload(Exception e) { ConsoleLogger.showError(e.getMessage()); stopOrUnload(); } // Initialize and setup the database + /** + * Method setupDatabase. + * @throws Exception + */ public void setupDatabase() throws Exception { if (database != null) database.close(); @@ -465,8 +507,8 @@ public class AuthMe extends JavaPlugin { /** * Get the permissions manager instance. * - * @return Permissions Manager instance. - */ + + * @return Permissions Manager instance. */ public PermissionsManager getPermissionsManager() { return this.permsMan; } @@ -571,7 +613,8 @@ public class AuthMe extends JavaPlugin { * * @param player * @param perm - * @return + + * @return boolean */ public boolean authmePermissible(Player player, String perm) { // New code: @@ -591,7 +634,8 @@ public class AuthMe extends JavaPlugin { * * @param sender * @param perm - * @return + + * @return boolean */ public boolean authmePermissible(CommandSender sender, String perm) { // Handle players with the permissions manager @@ -606,6 +650,10 @@ public class AuthMe extends JavaPlugin { } // Save Player Data + /** + * Method savePlayer. + * @param player Player + */ public void savePlayer(Player player) { if ((Utils.isNPC(player)) || (Utils.isUnrestricted(player))) { return; @@ -634,6 +682,11 @@ public class AuthMe extends JavaPlugin { } // Select the player to kick when a vip player join the server when full + /** + * Method generateKickPlayer. + * @param collection Collection + * @return Player + */ public Player generateKickPlayer(Collection collection) { Player player = null; for (Player p : collection) { @@ -678,6 +731,11 @@ public class AuthMe extends JavaPlugin { } // Return the spawn location of a player + /** + * Method getSpawnLocation. + * @param player Player + * @return Location + */ public Location getSpawnLocation(Player player) { World world = player.getWorld(); String[] spawnPriority = Settings.spawnPriority.split(","); @@ -700,11 +758,21 @@ public class AuthMe extends JavaPlugin { } // Return the default spawnpoint of a world + /** + * Method getDefaultSpawn. + * @param world World + * @return Location + */ private Location getDefaultSpawn(World world) { return world.getSpawnLocation(); } // Return the multiverse spawnpoint of a world + /** + * Method getMultiverseSpawn. + * @param world World + * @return Location + */ private Location getMultiverseSpawn(World world) { if (multiverse != null && Settings.multiverse) { try { @@ -717,6 +785,10 @@ public class AuthMe extends JavaPlugin { } // Return the essentials spawnpoint + /** + * Method getEssentialsSpawn. + * @return Location + */ private Location getEssentialsSpawn() { if (essentialsSpawn != null) { return essentialsSpawn; @@ -725,6 +797,11 @@ public class AuthMe extends JavaPlugin { } // Return the authme soawnpoint + /** + * Method getAuthMeSpawn. + * @param player Player + * @return Location + */ private Location getAuthMeSpawn(Player player) { if ((!database.isAuthAvailable(player.getName().toLowerCase()) || !player.hasPlayedBefore()) && (Spawn.getInstance().getFirstSpawn() != null)) { return Spawn.getInstance().getFirstSpawn(); @@ -735,11 +812,19 @@ public class AuthMe extends JavaPlugin { return player.getWorld().getSpawnLocation(); } + /** + * Method switchAntiBotMod. + * @param mode boolean + */ public void switchAntiBotMod(boolean mode) { this.antibotMod = mode; Settings.switchAntiBotMod(mode); } + /** + * Method getAntiBotModMode. + * @return boolean + */ public boolean getAntiBotModMode() { return this.antibotMod; } @@ -766,6 +851,12 @@ public class AuthMe extends JavaPlugin { }, 1, 1200 * Settings.delayRecall); } + /** + * Method replaceAllInfos. + * @param message String + * @param player Player + * @return String + */ public String replaceAllInfos(String message, Player player) { int playersOnline = Utils.getOnlinePlayers().size(); message = message.replace("&", "\u00a7"); @@ -781,6 +872,11 @@ public class AuthMe extends JavaPlugin { return message; } + /** + * Method getIP. + * @param player Player + * @return String + */ public String getIP(Player player) { String name = player.getName().toLowerCase(); String ip = player.getAddress().getAddress().getHostAddress(); @@ -794,6 +890,12 @@ public class AuthMe extends JavaPlugin { return ip; } + /** + * Method isLoggedIp. + * @param name String + * @param ip String + * @return boolean + */ public boolean isLoggedIp(String name, String ip) { int count = 0; for (Player player : Utils.getOnlinePlayers()) { @@ -803,6 +905,12 @@ public class AuthMe extends JavaPlugin { return count >= Settings.getMaxLoginPerIp; } + /** + * Method hasJoinedIp. + * @param name String + * @param ip String + * @return boolean + */ public boolean hasJoinedIp(String name, String ip) { int count = 0; for (Player player : Utils.getOnlinePlayers()) { @@ -812,6 +920,10 @@ public class AuthMe extends JavaPlugin { return count >= Settings.getMaxJoinPerIp; } + /** + * Method getModuleManager. + * @return ModuleManager + */ public ModuleManager getModuleManager() { return moduleManager; } @@ -821,6 +933,7 @@ public class AuthMe extends JavaPlugin { * * @param player * player + * @return String */ @Deprecated public String getVeryGamesIP(Player player) { @@ -840,11 +953,21 @@ public class AuthMe extends JavaPlugin { return realIP; } + /** + * Method getCountryCode. + * @param ip String + * @return String + */ @Deprecated public String getCountryCode(String ip) { return Utils.getCountryCode(ip); } + /** + * Method getCountryName. + * @param ip String + * @return String + */ @Deprecated public String getCountryName(String ip) { return Utils.getCountryName(ip); @@ -853,8 +976,8 @@ public class AuthMe extends JavaPlugin { /** * Get the command handler instance. * - * @return Command handler. - */ + + * @return Command handler. */ public CommandHandler getCommandHandler() { return this.commandHandler; } @@ -871,7 +994,8 @@ public class AuthMe extends JavaPlugin { * @param args * The command arguments (Bukkit). * - * @return True if the command was executed, false otherwise. + + * @return True if the command was executed, false otherwise. * @see org.bukkit.command.CommandExecutor#onCommand(CommandSender, Command, String, String[]) */ @Override public boolean onCommand(CommandSender sender, Command cmd, @@ -888,9 +1012,9 @@ public class AuthMe extends JavaPlugin { /** * Get the current installed AuthMeReloaded version name. * + * @return The version name of the currently installed AuthMeReloaded - * instance. - */ + * instance. */ public static String getVersionName() { return PLUGIN_VERSION_NAME; } @@ -898,9 +1022,9 @@ public class AuthMe extends JavaPlugin { /** * Get the current installed AuthMeReloaded version code. * + * @return The version code of the currently installed AuthMeReloaded - * instance. - */ + * instance. */ public static int getVersionCode() { return PLUGIN_VERSION_CODE; } diff --git a/src/main/java/fr/xephi/authme/ConsoleFilter.java b/src/main/java/fr/xephi/authme/ConsoleFilter.java index 10ac38de..60282088 100644 --- a/src/main/java/fr/xephi/authme/ConsoleFilter.java +++ b/src/main/java/fr/xephi/authme/ConsoleFilter.java @@ -6,12 +6,19 @@ import java.util.logging.LogRecord; /** * * @author Xephi59 + * @version $Revision: 1.0 $ */ public class ConsoleFilter implements Filter { public ConsoleFilter() { } + /** + * Method isLoggable. + * @param record LogRecord + * @return boolean + * @see java.util.logging.Filter#isLoggable(LogRecord) + */ @Override public boolean isLoggable(LogRecord record) { try { diff --git a/src/main/java/fr/xephi/authme/ConsoleLogger.java b/src/main/java/fr/xephi/authme/ConsoleLogger.java index e2c4ba5f..1e58e913 100644 --- a/src/main/java/fr/xephi/authme/ConsoleLogger.java +++ b/src/main/java/fr/xephi/authme/ConsoleLogger.java @@ -13,11 +13,17 @@ import com.google.common.base.Throwables; import fr.xephi.authme.api.NewAPI; import fr.xephi.authme.settings.Settings; +/** + */ public class ConsoleLogger { private static final Logger log = AuthMe.getInstance().getLogger(); private static final DateFormat df = new SimpleDateFormat("[MM-dd HH:mm:ss]"); + /** + * Method info. + * @param message String + */ public static void info(String message) { log.info("[AuthMe] " + message); if (Settings.useLogging) { @@ -29,6 +35,10 @@ public class ConsoleLogger { } } + /** + * Method showError. + * @param message String + */ public static void showError(String message) { log.warning("[AuthMe] " + message); if (Settings.useLogging) { @@ -40,6 +50,10 @@ public class ConsoleLogger { } } + /** + * Method writeLog. + * @param message String + */ public static void writeLog(String message) { try { Files.write(Settings.LOG_FILE.toPath(), (message + NewAPI.newline).getBytes(), @@ -49,6 +63,10 @@ public class ConsoleLogger { } } + /** + * Method writeStackTrace. + * @param ex Exception + */ public static void writeStackTrace(Exception ex) { if (Settings.useLogging) { String dateTime; diff --git a/src/main/java/fr/xephi/authme/DataManager.java b/src/main/java/fr/xephi/authme/DataManager.java index 95a9ab53..fc65845e 100644 --- a/src/main/java/fr/xephi/authme/DataManager.java +++ b/src/main/java/fr/xephi/authme/DataManager.java @@ -15,10 +15,16 @@ import fr.xephi.authme.settings.Settings; import fr.xephi.authme.util.Utils; import net.milkbowl.vault.permission.Permission; +/** + */ public class DataManager { public AuthMe plugin; + /** + * Constructor for DataManager. + * @param plugin AuthMe + */ public DataManager(AuthMe plugin) { this.plugin = plugin; } @@ -26,6 +32,11 @@ public class DataManager { public void run() { } + /** + * Method getOfflinePlayer. + * @param name String + * @return OfflinePlayer + */ public synchronized OfflinePlayer getOfflinePlayer(final String name) { ExecutorService executor = Executors.newSingleThreadExecutor(); Future result = executor.submit(new Callable() { @@ -52,6 +63,10 @@ public class DataManager { } } + /** + * Method purgeAntiXray. + * @param cleared List + */ public synchronized void purgeAntiXray(List cleared) { int i = 0; for (String name : cleared) { @@ -71,6 +86,10 @@ public class DataManager { ConsoleLogger.info("AutoPurgeDatabase : Remove " + i + " AntiXRayData Files"); } + /** + * Method purgeLimitedCreative. + * @param cleared List + */ public synchronized void purgeLimitedCreative(List cleared) { int i = 0; for (String name : cleared) { @@ -100,6 +119,10 @@ public class DataManager { ConsoleLogger.info("AutoPurgeDatabase : Remove " + i + " LimitedCreative Survival, Creative and Adventure files"); } + /** + * Method purgeDat. + * @param cleared List + */ public synchronized void purgeDat(List cleared) { int i = 0; for (String name : cleared) { @@ -126,6 +149,10 @@ public class DataManager { ConsoleLogger.info("AutoPurgeDatabase : Remove " + i + " .dat Files"); } + /** + * Method purgeEssentials. + * @param cleared List + */ @SuppressWarnings("deprecation") public void purgeEssentials(List cleared) { int i = 0; @@ -145,6 +172,11 @@ public class DataManager { ConsoleLogger.info("AutoPurgeDatabase : Remove " + i + " EssentialsFiles"); } + /** + * Method purgePermissions. + * @param cleared List + * @param permission Permission + */ public synchronized void purgePermissions(List cleared, Permission permission) { int i = 0; @@ -161,6 +193,12 @@ public class DataManager { ConsoleLogger.info("AutoPurgeDatabase : Remove " + i + " Permissions"); } + /** + * Method isOnline. + * @param player Player + * @param name String + * @return boolean + */ public boolean isOnline(Player player, final String name) { if (player.isOnline()) return true; @@ -185,6 +223,11 @@ public class DataManager { } } + /** + * Method getOnlinePlayerLower. + * @param name String + * @return Player + */ public Player getOnlinePlayerLower(String name) { name = name.toLowerCase(); for (Player player : Utils.getOnlinePlayers()) { diff --git a/src/main/java/fr/xephi/authme/ImageGenerator.java b/src/main/java/fr/xephi/authme/ImageGenerator.java index 2ca37cfa..ea3d6634 100644 --- a/src/main/java/fr/xephi/authme/ImageGenerator.java +++ b/src/main/java/fr/xephi/authme/ImageGenerator.java @@ -6,13 +6,23 @@ import java.awt.GradientPaint; import java.awt.Graphics2D; import java.awt.image.BufferedImage; +/** + */ public class ImageGenerator { private String pass; + /** + * Constructor for ImageGenerator. + * @param pass String + */ public ImageGenerator(String pass) { this.pass = pass; } + /** + * Method generateImage. + * @return BufferedImage + */ public BufferedImage generateImage() { BufferedImage image = new BufferedImage(200, 60, BufferedImage.TYPE_BYTE_INDEXED); Graphics2D graphics = image.createGraphics(); diff --git a/src/main/java/fr/xephi/authme/Log4JFilter.java b/src/main/java/fr/xephi/authme/Log4JFilter.java index 365b2cec..ed9ada5e 100644 --- a/src/main/java/fr/xephi/authme/Log4JFilter.java +++ b/src/main/java/fr/xephi/authme/Log4JFilter.java @@ -11,6 +11,7 @@ import fr.xephi.authme.util.StringUtils; /** * Implements a filter for Log4j to skip sensitive AuthMe commands. * @author Xephi59 + * @version $Revision: 1.0 $ */ public class Log4JFilter implements org.apache.logging.log4j.core.Filter { @@ -23,6 +24,12 @@ public class Log4JFilter implements org.apache.logging.log4j.core.Filter { public Log4JFilter() { } + /** + * Method filter. + * @param record LogEvent + * @return Result + * @see org.apache.logging.log4j.core.Filter#filter(LogEvent) + */ @Override public Result filter(LogEvent record) { if (record == null) { @@ -31,12 +38,32 @@ public class Log4JFilter implements org.apache.logging.log4j.core.Filter { return validateMessage(record.getMessage()); } + /** + * Method filter. + * @param arg0 Logger + * @param arg1 Level + * @param arg2 Marker + * @param message String + * @param arg4 Object[] + * @return Result + * @see org.apache.logging.log4j.core.Filter#filter(Logger, Level, Marker, String, Object[]) + */ @Override public Result filter(Logger arg0, Level arg1, Marker arg2, String message, Object... arg4) { return validateMessage(message); } + /** + * Method filter. + * @param arg0 Logger + * @param arg1 Level + * @param arg2 Marker + * @param message Object + * @param arg4 Throwable + * @return Result + * @see org.apache.logging.log4j.core.Filter#filter(Logger, Level, Marker, Object, Throwable) + */ @Override public Result filter(Logger arg0, Level arg1, Marker arg2, Object message, Throwable arg4) { @@ -46,17 +73,37 @@ public class Log4JFilter implements org.apache.logging.log4j.core.Filter { return validateMessage(message.toString()); } + /** + * Method filter. + * @param arg0 Logger + * @param arg1 Level + * @param arg2 Marker + * @param message Message + * @param arg4 Throwable + * @return Result + * @see org.apache.logging.log4j.core.Filter#filter(Logger, Level, Marker, Message, Throwable) + */ @Override public Result filter(Logger arg0, Level arg1, Marker arg2, Message message, Throwable arg4) { return validateMessage(message); } + /** + * Method getOnMatch. + * @return Result + * @see org.apache.logging.log4j.core.Filter#getOnMatch() + */ @Override public Result getOnMatch() { return Result.NEUTRAL; } + /** + * Method getOnMismatch. + * @return Result + * @see org.apache.logging.log4j.core.Filter#getOnMismatch() + */ @Override public Result getOnMismatch() { return Result.NEUTRAL; @@ -68,8 +115,8 @@ public class Log4JFilter implements org.apache.logging.log4j.core.Filter { * data. * * @param message the Message object to verify - * @return the Result value - */ + + * @return the Result value */ private static Result validateMessage(Message message) { if (message == null) { return Result.NEUTRAL; @@ -82,8 +129,8 @@ public class Log4JFilter implements org.apache.logging.log4j.core.Filter { * depending on whether the message contains sensitive AuthMe data. * * @param message the message to verify - * @return the Result value - */ + + * @return the Result value */ private static Result validateMessage(String message) { if (message == null) { return Result.NEUTRAL; diff --git a/src/main/java/fr/xephi/authme/PerformBackup.java b/src/main/java/fr/xephi/authme/PerformBackup.java index 0f7e1fcc..9cda7fac 100644 --- a/src/main/java/fr/xephi/authme/PerformBackup.java +++ b/src/main/java/fr/xephi/authme/PerformBackup.java @@ -14,6 +14,7 @@ import fr.xephi.authme.settings.Settings; /** * * @author stefano + * @version $Revision: 1.0 $ */ public class PerformBackup { @@ -26,10 +27,18 @@ public class PerformBackup { private String path = AuthMe.getInstance().getDataFolder() + File.separator + "backups" + File.separator + "backup" + dateString; private AuthMe instance; + /** + * Constructor for PerformBackup. + * @param instance AuthMe + */ public PerformBackup(AuthMe instance) { this.setInstance(instance); } + /** + * Method doBackup. + * @return boolean + */ public boolean doBackup() { switch (Settings.getDataSource) { @@ -44,6 +53,10 @@ public class PerformBackup { return false; } + /** + * Method MySqlBackup. + * @return boolean + */ private boolean MySqlBackup() { File dirBackup = new File(AuthMe.getInstance().getDataFolder() + "/backups"); @@ -83,6 +96,11 @@ public class PerformBackup { return false; } + /** + * Method FileBackup. + * @param backend String + * @return boolean + */ private boolean FileBackup(String backend) { File dirBackup = new File(AuthMe.getInstance().getDataFolder() + "/backups"); @@ -103,6 +121,11 @@ public class PerformBackup { * Check if we are under Windows and correct location of mysqldump.exe * otherwise return error. */ + /** + * Method checkWindows. + * @param windowsPath String + * @return boolean + */ private boolean checkWindows(String windowsPath) { String isWin = System.getProperty("os.name").toLowerCase(); if (isWin.indexOf("win") >= 0) { @@ -118,6 +141,12 @@ public class PerformBackup { /* * Copyr src bytefile into dst file */ + /** + * Method copy. + * @param src File + * @param dst File + * @throws IOException + */ void copy(File src, File dst) throws IOException { InputStream in = new FileInputStream(src); OutputStream out = new FileOutputStream(dst); @@ -132,10 +161,18 @@ public class PerformBackup { out.close(); } + /** + * Method setInstance. + * @param instance AuthMe + */ public void setInstance(AuthMe instance) { this.instance = instance; } + /** + * Method getInstance. + * @return AuthMe + */ public AuthMe getInstance() { return instance; } diff --git a/src/main/java/fr/xephi/authme/SendMailSSL.java b/src/main/java/fr/xephi/authme/SendMailSSL.java index eb4c2b8e..f3ed378d 100644 --- a/src/main/java/fr/xephi/authme/SendMailSSL.java +++ b/src/main/java/fr/xephi/authme/SendMailSSL.java @@ -15,15 +15,25 @@ import fr.xephi.authme.settings.Settings; /** * * @author Xephi59 + * @version $Revision: 1.0 $ */ public class SendMailSSL { public AuthMe plugin; + /** + * Constructor for SendMailSSL. + * @param plugin AuthMe + */ public SendMailSSL(AuthMe plugin) { this.plugin = plugin; } + /** + * Method main. + * @param auth PlayerAuth + * @param newPass String + */ public void main(final PlayerAuth auth, final String newPass) { String sendername; diff --git a/src/main/java/fr/xephi/authme/api/API.java b/src/main/java/fr/xephi/authme/api/API.java index 96dcc2a6..8f5bf87e 100644 --- a/src/main/java/fr/xephi/authme/api/API.java +++ b/src/main/java/fr/xephi/authme/api/API.java @@ -15,11 +15,17 @@ import fr.xephi.authme.security.PasswordSecurity; import fr.xephi.authme.settings.Settings; import fr.xephi.authme.util.Utils; +/** + */ public class API { public static final String newline = System.getProperty("line.separator"); public static AuthMe instance; + /** + * Constructor for API. + * @param instance AuthMe + */ @Deprecated public API(AuthMe instance) { API.instance = instance; @@ -28,8 +34,8 @@ public class API { /** * Hook into AuthMe * - * @return AuthMe instance - */ + + * @return AuthMe instance */ @Deprecated public static AuthMe hookAuthMe() { if (instance != null) @@ -42,6 +48,10 @@ public class API { return instance; } + /** + * Method getPlugin. + * @return AuthMe + */ @Deprecated public AuthMe getPlugin() { return instance; @@ -50,8 +60,8 @@ public class API { /** * * @param player - * @return true if player is authenticate - */ + + * @return true if player is authenticate */ @Deprecated public static boolean isAuthenticated(Player player) { return PlayerCache.getInstance().isAuthenticated(player.getName()); @@ -60,8 +70,8 @@ public class API { /** * * @param player - * @return true if player is a npc - */ + + * @return true if player is a npc */ @Deprecated public boolean isaNPC(Player player) { return Utils.isNPC(player); @@ -70,8 +80,8 @@ public class API { /** * * @param player - * @return true if player is a npc - */ + + * @return true if player is a npc */ @Deprecated public boolean isNPC(Player player) { return Utils.isNPC(player); @@ -80,13 +90,18 @@ public class API { /** * * @param player - * @return true if the player is unrestricted - */ + + * @return true if the player is unrestricted */ @Deprecated public static boolean isUnrestricted(Player player) { return Utils.isUnrestricted(player); } + /** + * Method getLastLocation. + * @param player Player + * @return Location + */ @Deprecated public static Location getLastLocation(Player player) { try { @@ -104,6 +119,12 @@ public class API { } } + /** + * Method setPlayerInventory. + * @param player Player + * @param content ItemStack[] + * @param armor ItemStack[] + */ @Deprecated public static void setPlayerInventory(Player player, ItemStack[] content, ItemStack[] armor) { @@ -117,8 +138,8 @@ public class API { /** * * @param playerName - * @return true if player is registered - */ + + * @return true if player is registered */ @Deprecated public static boolean isRegistered(String playerName) { String player = playerName.toLowerCase(); @@ -126,10 +147,11 @@ public class API { } /** - * @param String - * playerName, String passwordToCheck - * @return true if the password is correct , false else - */ + + + * @param playerName String + * @param passwordToCheck String + * @return true if the password is correct , false else */ @Deprecated public static boolean checkPassword(String playerName, String passwordToCheck) { @@ -147,10 +169,11 @@ public class API { /** * Register a player * - * @param String - * playerName, String password - * @return true if the player is register correctly - */ + + + * @param playerName String + * @param password String + * @return true if the player is register correctly */ @Deprecated public static boolean registerPlayer(String playerName, String password) { try { @@ -172,8 +195,8 @@ public class API { /** * Force a player to login * - * @param Player - * player + + * @param player * player */ @Deprecated public static void forceLogin(Player player) { diff --git a/src/main/java/fr/xephi/authme/api/NewAPI.java b/src/main/java/fr/xephi/authme/api/NewAPI.java index 6c48286a..ea1fc4ac 100644 --- a/src/main/java/fr/xephi/authme/api/NewAPI.java +++ b/src/main/java/fr/xephi/authme/api/NewAPI.java @@ -15,16 +15,26 @@ import fr.xephi.authme.security.PasswordSecurity; import fr.xephi.authme.settings.Settings; import fr.xephi.authme.util.Utils; +/** + */ public class NewAPI { public static final String newline = System.getProperty("line.separator"); public static NewAPI singleton; public AuthMe plugin; + /** + * Constructor for NewAPI. + * @param plugin AuthMe + */ public NewAPI(AuthMe plugin) { this.plugin = plugin; } + /** + * Constructor for NewAPI. + * @param serv Server + */ public NewAPI(Server serv) { this.plugin = (AuthMe) serv.getPluginManager().getPlugin("AuthMe"); } @@ -32,8 +42,8 @@ public class NewAPI { /** * Hook into AuthMe * - * @return AuthMe plugin - */ + + * @return AuthMe plugin */ public static NewAPI getInstance() { if (singleton != null) return singleton; @@ -46,6 +56,10 @@ public class NewAPI { return singleton; } + /** + * Method getPlugin. + * @return AuthMe + */ public AuthMe getPlugin() { return plugin; } @@ -53,8 +67,8 @@ public class NewAPI { /** * * @param player - * @return true if player is authenticate - */ + + * @return true if player is authenticate */ public boolean isAuthenticated(Player player) { return PlayerCache.getInstance().isAuthenticated(player.getName()); } @@ -62,8 +76,8 @@ public class NewAPI { /** * * @param player - * @return true if player is a npc - */ + + * @return true if player is a npc */ public boolean isNPC(Player player) { return Utils.isNPC(player); } @@ -71,12 +85,17 @@ public class NewAPI { /** * * @param player - * @return true if the player is unrestricted - */ + + * @return true if the player is unrestricted */ public boolean isUnrestricted(Player player) { return Utils.isUnrestricted(player); } + /** + * Method getLastLocation. + * @param player Player + * @return Location + */ public Location getLastLocation(Player player) { try { PlayerAuth auth = PlayerCache.getInstance().getAuth(player.getName().toLowerCase()); @@ -95,18 +114,19 @@ public class NewAPI { /** * * @param playerName - * @return true if player is registered - */ + + * @return true if player is registered */ public boolean isRegistered(String playerName) { String player = playerName.toLowerCase(); return plugin.database.isAuthAvailable(player); } /** - * @param String - * playerName, String passwordToCheck - * @return true if the password is correct , false else - */ + + + * @param playerName String + * @param passwordToCheck String + * @return true if the password is correct , false else */ public boolean checkPassword(String playerName, String passwordToCheck) { if (!isRegistered(playerName)) return false; @@ -122,10 +142,11 @@ public class NewAPI { /** * Register a player * - * @param String - * playerName, String password - * @return true if the player is register correctly - */ + + + * @param playerName String + * @param password String + * @return true if the player is register correctly */ public boolean registerPlayer(String playerName, String password) { try { String name = playerName.toLowerCase(); @@ -143,8 +164,8 @@ public class NewAPI { /** * Force a player to login * - * @param Player - * player + + * @param player * player */ public void forceLogin(Player player) { plugin.management.performLogin(player, "dontneed", true); @@ -153,8 +174,8 @@ public class NewAPI { /** * Force a player to logout * - * @param Player - * player + + * @param player * player */ public void forceLogout(Player player) { @@ -164,10 +185,10 @@ public class NewAPI { /** * Force a player to register * - * @param Player - * player - * @param String - * password + + + * @param player * player + * @param password String */ public void forceRegister(Player player, String password) { @@ -177,8 +198,8 @@ public class NewAPI { /** * Force a player to unregister * - * @param Player - * player + + * @param player * player */ public void forceUnregister(Player player) { diff --git a/src/main/java/fr/xephi/authme/cache/auth/PlayerAuth.java b/src/main/java/fr/xephi/authme/cache/auth/PlayerAuth.java index 3046c9c0..9ca05728 100644 --- a/src/main/java/fr/xephi/authme/cache/auth/PlayerAuth.java +++ b/src/main/java/fr/xephi/authme/cache/auth/PlayerAuth.java @@ -3,6 +3,8 @@ package fr.xephi.authme.cache.auth; import fr.xephi.authme.security.HashAlgorithm; import fr.xephi.authme.settings.Settings; +/** + */ public class PlayerAuth { private String nickname; @@ -18,38 +20,132 @@ public class PlayerAuth { private String email; private String realName; + /** + * Constructor for PlayerAuth. + * @param nickname String + * @param ip String + * @param lastLogin long + * @param realName String + */ public PlayerAuth(String nickname, String ip, long lastLogin, String realName) { this(nickname, "", "", -1, ip, lastLogin, 0, 0, 0, "world", "your@email.com", realName); } + /** + * Constructor for PlayerAuth. + * @param nickname String + * @param x double + * @param y double + * @param z double + * @param world String + * @param realName String + */ public PlayerAuth(String nickname, double x, double y, double z, String world, String realName) { this(nickname, "", "", -1, "127.0.0.1", System.currentTimeMillis(), x, y, z, world, "your@email.com", realName); } + /** + * Constructor for PlayerAuth. + * @param nickname String + * @param hash String + * @param ip String + * @param lastLogin long + * @param realName String + */ public PlayerAuth(String nickname, String hash, String ip, long lastLogin, String realName) { this(nickname, hash, "", -1, ip, lastLogin, 0, 0, 0, "world", "your@email.com", realName); } + /** + * Constructor for PlayerAuth. + * @param nickname String + * @param hash String + * @param ip String + * @param lastLogin long + * @param email String + * @param realName String + */ public PlayerAuth(String nickname, String hash, String ip, long lastLogin, String email, String realName) { this(nickname, hash, "", -1, ip, lastLogin, 0, 0, 0, "world", email, realName); } + /** + * Constructor for PlayerAuth. + * @param nickname String + * @param hash String + * @param salt String + * @param ip String + * @param lastLogin long + * @param realName String + */ public PlayerAuth(String nickname, String hash, String salt, String ip, long lastLogin, String realName) { this(nickname, hash, salt, -1, ip, lastLogin, 0, 0, 0, "world", "your@email.com", realName); } + /** + * Constructor for PlayerAuth. + * @param nickname String + * @param hash String + * @param ip String + * @param lastLogin long + * @param x double + * @param y double + * @param z double + * @param world String + * @param email String + * @param realName String + */ public PlayerAuth(String nickname, String hash, String ip, long lastLogin, double x, double y, double z, String world, String email, String realName) { this(nickname, hash, "", -1, ip, lastLogin, x, y, z, world, email, realName); } + /** + * Constructor for PlayerAuth. + * @param nickname String + * @param hash String + * @param salt String + * @param ip String + * @param lastLogin long + * @param x double + * @param y double + * @param z double + * @param world String + * @param email String + * @param realName String + */ public PlayerAuth(String nickname, String hash, String salt, String ip, long lastLogin, double x, double y, double z, String world, String email, String realName) { this(nickname, hash, salt, -1, ip, lastLogin, x, y, z, world, email, realName); } + /** + * Constructor for PlayerAuth. + * @param nickname String + * @param hash String + * @param salt String + * @param groupId int + * @param ip String + * @param lastLogin long + * @param realName String + */ public PlayerAuth(String nickname, String hash, String salt, int groupId, String ip, long lastLogin, String realName) { this(nickname, hash, salt, groupId, ip, lastLogin, 0, 0, 0, "world", "your@email.com", realName); } + /** + * Constructor for PlayerAuth. + * @param nickname String + * @param hash String + * @param salt String + * @param groupId int + * @param ip String + * @param lastLogin long + * @param x double + * @param y double + * @param z double + * @param world String + * @param email String + * @param realName String + */ public PlayerAuth(String nickname, String hash, String salt, int groupId, String ip, long lastLogin, double x, double y, double z, String world, String email, String realName) { this.nickname = nickname; this.hash = hash; @@ -65,6 +161,10 @@ public class PlayerAuth { this.realName = realName; } + /** + * Method set. + * @param auth PlayerAuth + */ public void set(PlayerAuth auth) { this.setEmail(auth.getEmail()); this.setHash(auth.getHash()); @@ -79,94 +179,186 @@ public class PlayerAuth { this.setRealName(auth.getRealName()); } + /** + * Method setName. + * @param nickname String + */ public void setName(String nickname) { this.nickname = nickname; } + /** + * Method getNickname. + * @return String + */ public String getNickname() { return nickname; } + /** + * Method getRealName. + * @return String + */ public String getRealName() { return realName; } + /** + * Method setRealName. + * @param realName String + */ public void setRealName(String realName) { this.realName = realName; } + /** + * Method getGroupId. + * @return int + */ public int getGroupId() { return groupId; } + /** + * Method setQuitLocX. + * @param d double + */ public void setQuitLocX(double d) { this.x = d; } + /** + * Method getQuitLocX. + * @return double + */ public double getQuitLocX() { return x; } + /** + * Method setQuitLocY. + * @param d double + */ public void setQuitLocY(double d) { this.y = d; } + /** + * Method getQuitLocY. + * @return double + */ public double getQuitLocY() { return y; } + /** + * Method setQuitLocZ. + * @param d double + */ public void setQuitLocZ(double d) { this.z = d; } + /** + * Method getQuitLocZ. + * @return double + */ public double getQuitLocZ() { return z; } + /** + * Method setWorld. + * @param world String + */ public void setWorld(String world) { this.world = world; } + /** + * Method getWorld. + * @return String + */ public String getWorld() { return world; } + /** + * Method setIp. + * @param ip String + */ public void setIp(String ip) { this.ip = ip; } + /** + * Method getIp. + * @return String + */ public String getIp() { return ip; } + /** + * Method setLastLogin. + * @param lastLogin long + */ public void setLastLogin(long lastLogin) { this.lastLogin = lastLogin; } + /** + * Method getLastLogin. + * @return long + */ public long getLastLogin() { return lastLogin; } + /** + * Method setEmail. + * @param email String + */ public void setEmail(String email) { this.email = email; } + /** + * Method getEmail. + * @return String + */ public String getEmail() { return email; } + /** + * Method setSalt. + * @param salt String + */ public void setSalt(String salt) { this.salt = salt; } + /** + * Method getSalt. + * @return String + */ public String getSalt() { return this.salt; } + /** + * Method setHash. + * @param hash String + */ public void setHash(String hash) { this.hash = hash; } + /** + * Method getHash. + * @return String + */ public String getHash() { if (Settings.getPasswordHash == HashAlgorithm.MD5VB) { if (salt != null && !salt.isEmpty() && Settings.getPasswordHash == HashAlgorithm.MD5VB) { @@ -176,6 +368,11 @@ public class PlayerAuth { return hash; } + /** + * Method equals. + * @param obj Object + * @return boolean + */ @Override public boolean equals(Object obj) { if (!(obj instanceof PlayerAuth)) { @@ -185,6 +382,10 @@ public class PlayerAuth { return other.getIp().equals(this.ip) && other.getNickname().equals(this.nickname); } + /** + * Method hashCode. + * @return int + */ @Override public int hashCode() { int hashCode = 7; @@ -193,6 +394,10 @@ public class PlayerAuth { return hashCode; } + /** + * Method toString. + * @return String + */ @Override public String toString() { return ("Player : " + nickname + " | " + realName diff --git a/src/main/java/fr/xephi/authme/cache/auth/PlayerCache.java b/src/main/java/fr/xephi/authme/cache/auth/PlayerCache.java index d8b0f404..d4df6e06 100644 --- a/src/main/java/fr/xephi/authme/cache/auth/PlayerCache.java +++ b/src/main/java/fr/xephi/authme/cache/auth/PlayerCache.java @@ -2,6 +2,8 @@ package fr.xephi.authme.cache.auth; import java.util.concurrent.ConcurrentHashMap; +/** + */ public class PlayerCache { private volatile static PlayerCache singleton; @@ -11,27 +13,53 @@ public class PlayerCache { cache = new ConcurrentHashMap<>(); } + /** + * Method addPlayer. + * @param auth PlayerAuth + */ public void addPlayer(PlayerAuth auth) { cache.put(auth.getNickname().toLowerCase(), auth); } + /** + * Method updatePlayer. + * @param auth PlayerAuth + */ public void updatePlayer(PlayerAuth auth) { cache.remove(auth.getNickname().toLowerCase()); cache.put(auth.getNickname().toLowerCase(), auth); } + /** + * Method removePlayer. + * @param user String + */ public void removePlayer(String user) { cache.remove(user.toLowerCase()); } + /** + * Method isAuthenticated. + * @param user String + * @return boolean + */ public boolean isAuthenticated(String user) { return cache.containsKey(user.toLowerCase()); } + /** + * Method getAuth. + * @param user String + * @return PlayerAuth + */ public PlayerAuth getAuth(String user) { return cache.get(user.toLowerCase()); } + /** + * Method getInstance. + * @return PlayerCache + */ public static PlayerCache getInstance() { if (singleton == null) { singleton = new PlayerCache(); @@ -39,10 +67,18 @@ public class PlayerCache { return singleton; } + /** + * Method getLogged. + * @return int + */ public int getLogged() { return cache.size(); } + /** + * Method getCache. + * @return ConcurrentHashMap + */ public ConcurrentHashMap getCache() { return this.cache; } diff --git a/src/main/java/fr/xephi/authme/cache/backup/DataFileCache.java b/src/main/java/fr/xephi/authme/cache/backup/DataFileCache.java index 5aa40dde..07534751 100644 --- a/src/main/java/fr/xephi/authme/cache/backup/DataFileCache.java +++ b/src/main/java/fr/xephi/authme/cache/backup/DataFileCache.java @@ -1,25 +1,45 @@ package fr.xephi.authme.cache.backup; +/** + */ public class DataFileCache { private String group; private boolean operator; private boolean flying; + /** + * Constructor for DataFileCache. + * @param group String + * @param operator boolean + * @param flying boolean + */ public DataFileCache(String group, boolean operator, boolean flying) { this.group = group; this.operator = operator; this.flying = flying; } + /** + * Method getGroup. + * @return String + */ public String getGroup() { return group; } + /** + * Method getOperator. + * @return boolean + */ public boolean getOperator() { return operator; } + /** + * Method isFlying. + * @return boolean + */ public boolean isFlying() { return flying; } diff --git a/src/main/java/fr/xephi/authme/cache/backup/JsonCache.java b/src/main/java/fr/xephi/authme/cache/backup/JsonCache.java index 31c647cb..d3913471 100644 --- a/src/main/java/fr/xephi/authme/cache/backup/JsonCache.java +++ b/src/main/java/fr/xephi/authme/cache/backup/JsonCache.java @@ -22,6 +22,8 @@ import fr.xephi.authme.ConsoleLogger; import fr.xephi.authme.settings.Settings; import fr.xephi.authme.util.Utils; +/** + */ public class JsonCache { private final Gson gson; @@ -39,6 +41,11 @@ public class JsonCache { .create(); } + /** + * Method createCache. + * @param player Player + * @param playerData DataFileCache + */ public void createCache(Player player, DataFileCache playerData) { if (player == null) { return; @@ -68,6 +75,11 @@ public class JsonCache { } } + /** + * Method readCache. + * @param player Player + * @return DataFileCache + */ public DataFileCache readCache(Player player) { String path; try { @@ -90,7 +102,16 @@ public class JsonCache { } } + /** + */ private class PlayerDataSerializer implements JsonSerializer { + /** + * Method serialize. + * @param dataFileCache DataFileCache + * @param type Type + * @param jsonSerializationContext JsonSerializationContext + * @return JsonElement + */ @Override public JsonElement serialize(DataFileCache dataFileCache, Type type, JsonSerializationContext jsonSerializationContext) { JsonObject jsonObject = new JsonObject(); @@ -102,7 +123,18 @@ public class JsonCache { } } + /** + */ private static class PlayerDataDeserializer implements JsonDeserializer { + /** + * Method deserialize. + * @param jsonElement JsonElement + * @param type Type + * @param jsonDeserializationContext JsonDeserializationContext + * @return DataFileCache + * @throws JsonParseException + * @see com.google.gson.JsonDeserializer#deserialize(JsonElement, Type, JsonDeserializationContext) + */ @Override public DataFileCache deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext) throws JsonParseException { JsonObject jsonObject = jsonElement.getAsJsonObject(); @@ -128,6 +160,10 @@ public class JsonCache { } } + /** + * Method removeCache. + * @param player Player + */ public void removeCache(Player player) { String path; try { @@ -144,6 +180,11 @@ public class JsonCache { } } + /** + * Method doesCacheExist. + * @param player Player + * @return boolean + */ public boolean doesCacheExist(Player player) { String path; try { diff --git a/src/main/java/fr/xephi/authme/cache/limbo/LimboCache.java b/src/main/java/fr/xephi/authme/cache/limbo/LimboCache.java index 354d4c72..1bfe8164 100644 --- a/src/main/java/fr/xephi/authme/cache/limbo/LimboCache.java +++ b/src/main/java/fr/xephi/authme/cache/limbo/LimboCache.java @@ -14,6 +14,8 @@ import fr.xephi.authme.cache.backup.JsonCache; import fr.xephi.authme.events.ResetInventoryEvent; import fr.xephi.authme.settings.Settings; +/** + */ public class LimboCache { private volatile static LimboCache singleton; @@ -21,12 +23,20 @@ public class LimboCache { private JsonCache playerData; public AuthMe plugin; + /** + * Constructor for LimboCache. + * @param plugin AuthMe + */ private LimboCache(AuthMe plugin) { this.plugin = plugin; this.cache = new ConcurrentHashMap<>(); this.playerData = new JsonCache(); } + /** + * Method addLimboPlayer. + * @param player Player + */ public void addLimboPlayer(Player player) { String name = player.getName().toLowerCase(); Location loc = player.getLocation(); @@ -75,22 +85,45 @@ public class LimboCache { cache.put(name, new LimboPlayer(name, loc, gameMode, operator, playerGroup, flying)); } + /** + * Method addLimboPlayer. + * @param player Player + * @param group String + */ public void addLimboPlayer(Player player, String group) { cache.put(player.getName().toLowerCase(), new LimboPlayer(player.getName().toLowerCase(), group)); } + /** + * Method deleteLimboPlayer. + * @param name String + */ public void deleteLimboPlayer(String name) { cache.remove(name); } + /** + * Method getLimboPlayer. + * @param name String + * @return LimboPlayer + */ public LimboPlayer getLimboPlayer(String name) { return cache.get(name); } + /** + * Method hasLimboPlayer. + * @param name String + * @return boolean + */ public boolean hasLimboPlayer(String name) { return cache.containsKey(name); } + /** + * Method getInstance. + * @return LimboCache + */ public static LimboCache getInstance() { if (singleton == null) { singleton = new LimboCache(AuthMe.getInstance()); @@ -98,6 +131,10 @@ public class LimboCache { return singleton; } + /** + * Method updateLimboPlayer. + * @param player Player + */ public void updateLimboPlayer(Player player) { if (this.hasLimboPlayer(player.getName().toLowerCase())) { this.deleteLimboPlayer(player.getName().toLowerCase()); diff --git a/src/main/java/fr/xephi/authme/cache/limbo/LimboPlayer.java b/src/main/java/fr/xephi/authme/cache/limbo/LimboPlayer.java index f4ae0466..3d2dc304 100644 --- a/src/main/java/fr/xephi/authme/cache/limbo/LimboPlayer.java +++ b/src/main/java/fr/xephi/authme/cache/limbo/LimboPlayer.java @@ -4,6 +4,8 @@ import org.bukkit.GameMode; import org.bukkit.Location; import org.bukkit.scheduler.BukkitTask; +/** + */ public class LimboPlayer { private String name; @@ -15,6 +17,15 @@ public class LimboPlayer { private String group = ""; private boolean flying = false; + /** + * Constructor for LimboPlayer. + * @param name String + * @param loc Location + * @param gameMode GameMode + * @param operator boolean + * @param group String + * @param flying boolean + */ public LimboPlayer(String name, Location loc, GameMode gameMode, boolean operator, String group, boolean flying) { this.name = name; @@ -25,51 +36,96 @@ public class LimboPlayer { this.flying = flying; } + /** + * Constructor for LimboPlayer. + * @param name String + * @param group String + */ public LimboPlayer(String name, String group) { this.name = name; this.group = group; } + /** + * Method getName. + * @return String + */ public String getName() { return name; } + /** + * Method getLoc. + * @return Location + */ public Location getLoc() { return loc; } + /** + * Method getGameMode. + * @return GameMode + */ public GameMode getGameMode() { return gameMode; } + /** + * Method getOperator. + * @return boolean + */ public boolean getOperator() { return operator; } + /** + * Method getGroup. + * @return String + */ public String getGroup() { return group; } + /** + * Method setTimeoutTaskId. + * @param i BukkitTask + */ public void setTimeoutTaskId(BukkitTask i) { if (this.timeoutTaskId != null) this.timeoutTaskId.cancel(); this.timeoutTaskId = i; } + /** + * Method getTimeoutTaskId. + * @return BukkitTask + */ public BukkitTask getTimeoutTaskId() { return timeoutTaskId; } + /** + * Method setMessageTaskId. + * @param messageTaskId BukkitTask + */ public void setMessageTaskId(BukkitTask messageTaskId) { if (this.messageTaskId != null) this.messageTaskId.cancel(); this.messageTaskId = messageTaskId; } + /** + * Method getMessageTaskId. + * @return BukkitTask + */ public BukkitTask getMessageTaskId() { return messageTaskId; } + /** + * Method isFlying. + * @return boolean + */ public boolean isFlying() { return flying; } diff --git a/src/main/java/fr/xephi/authme/command/CommandArgumentDescription.java b/src/main/java/fr/xephi/authme/command/CommandArgumentDescription.java index a5ea63d0..e47311bf 100644 --- a/src/main/java/fr/xephi/authme/command/CommandArgumentDescription.java +++ b/src/main/java/fr/xephi/authme/command/CommandArgumentDescription.java @@ -1,5 +1,7 @@ package fr.xephi.authme.command; +/** + */ public class CommandArgumentDescription { // TODO: Allow argument to consist of infinite parts.