* Copyright (c) 2005, 2010 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

*    

*******************************************************************************/

* Contains the tag library information for a single project.

*

*  * <p>

* This class is neither intended to be instantiated nor accessed by clients.

* </p>

*

*/

  class BuildPathJob extends Job {

    public BuildPathJob() {

      super("Updating Tag Library Index");

      setSystem(true);

      setUser(false);

    }

    protected IStatus run(IProgressMonitor monitor) {

      try {

        LOCK.acquire();

        PackageFragmentRootDelta[] removes = (PackageFragmentRootDelta[]) fPackageFragmentRootsRemoved.values().toArray(new PackageFragmentRootDelta[fPackageFragmentRootsRemoved.size()]);

        for (int i = 0; i < removes.length; i++) {

          handleElementChanged(removes[i].elementPath, removes[i].deltaKind, removes[i].isExported);

        }

        fPackageFragmentRootsRemoved.clear();

        if (monitor.isCanceled())

          return Status.OK_STATUS;

       

        PackageFragmentRootDelta[] changes = (PackageFragmentRootDelta[]) fPackageFragmentRootsChanged.values().toArray(new PackageFragmentRootDelta[fPackageFragmentRootsChanged.size()]);

        for (int i = 0; i < changes.length; i++) {

          handleElementChanged(changes[i].elementPath, changes[i].deltaKind, changes[i].isExported);

        }

        fPackageFragmentRootsChanged.clear();

        if (monitor.isCanceled())

          return Status.OK_STATUS;

       

        PackageFragmentRootDelta[] adds = (PackageFragmentRootDelta[]) fPackageFragmentRootsAdded.values().toArray(new PackageFragmentRootDelta[fPackageFragmentRootsAdded.size()]);

        for (int i = 0; i < adds.length; i++) {

          handleElementChanged(adds[i].elementPath, adds[i].deltaKind, adds[i].isExported);

        }

        fPackageFragmentRootsAdded.clear();

      }

      finally {

        LOCK.release();

      }

      TaglibIndex.getInstance().fireCurrentDelta(BuildPathJob.this);

      return Status.OK_STATUS;

    }

  }

 

  class PackageFragmentRootDelta {

    PackageFragmentRootDelta(IPath path, int kind, boolean exported) {

      super();

      elementPath = path;

      deltaKind = kind;

      isExported = exported;

    }

    /*

      IJavaElementDelta.F_ADDED_TO_CLASSPATH

      IJavaElementDelta.F_ARCHIVE_CONTENT_CHANGED

      IJavaElementDelta.F_REMOVED_FROM_CLASSPATH

    */

    int deltaKind;

    IPath elementPath;

    boolean isExported;

  }

  class DeltaVisitor implements IResourceDeltaVisitor {

    public boolean visit(IResourceDelta delta) throws CoreException {

      IResource resource = delta.getResource();

      if (resource.getType() == IResource.FILE) {

        if (delta.getKind() == IResourceDelta.CHANGED && (delta.getFlags() == IResourceDelta.ENCODING || delta.getFlags() == IResourceDelta.MARKERS))

          return true;

        if (resource.getName().endsWith(".tld")) { //$NON-NLS-1$

          if (delta.getKind() == IResourceDelta.REMOVED) {

            removeTLD(resource);

          }

          else {

            updateTLD(resource, delta.getKind());

          }

        }

        else if (resource.getName().endsWith(".jar")) { //$NON-NLS-1$

          if (delta.getKind() == IResourceDelta.REMOVED) {

            removeJAR(resource);

          }

          else {

            updateJAR(resource, delta.getKind());

          }

        }

        else if ("tag".equalsIgnoreCase(resource.getFileExtension()) || "tagx".equalsIgnoreCase(resource.getFileExtension())) { //$NON-NLS-1$ //$NON-NLS-2$

          if (delta.getKind() == IResourceDelta.REMOVED) {

            removeTag(resource);

          }

          else {

            updateTag(resource, delta.getKind());

          }

        }

        else if (resource.getName().equals(WEB_XML) && resource.getParent().getName().equals(WEB_INF)) {

          if (delta.getKind() == IResourceDelta.REMOVED) {

            removeWebXML(resource);

          }

          else {

            updateWebXML(resource, delta.getKind());

          }

        }

      }

      return resource.getName().length() != 0 && resource.getName().charAt(0) != '.';

    }

  }

  class Indexer implements IResourceProxyVisitor {

    public boolean visit(IResourceProxy proxy) throws CoreException {

      boolean visitMembers = true;

      if (proxy.getType() == IResource.FILE) {

        if (proxy.getName().endsWith(".tld")) { //$NON-NLS-1$

          updateTLD(proxy.requestResource(), ITaglibIndexDelta.ADDED);

        }

        else if (proxy.getName().endsWith(".jar")) { //$NON-NLS-1$

          updateJAR(proxy.requestResource(), ITaglibIndexDelta.ADDED);

        }

        else if (proxy.getName().endsWith(".tag") || proxy.getName().endsWith(".tagx")) { //$NON-NLS-1$ //$NON-NLS-2$

          updateTagDir(proxy.requestResource().getParent(), ITaglibIndexDelta.ADDED);

          // any folder with these files will create a record for

          // that folder in one pass

          visitMembers = false;

        }

        else if (proxy.getName().equals(WEB_XML) && proxy.requestResource().getParent().getName().equals(WEB_INF)) {

          updateWebXML(proxy.requestResource(), ITaglibIndexDelta.ADDED);

        }

      }

      String name = proxy.getName();

      return name.length() != 0 && name.charAt(0) != '.' && visitMembers;

    }

  }

  static class JarRecord implements IJarRecord {

    boolean has11TLD;

    TaglibInfo info;

    boolean isExported = true;

    boolean isMappedInWebXML;

    boolean isConsistent = false;

    IPath location;

    List urlRecords;

    public boolean equals(Object obj) {

      if (!(obj instanceof JarRecord))

        return false;

      return ((JarRecord) obj).location.equals(location) && ((JarRecord) obj).has11TLD == has11TLD && ((JarRecord) obj).info.equals(info);

    }

    public ITaglibDescriptor getDescriptor() {

      return info != null ? info : new TaglibInfo();

    }

    /**

     * @return Returns the location.

     */

    public IPath getLocation() {

      return location;

    }

    public int getRecordType() {

      return ITaglibRecord.JAR;

    }

    /**

     * @return Returns the recommended/default prefix if one was given.

     */

    public String getShortName() {

      if (info == null)

        return null;

      return info.shortName;

    }

    /**

     * @return Returns the uri.

     */

    public String getURI() {

      if (info == null)

        return null;

      return info.uri;

    }

    public List getURLRecords() {

      return urlRecords;

    }

    public String toString() {

      StringBuffer s = new StringBuffer("JarRecord: ");//$NON-NLS-1$

      s.append(location);

      if (urlRecords.size() > 0) {

        s.append('\n');//$NON-NLS-1$

        for (int i = 0; i < urlRecords.size(); i++) {

          s.append(urlRecords.get(i));

          s.append('\n');//$NON-NLS-1$

        }

      }

      return s.toString();

    }

  }

  static class TagDirRecord implements ITagDirRecord {

    TaglibInfo info;

    IPath path;

    // a List holding Strings of .tag and .tagx filenames relative to the

    // tagdir's location

    List tags = new ArrayList(0);

    public boolean equals(Object obj) {

      if (!(obj instanceof TagDirRecord))

        return false;

      return ((TagDirRecord) obj).path.equals(path) && ((TagDirRecord) obj).info.equals(info);

    }

    public ITaglibDescriptor getDescriptor() {

      return info != null ? info : (info = new TaglibInfo());

    }

    /*

     * (non-Javadoc)

     *

     * @see org.eclipse.jst.jsp.core.taglib.ITagDirRecord#getPath()

     */

    public IPath getPath() {

      return path;

    }

    public int getRecordType() {

      return ITaglibRecord.TAGDIR;

    }

    /**

     * @return Returns the tags.

     */

    public String[] getTagFilenames() {

      return (String[]) tags.toArray(new String[tags.size()]);

    }

    public String toString() {

      return "TagdirRecord: " + path + " <-> " + info.shortName; //$NON-NLS-1$ //$NON-NLS-2$

    }

  }

  /**

   * A brief representation of the information in a TLD.

   */

  static class TaglibInfo implements ITaglibDescriptor {

    // extract only when asked?

    String description = "";

    String displayName = "";

    String jspVersion = "";

    String largeIcon = "";

    String shortName = "";

    String smallIcon = "";

    String tlibVersion = "";

    String uri = "";

    public TaglibInfo() {

      super();

    }

    public boolean equals(Object obj) {

      if (!(obj instanceof TaglibInfo))

        return false;

      return ((TaglibInfo) obj).jspVersion == jspVersion && ((TaglibInfo) obj).description.equals(description) && ((TaglibInfo) obj).largeIcon.equals(largeIcon) && ((TaglibInfo) obj).shortName.equals(shortName) && ((TaglibInfo) obj).smallIcon.equals(smallIcon) && ((TaglibInfo) obj).tlibVersion.equals(tlibVersion) && ((TaglibInfo) obj).uri.equals(uri);

    }

    public String getDescription() {

      return description;

    }

    public String getDisplayName() {

      return displayName;

    }

    public String getJSPVersion() {

      return jspVersion;

    }

    public String getLargeIcon() {

      return largeIcon;

    }

    public String getShortName() {

      return shortName;

    }

    public String getSmallIcon() {

      return smallIcon;

    }

    public String getTlibVersion() {

      return tlibVersion;

    }

    public String getURI() {

      return uri;

    }

    public String toString() {

      return "TaglibInfo|" + uri + "|" + shortName + "|" + tlibVersion + "|" + smallIcon + "|" + largeIcon + "|" + jspVersion + "|" + description; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$

    }

  }

  static class TLDRecord implements ITLDRecord {

    TaglibInfo info;

    IPath path;

    public boolean equals(Object obj) {

      if (!(obj instanceof TLDRecord))

        return false;

      return ((TLDRecord) obj).path.equals(path) && ((TLDRecord) obj).getURI().equals(getURI()) && ((TLDRecord) obj).info.equals(info);

    }

    public ITaglibDescriptor getDescriptor() {

      return info != null ? info : new TaglibInfo();

    }

    public IPath getPath() {

      return path;

    }

    public int getRecordType() {

      return ITaglibRecord.TLD;

    }

    public String getShortName() {

      if (info == null)

        return null;

      return info.shortName;

    }

    /**

     * @return Returns the uri.

     */

    public String getURI() {

      if (info == null)

        return null;

      return info.uri;

    }

    public String toString() {

      return "TLDRecord: " + getURI() + " <-> " + path; //$NON-NLS-1$ //$NON-NLS-2$

    }

  }

  static class URLRecord implements IURLRecord {

    String baseLocation;

    TaglibInfo info;

    boolean isExported = true;

    URL url;

    public URLRecord() {

      super();

    }

    public boolean equals(Object obj) {

      if (!(obj instanceof URLRecord))

        return false;

      return ((URLRecord) obj).baseLocation.equals(baseLocation) && ((URLRecord) obj).url.equals(url) && ((URLRecord) obj).info.equals(info);

    }

    public String getBaseLocation() {

      return baseLocation;

    }

    public ITaglibDescriptor getDescriptor() {

      return info != null ? info : new TaglibInfo();

    }

    public int getRecordType() {

      return ITaglibRecord.URL;

    }

    /**

     * @return Returns the recommended/default prefix if one was given.

     */

    public String getShortName() {

      if (info == null)

        return null;

      return info.shortName;

    }

    /**

     * @return Returns the uri.

     */

    public String getURI() {

      if (info == null)

        return ""; //$NON-NLS-1$

      return info.uri;

    }

    /**

     * @return Returns the URL.

     */

    public URL getURL() {

      return url;

    }

    public String toString() {

      return "URLRecord: (exported=" + isExported + ") " + baseLocation + " <-> " + getURI(); //$NON-NLS-1$ //$NON-NLS-2$

    }

  }

  static class WebXMLRecord {

    TaglibInfo info;

    IPath path;

    List tldRecords = new ArrayList(0);

    public boolean equals(Object obj) {

      if (!(obj instanceof WebXMLRecord))

        return false;

      return ((WebXMLRecord) obj).path.equals(path) && ((WebXMLRecord) obj).info.equals(info);

    }

    /**

     * @return Returns the recommended/default prefix if one was given.

     */

    public String getPrefix() {

      if (info == null)

        return null;

      return info.shortName;

    }

    /**

     *

     */

    public List getTLDRecords() {

      return tldRecords;

    }

    /**

     * @return Returns the webxml.

     */

    public IPath getWebXML() {

      return path;

    }

    public String toString() {

      StringBuffer s = new StringBuffer("WebXMLRecord: ");//$NON-NLS-1$

      s.append(path);

      if (tldRecords.size() > 0) {

        s.append('\n');//$NON-NLS-1$

        for (int i = 0; i < tldRecords.size(); i++) {

          s.append(tldRecords.get(i));

          s.append('\n');//$NON-NLS-1$

        }

      }

      return s.toString();

    }

  }

 

  private class TaglibSorter extends Sorter {

    Collator collator = Collator.getInstance();

    public boolean compare(Object elementOne, Object elementTwo) {

      /**

       * Returns true if elementTwo is 'greater than' elementOne This is

       * the 'ordering' method of the sort operation. Each subclass

       * overides this method with the particular implementation of the

       * 'greater than' concept for the objects being sorted.

       */

     

      return (collator.compare(getTaglibPath((ITaglibRecord) elementOne), getTaglibPath((ITaglibRecord) elementTwo))) < 0;

    }

   

    private String getTaglibPath(ITaglibRecord record) {

      switch(record.getRecordType()) {

        case ITaglibRecord.JAR:

          return ((JarRecord) record).getLocation().toString();

        case ITaglibRecord.TAGDIR:

          return ((TagDirRecord) record).getPath().toString();

        case ITaglibRecord.TLD:

          return ((TLDRecord) record).getPath().toString();

        case ITaglibRecord.URL:

          return ((URLRecord) record).getBaseLocation();

        default:

          return ""; //$NON-NLS-1$

      }

    }

  }

  static boolean _debugIndexCreation = "true".equalsIgnoreCase(Platform.getDebugOption("org.eclipse.jst.jsp.core/taglib/indexcreation")); //$NON-NLS-1$ //$NON-NLS-2$

  static boolean _debugIndexTime = "true".equalsIgnoreCase(Platform.getDebugOption("org.eclipse.jst.jsp.core/taglib/indextime")); //$NON-NLS-1$ //$NON-NLS-2$

  private static final String BUILDPATH_DIRTY = "BUILDPATH_DIRTY"; //$NON-NLS-1$

  private static final String BUILDPATH_ENTRIES = "BUILDPATH_ENTRIES"; //$NON-NLS-1$

  private static final String BUILDPATH_PROJECT = "BUILDPATH_PROJECT"; //$NON-NLS-1$

  private static final String SAVE_FORMAT_VERSION = "Tag Library Index 1.1.0"; //$NON-NLS-1$

  private static final String WEB_INF = "WEB-INF"; //$NON-NLS-1$

  private static final IPath WEB_INF_PATH = new Path(WEB_INF);

  private static final String WEB_XML = "web.xml"; //$NON-NLS-1$

  private static final char[] TLD = { 't', 'T', 'l', 'L', 'd', 'D'} ;

  /**

   * Notes that the build path information is stale. Some operations can now

   * be skipped until a resolve/getAvailable call is made.

   */

  boolean fBuildPathIsDirty = false;

  /**

   * Count of entries on the build path. Primary use case is for classpath

   * containers that add an entry. Without notification (3.3), we can only

   * check after-the-fact.

   */

  int fBuildPathEntryCount = 0;

  /**

   * A cached copy of all of the records createable from the XMLCatalog.

   */

  private Collection fCatalogRecords;

  /*

   * Records active JARs on the classpath. Taglib descriptors should be

   * usable, but the jars by themselves are not.

   */

  Hashtable fClasspathJars;

  /**

   * A set of the projects that are in this project's build path.

   * Lookups/enumerations will be redirected to the corresponding

   * ProjectDescription instances

   */

  Set fClasspathProjects = null;

  // holds references by URI to JARs

  Hashtable fClasspathReferences;

  /*

   * this table is special in that it holds tables of references according

   * to local roots

   */

  Hashtable fImplicitReferences;

  Hashtable fJARReferences;

  IProject fProject;

  private String fSaveStateFilename;

  Hashtable fTagDirReferences;

  Hashtable fTLDReferences;

  IResourceDeltaVisitor fVisitor;

  Hashtable fWebXMLReferences;

 

  private Map fPackageFragmentRootsAdded = new HashMap();

  private Map fPackageFragmentRootsChanged = new HashMap();

  private Map fPackageFragmentRootsRemoved = new HashMap();

  ILock LOCK = Job.getJobManager().newLock();

  private long time0;

 

  private TaglibSorter fTaglibSorter = new TaglibSorter();

  private BuildPathJob fBuildPathJob = new BuildPathJob();

  /** Shared JAR records between projects */

  private static final Map fJarRecords = new Hashtable();

  ProjectDescription(IProject project, String saveStateFile) {

    super();

    fProject = project;

    fSaveStateFilename = saveStateFile;

    fClasspathJars = new Hashtable(0);

    fJARReferences = new Hashtable(0);

    fTagDirReferences = new Hashtable(0);

    fTLDReferences = new Hashtable(0);

    fWebXMLReferences = new Hashtable(0);

    fImplicitReferences = new Hashtable(0);

    fClasspathReferences = new Hashtable(0);

    fClasspathProjects = new HashSet();

    restoreReferences();

  }

  private Collection _getJSP11AndWebXMLJarReferences(Collection allJARs) {

    List collection = new ArrayList(allJARs.size());

    Iterator i = allJARs.iterator();

    while (i.hasNext()) {

      JarRecord record = (JarRecord) i.next();

      if (record.has11TLD || record.isMappedInWebXML) {

        collection.add(record);

      }

    }

    return collection;

  }

  /**

   * Adds the list of known references from this project's build path to the

   * map, appending any processed projects into the list to avoid

   * build-path-cycles.

   *

   * @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=142408

   *

   * @param references -

   *            the map of references to ITaglibRecords

   * @param projectsProcessed -

   *            the list of projects already considered

   * @param exportedOnly -

   *            Whether to only add references derived from exported build

   *            path containers. This method calls itself recursively with

   *            this parameter as false.

   */

  void addBuildPathReferences(Map references, List projectsProcessed, boolean exportedOnly) {

    ensureUpTodate();

    // Add the build path references that are exported from this project

    Enumeration keys = fClasspathReferences.keys();

    while (keys.hasMoreElements()) {

      Object key = keys.nextElement();

      URLRecord urlRecord = (URLRecord) fClasspathReferences.get(key);

      if (exportedOnly) {

        if (urlRecord.isExported) {

          references.put(key, urlRecord);

        }

      }

      else {

        references.put(key, urlRecord);