Merge pull request #193 from GeyserMC/feature/log4j2

Add log4j2 support

bootstrap/standalone/pom.xml

@@ -20,27 +20,55 @@
         <dependency>
             <groupId>net.minecrell</groupId>
             <artifactId>terminalconsoleappender</artifactId>
-            <version>1.0.0</version>
+            <version>1.1.1</version>
-            <type>jar</type>
+            <exclusions>
-            <scope>compile</scope>
+                <exclusion>
+                    <groupId>org.apache.logging.log4j</groupId>
+                    <artifactId>log4j-core</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>org.jline</groupId>
+                    <artifactId>jline-reader</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>org.jline</groupId>
+                    <artifactId>jline-terminal-jna</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>org.jline</groupId>
+                    <artifactId>jline-terminal</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
         <dependency>
-            <groupId>org.slf4j</groupId>
+            <groupId>org.jline</groupId>
-            <artifactId>slf4j-api</artifactId>
+            <artifactId>jline-terminal</artifactId>
-            <version>1.7.5</version>
+            <version>3.9.0</version>
-            <scope>compile</scope>
         </dependency>
         <dependency>
-            <groupId>org.slf4j</groupId>
+            <groupId>org.jline</groupId>
-            <artifactId>slf4j-simple</artifactId>
+            <artifactId>jline-terminal-jna</artifactId>
-            <version>1.6.4</version>
+            <version>3.9.0</version>
-            <scope>compile</scope>
         </dependency>
         <dependency>
-            <groupId>org.fusesource.jansi</groupId>
+            <groupId>org.jline</groupId>
-            <artifactId>jansi</artifactId>
+            <artifactId>jline-reader</artifactId>
-            <version>1.18</version>
+            <version>3.9.0</version>
-            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-api</artifactId>
+            <version>2.13.1</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-core</artifactId>
+            <version>2.13.1</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-slf4j18-impl</artifactId>
+            <version>2.13.1</version>
         </dependency>
     </dependencies>
     <build>
@@ -62,6 +90,13 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
                 <version>3.2.1</version>
+                <dependencies>
+                    <dependency>
+                        <groupId>com.github.edwgiz</groupId>
+                        <artifactId>maven-shade-plugin.log4j2-cachefile-transformer</artifactId>
+                        <version>2.8.1</version>
+                    </dependency>
+                </dependencies>
                 <executions>
                     <execution>
                         <phase>package</phase>
@@ -69,10 +104,29 @@
                             <goal>shade</goal>
                         </goals>
                         <configuration>
-                            <minimizeJar>true</minimizeJar>
+                            <minimizeJar>false</minimizeJar>
                         </configuration>
                     </execution>
                 </executions>
+                <configuration>
+                    <filters>
+                        <filter>
+                            <artifact>*:*</artifact>
+                            <excludes>
+                                <exclude>META-INF/versions/9/module-info.class</exclude>
+                            </excludes>
+                        </filter>
+                    </filters>
+                    <transformers>
+                        <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
+                            <mainClass>org.geysermc.platform.standalone.GeyserBootstrap</mainClass>
+                        </transformer>
+                        <transformer
+                                implementation="com.github.edwgiz.mavenShadePlugin.log4j2CacheTransformer.PluginsCacheFileTransformer">
+                        </transformer>
+                    </transformers>
+                    <dependencyReducedPomLocation>${project.build.directory}/dependency-reduced-pom.xml</dependencyReducedPomLocation>
+                </configuration>
             </plugin>
         </plugins>
     </build>

bootstrap/standalone/src/main/java/org/geysermc/platform/standalone/GeyserBootstrap.java

@@ -25,12 +25,10 @@
 
 package org.geysermc.platform.standalone;
 
-import org.fusesource.jansi.AnsiConsole;
 import org.geysermc.common.PlatformType;
 import org.geysermc.common.bootstrap.IGeyserBootstrap;
 import org.geysermc.connector.GeyserConnector;
 import org.geysermc.connector.utils.FileUtils;
-import org.geysermc.platform.standalone.console.ConsoleCommandReader;
 import org.geysermc.platform.standalone.console.GeyserLogger;
 
 import java.io.File;
@@ -48,11 +46,6 @@ public class GeyserBootstrap implements IGeyserBootstrap {
 
     @Override
     public void onEnable() {
-        // Metric
-        if (!(System.console() == null) && System.getProperty("os.name", "Windows 10").toLowerCase().contains("windows")) {
-            AnsiConsole.systemInstall();
-        }
-
         geyserLogger = new GeyserLogger();
 
         try {
@@ -63,10 +56,8 @@ public class GeyserBootstrap implements IGeyserBootstrap {
             System.exit(0);
         }
 
-        GeyserConnector connector = GeyserConnector.start(PlatformType.STANDALONE, this);
+        GeyserConnector.start(PlatformType.STANDALONE, this);
-
+        geyserLogger.start();
-        ConsoleCommandReader consoleReader = new ConsoleCommandReader(connector);
-        consoleReader.startConsole();
     }
 
     @Override

bootstrap/standalone/src/main/java/org/geysermc/platform/standalone/console/ConsoleCommandReader.java

@@ -1,96 +0,0 @@
-/*
- * Copyright (c) 2019-2020 GeyserMC. http://geysermc.org
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @author GeyserMC
- * @link https://github.com/GeyserMC/Geyser
- */
-
-package org.geysermc.platform.standalone.console;
-
-import net.minecrell.terminalconsole.TerminalConsoleAppender;
-
-import org.geysermc.connector.GeyserConnector;
-import org.geysermc.connector.command.GeyserConsoleCommandSender;
-import org.jline.reader.EndOfFileException;
-import org.jline.reader.LineReader;
-import org.jline.reader.LineReaderBuilder;
-import org.jline.reader.UserInterruptException;
-import org.jline.terminal.Terminal;
-
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.util.logging.Level;
-import java.util.logging.Logger;
-
-public class ConsoleCommandReader {
-
-    private GeyserConnector connector;
-    private Terminal terminal;
-
-    public ConsoleCommandReader(GeyserConnector connector) {
-        this.connector = connector;
-        this.terminal = TerminalConsoleAppender.getTerminal();
-    }
-
-    public void startConsole() {
-        Thread thread = new Thread(() -> {
-            if (terminal != null) {
-                LineReader lineReader = LineReaderBuilder.builder()
-                        .appName("Geyser")
-                        .terminal(terminal)
-                        .build();
-                TerminalConsoleAppender.setReader(lineReader);
-
-                try {
-                    String line;
-
-                    while (true) {
-                        try {
-                            line = lineReader.readLine("> ");
-                        } catch (EndOfFileException ignored) {
-                            continue;
-                        }
-
-                        if (line == null)
-                            break;
-                    }
-                } catch (UserInterruptException ignore) {
-                    /* do nothing */
-                } finally {
-                    TerminalConsoleAppender.setReader(null);
-                }
-            } else {
-                try (BufferedReader reader = new BufferedReader(new InputStreamReader(System.in))) {
-                    String line;
-                    while ((line = reader.readLine()) != null) {
-                        GeyserConsoleCommandSender sender = new GeyserConsoleCommandSender();
-                        connector.getCommandMap().runCommand(sender, line);
-                    }
-                } catch (IOException ex) {
-                    Logger.getLogger("Geyser").log(Level.SEVERE, null, ex);
-                }
-            }
-        });
-
-        thread.setName("ConsoleCommandThread");
-    }
-}

bootstrap/standalone/src/main/java/org/geysermc/platform/standalone/console/GeyserLogger.java

@@ -25,103 +25,69 @@
 
 package org.geysermc.platform.standalone.console;
 
-import io.sentry.Sentry;
+import lombok.extern.log4j.Log4j2;
 
+import net.minecrell.terminalconsole.SimpleTerminalConsole;
+
+import org.apache.logging.log4j.core.config.Configurator;
 import org.geysermc.common.ChatColor;
 import org.geysermc.common.logger.IGeyserLogger;
+import org.geysermc.connector.GeyserConnector;
+import org.geysermc.connector.command.CommandSender;
 
-import java.io.File;
+@Log4j2
-import java.io.IOException;
+public class GeyserLogger extends SimpleTerminalConsole implements IGeyserLogger, CommandSender {
-import java.util.Date;
-import java.util.logging.*;
-
-public class GeyserLogger implements IGeyserLogger {
 
     private boolean colored = true;
-    private boolean debug = false;
-
-    public GeyserLogger() {
-        ConsoleHandler consoleHandler = new ConsoleHandler();
-        consoleHandler.setLevel(Level.INFO);
-        consoleHandler.setFormatter(new SimpleFormatter() {
-            private static final String format = "[%1$tT][%2$-5s] %3$s %n";
 
     @Override
-            public synchronized String format(LogRecord lr) {
+    protected boolean isRunning() {
-                return String.format(format,
+        return !GeyserConnector.getInstance().isShuttingDown();
-                        new Date(lr.getMillis()),
-                        lr.getLevel().getLocalizedName(),
-                        lr.getMessage()
-                );
     }
-        });
-
-        try {
-            File logDir = new File("logs");
-            logDir.mkdir();
-            File logFile = new File(logDir, "latest.log");
-            int maxLogFileSize = 20;//Mo
-            if (logFile.exists() && (logFile.length()) > maxLogFileSize * 1024L * 1024L)
-                this.warning("Your log file is larger than " + maxLogFileSize + "Mo, you should backup and clean it !");
-            FileHandler fileHandler = new FileHandler(logFile.getCanonicalPath(), true);
-            fileHandler.setLevel(Level.INFO);
-            fileHandler.setFormatter(new SimpleFormatter() {
-                private static final String format = "[%1$tF %1$tT][%2$-5s] %3$s %n";
 
     @Override
-                public synchronized String format(LogRecord lr) {
+    protected void runCommand(String line) {
-                    return String.format(format,
+        GeyserConnector.getInstance().getCommandMap().runCommand(this, line);
-                            new Date(lr.getMillis()),
-                            lr.getLevel().getLocalizedName(),
-                            lr.getMessage()
-                    );
-                }
-            });
-        } catch (IOException | SecurityException ex) {
-            Logger.getLogger(GeyserLogger.class.getName()).log(Level.SEVERE, null, ex);
     }
 
-        if (System.getenv().containsKey("DP_SENTRY_CLIENT_KEY")) {
+    @Override
-            Handler sentryHandler = new io.sentry.jul.SentryHandler();
+    protected void shutdown() {
-            sentryHandler.setLevel(Level.SEVERE);
+        GeyserConnector.getInstance().shutdown();
-            Sentry.init(System.getenv().get("DP_SENTRY_CLIENT_KEY"));
-        }
     }
 
     @Override
     public void severe(String message) {
-        System.out.println(printConsole(ChatColor.DARK_RED + message, colored));
+        log.fatal(printConsole(ChatColor.DARK_RED + message, colored));
     }
 
     @Override
     public void severe(String message, Throwable error) {
-        System.out.println(printConsole(ChatColor.DARK_RED + message + "\n" + error.getMessage(), colored));
+        log.fatal(printConsole(ChatColor.DARK_RED + message, colored), error);
     }
 
     @Override
     public void error(String message) {
-        System.out.println(printConsole(ChatColor.RED + message, colored));
+        log.error(printConsole(ChatColor.RED + message, colored));
     }
 
     @Override
     public void error(String message, Throwable error) {
-        System.out.println(printConsole(ChatColor.RED + message + "\n" + error, colored));
+        log.error(printConsole(ChatColor.RED + message, colored), error);
     }
 
     @Override
     public void warning(String message) {
-        System.out.println(printConsole(ChatColor.YELLOW + message, colored));
+        log.warn(printConsole(ChatColor.YELLOW + message, colored));
     }
 
     @Override
     public void info(String message) {
-        System.out.println(printConsole(ChatColor.WHITE + message, colored));
+        log.info(printConsole(ChatColor.WHITE + message, colored));
     }
 
     @Override
     public void debug(String message) {
-        if (debug)
+        log.debug(printConsole(ChatColor.GRAY + message, colored));
-            System.out.println(printConsole(ChatColor.GRAY + message, colored));
     }
 
     public static String printConsole(String message, boolean colors) {
@@ -130,6 +96,16 @@ public class GeyserLogger implements IGeyserLogger {
 
     @Override
     public void setDebug(boolean debug) {
-        this.debug = debug;
+        Configurator.setLevel(log.getName(), debug ? org.apache.logging.log4j.Level.DEBUG : log.getLevel());
+    }
+
+    @Override
+    public String getName() {
+        return "CONSOLE";
+    }
+
+    @Override
+    public void sendMessage(String message) {
+        info(message);
     }
 }

bootstrap/standalone/src/main/resources/log4j2.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Configuration status="WARN">
+    <Appenders>
+        <TerminalConsole name="Console">
+            <PatternLayout pattern="[%d{HH:mm:ss} %style{%highlight{%level}{FATAL=red dark, ERROR=red, WARN=yellow bright, INFO=cyan bright, DEBUG=green, TRACE=white}}] %minecraftFormatting{%msg}%n"/>
+        </TerminalConsole>
+        <RollingRandomAccessFile name="File" fileName="logs/latest.log" filePattern="logs/%d{yyyy-MM-dd}-%i.log.gz">
+            <PatternLayout pattern="%d{yyy-MM-dd HH:mm:ss.SSS} [%t] %level{length=1} - %msg%n"/>
+            <Policies>
+                <TimeBasedTriggeringPolicy/>
+                <OnStartupTriggeringPolicy/>
+            </Policies>
+        </RollingRandomAccessFile>
+    </Appenders>
+    <Loggers>
+        <Root level="INFO">
+            <AppenderRef ref="Console"/>
+            <AppenderRef ref="File"/>
+        </Root>
+    </Loggers>
+</Configuration>

connector/src/main/java/org/geysermc/connector/command/GeyserCommandMap.java

@@ -61,7 +61,7 @@ public class GeyserCommandMap {
     }
 
     public void runCommand(CommandSender sender, String command) {
-        if (!command.startsWith("/geyser "))
+        if (!command.startsWith("geyser "))
             return;
 
         command = command.trim();
@@ -80,7 +80,7 @@ public class GeyserCommandMap {
 
         GeyserCommand cmd = commandMap.get(label);
         if (cmd == null) {
-            connector.getLogger().warning("Invalid Command! Try /help for a list of commands.");
+            connector.getLogger().error("Invalid Command! Try /geyser help for a list of commands.");
             return;
         }
 

connector/src/main/java/org/geysermc/connector/command/GeyserConsoleCommandSender.java

@@ -1,41 +0,0 @@
-/*
- * Copyright (c) 2019-2020 GeyserMC. http://geysermc.org
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @author GeyserMC
- * @link https://github.com/GeyserMC/Geyser
- */
-
-package org.geysermc.connector.command;
-
-import org.geysermc.common.ChatColor;
-
-public class GeyserConsoleCommandSender implements CommandSender {
-
-    @Override
-    public String getName() {
-        return "CONSOLE";
-    }
-
-    @Override
-    public void sendMessage(String message) {
-        System.out.println(ChatColor.toANSI(message + ChatColor.RESET));
-    }
-}

connector/src/main/java/org/geysermc/connector/command/defaults/HelpCommand.java

@@ -52,7 +52,7 @@ public class HelpCommand extends GeyserCommand {
         Collections.sort(commands);
 
         for (String cmd : commands) {
-            sender.sendMessage(ChatColor.YELLOW + "/" + cmd + ChatColor.WHITE + ": " + cmds.get(cmd).getDescription());
+            sender.sendMessage(ChatColor.YELLOW + "/geyser " + cmd + ChatColor.WHITE + ": " + cmds.get(cmd).getDescription());
         }
     }
 }