java/sql-dk/src/main/java/info/globalcode/sql/dk/logging/ColorfulConsoleFormatter.java
author František Kučera <franta-hg@frantovo.cz>
Thu, 24 Oct 2019 21:43:08 +0200
branchv_0
changeset 250 aae5009bd0af
parent 238 4a1864c3e867
permissions -rw-r--r--
fix license version: GNU GPLv3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
55
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     1
/**
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     2
 * SQL-DK
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     3
 * Copyright © 2013 František Kučera (frantovo.cz)
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     4
 *
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     5
 * This program is free software: you can redistribute it and/or modify
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License as published by
250
aae5009bd0af fix license version: GNU GPLv3
František Kučera <franta-hg@frantovo.cz>
parents: 238
diff changeset
     7
 * the Free Software Foundation, version 3 of the License.
55
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     8
 *
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    12
 * GNU General Public License for more details.
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    13
 *
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    15
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    16
 */
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    17
package info.globalcode.sql.dk.logging;
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    18
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    19
import info.globalcode.sql.dk.ColorfulPrintWriter;
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    20
import static info.globalcode.sql.dk.ColorfulPrintWriter.TerminalColor;
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    21
import static info.globalcode.sql.dk.ColorfulPrintWriter.TerminalStyle;
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    22
import static info.globalcode.sql.dk.Functions.rpad;
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    23
import java.io.StringWriter;
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    24
import java.util.logging.Formatter;
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    25
import java.util.logging.Level;
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    26
import java.util.logging.LogRecord;
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    27
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    28
/**
155
eb3676c6929b more JavaDoc
František Kučera <franta-hg@frantovo.cz>
parents: 59
diff changeset
    29
 * For console/terminal log output. Log messages are printed in brief and colorful form.
55
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    30
 *
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    31
 * @author Ing. František Kučera (frantovo.cz)
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    32
 */
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    33
public class ColorfulConsoleFormatter extends Formatter {
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    34
59
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    35
	private boolean printStacktrace = false;
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    36
55
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    37
	@Override
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    38
	public String format(LogRecord r) {
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    39
		StringWriter sw = new StringWriter();
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    40
		try (ColorfulPrintWriter out = new ColorfulPrintWriter(sw)) {
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    41
			printLevel(out, r.getLevel());
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    42
			printMessage(out, r);
59
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    43
			printThrowable(out, r);
55
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    44
			out.println();
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    45
		}
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    46
		return sw.toString();
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    47
	}
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    48
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    49
	private void printLevel(ColorfulPrintWriter out, Level l) {
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    50
		TerminalColor color = TerminalColor.Magenta;
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    51
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    52
		if (l == Level.SEVERE) {
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    53
			color = TerminalColor.Red;
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    54
		} else if (l == Level.WARNING) {
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    55
			color = TerminalColor.Yellow;
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    56
		}
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    57
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    58
		out.print(color, rpad(l.getLocalizedName() + ": ", 10));
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    59
	}
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    60
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    61
	private void printMessage(ColorfulPrintWriter out, LogRecord r) {
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    62
		out.print(formatMessage(r));
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    63
	}
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    64
59
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    65
	private void printThrowable(ColorfulPrintWriter out, LogRecord r) {
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    66
		Throwable t = r.getThrown();
55
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    67
		if (t != null) {
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    68
			out.print(": ");
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    69
			out.print(TerminalColor.Red, t.getClass().getSimpleName());
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    70
			String message = t.getLocalizedMessage();
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    71
			if (message != null) {
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    72
				out.print(": ");
182
4ff7a273f3e8 logging: strip line ends from the error message if not printing stacktrace
František Kučera <franta-hg@frantovo.cz>
parents: 155
diff changeset
    73
				if (printStacktrace) {
4ff7a273f3e8 logging: strip line ends from the error message if not printing stacktrace
František Kučera <franta-hg@frantovo.cz>
parents: 155
diff changeset
    74
					out.print(message);
4ff7a273f3e8 logging: strip line ends from the error message if not printing stacktrace
František Kučera <franta-hg@frantovo.cz>
parents: 155
diff changeset
    75
				} else {
4ff7a273f3e8 logging: strip line ends from the error message if not printing stacktrace
František Kučera <franta-hg@frantovo.cz>
parents: 155
diff changeset
    76
					out.print(message.replaceAll("\\n", " "));
4ff7a273f3e8 logging: strip line ends from the error message if not printing stacktrace
František Kučera <franta-hg@frantovo.cz>
parents: 155
diff changeset
    77
				}
55
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    78
			}
59
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    79
			if (printStacktrace) {
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    80
				out.println();
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    81
				out.setForegroundColor(TerminalColor.Yellow);
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    82
				out.setStyle(TerminalStyle.Dim);
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    83
				t.printStackTrace(out);
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    84
				out.resetAll();
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    85
			}
55
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    86
		}
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    87
	}
59
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    88
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    89
	public boolean isPrintStacktrace() {
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    90
		return printStacktrace;
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    91
	}
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    92
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    93
	public void setPrintStacktrace(boolean printStacktrace) {
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    94
		this.printStacktrace = printStacktrace;
5f745ae795a8 logging: print stacktraces if level is less than INFO
František Kučera <franta-hg@frantovo.cz>
parents: 55
diff changeset
    95
	}
55
f5ed7c4efacc colorful logging
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    96
}