57455 Aggregated plugin search indexes

1 files changed, 163 insertions, 0 deletions

diff --git a/org.eclipse.help.base/src/org/eclipse/help/internal/search/PluginIndex.java b/org.eclipse.help.base/src/org/eclipse/help/internal/search/PluginIndex.java
new file mode 100644
index 000000000..a75586cd0
--- /dev/null
+++ b/org.eclipse.help.base/src/org/eclipse/help/internal/search/PluginIndex.java
@@ -0,0 +1,163 @@
+/*******************************************************************************
+ * Copyright (c) 2005 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.help.internal.search;
+
+import java.io.IOException;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.eclipse.core.runtime.IPath;
+import org.eclipse.core.runtime.Path;
+import org.eclipse.core.runtime.Platform;
+import org.eclipse.help.internal.base.HelpBasePlugin;
+import org.eclipse.help.internal.util.ResourceLocator;
+import org.osgi.framework.Bundle;
+
+public class PluginIndex {
+	private String pluginId;
+
+	/**
+	 * index path as defined in plugin.xml, e.g. "index"
+	 */
+	private String path;
+
+	private String locale;
+
+	/**
+	 * path prefixes where index is found e.g. "", "nl/en/US", "ws/gtk"
+	 */
+	private List indexIDs;
+
+	/**
+	 * resolved directory paths (Strings) corresponding to indexes at given
+	 * prefixes, e.g. //d/eclipse/...../os/linux/index,
+	 */
+	private List resolvedPaths;
+
+	public PluginIndex(String pluginId, String path, String locale) {
+		super();
+		this.pluginId = pluginId;
+		this.path = path;
+		this.locale = locale;
+	}
+
+	private void resolve() {
+		if (indexIDs != null) {
+			return;
+		}
+		indexIDs = new ArrayList();
+		resolvedPaths = new ArrayList();
+		Bundle bundle = Platform.getBundle(pluginId);
+		if (bundle == null) {
+			return;
+		}
+		ArrayList availablePrefixes = ResourceLocator.getPathPrefix(locale);
+		for (int i = 0; i < availablePrefixes.size(); i++) {
+			String prefix = (String) availablePrefixes.get(i);
+			IPath prefixedPath = new Path(prefix + path);
+			// find index at this directory in plugin or fragments
+			URL url = Platform.find(bundle, prefixedPath);
+			if (url == null) {
+				continue;
+			}
+			URL resolved;
+			try {
+				resolved = Platform.resolve(url);
+			} catch (IOException ioe) {
+				HelpBasePlugin.logError("Help index directory at " //$NON-NLS-1$
+						+ prefixedPath + " for plugin " //$NON-NLS-1$
+						+ bundle.getSymbolicName() + " cannot be resolved.", //$NON-NLS-1$
+						ioe);
+				continue;
+			}
+			if ("file".equals(resolved.getProtocol())) { //$NON-NLS-1$
+				indexIDs.add(getIndexId(prefix));
+				resolvedPaths.add(resolved.getFile());
+			} else {
+				try {
+					// extract index from jarred bundles
+					URL localURL = Platform.asLocalURL(url);
+					if ("file".equals(localURL.getProtocol())) { //$NON-NLS-1$
+						indexIDs.add(getIndexId(prefix));
+						resolvedPaths.add(localURL.getFile());
+					}
+				} catch (IOException ioe) {
+					HelpBasePlugin.logError(
+							"Help index directory at " + prefixedPath //$NON-NLS-1$
+									+ " for plugin " + bundle.getSymbolicName() //$NON-NLS-1$
+									+ " cannot be resolved.", ioe); //$NON-NLS-1$
+					continue;
+				}
+			}
+		}
+
+	}
+
+	/**
+	 * Creates id of prebuilt index
+	 * 
+	 * @param prefix
+	 *            index directory prefix, e.g. "", "ws/gtk"
+	 * @return indexId string, e.g. "/", "/ws/gtk"
+	 */
+	private String getIndexId(String prefix) {
+		if (prefix.length() == 0) {
+			// root
+			return "/"; //$NON-NLS-1$
+		}
+		return "/" + prefix.substring(0, prefix.length() - 1); //$NON-NLS-1$
+	}
+
+	public boolean equals(Object obj) {
+		return pluginId.equals(obj);
+	}
+
+	public int hashCode() {
+		return pluginId.hashCode();
+	}
+
+	public String toString() {
+		StringBuffer ret = new StringBuffer(pluginId);
+		ret.append(":"); //$NON-NLS-1$
+		ret.append(path);
+		ret.append("="); //$NON-NLS-1$
+		if (indexIDs == null) {
+			ret.append("unresolved"); //$NON-NLS-1$
+		} else {
+			for (int i = 0; i < indexIDs.size(); i++) {
+				ret.append(indexIDs.get(i));
+				ret.append("@"); //$NON-NLS-1$
+				ret.append(resolvedPaths.get(i));
+			}
+		}
+		return ret.toString();
+	}
+
+	public List getIDs() {
+		resolve();
+		return indexIDs;
+	}
+
+	/**
+	 * @return list of paths (string) to an index directory. Paths are ordered
+	 *         from
+	 */
+	public List getPaths() {
+		resolve();
+		return resolvedPaths;
+	}
+
+	public String getPluginId() {
+		return pluginId;
+	}
+
+}