package org.apache.logging.log4j.core.lookup;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.ConfigurationAware;
import org.apache.logging.log4j.core.config.plugins.util.PluginManager;
import org.apache.logging.log4j.core.config.plugins.util.PluginType;
import org.apache.logging.log4j.core.util.Loader;
import org.apache.logging.log4j.core.util.ReflectionUtil;
import org.apache.logging.log4j.status.StatusLogger;
import org.apache.logging.log4j.util.Constants;
public class Interpolator extends AbstractConfigurationAwareLookup {
private static final String LOOKUP_KEY_WEB = "web";
private static final String LOOKUP_KEY_DOCKER = "docker";
private static final String LOOKUP_KEY_JNDI = "jndi";
private static final String LOOKUP_KEY_JVMRUNARGS = "jvmrunargs";
private static final Logger LOGGER = StatusLogger.getLogger();
private static final char PREFIX_SEPARATOR = ':';
private final Map<String, StrLookup> strLookupMap = new HashMap<>();
private final StrLookup defaultLookup;
public Interpolator(final StrLookup defaultLookup) {
this(defaultLookup, null);
}
public Interpolator(final StrLookup defaultLookup, final List<String> pluginPackages) {
this.defaultLookup = defaultLookup == null ? new MapLookup(new HashMap<String, String>()) : defaultLookup;
final PluginManager manager = new PluginManager(CATEGORY);
manager.collectPlugins(pluginPackages);
final Map<String, PluginType<?>> plugins = manager.getPlugins();
for (final Map.Entry<String, PluginType<?>> entry : plugins.entrySet()) {
try {
final Class<? extends StrLookup> clazz = entry.getValue().getPluginClass().asSubclass(StrLookup.class);
strLookupMap.put(entry.getKey().toLowerCase(), ReflectionUtil.instantiate(clazz));
} catch (final Throwable t) {
handleError(entry.getKey(), t);
}
}
}
public Interpolator() {
this((Map<String, String>) null);
}
public Interpolator(final Map<String, String> properties) {
this.defaultLookup = new MapLookup(properties == null ? new HashMap<String, String>() : properties);
strLookupMap.put("log4j", new Log4jLookup());
strLookupMap.put("sys", new SystemPropertiesLookup());
strLookupMap.put("env", new EnvironmentLookup());
strLookupMap.put("main", MainMapLookup.MAIN_SINGLETON);
strLookupMap.put("marker", new MarkerLookup());
strLookupMap.put("java", new JavaLookup());
try {
strLookupMap.put(LOOKUP_KEY_JNDI,
Loader.newCheckedInstanceOf("org.apache.logging.log4j.core.lookup.JndiLookup", StrLookup.class));
} catch (final LinkageError | Exception e) {
handleError(LOOKUP_KEY_JNDI, e);
}
try {
strLookupMap.put(LOOKUP_KEY_JVMRUNARGS,
Loader.newCheckedInstanceOf("org.apache.logging.log4j.core.lookup.JmxRuntimeInputArgumentsLookup",
StrLookup.class));
} catch (final LinkageError | Exception e) {
handleError(LOOKUP_KEY_JVMRUNARGS, e);
}
strLookupMap.put("date", new DateLookup());
strLookupMap.put("ctx", new ContextMapLookup());
if (Constants.IS_WEB_APP) {
try {
strLookupMap.put(LOOKUP_KEY_WEB,
Loader.newCheckedInstanceOf("org.apache.logging.log4j.web.WebLookup", StrLookup.class));
} catch (final Exception ignored) {
handleError(LOOKUP_KEY_WEB, ignored);
}
} else {
LOGGER.debug("Not in a ServletContext environment, thus not loading WebLookup plugin.");
}
try {
strLookupMap.put(LOOKUP_KEY_DOCKER,
Loader.newCheckedInstanceOf("org.apache.logging.log4j.docker.DockerLookup", StrLookup.class));
} catch (final Exception ignored) {
handleError(LOOKUP_KEY_DOCKER, ignored);
}
}
public Map<String, StrLookup> getStrLookupMap() {
return strLookupMap;
}
private void handleError(final String lookupKey, final Throwable t) {
switch (lookupKey) {
case LOOKUP_KEY_JNDI:
LOGGER.warn(
"JNDI lookup class is not available because this JRE does not support JNDI." +
" JNDI string lookups will not be available, continuing configuration. Ignoring " + t);
break;
case LOOKUP_KEY_JVMRUNARGS:
LOGGER.warn(
"JMX runtime input lookup class is not available because this JRE does not support JMX. " +
"JMX lookups will not be available, continuing configuration. Ignoring " + t);
break;
case LOOKUP_KEY_WEB:
LOGGER.info("Log4j appears to be running in a Servlet environment, but there's no log4j-web module " +
"available. If you want better web container support, please add the log4j-web JAR to your " +
"web archive or server lib directory.");
break;
case LOOKUP_KEY_DOCKER:
break;
default:
LOGGER.error("Unable to create Lookup for {}", lookupKey, t);
}
}
@Override
public String lookup(final LogEvent event, String var) {
if (var == null) {
return null;
}
final int prefixPos = var.indexOf(PREFIX_SEPARATOR);
if (prefixPos >= 0) {
final String prefix = var.substring(0, prefixPos).toLowerCase(Locale.US);
final String name = var.substring(prefixPos + 1);
final StrLookup lookup = strLookupMap.get(prefix);
if (lookup instanceof ConfigurationAware) {
((ConfigurationAware) lookup).setConfiguration(configuration);
}
String value = null;
if (lookup != null) {
value = event == null ? lookup.lookup(name) : lookup.lookup(event, name);
}
if (value != null) {
return value;
}
var = var.substring(prefixPos + 1);
}
if (defaultLookup != null) {
return event == null ? defaultLookup.lookup(var) : defaultLookup.lookup(event, var);
}
return null;
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder();
for (final String name : strLookupMap.keySet()) {
if (sb.length() == 0) {
sb.append('{');
} else {
sb.append(", ");
}
sb.append(name);
}
if (sb.length() > 0) {
sb.append('}');
}
return sb.toString();
}
}