aoqi@0: /*
aoqi@0:  * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: /*
aoqi@0:  * @test
aoqi@0:  * @bug 8026180
aoqi@0:  * @summary Ensuring javax.lang.model.**, javax.tools.**, javax.annotation.processing.**
aoqi@0:  *          and com.sun.source.** don't export inappropriate types.
aoqi@0:  * @library /tools/javac/lib
aoqi@0:  * @build JavacTestingAbstractProcessor NoPrivateTypesExported
aoqi@0:  * @compile -processor NoPrivateTypesExported NoPrivateTypesExported.java
aoqi@0:  */
aoqi@0: import java.lang.annotation.Documented;
aoqi@0: import java.util.Arrays;
aoqi@0: import java.util.HashSet;
aoqi@0: import java.util.List;
aoqi@0: import java.util.Set;
aoqi@0: import javax.annotation.processing.RoundEnvironment;
aoqi@0: import javax.lang.model.element.AnnotationMirror;
aoqi@0: import javax.lang.model.element.AnnotationValue;
aoqi@0: import javax.lang.model.element.Element;
aoqi@0: import javax.lang.model.element.ElementKind;
aoqi@0: import javax.lang.model.element.ExecutableElement;
aoqi@0: import javax.lang.model.element.PackageElement;
aoqi@0: import javax.lang.model.element.TypeElement;
aoqi@0: import javax.lang.model.element.TypeParameterElement;
aoqi@0: import javax.lang.model.element.VariableElement;
aoqi@0: import javax.lang.model.type.ArrayType;
aoqi@0: import javax.lang.model.type.DeclaredType;
aoqi@0: import javax.lang.model.type.IntersectionType;
aoqi@0: import javax.lang.model.type.TypeMirror;
aoqi@0: import javax.lang.model.type.TypeVariable;
aoqi@0: import javax.lang.model.type.WildcardType;
aoqi@0: import javax.lang.model.util.ElementScanner8;
aoqi@0: import javax.lang.model.util.SimpleAnnotationValueVisitor8;
aoqi@0: import javax.tools.Diagnostic.Kind;
aoqi@0: 
aoqi@0: public class NoPrivateTypesExported extends JavacTestingAbstractProcessor {
aoqi@0: 
aoqi@0:     private static final String[] javaxLangModelPackages = new String[] {
aoqi@0:         "javax.lang.model",
aoqi@0:         "javax.lang.model.element",
aoqi@0:         "javax.lang.model.type",
aoqi@0:         "javax.lang.model.util",
aoqi@0:     };
aoqi@0: 
aoqi@0:     private static final Set<String> javaxLangModelAcceptable;
aoqi@0: 
aoqi@0:     private static final String[] javaxToolsProcessingPackages = new String[] {
aoqi@0:         "javax.annotation.processing",
aoqi@0:         "javax.tools",
aoqi@0:     };
aoqi@0: 
aoqi@0:     private static final Set<String> javaxToolsProcessingAcceptable;
aoqi@0: 
aoqi@0:     private static final String[] comSunSourcePackages = new String[] {
aoqi@0:         "com.sun.source.doctree",
aoqi@0:         "com.sun.source.tree",
aoqi@0:         "com.sun.source.util"
aoqi@0:     };
aoqi@0: 
aoqi@0:     private static final Set<String> comSunSourceAcceptable;
aoqi@0: 
aoqi@0:     static {
aoqi@0:         javaxLangModelAcceptable = new HashSet<>(Arrays.asList(
aoqi@0:             "java.io.",
aoqi@0:             "java.lang.",
aoqi@0:             "java.net.",
aoqi@0:             "java.nio.",
aoqi@0:             "java.util.",
aoqi@0:             "javax.lang.model.",
aoqi@0:             "javax.annotation.processing.SupportedSourceVersion",
aoqi@0:             "jdk.Exported"
aoqi@0:         ));
aoqi@0:         Set<String> javaxToolsProcessingAcceptableTemp = new HashSet<>();
aoqi@0:         javaxToolsProcessingAcceptableTemp.addAll(javaxLangModelAcceptable);
aoqi@0:         javaxToolsProcessingAcceptableTemp.addAll(Arrays.asList(
aoqi@0:                 "javax.annotation.processing.",
aoqi@0:                 "javax.tools."
aoqi@0:         ));
aoqi@0:         javaxToolsProcessingAcceptable = javaxToolsProcessingAcceptableTemp;
aoqi@0:         Set<String> comSunSourceAcceptableTemp = new HashSet<>();
aoqi@0:         comSunSourceAcceptableTemp.addAll(javaxToolsProcessingAcceptable);
aoqi@0:         comSunSourceAcceptableTemp.addAll(Arrays.asList(
aoqi@0:                 "com.sun.source.doctree.",
aoqi@0:                 "com.sun.source.tree.",
aoqi@0:                 "com.sun.source.util."
aoqi@0:         ));
aoqi@0:         comSunSourceAcceptable = comSunSourceAcceptableTemp;
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public boolean process(Set<? extends TypeElement> annotations,
aoqi@0:                            RoundEnvironment roundEnv) {
aoqi@0:         if (roundEnv.processingOver()) {
aoqi@0:             verifyPackage(javaxLangModelPackages, javaxLangModelAcceptable);
aoqi@0:             verifyPackage(javaxToolsProcessingPackages, javaxToolsProcessingAcceptable);
aoqi@0:             verifyPackage(comSunSourcePackages, comSunSourceAcceptable);
aoqi@0:         }
aoqi@0:         return true;
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void verifyPackage(String[] packagesToTest, Set<String> acceptable) {
aoqi@0:         for (String packageToTest : packagesToTest) {
aoqi@0:             PackageElement packageElement = processingEnv.getElementUtils()
aoqi@0:                     .getPackageElement(packageToTest);
aoqi@0: 
aoqi@0:             verifyReferredTypesAcceptable(packageElement, acceptable);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void verifyReferredTypesAcceptable(Element rootElement,
aoqi@0:                                                final Set<String> acceptable) {
aoqi@0:         new ElementScanner8<Void, Void>() {
aoqi@0:             @Override public Void visitType(TypeElement e, Void p) {
aoqi@0:                 verifyTypeAcceptable(e.getSuperclass(), acceptable);
aoqi@0:                 verifyTypesAcceptable(e.getInterfaces(), acceptable);
aoqi@0:                 scan(e.getTypeParameters(), p);
aoqi@0:                 scan(e.getEnclosedElements(), p);
aoqi@0:                 verifyAnnotations(e.getAnnotationMirrors(), acceptable);
aoqi@0:                 return null;
aoqi@0:             }
aoqi@0:             @Override public Void visitTypeParameter(TypeParameterElement e, Void p) {
aoqi@0:                 verifyTypesAcceptable(e.getBounds(), acceptable);
aoqi@0:                 scan(e.getEnclosedElements(), p);
aoqi@0:                 verifyAnnotations(e.getAnnotationMirrors(), acceptable);
aoqi@0:                 return null;
aoqi@0:             }
aoqi@0:             @Override public Void visitPackage(PackageElement e, Void p) {
aoqi@0:                 scan(e.getEnclosedElements(), p);
aoqi@0:                 verifyAnnotations(e.getAnnotationMirrors(), acceptable);
aoqi@0:                 return null;
aoqi@0:             }
aoqi@0:             @Override public Void visitVariable(VariableElement e, Void p) {
aoqi@0:                 verifyTypeAcceptable(e.asType(), acceptable);
aoqi@0:                 scan(e.getEnclosedElements(), p);
aoqi@0:                 verifyAnnotations(e.getAnnotationMirrors(), acceptable);
aoqi@0:                 return null;
aoqi@0:             }
aoqi@0:             @Override
aoqi@0:             public Void visitExecutable(ExecutableElement e, Void p) {
aoqi@0:                 scan(e.getTypeParameters(), p);
aoqi@0:                 verifyTypeAcceptable(e.getReturnType(), acceptable);
aoqi@0:                 scan(e.getParameters(), p);
aoqi@0:                 verifyTypesAcceptable(e.getThrownTypes(), acceptable);
aoqi@0:                 scan(e.getEnclosedElements(), p);
aoqi@0:                 verifyAnnotations(e.getAnnotationMirrors(), acceptable);
aoqi@0:                 return null;
aoqi@0:             }
aoqi@0:         }.scan(rootElement, null);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void verifyAnnotations(Iterable<? extends AnnotationMirror> annotations,
aoqi@0:                                    Set<String> acceptable) {
aoqi@0:         for (AnnotationMirror mirror : annotations) {
aoqi@0:             Element annotationElement = mirror.getAnnotationType().asElement();
aoqi@0: 
aoqi@0:             if (annotationElement.getAnnotation(Documented.class) == null) {
aoqi@0:                 note("Ignoring undocumented annotation: " + mirror.getAnnotationType());
aoqi@0:             }
aoqi@0: 
aoqi@0:             verifyTypeAcceptable(mirror.getAnnotationType(), acceptable);
aoqi@0: 
aoqi@0:             for (AnnotationValue value : mirror.getElementValues().values()) {
aoqi@0:                 verifyAnnotationValue(value, acceptable);
aoqi@0:             }
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void verifyAnnotationValue(AnnotationValue value,
aoqi@0:                                        final Set<String> acceptable) {
aoqi@0:         value.accept(new SimpleAnnotationValueVisitor8<Void, Void>() {
aoqi@0:             @Override public Void visitType(TypeMirror t, Void p) {
aoqi@0:                 verifyTypeAcceptable(t, acceptable);
aoqi@0:                 return null;
aoqi@0:             }
aoqi@0:             @Override
aoqi@0:             public Void visitEnumConstant(VariableElement c, Void p) {
aoqi@0:                 verifyReferredTypesAcceptable(c, acceptable);
aoqi@0:                 return null;
aoqi@0:             }
aoqi@0:             @Override public Void visitArray(List<? extends AnnotationValue> vals,
aoqi@0:                                              Void p) {
aoqi@0:                 for (AnnotationValue val : vals) {
aoqi@0:                     val.accept(this, p);
aoqi@0:                 }
aoqi@0:                 return null;
aoqi@0:             }
aoqi@0:             @Override protected Void defaultAction(Object o, Void p) {
aoqi@0:                 error("Unexpected AnnotationValue: " + o.toString());
aoqi@0:                 return super.defaultAction(o, p);
aoqi@0:             }
aoqi@0:         }, null);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void verifyTypesAcceptable(Iterable<? extends TypeMirror> types,
aoqi@0:                                        Set<String> acceptable) {
aoqi@0:         if (types == null) return ;
aoqi@0: 
aoqi@0:         for (TypeMirror type : types) {
aoqi@0:             verifyTypeAcceptable(type, acceptable);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void verifyTypeAcceptable(TypeMirror type, Set<String> acceptable) {
aoqi@0:         if (type == null) return ;
aoqi@0: 
aoqi@0:         verifyAnnotations(type.getAnnotationMirrors(), acceptable);
aoqi@0: 
aoqi@0:         switch (type.getKind()) {
aoqi@0:             case BOOLEAN: case BYTE: case CHAR: case DOUBLE: case FLOAT:
aoqi@0:             case INT: case LONG: case SHORT: case VOID: case NONE: case NULL:
aoqi@0:                 return ;
aoqi@0:             case DECLARED:
aoqi@0:                 DeclaredType dt = (DeclaredType) type;
aoqi@0:                 TypeElement outermostTypeElement = outermostTypeElement(dt.asElement());
aoqi@0:                 String outermostType = outermostTypeElement.getQualifiedName().toString();
aoqi@0:                 boolean isAcceptable = false;
aoqi@0:                 for (String acceptablePackage : acceptable) {
aoqi@0:                     if (outermostType.startsWith(acceptablePackage)) {
aoqi@0:                         isAcceptable = true;
aoqi@0:                         break;
aoqi@0:                     }
aoqi@0:                 }
aoqi@0:                 if (!isAcceptable) {
aoqi@0:                     error("Type not acceptable for this API: " + dt.toString());
aoqi@0:                 }
aoqi@0: 
aoqi@0:                 for (TypeMirror bound : dt.getTypeArguments()) {
aoqi@0:                     verifyTypeAcceptable(bound, acceptable);
aoqi@0:                 }
aoqi@0:                 break;
aoqi@0:             case ARRAY:
aoqi@0:                 verifyTypeAcceptable(((ArrayType) type).getComponentType(), acceptable);
aoqi@0:                 break;
aoqi@0:             case INTERSECTION:
aoqi@0:                 for (TypeMirror element : ((IntersectionType) type).getBounds()) {
aoqi@0:                     verifyTypeAcceptable(element, acceptable);
aoqi@0:                 }
aoqi@0:                 break;
aoqi@0:             case TYPEVAR:
aoqi@0:                 verifyTypeAcceptable(((TypeVariable) type).getLowerBound(), acceptable);
aoqi@0:                 verifyTypeAcceptable(((TypeVariable) type).getUpperBound(), acceptable);
aoqi@0:                 break;
aoqi@0:             case WILDCARD:
aoqi@0:                 verifyTypeAcceptable(((WildcardType) type).getExtendsBound(), acceptable);
aoqi@0:                 verifyTypeAcceptable(((WildcardType) type).getSuperBound(), acceptable);
aoqi@0:                 break;
aoqi@0:             default:
aoqi@0:                 error("Type not acceptable for this API: " + type.toString());
aoqi@0:                 break;
aoqi@0: 
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     private TypeElement outermostTypeElement(Element el) {
aoqi@0:         while (el.getEnclosingElement().getKind() != ElementKind.PACKAGE) {
aoqi@0:             el = el.getEnclosingElement();
aoqi@0:         }
aoqi@0: 
aoqi@0:         return (TypeElement) el;
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void error(String text) {
aoqi@0:         processingEnv.getMessager().printMessage(Kind.ERROR, text);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void note(String text) {
aoqi@0:         processingEnv.getMessager().printMessage(Kind.NOTE, text);
aoqi@0:     }
aoqi@0: }