Attachment #186915 for bug #319907

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Lines 14-19 Link Here

(-)META-INF/MANIFEST.MF (+1 lines)
14	org.eclipse.core.expressions;bundle-version="3.4.200"	14	org.eclipse.core.expressions;bundle-version="3.4.200"
15	Export-Package: org.eclipse.help.internal.webapp;x-friends:="org.eclipse.ua.tests",	15	Export-Package: org.eclipse.help.internal.webapp;x-friends:="org.eclipse.ua.tests",
16	org.eclipse.help.internal.webapp.data;x-friends:="org.eclipse.ua.tests",	16	org.eclipse.help.internal.webapp.data;x-friends:="org.eclipse.ua.tests",
		17	org.eclipse.help.internal.webapp.service;x-friends:="org.eclipse.ua.tests,org.eclipse.ua.tests.doc",
17	org.eclipse.help.internal.webapp.servlet;x-friends:="org.eclipse.ua.tests,org.eclipse.ua.tests.doc",	18	org.eclipse.help.internal.webapp.servlet;x-friends:="org.eclipse.ua.tests,org.eclipse.ua.tests.doc",
18	org.eclipse.help.webapp	19	org.eclipse.help.webapp
19	Bundle-RequiredExecutionEnvironment: J2SE-1.4	20	Bundle-RequiredExecutionEnvironment: J2SE-1.4

Lines 5-11 Link Here

(-)plugin.xml (-1 / +82 lines)
5	are made available under the terms of the Eclipse Public License v1.0	5	are made available under the terms of the Eclipse Public License v1.0
6	which accompanies this distribution, and is available at	6	which accompanies this distribution, and is available at
7	http://www.eclipse.org/legal/epl-v10.html	7	http://www.eclipse.org/legal/epl-v10.html
8		8
9	Contributors:	9	Contributors:
10	IBM Corporation - initial API and implementation	10	IBM Corporation - initial API and implementation
11	-->	11	-->
Lines 15-20 Link Here
15	<extension-point id="view" name="View" schema="schema/view.exsd"/>	15	<extension-point id="view" name="View" schema="schema/view.exsd"/>
16	<extension-point id="frame" name="Webapp Frame" schema="schema/frame.exsd"/>	16	<extension-point id="frame" name="Webapp Frame" schema="schema/frame.exsd"/>
17	<extension-point id="toolbarButton" name="Toolbar Button" schema="schema/toolbarButton.exsd"/>	17	<extension-point id="toolbarButton" name="Toolbar Button" schema="schema/toolbarButton.exsd"/>
		18	<extension-point id="secureServlet" name="Security Enhanced Servlet" schema="schema/secureServlet.exsd"/>
18	<extension	19	<extension
19	point="org.eclipse.equinox.http.registry.httpcontexts">	20	point="org.eclipse.equinox.http.registry.httpcontexts">
20	<httpcontext	21	<httpcontext
Lines 125-130 Link Here
125	<serviceSelector	126	<serviceSelector
126	filter="(other.info=org.eclipse.help)">	127	filter="(other.info=org.eclipse.help)">
127	</serviceSelector>	128	</serviceSelector>
		129	<servlet
		130	alias="/ss"
		131	class="org.eclipse.help.internal.webapp.servlet.SecureServlet"
		132	httpcontextId="help">
		133	</servlet>
128	</extension>	134	</extension>
129	<extension	135	<extension
130	id="org.eclipse.help.webapp.remoteStatusProducer"	136	id="org.eclipse.help.webapp.remoteStatusProducer"
Lines 134-137 Link Here
134	producer="org.eclipse.help.internal.webapp.StatusProducer">	140	producer="org.eclipse.help.internal.webapp.StatusProducer">
135	</contentProducer>	141	</contentProducer>
136	</extension>	142	</extension>
		143	<extension
		144	point="org.eclipse.help.webapp.secureServlet">
		145	<servlet
		146	alias="/service/control"
		147	class="org.eclipse.help.internal.webapp.service.ControlService">
		148	</servlet>
		149	<servlet
		150	alias="/service/content"
		151	class="org.eclipse.help.internal.webapp.service.ContentService">
		152	</servlet>
		153	<servlet
		154	alias="/service/topic"
		155	class="org.eclipse.help.internal.webapp.service.ContentService">
		156	</servlet>
		157	<servlet
		158	alias="/service/nftopic"
		159	class="org.eclipse.help.internal.webapp.service.ContentService">
		160	</servlet>
		161	<servlet
		162	alias="/service/ntopic"
		163	class="org.eclipse.help.internal.webapp.service.ContentService">
		164	</servlet>
		165	<servlet
		166	alias="/service/rtopic"
		167	class="org.eclipse.help.internal.webapp.service.ContentService">
		168	</servlet>
		169	<servlet
		170	alias="/service/nav"
		171	class="org.eclipse.help.internal.webapp.service.NavService">
		172	</servlet>
		173	<servlet
		174	alias="/service/livehelp"
		175	class="org.eclipse.help.internal.webapp.service.LiveHelpService">
		176	</servlet>
		177	<servlet
		178	alias="/service/toc"
		179	class="org.eclipse.help.internal.webapp.service.TocService">
		180	</servlet>
		181	<servlet
		182	alias="/service/tocfragment"
		183	class="org.eclipse.help.internal.webapp.service.TocFragmentService">
		184	</servlet>
		185	<servlet
		186	alias="/service/index"
		187	class="org.eclipse.help.internal.webapp.service.IndexService">
		188	</servlet>
		189	<servlet
		190	alias="/service/indexfragment"
		191	class="org.eclipse.help.internal.webapp.service.IndexFragmentService">
		192	</servlet>
		193	<servlet
		194	alias="/service/search"
		195	class="org.eclipse.help.internal.webapp.service.SearchService">
		196	</servlet>
		197	<servlet
		198	alias="/service/simplesearch"
		199	class="org.eclipse.help.internal.webapp.service.SimpleSearchService">
		200	</servlet>
		201	<servlet
		202	alias="/service/context"
		203	class="org.eclipse.help.internal.webapp.service.ContextService">
		204	</servlet>
		205	<servlet
		206	alias="/service/extension"
207	class="org.eclipse.help.internal.webapp.service.ExtensionService">
208	</servlet>
209	<servlet
210	alias="/service/about.html"
211	class="org.eclipse.help.internal.webapp.service.AboutService">
212	</servlet>
213	<servlet
214	alias="/service/state"
215	class="org.eclipse.help.internal.webapp.service.SearchStateService">
216	</servlet>
217	</extension>
137	</plugin>	218	</plugin>




<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.help.webapp" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
      <appInfo>
         <meta.schema plugin="org.eclipse.help.webapp" id="secureServlet" name="Security Enhanced Servlet"/>
      </appInfo>
      <documentation>
         Allows definition of Servlets and their aliases, with a focus on preventing known security vulernabilites.
      </documentation>
   </annotation>

   <element name="extension">
      <annotation>
         <appInfo>
            <meta.element />
         </appInfo>
      </annotation>
      <complexType>
         <sequence minOccurs="0" maxOccurs="unbounded">
            <element ref="servlet"/>
         </sequence>
         <attribute name="point" type="string" use="required">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="id" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="name" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
               <appInfo>
                  <meta.attribute translatable="true"/>
               </appInfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="servlet">
      <complexType>
         <attribute name="class" type="string" use="required">
            <annotation>
               <documentation>
                  
               </documentation>
               <appInfo>
                  <meta.attribute kind="java" basedOn="javax.servlet.http.HttpServlet:"/>
               </appInfo>
            </annotation>
         </attribute>
         <attribute name="alias" type="string" use="required">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <annotation>
      <appInfo>
         <meta.section type="since"/>
      </appInfo>
      <documentation>
         [Enter the first release in which this extension point appears.]
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="examples"/>
      </appInfo>
      <documentation>
         [Enter extension point usage example here.]
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="apiinfo"/>
      </appInfo>
      <documentation>
         [Enter API information here.]
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="implementation"/>
      </appInfo>
      <documentation>
         [Enter information about supplied implementation of this extension point.]
      </documentation>
   </annotation>


</schema>

Lines 211-213 Link Here

(-)src/org/eclipse/help/internal/webapp/WebappResources.properties (+7 lines)
211	criterionClosed=Criterion closed	211	criterionClosed=Criterion closed
212	criterionOpen=Criterion open	212	criterionOpen=Criterion open
213	Criteria=Criteria	213	Criteria=Criteria
		214
		215	# Secure Servlet
		216	cantCreateServlet=Unable to create servlet: {0}
		217
		218	# Service API
		219	StatusServlet_PARAM_MISSING=The "{0}" parameter is missing from the request.
		220

Lines 8-13 Link Here

(-)src/org/eclipse/help/internal/webapp/data/SearchData.java (-4 / +9 lines)
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
10	* Sebastian Davids <sdavids@gmx.de> - fix for Bug 182466	10	* Sebastian Davids <sdavids@gmx.de> - fix for Bug 182466
		11	* Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
11	*******************************************************************************/	12	*******************************************************************************/
12	package org.eclipse.help.internal.webapp.data;	13	package org.eclipse.help.internal.webapp.data;
13		14
Lines 177-182 Link Here
177	public int getResultsCount() {	178	public int getResultsCount() {
178	return hits.length;	179	return hits.length;
179	}	180	}
		181
		182	public SearchHit[] getResults() {
		183	return hits;
		184	}
180		185
181	public String getSelectedTopicId() {	186	public String getSelectedTopicId() {
182	return selectedTopicId;	187	return selectedTopicId;
Lines 554-565 Link Here
554		559
555	public String getScopeActiveMessage() {	560	public String getScopeActiveMessage() {
556	String scope = getScope();	561	String scope = getScope();
557	return NLS.bind(ServletResources.getString("activeScope", request), scope); //$NON-NLS-1$	562	return NLS.bind(ServletResources.getString("activeScope", request), scope); //$NON-NLS-1$
558	}	563	}
559		564
560	public String getMatchesInScopeMessage() {	565	public String getMatchesInScopeMessage() {
561	String scope = getScope();	566	String scope = getScope();
562	return NLS.bind(ServletResources.getString("matchesInScope", request), "" + getResultsCount(), scope); //$NON-NLS-1$ //$NON-NLS-2$	567	return NLS.bind(ServletResources.getString("matchesInScope", request), "" + getResultsCount(), scope); //$NON-NLS-1$ //$NON-NLS-2$
563	}	568	}
564		569
565	/*	570	/*




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.parser;

import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;
import org.eclipse.help.internal.webapp.utils.XMLHelper;
import org.xml.sax.Attributes;

public class ContextParser extends ResultParser {

	private ParseElement element = null;
	private String currentTag;

	public ContextParser() {
		super(JSonHelper.TITLE);
	}
	
	public void startElement(String uri, String lname, String name, Attributes attrs) {
		
		currentTag = name;
		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_DESCRIPTION))
			return;
		
		Properties properties = new Properties();
		properties.put(JSonHelper.PROPERTY_NAME, name);
		for (int i = 0; i < attrs.getLength(); i++) {
			String qname = attrs.getQName(i);
			String val = attrs.getValue(i);
			properties.put(qname, val);
		}
		
		ParseElement elem = new ParseElement(properties, element);
		if (element != null)
			element.addChild(elem);
		else
			items.add(elem);
		
		element = elem;
		
	}
	
	public void characters(char[] ch, int start, int length) {
		
		if (element != null 
				&& currentTag.equalsIgnoreCase(
						XMLHelper.ELEMENT_DESCRIPTION)) {
			
			Properties properties = element.getProps();
			if (properties != null) {
				
				String content = new String(ch, start, length);
				
				String existing = (String) properties.get(currentTag);
				if (existing == null)
					existing = ""; //$NON-NLS-1$
				
				content = content.replaceAll("[\\n\\t]", "").trim(); //$NON-NLS-1$ //$NON-NLS-2$
				
				properties.put(currentTag, existing + content);
				element.updateParseElement(properties);
			}
		}
	}
	
	public void endElement(String uri, String lname, String name) {
		
		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_DESCRIPTION))
			return;
		
		if (element != null) {
			element = element.getParent();
		}		
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.parser;

import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;
import org.xml.sax.Attributes;

public class ExtensionParser extends ResultParser {

	private ParseElement element = null;
	private String currentTag;

	public ExtensionParser() {
		super(JSonHelper.TITLE);
	}
	
	public void startElement(String uri, String lname, String name, Attributes attrs) {
		
		currentTag = name;
		
		Properties properties = new Properties();
		properties.put(JSonHelper.PROPERTY_NAME, name);
		for (int i = 0; i < attrs.getLength(); i++) {
			String qname = attrs.getQName(i);
			String val = attrs.getValue(i);
			properties.put(qname, val);
		}
		
		ParseElement elem = new ParseElement(properties, element);
		if (element != null)
			element.addChild(elem);
		else
			items.add(elem);
		
		element = elem;
		
	}
	
	public void characters(char[] ch, int start, int length) {
		
		if (element != null) {
			
			Properties properties = element.getProps();
			if (properties != null) {
				
				String content = new String(ch, start, length);
				
				String existing = (String) properties.get(currentTag);
				if (existing == null)
					existing = ""; //$NON-NLS-1$
				
				content = content.replaceAll("[\\n\\t]", "").trim(); //$NON-NLS-1$ //$NON-NLS-2$
				
				properties.put(currentTag, existing + content);
				element.updateParseElement(properties);
			}
		}
	}
	
	public void endElement(String uri, String lname, String name) {
		
		if (element != null) {
			element = element.getParent();
		}		
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.parser;

import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;
import org.eclipse.help.internal.webapp.utils.XMLHelper;
import org.xml.sax.Attributes;

public class IndexFragmentParser extends ResultParser{

	private ParseElement element = null;
	
	public IndexFragmentParser() {
		super(JSonHelper.TITLE);
	}
	
	public void startElement(String uri, String lname, String name, Attributes attrs) {
		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_NODE))
		{
			Properties properties = new Properties();
			properties.put(JSonHelper.PROPERTY_NAME, JSonHelper.INDEX);
			for (int i = 0; i < attrs.getLength(); i++) {
				String qname = attrs.getQName(i);
				String val = attrs.getValue(i);
				properties.put(qname, val);
			}
			
			ParseElement elem = new ParseElement(properties, element);
			if (element != null)
				element.addChild(elem);
			else
				items.add(elem);
			
			element = elem;
		}
		
	}
	
	public void endElement(String uri, String lname, String name) {
		if (element != null 
				&& name.equalsIgnoreCase(XMLHelper.ELEMENT_NODE)) {
			element = element.getParent();
		}		
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.parser;

import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;
import org.eclipse.help.internal.webapp.utils.XMLHelper;
import org.xml.sax.Attributes;

public class IndexParser extends ResultParser {

	private ParseElement element = null;

	public IndexParser() {
		super(JSonHelper.TITLE);
	}
	
	public void startElement(String uri, String lname, String name, Attributes attrs) {
		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_INDEX_CONTRIBUTIONS) 
				|| name.equalsIgnoreCase(XMLHelper.ELEMENT_INDEX))
			return;
		
		Properties properties = new Properties();
		properties.put(JSonHelper.PROPERTY_NAME, name);
		for (int i = 0; i < attrs.getLength(); i++) {
			String qname = attrs.getQName(i);
			String val = attrs.getValue(i);
			properties.put(qname, val);
		}
		
		ParseElement elem = new ParseElement(properties, element);
		if (element != null)
			element.addChild(elem);
		else
			items.add(elem);
		
		element = elem;
		
	}
	
	public void endElement(String uri, String lname, String name) {
		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_INDEX_CONTRIBUTIONS) 
				|| name.equalsIgnoreCase(XMLHelper.ELEMENT_INDEX))
			return;
		
		if (element != null) {
			element = element.getParent();
		}		
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.parser;

import java.util.ArrayList;
import java.util.Enumeration;
import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;

public class ParseElement {

	private Properties props;
	private ArrayList children = new ArrayList();
	private ParseElement parent;

	public ParseElement(Properties props, ParseElement parent) {
		this.props = props;
		this.parent = parent;
	}

	public ParseElement(Properties props) {
		this(props, null);
	}
	
	public void updateParseElement(Properties props) {
		this.props = props;
	}
	
	public Properties getProps() {
		return props;
	}
	
	public ParseElement getParent() {
		return parent;
	}
	
	public String getProperty(String key) {
		return (props != null) ? props.getProperty(key) : ""; //$NON-NLS-1$
	}
	
	public String toString() {
		return (props != null) ? props.toString() : ""; //$NON-NLS-1$
	}
	
	public void addChild(ParseElement elem) {
		children.add(elem);
	}
	
	public int getChildrenCount() {
		return children.size();
	}
	
	public String toJSON(int level) {
		
		StringBuffer buff = new StringBuffer();
		
		String space = JSonHelper.SPACE;
		for (int s = 0; s < level; s++) {
			space += JSonHelper.SPACE;
		}
		
		buff.append(JSonHelper.NEWLINE + space);
		buff.append(JSonHelper.BEGIN_BRACE);
		
		if (props != null) {
			Enumeration enumObj = props.keys();
			while (enumObj.hasMoreElements()) {
				
				String key = (String) enumObj.nextElement();
				String val = props.getProperty(key);
				
				buff.append(JSonHelper.NEWLINE + space + JSonHelper.SPACE);
				buff.append(key);
				buff.append(JSonHelper.COLON);
				buff.append(JSonHelper.getQuotes(val));
				buff.append(JSonHelper.COMMA);
			}
		}
		
		if (children.size() <= 0) {
			int len = buff.length();
			char ch = buff.charAt(len - 1);
			if (ch == ',') {
				buff.deleteCharAt(len - 1);
				buff.append(JSonHelper.NEWLINE + space);
			}
			
		} else {
			
			buff.append(JSonHelper.NEWLINE + space + JSonHelper.SPACE);
			buff.append(JSonHelper.CHILDREN);
			buff.append(JSonHelper.COLON);
			buff.append(JSonHelper.BEGIN_BRACKET);
			
			for (int i = 0; i < children.size(); i++) {
				
				if (i > 0)
					buff.append(JSonHelper.COMMA);
				
				ParseElement element = (ParseElement) children.get(i);
				buff.append(element.toJSON(level + 2));
			}
			
			buff.append(JSonHelper.NEWLINE + space + JSonHelper.SPACE);
			
			buff.append(JSonHelper.END_BRACKET);
			buff.append(JSonHelper.NEWLINE + space);
		}
		
		buff.append(JSonHelper.END_BRACE);
		
		return buff.toString();
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.parser;

import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.ArrayList;

import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;

import org.eclipse.help.internal.webapp.utils.JSonHelper;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;

public class ResultParser extends DefaultHandler {

	private String label = ""; //$NON-NLS-1$
	protected ArrayList items = new ArrayList(); //parser populates the items arrayList withe parsed data.

	public ResultParser(String label) {
		this.label = label;
	}
	
	public void parse(URL tocURL) 
		throws ParserConfigurationException, SAXException, IOException
	{
		parse(tocURL.openStream());
	}
	
	public void parse(InputStream in) 
		throws ParserConfigurationException, SAXException, IOException
	{
		SAXParser parser = SAXParserFactory.newInstance().newSAXParser();
		parser.parse(in, this);
	}
	
	public ArrayList getItems()
	{
		return items;
	}
	
	public String toString()
	{
		return items.toString();
	}
	
	public String toJSON() {
		
		StringBuffer buf = new StringBuffer();
		
		buf.append(JSonHelper.BEGIN_BRACE);
		buf.append(JSonHelper.NEWLINE + JSonHelper.SPACE);
		
		buf.append(JSonHelper.IDENTIFIER);
		buf.append(JSonHelper.COLON);
		buf.append(JSonHelper.getQuotes(JSonHelper.ID));
		buf.append(JSonHelper.COMMA);

		buf.append(JSonHelper.NEWLINE + JSonHelper.SPACE);
		buf.append(JSonHelper.LABEL);
		buf.append(JSonHelper.COLON);
		buf.append(JSonHelper.getQuotes(label));
		buf.append(JSonHelper.COMMA);

		buf.append(JSonHelper.NEWLINE + JSonHelper.SPACE);
		buf.append(JSonHelper.ITEMS);
		buf.append(JSonHelper.COLON);
		buf.append(JSonHelper.BEGIN_BRACKET);
		
		for (int i = 0; i < items.size(); i++) {
			
			if (i > 0)
				buf.append(JSonHelper.COMMA);
			
			ParseElement element = (ParseElement) items.get(i);
			buf.append(element.toJSON(1));
		}
		
		if (items.size() > 0)
			buf.append(JSonHelper.NEWLINE + JSonHelper.SPACE);
		
		buf.append(JSonHelper.END_BRACKET);
		buf.append(JSonHelper.NEWLINE);
		buf.append(JSonHelper.END_BRACE);
		
		return buf.toString();
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.parser;

import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;
import org.eclipse.help.internal.webapp.utils.XMLHelper;
import org.xml.sax.Attributes;

public class SearchParser extends ResultParser {

//	private ParseElement element;
	private Properties properties;
	private String currentTag;
	
	public SearchParser() {
		super(JSonHelper.LABEL);
	}

	public void startElement(String uri, 
			String lname, String name, Attributes attrs) {
		
		currentTag = name;
		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_HIT)) {
			
			properties = new Properties();
			properties.put(JSonHelper.PROPERTY_NAME, name);
			for (int i = 0; i < attrs.getLength(); i++) {
				String qname = attrs.getQName(i);
				String val = attrs.getValue(i);
				properties.put(qname, val);
			}
			
			String id = "" + items.size(); //$NON-NLS-1$
			properties.put(JSonHelper.ID, id);
			
		} else if (name.equalsIgnoreCase(XMLHelper.ELEMENT_CATEGORY)) {
//		} else {
			for (int i = 0; i < attrs.getLength(); i++) {
				String qname = attrs.getQName(i);
				String val = attrs.getValue(i);
				if (qname.equalsIgnoreCase(XMLHelper.ATTR_HREF))
					qname = XMLHelper.CATEGORY_HREF;
				properties.put(qname, val);
			}
		}
	}
	
	public void characters(char[] ch, int start, int length) {
		
		if (currentTag.equalsIgnoreCase(XMLHelper.ELEMENT_HIT) 
				|| currentTag.equalsIgnoreCase(XMLHelper.ELEMENT_HITS))
			return;
		
		if (properties != null)
		{
			String content = new String(ch, start, length);
			
			String existing = (String) properties.get(currentTag);
			if (existing == null)
				existing = ""; //$NON-NLS-1$
			
			content = content.replaceAll("[\\n\\t]", "").trim(); //$NON-NLS-1$ //$NON-NLS-2$
			
			properties.put(currentTag, existing + content);
		}
	}

	public void endElement(String uri, String lname, String name) {

		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_HIT)) {
			ParseElement element = new ParseElement(properties);
			items.add(element);
		}
//		} else if (name.equalsIgnoreCase(XMLHelper.ELEMENT_CATEGORY)) {
		/*} else {
			if (element != null && properties != null) {
				ParseElement category = new ParseElement(properties);
				element.addChild(category);
			}
			properties = null;
		}*/
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.parser;

import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Properties;

import javax.xml.parsers.ParserConfigurationException;

import org.eclipse.help.internal.webapp.utils.JSonHelper;
import org.eclipse.help.internal.webapp.utils.XMLHelper;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;

public class TocFragmentParser extends ResultParser {

	private Properties properties;
	private String parentId = ""; //$NON-NLS-1$
	private int tagLevel = -1;
	private int level = 0;
	
	public TocFragmentParser() {
		super(JSonHelper.TITLE);
	}

	public void parse(URL tocURL, int level) 
		throws ParserConfigurationException, SAXException, IOException
	{
		parse(tocURL.openStream(), level);
	}
	
	public void parse(InputStream in, int level) 
		throws ParserConfigurationException, SAXException, IOException
	{
		this.level = level;
		super.parse(in);
	}

	public void startElement(String uri, 
			String lname, String name, Attributes attrs) {
		
		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_NODE))
		{
			tagLevel++;
			
			if (tagLevel == level) {
				properties = new Properties();
				properties.put(JSonHelper.PROPERTY_NAME, JSonHelper.TOPIC);
				for (int i = 0; i < attrs.getLength(); i++) {
					String qname = attrs.getQName(i);
					String val = attrs.getValue(i);
					if (qname.equals(XMLHelper.ATTR_ID)) {
						if (parentId.length() > 0)
							val = parentId + '$' + val;
					}
					properties.put(qname, val);
				}
			} else if (parentId.length() <= 0) {
				for (int i = 0; i < attrs.getLength(); i++) {
					if (attrs.getQName(i).equals(XMLHelper.ATTR_ID))
						parentId = attrs.getValue(i);
				}
			}
		}
	}

	public void endElement(String uri, String lname, String name) {

		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_NODE))
		{
			if (tagLevel == level && properties != null ) {
				
				properties.setProperty("type", "toc"); //$NON-NLS-1$ //$NON-NLS-2$
				
				ParseElement element = new ParseElement(properties);
				items.add(element);
				
				properties = null;
			}
			
			tagLevel--;
		}
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.parser;

import java.util.Properties;

import org.eclipse.help.internal.webapp.utils.JSonHelper;
import org.eclipse.help.internal.webapp.utils.XMLHelper;
import org.xml.sax.Attributes;

public class TocParser extends ResultParser {

	private ParseElement element = null;

	public TocParser() {
		super(JSonHelper.LABEL);
	}
	
	public void startElement(String uri, String lname, String name, Attributes attrs) {
		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_TOC_CONTRIBUTIONS))
			return;
		
		Properties properties = new Properties();
		properties.put(JSonHelper.PROPERTY_NAME, name);
		for (int i = 0; i < attrs.getLength(); i++) {
			String qname = attrs.getQName(i);
			String val = attrs.getValue(i);
			properties.put(qname, val);
		}
		
		ParseElement elem = new ParseElement(properties, element);
		if (element != null)
			element.addChild(elem);
		else
			items.add(elem);
		
		element = elem;
		
	}
	
	public void endElement(String uri, String lname, String name) {
		if (name.equalsIgnoreCase(XMLHelper.ELEMENT_TOC_CONTRIBUTIONS))
			return;
		
		if (element != null) {
			element = element.getParent();
		}		
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import org.eclipse.help.internal.webapp.servlet.AboutServlet;

public class AboutService extends AboutServlet {

	private static final long serialVersionUID = 1L;

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.net.URL;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.internal.webapp.utils.Utils;

public class ContentService extends HttpServlet {

	private static final long serialVersionUID = 1L;

	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
		resp.setContentType("text/html; charset=UTF-8"); //$NON-NLS-1$
		
		String servletPath = "/help"; //$NON-NLS-1$
		String pathInfo = req.getPathInfo();
		if (pathInfo != null) {
			int index = pathInfo.indexOf("/service"); //$NON-NLS-1$
			if (index > -1)
				pathInfo = pathInfo.substring(index + "/service".length()); //$NON-NLS-1$
			if (!pathInfo.equals("")) //$NON-NLS-1$
				servletPath += pathInfo.startsWith("/") ? pathInfo : "/" + pathInfo; //$NON-NLS-1$ //$NON-NLS-2$
		}
		
		String queryString = req.getQueryString();
		if (queryString != null && !queryString.equals("")) { //$NON-NLS-1$
			servletPath += "?" + queryString; //$NON-NLS-1$
		}
		
		URL url = new URL("http", req.getServerName(),  //$NON-NLS-1$
				req.getServerPort(), servletPath);
		String response = Utils.convertStreamToString(url.openStream());
		
		OutputStream out = resp.getOutputStream();
		PrintWriter writer = new PrintWriter(new OutputStreamWriter(out, "UTF-8")); //$NON-NLS-1$
		writer.write(response);
		writer.close();
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.internal.webapp.parser.ContextParser;
import org.eclipse.help.internal.webapp.servlet.ContextServlet;
import org.eclipse.help.internal.webapp.utils.Utils;

public class ContextService extends ContextServlet {

	private static final long serialVersionUID = 1L;

	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		
		req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
		// Set standard HTTP/1.1 no-cache headers.
		resp.setHeader("Cache-Control",  //$NON-NLS-1$
				"no-store, no-cache, must-revalidate"); //$NON-NLS-1$
		
		String response = processRequest(req, resp);
		if ("400".equals(response)) { //$NON-NLS-1$
			resp.sendError(400); // bad request; missing parameter
			return;
		} else if ("404".equals(response)) { //$NON-NLS-1$
			resp.sendError(404); // Wrong context id; not found
			return;
		}
		
		String returnType = req.getParameter(Utils.RETURN_TYPE);
		boolean boolIsJSON = (returnType != null 
				&& returnType.equalsIgnoreCase(Utils.JSON));
		
		// If JSON output is required
		if (boolIsJSON) {
			resp.setContentType("text/plain"); //$NON-NLS-1$
			response = getJSONResponse(response);
		}
		
		resp.getWriter().write(response);
	}

	protected String getJSONResponse(String response)
			throws IOException {
		ContextParser searchParser = new ContextParser();
		InputStream is = null;
		try {
			if (response != null) {
				is = new ByteArrayInputStream(response.getBytes("UTF-8")); //$NON-NLS-1$
				searchParser.parse(is);
			}

		} catch (Exception e) {
			e.printStackTrace();
		}
		
		if (is != null)
			is.close();

		// Call after the catch.
		// An empty JSON is created if any Exception is thrown
		// Else returns the complete JSON
		return searchParser.toJSON();
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import org.eclipse.help.internal.webapp.servlet.ControlServlet;

public class ControlService extends ControlServlet {

	private static final long serialVersionUID = 1L;

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.internal.webapp.parser.ExtensionParser;
import org.eclipse.help.internal.webapp.servlet.ExtensionServlet;
import org.eclipse.help.internal.webapp.utils.Utils;

public class ExtensionService extends ExtensionServlet {

	private static final long serialVersionUID = 1L;

	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		
		req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
		// Set standard HTTP/1.1 no-cache headers.
		resp.setHeader("Cache-Control",  //$NON-NLS-1$
				"no-store, no-cache, must-revalidate"); //$NON-NLS-1$
		
		String response = processRequest(req, resp);
		String returnType = req.getParameter(Utils.RETURN_TYPE);
		boolean boolIsJSON = (returnType != null 
				&& returnType.equalsIgnoreCase(Utils.JSON));
		
		// If JSON output is required
		if (boolIsJSON) {
			resp.setContentType("text/plain"); //$NON-NLS-1$
			response = getJSONResponse(response);
		}
		
		resp.getWriter().write(response);
	}

	protected String getJSONResponse(String response)
			throws IOException {
		ExtensionParser searchParser = new ExtensionParser();
		InputStream is = null;
		try {
			if (response != null) {
				is = new ByteArrayInputStream(response.getBytes("UTF-8")); //$NON-NLS-1$
				searchParser.parse(is);
			}

		} catch (Exception e) {
			e.printStackTrace();
		}
		
		if (is != null)
			is.close();

		// Call after the catch.
		// An empty JSON is created if any Exception is thrown
		// Else returns the complete JSON
		return searchParser.toJSON();
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.internal.webapp.parser.IndexFragmentParser;
import org.eclipse.help.internal.webapp.servlet.IndexFragmentServlet;
import org.eclipse.help.internal.webapp.utils.Utils;

/*
 * Sends all available keyword index data in XML form. The data is sent as one
 * large index contribution that includes all merged contributions from the
 * system.
 * 
 * This is called on infocenters by client workbenches configured for remote
 * help in order to gather all the index keywords and assemble them into a
 * complete index.
 */
public class IndexFragmentService extends IndexFragmentServlet {

	private static final long serialVersionUID = 1L;

	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		
		req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
		// Set standard HTTP/1.1 no-cache headers.
		resp.setHeader("Cache-Control",  //$NON-NLS-1$
				"no-store, no-cache, must-revalidate"); //$NON-NLS-1$
		
		String response = processRequest(req, resp);
		
		String returnType = req.getParameter(Utils.RETURN_TYPE);
		boolean boolIsJSON = (returnType != null 
				&& returnType.equalsIgnoreCase(Utils.JSON));
		
		// If JSON output is required
		if (boolIsJSON) {
			resp.setContentType("text/plain"); //$NON-NLS-1$
			response = getJSONResponse(response);
		}
		
		resp.getWriter().write(response);
	}

	protected String getJSONResponse(String response)
			throws IOException {
		IndexFragmentParser indexParser = new IndexFragmentParser();
		InputStream is = null;
		try {
			if (response != null) {
				is = new ByteArrayInputStream(response.getBytes("UTF-8")); //$NON-NLS-1$
				indexParser.parse(is);
			}

		} catch (Exception e) {
			e.printStackTrace();
		}
		
		if (is != null)
			is.close();

		// Call after the catch.
		// An empty JSON is created if any Exception is thrown
		// Else returns the complete JSON
		return indexParser.toJSON();
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.internal.webapp.parser.IndexParser;
import org.eclipse.help.internal.webapp.servlet.IndexServlet;
import org.eclipse.help.internal.webapp.utils.Utils;

public class IndexService extends IndexServlet {

	private static final long serialVersionUID = 1L;

	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		
		req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
		// Set standard HTTP/1.1 no-cache headers.
		resp.setHeader("Cache-Control",  //$NON-NLS-1$
				"no-store, no-cache, must-revalidate"); //$NON-NLS-1$
		
		String response = processRequest(req, resp);
		
		String returnType = req.getParameter(Utils.RETURN_TYPE);
		boolean boolIsJSON = (returnType != null 
				&& returnType.equalsIgnoreCase(Utils.JSON));
		
		// If JSON output is required
		if (boolIsJSON) {
			resp.setContentType("text/plain"); //$NON-NLS-1$
			response = getJSONResponse(response);
		}
		
		resp.getWriter().write(response);
	}

	protected String getJSONResponse(String response)
			throws IOException {
		IndexParser indexParser = new IndexParser();
		InputStream is = null;
		try {
			if (response != null) {
				is = new ByteArrayInputStream(response.getBytes("UTF-8")); //$NON-NLS-1$
				indexParser.parse(is);
			}

		} catch (Exception e) {
			e.printStackTrace();
		}
		
		if (is != null)
			is.close();

		// Call after the catch.
		// An empty JSON is created if any Exception is thrown
		// Else returns the complete JSON
		return indexParser.toJSON();
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import org.eclipse.help.internal.webapp.servlet.LiveHelpServlet;

public class LiveHelpService extends LiveHelpServlet {

	private static final long serialVersionUID = 1L;

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.net.URL;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.internal.webapp.utils.Utils;

public class NavService extends HttpServlet {

	private static final long serialVersionUID = 1L;

	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		
		req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
		resp.setContentType("text/html; charset=UTF-8"); //$NON-NLS-1$
		
		String servletPath = "/help"; //$NON-NLS-1$
		String pathInfo = req.getPathInfo();
		if (pathInfo != null) {
			int index = pathInfo.indexOf("/service"); //$NON-NLS-1$
			if (index > -1)
				pathInfo = pathInfo.substring(index + "/service".length()); //$NON-NLS-1$
			if (!pathInfo.equals("")) //$NON-NLS-1$
				servletPath += pathInfo.startsWith("/") ? pathInfo : "/" + pathInfo; //$NON-NLS-1$ //$NON-NLS-2$
		}
		
		String queryString = req.getQueryString();
		if (queryString != null && !queryString.equals("")) { //$NON-NLS-1$
			servletPath += "?" + queryString; //$NON-NLS-1$
		}
		
		URL url = new URL("http", req.getServerName(),  //$NON-NLS-1$
				req.getServerPort(), servletPath);
		String response = Utils.convertStreamToString(url.openStream());
		
		OutputStream out = resp.getOutputStream();
		PrintWriter writer = new PrintWriter(new OutputStreamWriter(out, "UTF-8")); //$NON-NLS-1$
		writer.write(response);
		writer.close();
		
		/*try {
			HttpServlet servlet = getWebappServlet("NavServlet"); //$NON-NLS-1$
			ServletConfig config = getServletConfig();
			servlet.init(config);
			servlet.service(req, resp);
		} catch (Exception e) {
			e.printStackTrace();
		}*/
	}

	/*private HttpServlet getWebappServlet(String service) 
			throws Exception {
		Class cls = Class.forName(
				"org.eclipse.help.internal.webapp.servlet." + service); //$NON-NLS-1$
		Constructor constructor = cls.getConstructor(new Class[]{});
		return (HttpServlet)constructor.newInstance(new Object[]{});
	}*/

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.internal.search.SearchHit;
import org.eclipse.help.internal.search.SearchProgressMonitor;
import org.eclipse.help.internal.webapp.data.SearchData;
import org.eclipse.help.internal.webapp.data.UrlUtil;
import org.eclipse.help.internal.webapp.parser.SearchParser;
import org.eclipse.help.internal.webapp.utils.Utils;
import org.eclipse.help.internal.webapp.utils.SearchXMLGenerator;

/*
 * Returns the search hits for the query provided in the phrase parameter.
 * 
 * This is called on infocenters by client workbenches configured for remote
 * help in order to retrieve search hits from the remote help server.
 */
public class SearchService extends HttpServlet {
	
	private static final long serialVersionUID = 1L;
	public static final String XID = "xid"; //$NON-NLS-1$
	
	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		
		req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
		// Set standard HTTP/1.1 no-cache headers.
		resp.setHeader("Cache-Control",  //$NON-NLS-1$
				"no-store, no-cache, must-revalidate"); //$NON-NLS-1$
		
		resp.setContentType("application/xml; charset=UTF-8"); //$NON-NLS-1$
		
		ServletContext context = req.getSession().getServletContext();
		SearchData searchData = new SearchData(context, req, resp);
		
		String noCat = req.getParameter(Utils.NO_CATEGORY);
		boolean boolIsCategory = (noCat == null 
				|| !noCat.equalsIgnoreCase("true")); //$NON-NLS-1$
		
		String locale = UrlUtil.getLocale(req, resp);
		SearchProgressMonitor pm = SearchProgressMonitor
				.getProgressMonitor(locale);
		while (!pm.isDone()) {
			try {
				Thread.sleep(500); // Sleep for 0.5 sec
			} catch(InterruptedException ex) {}
		}
		
		SearchHit[] hits = searchData.getResults();
		
		String response = SearchXMLGenerator.serialize(hits, boolIsCategory);
		
		String returnType = req.getParameter(Utils.RETURN_TYPE);
		boolean boolIsJSON = (returnType != null 
				&& returnType.equalsIgnoreCase(Utils.JSON));
		
		// If JSON output is required
		if (boolIsJSON) {
			resp.setContentType("text/plain"); //$NON-NLS-1$
			response = getJSONResponse(response);
		}
		
		resp.getWriter().write(response);
	}
	
	protected String getJSONResponse(String response)
			throws IOException {
		SearchParser searchParser = new SearchParser();
		
		InputStream is = null;
		try {
			if (response != null) {
				is = new ByteArrayInputStream(response.getBytes("UTF-8")); //$NON-NLS-1$
				searchParser.parse(is);
			}
			
		} catch (Exception e) {
			e.printStackTrace();
		}
		
		if (is != null)
			is.close();
        
        // Call after the catch.
		// An empty JSON is created if any Exception is thrown
		// Else returns the complete JSON
		return searchParser.toJSON();
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import java.io.IOException;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.internal.search.SearchProgressMonitor;
import org.eclipse.help.internal.webapp.data.UrlUtil;
import org.eclipse.help.internal.webapp.utils.Utils;

/**
 * This is the main servlet for WAR Update Actions.  It delegates each action to the
 * appropriate <code>IDelegatorOperation</code>
 * 
 * @author snehpaul
 *
 */
public class SearchStateService extends HttpServlet {
	
	private static final long serialVersionUID = 1L;
	private final static String STATE = "state"; //$NON-NLS-1$
	private final static String PERCENT = "percent"; //$NON-NLS-1$
	
	public void init() throws ServletException {
	}

	/**
	 * Called by the server (via the <code>service</code> method) to allow a
	 * Servlet to handle a GET request.
	 */
	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {

		process(req,resp);
	}

	/**
	 *
	 * Called by the server (via the <code>service</code> method) to allow a
	 * Servlet to handle a POST request.
	 *
	 * Handle the search requests,
	 *
	 */
	protected void doPost(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		process(req, resp);
	}


	/**
	 * Processes all requests to the servlet.
	 *
	 */
	private void process(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		
		resp.setHeader("Cache-Control", "no-store, no-cache, must-revalidate"); //$NON-NLS-1$ //$NON-NLS-2$
		resp.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
		
		int indexCompletion = 0;
		String locale = UrlUtil.getLocale(req, resp);
		SearchProgressMonitor pm = SearchProgressMonitor
				.getProgressMonitor(locale);
		if (pm.isDone()) {
			indexCompletion = 100;
		} else {
			indexCompletion = pm.getPercentage();
			if (indexCompletion >= 100) {
				// 38573 We do not have results, so index cannot be 100
				indexCompletion = 100 - 1;
			}
		}
		
		String returnType = req.getParameter(Utils.RETURN_TYPE);
		boolean isXML = Utils.XML.equalsIgnoreCase(returnType);
		if (isXML) {
			resp.setContentType("application/xml"); //$NON-NLS-1$
			resp.getWriter().write(toXML(indexCompletion));
		} else {
			resp.setContentType("text/plain"); //$NON-NLS-1$
			resp.getWriter().write(toString(indexCompletion));
		}
		resp.getWriter().flush();
	}
	
	public static String toXML(int percent) {
		String xml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"; //$NON-NLS-1$
		xml += '<'+STATE+">\n"; //$NON-NLS-1$
		xml += "	<"+PERCENT+'>'+percent+"</"+PERCENT+">\n"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
		xml += "</"+STATE+">"; //$NON-NLS-1$ //$NON-NLS-2$
		return xml;
	}
	
	public static String toString(int percent) {
		return "Percent:" + percent; //$NON-NLS-1$
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.internal.webapp.parser.SearchParser;
import org.eclipse.help.internal.webapp.servlet.SearchServlet;
import org.eclipse.help.internal.webapp.utils.Utils;

public class SimpleSearchService extends SearchServlet {

	private static final long serialVersionUID = 1L;

	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		
		req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
		// Set standard HTTP/1.1 no-cache headers.
		resp.setHeader("Cache-Control",  //$NON-NLS-1$
				"no-store, no-cache, must-revalidate"); //$NON-NLS-1$
		
		String response = processRequest(req, resp);
		if ("".equals(response)) { //$NON-NLS-1$
			resp.sendError(400); // bad request; missing parameter
			return;
		}
		
		String returnType = req.getParameter(Utils.RETURN_TYPE);
		boolean boolIsJSON = (returnType != null 
				&& returnType.equalsIgnoreCase(Utils.JSON));
		
		// If JSON output is required
		if (boolIsJSON) {
			resp.setContentType("text/plain"); //$NON-NLS-1$
			response = getJSONResponse(response);
		}
		
		resp.getWriter().write(response);
	}

	protected String getJSONResponse(String response)
			throws IOException {
		SearchParser searchParser = new SearchParser();
		InputStream is = null;
		try {
			if (response != null) {
				is = new ByteArrayInputStream(response.getBytes("UTF-8")); //$NON-NLS-1$
				searchParser.parse(is);
			}

		} catch (Exception e) {
			e.printStackTrace();
		}
		
		if (is != null)
			is.close();

		// Call after the catch.
		// An empty JSON is created if any Exception is thrown
		// Else returns the complete JSON
		return searchParser.toJSON();
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.internal.webapp.parser.TocFragmentParser;
import org.eclipse.help.internal.webapp.servlet.TocFragmentServlet;
import org.eclipse.help.internal.webapp.utils.Utils;

/*
 * Sends all toc contributions available on this host in XML form. The toc
 * is not send in assembled form, but instead fragments, because complete books
 * may be distributed between remote and local.
 * 
 */
public class TocFragmentService extends TocFragmentServlet {
	
	private static final long serialVersionUID = 1L;

	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		
		req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
		// Set standard HTTP/1.1 no-cache headers.
		resp.setHeader("Cache-Control",  //$NON-NLS-1$
				"no-store, no-cache, must-revalidate"); //$NON-NLS-1$
		
		String response = processRequest(req, resp);
		
		String returnType = req.getParameter(Utils.RETURN_TYPE);
		boolean boolIsJSON = (returnType != null 
				&& returnType.equalsIgnoreCase(Utils.JSON));
		
		// If JSON output is required
		if (boolIsJSON) {
			resp.setContentType("text/plain"); //$NON-NLS-1$
			String toc = req.getParameter("toc"); //$NON-NLS-1$
			String path = req.getParameter("path"); //$NON-NLS-1$
			response = getJSONResponse(toc, path, response);
		}
		
		resp.getWriter().write(response);
	}
	
	protected String getJSONResponse(String toc, String path, String xmlResource)
			throws IOException {
		TocFragmentParser tocParser = new TocFragmentParser();
		InputStream is = null;
		try {
			if (xmlResource != null) {
	            is = new ByteArrayInputStream(xmlResource.getBytes("UTF-8")); //$NON-NLS-1$
	            
	            int level = 0;
				if (toc != null && toc.length() > 0) {
					level++;
					
					
					if (path != null && path.length() > 0) {
						String[] pathIdxs = path.split("_"); //$NON-NLS-1$
						level += pathIdxs.length;
					}
				}
				
				tocParser.parse(is, level);
			}
			
		} catch (Exception e) {
			e.printStackTrace();
		}
		
		if (is != null)
			is.close();
        
        // Call after the catch.
		// An empty JSON is created if any Exception is thrown
		// Else returns the complete JSON
		return tocParser.toJSON();
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.service;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.internal.webapp.parser.TocParser;
import org.eclipse.help.internal.webapp.servlet.TocServlet;
import org.eclipse.help.internal.webapp.utils.Utils;

public class TocService extends TocServlet {

	private static final long serialVersionUID = 1L;

	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		
		req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
		// Set standard HTTP/1.1 no-cache headers.
		resp.setHeader("Cache-Control",  //$NON-NLS-1$
				"no-store, no-cache, must-revalidate"); //$NON-NLS-1$
		
		String response = processRequest(req, resp);
		
		String returnType = req.getParameter(Utils.RETURN_TYPE);
		boolean boolIsJSON = (returnType != null 
				&& returnType.equalsIgnoreCase(Utils.JSON));
		
		// If JSON output is required
		if (boolIsJSON) {
			resp.setContentType("text/plain"); //$NON-NLS-1$
			response = getJSONResponse(response);
		}
		
		resp.getWriter().write(response);
	}

	protected String getJSONResponse(String response)
			throws IOException {
		TocParser tocParser = new TocParser();
		InputStream is = null;
		try {
			if (response != null) {
				is = new ByteArrayInputStream(response.getBytes("UTF-8")); //$NON-NLS-1$
				tocParser.parse(is);
			}

		} catch (Exception e) {
			e.printStackTrace();
		}
		
		if (is != null)
			is.close();

		// Call after the catch.
		// An empty JSON is created if any Exception is thrown
		// Else returns the complete JSON
		return tocParser.toJSON();
	}

}




/*******************************************************************************
 * Copyright (c) 2000, 2011 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

 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.servlet;

import java.io.IOException;
import java.io.Writer;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;

	
	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		String response = processRequest(req, resp);
		if ("400".equals(response)) //$NON-NLS-1$
			resp.sendError(400); // bad request; missing parameter
		else if ("404".equals(response)) //$NON-NLS-1$
			resp.sendError(404); // Wrong context id; not found
		else
			resp.getWriter().write(response);
	}
	
	protected String processRequest(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		BaseHelpSystem.checkMode();
		String locale = UrlUtil.getLocale(req, resp);
		req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$

		if (id != null) {
			IContext context = getContext(locale, id);
			if (context != null) {
				return serialize(context);
			}
			// Wrong context id; not found
			return "404"; //$NON-NLS-1$
			}
		}
		else {
			resp.sendError(400); // bad request; missing parameter
		}
		// bad request; missing parameter
		return "400"; //$NON-NLS-1$
	}

	protected IContext getContext(String locale, String id) {

		return context;
	}
	
	private String serialize(IContext context) throws IOException {
		StringBuffer buff = new StringBuffer();
		buff.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"); //$NON-NLS-1$
		buff.append('<' + Context.NAME );
		if (context instanceof IContext2) {
			String title = ((IContext2)context).getTitle();
			if (title != null && title.length() > 0) {
				buff.append(" title=\"" + title + "\""); //$NON-NLS-1$ //$NON-NLS-2$			
			}
		}
		buff.append(">\n"); //$NON-NLS-1$
		String description = context.getText();
		if (description != null) {
			buff.append("   <description>" + UrlUtil.htmlEncode(description) + "</description>\n"); //$NON-NLS-1$ //$NON-NLS-2$
		}
		
		IHelpResource[] topics = context.getRelatedTopics();
		for (int i=0;i<topics.length;++i) {
			buff.append("   <" + Topic.NAME); //$NON-NLS-1$
			if (topics[i].getLabel() != null) {
				buff.append("\n         " + Topic.ATTRIBUTE_LABEL + "=\"" + topics[i].getLabel() + '"'); //$NON-NLS-1$ //$NON-NLS-2$
			}
			if (topics[i].getHref() != null) {
				buff.append("\n         " + Topic.ATTRIBUTE_HREF + "=\"" + topics[i].getHref() + '"'); //$NON-NLS-1$ //$NON-NLS-2$
			}
			buff.append(">   </" + Topic.NAME + ">\n"); //$NON-NLS-1$ //$NON-NLS-2$
		}
		buff.append("</" + Context.NAME + ">\n"); //$NON-NLS-1$ //$NON-NLS-2$
		return buff.toString();
	}
}

Lines 1-5 Link Here

(-)src/org/eclipse/help/internal/webapp/servlet/ExtensionServlet.java (-2 / +8 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2007 IBM Corporation and others.	2	* Copyright (c) 2007, 2011 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 7-12 Link Here
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.help.internal.webapp.servlet;	12	package org.eclipse.help.internal.webapp.servlet;
12		13
Lines 39-44 Link Here
39		40
40	protected void doGet(HttpServletRequest req, HttpServletResponse resp)	41	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
41	throws ServletException, IOException {	42	throws ServletException, IOException {
		43	resp.getWriter().write(processRequest(req, resp));
		44	}
		45
		46	protected String processRequest(HttpServletRequest req, HttpServletResponse resp)
		47	throws ServletException, IOException {
42	String locale = UrlUtil.getLocale(req, resp);	48	String locale = UrlUtil.getLocale(req, resp);
43	req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$	49	req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
44	resp.setContentType("application/xml; charset=UTF-8"); //$NON-NLS-1$	50	resp.setContentType("application/xml; charset=UTF-8"); //$NON-NLS-1$
Lines 57-63 Link Here
57	}	63	}
58	responseByLocale.put(locale, response);	64	responseByLocale.put(locale, response);
59	}	65	}
60	resp.getWriter().write(response);	66	return response;
61	}	67	}
62		68
63	private String serialize(ContentExtension[] extensions) throws TransformerException {	69	private String serialize(ContentExtension[] extensions) throws TransformerException {

Lines 1-5 Link Here

(-)src/org/eclipse/help/internal/webapp/servlet/IndexFragmentServlet.java (-2 / +9 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2007, 2010 IBM Corporation and others.	2	* Copyright (c) 2007, 2011 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 7-12 Link Here
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.help.internal.webapp.servlet;	12	package org.eclipse.help.internal.webapp.servlet;
12		13
Lines 68-73 Link Here
68		69
69	protected void doGet(HttpServletRequest req, HttpServletResponse resp)	70	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
70	throws ServletException, IOException {	71	throws ServletException, IOException {
		72	resp.getWriter().write(processRequest(req, resp));
		73	}
		74
		75	protected String processRequest(HttpServletRequest req, HttpServletResponse resp)
		76	throws ServletException, IOException {
71	String locale = UrlUtil.getLocale(req, resp);	77	String locale = UrlUtil.getLocale(req, resp);
72	startParameter = req.getParameter("start"); //$NON-NLS-1$	78	startParameter = req.getParameter("start"); //$NON-NLS-1$
73	if (startParameter != null) {	79	if (startParameter != null) {
Lines 112-118 Link Here
112	Serializer serializer = new Serializer(locale, scope);	118	Serializer serializer = new Serializer(locale, scope);
113	String response = serializer.generateIndexXml();	119	String response = serializer.generateIndexXml();
114	locale2Response.put(locale, response);	120	locale2Response.put(locale, response);
115	resp.getWriter().write(response);	121
		122	return response;
116	}	123	}
117		124
118	/*	125	/*

Lines 1-5 Link Here

(-)src/org/eclipse/help/internal/webapp/servlet/IndexServlet.java (-2 / +9 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2000, 2009 IBM Corporation and others.	2	* Copyright (c) 2000, 2011 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 7-12 Link Here
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.help.internal.webapp.servlet;	12	package org.eclipse.help.internal.webapp.servlet;
12		13
Lines 44-49 Link Here
44		45
45	protected void doGet(HttpServletRequest req, HttpServletResponse resp)	46	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
46	throws ServletException, IOException {	47	throws ServletException, IOException {
		48	resp.getWriter().write(processRequest(req, resp));
		49	}
		50
		51	protected String processRequest(HttpServletRequest req, HttpServletResponse resp)
		52	throws ServletException, IOException {
47	BaseHelpSystem.checkMode();	53	BaseHelpSystem.checkMode();
48	String locale = UrlUtil.getLocale(req, resp);	54	String locale = UrlUtil.getLocale(req, resp);
49	req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$	55	req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
Lines 63-69 Link Here
63	}	69	}
64	responseByLocale.put(locale, response);	70	responseByLocale.put(locale, response);
65	}	71	}
66	resp.getWriter().write(response);	72
		73	return (response != null) ? response : ""; //$NON-NLS-1$
67	}	74	}
68		75
69	public String serialize(IndexContribution[] contributions, String locale) throws TransformerException {	76	public String serialize(IndexContribution[] contributions, String locale) throws TransformerException {




/*******************************************************************************
 * Copyright (c) 2000, 2011 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

 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.servlet;


import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import javax.servlet.ServletException;

import org.eclipse.help.internal.search.ISearchHitCollector;
import org.eclipse.help.internal.search.ISearchQuery;
import org.eclipse.help.internal.search.QueryTooComplexException;
import org.eclipse.help.internal.search.SearchHit;
import org.eclipse.help.internal.search.SearchQuery;
import org.eclipse.help.internal.util.URLCoder;
import org.eclipse.help.internal.webapp.data.UrlUtil;
import org.eclipse.help.internal.webapp.utils.SearchXMLGenerator;

/*
 * Returns the search hits for the query provided in the phrase parameter.

	
	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		String response = processRequest(req, resp);
		if ("".equals(response)) //$NON-NLS-1$
			resp.sendError(400); // bad request; missing parameter
		else
			resp.getWriter().write(response);
	}
	
	protected String processRequest(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		BaseHelpSystem.checkMode();
		HitCollector collector = new HitCollector();
		String locale = UrlUtil.getLocale(req, resp);
		req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
		resp.setContentType("application/xml; charset=UTF-8"); //$NON-NLS-1$
		String phrase = req.getParameter(PARAMETER_PHRASE);
		if (phrase != null) {
		    phrase = URLCoder.decode(phrase);
			ISearchQuery query = new SearchQuery(phrase, false, Collections.EMPTY_LIST, locale);
			collector.results.clear();
			BaseHelpSystem.getSearchManager().search(query, collector, new NullProgressMonitor());
			if (searchException == null) {
				return serialize(collector.results);
				resp.getWriter().write(response);
				return;
			}
		}
		return ""; //$NON-NLS-1$
		resp.sendError(400); // bad request; missing parameter

	}
	
	public static String serialize(Collection results) {
		return SearchXMLGenerator.serialize(results);
		buf.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"); //$NON-NLS-1$
		buf.append("<searchHits>\n"); //$NON-NLS-1$
		Iterator iter = results.iterator();
		while (iter.hasNext()) {
			SearchHit hit = (SearchHit)iter.next();
			serialize(hit, buf, "   "); //$NON-NLS-1$
		}
		buf.append("</searchHits>\n"); //$NON-NLS-1$
		return buf.toString();
	}
	
	private static void serialize(SearchHit hit, StringBuffer buf, String indent) {
		buf.append(indent + "<hit"); //$NON-NLS-1$
		if (hit.getHref() != null) {
			buf.append('\n' + indent	+ "      href=\"" + XMLGenerator.xmlEscape(hit.getHref()) + '"'); //$NON-NLS-1$
		}
		if (hit.getLabel() != null) {
			buf.append('\n' + indent	+ "      label=\"" + XMLGenerator.xmlEscape(hit.getLabel()) + '"'); //$NON-NLS-1$
		}
		if (hit.isPotentialHit()) {
			buf.append('\n' + indent	+ "      isPotentialHit=\"true\""); //$NON-NLS-1$
		}
		buf.append('\n' + indent + "      score=\"" + hit.getScore() + '"'); //$NON-NLS-1$
		buf.append(">\n"); //$NON-NLS-1$
		
		String summary = hit.getSummary();
		if (summary != null) {
			serialize(summary, buf, indent + "   "); //$NON-NLS-1$
		}
		buf.append(indent + "</hit>\n"); //$NON-NLS-1$
	}

	private static void serialize(String summary, StringBuffer buf, String indent) {
		buf.append(indent + "<summary>"); //$NON-NLS-1$
		buf.append(XMLGenerator.xmlEscape(summary));
		buf.append("</summary>\n"); //$NON-NLS-1$
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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.webapp.servlet;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.List;
import java.util.Locale;

import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.Platform;
import org.eclipse.help.internal.webapp.HelpWebappPlugin;
import org.eclipse.help.internal.webapp.WebappResources;
import org.eclipse.help.internal.webapp.data.UrlUtil;

/*
 * Class is responsible for implementing security protection.  All servlets
 * who use the org.eclipse.help.webapp.secureServlet extension point will
 * will be processed for security failures by this class.
 *
 */
public class SecureServlet extends HttpServlet {

	private static final long serialVersionUID = -3783758607845176051L;
	private Hashtable servletTable = new Hashtable();
	
	protected void process(HttpServletRequest req, HttpServletResponse resp)
		throws ServletException, IOException{

		String baseURL = req.getRequestURL().toString();		
		baseURL = baseURL.substring(0, baseURL.indexOf(req.getServletPath()));
		
		Locale locale = UrlUtil.getLocaleObj(req,resp);

		String service = req.getRequestURL().toString().substring(
				(baseURL).length()+("/ss".length())); //$NON-NLS-1$
		
		try {
			HttpServletResponseAdv response = new HttpServletResponseAdv(resp);
			
			HttpServlet servlet = getServlet(service);
			ServletConfig config = getServletConfig();
			servlet.init(config);
			servlet.service(req, response);
			
			if (isSecure(req, response))
				response.commitOutput();
			
		} catch(Exception ex) {
			
			String errorMsg = WebappResources.getString("cantCreateServlet", //$NON-NLS-1$
					locale, service);
			HelpWebappPlugin.logError(errorMsg, ex);
			
			PrintWriter writer = resp.getWriter();
			writer.println(errorMsg);
			ex.printStackTrace(writer);
			
			resp.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
		}
	}
	
	private HttpServlet getServlet(String name) throws CoreException
	{
		HttpServlet servlet = (HttpServlet)servletTable.get(name);
		
		if (servlet==null)
		{
			IConfigurationElement[] configs = 
				Platform.getExtensionRegistry().getConfigurationElementsFor(HelpWebappPlugin.PLUGIN_ID+".secureServlet"); //$NON-NLS-1$
			
			for (int c=0;c<configs.length;c++)
			{
				String alias = configs[c].getAttribute("alias"); //$NON-NLS-1$
				if (alias!=null)
				{
					if (isMatch(alias,name))
					{
						servlet = (HttpServlet)configs[c].createExecutableExtension("class"); //$NON-NLS-1$
						servletTable.put(name, servlet);
					}
				}
			}
		}
		return servlet;
		
	}
	
	private boolean isMatch(String alias,String name)
	{
		if (alias.indexOf("*")>-1) //$NON-NLS-1$
			alias = replaceAll(alias,'*',".*"); //$NON-NLS-1$
		
		alias+=".*"; //$NON-NLS-1$
		
		return name.matches(alias);
	}

	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		process(req,resp);
	}
	
	protected void doPost(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		process(req,resp);
	}
	
	public boolean isSecure(HttpServletRequest req,HttpServletResponseAdv resp) throws SecurityException
	{
		Enumeration names = req.getParameterNames();
		List values = new ArrayList();
		List scripts = new ArrayList();
		
		while (names.hasMoreElements())
		{
			String name = (String)names.nextElement();
			String val = req.getParameter(name);
			values.add(val);
			if (replaceAll(val,'+',"").indexOf("<script")>-1) //$NON-NLS-1$ //$NON-NLS-2$
				scripts.add(val);
		}
		
		if(resp.getWriter()!=null)
		{
			String data = resp.getString();
			for (int s=0;s<scripts.size();s++)
				if (data.indexOf((String)scripts.get(s))>-1)
					throw new SecurityException("Potential cross-site scripting detected."); //$NON-NLS-1$
		}
		
		return true;
	}

	public void isScript(List params,OutputStream out)
	{
//		ByteArrayOutputStream bOut = new ByteArrayOutputStream(out);
	}

	
	public String replaceAll(String str,char remove,String add)
	{
		StringBuffer buffer = new StringBuffer();
		for (int s=0;s<str.length();s++)
		{
			if (str.charAt(s)==remove)
				buffer.append(add);
			else
				buffer.append(str.charAt(s));
		}
		return buffer.toString();
	}
	
	private class HttpServletResponseAdv extends HttpServletResponseWrapper
	{
		private HttpServletResponse response;
		private ByteArrayOutputStream out;
		private ServletPrintWriter writer;
		private SecureServletOutputStream stream;
		
		public HttpServletResponseAdv(HttpServletResponse response) {
			super(response);
			out = new ByteArrayOutputStream();
			this.response = response;
		}

		public PrintWriter getWriter()
		{
			if (writer==null && stream==null)
				writer = new ServletPrintWriter();
			return writer;
		}
		
		public ServletOutputStream getOutputStream()
		{
			if (stream==null && writer==null)
				stream = new SecureServletOutputStream(out);
			return stream;
		}
		
		public void commitOutput() throws IOException
		{
			OutputStream os = response.getOutputStream();
			InputStream is = getInputStream();
			
			int read;
			byte buffer[] = new byte[1024*8*8];
			
			while ((read = is.read(buffer))>-1)
				os.write(buffer,0,read);
			
			os.flush();
		}
		
		public InputStream getInputStream()
		{
			if (stream!=null)
			{
				try {
						out.flush();
				} catch (IOException e) {
					e.printStackTrace();
				}
				return new ByteArrayInputStream(out.toByteArray());
			}
			if (writer!=null)
			{
				try {
					return new ByteArrayInputStream(writer.toString().getBytes(getCharacterEncoding()));
				} catch (UnsupportedEncodingException e) {
					// TODO Auto-generated catch block
					e.printStackTrace();
				}
			}
			return null;
		}
		
		public String getString()
		{
			if (writer!=null)
				return writer.toString();
			
			return null;
		}
	}
	
	
	private class SecureServletOutputStream extends ServletOutputStream{

		private OutputStream out;

		public SecureServletOutputStream(OutputStream out)
		{
			this.out = out;
		}
		
		public void write(int b) throws IOException {
			out.write(b);
		}
		
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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.webapp.servlet;

import java.io.ByteArrayOutputStream;
import java.io.PrintWriter;

public class ServletPrintWriter extends PrintWriter{

	private StringBuffer buffer;
	
	public ServletPrintWriter() {
		super(new ByteArrayOutputStream());
		buffer = new StringBuffer();
	}
	
    /**
     * Writes a single character.
     * @param c int specifying a character to be written.
     */
    public void write(int c) {
	    synchronized (lock) {
	    	buffer.append((char)(c));
	    }
    }

    /**
     * Writes A Portion of an array of characters.
     * @param buf Array of characters
     * @param off Offset from which to start writing characters
     * @param len Number of characters to write
     */
    public void write(char buf[], int off, int len) {
	    synchronized (lock) {
	    	buffer.append(buf, off, len);
	    }
    }

    /**
     * Writes an array of characters.  This method cannot be inherited from the
     * Writer class because it must suppress I/O exceptions.
     * @param buf Array of characters to be written
     */
    public void write(char buf[]) {
    	write(buf, 0, buf.length);
    }

    /**
     * Writes a portion of a string.
     * @param s A String
     * @param off Offset from which to start writing characters
     * @param len Number of characters to write
     */
    public void write(String s, int off, int len) {
	    synchronized (lock) {
	    	buffer.append(s.toCharArray(), off, off+len);
	    }
    }

    /**
     * Writes a string.  This method cannot be inherited from the Writer class
     * because it must suppress I/O exceptions.
     * @param s String to be written
     */
    public void write(String s) {
	write(s, 0, s.length());
    }
	
    public String toString()
    {
    	return buffer.toString();
    }
}

Lines 1-5 Link Here

(-)src/org/eclipse/help/internal/webapp/servlet/TocFragmentServlet.java (-2 / +9 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2006, 2010 IBM Corporation and others.	2	* Copyright (c) 2006, 2011 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 7-12 Link Here
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.help.internal.webapp.servlet;	12	package org.eclipse.help.internal.webapp.servlet;
12		13
Lines 46-51 Link Here
46		47
47	protected void doGet(HttpServletRequest req, HttpServletResponse resp)	48	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
48	throws ServletException, IOException {	49	throws ServletException, IOException {
		50	resp.getWriter().write(processRequest(req, resp));
		51	}
		52
		53	protected String processRequest(HttpServletRequest req, HttpServletResponse resp)
		54	throws ServletException, IOException {
49	String locale = UrlUtil.getLocale(req, resp);	55	String locale = UrlUtil.getLocale(req, resp);
50	req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$	56	req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
51	resp.setContentType("application/xml; charset=UTF-8"); //$NON-NLS-1$	57	resp.setContentType("application/xml; charset=UTF-8"); //$NON-NLS-1$
Lines 60-66 Link Here
60	Serializer serializer = new Serializer(data, req.getLocale(), scope);	66	Serializer serializer = new Serializer(data, req.getLocale(), scope);
61	String response = serializer.generateTreeXml();	67	String response = serializer.generateTreeXml();
62	locale2Response.put(locale, response);	68	locale2Response.put(locale, response);
63	resp.getWriter().write(response);	69
		70	return response;
64	}	71	}
65		72
66	private void readParameters(HttpServletRequest req) {	73	private void readParameters(HttpServletRequest req) {

Lines 1-5 Link Here

(-)src/org/eclipse/help/internal/webapp/servlet/TocServlet.java (-2 / +9 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2000, 2009 IBM Corporation and others.	2	* Copyright (c) 2000, 2011 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 7-12 Link Here
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.help.internal.webapp.servlet;	12	package org.eclipse.help.internal.webapp.servlet;
12		13
Lines 44-49 Link Here
44		45
45	protected void doGet(HttpServletRequest req, HttpServletResponse resp)	46	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
46	throws ServletException, IOException {	47	throws ServletException, IOException {
		48	resp.getWriter().write(processRequest(req, resp));
		49	}
		50
		51	protected String processRequest(HttpServletRequest req, HttpServletResponse resp)
		52	throws ServletException, IOException {
47	BaseHelpSystem.checkMode();	53	BaseHelpSystem.checkMode();
48	String locale = UrlUtil.getLocale(req, resp);	54	String locale = UrlUtil.getLocale(req, resp);
49	req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$	55	req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
Lines 63-69 Link Here
63	}	69	}
64	responseByLocale.put(locale, response);	70	responseByLocale.put(locale, response);
65	}	71	}
66	resp.getWriter().write(response);	72
		73	return (response != null) ? response : ""; //$NON-NLS-1$
67	}	74	}
68		75
69	protected String serialize(TocContribution[] contributions, String locale) throws TransformerException {	76	protected String serialize(TocContribution[] contributions, String locale) throws TransformerException {




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.utils;

public final class JSonHelper {
	
	//JSON Characters
	public static final String BEGIN_BRACE = "{"; //$NON-NLS-1$
	public static final String END_BRACE  = "}"; //$NON-NLS-1$
	public static final String QUOTE  = "\'"; //$NON-NLS-1$
	public static final String COLON  = ":"; //$NON-NLS-1$
	public static final String BEGIN_BRACKET  = "["; //$NON-NLS-1$
	public static final String END_BRACKET  =   "]"; //$NON-NLS-1$
	public static final String COMMA  =   ","; //$NON-NLS-1$
	public static final String NEWLINE  =   "\n"; //$NON-NLS-1$
	public static final String SPACE  =   "   "; //$NON-NLS-1$
	
	//JSON items
	public static final String LABEL			= "label"; //$NON-NLS-1$
	public static final String IDENTIFIER		= "identifier"; //$NON-NLS-1$
	public static final String URL				= "url"; //$NON-NLS-1$
	public static final String PROVIDER			= "provider"; //$NON-NLS-1$
	public static final String ITEMS			= "items"; //$NON-NLS-1$
	public static final String NAME				= "name"; //$NON-NLS-1$
	public static final String TITLE			= "title"; //$NON-NLS-1$
	public static final String ID				= "id"; //$NON-NLS-1$
	public static final String HREF				= "href"; //$NON-NLS-1$
	public static final String TYPE				= "type"; //$NON-NLS-1$
	public static final String CHECKED			= "checked"; //$NON-NLS-1$
	public static final String CHILDREN			= "children"; //$NON-NLS-1$
	public static final String REFERENCE		= "_reference"; //$NON-NLS-1$
	public static final String IS_LEAF			= "is_leaf"; //$NON-NLS-1$
	public static final String IS_SELECTED		= "is_selected"; //$NON-NLS-1$
	public static final String IS_HIGHLIGHTED	= "is_highlighted"; //$NON-NLS-1$
	public static final String TOC				= "toc"; //$NON-NLS-1$
	public static final String PATH				= "path"; //$NON-NLS-1$
	public static final String CATEGORY			= "category"; //$NON-NLS-1$
	public static final String DESCRIPTION		= "description"; //$NON-NLS-1$
	public static final String CATEGORY_HREF	= CATEGORY+"_"+HREF; //$NON-NLS-1$
	public static final String PROPERTY_NAME	= "propertyName"; //$NON-NLS-1$
	public static final String INDEX			= "Index"; //$NON-NLS-1$
	public static final String TOPIC			= "Topic"; //$NON-NLS-1$
	
	public static String getQuotes(String str){
		return ((str != null)?QUOTE + str + QUOTE:""); //$NON-NLS-1$
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.utils;

import java.util.Collection;

import org.eclipse.help.HelpSystem;
import org.eclipse.help.IHelpResource;
import org.eclipse.help.IToc;
import org.eclipse.help.ITopic;
import org.eclipse.help.internal.search.SearchHit;
import org.eclipse.help.internal.webapp.data.UrlUtil;
import org.eclipse.help.internal.webapp.servlet.XMLGenerator;

public class SearchXMLGenerator  {

	public static String serialize(Collection results) {
		return serialize((results != null) ? results.toArray() : null, false);
	}
	
	public static String serialize(Object[] hits, boolean boolIsCategory) {
		StringBuffer buf = new StringBuffer();
		buf.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"); //$NON-NLS-1$
		buf.append("<searchHits>\n"); //$NON-NLS-1$
		
		if (hits != null) {
			for (int i = 0; i < hits.length; i++) {
				SearchHit hit = (SearchHit) hits[i];
				serialize(hit, buf, "   ", boolIsCategory); //$NON-NLS-1$
			}
		}
		
		buf.append("</searchHits>\n"); //$NON-NLS-1$
		
		return buf.toString();
	}
	
	private static void serialize(SearchHit hit, StringBuffer buf, 
			String indent, boolean boolIsCategory) {
		buf.append(indent + "<hit"); //$NON-NLS-1$
		if (hit.getHref() != null) {
			buf.append('\n' + indent	+ "      href=\"" + XMLGenerator.xmlEscape(hit.getHref()) + '"'); //$NON-NLS-1$
		}
		if (hit.getLabel() != null) {
			buf.append('\n' + indent	+ "      label=\"" + XMLGenerator.xmlEscape(hit.getLabel()) + '"'); //$NON-NLS-1$
		}
		if (hit.isPotentialHit()) {
			buf.append('\n' + indent	+ "      isPotentialHit=\"true\""); //$NON-NLS-1$
		}
		buf.append('\n' + indent + "      score=\"" + hit.getScore() + '"'); //$NON-NLS-1$
		buf.append(">\n"); //$NON-NLS-1$
		
		// get Category
		if (boolIsCategory) {
			IHelpResource categoryResource = hit.getCategory();
			if (categoryResource != null) {
				serializeCategory(categoryResource, buf, indent + "  "); //$NON-NLS-1$
			}
		}
		
		// get Summary/Description
		String summary = hit.getSummary();
		if (summary != null) {
			serialize(summary, buf, indent + "   "); //$NON-NLS-1$
		}
		buf.append(indent + "</hit>\n"); //$NON-NLS-1$
	}

	private static void serialize(String summary, StringBuffer buf, String indent) {
		buf.append(indent + "<summary>"); //$NON-NLS-1$
		buf.append(XMLGenerator.xmlEscape(summary));
		buf.append("</summary>\n"); //$NON-NLS-1$
	}
	
	private static void serializeCategory(IHelpResource categoryResource, 
			StringBuffer buf, String indent) {
		String category = categoryResource.getLabel();
		if (category == null) return;
		
		buf.append(indent + "<category"); //$NON-NLS-1$
		
		String catHref = getCategoryHref(categoryResource);
		if (catHref != null) {
			buf.append('\n' + indent	+ "      href=\""  //$NON-NLS-1$
					+ XMLGenerator.xmlEscape(catHref) + '"');
		}
		
		buf.append(">\n"); //$NON-NLS-1$
		buf.append(XMLGenerator.xmlEscape(category));
		
		buf.append("</category>\n"); //$NON-NLS-1$
	}
	
	private static String getCategoryHref(IHelpResource categoryResource) {
		String tocHref = categoryResource.getHref();
		IToc[] tocs = HelpSystem.getTocs();
		for (int j=0;j<tocs.length;++j) {
			if (tocHref.equals(tocs[j].getHref())) {
				ITopic topic = tocs[j].getTopic(null);
				String topicHref = topic.getHref();
				if (topicHref != null) {
					return UrlUtil.getHelpURL(topicHref);
				}
				return "../nav/" + j; //$NON-NLS-1$
			}
		}
		return null;
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.utils;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.StringWriter;
import java.io.Writer;

public class Utils {

	public static final String RETURN_TYPE 			= "returnType"; //$NON-NLS-1$
	public static final String NO_CATEGORY 			= "noCategory"; //$NON-NLS-1$

	// returnType values: xml (default) | json
	public static final String XML 					= "xml"; //$NON-NLS-1$
	public static final String JSON 				= "json"; //$NON-NLS-1$
	
	public static String convertStreamToString(InputStream is)
			throws IOException {
		if (is != null) {
			Writer writer = new StringWriter();
			char[] buffer = new char[1024];
			try {
				Reader reader = new BufferedReader(
						new InputStreamReader(is, "UTF-8")); //$NON-NLS-1$
				int n;
				while ((n = reader.read(buffer)) != -1) {
					writer.write(buffer, 0, n);
				}
			} finally {
				is.close();
			}
			return writer.toString();
		} else {
			return ""; //$NON-NLS-1$
		}
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.help.internal.webapp.utils;

public final class XMLHelper {

	public static final String SESSION_URL				= "helpURL"; //$NON-NLS-1$
	
	public static final String URL36_PREFIX				= "/advanced"; //$NON-NLS-1$
	public static final String TOC_URL					= "/tocfragment"; //$NON-NLS-1$
	public static final String SEARCH_URL				= "/search"; //$NON-NLS-1$
	
	public static final String ATTR_TITLE				= "title"; //$NON-NLS-1$
	public static final String ATTR_ID					= "id"; //$NON-NLS-1$
	public static final String ATTR_HREF				= "href"; //$NON-NLS-1$
	public static final String ATTR_IMAGE				= "image"; //$NON-NLS-1$
	public static final String ATTR_LABEL				= "label"; //$NON-NLS-1$
	public static final String ATTR_SCORE				= "score"; //$NON-NLS-1$
	public static final String ATTR_LOCALE				= "locale"; //$NON-NLS-1$
	public static final String ATTR_KEYWORD				= "keyword"; //$NON-NLS-1$
	
	public static final String ELEMENT_NODE				= "node"; //$NON-NLS-1$
	public static final String ELEMENT_HIT				= "hit"; //$NON-NLS-1$
	public static final String ELEMENT_HITS				= "searchHits"; //$NON-NLS-1$
	public static final String ELEMENT_CATEGORY			= "category"; //$NON-NLS-1$
	public static final String ELEMENT_SUMMARY			= "summary"; //$NON-NLS-1$
	public static final String ELEMENT_DESCRIPTION		= "description"; //$NON-NLS-1$
	public static final String ELEMENT_INDEX			= "index"; //$NON-NLS-1$
	public static final String ELEMENT_INDEX_CONTRIBUTIONS	= "indexContributions"; //$NON-NLS-1$
	public static final String ELEMENT_TOC_CONTRIBUTIONS	= "tocContributions"; //$NON-NLS-1$
	
	public static final String CATEGORY_HREF			= "categoryHref"; //$NON-NLS-1$
}




 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.remote;


		}
	}

	protected Element[] getContextsFromServlet(String phrase)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/context?id=" + URLEncoder.encode(phrase, "UTF-8"));
		return makeServletCall(url);
	}
	
	protected Element[] getContextsUsingLocale(String phrase, String locale)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/context?id="

		return makeServletCall(url);
	}

	protected Element[] makeServletCall(URL url) throws IOException,
			ParserConfigurationException, FactoryConfigurationError,
			SAXException {
		InputStream is = url.openStream();

Lines 7-12 Link Here

(-)help/org/eclipse/ua/tests/help/remote/IndexServletTest.java (-1 / +2 lines)
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.ua.tests.help.remote;	12	package org.eclipse.ua.tests.help.remote;
12		13
Lines 146-152 Link Here
146	}	147	}
147	}	148	}
148		149
149	private Node getIndexContributions( String locale)	150	protected Node getIndexContributions( String locale)
150	throws Exception {	151	throws Exception {
151	int port = WebappManager.getPort();	152	int port = WebappManager.getPort();
152	URL url = new URL("http", "localhost", port, "/help/index?lang=" + locale);	153	URL url = new URL("http", "localhost", port, "/help/index?lang=" + locale);




 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.remote;


		assertEquals(0, hits.length);
	}

	protected Node[] getSearchHitsFromServlet(String phrase)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/search?phrase=" + URLEncoder.encode(phrase, "UTF-8"));
		return makeServletCall(url);
	}
	
	protected Node[] getSearchHitsUsingLocale(String phrase, String locale)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/search?phrase="

		return makeServletCall(url);
	}

	protected Node[] makeServletCall(URL url) throws IOException,
			ParserConfigurationException, FactoryConfigurationError,
			SAXException {
		InputStream is = url.openStream();

Lines 7-12 Link Here

(-)help/org/eclipse/ua/tests/help/remote/TocServletTest.java (-1 / +2 lines)
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.ua.tests.help.remote;	12	package org.eclipse.ua.tests.help.remote;
12		13
Lines 110-116 Link Here
110	}	111	}
111		112
112		113
113	private Node getTocContributions( String locale)	114	protected Node getTocContributions( String locale)
114	throws Exception {	115	throws Exception {
115	int port = WebappManager.getPort();	116	int port = WebappManager.getPort();
116	URL url = new URL("http", "localhost", port, "/help/toc?lang=" + locale);	117	URL url = new URL("http", "localhost", port, "/help/toc?lang=" + locale);




/*******************************************************************************
 * Copyright (c) 2011 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.ua.tests.help.util;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.URL;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.MultiStatus;
import org.eclipse.core.runtime.Status;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;


public class ServletTester {

	// dtd validation
	// argument processing / validation
	// invalid args dont workit
	
	public static String callTextServlet(URL url) throws IOException
	{
		BufferedReader br = new BufferedReader(new InputStreamReader(url.openStream()));

		String res="";
		String line;
		while ((line = br.readLine())!=null)
			res+=line+'\n';
		
		br.close();
		
		return res;
	}
	
	public static boolean isXML(URL url) throws IOException
	{
		return callTextServlet(url).startsWith("<?xml");
//		return siteContains(url,"<?xml");
	}
	
	public static boolean siteContains(URL url,String str) throws IOException
	{
		return (callTextServlet(url).indexOf(str) > -1);
	}
	
	public static boolean isDTDValidated(URL url) throws Exception
	{
		DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
		factory.setValidating(true);
		
		DocumentBuilder builder = factory.newDocumentBuilder();
		
		DTDErrorHandler handler = new DTDErrorHandler();
		builder.setErrorHandler(handler);
		builder.parse(url.toString());
		
		return handler.getStatus().getSeverity()!=IStatus.ERROR;
	}
	
	
	private static class DTDErrorHandler implements ErrorHandler
	{
		private MultiStatus status = null;
		
		public void warning(SAXParseException exception) throws SAXException {
			if (status==null)
				status = new MultiStatus("org.eclipse.ua.tests",IStatus.WARNING,"DTD Processing Warning",exception);
			else
			{
				IStatus tmp = new Status(IStatus.WARNING,"org.eclipse.ua.tests","DTD Processing Warning",exception);
				status.add(tmp);
			}
		}

		public void error(SAXParseException exception) throws SAXException {
			if (status==null)
				status = new MultiStatus("org.eclipse.ua.tests",IStatus.ERROR,"DTD Processing Error",exception);
			else
			{
				IStatus tmp = new Status(IStatus.ERROR,"org.eclipse.ua.tests","DTD Processing Error",exception);
				status.add(tmp);
			}
		}

		public void fatalError(SAXParseException exception) throws SAXException {
			error(exception);
		}
		
		public IStatus getStatus()
		{
			if (status==null)
				return Status.OK_STATUS;
			return status;
		}
		
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.webapp.service;

import junit.framework.Test;
import junit.framework.TestSuite;

/*
 * Tests utility classes and servlets used in Web Application
 */
public class AllWebappServiceTests extends TestSuite {

	/*
	 * Returns the entire test suite.
	 */
	public static Test suite() {
		TestSuite suite = new TestSuite(
				"org.eclipse.ua.tests.help.AllWebappServiceTests");
		//$JUnit-BEGIN$
		suite.addTestSuite(ContentServiceTest.class);
		suite.addTestSuite(ContextServiceTest.class);
		suite.addTestSuite(IndexFragmentServiceTest.class);
		suite.addTestSuite(IndexServiceTest.class);
		suite.addTestSuite(SearchServiceTest.class);
		suite.addTestSuite(SimpleSearchServiceTest.class);
		suite.addTestSuite(TocFragmentServiceTest.class);
		suite.addTestSuite(TocServiceTest.class);
		//$JUnit-END$
		return suite;
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.webapp.service;

import java.io.IOException;

import org.eclipse.ua.tests.help.remote.ContentServletTest;

public class ContentServiceTest extends ContentServletTest {

	private static final String UA_TESTS = "org.eclipse.ua.tests";

	public void testSimpleContent() throws Exception {
		final String path = "/data/help/index/topic1.html";
		String remoteContent = ServicesTestUtils.getRemoteContent(UA_TESTS, path, "en");
		String localContent = ServicesTestUtils.getLocalContent(UA_TESTS, path);	   
	    assertEquals(remoteContent, localContent);
	}

	public void testFilteredContent() throws Exception {
		final String path = "/data/help/manual/filter.xhtml";
		String remoteContent = ServicesTestUtils.getRemoteContent(UA_TESTS, path, "en");
		String localContent = ServicesTestUtils.getLocalContent(UA_TESTS, path);	   
	    assertEquals(remoteContent, localContent);
	}

	public void testContentInEnLocale() throws Exception {
		final String path = "/data/help/search/testnl1.xhtml";
		String remoteContent = ServicesTestUtils.getRemoteContent(UA_TESTS, path, "en");
		String localContent = ServicesTestUtils.getLocalContent(UA_TESTS, path);	   
	    assertEquals(remoteContent, localContent);
	}
	
	public void testContentInDeLocale() throws Exception {
		final String path = "/data/help/search/testnl1.xhtml";
		String remoteContent = ServicesTestUtils.getRemoteContent(UA_TESTS, path, "de");
		String enLocalContent = ServicesTestUtils.getLocalContent(UA_TESTS, path);	   
		String deLocalContent = ServicesTestUtils.getLocalContent(UA_TESTS, "/nl/de" + path);	   
	    assertEquals(remoteContent, deLocalContent);
	    assertFalse(remoteContent.equals(enLocalContent));
	}
	
	public void testRemoteContentNotFound() throws Exception {
		try {
			ServicesTestUtils.getRemoteContent(UA_TESTS, "/no/such/path.html", "en");
			fail("No exception thrown");
		} catch (IOException e) {
			// Exception caught as expected
		}	
	}

	
	
}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.webapp.service;

import java.net.URL;
import java.net.URLEncoder;

import org.eclipse.help.internal.server.WebappManager;
import org.eclipse.ua.tests.help.remote.ContextServletTest;
import org.w3c.dom.Element;

public class ContextServiceTest extends ContextServletTest {

	protected Element[] getContextsFromServlet(String phrase)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/context?id=" 
				+ URLEncoder.encode(phrase, "UTF-8"));
		return makeServletCall(url);
	}
	
	protected Element[] getContextsUsingLocale(String phrase, String locale)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/context?id="
				+ URLEncoder.encode(phrase, "UTF-8") + "&lang=" + locale);
		return makeServletCall(url);
	}

	public void testContextServiceXMLSchema() 
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/context?id=org.eclipse.ua.tests.test_cheatsheets&lang=en");
		URL schemaUrl = new URL("http", "localhost", port, "/help/test/schema/xml/context.xsd");
		String schema = schemaUrl.toString();
		String uri = url.toString();
		String result = SchemaValidator.testXMLSchema(uri, schema);
		
		assertEquals("URL: \"" + uri + "\" is ", "valid", result);
	}

	public void testContextServiceJSONSchema() 
			throws Exception {
//		fail("Not yet implemented.");
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.webapp.service;


import java.io.InputStream;
import java.net.URL;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import junit.framework.TestCase;

import org.eclipse.help.internal.base.BaseHelpSystem;
import org.eclipse.help.internal.entityresolver.LocalEntityResolver;
import org.eclipse.help.internal.server.WebappManager;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.InputSource;

public class IndexFragmentServiceTest extends TestCase {

	private int mode;

	protected void setUp() throws Exception {
		BaseHelpSystem.ensureWebappRunning();
		mode = BaseHelpSystem.getMode();
		BaseHelpSystem.setMode(BaseHelpSystem.MODE_INFOCENTER);
	}
	
	protected void tearDown() throws Exception {
		BaseHelpSystem.setMode(mode);
	}

	public void testIndexServletEn() throws Exception {
		getTreeData("en");
	}

	public void testIndexServletDe() throws Exception {
		getTreeData("de");
	}

	private void getTreeData(String locale)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/indexfragment?lang=" + locale);
		InputStream is = url.openStream();
		InputSource inputSource = new InputSource(is);
        DocumentBuilder documentBuilder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
		documentBuilder.setEntityResolver(new LocalEntityResolver());
		Document document = documentBuilder.parse(inputSource);
		Node root = document.getFirstChild();
		is.close();
		assertEquals("tree_data", root.getNodeName());
	}

	public void testIndexFragmentServiceXMLSchema() 
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/indexfragment?lang=en");
		URL schemaUrl = new URL("http", "localhost", port, "/help/test/schema/xml/indexfragment.xsd");
		String schema = schemaUrl.toString();
		String uri = url.toString();
		String result = SchemaValidator.testXMLSchema(uri, schema);
		
		assertEquals("URL: \"" + uri + "\" is ", "valid", result);
	}

	public void testIndexFragmentServiceJSONSchema() 
			throws Exception {
//		fail("Not yet implemented.");
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.webapp.service;

import java.io.InputStream;
import java.net.URL;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import org.eclipse.help.internal.entityresolver.LocalEntityResolver;
import org.eclipse.help.internal.server.WebappManager;
import org.eclipse.ua.tests.help.remote.IndexServletTest;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.InputSource;

public class IndexServiceTest extends IndexServletTest {

	protected Node getIndexContributions( String locale)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/index?lang=" + locale);
		InputStream is = url.openStream();
		InputSource inputSource = new InputSource(is);
        DocumentBuilder documentBuilder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
		documentBuilder.setEntityResolver(new LocalEntityResolver());
		Document document = documentBuilder.parse(inputSource);
		Node root = document.getFirstChild();
		is.close();
		assertEquals("indexContributions", root.getNodeName());
		return root;
	}

	public void testIndexServiceXMLSchema() 
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/index?lang=en");
		URL schemaUrl = new URL("http", "localhost", port, "/help/test/schema/xml/index.xsd");
		String schema = schemaUrl.toString();
		String uri = url.toString();
		String result = SchemaValidator.testXMLSchema(uri, schema);
		
		assertEquals("URL: \"" + uri + "\" is ", "valid", result);
	}

	public void testIndexServiceJSONSchema() 
			throws Exception {
//		fail("Not yet implemented.");
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.webapp.service;

import java.io.File;
import java.net.URL;

import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import javax.xml.validation.Validator;

import org.xml.sax.SAXException;

public class SchemaValidator {

	public static String testXMLSchema(String uri, String schemaFile) {
		String msg = ""; //$NON-NLS-1$
		try {
			SchemaFactory factory = SchemaFactory.newInstance("http://www.w3.org/2001/XMLSchema"); //$NON-NLS-1$
			Schema schema = null;
			if (schemaFile.startsWith("http") || schemaFile.startsWith("ftp"))
				schema = factory.newSchema(new URL(schemaFile));
			else
				schema = factory.newSchema(new File(schemaFile));
			
			Validator validator = schema.newValidator();
			Source source = new StreamSource(uri);
			try {
				validator.validate(source);
				msg = "valid"; //$NON-NLS-1$
			} catch (SAXException ex) {
				msg = "not valid. Details: " + ex.getMessage(); //$NON-NLS-1$
			}
		} catch(Exception e) {
			msg = "Exception e: " + e; //$NON-NLS-1$
		}
		
		System.out.println(msg);
		return msg;
	}
	
	public static String testJSONSchema(String uri, String schemaFile) {
		// TODO: Not yet implemented
		return ""; //$NON-NLS-1$
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.webapp.service;


import java.net.URL;
import java.net.URLEncoder;

import org.eclipse.help.internal.server.WebappManager;
import org.eclipse.ua.tests.help.remote.SearchServletTest;
import org.w3c.dom.Node;

public class SearchServiceTest extends SearchServletTest {

	protected Node[] getSearchHitsFromServlet(String searchWord)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/search?searchWord=" + URLEncoder.encode(searchWord, "UTF-8"));
		return makeServletCall(url);
	}
	
	protected Node[] getSearchHitsUsingLocale(String searchWord, String locale)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/search?searchWord="
				+ URLEncoder.encode(searchWord, "UTF-8") + "&lang=" + locale);
		return makeServletCall(url);
	}

	public void testRemoteSearchXMLSchema() 
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, 
				"/help/ss/service/search?searchWord=" + URLEncoder.encode("jehcyqpfjs vkrhjewiwh", "UTF-8"));
		URL schemaUrl = new URL("http", "localhost", port, "/help/test/schema/xml/search.xsd");
		String schema = schemaUrl.toString();
		String uri = url.toString();
		String result = SchemaValidator.testXMLSchema(uri, schema);
		
		assertEquals("URL: \"" + uri + "\" is ", "valid", result);
	}

	public void testRemoteSearchXMLSchemaExactMatchFound() 
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, 
				"/help/ss/service/search?searchWord=" + URLEncoder.encode("\"jehcyqpfjs vkrhjewiwh\"", "UTF-8"));
		URL schemaUrl = new URL("http", "localhost", port, "/help/test/schema/xml/search.xsd");
		String schema = schemaUrl.toString();
		String uri = url.toString();
		String result = SchemaValidator.testXMLSchema(uri, schema);
		
		assertEquals("URL: \"" + uri + "\" is ", "valid", result);
	}

	public void testRemoteSearchJSONSchema() 
			throws Exception {
//		fail("Not yet implemented.");
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.webapp.service;

import java.net.URL;

import org.eclipse.help.internal.server.WebappManager;
import org.eclipse.ua.tests.help.remote.RemoteTestUtils;

public class ServicesTestUtils extends RemoteTestUtils {

	public static String getRemoteContent(String plugin, String path,
			String locale) throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/rtopic/" + plugin
				+ path + "?lang=" + locale);
		return readFromURL(url);
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.webapp.service;


import java.net.URL;
import java.net.URLEncoder;

import org.eclipse.help.internal.server.WebappManager;
import org.eclipse.ua.tests.help.remote.SearchServletTest;
import org.w3c.dom.Node;

public class SimpleSearchServiceTest extends SearchServletTest {

	protected Node[] getSearchHitsFromServlet(String phrase)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/simplesearch?phrase=" + URLEncoder.encode(phrase, "UTF-8"));
		return makeServletCall(url);
	}
	
	protected Node[] getSearchHitsUsingLocale(String phrase, String locale)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/simplesearch?phrase="
				+ URLEncoder.encode(phrase, "UTF-8") + "&lang=" + locale);
		return makeServletCall(url);
	}

	public void testRemoteSimpleSearchXMLSchema() 
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, 
				"/help/ss/service/simplesearch?phrase=" + URLEncoder.encode("jehcyqpfjs vkrhjewiwh", "UTF-8"));
		URL schemaUrl = new URL("http", "localhost", port, "/help/test/schema/xml/simplesearch.xsd");
		String schema = schemaUrl.toString();
		String uri = url.toString();
		String result = SchemaValidator.testXMLSchema(uri, schema);
		
		assertEquals("URL: \"" + uri + "\" is ", "valid", result);
	}

	public void testRemoteSimpleSearchXMLSchemaExactMatchFound() 
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, 
				"/help/ss/service/simplesearch?phrase=" + URLEncoder.encode("\"jehcyqpfjs vkrhjewiwh\"", "UTF-8"));
		URL schemaUrl = new URL("http", "localhost", port, "/help/test/schema/xml/simplesearch.xsd");
		String schema = schemaUrl.toString();
		String uri = url.toString();
		String result = SchemaValidator.testXMLSchema(uri, schema);
		
		assertEquals("URL: \"" + uri + "\" is ", "valid", result);
	}

	public void testRemoteSimpleSearchJSONSchema() 
			throws Exception {
//		fail("Not yet implemented.");
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.webapp.service;

import java.io.InputStream;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import junit.framework.TestCase;

import org.eclipse.help.internal.base.BaseHelpSystem;
import org.eclipse.help.internal.entityresolver.LocalEntityResolver;
import org.eclipse.help.internal.server.WebappManager;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.InputSource;

public class TocFragmentServiceTest extends TestCase {

	private int mode;

	protected void setUp() throws Exception {
		BaseHelpSystem.ensureWebappRunning();
		mode = BaseHelpSystem.getMode();
		BaseHelpSystem.setMode(BaseHelpSystem.MODE_INFOCENTER);
	}
	
	protected void tearDown() throws Exception {
		BaseHelpSystem.setMode(mode);
	}

	public void testTocFragmentServiceContainsUAToc() throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, 
				"/help/ss/service/tocfragment?lang=en");
		Node root = getTreeData(url);
		Element[] UARoot = findNodeById(root, 
				"/org.eclipse.ua.tests/data/help/toc/root.xml");
	    assertEquals(1, UARoot.length);
	}

	public void testTocFragmentServiceContainsFilteredToc() throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, 
				"/help/ss/service/tocfragment?lang=en&toc=/org.eclipse.ua.tests/data/help/toc/root.xml&path=2");
		Node root = getTreeData(url);
		Element[] UARoot = findNodeById(root, 
				"/org.eclipse.ua.tests/data/help/toc/root.xml");
		assertEquals(1, UARoot.length);
		Element[] filterNode = findNodeById(UARoot[0], "2");
		assertEquals(1, filterNode.length);
		Element[] results = findChildren(filterNode[0], "node", "href", 
				"../topic/org.eclipse.ua.tests/data/help/toc/filteredToc/simple_page.html");
		assertEquals(24, results.length);
		
		results = findChildren(filterNode[0], "node", "href", 
		"../topic/org.eclipse.ua.tests/data/help/toc/filteredToc/helpInstalled.html");
		assertEquals(1, results.length);
	}
	
	public void testReadEnToc() throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, 
				"/help/ss/service/tocfragment?lang=en&toc=/org.eclipse.ua.tests/data/help/toc/root.xml&path=7");
		Node root = getTreeData(url);
		Element[] UARoot = findNodeById(root, 
				"/org.eclipse.ua.tests/data/help/toc/root.xml");
		assertEquals(1, UARoot.length);
		Element[] searchNode = findNodeById(UARoot[0], "7");
		assertEquals(1, searchNode.length);
		Element[] topicEn = findChildren(searchNode[0], "node", "href", 
				"../topic/org.eclipse.ua.tests/data/help/search/test_en.html");
		assertEquals(1, topicEn.length);
		Element[] topicDe = findChildren(searchNode[0], "node", "href", 
				"../topic/org.eclipse.ua.tests/data/help/search/test_de.html");
		assertEquals(0, topicDe.length);
	}	
	
	public void testReadDeToc() throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, 
				"/help/ss/service/tocfragment?lang=de&toc=/org.eclipse.ua.tests/data/help/toc/root.xml&path=7");
		Node root = getTreeData(url);
		Element[] UARoot = findNodeById(root, 
				"/org.eclipse.ua.tests/data/help/toc/root.xml");
		assertEquals(1, UARoot.length);
		Element[] searchNode = findNodeById(UARoot[0], "7");
		Element[] topicEn = findChildren(searchNode[0], "node", "href", 
				"../topic/org.eclipse.ua.tests/data/help/search/test_en.html");
		assertEquals(0, topicEn.length);
		Element[] topicDe = findChildren(searchNode[0], "node", "href", 
				"../topic/org.eclipse.ua.tests/data/help/search/test_de.html");
		assertEquals(1, topicDe.length);
	}
	
	private Element[] findNodeById(Node root, String id) {
		return findChildren(root, "node", "id", id);
	}
	
	private Element[] findChildren(Node parent, String childKind, 
			String attributeName, String attributeValue) {
		NodeList nodes = parent.getChildNodes();
		List<Node> results = new ArrayList<Node>();
		for (int i = 0; i < nodes.getLength(); i++) {
			Node next = nodes.item(i);
			if (next instanceof Element) {
				Element nextElement = (Element)next;
				if ( childKind.equals(nextElement.getTagName()) 
						&& attributeValue.equals(nextElement.getAttribute(attributeName))) {
		
				    results.add(next);	
				}
			}
		}
		return (Element[]) results.toArray(new Element[results.size()]);
	}
	 

	private Node getTreeData(URL url)
			throws Exception {
		InputStream is = url.openStream();
		InputSource inputSource = new InputSource(is);
        DocumentBuilder documentBuilder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
		documentBuilder.setEntityResolver(new LocalEntityResolver());
		Document document = documentBuilder.parse(inputSource);
		Node root = document.getFirstChild();
		is.close();
		assertEquals("tree_data", root.getNodeName());
		return root;
	}

	public void testTocFragmentServiceXMLSchema() 
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/tocfragment?lang=en");
		URL schemaUrl = new URL("http", "localhost", port, "/help/test/schema/xml/tocfragment.xsd");
		String schema = schemaUrl.toString();
		String uri = url.toString();
		String result = SchemaValidator.testXMLSchema(uri, schema);
		
		assertEquals("URL: \"" + uri + "\" is ", "valid", result);
	}
	
	public void testTocFragmentServiceJSONSchema() 
			throws Exception {
//		fail("Not yet implemented.");
	}

}




/*******************************************************************************
 * Copyright (c) 2011 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
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.webapp.service;

import java.io.InputStream;
import java.net.URL;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import org.eclipse.help.internal.entityresolver.LocalEntityResolver;
import org.eclipse.help.internal.server.WebappManager;
import org.eclipse.ua.tests.help.remote.TocServletTest;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.InputSource;

public class TocServiceTest extends TocServletTest {

	protected Node getTocContributions( String locale)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/toc?lang=" + locale);
		InputStream is = url.openStream();
		InputSource inputSource = new InputSource(is);
        DocumentBuilder documentBuilder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
		documentBuilder.setEntityResolver(new LocalEntityResolver());
		Document document = documentBuilder.parse(inputSource);
		Node root = document.getFirstChild();
		is.close();
		assertEquals("tocContributions", root.getNodeName());
		return root;
	}

	public void testTocServiceXMLSchema() 
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/toc?lang=en");
		URL schemaUrl = new URL("http", "localhost", port, "/help/test/schema/xml/toc.xsd");
		String schema = schemaUrl.toString();
		String uri = url.toString();
		String result = SchemaValidator.testXMLSchema(uri, schema);
		
		assertEquals("URL: \"" + uri + "\" is ", "valid", result);
	}
	
	public void testTocServiceJSONSchema() 
			throws Exception {
		/*int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/ss/service/toc?lang=en");
		URL schemaUrl = new URL("http", "localhost", port, "/help/test/schema/json/toc.json");
		String schema = schemaUrl.toString();
		String uri = url.toString();
		String result = SchemaValidator.testJSONSchema(uri, schema);
		
		assertEquals("URL: \"" + uri + "\" is ", "valid", result);*/
//		fail("Not yet implemented.");
	}

}

Lines 545-550 Link Here

(-)plugin.xml (+4 lines)
545	alias="/titlesearch/script"	545	alias="/titlesearch/script"
546	base-name="/script">	546	base-name="/script">
547	</resource>	547	</resource>
		548	<resource
		549	alias="/test"
		550	base-name="/service">
		551	</resource>
548	<serviceSelector	552	<serviceSelector
549	filter="(other.info=org.eclipse.help)">	553	filter="(other.info=org.eclipse.help)">
550	</serviceSelector>	554	</serviceSelector>




<?xml version="1.0" encoding="UTF-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
	elementFormDefault="qualified">

	<xs:element name="context">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element name="description" type="xs:string" minOccurs="1" maxOccurs="1" />
				<xs:element ref="topic" minOccurs="0" maxOccurs="unbounded" />	
			</xs:sequence>
			<xs:attribute name="title" type="xs:string" /> <!-- attribute for tree_data -->
		</xs:complexType>
	</xs:element>
	
	<xs:element name="topic">
		<xs:complexType mixed="true">
			<xs:attribute name="label" type="xs:string" /> <!-- attribute for tree_data -->
			<xs:attribute name="href" type="xs:string" /> <!-- attribute for tree_data -->
		</xs:complexType>
	</xs:element>
</xs:schema>




<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
	elementFormDefault="qualified">

<xs:element name="indexContributions">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="indexContribution" minOccurs="0"
					maxOccurs="unbounded" />
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	
	
	<xs:element name="indexContribution">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="index" minOccurs="1"	maxOccurs="1" />
			</xs:sequence>
			<xs:attribute name="id" type="xs:string" use="required"/> <!-- attribute for tree_data -->
			<xs:attribute name="locale" type="xs:string" use="required"/> <!-- attribute for tree_data -->
		</xs:complexType>
	</xs:element>
	
	<xs:element name="index">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="entry" minOccurs="0" maxOccurs="unbounded" />
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	
	<xs:element name="entry">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="topic" minOccurs="0" maxOccurs="unbounded" />
				<xs:element ref="entry" minOccurs="0" maxOccurs="unbounded" />
				<xs:element ref="see" minOccurs="0" maxOccurs="unbounded" />
			</xs:sequence>
			<xs:attribute name="keyword" type="xs:string" use="required"/> <!-- attribute for tree_data -->
		</xs:complexType>
	</xs:element>
	
	<xs:element name="topic">
		<xs:complexType mixed="false">
			<xs:attribute name="href" type="xs:string" /> <!-- attribute for tree_data -->
			<xs:attribute name="title" type="xs:string" /> <!-- attribute for tree_data -->
			<xs:attribute name="label" type="xs:string" /> <!-- attribute for tree_data -->			
		</xs:complexType>
	</xs:element>
	
	<xs:element name="see">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="subpath" minOccurs="0" maxOccurs="unbounded" />
			</xs:sequence>
			<xs:attribute name="keyword" type="xs:string" use="required"/> <!-- attribute for tree_data -->
		</xs:complexType>
	</xs:element>
	
	<xs:element name="subpath">
		<xs:complexType mixed="false">
			<xs:attribute name="keyword" type="xs:string" use="required"/> <!-- attribute for tree_data -->
		</xs:complexType>
	</xs:element>
</xs:schema>




<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
	elementFormDefault="qualified">
	<xs:element name="tree_data">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="node" minOccurs="0" maxOccurs="unbounded" />
			</xs:sequence>
			<xs:attribute name="enableNext" type="xs:boolean" use="required" /> <!-- attribute for tree_data -->
			<xs:attribute name="enablePrevious" type="xs:boolean" use="required" /> <!-- attribute for tree_data -->

		</xs:complexType>
	</xs:element>

	<xs:element name="node" abstract="false" nillable="false">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="node" minOccurs="0" maxOccurs="unbounded" />
			</xs:sequence>

			<xs:attribute name="title" type="xs:string" /> <!-- optional attribute for node -->
			<xs:attribute name="id" type="xs:ID" use="required" /> <!-- attribute for node -->
			<xs:attribute name="href" type="xs:string"/> <!-- optional attribute for node -->
		</xs:complexType>
	</xs:element>

</xs:schema>




<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
	elementFormDefault="qualified">
	<xs:element name="searchHits">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="hit" minOccurs="0" maxOccurs="unbounded" />   <!-- hits result could be zero -->
			</xs:sequence>
		</xs:complexType>
	</xs:element>

	<xs:element name="hit" abstract="false" nillable="false">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element name="category" minOccurs="1" maxOccurs="1">
					<xs:complexType>
						<xs:simpleContent>
							<xs:extension base="xs:string">
								<xs:attribute name="href" type="xs:string" use="required" />
							</xs:extension>
						</xs:simpleContent>
					</xs:complexType>
				</xs:element>
				<xs:element name="summary" type="xs:string" minOccurs="1" maxOccurs="1" />
			</xs:sequence>
			<xs:attribute name="href" type="xs:string" use="required" /> <!-- attribute for hit -->
			<xs:attribute name="label" type="xs:string" use="required" /> <!-- attribute for hit -->
			<xs:attribute name="isPotentialHit" type="xs:boolean" />  <!-- optional attribute for hit -->
			<xs:attribute name="score" type="xs:double" use="required" /> <!-- attribute for hit -->
		</xs:complexType>
	</xs:element>

</xs:schema>




<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
	elementFormDefault="qualified">
	<xs:element name="searchHits">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="hit" minOccurs="0" maxOccurs="unbounded" />   <!-- hits result could be zero -->
			</xs:sequence>
		</xs:complexType>
	</xs:element>

	<xs:element name="hit" abstract="false" nillable="false">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element name="summary" type="xs:string" minOccurs="1" maxOccurs="1" />
			</xs:sequence>
			<xs:attribute name="href" type="xs:string" use="required" /> <!-- attribute for hit -->
			<xs:attribute name="label" type="xs:string" use="required" /> <!-- attribute for hit -->
			<xs:attribute name="isPotentialHit" type="xs:boolean" />  <!-- optional attribute for hit -->
			<xs:attribute name="score" type="xs:double" use="required" /> <!-- attribute for hit -->
		</xs:complexType>
	</xs:element>

</xs:schema>




<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
	elementFormDefault="qualified">

	<xs:element name="tocContributions">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="tocContribution" minOccurs="0"
					maxOccurs="unbounded" />
			</xs:sequence>
		</xs:complexType>
	</xs:element>


	<xs:element name="tocContribution " abstract="false"
		nillable="false">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="toc" minOccurs="0" maxOccurs="unbounded" />
				<xs:element ref="extraDocument" minOccurs="0" maxOccurs="unbounded" />
			</xs:sequence>
			<xs:attribute name="categoryId" type="xs:string" /> <!-- attribute for tree_data -->
			<xs:attribute name="contributorId" type="xs:string" /> <!-- attribute for tree_data -->
			<xs:attribute name="id" type="xs:string" use="required" /> <!-- attribute for tree_data -->
			<xs:attribute name="locale" type="xs:string" use="required" /> <!-- attribute for tree_data -->
			<xs:attribute name="isPrimary" type="xs:boolean" use="required" /> <!-- attribute for tree_data -->
		</xs:complexType>
	</xs:element>

	<xs:element name="toc" abstract="false" nillable="false">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="anchor" minOccurs="0" maxOccurs="unbounded" />
				<xs:element ref="topic" minOccurs="0" maxOccurs="unbounded" />
				<xs:element ref="enablement" minOccurs="0" maxOccurs="1" />
			</xs:sequence>
			
			<xs:attribute name="label" type="xs:string" use="required" /> <!-- optional attribute for node -->
			<xs:attribute name="link_to" type="xs:string" /> <!-- attribute for node -->
			<xs:attribute name="topic" type="xs:string" /> <!-- optional attribute for node -->
		</xs:complexType>
		
		
	</xs:element>

	<xs:element name="extraDocument" abstract="false" nillable="false">
		<xs:complexType mixed="false">
			<xs:attribute name="href" type="xs:string" use="required" />
		</xs:complexType>
	</xs:element>

	<xs:element name="topic" abstract="false" nillable="false">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="topic" minOccurs="0" maxOccurs="unbounded" />
				<xs:element ref="link" minOccurs="0" maxOccurs="unbounded" />
				<xs:element ref="enablement" minOccurs="0" maxOccurs="1" />
			</xs:sequence>

			<xs:attribute name="label" type="xs:string" /> <!-- optional attribute for node -->
			<xs:attribute name="href" type="xs:string" /> <!-- optional attribute for node -->
		</xs:complexType>
	</xs:element>

	<xs:element name="anchor" abstract="false" nillable="false">
		<xs:complexType mixed="false">
			<xs:attribute name="id" type="xs:string" use="required" /> <!-- optional attribute for node -->
		</xs:complexType>
	</xs:element>

	<xs:element name="link" abstract="false" nillable="false">
		<xs:complexType mixed="false">
			<xs:attribute name="toc" type="xs:string" use="required" /> <!-- optional attribute for node -->
		</xs:complexType>
	</xs:element>

	<xs:element name="enablement" abstract="false" nillable="false">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="with" minOccurs="0" maxOccurs="unbounded" />
				<xs:element ref="test" minOccurs="0" maxOccurs="unbounded" />
			</xs:sequence>
		</xs:complexType>
	</xs:element>

	<xs:element name="test" abstract="false" nillable="false">
		<xs:complexType mixed="false">
			<xs:attribute name="args" type="xs:string" use="required" /> <!-- optional attribute for node -->
			<xs:attribute name="property" type="xs:string" use="required" /> <!-- attribute for node -->
		</xs:complexType>
	</xs:element>

	<xs:element name="with" abstract="false" nillable="false">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element ref="test" minOccurs="0" maxOccurs="unbounded" />
			</xs:sequence>
			<xs:attribute name="variable" type="xs:string" /> <!-- optional attribute for node -->
		</xs:complexType>
	</xs:element>
</xs:schema>




<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
	elementFormDefault="qualified">
	<xs:element name="tree_data">
		<xs:complexType mixed="false">
			<xs:sequence>
				<xs:element name="error" minOccurs="0" />
				<xs:element ref="numeric_path" minOccurs="0" maxOccurs="1" />
				<xs:element name="node"  minOccurs="0" maxOccurs="unbounded">
					<!--
						toc node, only difference b/w toc and topic level node is of
						is_leaf attrb and order of attrb
					-->
					<xs:complexType mixed="false">
						<xs:sequence>
							<xs:element name="node" type="TopicNode" minOccurs="0" maxOccurs="unbounded" />
						</xs:sequence>
						<xs:attribute name="title" type="xs:string" /> <!-- optional attribute for node -->
						<xs:attribute name="id" type="xs:string" use="required" /> <!-- attribute for node -->
						<xs:attribute name="href" type="xs:string" use="required" /> <!-- attribute for node -->
						<xs:attribute name="openImage" type="xs:string" /> <!-- optional attribute for node -->
						<xs:attribute name="closedImage" type="xs:string" />  <!-- optional attribute for node -->
						<xs:attribute name="imageAlt" type="xs:string" />  <!-- optional attribute for node -->
						<xs:attribute name="image" type="xs:string" default="toc_closed" />  <!-- optional attribute for node -->
						<xs:attribute name="is_selected" type="xs:boolean"
							default="true" /> <!-- attribute for node -->
						<xs:attribute name="is_highlighted" type="xs:boolean"
							default="true" /> <!-- attribute for node -->

					</xs:complexType>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>

	<xs:element name="numeric_path">
		<xs:complexType>
			<xs:attribute name="path" type="xs:string" />
		</xs:complexType>
	</xs:element>

	
		<xs:complexType name="TopicNode" mixed="false">
			<xs:sequence>
				<xs:element name="node" type="TopicNode" minOccurs="0" maxOccurs="unbounded" />
			</xs:sequence>

			<xs:attribute name="title" type="xs:string" /> <!-- optional attribute for node -->
			<xs:attribute name="id" type="xs:string" use="required" /> <!-- attribute for node -->
			<xs:attribute name="href" type="xs:string" use="required" /> <!-- attribute for node -->
			<xs:attribute name="is_leaf" type="xs:boolean" default="true" /> <!-- attribute for node -->
			<xs:attribute name="is_selected" type="xs:boolean"
				default="true" /> <!-- attribute for node -->
			<xs:attribute name="is_highlighted" type="xs:boolean"
				default="true" /> <!-- attribute for node -->
			<xs:attribute name="openImage" type="xs:string" /> <!-- optional attribute for node -->
			<xs:attribute name="closedImage" type="xs:string" />  <!-- optional attribute for node -->
			<xs:attribute name="imageAlt" type="xs:string" />  <!-- optional attribute for node -->
			<xs:attribute name="image" type="xs:string" default="toc_closed" />  <!-- optional attribute for node -->

		</xs:complexType>
	

</xs:schema>

Return to bug 319907

Added Link Here

(-)schema/secureServlet.exsd (+109 lines)
1	<?xml version='1.0' encoding='UTF-8'?>
2	<!-- Schema file written by PDE -->
3	<schema targetNamespace="org.eclipse.help.webapp" xmlns="http://www.w3.org/2001/XMLSchema">
4	<annotation>
5	<appInfo>
6	<meta.schema plugin="org.eclipse.help.webapp" id="secureServlet" name="Security Enhanced Servlet"/>
7	</appInfo>
8	<documentation>
9	Allows definition of Servlets and their aliases, with a focus on preventing known security vulernabilites.
10	</documentation>
11	</annotation>
12
13	<element name="extension">
14	<annotation>
15	<appInfo>
16	<meta.element />
17	</appInfo>
18	</annotation>
19	<complexType>
20	<sequence minOccurs="0" maxOccurs="unbounded">
21	<element ref="servlet"/>
22	</sequence>
23	<attribute name="point" type="string" use="required">
24	<annotation>
25	<documentation>
26
27	</documentation>
28	</annotation>
29	</attribute>
30	<attribute name="id" type="string">
31	<annotation>
32	<documentation>
33
34	</documentation>
35	</annotation>
36	</attribute>
37	<attribute name="name" type="string">
38	<annotation>
39	<documentation>
40
41	</documentation>
42	<appInfo>
43	<meta.attribute translatable="true"/>
44	</appInfo>
45	</annotation>
46	</attribute>
47	</complexType>
48	</element>
49
50	<element name="servlet">
51	<complexType>
52	<attribute name="class" type="string" use="required">
53	<annotation>
54	<documentation>
55
56	</documentation>
57	<appInfo>
58	<meta.attribute kind="java" basedOn="javax.servlet.http.HttpServlet:"/>
59	</appInfo>
60	</annotation>
61	</attribute>
62	<attribute name="alias" type="string" use="required">
63	<annotation>
64	<documentation>
65
66	</documentation>
67	</annotation>
68	</attribute>
69	</complexType>
70	</element>
71
72	<annotation>
73	<appInfo>
74	<meta.section type="since"/>
75	</appInfo>
76	<documentation>
77	[Enter the first release in which this extension point appears.]
78	</documentation>
79	</annotation>
80
81	<annotation>
82	<appInfo>
83	<meta.section type="examples"/>
84	</appInfo>
85	<documentation>
86	[Enter extension point usage example here.]
87	</documentation>
88	</annotation>
89
90	<annotation>
91	<appInfo>
92	<meta.section type="apiinfo"/>
93	</appInfo>
94	<documentation>
95	[Enter API information here.]
96	</documentation>
97	</annotation>
98
99	<annotation>
100	<appInfo>
101	<meta.section type="implementation"/>
102	</appInfo>
103	<documentation>
104	[Enter information about supplied implementation of this extension point.]
105	</documentation>
106	</annotation>
107
108
109	</schema>

Added Link Here

(-)src/org/eclipse/help/internal/webapp/parser/ContextParser.java (+86 lines)
1	/*******************************************************************************
2	* Copyright (c) 2011 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	* Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
11	*******************************************************************************/
12	package org.eclipse.help.internal.webapp.parser;
13
14	import java.util.Properties;
15
16	import org.eclipse.help.internal.webapp.utils.JSonHelper;
17	import org.eclipse.help.internal.webapp.utils.XMLHelper;
18	import org.xml.sax.Attributes;
19
20	public class ContextParser extends ResultParser {
21
22	private ParseElement element = null;
23	private String currentTag;
24
25	public ContextParser() {
26	super(JSonHelper.TITLE);
27	}
28
29	public void startElement(String uri, String lname, String name, Attributes attrs) {
30
31	currentTag = name;
32	if (name.equalsIgnoreCase(XMLHelper.ELEMENT_DESCRIPTION))
33	return;
34
35	Properties properties = new Properties();
36	properties.put(JSonHelper.PROPERTY_NAME, name);
37	for (int i = 0; i < attrs.getLength(); i++) {
38	String qname = attrs.getQName(i);
39	String val = attrs.getValue(i);
40	properties.put(qname, val);
41	}
42
43	ParseElement elem = new ParseElement(properties, element);
44	if (element != null)
45	element.addChild(elem);
46	else
47	items.add(elem);
48
49	element = elem;
50
51	}
52
53	public void characters(char[] ch, int start, int length) {
54
55	if (element != null
56	&& currentTag.equalsIgnoreCase(
57	XMLHelper.ELEMENT_DESCRIPTION)) {
58
59	Properties properties = element.getProps();
60	if (properties != null) {
61
62	String content = new String(ch, start, length);
63
64	String existing = (String) properties.get(currentTag);
65	if (existing == null)
66	existing = ""; //$NON-NLS-1$
67
68	content = content.replaceAll("[\\n\\t]", "").trim(); //$NON-NLS-1$ //$NON-NLS-2$
69
70	properties.put(currentTag, existing + content);
71	element.updateParseElement(properties);
72	}
73	}
74	}
75
76	public void endElement(String uri, String lname, String name) {
77
78	if (name.equalsIgnoreCase(XMLHelper.ELEMENT_DESCRIPTION))
79	return;
80
81	if (element != null) {
82	element = element.getParent();
83	}
84	}
85
86	}

Lines 1-5 Link Here

(-)help/org/eclipse/ua/tests/help/AllHelpTests.java (-1 / +3 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2006, 2010 IBM Corporation and others.	2	* Copyright (c) 2006, 2011 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 23-28 Link Here
23	import org.eclipse.ua.tests.help.search.AllSearchTests;	23	import org.eclipse.ua.tests.help.search.AllSearchTests;
24	import org.eclipse.ua.tests.help.toc.AllTocTests;	24	import org.eclipse.ua.tests.help.toc.AllTocTests;
25	import org.eclipse.ua.tests.help.webapp.AllWebappTests;	25	import org.eclipse.ua.tests.help.webapp.AllWebappTests;
		26	import org.eclipse.ua.tests.help.webapp.service.AllWebappServiceTests;
26		27
27	/*	28	/*
28	* Tests help functionality (automated).	29	* Tests help functionality (automated).
Lines 50-54 Link Here
50	addTest(AllOtherHelpTests.suite());	51	addTest(AllOtherHelpTests.suite());
51	addTest(AllRemoteTests.suite());	52	addTest(AllRemoteTests.suite());
52	addTest(AllScopeTests.suite());	53	addTest(AllScopeTests.suite());
		54	addTest(AllWebappServiceTests.suite());
53	}	55	}
54	}	56	}

Added Link Here

(-)help/org/eclipse/ua/tests/help/util/ServletTester.java (+111 lines)
1	/*******************************************************************************
2	* Copyright (c) 2011 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.ua.tests.help.util;
12
13	import java.io.BufferedReader;
14	import java.io.IOException;
15	import java.io.InputStreamReader;
16	import java.net.URL;
17
18	import javax.xml.parsers.DocumentBuilder;
19	import javax.xml.parsers.DocumentBuilderFactory;
20
21	import org.eclipse.core.runtime.IStatus;
22	import org.eclipse.core.runtime.MultiStatus;
23	import org.eclipse.core.runtime.Status;
24	import org.xml.sax.ErrorHandler;
25	import org.xml.sax.SAXException;
26	import org.xml.sax.SAXParseException;
27
28
29	public class ServletTester {
30
31	// dtd validation
32	// argument processing / validation
33	// invalid args dont workit
34
35	public static String callTextServlet(URL url) throws IOException
36	{
37	BufferedReader br = new BufferedReader(new InputStreamReader(url.openStream()));
38
39	String res="";
40	String line;
41	while ((line = br.readLine())!=null)
42	res+=line+'\n';
43
44	br.close();
45
46	return res;
47	}
48
49	public static boolean isXML(URL url) throws IOException
50	{
51	return callTextServlet(url).startsWith("<?xml");
52	// return siteContains(url,"<?xml");
53	}
54
55	public static boolean siteContains(URL url,String str) throws IOException
56	{
57	return (callTextServlet(url).indexOf(str) > -1);
58	}
59
60	public static boolean isDTDValidated(URL url) throws Exception
61	{
62	DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
63	factory.setValidating(true);
64
65	DocumentBuilder builder = factory.newDocumentBuilder();
66
67	DTDErrorHandler handler = new DTDErrorHandler();
68	builder.setErrorHandler(handler);
69	builder.parse(url.toString());
70
71	return handler.getStatus().getSeverity()!=IStatus.ERROR;
72	}
73
74
75	private static class DTDErrorHandler implements ErrorHandler
76	{
77	private MultiStatus status = null;
78
79	public void warning(SAXParseException exception) throws SAXException {
80	if (status==null)
81	status = new MultiStatus("org.eclipse.ua.tests",IStatus.WARNING,"DTD Processing Warning",exception);
82	else
83	{
84	IStatus tmp = new Status(IStatus.WARNING,"org.eclipse.ua.tests","DTD Processing Warning",exception);
85	status.add(tmp);
86	}
87	}
88
89	public void error(SAXParseException exception) throws SAXException {
90	if (status==null)
91	status = new MultiStatus("org.eclipse.ua.tests",IStatus.ERROR,"DTD Processing Error",exception);
92	else
93	{
94	IStatus tmp = new Status(IStatus.ERROR,"org.eclipse.ua.tests","DTD Processing Error",exception);
95	status.add(tmp);
96	}
97	}
98
99	public void fatalError(SAXParseException exception) throws SAXException {
100	error(exception);
101	}
102
103	public IStatus getStatus()
104	{
105	if (status==null)
106	return Status.OK_STATUS;
107	return status;
108	}
109
110	}
111	}

Added Link Here

(-)help/org/eclipse/ua/tests/help/webapp/service/AllWebappServiceTests.java (+41 lines)
1	/*******************************************************************************
2	* Copyright (c) 2011 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	* Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
11	*******************************************************************************/
12	package org.eclipse.ua.tests.help.webapp.service;
13
14	import junit.framework.Test;
15	import junit.framework.TestSuite;
16
17	/*
18	* Tests utility classes and servlets used in Web Application
19	*/
20	public class AllWebappServiceTests extends TestSuite {
21
22	/*
23	* Returns the entire test suite.
24	*/
25	public static Test suite() {
26	TestSuite suite = new TestSuite(
27	"org.eclipse.ua.tests.help.AllWebappServiceTests");
28	//$JUnit-BEGIN$
29	suite.addTestSuite(ContentServiceTest.class);
30	suite.addTestSuite(ContextServiceTest.class);
31	suite.addTestSuite(IndexFragmentServiceTest.class);
32	suite.addTestSuite(IndexServiceTest.class);
33	suite.addTestSuite(SearchServiceTest.class);
34	suite.addTestSuite(SimpleSearchServiceTest.class);
35	suite.addTestSuite(TocFragmentServiceTest.class);
36	suite.addTestSuite(TocServiceTest.class);
37	//$JUnit-END$
38	return suite;
39	}
40
41	}

Added Link Here

(-)service/schema/xml/context.xsd (+22 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2
3	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
4	elementFormDefault="qualified">
5
6	<xs:element name="context">
7	<xs:complexType mixed="false">
8	<xs:sequence>
9	<xs:element name="description" type="xs:string" minOccurs="1" maxOccurs="1" />
10	<xs:element ref="topic" minOccurs="0" maxOccurs="unbounded" />
11	</xs:sequence>
12	<xs:attribute name="title" type="xs:string" /> <!-- attribute for tree_data -->
13	</xs:complexType>
14	</xs:element>
15
16	<xs:element name="topic">
17	<xs:complexType mixed="true">
18	<xs:attribute name="label" type="xs:string" /> <!-- attribute for tree_data -->
19	<xs:attribute name="href" type="xs:string" /> <!-- attribute for tree_data -->
20	</xs:complexType>
21	</xs:element>
22	</xs:schema>

Added Link Here

(-)service/schema/xml/index.xsd (+66 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
3	elementFormDefault="qualified">
4
5	<xs:element name="indexContributions">
6	<xs:complexType mixed="false">
7	<xs:sequence>
8	<xs:element ref="indexContribution" minOccurs="0"
9	maxOccurs="unbounded" />
10	</xs:sequence>
11	</xs:complexType>
12	</xs:element>
13
14
15	<xs:element name="indexContribution">
16	<xs:complexType mixed="false">
17	<xs:sequence>
18	<xs:element ref="index" minOccurs="1" maxOccurs="1" />
19	</xs:sequence>
20	<xs:attribute name="id" type="xs:string" use="required"/> <!-- attribute for tree_data -->
21	<xs:attribute name="locale" type="xs:string" use="required"/> <!-- attribute for tree_data -->
22	</xs:complexType>
23	</xs:element>
24
25	<xs:element name="index">
26	<xs:complexType mixed="false">
27	<xs:sequence>
28	<xs:element ref="entry" minOccurs="0" maxOccurs="unbounded" />
29	</xs:sequence>
30	</xs:complexType>
31	</xs:element>
32
33	<xs:element name="entry">
34	<xs:complexType mixed="false">
35	<xs:sequence>
36	<xs:element ref="topic" minOccurs="0" maxOccurs="unbounded" />
37	<xs:element ref="entry" minOccurs="0" maxOccurs="unbounded" />
38	<xs:element ref="see" minOccurs="0" maxOccurs="unbounded" />
39	</xs:sequence>
40	<xs:attribute name="keyword" type="xs:string" use="required"/> <!-- attribute for tree_data -->
41	</xs:complexType>
42	</xs:element>
43
44	<xs:element name="topic">
45	<xs:complexType mixed="false">
46	<xs:attribute name="href" type="xs:string" /> <!-- attribute for tree_data -->
47	<xs:attribute name="title" type="xs:string" /> <!-- attribute for tree_data -->
48	<xs:attribute name="label" type="xs:string" /> <!-- attribute for tree_data -->
49	</xs:complexType>
50	</xs:element>
51
52	<xs:element name="see">
53	<xs:complexType mixed="false">
54	<xs:sequence>
55	<xs:element ref="subpath" minOccurs="0" maxOccurs="unbounded" />
56	</xs:sequence>
57	<xs:attribute name="keyword" type="xs:string" use="required"/> <!-- attribute for tree_data -->
58	</xs:complexType>
59	</xs:element>
60
61	<xs:element name="subpath">
62	<xs:complexType mixed="false">
63	<xs:attribute name="keyword" type="xs:string" use="required"/> <!-- attribute for tree_data -->
64	</xs:complexType>
65	</xs:element>
66	</xs:schema>

Added Link Here

(-)service/schema/xml/indexfragment.xsd (+27 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
3	elementFormDefault="qualified">
4	<xs:element name="tree_data">
5	<xs:complexType mixed="false">
6	<xs:sequence>
7	<xs:element ref="node" minOccurs="0" maxOccurs="unbounded" />
8	</xs:sequence>
9	<xs:attribute name="enableNext" type="xs:boolean" use="required" /> <!-- attribute for tree_data -->
10	<xs:attribute name="enablePrevious" type="xs:boolean" use="required" /> <!-- attribute for tree_data -->
11
12	</xs:complexType>
13	</xs:element>
14
15	<xs:element name="node" abstract="false" nillable="false">
16	<xs:complexType mixed="false">
17	<xs:sequence>
18	<xs:element ref="node" minOccurs="0" maxOccurs="unbounded" />
19	</xs:sequence>
20
21	<xs:attribute name="title" type="xs:string" /> <!-- optional attribute for node -->
22	<xs:attribute name="id" type="xs:ID" use="required" /> <!-- attribute for node -->
23	<xs:attribute name="href" type="xs:string"/> <!-- optional attribute for node -->
24	</xs:complexType>
25	</xs:element>
26
27	</xs:schema>

Added Link Here

(-)service/schema/xml/search.xsd (+33 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
3	elementFormDefault="qualified">
4	<xs:element name="searchHits">
5	<xs:complexType mixed="false">
6	<xs:sequence>
7	<xs:element ref="hit" minOccurs="0" maxOccurs="unbounded" /> <!-- hits result could be zero -->
8	</xs:sequence>
9	</xs:complexType>
10	</xs:element>
11
12	<xs:element name="hit" abstract="false" nillable="false">
13	<xs:complexType mixed="false">
14	<xs:sequence>
15	<xs:element name="category" minOccurs="1" maxOccurs="1">
16	<xs:complexType>
17	<xs:simpleContent>
18	<xs:extension base="xs:string">
19	<xs:attribute name="href" type="xs:string" use="required" />
20	</xs:extension>
21	</xs:simpleContent>
22	</xs:complexType>
23	</xs:element>
24	<xs:element name="summary" type="xs:string" minOccurs="1" maxOccurs="1" />
25	</xs:sequence>
26	<xs:attribute name="href" type="xs:string" use="required" /> <!-- attribute for hit -->
27	<xs:attribute name="label" type="xs:string" use="required" /> <!-- attribute for hit -->
28	<xs:attribute name="isPotentialHit" type="xs:boolean" /> <!-- optional attribute for hit -->
29	<xs:attribute name="score" type="xs:double" use="required" /> <!-- attribute for hit -->
30	</xs:complexType>
31	</xs:element>
32
33	</xs:schema>

Added Link Here

(-)service/schema/xml/simplesearch.xsd (+24 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
3	elementFormDefault="qualified">
4	<xs:element name="searchHits">
5	<xs:complexType mixed="false">
6	<xs:sequence>
7	<xs:element ref="hit" minOccurs="0" maxOccurs="unbounded" /> <!-- hits result could be zero -->
8	</xs:sequence>
9	</xs:complexType>
10	</xs:element>
11
12	<xs:element name="hit" abstract="false" nillable="false">
13	<xs:complexType mixed="false">
14	<xs:sequence>
15	<xs:element name="summary" type="xs:string" minOccurs="1" maxOccurs="1" />
16	</xs:sequence>
17	<xs:attribute name="href" type="xs:string" use="required" /> <!-- attribute for hit -->
18	<xs:attribute name="label" type="xs:string" use="required" /> <!-- attribute for hit -->
19	<xs:attribute name="isPotentialHit" type="xs:boolean" /> <!-- optional attribute for hit -->
20	<xs:attribute name="score" type="xs:double" use="required" /> <!-- attribute for hit -->
21	</xs:complexType>
22	</xs:element>
23
24	</xs:schema>

Added Link Here

(-)service/schema/xml/toc.xsd (+101 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
3	elementFormDefault="qualified">
4
5	<xs:element name="tocContributions">
6	<xs:complexType mixed="false">
7	<xs:sequence>
8	<xs:element ref="tocContribution" minOccurs="0"
9	maxOccurs="unbounded" />
10	</xs:sequence>
11	</xs:complexType>
12	</xs:element>
13
14
15	<xs:element name="tocContribution " abstract="false"
16	nillable="false">
17	<xs:complexType mixed="false">
18	<xs:sequence>
19	<xs:element ref="toc" minOccurs="0" maxOccurs="unbounded" />
20	<xs:element ref="extraDocument" minOccurs="0" maxOccurs="unbounded" />
21	</xs:sequence>
22	<xs:attribute name="categoryId" type="xs:string" /> <!-- attribute for tree_data -->
23	<xs:attribute name="contributorId" type="xs:string" /> <!-- attribute for tree_data -->
24	<xs:attribute name="id" type="xs:string" use="required" /> <!-- attribute for tree_data -->
25	<xs:attribute name="locale" type="xs:string" use="required" /> <!-- attribute for tree_data -->
26	<xs:attribute name="isPrimary" type="xs:boolean" use="required" /> <!-- attribute for tree_data -->
27	</xs:complexType>
28	</xs:element>
29
30	<xs:element name="toc" abstract="false" nillable="false">
31	<xs:complexType mixed="false">
32	<xs:sequence>
33	<xs:element ref="anchor" minOccurs="0" maxOccurs="unbounded" />
34	<xs:element ref="topic" minOccurs="0" maxOccurs="unbounded" />
35	<xs:element ref="enablement" minOccurs="0" maxOccurs="1" />
36	</xs:sequence>
37
38	<xs:attribute name="label" type="xs:string" use="required" /> <!-- optional attribute for node -->
39	<xs:attribute name="link_to" type="xs:string" /> <!-- attribute for node -->
40	<xs:attribute name="topic" type="xs:string" /> <!-- optional attribute for node -->
41	</xs:complexType>
42
43
44	</xs:element>
45
46	<xs:element name="extraDocument" abstract="false" nillable="false">
47	<xs:complexType mixed="false">
48	<xs:attribute name="href" type="xs:string" use="required" />
49	</xs:complexType>
50	</xs:element>
51
52	<xs:element name="topic" abstract="false" nillable="false">
53	<xs:complexType mixed="false">
54	<xs:sequence>
55	<xs:element ref="topic" minOccurs="0" maxOccurs="unbounded" />
56	<xs:element ref="link" minOccurs="0" maxOccurs="unbounded" />
57	<xs:element ref="enablement" minOccurs="0" maxOccurs="1" />
58	</xs:sequence>
59
60	<xs:attribute name="label" type="xs:string" /> <!-- optional attribute for node -->
61	<xs:attribute name="href" type="xs:string" /> <!-- optional attribute for node -->
62	</xs:complexType>
63	</xs:element>
64
65	<xs:element name="anchor" abstract="false" nillable="false">
66	<xs:complexType mixed="false">
67	<xs:attribute name="id" type="xs:string" use="required" /> <!-- optional attribute for node -->
68	</xs:complexType>
69	</xs:element>
70
71	<xs:element name="link" abstract="false" nillable="false">
72	<xs:complexType mixed="false">
73	<xs:attribute name="toc" type="xs:string" use="required" /> <!-- optional attribute for node -->
74	</xs:complexType>
75	</xs:element>
76
77	<xs:element name="enablement" abstract="false" nillable="false">
78	<xs:complexType mixed="false">
79	<xs:sequence>
80	<xs:element ref="with" minOccurs="0" maxOccurs="unbounded" />
81	<xs:element ref="test" minOccurs="0" maxOccurs="unbounded" />
82	</xs:sequence>
83	</xs:complexType>
84	</xs:element>
85
86	<xs:element name="test" abstract="false" nillable="false">
87	<xs:complexType mixed="false">
88	<xs:attribute name="args" type="xs:string" use="required" /> <!-- optional attribute for node -->
89	<xs:attribute name="property" type="xs:string" use="required" /> <!-- attribute for node -->
90	</xs:complexType>
91	</xs:element>
92
93	<xs:element name="with" abstract="false" nillable="false">
94	<xs:complexType mixed="false">
95	<xs:sequence>
96	<xs:element ref="test" minOccurs="0" maxOccurs="unbounded" />
97	</xs:sequence>
98	<xs:attribute name="variable" type="xs:string" /> <!-- optional attribute for node -->
99	</xs:complexType>
100	</xs:element>
101	</xs:schema>

Added Link Here

(-)service/schema/xml/tocfragment.xsd (+64 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
3	elementFormDefault="qualified">
4	<xs:element name="tree_data">
5	<xs:complexType mixed="false">
6	<xs:sequence>
7	<xs:element name="error" minOccurs="0" />
8	<xs:element ref="numeric_path" minOccurs="0" maxOccurs="1" />
9	<xs:element name="node" minOccurs="0" maxOccurs="unbounded">
10	<!--
11	toc node, only difference b/w toc and topic level node is of
12	is_leaf attrb and order of attrb
13	-->
14	<xs:complexType mixed="false">
15	<xs:sequence>
16	<xs:element name="node" type="TopicNode" minOccurs="0" maxOccurs="unbounded" />
17	</xs:sequence>
18	<xs:attribute name="title" type="xs:string" /> <!-- optional attribute for node -->
19	<xs:attribute name="id" type="xs:string" use="required" /> <!-- attribute for node -->
20	<xs:attribute name="href" type="xs:string" use="required" /> <!-- attribute for node -->
21	<xs:attribute name="openImage" type="xs:string" /> <!-- optional attribute for node -->
22	<xs:attribute name="closedImage" type="xs:string" /> <!-- optional attribute for node -->
23	<xs:attribute name="imageAlt" type="xs:string" /> <!-- optional attribute for node -->
24	<xs:attribute name="image" type="xs:string" default="toc_closed" /> <!-- optional attribute for node -->
25	<xs:attribute name="is_selected" type="xs:boolean"
26	default="true" /> <!-- attribute for node -->
27	<xs:attribute name="is_highlighted" type="xs:boolean"
28	default="true" /> <!-- attribute for node -->
29
30	</xs:complexType>
31	</xs:element>
32	</xs:sequence>
33	</xs:complexType>
34	</xs:element>
35
36	<xs:element name="numeric_path">
37	<xs:complexType>
38	<xs:attribute name="path" type="xs:string" />
39	</xs:complexType>
40	</xs:element>
41
42
43	<xs:complexType name="TopicNode" mixed="false">
44	<xs:sequence>
45	<xs:element name="node" type="TopicNode" minOccurs="0" maxOccurs="unbounded" />
46	</xs:sequence>
47
48	<xs:attribute name="title" type="xs:string" /> <!-- optional attribute for node -->
49	<xs:attribute name="id" type="xs:string" use="required" /> <!-- attribute for node -->
50	<xs:attribute name="href" type="xs:string" use="required" /> <!-- attribute for node -->
51	<xs:attribute name="is_leaf" type="xs:boolean" default="true" /> <!-- attribute for node -->
52	<xs:attribute name="is_selected" type="xs:boolean"
53	default="true" /> <!-- attribute for node -->
54	<xs:attribute name="is_highlighted" type="xs:boolean"
55	default="true" /> <!-- attribute for node -->
56	<xs:attribute name="openImage" type="xs:string" /> <!-- optional attribute for node -->
57	<xs:attribute name="closedImage" type="xs:string" /> <!-- optional attribute for node -->
58	<xs:attribute name="imageAlt" type="xs:string" /> <!-- optional attribute for node -->
59	<xs:attribute name="image" type="xs:string" default="toc_closed" /> <!-- optional attribute for node -->
60
61	</xs:complexType>
62
63
64	</xs:schema>