| /******************************************************************************* |
| * Copyright (c) 2000, 2013 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 |
| *******************************************************************************/ |
| package org.eclipse.jdt.internal.core.search.indexing; |
| |
| import java.io.File; |
| import java.io.IOException; |
| import java.net.URI; |
| 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.core.runtime.IProgressMonitor; |
| import org.eclipse.core.runtime.Path; |
| import org.eclipse.jdt.core.compiler.InvalidInputException; |
| import org.eclipse.jdt.core.search.IJavaSearchScope; |
| import org.eclipse.jdt.core.search.SearchEngine; |
| import org.eclipse.jdt.core.search.SearchParticipant; |
| import org.eclipse.jdt.internal.compiler.classfmt.ClassFileConstants; |
| import org.eclipse.jdt.internal.compiler.parser.Scanner; |
| import org.eclipse.jdt.internal.compiler.parser.TerminalTokens; |
| import org.eclipse.jdt.internal.compiler.util.SimpleLookupTable; |
| import org.eclipse.jdt.internal.compiler.util.SuffixConstants; |
| import org.eclipse.jdt.internal.compiler.util.Util; |
| import org.eclipse.jdt.internal.core.JavaModelManager; |
| import org.eclipse.jdt.internal.core.index.Index; |
| import org.eclipse.jdt.internal.core.index.IndexLocation; |
| import org.eclipse.jdt.internal.core.search.JavaSearchDocument; |
| import org.eclipse.jdt.internal.core.search.processing.JobManager; |
| |
| @SuppressWarnings("rawtypes") |
| class AddJarFileToIndex extends IndexRequest { |
| |
| private static final char JAR_SEPARATOR = IJavaSearchScope.JAR_FILE_ENTRY_SEPARATOR.charAt(0); |
| IFile resource; |
| Scanner scanner; |
| private IndexLocation indexFileURL; |
| private final boolean forceIndexUpdate; |
| |
| public AddJarFileToIndex(IFile resource, IndexLocation indexFile, IndexManager manager) { |
| this(resource, indexFile, manager, false); |
| } |
| public AddJarFileToIndex(IFile resource, IndexLocation indexFile, IndexManager manager, final boolean updateIndex) { |
| super(resource.getFullPath(), manager); |
| this.resource = resource; |
| this.indexFileURL = indexFile; |
| this.forceIndexUpdate = updateIndex; |
| } |
| public AddJarFileToIndex(IPath jarPath, IndexLocation indexFile, IndexManager manager) { |
| this(jarPath, indexFile, manager, false); |
| } |
| public AddJarFileToIndex(IPath jarPath, IndexLocation indexFile, IndexManager manager, final boolean updateIndex) { |
| // external JAR scenario - no resource |
| super(jarPath, manager); |
| this.indexFileURL = indexFile; |
| this.forceIndexUpdate = updateIndex; |
| } |
| public boolean equals(Object o) { |
| if (o instanceof AddJarFileToIndex) { |
| if (this.resource != null) |
| return this.resource.equals(((AddJarFileToIndex) o).resource); |
| if (this.containerPath != null) |
| return this.containerPath.equals(((AddJarFileToIndex) o).containerPath); |
| } |
| return false; |
| } |
| public int hashCode() { |
| if (this.resource != null) |
| return this.resource.hashCode(); |
| if (this.containerPath != null) |
| return this.containerPath.hashCode(); |
| return -1; |
| } |
| public boolean execute(IProgressMonitor progressMonitor) { |
| |
| if (this.isCancelled || progressMonitor != null && progressMonitor.isCanceled()) return true; |
| |
| if (hasPreBuiltIndex()) { |
| boolean added = this.manager.addIndex(this.containerPath, this.indexFileURL); |
| if (added) return true; |
| this.indexFileURL = null; |
| } |
| |
| try { |
| // if index is already cached, then do not perform any check |
| // MUST reset the IndexManager if a jar file is changed |
| Index index = this.manager.getIndexForUpdate(this.containerPath, false, /*do not reuse index file*/ false /*do not create if none*/); |
| if (index != null) { |
| if (JobManager.VERBOSE) |
| org.eclipse.jdt.internal.core.util.Util.verbose("-> no indexing required (index already exists) for " + this.containerPath); //$NON-NLS-1$ |
| return true; |
| } |
| |
| index = this.manager.getIndexForUpdate(this.containerPath, true, /*reuse index file*/ true /*create if none*/); |
| if (index == null) { |
| if (JobManager.VERBOSE) |
| org.eclipse.jdt.internal.core.util.Util.verbose("-> index could not be created for " + this.containerPath); //$NON-NLS-1$ |
| return true; |
| } |
| ReadWriteMonitor monitor = index.monitor; |
| if (monitor == null) { |
| if (JobManager.VERBOSE) |
| org.eclipse.jdt.internal.core.util.Util.verbose("-> index for " + this.containerPath + " just got deleted"); //$NON-NLS-1$//$NON-NLS-2$ |
| return true; // index got deleted since acquired |
| } |
| index.separator = JAR_SEPARATOR; |
| ZipFile zip = null; |
| try { |
| // this path will be a relative path to the workspace in case the zipfile in the workspace otherwise it will be a path in the |
| // local file system |
| Path zipFilePath = null; |
| |
| monitor.enterWrite(); // ask permission to write |
| if (this.resource != null) { |
| URI location = this.resource.getLocationURI(); |
| if (location == null) return false; |
| if (JavaModelManager.ZIP_ACCESS_VERBOSE) |
| System.out.println("(" + Thread.currentThread() + ") [AddJarFileToIndex.execute()] Creating ZipFile on " + location.getPath()); //$NON-NLS-1$ //$NON-NLS-2$ |
| File file = null; |
| try { |
| file = org.eclipse.jdt.internal.core.util.Util.toLocalFile(location, progressMonitor); |
| } catch (CoreException e) { |
| if (JobManager.VERBOSE) { |
| org.eclipse.jdt.internal.core.util.Util.verbose("-> failed to index " + location.getPath() + " because of the following exception:"); //$NON-NLS-1$ //$NON-NLS-2$ |
| e.printStackTrace(); |
| } |
| } |
| if (file == null) { |
| if (JobManager.VERBOSE) |
| org.eclipse.jdt.internal.core.util.Util.verbose("-> failed to index " + location.getPath() + " because the file could not be fetched"); //$NON-NLS-1$ //$NON-NLS-2$ |
| return false; |
| } |
| zip = new ZipFile(file); |
| zipFilePath = (Path) this.resource.getFullPath().makeRelative(); |
| // absolute path relative to the workspace |
| } else { |
| if (JavaModelManager.ZIP_ACCESS_VERBOSE) |
| System.out.println("(" + Thread.currentThread() + ") [AddJarFileToIndex.execute()] Creating ZipFile on " + this.containerPath); //$NON-NLS-1$ //$NON-NLS-2$ |
| // external file -> it is ok to use toFile() |
| zip = new ZipFile(this.containerPath.toFile()); |
| zipFilePath = (Path) this.containerPath; |
| // path is already canonical since coming from a library classpath entry |
| } |
| |
| if (this.isCancelled) { |
| if (JobManager.VERBOSE) |
| org.eclipse.jdt.internal.core.util.Util.verbose("-> indexing of " + zip.getName() + " has been cancelled"); //$NON-NLS-1$ //$NON-NLS-2$ |
| return false; |
| } |
| |
| if (JobManager.VERBOSE) |
| org.eclipse.jdt.internal.core.util.Util.verbose("-> indexing " + zip.getName()); //$NON-NLS-1$ |
| long initialTime = System.currentTimeMillis(); |
| |
| String[] paths = index.queryDocumentNames(""); // all file names //$NON-NLS-1$ |
| if (paths != null) { |
| int max = paths.length; |
| /* check integrity of the existing index file |
| * if the length is equal to 0, we want to index the whole jar again |
| * If not, then we want to check that there is no missing entry, if |
| * one entry is missing then we recreate the index |
| */ |
| String EXISTS = "OK"; //$NON-NLS-1$ |
| String DELETED = "DELETED"; //$NON-NLS-1$ |
| SimpleLookupTable indexedFileNames = new SimpleLookupTable(max == 0 ? 33 : max + 11); |
| for (int i = 0; i < max; i++) |
| indexedFileNames.put(paths[i], DELETED); |
| for (Enumeration e = zip.entries(); e.hasMoreElements();) { |
| // iterate each entry to index it |
| ZipEntry ze = (ZipEntry) e.nextElement(); |
| String zipEntryName = ze.getName(); |
| if (Util.isClassFileName(zipEntryName) && isValidPackageNameForClass(zipEntryName)) |
| // the class file may not be there if the package name is not valid |
| indexedFileNames.put(zipEntryName, EXISTS); |
| } |
| boolean needToReindex = indexedFileNames.elementSize != max; // a new file was added |
| if (!needToReindex) { |
| Object[] valueTable = indexedFileNames.valueTable; |
| for (int i = 0, l = valueTable.length; i < l; i++) { |
| if (valueTable[i] == DELETED) { |
| needToReindex = true; // a file was deleted so re-index |
| break; |
| } |
| } |
| if (!needToReindex) { |
| if (JobManager.VERBOSE) |
| org.eclipse.jdt.internal.core.util.Util.verbose("-> no indexing required (index is consistent with library) for " //$NON-NLS-1$ |
| + zip.getName() + " (" //$NON-NLS-1$ |
| + (System.currentTimeMillis() - initialTime) + "ms)"); //$NON-NLS-1$ |
| this.manager.saveIndex(index); // to ensure its placed into the saved state |
| return true; |
| } |
| } |
| } |
| |
| // Index the jar for the first time or reindex the jar in case the previous index file has been corrupted |
| // index already existed: recreate it so that we forget about previous entries |
| SearchParticipant participant = SearchEngine.getDefaultSearchParticipant(); |
| if (!this.manager.resetIndex(this.containerPath)) { |
| // failed to recreate index, see 73330 |
| this.manager.removeIndex(this.containerPath); |
| return false; |
| } |
| index.separator = JAR_SEPARATOR; |
| IPath indexPath = null; |
| IndexLocation indexLocation; |
| if ((indexLocation = index.getIndexLocation()) != null) { |
| indexPath = new Path(indexLocation.getCanonicalFilePath()); |
| } |
| for (Enumeration e = zip.entries(); e.hasMoreElements();) { |
| if (this.isCancelled) { |
| if (JobManager.VERBOSE) |
| org.eclipse.jdt.internal.core.util.Util.verbose("-> indexing of " + zip.getName() + " has been cancelled"); //$NON-NLS-1$ //$NON-NLS-2$ |
| return false; |
| } |
| |
| // iterate each entry to index it |
| ZipEntry ze = (ZipEntry) e.nextElement(); |
| String zipEntryName = ze.getName(); |
| if (Util.isClassFileName(zipEntryName) && |
| isValidPackageNameForClass(zipEntryName)) { |
| // index only classes coming from valid packages - https://bugs.eclipse.org/bugs/show_bug.cgi?id=293861 |
| final byte[] classFileBytes = org.eclipse.jdt.internal.compiler.util.Util.getZipEntryByteContent(ze, zip); |
| JavaSearchDocument entryDocument = new JavaSearchDocument(ze, zipFilePath, classFileBytes, participant); |
| this.manager.indexDocument(entryDocument, participant, index, indexPath); |
| } |
| } |
| if(this.forceIndexUpdate) { |
| this.manager.savePreBuiltIndex(index); |
| } |
| else { |
| this.manager.saveIndex(index); |
| } |
| if (JobManager.VERBOSE) |
| org.eclipse.jdt.internal.core.util.Util.verbose("-> done indexing of " //$NON-NLS-1$ |
| + zip.getName() + " (" //$NON-NLS-1$ |
| + (System.currentTimeMillis() - initialTime) + "ms)"); //$NON-NLS-1$ |
| } finally { |
| if (zip != null) { |
| if (JavaModelManager.ZIP_ACCESS_VERBOSE) |
| System.out.println("(" + Thread.currentThread() + ") [AddJarFileToIndex.execute()] Closing ZipFile " + zip); //$NON-NLS-1$ //$NON-NLS-2$ |
| zip.close(); |
| } |
| monitor.exitWrite(); // free write lock |
| } |
| } catch (IOException e) { |
| if (JobManager.VERBOSE) { |
| org.eclipse.jdt.internal.core.util.Util.verbose("-> failed to index " + this.containerPath + " because of the following exception:"); //$NON-NLS-1$ //$NON-NLS-2$ |
| e.printStackTrace(); |
| } |
| this.manager.removeIndex(this.containerPath); |
| return false; |
| } |
| return true; |
| } |
| public String getJobFamily() { |
| if (this.resource != null) |
| return super.getJobFamily(); |
| return this.containerPath.toOSString(); // external jar |
| } |
| private boolean isIdentifier() throws InvalidInputException { |
| switch(this.scanner.scanIdentifier()) { |
| // assert and enum will not be recognized as java identifiers |
| // in 1.7 mode, which are in 1.3. |
| case TerminalTokens.TokenNameIdentifier: |
| case TerminalTokens.TokenNameassert: |
| case TerminalTokens.TokenNameenum: |
| return true; |
| default: |
| return false; |
| } |
| } |
| private boolean isValidPackageNameForClass(String className) { |
| char[] classNameArray = className.toCharArray(); |
| // use 1.7 as the source level as there are more valid identifiers in 1.7 mode |
| // https://bugs.eclipse.org/bugs/show_bug.cgi?id=376673 |
| if (this.scanner == null) |
| this.scanner = new Scanner(false /* comment */, true /* whitespace */, false /* nls */, |
| ClassFileConstants.JDK1_7/* sourceLevel */, null/* taskTag */, null/* taskPriorities */, true /* taskCaseSensitive */); |
| //{ObjectTeams: don't exclude OT keywords appearing as package names: |
| this.scanner.forceBaseIsIdentifier(); |
| this.scanner.parsePureJavaOnly = true; |
| this.scanner.parseOTJonly = false; |
| // SH} |
| this.scanner.setSource(classNameArray); |
| this.scanner.eofPosition = classNameArray.length - SuffixConstants.SUFFIX_CLASS.length; |
| try { |
| if (isIdentifier()) { |
| while (this.scanner.eofPosition > this.scanner.currentPosition) { |
| if (this.scanner.getNextChar() != '/' || this.scanner.eofPosition <= this.scanner.currentPosition) { |
| return false; |
| } |
| if (!isIdentifier()) return false; |
| } |
| return true; |
| } |
| } catch (InvalidInputException e) { |
| // invalid class name |
| } |
| return false; |
| } |
| protected Integer updatedIndexState() { |
| |
| Integer updateState = null; |
| if(hasPreBuiltIndex()) { |
| updateState = IndexManager.REUSE_STATE; |
| } |
| else { |
| updateState = IndexManager.REBUILDING_STATE; |
| } |
| return updateState; |
| } |
| public String toString() { |
| return "indexing " + this.containerPath.toString(); //$NON-NLS-1$ |
| } |
| |
| protected boolean hasPreBuiltIndex() { |
| return !this.forceIndexUpdate && (this.indexFileURL != null && this.indexFileURL.exists()); |
| } |
| } |