1b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato/* 2b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * ProGuard -- shrinking, optimization, obfuscation, and preverification 3b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * of Java bytecode. 4b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 5b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Copyright (c) 2002-2009 Eric Lafortune (eric@graphics.cornell.edu) 6b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 7b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * This program is free software; you can redistribute it and/or modify it 8b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * under the terms of the GNU General Public License as published by the Free 9b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Software Foundation; either version 2 of the License, or (at your option) 10b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * any later version. 11b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 12b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * This program is distributed in the hope that it will be useful, but WITHOUT 13b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 14b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 15b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * more details. 16b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 17b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * You should have received a copy of the GNU General Public License along 18b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * with this program; if not, write to the Free Software Foundation, Inc., 19b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 20b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 21b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratopackage proguard; 22b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 23b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport proguard.classfile.*; 24b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport proguard.classfile.util.*; 25b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport proguard.classfile.visitor.*; 26b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 27b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport java.util.List; 28b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 29b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato/** 30b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * This class checks if the user has forgotten to fully qualify any classes 31b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * in the configuration. 32b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 33b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @author Eric Lafortune 34b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 35b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratopublic class FullyQualifiedClassNameChecker 36b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoextends SimplifiedVisitor 37b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimplements ClassVisitor 38b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato{ 39b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private final ClassPool programClassPool; 40b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private final ClassPool libraryClassPool; 41b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private final WarningPrinter notePrinter; 42b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 43b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 44b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 45b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Creates a new DescriptorKeepChecker. 46b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 47b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public FullyQualifiedClassNameChecker(ClassPool programClassPool, 48b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassPool libraryClassPool, 49b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato WarningPrinter notePrinter) 50b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 51b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.programClassPool = programClassPool; 52b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.libraryClassPool = libraryClassPool; 53b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.notePrinter = notePrinter; 54b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 55b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 56b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 57b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 58b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Checks the classes mentioned in the given class specifications, printing 59b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * notes if necessary. Returns the number of notes printed. 60b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 61b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void checkClassSpecifications(List classSpecifications) 62b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 63b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (classSpecifications != null) 64b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 65b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato for (int index = 0; index < classSpecifications.size(); index++) 66b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 67b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassSpecification classSpecification = 68b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato (ClassSpecification)classSpecifications.get(index); 69b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 70b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato checkType(classSpecification.annotationType); 71b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato checkClassName(classSpecification.className); 72b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato checkType(classSpecification.extendsAnnotationType); 73b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato checkClassName(classSpecification.extendsClassName); 74b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 75b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato checkMemberSpecifications(classSpecification.fieldSpecifications, true); 76b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato checkMemberSpecifications(classSpecification.methodSpecifications, false); 77b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 78b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 79b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 80b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 81b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 82b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 83b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Checks the classes mentioned in the given class member specifications, 84b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * printing notes if necessary. 85b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 86b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private void checkMemberSpecifications(List memberSpecifications, boolean isField) 87b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 88b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (memberSpecifications != null) 89b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 90b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato for (int index = 0; index < memberSpecifications.size(); index++) 91b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 92b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato MemberSpecification memberSpecification = 93b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato (MemberSpecification)memberSpecifications.get(index); 94b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 95b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato checkType(memberSpecification.annotationType); 96b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 97b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (isField) 98b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 99b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato checkType(memberSpecification.descriptor); 100b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 101b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato else 102b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 103b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato checkDescriptor(memberSpecification.descriptor); 104b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 105b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 106b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 107b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 108b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 109b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 110b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 111b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Checks the classes mentioned in the given class member descriptor, 112b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * printing notes if necessary. 113b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 114b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private void checkDescriptor(String descriptor) 115b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 116b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (descriptor != null) 117b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 118b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato InternalTypeEnumeration internalTypeEnumeration = 119b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato new InternalTypeEnumeration(descriptor); 120b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 121b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato checkType(internalTypeEnumeration.returnType()); 122b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 123b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato while (internalTypeEnumeration.hasMoreTypes()) 124b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 125b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato checkType(internalTypeEnumeration.nextType()); 126b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 127b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 128b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 129b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 130b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 131b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 132b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Checks the class mentioned in the given type (if any), 133b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * printing notes if necessary. 134b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 135b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private void checkType(String type) 136b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 137b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (type != null) 138b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 139b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato checkClassName(ClassUtil.internalClassNameFromType(type)); 140b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 141b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 142b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 143b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 144b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 145b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Checks the specified class (if any), 146b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * printing notes if necessary. 147b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 148b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private void checkClassName(String className) 149b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 150b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (className != null && 151b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato !containsWildCards(className) && 152b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato programClassPool.getClass(className) == null && 153b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato libraryClassPool.getClass(className) == null && 154b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato notePrinter.accepts(className)) 155b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 156b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato notePrinter.print(className, 157b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato "Note: the configuration refers to the unknown class '" + 158b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassUtil.externalClassName(className) + "'"); 159b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 160b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato String fullyQualifiedClassName = 161b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato "**" + ClassConstants.INTERNAL_PACKAGE_SEPARATOR + 162b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato className.substring(className.lastIndexOf(ClassConstants.INTERNAL_PACKAGE_SEPARATOR)+1); 163b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 164b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassNameFilter classNameFilter = 165b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato new ClassNameFilter(fullyQualifiedClassName, this); 166b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 167b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato programClassPool.classesAccept(classNameFilter); 168b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato libraryClassPool.classesAccept(classNameFilter); 169b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 170b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 171b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 172b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 173b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private static boolean containsWildCards(String string) 174b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 175b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato return string != null && 176b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato (string.indexOf('*') >= 0 || 177b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato string.indexOf('?') >= 0 || 178b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato string.indexOf(',') >= 0 || 179b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato string.indexOf("///") >= 0); 180b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 181b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 182b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 183b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Implementations for ClassVisitor. 184b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 185b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void visitAnyClass(Clazz clazz) 186b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 187b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato System.out.println(" Maybe you meant the fully qualified name '" + 188b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassUtil.externalClassName(clazz.getName()) + "'?"); 189b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 190b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato} 191