1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.core.config.plugins;
18
19 import org.apache.logging.log4j.Logger;
20 import org.apache.logging.log4j.core.helpers.Loader;
21 import org.apache.logging.log4j.status.StatusLogger;
22
23 import java.io.BufferedInputStream;
24 import java.io.BufferedOutputStream;
25 import java.io.DataInputStream;
26 import java.io.DataOutputStream;
27 import java.io.File;
28 import java.io.FileOutputStream;
29 import java.io.IOException;
30 import java.io.InputStream;
31 import java.net.URL;
32 import java.text.DecimalFormat;
33 import java.util.Enumeration;
34 import java.util.HashMap;
35 import java.util.Map;
36 import java.util.concurrent.ConcurrentHashMap;
37 import java.util.concurrent.ConcurrentMap;
38 import java.util.concurrent.CopyOnWriteArrayList;
39
40
41
42
43 public class PluginManager {
44
45 private static final long NANOS_PER_SECOND = 1000000000L;
46
47 private static ConcurrentMap<String, ConcurrentMap<String, PluginType>> pluginTypeMap =
48 new ConcurrentHashMap<String, ConcurrentMap<String, PluginType>>();
49
50 private static final CopyOnWriteArrayList<String> PACKAGES = new CopyOnWriteArrayList<String>();
51 private static final String PATH = "org/apache/logging/log4j/core/config/plugins/";
52 private static final String FILENAME = "Log4j2Plugins.dat";
53 private static final String LOG4J_PACKAGES = "org.apache.logging.log4j.core";
54
55 private static final Logger LOGGER = StatusLogger.getLogger();
56
57 private static String rootDir;
58
59 private Map<String, PluginType> plugins = new HashMap<String, PluginType>();
60 private final String type;
61 private final Class<?> clazz;
62
63
64
65
66
67 public PluginManager(final String type) {
68 this.type = type;
69 this.clazz = null;
70 }
71
72
73
74
75
76
77 public PluginManager(final String type, final Class<?> clazz) {
78 this.type = type;
79 this.clazz = clazz;
80 }
81
82 public static void main(final String[] args) throws Exception {
83 if (args == null || args.length < 1) {
84 System.err.println("A target directory must be specified");
85 System.exit(-1);
86 }
87 rootDir = args[0].endsWith("/") || args[0].endsWith("\\") ? args[0] : args[0] + "/";
88
89 final PluginManager manager = new PluginManager("Core");
90 final String packages = args.length == 2 ? args[1] : null;
91
92 manager.collectPlugins(false, packages);
93 encode(pluginTypeMap);
94 }
95
96
97
98
99
100 public static void addPackage(final String p) {
101 if (PACKAGES.addIfAbsent(p))
102 {
103
104 pluginTypeMap.clear();
105 }
106 }
107
108
109
110
111
112
113 public PluginType getPluginType(final String name) {
114 return plugins.get(name.toLowerCase());
115 }
116
117
118
119
120
121 public Map<String, PluginType> getPlugins() {
122 return plugins;
123 }
124
125
126
127
128 public void collectPlugins() {
129 collectPlugins(true, null);
130 }
131
132
133
134
135
136
137
138 public void collectPlugins(boolean preLoad, final String pkgs) {
139 if (pluginTypeMap.containsKey(type)) {
140 plugins = pluginTypeMap.get(type);
141 preLoad = false;
142 }
143 final long start = System.nanoTime();
144 final ResolverUtil resolver = new ResolverUtil();
145 final ClassLoader loader = Loader.getClassLoader();
146 if (loader != null) {
147 resolver.setClassLoader(loader);
148 }
149 if (preLoad) {
150 final ConcurrentMap<String, ConcurrentMap<String, PluginType>> map = decode(loader);
151 if (map != null) {
152 pluginTypeMap = map;
153 plugins = map.get(type);
154 } else {
155 LOGGER.warn("Plugin preloads not available");
156 }
157 }
158 if (plugins == null || plugins.size() == 0) {
159 if (pkgs == null) {
160 if (!PACKAGES.contains(LOG4J_PACKAGES)) {
161 PACKAGES.add(LOG4J_PACKAGES);
162 }
163 } else {
164 final String[] names = pkgs.split(",");
165 for (final String name : names) {
166 PACKAGES.add(name);
167 }
168 }
169 }
170 final ResolverUtil.Test test = new PluginTest(clazz);
171 for (final String pkg : PACKAGES) {
172 resolver.findInPackage(test, pkg);
173 }
174 for (final Class<?> clazz : resolver.getClasses()) {
175 final Plugin plugin = clazz.getAnnotation(Plugin.class);
176 final String pluginType = plugin.type();
177 if (!pluginTypeMap.containsKey(pluginType)) {
178 pluginTypeMap.putIfAbsent(pluginType, new ConcurrentHashMap<String, PluginType>());
179 }
180 final Map<String, PluginType> map = pluginTypeMap.get(pluginType);
181 final String type = plugin.elementType().equals(Plugin.EMPTY) ? plugin.name() : plugin.elementType();
182 map.put(plugin.name().toLowerCase(), new PluginType(clazz, type, plugin.printObject(),
183 plugin.deferChildren()));
184 }
185 long elapsed = System.nanoTime() - start;
186 plugins = pluginTypeMap.get(type);
187 final StringBuilder sb = new StringBuilder("Generated plugins");
188 sb.append(" in ");
189 DecimalFormat numFormat = new DecimalFormat("#0");
190 final long seconds = elapsed / NANOS_PER_SECOND;
191 elapsed %= NANOS_PER_SECOND;
192 sb.append(numFormat.format(seconds)).append('.');
193 numFormat = new DecimalFormat("000000000");
194 sb.append(numFormat.format(elapsed)).append(" seconds");
195 LOGGER.debug(sb.toString());
196 }
197
198 private static ConcurrentMap<String, ConcurrentMap<String, PluginType>> decode(final ClassLoader loader) {
199 Enumeration<URL> resources;
200 try {
201 resources = loader.getResources(PATH + FILENAME);
202 } catch (final IOException ioe) {
203 LOGGER.warn("Unable to preload plugins", ioe);
204 return null;
205 }
206 final ConcurrentMap<String, ConcurrentMap<String, PluginType>> map =
207 new ConcurrentHashMap<String, ConcurrentMap<String, PluginType>>();
208 while (resources.hasMoreElements()) {
209 try {
210 final URL url = resources.nextElement();
211 LOGGER.debug("Found Plugin Map at {}", url.toExternalForm());
212 final InputStream is = url.openStream();
213 final BufferedInputStream bis = new BufferedInputStream(is);
214 final DataInputStream dis = new DataInputStream(bis);
215 final int count = dis.readInt();
216 for (int j = 0; j < count; ++j) {
217 final String type = dis.readUTF();
218 final int entries = dis.readInt();
219 ConcurrentMap<String, PluginType> types = map.get(type);
220 if (types == null) {
221 types = new ConcurrentHashMap<String, PluginType>(count);
222 }
223 for (int i = 0; i < entries; ++i) {
224 final String key = dis.readUTF();
225 final String className = dis.readUTF();
226 final String name = dis.readUTF();
227 final boolean printable = dis.readBoolean();
228 final boolean defer = dis.readBoolean();
229 final Class<?> clazz = Class.forName(className);
230 types.put(key, new PluginType(clazz, name, printable, defer));
231 }
232 map.putIfAbsent(type, types);
233 }
234 dis.close();
235 } catch (final Exception ex) {
236 LOGGER.warn("Unable to preload plugins", ex);
237 return null;
238 }
239 }
240 return map.size() == 0 ? null : map;
241 }
242
243 private static void encode(final ConcurrentMap<String, ConcurrentMap<String, PluginType>> map) {
244 final String fileName = rootDir + PATH + FILENAME;
245 try {
246 final File file = new File(rootDir + PATH);
247 file.mkdirs();
248 final FileOutputStream fos = new FileOutputStream(fileName);
249 final BufferedOutputStream bos = new BufferedOutputStream(fos);
250 final DataOutputStream dos = new DataOutputStream(bos);
251 dos.writeInt(map.size());
252 for (final Map.Entry<String, ConcurrentMap<String, PluginType>> outer : map.entrySet()) {
253 dos.writeUTF(outer.getKey());
254 dos.writeInt(outer.getValue().size());
255 for (final Map.Entry<String, PluginType> entry : outer.getValue().entrySet()) {
256 dos.writeUTF(entry.getKey());
257 final PluginType pt = entry.getValue();
258 dos.writeUTF(pt.getPluginClass().getName());
259 dos.writeUTF(pt.getElementName());
260 dos.writeBoolean(pt.isObjectPrintable());
261 dos.writeBoolean(pt.isDeferChildren());
262 }
263 }
264 dos.close();
265 } catch (final Exception ex) {
266 ex.printStackTrace();
267 }
268 }
269
270
271
272
273
274 public static class PluginTest extends ResolverUtil.ClassTest {
275 private final Class<?> isA;
276
277
278
279
280
281 public PluginTest(final Class<?> isA) {
282 this.isA = isA;
283 }
284
285
286
287
288
289
290 public boolean matches(final Class<?> type) {
291 return type != null && type.isAnnotationPresent(Plugin.class) &&
292 (isA == null || isA.isAssignableFrom(type));
293 }
294
295 @Override
296 public String toString() {
297 final StringBuilder msg = new StringBuilder("annotated with @" + Plugin.class.getSimpleName());
298 if (isA != null) {
299 msg.append(" is assignable to " + isA.getSimpleName());
300 }
301 return msg.toString();
302 }
303 }
304
305 }