| /******************************************************************************* |
| * Copyright (c) 2000, 2016 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 |
| * Tal Lev-Ami - added package cache for zip files |
| * Stephan Herrmann - Contribution for |
| * Bug 440477 - [null] Infrastructure for feeding external annotations into compilation |
| *******************************************************************************/ |
| package org.eclipse.jdt.internal.core.builder; |
| |
| import java.io.File; |
| import java.io.IOException; |
| import java.util.Date; |
| import java.util.Enumeration; |
| import java.util.zip.ZipEntry; |
| import java.util.zip.ZipFile; |
| |
| import org.eclipse.core.resources.IFile; |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.core.runtime.IPath; |
| 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.env.AccessRuleSet; |
| import org.eclipse.jdt.internal.compiler.env.IBinaryType; |
| import org.eclipse.jdt.internal.compiler.env.NameEnvironmentAnswer; |
| import org.eclipse.jdt.internal.compiler.util.SimpleLookupTable; |
| import org.eclipse.jdt.internal.compiler.util.SimpleSet; |
| import org.eclipse.jdt.internal.compiler.util.SuffixConstants; |
| import org.eclipse.jdt.internal.core.util.Util; |
| |
| @SuppressWarnings("rawtypes") |
| public class ClasspathJar extends ClasspathLocation { |
| |
| static class PackageCacheEntry { |
| long lastModified; |
| long fileSize; |
| SimpleSet packageSet; |
| |
| PackageCacheEntry(long lastModified, long fileSize, SimpleSet packageSet) { |
| this.lastModified = lastModified; |
| this.fileSize = fileSize; |
| this.packageSet = packageSet; |
| } |
| } |
| |
| static SimpleLookupTable PackageCache = new SimpleLookupTable(); |
| |
| /** |
| * Calculate and cache the package list available in the zipFile. |
| * @param jar The ClasspathJar to use |
| * @return A SimpleSet with the all the package names in the zipFile. |
| */ |
| static SimpleSet findPackageSet(ClasspathJar jar) { |
| String zipFileName = jar.zipFilename; |
| long lastModified = jar.lastModified(); |
| long fileSize = new File(zipFileName).length(); |
| PackageCacheEntry cacheEntry = (PackageCacheEntry) PackageCache.get(zipFileName); |
| if (cacheEntry != null && cacheEntry.lastModified == lastModified && cacheEntry.fileSize == fileSize) |
| return cacheEntry.packageSet; |
| |
| SimpleSet packageSet = new SimpleSet(41); |
| packageSet.add(""); //$NON-NLS-1$ |
| nextEntry : for (Enumeration e = jar.zipFile.entries(); e.hasMoreElements(); ) { |
| String fileName = ((ZipEntry) e.nextElement()).getName(); |
| |
| // add the package name & all of its parent packages |
| int last = fileName.lastIndexOf('/'); |
| while (last > 0) { |
| // extract the package name |
| String packageName = fileName.substring(0, last); |
| if (packageSet.addIfNotIncluded(packageName) == null) |
| continue nextEntry; // already existed |
| last = packageName.lastIndexOf('/'); |
| } |
| } |
| |
| PackageCache.put(zipFileName, new PackageCacheEntry(lastModified, fileSize, packageSet)); |
| return packageSet; |
| } |
| |
| |
| String zipFilename; // keep for equals |
| IFile resource; |
| ZipFile zipFile; |
| ZipFile annotationZipFile; |
| long lastModified; |
| boolean closeZipFileAtEnd; |
| SimpleSet knownPackageNames; |
| AccessRuleSet accessRuleSet; |
| String externalAnnotationPath; |
| |
| ClasspathJar(IFile resource, AccessRuleSet accessRuleSet, IPath externalAnnotationPath) { |
| this.resource = resource; |
| try { |
| java.net.URI location = resource.getLocationURI(); |
| if (location == null) { |
| this.zipFilename = ""; //$NON-NLS-1$ |
| } else { |
| File localFile = Util.toLocalFile(location, null); |
| this.zipFilename = localFile.getPath(); |
| } |
| } catch (CoreException e) { |
| // ignore |
| } |
| this.zipFile = null; |
| this.knownPackageNames = null; |
| this.accessRuleSet = accessRuleSet; |
| if (externalAnnotationPath != null) |
| this.externalAnnotationPath = externalAnnotationPath.toString(); |
| } |
| |
| ClasspathJar(String zipFilename, long lastModified, AccessRuleSet accessRuleSet, IPath externalAnnotationPath) { |
| this.zipFilename = zipFilename; |
| this.lastModified = lastModified; |
| this.zipFile = null; |
| this.knownPackageNames = null; |
| this.accessRuleSet = accessRuleSet; |
| if (externalAnnotationPath != null) |
| this.externalAnnotationPath = externalAnnotationPath.toString(); |
| } |
| |
| public ClasspathJar(ZipFile zipFile, AccessRuleSet accessRuleSet, IPath externalAnnotationPath) { |
| this.zipFilename = zipFile.getName(); |
| this.zipFile = zipFile; |
| this.closeZipFileAtEnd = false; |
| this.knownPackageNames = null; |
| this.accessRuleSet = accessRuleSet; |
| if (externalAnnotationPath != null) |
| this.externalAnnotationPath = externalAnnotationPath.toString(); |
| } |
| |
| public void cleanup() { |
| if (this.closeZipFileAtEnd) { |
| if (this.zipFile != null) { |
| try { |
| this.zipFile.close(); |
| } catch(IOException e) { // ignore it |
| } |
| this.zipFile = null; |
| } |
| if (this.annotationZipFile != null) { |
| try { |
| this.annotationZipFile.close(); |
| } catch(IOException e) { // ignore it |
| } |
| this.annotationZipFile = null; |
| } |
| } |
| this.knownPackageNames = null; |
| } |
| |
| public boolean equals(Object o) { |
| if (this == o) return true; |
| if (!(o instanceof ClasspathJar)) return false; |
| |
| ClasspathJar jar = (ClasspathJar) o; |
| if (this.accessRuleSet != jar.accessRuleSet) |
| if (this.accessRuleSet == null || !this.accessRuleSet.equals(jar.accessRuleSet)) |
| return false; |
| return this.zipFilename.equals(jar.zipFilename) && lastModified() == jar.lastModified(); |
| } |
| |
| public NameEnvironmentAnswer findClass(String binaryFileName, String qualifiedPackageName, String qualifiedBinaryFileName) { |
| if (!isPackage(qualifiedPackageName)) return null; // most common case |
| |
| try { |
| IBinaryType reader = ClassFileReader.read(this.zipFile, qualifiedBinaryFileName); |
| if (reader != null) { |
| String fileNameWithoutExtension = qualifiedBinaryFileName.substring(0, qualifiedBinaryFileName.length() - SuffixConstants.SUFFIX_CLASS.length); |
| if (this.externalAnnotationPath != null) { |
| try { |
| if (this.annotationZipFile == null) { |
| this.annotationZipFile = ExternalAnnotationDecorator |
| .getAnnotationZipFile(this.externalAnnotationPath, null); |
| } |
| |
| reader = ExternalAnnotationDecorator.create(reader, this.externalAnnotationPath, |
| fileNameWithoutExtension, this.annotationZipFile); |
| } catch (IOException e) { |
| // don't let error on annotations fail class reading |
| } |
| } |
| if (this.accessRuleSet == null) |
| return new NameEnvironmentAnswer(reader, null); |
| return new NameEnvironmentAnswer(reader, this.accessRuleSet.getViolatedRestriction(fileNameWithoutExtension.toCharArray())); |
| } |
| } catch (IOException e) { // treat as if class file is missing |
| } catch (ClassFormatException e) { // treat as if class file is missing |
| } |
| return null; |
| } |
| |
| public IPath getProjectRelativePath() { |
| if (this.resource == null) return null; |
| return this.resource.getProjectRelativePath(); |
| } |
| |
| public int hashCode() { |
| return this.zipFilename == null ? super.hashCode() : this.zipFilename.hashCode(); |
| } |
| |
| public boolean isPackage(String qualifiedPackageName) { |
| if (this.knownPackageNames != null) |
| return this.knownPackageNames.includes(qualifiedPackageName); |
| |
| try { |
| if (this.zipFile == null) { |
| if (org.eclipse.jdt.internal.core.JavaModelManager.ZIP_ACCESS_VERBOSE) { |
| System.out.println("(" + Thread.currentThread() + ") [ClasspathJar.isPackage(String)] Creating ZipFile on " + this.zipFilename); //$NON-NLS-1$ //$NON-NLS-2$ |
| } |
| this.zipFile = new ZipFile(this.zipFilename); |
| this.closeZipFileAtEnd = true; |
| } |
| this.knownPackageNames = findPackageSet(this); |
| } catch(Exception e) { |
| this.knownPackageNames = new SimpleSet(); // assume for this build the zipFile is empty |
| } |
| return this.knownPackageNames.includes(qualifiedPackageName); |
| } |
| |
| public long lastModified() { |
| if (this.lastModified == 0) |
| this.lastModified = new File(this.zipFilename).lastModified(); |
| return this.lastModified; |
| } |
| |
| public String toString() { |
| String start = "Classpath jar file " + this.zipFilename; //$NON-NLS-1$ |
| if (this.accessRuleSet == null) |
| return start; |
| return start + " with " + this.accessRuleSet; //$NON-NLS-1$ |
| } |
| |
| public String debugPathString() { |
| long time = lastModified(); |
| if (time == 0) |
| return this.zipFilename; |
| return this.zipFilename + '(' + (new Date(time)) + " : " + time + ')'; //$NON-NLS-1$ |
| } |
| |
| } |