nmode's Git Repositories - signal-cli/blob - src/main/java/org/asamk/signal/logging/LogConfigurator.java

   1 package org.asamk.signal.logging;
   2
   3 import java.io.File;
   4
   5 import ch.qos.logback.classic.Level;
   6 import ch.qos.logback.classic.Logger;
   7 import ch.qos.logback.classic.LoggerContext;
   8 import ch.qos.logback.classic.PatternLayout;
   9 import ch.qos.logback.classic.jul.LevelChangePropagator;
  10 import ch.qos.logback.classic.spi.Configurator;
  11 import ch.qos.logback.classic.spi.ILoggingEvent;
  12 import ch.qos.logback.core.ConsoleAppender;
  13 import ch.qos.logback.core.FileAppender;
  14 import ch.qos.logback.core.Layout;
  15 import ch.qos.logback.core.encoder.LayoutWrappingEncoder;
  16 import ch.qos.logback.core.filter.Filter;
  17 import ch.qos.logback.core.spi.ContextAwareBase;
  18 import ch.qos.logback.core.spi.FilterReply;
  19
  20 public class LogConfigurator extends ContextAwareBase implements Configurator {
  21
  22     private static int verboseLevel = 0;
  23     private static File logFile = null;
  24     private static boolean scrubSensitiveInformation = false;
  25
  26     public static void setVerboseLevel(int verboseLevel) {
  27         LogConfigurator.verboseLevel = verboseLevel;
  28     }
  29
  30     public static void setLogFile(File logFile) {
  31         LogConfigurator.logFile = logFile;
  32     }
  33
  34     public static void setScrubSensitiveInformation(final boolean scrubSensitiveInformation) {
  35         LogConfigurator.scrubSensitiveInformation = scrubSensitiveInformation;
  36     }
  37
  38     @Override
  39     public ExecutionStatus configure(LoggerContext lc) {
  40         lc.addListener(new LevelChangePropagator() {{
  41             setContext(lc);
  42         }});
  43         final var rootLogger = lc.getLogger(Logger.ROOT_LOGGER_NAME);
  44
  45         final var defaultLevel = verboseLevel > 1 ? Level.ALL : verboseLevel > 0 ? Level.INFO : Level.WARN;
  46         rootLogger.setLevel(defaultLevel);
  47
  48         final var consoleLayout = verboseLevel == 0 || logFile != null
  49                 ? createSimpleLoggingLayout(lc)
  50                 : createDetailedLoggingLayout(lc);
  51         final var consoleAppender = createLoggingConsoleAppender(lc, createLayoutWrappingEncoder(consoleLayout));
  52         rootLogger.addAppender(consoleAppender);
  53
  54         lc.getLogger("org.asamk").setLevel(verboseLevel > 1 ? Level.ALL : verboseLevel > 0 ? Level.DEBUG : Level.INFO);
  55         lc.getLogger("com.zaxxer.hikari.pool.PoolBase")
  56                 .setLevel(verboseLevel > 2 ? Level.ALL : verboseLevel > 1 ? Level.INFO : Level.WARN);
  57         lc.getLogger("org.sqlite.core.NativeDB")
  58                 .setLevel(verboseLevel > 3 ? Level.ALL : verboseLevel > 1 ? Level.INFO : Level.WARN);
  59
  60         if (logFile != null) {
  61             consoleAppender.addFilter(new Filter<>() {
  62                 @Override
  63                 public FilterReply decide(final ILoggingEvent event) {
  64                     return !"LibSignal".equals(event.getLoggerName()) && (
  65                             event.getLevel().isGreaterOrEqual(Level.WARN) || (
  66                                     event.getLevel().isGreaterOrEqual(Level.INFO) && event.getLoggerName()
  67                                             .startsWith("org.asamk")
  68                             )
  69                     )
  70
  71                             ? FilterReply.NEUTRAL : FilterReply.DENY;
  72                 }
  73             });
  74
  75             final var fileLayout = createDetailedLoggingLayout(lc);
  76             final var fileAppender = createLoggingFileAppender(lc, createLayoutWrappingEncoder(fileLayout));
  77             rootLogger.addAppender(fileAppender);
  78         }
  79         return ExecutionStatus.DO_NOT_INVOKE_NEXT_IF_ANY;
  80     }
  81
  82     private ConsoleAppender<ILoggingEvent> createLoggingConsoleAppender(
  83             final LoggerContext lc, final LayoutWrappingEncoder<ILoggingEvent> layoutEncoder
  84     ) {
  85         return new ConsoleAppender<>() {{
  86             setContext(lc);
  87             setName("console");
  88             setTarget("System.err");
  89             setEncoder(layoutEncoder);
  90             start();
  91         }};
  92     }
  93
  94     private FileAppender<ILoggingEvent> createLoggingFileAppender(
  95             final LoggerContext lc, final LayoutWrappingEncoder<ILoggingEvent> layoutEncoder
  96     ) {
  97         return new FileAppender<>() {{
  98             setContext(lc);
  99             setName("file");
 100             setFile(logFile.getAbsolutePath());
 101             setEncoder(layoutEncoder);
 102             start();
 103         }};
 104     }
 105
 106     private LayoutWrappingEncoder<ILoggingEvent> createLayoutWrappingEncoder(final Layout<ILoggingEvent> l) {
 107         return new LayoutWrappingEncoder<>() {{
 108             setContext(l.getContext());
 109             setLayout(l);
 110         }};
 111     }
 112
 113     private PatternLayout createSimpleLoggingLayout(final LoggerContext lc) {
 114         final var patternLayout = getPatternLayout();
 115         patternLayout.setPattern("%-5level %logger{0} - %msg%n");
 116         patternLayout.setContext(lc);
 117         patternLayout.start();
 118         return patternLayout;
 119     }
 120
 121     private PatternLayout createDetailedLoggingLayout(final LoggerContext lc) {
 122         final var patternLayout = getPatternLayout();
 123         patternLayout.setPattern("%d{yyyy-MM-dd'T'HH:mm:ss.SSSXX} [%thread] %-5level %logger{36} - %msg%n");
 124         patternLayout.setContext(lc);
 125         patternLayout.start();
 126         return patternLayout;
 127     }
 128
 129     private PatternLayout getPatternLayout() {
 130         if (scrubSensitiveInformation) {
 131             return new ScrubberPatternLayout();
 132         } else {
 133             return new PatternLayout();
 134         }
 135     }
 136 }