#605 Add custom log levels, create debug logging method

- Log levels in the log file too
- Create migration from old boolean "stop spam" property to new log level property

src/main/java/fr/xephi/authme/ConsoleLogger.java

@@ -1,7 +1,9 @@
 package fr.xephi.authme;
 
 import com.google.common.base.Throwables;
+import fr.xephi.authme.output.LogLevel;
 import fr.xephi.authme.settings.NewSetting;
+import fr.xephi.authme.settings.properties.PluginSettings;
 import fr.xephi.authme.settings.properties.SecuritySettings;
 import fr.xephi.authme.util.StringUtils;
 
@@ -21,6 +23,7 @@ public final class ConsoleLogger {
     private static final String NEW_LINE = System.getProperty("line.separator");
     private static final DateFormat DATE_FORMAT = new SimpleDateFormat("[MM-dd HH:mm:ss]");
     private static Logger logger;
+    private static LogLevel logLevel = LogLevel.INFO;
     private static boolean useLogging = false;
     private static File logFile;
     private static FileWriter fileWriter;
@@ -28,15 +31,35 @@ public final class ConsoleLogger {
     private ConsoleLogger() {
     }
 
+    // --------
+    // Configurations
+    // --------
+
+    /**
+     * Set the logger to use.
+     *
+     * @param logger The logger
+     */
     public static void setLogger(Logger logger) {
         ConsoleLogger.logger = logger;
     }
 
+    /**
+     * Set the file to log to if enabled.
+     *
+     * @param logFile The log file
+     */
     public static void setLogFile(File logFile) {
         ConsoleLogger.logFile = logFile;
     }
 
+    /**
+     * Load the required settings.
+     *
+     * @param settings The settings instance
+     */
     public static void setLoggingOptions(NewSetting settings) {
+        ConsoleLogger.logLevel = settings.getProperty(PluginSettings.LOG_LEVEL);
         ConsoleLogger.useLogging = settings.getProperty(SecuritySettings.USE_LOGGING);
         if (useLogging) {
             if (fileWriter == null) {
@@ -51,64 +74,81 @@ public final class ConsoleLogger {
         }
     }
 
-    /**
-     * Print an info message.
-     *
-     * @param message String
-     */
-    public static void info(String message) {
-        logger.info(message);
-        if (useLogging) {
-            writeLog("[INFO] " + message);
-        }
 
-    }
+    // --------
+    // Logging methods
+    // --------
 
     /**
-     * Print an error message.
+     * Log a WARN message.
      *
-     * @param message String
+     * @param message The message to log
      */
     public static void warning(String message) {
         logger.warning(message);
-        if (useLogging) {
-            writeLog("[WARN] " + message);
-        }
+        writeLog("[WARN] " + message);
     }
 
     /**
-     * Write a message into the log file with a TimeStamp.
+     * Log an INFO message.
      *
-     * @param message String
+     * @param message The message to log
      */
-    private static void writeLog(String message) {
-        String dateTime;
-        synchronized (DATE_FORMAT) {
-            dateTime = DATE_FORMAT.format(new Date());
-        }
-        try {
-            fileWriter.write(dateTime);
-            fileWriter.write(": ");
-            fileWriter.write(message);
-            fileWriter.write(NEW_LINE);
-            fileWriter.flush();
-        } catch (IOException ignored) {
+    public static void info(String message) {
+        logger.info(message);
+        writeLog("[INFO] " + message);
+    }
+
+    /**
+     * Log a FINE message if enabled.
+     * <p>
+     * Implementation note: this logs a message on INFO level because
+     * levels below INFO are disabled by Bukkit/Spigot.
+     *
+     * @param message The message to log
+     */
+    public static void fine(String message) {
+        if (logLevel.includes(LogLevel.FINE)) {
+            logger.info(message);
+            writeLog("[FINE] " + message);
         }
     }
 
     /**
-     * Logs a Throwable with the provided message and saves the stack trace to the log file.
+     * Log a DEBUG message if enabled.
+     * <p>
+     * Implementation note: this logs a message on INFO level and prefixes it with "DEBUG" because
+     * levels below INFO are disabled by Bukkit/Spigot.
+     *
+     * @param message The message to log
+     */
+    public static void debug(String message) {
+        if (logLevel.includes(LogLevel.DEBUG)) {
+            logger.info("Debug: " + message);
+            writeLog("[DEBUG] " + message);
+        }
+    }
+
+    /**
+     * Log a Throwable with the provided message on WARNING level
+     * and save the stack trace to the log file.
      *
      * @param message The message to accompany the exception
      * @param th      The Throwable to log
      */
     public static void logException(String message, Throwable th) {
         warning(message + " " + StringUtils.formatException(th));
-        if (useLogging) {
-            writeLog(Throwables.getStackTraceAsString(th));
-        }
+        writeLog(Throwables.getStackTraceAsString(th));
     }
 
+
+    // --------
+    // Helpers
+    // --------
+
+    /**
+     * Close all file handles.
+     */
     public static void close() {
         if (fileWriter != null) {
             try {
@@ -119,4 +159,26 @@ public final class ConsoleLogger {
             }
         }
     }
+
+    /**
+     * Write a message into the log file with a TimeStamp if enabled.
+     *
+     * @param message The message to write to the log
+     */
+    private static void writeLog(String message) {
+        if (useLogging) {
+            String dateTime;
+            synchronized (DATE_FORMAT) {
+                dateTime = DATE_FORMAT.format(new Date());
+            }
+            try {
+                fileWriter.write(dateTime);
+                fileWriter.write(": ");
+                fileWriter.write(message);
+                fileWriter.write(NEW_LINE);
+                fileWriter.flush();
+            } catch (IOException ignored) {
+            }
+        }
+    }
 }