-
Notifications
You must be signed in to change notification settings - Fork 71
/
CHLog.java
325 lines (297 loc) · 9.86 KB
/
CHLog.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
package com.laytonsmith.core;
import com.laytonsmith.PureUtilities.Common.StackTraceUtils;
import com.laytonsmith.PureUtilities.Common.StreamUtils;
import com.laytonsmith.PureUtilities.Preferences;
import com.laytonsmith.PureUtilities.Preferences.Preference;
import com.laytonsmith.abstraction.Implementation;
import com.laytonsmith.core.constructs.Target;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.EnumMap;
import java.util.List;
/**
* The Log class simplifies logging for a user. Log messages are categorized by module and urgency, and the user
* configures each separately, allowing for more granular log control. Eventually, if other clients are able to connect
* to the system, they may each specify logging granularity, but the default is to use the preferences file and output
* to the debug log file.
*
*/
@SuppressWarnings("checkstyle:finalclass") // StaticTest.InstallFakeLogger() mocks this class, so it cannot be final.
public class CHLog {
private CHLog() {
}
private static final String HEADER = "The logger preferences allow you to granularly define what information\n"
+ "is written out to file, to assist you in debugging or general logging.\n"
+ "You may set the granularity of all the tags individually, to any one of\n"
+ "the following values:\n"
+ "OFF - Turns off all logging for this module.\n"
+ "ON - Synonym for ERRORS\n"
+ "\n"
+ "ERROR - Logs errors, or other high importance messages.\n"
+ "WARNING - Logs warnings and above.\n"
+ "INFO - Logs informational notices, and above.\n"
+ "DEBUG - Logs useful debugging information, and above.\n"
+ "VERBOSE - Logs every little detail.\n"
+ "\n\n"
+ "In many cases, components will only use the ERROR level, therefore, ON is a synonym.\n"
+ "However, in some cases, a component may give you more information if you set it lower."
+ "";
private static Preferences prefs;
private static final EnumMap<Tags, LogLevel> LOOKUP = new EnumMap<Tags, LogLevel>(Tags.class);
public enum Tags {
COMPILER("compiler", "Logs compiler errors (but not runtime errors)", LogLevel.WARNING),
RUNTIME("runtime", "Logs runtime errors, (exceptions that bubble all the way to the top)", LogLevel.ERROR),
FALSESTRING("falsestring", "Logs coersion of the string \"false\" to boolean, which is actually true",
LogLevel.ERROR),
DEPRECATION("deprecation", "Shows deprecation warnings", LogLevel.WARNING),
PERSISTENCE("persistence", "Logs when any persistence actions occur.", LogLevel.ERROR),
//TODO Add the rest of these hooks into the code
// IO("IO", "Logs when the filesystem is accessed.", Level.OFF),
// EVENTS("events", "Logs bindings and use of an event.", Level.OFF),
// PROCEDURES("procedures", "Logs when a procedure is created", Level.OFF),
INCLUDES("includes", "Logs what file is requested when include() is used", LogLevel.ERROR),
GENERAL("general", "Anything that doesn't fit in a more specific category is logged here.", LogLevel.ERROR),
META("meta", "Functions in the meta class use this tag", LogLevel.ERROR),
EXTENSIONS("extensions", "Extension related logs use this tag", LogLevel.ERROR);
String name;
String description;
LogLevel level;
private Tags(String name, String description, LogLevel defaultLevel) {
this.name = name;
this.description = description;
this.level = defaultLevel;
}
}
private static File root = null;
// Do not rename this field, it is used reflectively in tests
private static CHLog instance = null;
public static CHLog GetLogger() {
if(root == null) {
throw new RuntimeException("Logger is not initialized! Call CHLog.initialize before using the logger.");
}
if(instance == null) {
instance = new CHLog();
}
return instance;
}
/**
* Initializes the logger. This should be called once per JVM invocation. Eventually, a new instance of the logger
* should be created, but until then, the static approach is in use.
*
* @param root The root
*/
public static void initialize(File root) {
CHLog.root = root;
List<Preference> myPrefs = new ArrayList<Preference>();
for(Tags t : Tags.values()) {
myPrefs.add(new Preference(t.name, t.level.name(), Preferences.Type.STRING, t.description));
}
CHLog.prefs = new Preferences("CommandHelper", Static.getLogger(), myPrefs, HEADER);
try {
CHLog.prefs.init(MethodScriptFileLocations.getDefault().getLoggerPreferencesFile());
} catch (IOException e) {
Static.getLogger().log(java.util.logging.Level.SEVERE, "Could not create logger preferences", e);
}
}
/**
* Gets the level for the specified tag
*
* @param tag
* @return
*/
private static LogLevel GetLevel(Tags tag) {
if(LOOKUP.containsKey(tag)) {
return LOOKUP.get(tag);
}
LogLevel level;
try {
String pref = prefs.getStringPreference(tag.name);
if("ON".equals(pref)) {
level = LogLevel.ERROR;
} else {
level = LogLevel.valueOf(pref);
}
} catch (IllegalArgumentException e) {
level = LogLevel.ERROR;
}
LOOKUP.put(tag, level);
return level;
}
/**
* Returns true if a call to Log would cause this level and tag to be logged.
*
* @param tag
* @param l
* @return
*/
public boolean WillLog(Tags tag, LogLevel l) {
LogLevel level = GetLevel(tag);
if(level == LogLevel.OFF) {
return false;
} else {
return l.getLevel() <= level.getLevel();
}
}
/**
* From the given MsgBundles, picks the most appropriate log level, tending towards more verbose, and uses that
* message. This is useful if a message would be different, not just more information, given a level. For instance,
* given the following: LogOne(Tags.tag, new MsgBundle(Level.ERROR, "An error occured"), new
* MsgBundle(Level.VERBOSE, "An error occured, and here is why")), if the level was set to ERROR, only "An error
* occured" would show. If the level was set to VERBOSE, only "An error occured, and here is why" would show.
*
* @param tag
* @param t
* @param messages
*/
public void LogOne(Tags tag, Target t, MsgBundle... messages) {
if(GetLevel(tag) == LogLevel.OFF) {
return; //Bail!
}
LogLevel tagLevel = GetLevel(tag);
LogLevel[] levels = new LogLevel[]{LogLevel.VERBOSE, LogLevel.DEBUG, LogLevel.INFO, LogLevel.WARNING, LogLevel.ERROR};
for(LogLevel l : levels) {
for(MsgBundle b : messages) {
if(b.level == l && b.level == tagLevel) {
//Found it.
Log(tag, l, HEADER, t);
return;
}
}
}
}
/**
* Logs all the applicable levels. This is useful if a message is always displayed, but progressively more
* information is displayed the more verbose it gets.
*
* @param tag
* @param t
* @param messages
*/
public void LogAll(Tags tag, Target t, MsgBundle... messages) {
if(GetLevel(tag) == LogLevel.OFF) {
return; //For efficiency sake, go ahead and bail.
}
for(MsgBundle b : messages) {
Log(tag, b.level, b.message, t);
}
}
/**
* Logs the given message at the level of ERROR/ON.
*
* @param module
* @param message
* @param t
*/
public void Log(Tags module, String message, Target t) {
Log(module, LogLevel.ERROR, message, t);
}
/**
* Equivalent to Log(modules, level, message, t, true);
*
* @param modules
* @param level
* @param message
* @param t
*/
public void Log(Tags modules, LogLevel level, String message, Target t) {
Log(modules, level, message, t, true);
}
/**
* Logs the given message at the specified level.
*
* @param modules
* @param level
* @param message
* @param t
* @param printScreen
*/
public void Log(Tags modules, LogLevel level, String message, Target t, boolean printScreen) {
LogLevel moduleLevel = GetLevel(modules);
if(moduleLevel == LogLevel.OFF && !Prefs.ScreamErrors()) {
return; //Bail as quick as we can!
}
if(moduleLevel.level >= level.level || (moduleLevel == LogLevel.ERROR && Prefs.ScreamErrors())) {
//We want to do the log
try {
Static.LogDebug(root, "[" + Implementation.GetServerType().getBranding() + "][" + level.name() + "][" + modules.name() + "] " + message + (t != Target.UNKNOWN ? " " + t.toString() : ""),
level, printScreen);
} catch (IOException e) {
//Well, shoot.
if(level.level <= 1) {
StreamUtils.GetSystemErr().println("Was going to print information to the log, but instead, there was"
+ " an IOException: ");
e.printStackTrace(StreamUtils.GetSystemErr());
}
}
}
}
/**
* Logs the given exception at the ERROR level.
*
* @param modules
* @param throwable
* @param t
*/
public void e(Tags modules, Throwable throwable, Target t) {
Log(modules, LogLevel.ERROR, StackTraceUtils.GetStacktrace(throwable), t, true);
}
/**
* Logs the given message at the ERROR level.
*
* @param modules
* @param message
* @param t
*/
public void e(Tags modules, String message, Target t) {
Log(modules, LogLevel.ERROR, message, t, true);
}
/**
* Logs the given message at the WARNING level.
*
* @param modules
* @param message
* @param t
*/
public void w(Tags modules, String message, Target t) {
Log(modules, LogLevel.WARNING, message, t, true);
}
/**
* Logs the given message at the INFO level.
*
* @param modules
* @param message
* @param t
*/
public void i(Tags modules, String message, Target t) {
Log(modules, LogLevel.INFO, message, t, true);
}
/**
* Logs the given message at the DEBUG level.
*
* @param modules
* @param message
* @param t
*/
public void d(Tags modules, String message, Target t) {
Log(modules, LogLevel.DEBUG, message, t, true);
}
/**
* Logs the given message at the VERBOSE level.
*
* @param modules
* @param message
* @param t
*/
public void v(Tags modules, String message, Target t) {
Log(modules, LogLevel.VERBOSE, message, t, true);
}
public static class MsgBundle {
private LogLevel level;
private String message;
public MsgBundle(LogLevel level, String message) {
this.level = level;
this.message = message;
}
}
}