org.eclipse.help/Eclipse Help/org/eclipse/help/internal/navigation/NavigationModel.java

package org.eclipse.help.internal.navigation;

/*
 * Licensed Materials - Property of IBM,
 * WebSphere Studio Workbench
 * (c) Copyright IBM Corp 2000
 */

import org.xml.sax.*;
import java.util.*;
import java.io.*;
import org.eclipse.help.internal.HelpSystem;
import org.eclipse.help.internal.util.*;
import org.eclipse.help.internal.contributions.*;
import java.net.*;
import org.eclipse.help.internal.contributors.xml.*;
import org.eclipse.core.runtime.IPath;

import org.eclipse.help.internal.server.TempURL;

/**
 * Domain notifier for the help model.
 * It holds the model (views and topic elements).
 */
public class NavigationModel {

	// the map of topic url to all possible topics
	private Map urlToTopicMap = new HashMap();

	private Contribution infoset;
	private String infosetID;

	/**
	 * HelpDomainNotifier constructor comment.
	 */
	public NavigationModel(String infoset) {
		super();
		this.infosetID = infoset;

		if (HelpSystem.isClient())
			loadFromServer();
		else
			load();

		registerURLs();
	}
	/**
	 * HelpDomainNotifier constructor comment.
	 */
	public NavigationModel(Contribution infoset) {
		super();
		this.infoset = infoset;
		registerURLs();
	}
	/**
	 * Generate the XML navigation file for this model (infoset)
	 */
	private void generateNavigation() {
		if (infoset == null)
			return;

		IPath path =
			HelpSystem
				.getPlugin()
				.getStateLocation()
				.addTrailingSeparator()
				.append(infoset.getID());

		File outDir = path.toFile();
		if (!outDir.exists()) {
			outDir.mkdirs();
		}

		XMLNavGenerator navGen = new XMLNavGenerator((InfoSet) infoset, outDir);
		navGen.generate();
	}
	public Set getAllURLs() {
		return urlToTopicMap.keySet();
	}
	/**
	 * Insert the method's description here.
	 * @return java.lang.String
	 */
	public String getID() {
		return infosetID;
	}
	public Contribution getRootElement() {
		return infoset;
	}
	public Topic[] getTopicsWithURL(String url) {
		// Correct URL format first to what is recorded in the map
		int pos = url.indexOf("?");
		if (pos > 0)
			url = url.substring(0, pos);
		else {
			pos = url.indexOf("#");
			if (pos > 0)
				url = url.substring(0, pos);
		}

		// strip off the http://host:port/path
		URL helpServerURL = HelpSystem.getLocalHelpServerURL();
		if (helpServerURL != null && url.startsWith(helpServerURL.getProtocol())) {
			url = url.substring(helpServerURL.toExternalForm().length());
		} else
			if (url.indexOf('/') != 0)
				url = "/" + url;

		// get topics for corrected URL from the map
		return (Topic[]) urlToTopicMap.get(url);
	}
	/**
	 * Loads the xml model and creates the ui elements
	 */
	private void load() {
		String xmlFile =
			HelpSystem
				.getPlugin()
				.getStateLocation()
				.append(infosetID)
				.append(XMLNavGenerator.NAV_XML_FILENAME)
				.toOSString();
		try {
			ContributionParser parser = new ContributionParser();
			if (Logger.DEBUG)
				Logger.logDebugMessage("NavigationModel", "Loading _nav= " + xmlFile);
			InputStream input = new FileInputStream(xmlFile);
			parser.parse(new InputSource(input));
			infoset = parser.getContribution();

		} catch (SAXException se) {
			Logger.logError(se.getMessage(), se);
		} catch (IOException ioe) {
			String msg = Resources.getString("E009", xmlFile.toString());
			Logger.logError(msg, ioe);

			// now pass it to the RuntimeHelpStatus object explicitly because we
			// still need to display errors even if Logging is turned off.
			RuntimeHelpStatus.getInstance().addParseError(msg, xmlFile);
		}

	}
	/**
	 * Loads the xml model from the help server and creates the ui elements
	 */
	private void loadFromServer() {
		BufferedInputStream in = null;
		try {
			URL remoteNavFile =
				new URL(
					HelpSystem.getRemoteHelpServerURL(),
					HelpSystem.getRemoteHelpServerPath()
						+ "/"
						+ TempURL.getPrefix()
						+ "/"
						+ infosetID
						+ "/"
						+ XMLNavGenerator.NAV_XML_FILENAME);

			in = new BufferedInputStream(remoteNavFile.openStream());

			ContributionParser parser = new ContributionParser();
			if (Logger.DEBUG)
				Logger.logDebugMessage(
					"NavigationModel",
					"Loading _nav= " + remoteNavFile.toExternalForm());
			InputSource source = new InputSource(in);
			parser.parse(source);
			infoset = parser.getContribution();
			in.close();

		} catch (SAXException se) {
			Logger.logError(se.getMessage(), se);
		} catch (Exception ioe) {
			Logger.logError("Could not copy the model data from server", ioe);
			try {
				if (in != null)
					in.close();
			} catch (IOException e) {
			}
		}

	}
	/**
	 * Registers an element with the model
	 */
	private void registerURL(Topic topic) {
		// if it is a topic, map it to its url;
		String url = topic.getHref();
		if (url == null || "".equals(url))
			return;

		// see if mapped already
		Object t = urlToTopicMap.get(url);
		Topic[] topics;
		if (t == null) {
			topics = new Topic[1];
			topics[0] = topic;
		} else {
			topics = new Topic[((Topic[]) t).length + 1];
			for (int i = 0; i < ((Topic[]) t).length; i++) {
				topics[i] = ((Topic[]) t)[i];
			}
			topics[((Topic[]) t).length] = topic;
		}
		urlToTopicMap.put(url, topics);

	}
	/**
	 * Register all the topics by url
	 */
	private void registerURLs() {
		if (infoset == null)
			return;
		// Get the views
		for (Iterator views = infoset.getChildren(); views.hasNext();) {
			Contribution view = (Contribution) views.next();
			Stack stack = new Stack();
			stack.push(view.getChildren());
			while (!stack.isEmpty()) {
				Iterator topics = (Iterator) stack.pop();
				while (topics.hasNext()) {
					Topic topic = (Topic) topics.next();
					registerURL(topic);
					Iterator subtopics = topic.getChildren();
					if (subtopics.hasNext())
						stack.push(subtopics);
				}
			}
		}
	}
	private void save() {
		generateNavigation();
	}
}