| /******************************************************************************* |
| * Copyright (c) 2000, 2018 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| * Stephan Herrmann - Contribution for |
| * Bug 440477 - [null] Infrastructure for feeding external annotations into compilation |
| * Bug 440687 - [compiler][batch][null] improve command line option for external annotations |
| *******************************************************************************/ |
| package org.eclipse.jdt.internal.compiler.batch; |
| |
| import java.io.File; |
| import java.io.IOException; |
| import java.io.InputStream; |
| import java.util.ArrayList; |
| import java.util.Enumeration; |
| import java.util.HashSet; |
| import java.util.Iterator; |
| import java.util.List; |
| import java.util.Set; |
| import java.util.jar.Manifest; |
| import java.util.zip.ZipEntry; |
| import java.util.zip.ZipFile; |
| |
| import org.eclipse.jdt.core.compiler.CharOperation; |
| import org.eclipse.jdt.internal.compiler.batch.FileSystem.Classpath; |
| import org.eclipse.jdt.internal.compiler.classfmt.ClassFileReader; |
| import org.eclipse.jdt.internal.compiler.classfmt.ClassFormatException; |
| import org.eclipse.jdt.internal.compiler.classfmt.ExternalAnnotationDecorator; |
| import org.eclipse.jdt.internal.compiler.classfmt.ExternalAnnotationProvider; |
| import org.eclipse.jdt.internal.compiler.env.AccessRuleSet; |
| import org.eclipse.jdt.internal.compiler.env.IModule; |
| import org.eclipse.jdt.internal.compiler.env.NameEnvironmentAnswer; |
| import org.eclipse.jdt.internal.compiler.env.IBinaryType; |
| import org.eclipse.jdt.internal.compiler.lookup.TypeConstants; |
| import org.eclipse.jdt.internal.compiler.lookup.BinaryTypeBinding.ExternalAnnotationStatus; |
| import org.eclipse.jdt.internal.compiler.util.ManifestAnalyzer; |
| import org.eclipse.jdt.internal.compiler.util.SuffixConstants; |
| import org.eclipse.jdt.internal.compiler.util.Util; |
| |
| @SuppressWarnings({"rawtypes", "unchecked"}) |
| public class ClasspathJar extends ClasspathLocation { |
| |
| protected File file; |
| protected ZipFile zipFile; |
| protected ZipFile annotationZipFile; |
| protected boolean closeZipFileAtEnd; |
| protected Set<String> packageCache; |
| protected List<String> annotationPaths; |
| |
| public ClasspathJar(File file, boolean closeZipFileAtEnd, |
| AccessRuleSet accessRuleSet, String destinationPath) { |
| super(accessRuleSet, destinationPath); |
| this.file = file; |
| this.closeZipFileAtEnd = closeZipFileAtEnd; |
| } |
| |
| @Override |
| public List<Classpath> fetchLinkedJars(FileSystem.ClasspathSectionProblemReporter problemReporter) { |
| // expected to be called once only - if multiple calls desired, consider |
| // using a cache |
| InputStream inputStream = null; |
| try { |
| initialize(); |
| ArrayList<Classpath> result = new ArrayList<>(); |
| ZipEntry manifest = this.zipFile.getEntry(TypeConstants.META_INF_MANIFEST_MF); |
| if (manifest != null) { // non-null implies regular file |
| inputStream = this.zipFile.getInputStream(manifest); |
| ManifestAnalyzer analyzer = new ManifestAnalyzer(); |
| boolean success = analyzer.analyzeManifestContents(inputStream); |
| List calledFileNames = analyzer.getCalledFileNames(); |
| if (problemReporter != null) { |
| if (!success || analyzer.getClasspathSectionsCount() == 1 && calledFileNames == null) { |
| problemReporter.invalidClasspathSection(getPath()); |
| } else if (analyzer.getClasspathSectionsCount() > 1) { |
| problemReporter.multipleClasspathSections(getPath()); |
| } |
| } |
| if (calledFileNames != null) { |
| Iterator calledFilesIterator = calledFileNames.iterator(); |
| String directoryPath = getPath(); |
| int lastSeparator = directoryPath.lastIndexOf(File.separatorChar); |
| directoryPath = directoryPath.substring(0, lastSeparator + 1); // potentially empty (see bug 214731) |
| while (calledFilesIterator.hasNext()) { |
| result.add(new ClasspathJar(new File(directoryPath + (String) calledFilesIterator.next()), this.closeZipFileAtEnd, this.accessRuleSet, this.destinationPath)); |
| } |
| } |
| } |
| return result; |
| } catch (IOException | IllegalArgumentException e) { |
| // JRE 9 could throw an IAE if the path is incorrect. We are to ignore such |
| // linked jars |
| return null; |
| } finally { |
| if (inputStream != null) { |
| try { |
| inputStream.close(); |
| } catch (IOException e) { |
| // best effort |
| } |
| } |
| } |
| } |
| @Override |
| public NameEnvironmentAnswer findClass(char[] typeName, String qualifiedPackageName, String moduleName, String qualifiedBinaryFileName) { |
| return findClass(typeName, qualifiedPackageName, moduleName, qualifiedBinaryFileName, false); |
| } |
| @Override |
| public NameEnvironmentAnswer findClass(char[] typeName, String qualifiedPackageName, String moduleName, String qualifiedBinaryFileName, boolean asBinaryOnly) { |
| if (!isPackage(qualifiedPackageName, moduleName)) |
| return null; // most common case |
| |
| try { |
| IBinaryType reader = ClassFileReader.read(this.zipFile, qualifiedBinaryFileName); |
| if (reader != null) { |
| char[] modName = this.module == null ? null : this.module.name(); |
| if (reader instanceof ClassFileReader) { |
| ClassFileReader classReader = (ClassFileReader) reader; |
| if (classReader.moduleName == null) |
| classReader.moduleName = modName; |
| else |
| modName = classReader.moduleName; |
| } |
| searchPaths: |
| if (this.annotationPaths != null) { |
| String qualifiedClassName = qualifiedBinaryFileName.substring(0, qualifiedBinaryFileName.length()-SuffixConstants.EXTENSION_CLASS.length()-1); |
| for (String annotationPath : this.annotationPaths) { |
| try { |
| if (this.annotationZipFile == null) { |
| this.annotationZipFile = ExternalAnnotationDecorator.getAnnotationZipFile(annotationPath, null); |
| } |
| reader = ExternalAnnotationDecorator.create(reader, annotationPath, qualifiedClassName, this.annotationZipFile); |
| |
| if (reader.getExternalAnnotationStatus() == ExternalAnnotationStatus.TYPE_IS_ANNOTATED) { |
| break searchPaths; |
| } |
| } catch (IOException e) { |
| // don't let error on annotations fail class reading |
| } |
| } |
| // location is configured for external annotations, but no .eea found, decorate in order to answer NO_EEA_FILE: |
| reader = new ExternalAnnotationDecorator(reader, null); |
| } |
| return new NameEnvironmentAnswer(reader, fetchAccessRestriction(qualifiedBinaryFileName), modName); |
| } |
| } catch(ClassFormatException e) { |
| // treat as if class file is missing |
| } catch (IOException e) { |
| // treat as if class file is missing |
| } |
| return null; |
| } |
| @Override |
| public boolean hasAnnotationFileFor(String qualifiedTypeName) { |
| return this.zipFile.getEntry(qualifiedTypeName+ExternalAnnotationProvider.ANNOTATION_FILE_SUFFIX) != null; |
| } |
| @Override |
| public char[][][] findTypeNames(final String qualifiedPackageName, String moduleName) { |
| if (!isPackage(qualifiedPackageName, moduleName)) |
| return null; // most common case |
| final char[] packageArray = qualifiedPackageName.toCharArray(); |
| final ArrayList answers = new ArrayList(); |
| nextEntry : for (Enumeration e = this.zipFile.entries(); e.hasMoreElements(); ) { |
| String fileName = ((ZipEntry) e.nextElement()).getName(); |
| |
| // add the package name & all of its parent packages |
| int last = fileName.lastIndexOf('/'); |
| if (last > 0) { |
| // extract the package name |
| String packageName = fileName.substring(0, last); |
| if (!qualifiedPackageName.equals(packageName)) |
| continue nextEntry; |
| int indexOfDot = fileName.lastIndexOf('.'); |
| if (indexOfDot != -1) { |
| String typeName = fileName.substring(last + 1, indexOfDot); |
| answers.add( |
| CharOperation.arrayConcat( |
| CharOperation.splitOn('/', packageArray), |
| typeName.toCharArray())); |
| } |
| } |
| } |
| int size = answers.size(); |
| if (size != 0) { |
| char[][][] result = new char[size][][]; |
| answers.toArray(result); |
| return result; |
| } |
| return null; |
| } |
| |
| @Override |
| public void initialize() throws IOException { |
| if (this.zipFile == null) { |
| this.zipFile = new ZipFile(this.file); |
| } |
| } |
| void acceptModule(ClassFileReader reader) { |
| if (reader != null) { |
| acceptModule(reader.getModuleDeclaration()); |
| } |
| } |
| void acceptModule(byte[] content) { |
| if (content == null) |
| return; |
| ClassFileReader reader = null; |
| try { |
| reader = new ClassFileReader(content, IModule.MODULE_INFO_CLASS.toCharArray()); |
| } catch (ClassFormatException e) { |
| e.printStackTrace(); |
| } |
| if (reader != null && reader.getModuleDeclaration() != null) { |
| acceptModule(reader); |
| } |
| } |
| protected void addToPackageCache(String fileName, boolean endsWithSep) { |
| int last = endsWithSep ? fileName.length() : fileName.lastIndexOf('/'); |
| while (last > 0) { |
| // extract the package name |
| String packageName = fileName.substring(0, last); |
| if (this.packageCache.contains(packageName)) |
| return; |
| this.packageCache.add(packageName); |
| last = packageName.lastIndexOf('/'); |
| } |
| } |
| @Override |
| public synchronized char[][] getModulesDeclaringPackage(String qualifiedPackageName, String moduleName) { |
| if (this.packageCache != null) |
| return singletonModuleNameIf(this.packageCache.contains(qualifiedPackageName)); |
| |
| this.packageCache = new HashSet<>(41); |
| this.packageCache.add(Util.EMPTY_STRING); |
| |
| for (Enumeration e = this.zipFile.entries(); e.hasMoreElements(); ) { |
| String fileName = ((ZipEntry) e.nextElement()).getName(); |
| addToPackageCache(fileName, false); |
| } |
| return singletonModuleNameIf(this.packageCache.contains(qualifiedPackageName)); |
| } |
| @Override |
| public boolean hasCompilationUnit(String qualifiedPackageName, String moduleName) { |
| qualifiedPackageName += '/'; |
| for (Enumeration<? extends ZipEntry> e = this.zipFile.entries(); e.hasMoreElements(); ) { |
| String fileName = e.nextElement().getName(); |
| if (fileName.startsWith(qualifiedPackageName) && fileName.length() > qualifiedPackageName.length()) { |
| String tail = fileName.substring(qualifiedPackageName.length()); |
| if (tail.indexOf('/') != -1) |
| continue; |
| if (tail.toLowerCase().endsWith(SUFFIX_STRING_class)) |
| return true; |
| } |
| } |
| return false; |
| } |
| @Override |
| public void reset() { |
| super.reset(); |
| if (this.closeZipFileAtEnd) { |
| if (this.zipFile != null) { |
| try { |
| this.zipFile.close(); |
| } catch(IOException e) { |
| // ignore |
| } |
| this.zipFile = null; |
| } |
| if (this.annotationZipFile != null) { |
| try { |
| this.annotationZipFile.close(); |
| } catch(IOException e) { |
| // ignore |
| } |
| this.annotationZipFile = null; |
| } |
| } |
| this.packageCache = null; |
| this.annotationPaths = null; |
| } |
| @Override |
| public String toString() { |
| return "Classpath for jar file " + this.file.getPath(); //$NON-NLS-1$ |
| } |
| @Override |
| public char[] normalizedPath() { |
| if (this.normalizedPath == null) { |
| String path2 = this.getPath(); |
| char[] rawName = path2.toCharArray(); |
| if (File.separatorChar == '\\') { |
| CharOperation.replace(rawName, '\\', '/'); |
| } |
| this.normalizedPath = CharOperation.subarray(rawName, 0, CharOperation.lastIndexOf('.', rawName)); |
| } |
| return this.normalizedPath; |
| } |
| @Override |
| public String getPath() { |
| if (this.path == null) { |
| try { |
| this.path = this.file.getCanonicalPath(); |
| } catch (IOException e) { |
| // in case of error, simply return the absolute path |
| this.path = this.file.getAbsolutePath(); |
| } |
| } |
| return this.path; |
| } |
| @Override |
| public int getMode() { |
| return BINARY; |
| } |
| |
| @Override |
| public IModule getModule() { |
| if (this.isAutoModule && this.module == null) { |
| Manifest manifest = null; |
| try { |
| initialize(); |
| ZipEntry entry = this.zipFile.getEntry(TypeConstants.META_INF_MANIFEST_MF); |
| if (entry != null) |
| manifest = new Manifest(this.zipFile.getInputStream(entry)); |
| } catch (IOException e) { |
| // no usable manifest |
| } |
| return this.module = IModule.createAutomatic(this.file.getName(), true, manifest); |
| } |
| return this.module; |
| } |
| } |