Minecraft/slf4bukkit
Archived
0
Fork 0
Code Activity

Tolerate invalid config values with defaults

Browse Source
This commit is contained in:
rjenkinsjr
2016-03-30 22:19:58 -04:00
parent 1e0dbc8ec0
commit a861371a94
2 changed files with 36 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
src/main/java/org/slf4j/impl/BukkitPluginLoggerAdapter.java
View File

@@ -79,31 +79,33 @@ import org.yaml.snakeyaml.Yaml;
* <ul> * <ul>
* <li><code>slf4j.defaultLogLevel</code> - Default log level for all SLF4Bukkit * <li><code>slf4j.defaultLogLevel</code> - Default log level for all SLF4Bukkit
* loggers in this plugin. Must be one of "trace", "debug", "info", "warn", or * loggers in this plugin. Must be one of "trace", "debug", "info", "warn", or
* "error". Defaults to "info".</li> * "error". If unspecified or given any other value, defaults to "info".</li>
* *
* <li><code>slf4j.log.<em>a.b.c</em></code> - Logging detail level for an * <li><code>slf4j.log.<em>a.b.c</em></code> - Logging detail level for an
* SLF4Bukkit logger instance in this plugin named "a.b.c". Right-side value * SLF4Bukkit logger instance in this plugin named "a.b.c". Right-side value
* must be one of "trace", "debug", "info", "warn", or "error". When a logger * must be one of "trace", "debug", "info", "warn", or "error". When a logger
* named "a.b.c" is initialized, its level is assigned from this property. If * named "a.b.c" is initialized, its level is assigned from this property. If
* unspecified, the level of the nearest parent logger will be used. If no * unspecified or given any other value, the level of the nearest parent logger
* parent logger level is set, then the value specified by * will be used. If no parent logger level is set, then the value specified by
* <code>slf4j.defaultLogLevel</code> for this plugin will be used.</li> * <code>slf4j.defaultLogLevel</code> for this plugin will be used.</li>
* *
* <li><code>slf4j.showHeader</code> -Set to <code>true</code> if you want to * <li><code>slf4j.showHeader</code> -Set to <code>true</code> if you want to
* output the {@code [SLF4J]} header. Defaults to <code>false</code>.</li> * output the {@code [SLF4J]} header. If unspecified or given any other value,
* defaults to <code>false</code>.</li>
* *
* <li><code>slf4j.showThreadName</code> -Set to <code>true</code> if you want * <li><code>slf4j.showThreadName</code> -Set to <code>true</code> if you want
* to output the current thread name. Defaults to <code>false</code>.</li> * to output the current thread name. If unspecified or given any other value,
* defaults to <code>false</code>.</li>
* *
* <li><code>slf4j.showLogName</code> - Set to <code>true</code> if you want the * <li><code>slf4j.showLogName</code> - Set to <code>true</code> if you want the
* logger instance name to be included in output messages. Defaults to * logger instance name to be included in output messages. If unspecified or
* <code>false</code>.</li> * given any other value, defaults to <code>false</code>.</li>
* *
* <li><code>slf4j.showShortLogName</code> - Set to <code>true</code> if you * <li><code>slf4j.showShortLogName</code> - Set to <code>true</code> if you
* want the logger instance's short name to be included in output messages. The * want the logger instance's short name to be included in output messages. The
* short name is equal to the full name with every dot-separated portion of the * short name is equal to the full name with every dot-separated portion of the
* full name (except the last portion) truncated to its first character. * full name (except the last portion) truncated to its first character. If
* Defaults to <code>true</code>.</li> * unspecified or given any other value, defaults to <code>true</code>.</li>
* </ul> * </ul>
* *
* <p> * <p>
@@ -249,6 +251,7 @@ public final class BukkitPluginLoggerAdapter extends MarkerIgnoringBase {
// (1 and 2 are handled by using the Bukkit API.) // (1 and 2 are handled by using the Bukkit API.)
BukkitPluginLoggerAdapter.CONFIG_VALUE_DEFAULT_LOG_LEVEL = BukkitPluginLoggerAdapter.stringToLevel(BukkitPluginLoggerAdapter.getStringProperty(BukkitPluginLoggerAdapter.CONFIG_KEY_DEFAULT_LOG_LEVEL, BukkitPluginLoggerAdapter.CONFIG_VALUE_DEFAULT_LOG_LEVEL = BukkitPluginLoggerAdapter.stringToLevel(BukkitPluginLoggerAdapter.getStringProperty(BukkitPluginLoggerAdapter.CONFIG_KEY_DEFAULT_LOG_LEVEL,
BukkitPluginLoggerAdapter.CONFIG_FALLBACK_DEFAULT_LOG_LEVEL)); BukkitPluginLoggerAdapter.CONFIG_FALLBACK_DEFAULT_LOG_LEVEL));
if (BukkitPluginLoggerAdapter.CONFIG_VALUE_DEFAULT_LOG_LEVEL == null) BukkitPluginLoggerAdapter.CONFIG_VALUE_DEFAULT_LOG_LEVEL = BukkitPluginLoggerAdapter.stringToLevel(BukkitPluginLoggerAdapter.CONFIG_FALLBACK_DEFAULT_LOG_LEVEL);
BukkitPluginLoggerAdapter.CONFIG_VALUE_SHOW_HEADER = BukkitPluginLoggerAdapter.getBooleanProperty(BukkitPluginLoggerAdapter.CONFIG_KEY_SHOW_HEADER, BukkitPluginLoggerAdapter.CONFIG_VALUE_SHOW_HEADER = BukkitPluginLoggerAdapter.getBooleanProperty(BukkitPluginLoggerAdapter.CONFIG_KEY_SHOW_HEADER,
BukkitPluginLoggerAdapter.CONFIG_FALLBACK_SHOW_HEADER); BukkitPluginLoggerAdapter.CONFIG_FALLBACK_SHOW_HEADER);
BukkitPluginLoggerAdapter.CONFIG_VALUE_SHOW_LOG_NAME = BukkitPluginLoggerAdapter.getBooleanProperty(BukkitPluginLoggerAdapter.CONFIG_KEY_SHOW_LOG_NAME, BukkitPluginLoggerAdapter.CONFIG_VALUE_SHOW_LOG_NAME = BukkitPluginLoggerAdapter.getBooleanProperty(BukkitPluginLoggerAdapter.CONFIG_KEY_SHOW_LOG_NAME,
@@ -266,7 +269,9 @@ public final class BukkitPluginLoggerAdapter extends MarkerIgnoringBase {
if (BukkitPluginLoggerAdapter.BUKKIT_PLUGIN == null) { return defaultValue; } if (BukkitPluginLoggerAdapter.BUKKIT_PLUGIN == null) { return defaultValue; }
final String prop = BukkitPluginLoggerAdapter.BUKKIT_PLUGIN.getConfig() final String prop = BukkitPluginLoggerAdapter.BUKKIT_PLUGIN.getConfig()
.getString(name); .getString(name);
return (prop == null) ? defaultValue : "true".equalsIgnoreCase(prop); if ("true".equalsIgnoreCase(prop)) return true;
if ("false".equalsIgnoreCase(prop)) return false;
return defaultValue;
} }
} }
@@ -333,7 +338,7 @@ public final class BukkitPluginLoggerAdapter extends MarkerIgnoringBase {
} else if ("error".equalsIgnoreCase(levelStr)) { } else if ("error".equalsIgnoreCase(levelStr)) {
return Level.ERROR; return Level.ERROR;
} else { } else {
return Level.INFO; return null;
} }
} }
@@ -623,9 +628,9 @@ public final class BukkitPluginLoggerAdapter extends MarkerIgnoringBase {
} }
private Level determineCurrentLevel() { private Level determineCurrentLevel() {
final String levelString = this.recursivelyComputeLevelString(); final Level level = this.recursivelyComputeLevel();
if (levelString != null) { if (level != null) {
return BukkitPluginLoggerAdapter.stringToLevel(levelString); return level;
} else { } else {
return BukkitPluginLoggerAdapter.CONFIG_VALUE_DEFAULT_LOG_LEVEL; return BukkitPluginLoggerAdapter.CONFIG_VALUE_DEFAULT_LOG_LEVEL;
} }
@@ -823,18 +828,18 @@ public final class BukkitPluginLoggerAdapter extends MarkerIgnoringBase {
buf.toString(), t); buf.toString(), t);
} }
private String recursivelyComputeLevelString() { private Level recursivelyComputeLevel() {
String tempName = this.name; String tempName = this.name;
String levelString = null; Level level = null;
int indexOfLastDot = tempName.length(); int indexOfLastDot = tempName.length();
while ((levelString == null) && (indexOfLastDot > -1)) { while ((level == null) && (indexOfLastDot > -1)) {
tempName = tempName.substring(0, indexOfLastDot); tempName = tempName.substring(0, indexOfLastDot);
levelString = BukkitPluginLoggerAdapter.getStringProperty(BukkitPluginLoggerAdapter.CONFIG_KEY_PREFIX_LOG level = BukkitPluginLoggerAdapter.stringToLevel(BukkitPluginLoggerAdapter.getStringProperty(BukkitPluginLoggerAdapter.CONFIG_KEY_PREFIX_LOG
+ tempName, + tempName,
null); null));
indexOfLastDot = String.valueOf(tempName).lastIndexOf("."); indexOfLastDot = String.valueOf(tempName).lastIndexOf(".");
} }
return levelString; return level;
} }
} }

15
src/site/markdown/index.md
View File

@@ -41,30 +41,30 @@ slf4j:
# the plugin as "info" severity, but you'll see the actual severity in the # the plugin as "info" severity, but you'll see the actual severity in the
# log message. This is due to a Bukkit logging limitation. # log message. This is due to a Bukkit logging limitation.
# #
# If not specified, default is "info". # If not specified or given an invalid value, defaults to "info".
defaultLogLevel: info defaultLogLevel: info
# Shows an "[SLF4J]" header for every message logged through SLF4Bukkit. # Shows an "[SLF4J]" header for every message logged through SLF4Bukkit.
# #
# If not specified, default is "false". # If not specified or given an invalid value, defaults to "false".
showHeader: false showHeader: false
# Shows the name of each thread that is logging via SLF4Bukkit. You probably # Shows the name of each thread that is logging via SLF4Bukkit. You probably
# don't want this information unless you're helping troubleshoot a plugin. # don't want this information unless you're helping troubleshoot a plugin.
# #
# If not specified, default is "false". # If not specified or given an invalid value, defaults to "false".
showThreadName: false showThreadName: false
# Shows the full logger name (e.g. "info.ronjenkins.bukkit.MyPlugin"). # Shows the full logger name (e.g. "info.ronjenkins.bukkit.MyPlugin").
# #
# If not specified, default is "false". # If not specified or given an invalid value, defaults to "false".
showLogName: false showLogName: false
# Shows the short logger name, which is the short Java package name format # Shows the short logger name, which is the short Java package name format
# (e.g. a logger named "info.ronjenkins.bukkit.MyPlugin" would have a short # (e.g. a logger named "info.ronjenkins.bukkit.MyPlugin" would have a short
# name of "i.r.b.MyPlugin". # name of "i.r.b.MyPlugin".
# #
# If not specified, default is "true". # If not specified or given an invalid value, defaults to "true".
showShortLogName: true showShortLogName: true
# This section controls logging levels for individual loggers. # This section controls logging levels for individual loggers.
@@ -77,6 +77,11 @@ slf4j:
# The documentation for your plugin should elaborate on what logger names # The documentation for your plugin should elaborate on what logger names
# are available. As a general rule, you won't need to specify levels for # are available. As a general rule, you won't need to specify levels for
# specific loggers. # specific loggers.
#
# For any logger, if the level specified here is invalid, or if the level is
# not specified at all, the level of the closest parent logger is used. If
# none of the logger's ancestors have a valid level defined, the
# value of "slf4j.defaultLogLevel" is used.
info.ronjenkins.bukkit.MyPlugin: debug info.ronjenkins.bukkit.MyPlugin: debug
info.ronjenkins.SomeOtherLogger: warn info.ronjenkins.SomeOtherLogger: warn
``` ```