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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
|
/**
* This file is part of javadepchecker
*
* Copyright (C) 2016 Gentoo Foundation
*
* javadepchecker is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package javadepchecker;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.Set;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.Properties;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.commons.cli.PosixParser;
import org.objectweb.asm.AnnotationVisitor;
import org.objectweb.asm.ClassReader;
import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.FieldVisitor;
import org.objectweb.asm.Label;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;
import org.objectweb.asm.Type;
/**
* Main Class of javadepchecker
* Gentoo Java Utility to scan class files for unneeded dependencies and
* ophaned class files
*
* @author Petteri Räty <betelgeuse@gentoo.org>
* @author Serkan Kaba <serkan@gentoo.org>
* @author William L. Thomson Jr., <wlt@o-sinc.com>
*/
public final class Main extends ClassVisitor {
static private String image = "";
private Set<String> mDeps = new HashSet<>();
private Set<String> mCurrent = new HashSet<>();
/**
* Empty Constructor, sets ASM op code version
*/
public Main() {
super(Opcodes.ASM9);
}
/**
* Get jar names from the Gentoo package and store in a collection
*
* @param pkg Gentoo package name
* @return a collection of jar names
*/
private static Collection<String> getPackageJars(String pkg) {
ArrayList<String> jars = new ArrayList<>();
try {
Process p = Runtime.getRuntime().exec("java-config -p " + pkg);
p.waitFor();
BufferedReader in;
in = new BufferedReader(new InputStreamReader(p.getInputStream()));
String output = in.readLine();
if (output!=null/* package somehow missing*/ &&
!output.trim().isEmpty()) {
jars.addAll(Arrays.asList(output.split(":")));
}
} catch (InterruptedException | IOException ex) {
Logger.getLogger(Main.class.getName()).log(Level.SEVERE, null, ex);
}
return jars;
}
/**
* Scan jar for classes to be processed by ASM
*
* @param jar jar file to be processed
* @throws IOException
*/
public void processJar(JarFile jar) throws IOException {
Collections.list(jar.entries())
.stream()
.filter((JarEntry entry) -> (!entry.isDirectory() && entry.getName().endsWith("class")))
.forEach((JarEntry entry) -> {
InputStream is = null;
try {
Main.this.mCurrent.add(entry.getName());
is = jar.getInputStream(entry);
new ClassReader(is).accept(Main.this, 0);
} catch (IOException ex) {
Logger.getLogger(Main.class.getName()).log(Level.SEVERE, null, ex);
} finally {
try {
if(is!=null)
is.close();
} catch (IOException ex) {
Logger.getLogger(Main.class.getName()).log(Level.SEVERE, null, ex);
}
}
});
}
/**
* Check if a dependency is needed by a given package
*
* @param pkg Gentoo package name
* @param deps collection of dependencies for the package
* @return boolean if the dependency is needed or not
* @throws IOException
*/
private static boolean depNeeded(String pkg,
Collection<String> deps) throws IOException {
Collection<String> jars = getPackageJars(pkg);
// We have a virtual with VM provider here
if (jars.isEmpty()) {
return true;
}
for (String jarName : jars) {
JarFile jar = new JarFile(jarName);
for (Enumeration<JarEntry> e = jar.entries(); e.hasMoreElements();) {
String name = e.nextElement().getName();
if (deps.contains(name)) {
return true;
}
}
}
return false;
}
/**
* Check for orphaned class files not owned by any package in dependencies
*
* @param pkg Gentoo package name
* @param deps collection of dependencies for the package
* @return boolean if the dependency is found or not
* @throws IOException
*/
private static boolean depsFound(Collection<String> pkgs,
Collection<String> deps) throws IOException {
boolean found = true;
Collection<String> jars = new ArrayList<>();
pkgs.forEach((String pkg) -> {
jars.addAll(getPackageJars(pkg));
});
if (jars.isEmpty()) {
return false;
}
ArrayList<String> jarClasses = new ArrayList<>();
jars.forEach((String jarName) -> {
try {
JarFile jar = new JarFile(jarName);
Collections.list(jar.entries()).forEach((JarEntry entry) -> {
jarClasses.add(entry.getName());
});
} catch (IOException ex) {
Logger.getLogger(Main.class.getName()).log(Level.SEVERE, null, ex);
}
});
for (String dep : deps) {
if (!jarClasses.contains(dep)) {
boolean systemClass = false;
if (!dep.startsWith("org/apache/commons/cli/") && !dep.startsWith("org/objectweb/asm/")) {
try {
Class.forName(dep.replaceAll("\\.class$", "").replace('/', '.'));
systemClass = true;
} catch (final ClassNotFoundException ex) {
// it's not a syste class
}
}
if (!systemClass) {
if (found) {
System.out.println("Class files not found via DEPEND in package.env");
}
System.out.println("\t" + dep);
found = false;
}
}
}
return found;
}
/**
* Core method, this one fires off all others and is the one called from
* Main. Check this package for unneeded dependencies and orphaned class
* files
*
* @param env
* @return
*/
private static boolean checkPkg(File env) {
boolean needed = true;
boolean found = true;
HashSet<String> pkgs = new HashSet<>();
Collection<String> deps = null;
InputStream is = null;
try {
// load package.env
Properties props = new Properties();
is = new FileInputStream(env);
props.load(is);
// load package deps, add to hashset if exist
String depend = props.getProperty("DEPEND");
if(depend!=null &&
!depend.isEmpty()) {
for (String atom : depend.replaceAll("\"","").split(":")) {
String pkg = atom;
if (atom.contains("@")) {
pkg = atom.split("@")[1];
}
pkgs.add(pkg);
}
}
// load package classpath
String classpath = props.getProperty("CLASSPATH");
if(classpath!=null &&
!classpath.isEmpty()) {
Main classParser = new Main();
for (String jar : classpath.replaceAll("\"","").split(":")) {
if (jar.endsWith(".jar")) {
classParser.processJar(new JarFile(image + jar));
}
}
deps = classParser.getDeps();
}
for (String pkg : pkgs) {
if (!depNeeded(pkg, deps)) {
if (needed) {
System.out.println("Possibly unneeded dependencies found");
}
System.out.println("\t" + pkg);
needed = false;
}
}
found = depsFound(pkgs, deps);
} catch (IOException ex) {
Logger.getLogger(Main.class.getName()).log(Level.SEVERE, null, ex);
} finally {
try {
if(is!=null)
is.close();
} catch (IOException ex) {
Logger.getLogger(Main.class.getName()).log(Level.SEVERE, null, ex);
}
}
return needed && found;
}
/** Main method, parse command line opts, invoke the package checker
* @param args the command line arguments
* @throws java.io.IOException
*/
public static void main(String[] args) throws IOException {
int exit = 0;
try {
CommandLineParser parser = new PosixParser();
Options options = new Options();
options.addOption("h", "help", false, "print help");
options.addOption("i", "image", true, "image directory");
options.addOption("v", "verbose", false, "print verbose output");
CommandLine line = parser.parse(options, args);
String[] files = line.getArgs();
if (line.hasOption("h") || files.length == 0) {
HelpFormatter h = new HelpFormatter();
h.printHelp("java-dep-check [-i <image>] <package.env>+", options);
} else {
image = line.getOptionValue("i", "");
for (String arg : files) {
if (line.hasOption('v')) {
System.out.println("Checking " + arg);
}
if (!checkPkg(new File(arg))) {
exit = 1;
}
}
}
} catch (ParseException ex) {
Logger.getLogger(Main.class.getName()).log(Level.SEVERE, null, ex);
}
System.exit(exit);
}
/**
* Add dependency to deps hashset
*
* @param dep dependent class name
*/
private void addDep(String dep) {
mDeps.add(dep + ".class");
}
/**
* Add dependency type to deps hashset
*
* @param dep dependent class name
*/
private void addDep(Type dep) {
if (dep.getSort() == Type.ARRAY) {
addDep(dep.getElementType());
}
if (dep.getSort() == Type.OBJECT) {
addDep(dep.getInternalName());
}
}
/**
* Get deps not contained in the current hashset
*
* @return a collection of deps
*/
private Collection<String> getDeps() {
ArrayList<String> result = new ArrayList<>();
mDeps.stream().filter((s) -> (!mCurrent.contains(s))).forEach((s) -> {
result.add(s);
});
return result;
}
@Override
public void visit(int version,
int access,
String name,
String signature,
String superName,
String[] interfaces) {
if(superName != null) {
addDep(superName);
}
for (String iface : interfaces) {
addDep(iface);
}
}
@Override
public FieldVisitor visitField(int access,
String name,
String desc,
String signature,
Object value) {
addDep(Type.getType(desc));
return null;
}
@Override
public MethodVisitor visitMethod(int access,
String name,
String desc,
String signature,
String[] exceptions) {
for (Type param : Type.getArgumentTypes(desc)) {
addDep(param);
}
if (exceptions != null) {
for (String exception : exceptions) {
addDep(exception);
}
}
addDep(Type.getReturnType(desc));
return new MethodVisitor(Opcodes.ASM5) {
@Override
public void visitLocalVariable(String name,
String desc,
String signature,
Label start,
Label end,
int index) {
addDep(Type.getType(desc));
}
@Override
public void visitFieldInsn(int opcode,
String owner,
String name,
String desc) {
addDep(Type.getObjectType(owner));
addDep(Type.getType(desc));
}
@Override
public void visitMethodInsn(int opcode,
String owner,
String name,
String desc,
boolean itf) {
addDep(Type.getObjectType(owner));
}
@Override
public AnnotationVisitor visitParameterAnnotation(int parameter,
String desc,
boolean visible) {
return Main.this.visitAnnotation(desc, visible);
}
};
}
@Override
public AnnotationVisitor visitAnnotation(String desc, boolean visible) {
addDep(Type.getType(desc));
return null;
}
}
|