Attachment #157166 for bug #223475

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




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

 *     Intel Corporation - initial API and implementation
 *     IBM Corporation - 122967 [Help] Remote help system
 *     IBM Corporation - add support for see / see also
 *     IBM Corporation - add support for filtering of the index view
 *******************************************************************************/
package org.eclipse.help.internal.index;



	/**
	 * @param see A see element
	 * @return the entry with matching keyword or null 
	 */
	public IndexEntry getSeeTarget(IndexSee see) {
		if (children == null) getChildren();
		String keyword = see.getKeyword();
		for (Iterator iter = children.iterator(); iter.hasNext();) {
			Object next = iter.next();
			if (next instanceof IndexEntry && keyword.equals(((IndexEntry)next).getKeyword())) {
				return (IndexEntry)next;
			}
		}
		return null;
	}
	
}

Lines 1-5 Link Here

(-)src/org/eclipse/help/internal/index/IndexAssembler.java (-2 / +3 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2006, 2009 IBM Corporation and others.	2	* Copyright (c) 2006, 2010 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	* IBM Corporation - add support for filtering of the index view
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.help.internal.index;	12	package org.eclipse.help.internal.index;
12		13
Lines 195-201 Link Here
195	}	196	}
196	ancestor = ancestor.getParentElement();	197	ancestor = ancestor.getParentElement();
197	}	198	}
198	return ((Index)ancestor).containsSeeTarget(see);	199	return ((Index)ancestor).getSeeTarget(see) != null;
199	}	200	}
200		201
201	/*	202	/*

Lines 7-12 Link Here

(-)META-INF/MANIFEST.MF (+2 lines)
7	Bundle-Vendor: %providerName	7	Bundle-Vendor: %providerName
8	Bundle-Localization: plugin	8	Bundle-Localization: plugin
9	Export-Package: org.apache.lucene.demo.html;x-internal:=true,	9	Export-Package: org.apache.lucene.demo.html;x-internal:=true,
		10	org.eclipse.help.base,
10	org.eclipse.help.browser,	11	org.eclipse.help.browser,
11	org.eclipse.help.internal.base;	12	org.eclipse.help.internal.base;
12	x-friends:="org.eclipse.help.ui,	13	x-friends:="org.eclipse.help.ui,
Lines 15-20 Link Here
15	org.eclipse.ui.intro,	16	org.eclipse.ui.intro,
16	org.eclipse.ua.tests.doc",	17	org.eclipse.ua.tests.doc",
17	org.eclipse.help.internal.base.remote;x-friends:="org.eclipse.ua.tests,org.eclipse.help.webapp,org.eclipse.help.ui",	18	org.eclipse.help.internal.base.remote;x-friends:="org.eclipse.ua.tests,org.eclipse.help.webapp,org.eclipse.help.ui",
		19	org.eclipse.help.internal.base.scope;x-friends:="org.eclipse.help.webapp,org.eclipse.ua.tests",
18	org.eclipse.help.internal.base.util;x-friends:="org.eclipse.help.ui,org.eclipse.help.webapp,org.eclipse.ua.tests",	20	org.eclipse.help.internal.base.util;x-friends:="org.eclipse.help.ui,org.eclipse.help.webapp,org.eclipse.ua.tests",
19	org.eclipse.help.internal.browser;x-friends:="org.eclipse.help.ui,org.eclipse.ua.tests",	21	org.eclipse.help.internal.browser;x-friends:="org.eclipse.help.ui,org.eclipse.ua.tests",
20	org.eclipse.help.internal.browser.macosx;x-friends:="org.eclipse.ua.tests",	22	org.eclipse.help.internal.browser.macosx;x-friends:="org.eclipse.ua.tests",

Lines 19-24 Link Here

(-)plugin.xml (+1 lines)
19	<extension-point id="luceneSearchParticipants" name="%search_participant_extension_point_name" schema="schema/luceneSearchParticipants.exsd"/>	19	<extension-point id="luceneSearchParticipants" name="%search_participant_extension_point_name" schema="schema/luceneSearchParticipants.exsd"/>
20	<extension-point id="server" name="%server_extension_point_name" schema="schema/server.exsd"/>	20	<extension-point id="server" name="%server_extension_point_name" schema="schema/server.exsd"/>
21	<extension-point id="searchParticipant" name="Help Search Participant" schema="schema/searchParticipant.exsd"/>	21	<extension-point id="searchParticipant" name="Help Search Participant" schema="schema/searchParticipant.exsd"/>
		22	<extension-point id="scope" name="Help Scope" schema="schema/scope.exsd"/>
22		23
23	<!-- Stand-alone infocenter application -->	24	<!-- Stand-alone infocenter application -->
24	<extension	25	<extension




<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.help.base" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
      <appInfo>
         <meta.schema plugin="org.eclipse.help.base" id="scope" name="Help Scope"/>
      </appInfo>
      <documentation>
         Support for user defined scopes in the help table of contents, index and search results.
      </documentation>
   </annotation>

   <element name="extension">
      <annotation>
         <appInfo>
            <meta.element />
         </appInfo>
      </annotation>
      <complexType>
         <sequence minOccurs="1" maxOccurs="unbounded">
            <element ref="scope"/>
         </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="scope">
      <annotation>
         <documentation>
            Defines a scope class which contains methods to determine which UA elements are in scope.
         </documentation>
      </annotation>
      <complexType>
         <attribute name="class" type="string" use="required">
            <annotation>
               <documentation>
                  
               </documentation>
               <appInfo>
                  <meta.attribute kind="java"/>
               </appInfo>
            </annotation>
         </attribute>
         <attribute name="id" type="string" use="required">
            <annotation>
               <documentation>
                  An id for this scope which must be unique among scope ids.
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <annotation>
      <appInfo>
         <meta.section type="since"/>
      </appInfo>
      <documentation>
         3.5
      </documentation>
   </annotation>


   <annotation>
      <appInfo>
         <meta.section type="apiinfo"/>
      </appInfo>
      <documentation>
         A class which implements AbstractScope contains functions to determine which elemements should be displayed when the scope is active. The help UI allows the user to specify any of the predefiend scopes.
      </documentation>
   </annotation>


   <annotation>
      <appInfo>
         <meta.section type="copyright"/>
      </appInfo>
      <documentation>
         Copyright (c) 2010 IBM Corporation and others.&lt;br&gt;
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 &lt;a href=&quot;http://www.eclipse.org/legal/epl-v10.html&quot;&gt;http://www.eclipse.org/legal/epl-v10.html&lt;/a&gt;
      </documentation>
   </annotation>

</schema>




/*******************************************************************************
 * Copyright (c) 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.help.base;

import java.util.Locale;
import org.eclipse.help.IIndexEntry;
import org.eclipse.help.IIndexSee;
import org.eclipse.help.IToc;
import org.eclipse.help.ITopic;
import org.eclipse.help.IUAElement;
import org.eclipse.help.internal.base.scope.ScopeUtils;

/**
 * Represents a scope which can be used to specify which topics are shown in the
 * table of contents and which entries will show in the index. The inScope() functions
 * are used by the help system to determine which elements to show. Both the table of
 * contents and index are trees and the help system reads these trees starting with the 
 * root and working down through the children. 
 * 
 * @since 3.5
 */

public abstract class AbstractHelpScope {
	
	/**
	 * Determine whether a table of contents is in scope
	 */
	public abstract boolean inScope(IToc toc);
	
	/**
	 * Determine whether a topic is in scope
	 */
	public abstract boolean inScope(ITopic topic);

	/**
	 * Determine whether an index entry is in scope
	 */
	public abstract boolean inScope(IIndexEntry entry);
	
	/**
	 * a single information center instance can display content in multiple locales.
	 * This function exists to provide a name for a specific locale.
	 * @param locale a string representing the locale used for the UI
	 * @return a name for this scope appropriate for the locale which 
	 * will be used in the scope selection dialog. It is recommended that 
	 * the name be no more than 20 characters long.
	 */
	public abstract String getName(Locale locale);
	
	/**
     * In the default implementation of this method an IndexSee element is in scope
     * if it's target is in scope. May be overridden to exclude more IndexSee elements 
     * from the scope
	 * @param see
	 * @return
	 */
	public boolean inScope(IIndexSee see) {
		return hasInScopeChildren(see);
	}
	
	/**
	 * The help system can build the trees faster if it knows that an out of
	 * scope element cannot have child elements which are in scope. This 
	 * is called a hierarchical scope. If an out of scope element can have
	 * in scope children this function should be overridden and the help 
	 * system will perform a deeper search.
	 */
	public boolean isHierarchicalScope() {
		return true;
	}
	
	/**
	 * Convenience method to make it easier to write subclasses
	 * In the case of an IIndexSee element this method tests 
	 * to see if the target is in scope. For all other elements
	 * it tests all children and if this is not a hierarchical scope 
	 * all descendants are tested.
	 * @param element An element which may have children
	 * @return true if at least one child is in scope
	 */
	public final boolean hasInScopeChildren(IUAElement element) {
		return ScopeUtils.hasInScopeChildren(element, this);
	}
		
}





/*******************************************************************************
 * Copyright (c) 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.help.internal.base.scope;

import java.util.Locale;

import org.eclipse.help.IIndexEntry;
import org.eclipse.help.IIndexSee;
import org.eclipse.help.IToc;
import org.eclipse.help.ITopic;
import org.eclipse.help.base.AbstractHelpScope;
import org.eclipse.help.internal.base.HelpBasePlugin;

public class EnablementScope extends AbstractHelpScope {

	public boolean inScope(IToc toc) {
		return HelpBasePlugin.getActivitySupport().isEnabled(toc.getHref());
	}

	public boolean inScope(ITopic topic) {
		return true;
	}

	public boolean inScope(IIndexEntry entry) {
		return true;
	}

	public boolean inScope(IIndexSee see) {
		return true;
	}
	
	public String getName(Locale locale) {
		return null;
	}

}




/*******************************************************************************
 * Copyright (c) 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.help.internal.base.scope;

import java.util.Locale;

import org.eclipse.help.IIndexEntry;
import org.eclipse.help.IIndexSee;
import org.eclipse.help.IToc;
import org.eclipse.help.ITopic;
import org.eclipse.help.base.AbstractHelpScope;
import org.eclipse.help.internal.base.HelpEvaluationContext;

/**
 * A scope which tests for content filtering
 */

public class FilterScope extends AbstractHelpScope {

	public boolean inScope(IToc toc) {
		if (!toc.isEnabled(HelpEvaluationContext.getContext())) {
			return false;
		}
		return hasInScopeChildren(toc);
	}

	public boolean inScope(ITopic topic) {
		if (!topic.isEnabled(HelpEvaluationContext.getContext())) {
			return false;
		}
		if (topic.getHref() != null) {
			return true;
		}
		return ScopeUtils.hasInScopeDescendent(topic, this);
	}

	public boolean inScope(IIndexEntry entry) {
		return entry.isEnabled(HelpEvaluationContext.getContext());
	}

	public boolean inScope(IIndexSee see) {
		return see.isEnabled(HelpEvaluationContext.getContext());
	}

	public String getName(Locale locale) {
		// TODO Auto-generated method stub
		return null;
	}

}




/*******************************************************************************
 * Copyright (c) 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.help.internal.base.scope;

import java.util.Locale;

import org.eclipse.help.IIndexEntry;
import org.eclipse.help.IIndexSee;
import org.eclipse.help.IToc;
import org.eclipse.help.ITopic;
import org.eclipse.help.base.AbstractHelpScope;

/**
 * A scope which represents the intersection of two or more other scopes
 * An element is in scope only if it is included in every scope passed to the constructor
 */

public class IntersectionScope extends AbstractHelpScope {
	
	AbstractHelpScope[] scopes;
	
	public IntersectionScope(AbstractHelpScope[] scopes) {
		this.scopes = scopes;
	}

	public boolean inScope(IToc toc) {
		for (int scope = 0; scope < scopes.length; scope ++) {
			if (!scopes[scope].inScope(toc)) {
				return false;
			}
		}
		return true;
	}

	public boolean inScope(ITopic topic) {
		for (int scope = 0; scope < scopes.length; scope ++) {
			if (!scopes[scope].inScope(topic)) {
				return false;
			}
		}
		return true;
	}

	public boolean inScope(IIndexEntry entry) {
		for (int scope = 0; scope < scopes.length; scope ++) {
			if (!scopes[scope].inScope(entry)) {
				return false;
			}
		}
		return true;
	}

	public boolean inScope(IIndexSee see) {
		for (int scope = 0; scope < scopes.length; scope ++) {
			if (!scopes[scope].inScope(see)) {
				return false;
			}
		}
		return true;
	}

	public String getName(Locale locale) {
		return null;
	}
	
	public boolean isHierarchicalScope() {
		for (int scope = 0; scope < scopes.length; scope ++) {
			if (!scopes[scope].isHierarchicalScope()) {
				return false;
			}
		}
		return true;
	}

}




/*******************************************************************************
 * Copyright (c) 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.help.internal.base.scope;

import org.eclipse.help.base.AbstractHelpScope;

public class ScopeHandle {
	
	private AbstractHelpScope scope;	
	private String id;
	
	public ScopeHandle( String id, AbstractHelpScope scope) {
		this.id = id;
		this.scope = scope;
	}

	public AbstractHelpScope getScope() {
		return scope;
	}

	public String getId() {
		return id;
	}

}




/*******************************************************************************
 * Copyright (c) 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.help.internal.base.scope;

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

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtensionRegistry;
import org.eclipse.core.runtime.Platform;
import org.eclipse.help.base.AbstractHelpScope;
import org.eclipse.help.internal.base.HelpBasePlugin;

public class ScopeRegistry {

	public static final String SCOPE_XP_NAME = "org.eclipse.help.base.scope"; //$NON-NLS-1$

	private static List scopes = null;
	
	private static ScopeRegistry instance;

	private boolean initialized = false;
	

	private ScopeRegistry() {
	}
	
	public static ScopeRegistry getInstance() {
		if (instance == null) {
			instance = new ScopeRegistry();
		}
		return instance;
	}
	
	public AbstractHelpScope getScope(String id) {
		if (id == null) {
			return new UniversalScope();
		}
		readScopes();
		// Lookup in scope registry
		for (Iterator iter = scopes.iterator(); iter.hasNext();) {
			ScopeHandle handle = (ScopeHandle) iter.next();
			if (id.equals(handle.getId())) {
				return handle.getScope();
			}
		}
		return null;
	}

	synchronized private void readScopes() {
		if (initialized ) {
			return;
		}	
		scopes = new ArrayList();
		IExtensionRegistry registry = Platform.getExtensionRegistry();
		IConfigurationElement[] elements = registry
				.getConfigurationElementsFor(SCOPE_XP_NAME);
		for (int i = 0; i < elements.length; i++) {

			Object obj = null;
			try {
				obj = elements[i].createExecutableExtension("class"); //$NON-NLS-1$
			} catch (CoreException e) {
				HelpBasePlugin.logError("Create extension failed:[" //$NON-NLS-1$
						+ SCOPE_XP_NAME + "].", e); //$NON-NLS-1$
			}
			if (obj instanceof AbstractHelpScope) {
				String id = elements[i].getAttribute("id"); //$NON-NLS-1$
				ScopeHandle filter = new ScopeHandle(id, (AbstractHelpScope) obj);
				scopes.add(filter);
			}
		}
		initialized = true;
	}

}




/*******************************************************************************
 * Copyright (c) 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.help.internal.base.scope;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.help.IIndexEntry;
import org.eclipse.help.IIndexEntry2;
import org.eclipse.help.IIndexSee;
import org.eclipse.help.IToc;
import org.eclipse.help.ITopic;
import org.eclipse.help.IUAElement;
import org.eclipse.help.base.AbstractHelpScope;
import org.eclipse.help.internal.UAElement;
import org.eclipse.help.internal.index.Index;
import org.eclipse.help.internal.index.IndexSee;

/**
 * Utilities to test for enabled topics, index entries etc. 
 */

public class ScopeUtils {
	

	/*
	 * Function to determine whether a topic should be shown in the toc.
	 * For hierarchical scopes the element itself must be in scope.
	 * For non hierarchical scopes if any child is in scope the element should show.
	 */
	public static boolean showInTree(IToc toc, AbstractHelpScope scope) {
		return scope.inScope(toc) || 
		   (!scope.isHierarchicalScope() && hasInScopeDescendent(toc, scope));
	}

	/*
	 * Function to determine whether a topic should be shown in the toc.
	 * For hierarchical scopes the element itself must be in scope.
	 * For non hierarchical scopes if any child is in scope the element should show.
	 */
	public static boolean showInTree(ITopic topic, AbstractHelpScope scope) {
		return scope.inScope(topic) || 
		   (!scope.isHierarchicalScope() && hasInScopeDescendent(topic, scope));
	}
	
	/*
	 * Function to determine whether an entry should be shown in the index.
	 * For hierarchical scopes the element itself must be in scope.
	 * For non hierarchical scopes if any child is in scope the element should show.
	 */
	public static boolean showInTree(IIndexEntry entry, AbstractHelpScope scope) {
		return scope.inScope(entry) || 
		   (!scope.isHierarchicalScope() && hasInScopeDescendent(entry, scope));
	}

	public static boolean hasInScopeDescendent(ITopic topic, AbstractHelpScope scope) {
		ITopic[] subtopics = topic.getSubtopics();
		for (int i = 0; i < subtopics.length; i++) {
			if (showInTree(subtopics[i], scope)) {  
				return true;
			}
		}
		return false;
    }
	
	public static boolean hasInScopeDescendent(IToc toc, AbstractHelpScope scope) {
		ITopic[] topics = toc.getTopics();
		for (int i = 0; i < topics.length; i++) {
			if (showInTree(topics[i], scope)) {  
				return true;
			}
		}
		return false;
    }
	
	public static boolean hasInScopeDescendent(IIndexEntry entry,
			AbstractHelpScope scope) {
		ITopic[] topics = entry.getTopics();
		for (int t = 0; t < topics.length; t++) {
			if (showInTree(topics[t], scope)) {
				return true;
			}
		}
		IIndexEntry[] entries = entry.getSubentries();
		for (int e = 0; e < entries.length; e++) {
			if (showInTree(entries[e], scope)) {
				return true;
			}
		}
		if (entry instanceof IIndexEntry2) {
			IIndexSee[] sees = ((IIndexEntry2)entry).getSees();
			for (int s = 0; s < sees.length; s++) {
				if (scope.inScope(sees[s]) && hasInScopeTarget(sees[s], scope)) {
					return true;
				}
			}
		}
		return false;
	}
	
	public static boolean hasInScopeTarget(IIndexSee see, AbstractHelpScope scope) {
		if (see instanceof IndexSee) {
			IndexSee indexSee = (IndexSee)see;
			UAElement ancestor = indexSee.getParentElement();
			while (!(ancestor instanceof Index)) {
				if (ancestor == null) {
					return true;
				}
				ancestor = ancestor.getParentElement();
			}
			IIndexEntry target = ((Index)ancestor).getSeeTarget(indexSee);
			if (target == null) {
				return false;
			}
			return scope.inScope(target) || hasInScopeDescendent(target, scope);	
		}
		return false;
	}

	/**
	 * Filter out any disabled entries from an array
	 * @param entries an array of entries
	 * @param scope 
	 * @return an array containing only those entries which are enabled
	 */
	public static IIndexEntry[] inScopeEntries(IIndexEntry[] entries, AbstractHelpScope scope) {
		for (int i=0;i<entries.length;++i) {
			if (!scope.inScope(entries[i])) {
				List list = new ArrayList(entries.length);
				for (int j=0;j<entries.length;++j) {
					if (j < i || scope.inScope(entries[j])) {
						list.add(entries[j]);
					}
				}
				return (IIndexEntry[])list.toArray(new IIndexEntry[list.size()]);
			}
		}
		return entries;
	}

	/**
	 * Filter out any disabled topics from an array
	 * @param topics an array of topics
	 * @param scope 
	 * @return an array containing only those topics which are enabled
	 */
	public static ITopic[] inScopeTopics(ITopic[] topics, AbstractHelpScope scope) {
		for (int i=0;i<topics.length;++i) {
			if (!scope.inScope(topics[i])) {
				List list = new ArrayList(topics.length);
				for (int j=0;j<topics.length;++j) {
					if (j < i || scope.inScope(topics[j])) {
						list.add(topics[j]);
					}
				}
				return (ITopic[])list.toArray(new ITopic[list.size()]);
			}
		}
		return topics;
	}

	public static boolean hasInScopeChildren(IUAElement element,
			AbstractHelpScope scope) {
		if (element instanceof IToc) {
			return hasInScopeDescendent((IToc)element, scope);
		}
		if (element instanceof ITopic) {
			return hasInScopeDescendent((ITopic)element, scope);
		}
		if (element instanceof IIndexEntry) {
			return hasInScopeDescendent((IIndexEntry) element, scope);
		}
		if (element instanceof IIndexSee) {
			return hasInScopeTarget((IIndexSee) element, scope);
		}
		return false;
	}

}




/*******************************************************************************
 * Copyright (c) 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.help.internal.base.scope;

import java.util.Locale;

import org.eclipse.help.IIndexEntry;
import org.eclipse.help.IIndexSee;
import org.eclipse.help.IToc;
import org.eclipse.help.ITopic;
import org.eclipse.help.base.AbstractHelpScope;

public class UniversalScope extends AbstractHelpScope {

	public boolean inScope(IToc toc) {
		return true;
	}

	public boolean inScope(ITopic topic) {
		return true;
	}

	public boolean inScope(IIndexEntry entry) {
		return true;
	}

	public boolean inScope(IIndexSee see) {
		return true;
	}

	public String getName(Locale locale) {
		// TODO Auto-generated method stub
		return null;
	}

}




/*******************************************************************************
 * Copyright (c) 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.help.internal.base.scope;

import java.util.HashSet;
import java.util.Locale;
import java.util.Set;

import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.help.IIndexEntry;
import org.eclipse.help.IIndexSee;
import org.eclipse.help.IToc;
import org.eclipse.help.ITopic;
import org.eclipse.help.base.AbstractHelpScope;
import org.eclipse.help.internal.UAElement;
import org.eclipse.help.internal.workingset.AdaptableHelpResource;
import org.eclipse.help.internal.workingset.IHelpWorkingSetManager;
import org.eclipse.help.internal.workingset.WorkingSet;

public class WorkingSetScope extends AbstractHelpScope {
	
	IHelpWorkingSetManager wSetManager;
	private WorkingSet workingSet;
	AdaptableHelpResource[] elements;
	
	public WorkingSetScope(String scope, IHelpWorkingSetManager manager) {
		wSetManager = manager;
		workingSet = wSetManager.getWorkingSet(scope); 
		elements = workingSet.getElements();
		wSetManager = manager;
	}

	public boolean inScope(IToc toc) {
		for (int i = 0; i < elements.length; i++) {	
			for (AdaptableHelpResource adaptable = elements[i]; adaptable != null; ) {
				Object itoc = adaptable.getAdapter(IToc.class); 
				if (toc == itoc) {
					return true;	
				}
				IAdaptable parent= adaptable.getParent();
				if (parent instanceof AdaptableHelpResource) {
					adaptable = (AdaptableHelpResource) parent;
				} else {
				    adaptable = null;
				}
			}		
		}
		return false;
	}

	public boolean inScope(ITopic topic) {
		Set topics = new HashSet();
		IToc toc = null;
		topics.add(topic);
		if (topic instanceof UAElement) {
			for (UAElement uae = (UAElement) topic; uae != null; ) {
				if (uae instanceof IToc)  {
					toc = (IToc) uae;
					uae = null;
				} else if (uae instanceof IIndexEntry) {
					for (int i = 0; i < elements.length; i++) {
						AdaptableHelpResource adaptable = elements[i];
						if (adaptable.getTopic(topic.getHref()) != null) {
							return true;
						}
					}
					return false;
				} else {					
					if (uae instanceof ITopic) {
					    topics.add(uae);
					}
					uae = uae.getParentElement();
				}
			}
		}
		for (int i = 0; i < elements.length; i++) {
			AdaptableHelpResource adaptable = elements[i];
			if (toc != null) {
				Object itoc = adaptable.getAdapter(IToc.class);
				if (toc == itoc) {
					return true;
				}
			}
			Object itopic = adaptable.getAdapter(ITopic.class);
			if (topic != null && topics.contains(itopic)) {
				return true;
			}
			IAdaptable parent = adaptable.getParent();
			if (parent instanceof AdaptableHelpResource) {
				adaptable = (AdaptableHelpResource) parent;
			} else {
				adaptable = null;
			}
		}
		return false;
	}

	public boolean inScope(IIndexEntry entry) {
		return hasInScopeChildren(entry);
	}

	public boolean inScope(IIndexSee see) {
		return hasInScopeChildren(see);
	}

	public String getName(Locale locale) {
		return null;
	}

}

Lines 1-5 Link Here

(-)src/org/eclipse/help/internal/search/SearchResults.java (-5 / +35 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2000, 2009 IBM Corporation and others.	2	* Copyright (c) 2000, 2010 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 16-21 Link Here
16		16
17	import org.eclipse.help.IToc;	17	import org.eclipse.help.IToc;
18	import org.eclipse.help.ITopic;	18	import org.eclipse.help.ITopic;
		19	import org.eclipse.help.base.AbstractHelpScope;
19	import org.eclipse.help.internal.HelpPlugin;	20	import org.eclipse.help.internal.HelpPlugin;
20	import org.eclipse.help.internal.util.URLCoder;	21	import org.eclipse.help.internal.util.URLCoder;
21	import org.eclipse.help.internal.workingset.AdaptableHelpResource;	22	import org.eclipse.help.internal.workingset.AdaptableHelpResource;
Lines 34-39 Link Here
34	private ArrayList scopes;	35	private ArrayList scopes;
35	private int maxHits;	36	private int maxHits;
36	private String locale;	37	private String locale;
		38	private AbstractHelpScope filter;
37	protected SearchHit[] searchHits = new SearchHit[0];	39	protected SearchHit[] searchHits = new SearchHit[0];
38	/**	40	/**
39	* Constructor	41	* Constructor
Lines 46-51 Link Here
46	this.locale = locale;	48	this.locale = locale;
47	this.scopes = getScopes(workingSets);	49	this.scopes = getScopes(workingSets);
48	}	50	}
		51
		52	public void setFilter(AbstractHelpScope filter) {
		53	this.filter = filter;
		54	}
49		55
50	/* (non-Javadoc)	56	/* (non-Javadoc)
51	* @see org.eclipse.help.internal.search.ISearchHitCollector#addHits(List, String)	57	* @see org.eclipse.help.internal.search.ISearchHitCollector#addHits(List, String)
Lines 65-70 Link Here
65	// the scope for the topic, if any	71	// the scope for the topic, if any
66	if (scopes == null) {	72	if (scopes == null) {
67	toc = getTocForTopic(href, locale);	73	toc = getTocForTopic(href, locale);
		74	if (toc == null) {
		75	continue;
		76	}
68	} else {	77	} else {
69	scope = getScopeForTopic(href);	78	scope = getScopeForTopic(href);
70	if (scope == null) {	79	if (scope == null) {
Lines 123-130 Link Here
123	private AdaptableHelpResource getScopeForTopic(String href) {	132	private AdaptableHelpResource getScopeForTopic(String href) {
124	for (int i = 0; i < scopes.size(); i++) {	133	for (int i = 0; i < scopes.size(); i++) {
125	AdaptableHelpResource scope = (AdaptableHelpResource) scopes.get(i);	134	AdaptableHelpResource scope = (AdaptableHelpResource) scopes.get(i);
126	if (scope.getTopic(href) != null)	135	ITopic inScopeTopic = scope.getTopic(href);
127	return scope;	136	if (inScopeTopic != null)
		137	if (filter == null \|\| filter.inScope(inScopeTopic)) {
		138	return scope;
		139	}
128		140
129	// add root toc's extradir topics to search scope	141	// add root toc's extradir topics to search scope
130	IToc tocRoot = getTocForScope(scope, locale);	142	IToc tocRoot = getTocForScope(scope, locale);
Lines 133-138 Link Here
133	if (toc != null) {	145	if (toc != null) {
134	String owningTocHref = toc.getHref();	146	String owningTocHref = toc.getHref();
135	if (owningTocHref == tocRoot.getHref()) {	147	if (owningTocHref == tocRoot.getHref()) {
		148	if (filter == null \|\| filter.inScope(inScopeTopic)) {
		149	return scope;
		150	}
136	return scope;	151	return scope;
137	}	152	}
138	}	153	}
Lines 176-185 Link Here
176	*/	191	*/
177	private IToc getTocForTopic(String href, String locale) {	192	private IToc getTocForTopic(String href, String locale) {
178	IToc[] tocs = HelpPlugin.getTocManager().getTocs(locale);	193	IToc[] tocs = HelpPlugin.getTocManager().getTocs(locale);
		194	boolean foundInToc = false;
179	for (int i = 0; i < tocs.length; i++) {	195	for (int i = 0; i < tocs.length; i++) {
180	ITopic topic = tocs[i].getTopic(href);	196	ITopic topic = tocs[i].getTopic(href);
181	if (topic != null)	197	if (topic != null) {
182	return tocs[i];	198	foundInToc = true;
		199	if (filter == null \|\| filter.inScope(topic)) {
		200	return tocs[i];
		201	}
		202	}
		203	}
		204	if (!foundInToc) {
		205	// test to pick up files in extradirs
		206	IToc toc = HelpPlugin.getTocManager().getOwningToc(href);
		207	if (toc != null) {
		208	foundInToc = true;
		209	if (filter == null \|\| filter.inScope(toc)) {
		210	return toc;
		211	}
		212	}
183	}	213	}
184	return null;	214	return null;
185	}	215	}

Lines 1-5 Link Here

(-)advanced/index.jsp (-1 / +3 lines)
1	<%--	1	<%--
2	Copyright (c) 2000, 2009 IBM Corporation and others.	2	Copyright (c) 2000, 2010 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 18-23 Link Here
18	cookieTest.setMaxAge(3652460*60);	18	cookieTest.setMaxAge(3652460*60);
19	response.addCookie(cookieTest);	19	response.addCookie(cookieTest);
20	}	20	}
		21	// Read the scope parameter
		22	RequestScope.getScopeParameter(request, response, false);
21	%>	23	%>
22		24
23	<html>	25	<html>




/*******************************************************************************
 * Copyright (c) 2006, 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at

// Tree code specific to the help toc

var showExpanders = true;
var ajaxPath = "tocfragment"; 
var pendingSynchTopic = null; // Should the toc be synchronized when the view becomes visible

// The default value of ajaxPath works from jsp files but needs to be overridden to 
// a non relative path to work from scripts launched from any page

function setAjaxPrefix(prefix) {
    ajaxPath = prefix + "/tocfragment";
}

/*


function makeNodeRequest(parameters) {
    var href;
    href = ajaxPath +parameters; 
        href = ajaxPrefix + "/tocfragment" +parameters; 
    } else {
        href = "../tocfragment" + parameters;
    }
    var callback = function(xml) { updateTocTree(xml);}; 
    var errorCallback = function() { 
        // alert("ajax error"); 


function makeShowInTocRequest(parameters) {
    var href;
    href = ajaxPath +parameters; 
        href = ajaxPrefix + "/tocfragment" +parameters; 
    } else {
        href = "../tocfragment" + parameters;
    }
    var callback = function(xml) { showInToc(xml);}; 
    var errorCallback = function() { 
        // alert("ajax error"); 

Lines 1-5 Link Here

(-)advanced/tocView.jsp (-3 / +3 lines)
1	<%--	1	<%--
2	Copyright (c) 2000, 2009 IBM Corporation and others.	2	Copyright (c) 2000, 2010 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 72-80 Link Here
72	setRootAccessibility();	72	setRootAccessibility();
73	loadChildren(null);	73	loadChildren(null);
74		74
75	// Set prefix for AJAX calls by removing advanced/tocView.jsp from location	75	// Set prefix for AJAX calls by removing tocView.jsp from location
76	var locationHref = window.location.href;	76	var locationHref = window.location.href;
77	var slashAdvanced = locationHref.lastIndexOf('/advanced');	77	var slashAdvanced = locationHref.lastIndexOf('/tocView.jsp');
78	if(slashAdvanced > 0) {	78	if(slashAdvanced > 0) {
79	setAjaxPrefix(locationHref.substr(0, slashAdvanced));	79	setAjaxPrefix(locationHref.substr(0, slashAdvanced));
80	}	80	}

Lines 83-89 Link Here

(-)plugin.xml (-2 / +2 lines)
83	httpcontextId="help">	83	httpcontextId="help">
84	</servlet>	84	</servlet>
85	<servlet	85	<servlet
86	alias="/tocfragment"	86	alias="/advanced/tocfragment"
87	class="org.eclipse.help.internal.webapp.servlet.TocFragmentServlet"	87	class="org.eclipse.help.internal.webapp.servlet.TocFragmentServlet"
88	httpcontextId="help">	88	httpcontextId="help">
89	</servlet>	89	</servlet>
Lines 93-99 Link Here
93	httpcontextId="help">	93	httpcontextId="help">
94	</servlet>	94	</servlet>
95	<servlet	95	<servlet
96	alias="/indexfragment"	96	alias="/advanced/indexfragment"
97	class="org.eclipse.help.internal.webapp.servlet.IndexFragmentServlet"	97	class="org.eclipse.help.internal.webapp.servlet.IndexFragmentServlet"
98	httpcontextId="help">	98	httpcontextId="help">
99	</servlet>	99	</servlet>

Lines 1-5 Link Here

(-)src/org/eclipse/help/internal/webapp/data/PrintData.java (-5 / +10 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2007, 2009 IBM Corporation and others.	2	* Copyright (c) 2007, 2010 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 33-40 Link Here
33	import org.eclipse.help.HelpSystem;	33	import org.eclipse.help.HelpSystem;
34	import org.eclipse.help.IToc;	34	import org.eclipse.help.IToc;
35	import org.eclipse.help.ITopic;	35	import org.eclipse.help.ITopic;
		36	import org.eclipse.help.base.AbstractHelpScope;
36	import org.eclipse.help.internal.HelpPlugin;	37	import org.eclipse.help.internal.HelpPlugin;
37	import org.eclipse.help.internal.base.BaseHelpSystem;	38	import org.eclipse.help.internal.base.BaseHelpSystem;
		39	import org.eclipse.help.internal.base.scope.ScopeUtils;
38	import org.eclipse.help.internal.search.HTMLDocParser;	40	import org.eclipse.help.internal.search.HTMLDocParser;
39	import org.eclipse.help.internal.webapp.HelpWebappPlugin;	41	import org.eclipse.help.internal.webapp.HelpWebappPlugin;
40	import org.eclipse.help.internal.xhtml.DynamicXHTMLProcessor;	42	import org.eclipse.help.internal.xhtml.DynamicXHTMLProcessor;
Lines 70-75 Link Here
70	// flag right-to-left direction of text	72	// flag right-to-left direction of text
71	private boolean isRTL;	73	private boolean isRTL;
72		74
		75	private AbstractHelpScope scope;
		76
73	/*	77	/*
74	* Constructs the print data for the given request.	78	* Constructs the print data for the given request.
75	*/	79	*/
Lines 81-86 Link Here
81	}	85	}
82		86
83	isRTL = UrlUtil.isRTL(request, response);	87	isRTL = UrlUtil.isRTL(request, response);
		88	scope = RequestScope.getScopeFromRequest(request, response);
84		89
85	String confirmString = request.getParameter("confirmed"); //$NON-NLS-1$	90	String confirmString = request.getParameter("confirmed"); //$NON-NLS-1$
86	if ((confirmString != null) && ("true".equals(confirmString))) { //$NON-NLS-1$	91	if ((confirmString != null) && ("true".equals(confirmString))) { //$NON-NLS-1$
Lines 209-215 Link Here
209	topicsRequested++;	214	topicsRequested++;
210	}	215	}
211		216
212	ITopic[] subtopics = EnabledTopicUtils.getEnabled(topic.getSubtopics());	217	ITopic[] subtopics = ScopeUtils.inScopeTopics(topic.getSubtopics(), scope);
213	for (int i = 0; i < subtopics.length; ++i) {	218	for (int i = 0; i < subtopics.length; ++i) {
214	topicsRequested += topicsRequested(subtopics[i]);	219	topicsRequested += topicsRequested(subtopics[i]);
215	}	220	}
Lines 243-249 Link Here
243	if (href != null && href.length() > 0) {	248	if (href != null && href.length() > 0) {
244	tocGenerated++;	249	tocGenerated++;
245	}	250	}
246	ITopic[] subtopics = EnabledTopicUtils.getEnabled(topic.getSubtopics());	251	ITopic[] subtopics = ScopeUtils.inScopeTopics(topic.getSubtopics(), scope);
247	for (int i = 0; i < subtopics.length; ++i) {	252	for (int i = 0; i < subtopics.length; ++i) {
248	tocGenerated = generateToc(subtopics[i], String.valueOf(i + 1), tocGenerated, out);	253	tocGenerated = generateToc(subtopics[i], String.valueOf(i + 1), tocGenerated, out);
249	}	254	}
Lines 267-273 Link Here
267	tocGenerated++;	272	tocGenerated++;
268	}	273	}
269		274
270	ITopic[] subtopics = EnabledTopicUtils.getEnabled(topic.getSubtopics());	275	ITopic[] subtopics = ScopeUtils.inScopeTopics(topic.getSubtopics(), scope);
271	for (int i = 0; i < subtopics.length; ++i) {	276	for (int i = 0; i < subtopics.length; ++i) {
272	String subsectionId = sectionId + "." + (i + 1); //$NON-NLS-1$	277	String subsectionId = sectionId + "." + (i + 1); //$NON-NLS-1$
273	tocGenerated = generateToc(subtopics[i], subsectionId, tocGenerated, out);	278	tocGenerated = generateToc(subtopics[i], subsectionId, tocGenerated, out);
Lines 311-317 Link Here
311	out.write(content);	316	out.write(content);
312	}	317	}
313	}	318	}
314	ITopic[] subtopics = EnabledTopicUtils.getEnabled(topic.getSubtopics());	319	ITopic[] subtopics = ScopeUtils.inScopeTopics(topic.getSubtopics(), scope);
315	for (int i = 0; i < subtopics.length; ++i) {	320	for (int i = 0; i < subtopics.length; ++i) {
316	String subsectionId = (sectionId != null ? sectionId + "." : "") + (i + 1); //$NON-NLS-1$ //$NON-NLS-2$	321	String subsectionId = (sectionId != null ? sectionId + "." : "") + (i + 1); //$NON-NLS-1$ //$NON-NLS-2$
317	topicsGenerated = generateContent(subtopics[i], subsectionId, topicsGenerated, generated, out);	322	topicsGenerated = generateContent(subtopics[i], subsectionId, topicsGenerated, generated, out);




/*******************************************************************************
 * Copyright (c) 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.help.internal.webapp.data;

import java.util.ArrayList;
import java.util.List;
import java.util.StringTokenizer;

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

import org.eclipse.help.HelpSystem;
import org.eclipse.help.base.AbstractHelpScope;
import org.eclipse.help.internal.base.HelpBasePlugin;
import org.eclipse.help.internal.base.scope.EnablementScope;
import org.eclipse.help.internal.base.scope.FilterScope;
import org.eclipse.help.internal.base.scope.IntersectionScope;
import org.eclipse.help.internal.base.scope.ScopeRegistry;
import org.eclipse.help.internal.base.scope.UniversalScope;
import org.eclipse.help.internal.base.scope.WorkingSetScope;
import org.eclipse.help.internal.webapp.servlet.WebappWorkingSetManager;

public class RequestScope {
	
	private static final String SCOPE_PARAMETER_NAME = "subset"; //$NON-NLS-1$
	private static final String SCOPE_COOKIE_NAME = "filter"; //$NON-NLS-1$

	public static AbstractHelpScope getScopeFromRequest(HttpServletRequest req, HttpServletResponse resp ) {
		if (!HelpSystem.isShared()) {
			// Filtering by scope is currently only in information center mode
			if (HelpBasePlugin.getActivitySupport().isFilteringEnabled()) {
				AbstractHelpScope[] scopes = { new FilterScope(), new EnablementScope() };
				return new IntersectionScope(scopes);
			}
			return new FilterScope();
		}

		String scopesFromParameter= getScopeParameter(req, resp, true);
		List scopes = new ArrayList();
		if (scopesFromParameter != null) {
			StringTokenizer tokenizer = new StringTokenizer(scopesFromParameter, "/"); //$NON-NLS-1$
			while (tokenizer.hasMoreTokens()) {
				String nextScope = tokenizer.nextToken().trim();
				if (!nextScope.equals("")) { //$NON-NLS-1$
					AbstractHelpScope scope = ScopeRegistry.getInstance().getScope(nextScope);
					if (scope != null) {
						scopes.add(scope);
					} else {
						// Try for a working set
						try {
							WorkingSetScope workingSetScope = new WorkingSetScope(
									nextScope, new WebappWorkingSetManager(req,
											resp, UrlUtil.getLocale(req, resp)));
							scopes.add(workingSetScope);
						} catch (Exception e) {
						}
					}

				}
			}
		}
		switch (scopes.size()) {
		case 0:
			return new UniversalScope();
		case 1:
			return (AbstractHelpScope) scopes.get(0);
		default:
			return new IntersectionScope(
					(AbstractHelpScope[]) scopes.toArray(new AbstractHelpScope[scopes.size()]));
		}	
	}
	
	public static String getScopeParameter(HttpServletRequest request, HttpServletResponse response, boolean readCookie ) {
		// See if there is a scope parameter, if so save as cookie
		String[] scope = request.getParameterValues(SCOPE_PARAMETER_NAME); 
		String scopeString = null;
		if (scope != null) {
			// save scope (in session cookie) for later use in a user session
			// If there are multiple values separate them with an '&'
			if (scope != null && scope.length > 0 && response != null) {
				scopeString = scope[0];			
				for (int s = 1; s < scope.length; s++) {
					scopeString += '/';
					scopeString += scope[s];
				}
				Cookie scopeCookie = new Cookie(SCOPE_COOKIE_NAME, scopeString); 
				response.addCookie(scopeCookie);
				return scopeString;
			}
		} else {
			if (readCookie) {
				// check if scope was passed earlier in this session
				Cookie[] cookies = request.getCookies();
				if (cookies != null) {
					for (int c = 0; c < cookies.length; c++) {
						if (SCOPE_COOKIE_NAME.equals(cookies[c].getName())) { 
							scopeString = cookies[c].getValue();
							break;
						}
					}
				}
			} else if (response != null) {
				// No scope parameter and cookie is stale. Set the cookie to show all
				scopeString = "all"; //$NON-NLS-1$
				Cookie scopeCookie = new Cookie(SCOPE_COOKIE_NAME, scopeString); 
				response.addCookie(scopeCookie);
			}
		}
		return scopeString;
	}

}




import org.eclipse.help.IHelpResource;
import org.eclipse.help.IToc;
import org.eclipse.help.ITopic;
import org.eclipse.help.base.AbstractHelpScope;
import org.eclipse.help.internal.HelpPlugin;
import org.eclipse.help.internal.base.BaseHelpSystem;
import org.eclipse.help.internal.base.HelpBasePlugin;

					.getProgressMonitor(getLocale());
			if (pm.isDone()) {
				this.indexCompletion = 100;
				AbstractHelpScope filter = RequestScope.getScopeFromRequest(request, response);
				SearchResults results = createHitCollector(filter);
				BaseHelpSystem.getSearchManager().search(createSearchQuery(),
						results, pm);
				hits = results.getSearchHits();

				getLocale());
	}

	private SearchResults createHitCollector(AbstractHelpScope filter) {
		WorkingSet[] workingSets;
		if (request.getParameterValues("scopedSearch") != null) { //$NON-NLS-1$
			// scopes are books (advanced search)

			} catch (NumberFormatException nfe) {
			}
		}
		return new SearchResultFilter(workingSets, maxHits, getLocale(), filter);
	}

	/**

	 * that implement ISearchEngineResult2 and canOpen() returns true.
	 */
	private static class SearchResultFilter extends SearchResults {
		public SearchResultFilter(WorkingSet[] workingSets, int maxHits, String locale, AbstractHelpScope filter) {
			super(workingSets, maxHits, locale);
			setFilter(filter);
		}
		public void addHits(List hits, String highlightTerms) {
			List filtered = new ArrayList();




/*******************************************************************************
 * Copyright (c) 2009, 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at


import org.eclipse.core.runtime.Path;
import org.eclipse.help.ITopic;
import org.eclipse.help.base.AbstractHelpScope;
import org.eclipse.help.internal.HelpPlugin;
import org.eclipse.help.internal.base.scope.ScopeUtils;
import org.eclipse.help.internal.toc.Toc;
import org.eclipse.help.internal.webapp.data.RequestScope;
import org.eclipse.help.internal.webapp.data.UrlUtil;

public class ChildLinkInserter {

	private OutputStream out;
	private static final String NO_CHILDREN = "no_child_topics"; //$NON-NLS-1$
	private static final String HAS_CHILDREN = "has_child_topics"; //$NON-NLS-1$
	private AbstractHelpScope scope;

	public ChildLinkInserter(HttpServletRequest req, OutputStream out) {
		this.req = req;
		this.out = out;
		scope = RequestScope.getScopeFromRequest(req, null);
	}
	
	public void addContents(String encoding) throws IOException {	

	    }
	    StringBuffer links = new StringBuffer("\n<ul class=\"childlinks\">\n"); //$NON-NLS-1$
		for (int i=0;i<subtopics.length;++i) {
			if (ScopeUtils.showInTree(subtopics[i], scope)) {
				links.append("\n<li><a href=\""); //$NON-NLS-1$
				String href = subtopics[i].getHref();
				if (href == null) {

		if (topic != null && topic.getHref() != null) {
			ITopic[] subtopics = topic.getSubtopics();
			for (int i = 0; i < subtopics.length; ++i) {
				if (ScopeUtils.showInTree(subtopics[i], scope)) {
					out.write(HAS_CHILDREN.getBytes(UTF_8));
					return;
				}

Lines 69-75 Link Here

(-)src/org/eclipse/help/internal/webapp/servlet/CookieUtil.java (-1 / +1 lines)
69	* Saves string in multiple browser cookies. Cookies can store limited	69	* Saves string in multiple browser cookies. Cookies can store limited
70	* length string. This method will attemt to split string among multiple	70	* length string. This method will attemt to split string among multiple
71	* cookies. The following cookies will be set name1=length <substing1	71	* cookies. The following cookies will be set name1=length <substing1
72	* name2=substrging2 ... namen=substringn	72	* name2=substring2 ... namen=substringn
73	*	73	*
74	* @param data	74	* @param data
75	* a string containing legal characters for cookie value	75	* a string containing legal characters for cookie value




/*******************************************************************************
 * Copyright (c) 2007, 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at

import org.eclipse.help.IIndexSee;
import org.eclipse.help.IIndexSubpath;
import org.eclipse.help.ITopic;
import org.eclipse.help.base.AbstractHelpScope;
import org.eclipse.help.internal.HelpPlugin;
import org.eclipse.help.internal.base.BaseHelpSystem;
import org.eclipse.help.internal.base.scope.ScopeUtils;
import org.eclipse.help.internal.webapp.WebappResources;
import org.eclipse.help.internal.webapp.data.ActivitiesData;
import org.eclipse.help.internal.webapp.data.RequestScope;
import org.eclipse.help.internal.webapp.data.UrlUtil;
import org.eclipse.osgi.util.NLS;


		    resp.setHeader("Pragma","no-cache");  //$NON-NLS-1$ //$NON-NLS-2$
		    resp.setDateHeader ("Expires", 0); 	 //$NON-NLS-1$	
		}
		AbstractHelpScope scope = RequestScope.getScopeFromRequest(req, resp);
		Serializer serializer = new Serializer(locale, scope);
		String response = serializer.generateIndexXml();	
		locale2Response.put(locale, response);
		resp.getWriter().write(response);

		private IIndexEntry[] entries;
		private boolean enablePrevious = true;
		private boolean enableNext = true;
		private AbstractHelpScope scope;

		public Serializer(String locale, AbstractHelpScope scope) {
			this.locale = locale;
			this.scope = scope;
			index = HelpPlugin.getIndexManager().getIndex(locale);
			buf = new StringBuffer();
		}

		}
		
		private int enabledEntryCount(IIndexEntry entry) {
			if (!ScopeUtils.hasInScopeDescendent(entry, scope)) return 0;
			if (entry.getKeyword() == null || entry.getKeyword().length() == 0) {
				return 0;
			}
			int count = 1;
		    int topicCount = enabledTopicCount(entry);

			IIndexEntry[] subentries = entry.getSubentries();
		    int subentryCount = 0;
			for (int i=0; i<subentries.length; ++i) {
				count += enabledEntryCount(subentries[i]);
			}
			
			int seeCount = 0;
			IIndexSee[] sees = entry instanceof IIndexEntry2 ? ((IIndexEntry2)entry).getSees() : new IIndexSee[0];
			for (int s = 0; s < sees.length; s++) {
				if (scope.inScope(sees[s])) {
					seeCount++;
				}
			}
			
			if (topicCount + subentryCount + seeCount > 1) {
				count += topicCount;
			}
			count += subentryCount;
			count += seeCount;
            return count;
		}

		private int enabledTopicCount(IIndexEntry entry) {
			int topicCount = 0;
		    ITopic[] topics = entry.getTopics();
		    for (int i = 0; i < topics.length; i++) {
		    	if (scope.inScope(topics[i])) {
		    		topicCount++;
		    	}
		    }
			return topicCount;
		}
		
		private void generateEmptyIndexMessage() {
			buf.append("<node"); //$NON-NLS-1$			

		}
		
		private void generateEntry(IIndexEntry entry, int level, String id) {
			if (!ScopeUtils.hasInScopeDescendent(entry, scope)) return;
			if (entry.getKeyword() != null && entry.getKeyword().length() > 0) {
				ITopic[] topics = ScopeUtils.inScopeTopics(entry.getTopics(), scope);
				IIndexEntry[] subentries = ScopeUtils.inScopeEntries(entry.getSubentries(), scope);
				IIndexSee[] sees; 
				if (entry instanceof IIndexEntry2) {
					sees = ((IIndexEntry2)entry).getSees();

		private void generateSees(IIndexSee[] sees) {
	        for (int i = 0; i < sees.length; i++) {
	        	IIndexSee see = sees[i];
				if (scope.inScope(see)) {
					//
					String key = see.isSeeAlso() ? "SeeAlso" : "See"; //$NON-NLS-1$ //$NON-NLS-2$
					String seePrefix = WebappResources.getString(key, UrlUtil




/*******************************************************************************
 * Copyright (c) 2007, 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at

import javax.servlet.http.HttpServletResponse;

import org.eclipse.help.ITopic;
import org.eclipse.help.base.AbstractHelpScope;
import org.eclipse.help.internal.HelpPlugin;
import org.eclipse.help.internal.webapp.WebappResources;
import org.eclipse.help.internal.webapp.data.RequestScope;
import org.eclipse.help.internal.webapp.data.UrlUtil;
import org.eclipse.help.webapp.IFilter;


		}

		PrintWriter writer = new PrintWriter(new OutputStreamWriter(out, "UTF-8")); //$NON-NLS-1$
		AbstractHelpScope scope = RequestScope.getScopeFromRequest(req, resp);
		writeContent(topic, path, locale, writer, UrlUtil.isRTL(req, resp), scope);
		writer.close();
	}
	

		return topic;
	}
	
	private void writeContent(ITopic topic, String path, Locale locale, PrintWriter writer, boolean isRTL, AbstractHelpScope scope) {
		writer.write(XHTML_1);
		writer.write(topic.getLabel());
		if (isRTL) {

		writer.write("<ul class=\"NavList\">\n"); //$NON-NLS-1$
		ITopic[] subtopics = topic.getSubtopics();
		for (int i=0;i<subtopics.length;++i) {
			if (scope.inScope(subtopics[i])) {
				writer.write("<li><a href=\""); //$NON-NLS-1$
				String href = subtopics[i].getHref();
				if (href == null) {




/*******************************************************************************
 * Copyright (c) 2006, 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at


import org.eclipse.help.IToc;
import org.eclipse.help.ITopic;
import org.eclipse.help.base.AbstractHelpScope;
import org.eclipse.help.internal.Topic;
import org.eclipse.help.internal.base.scope.ScopeUtils;
import org.eclipse.help.internal.toc.Toc;
import org.eclipse.help.internal.webapp.WebappResources;
import org.eclipse.help.internal.webapp.data.EnabledTopicUtils;
import org.eclipse.help.internal.webapp.data.IconFinder;
import org.eclipse.help.internal.webapp.data.RequestScope;
import org.eclipse.help.internal.webapp.data.TocData;
import org.eclipse.help.internal.webapp.data.UrlUtil;


		
		readParameters(req);
		
		AbstractHelpScope scope = RequestScope.getScopeFromRequest(req, resp);
		Serializer serializer = new Serializer(data, req.getLocale(), scope);
		String response = serializer.generateTreeXml();	
		locale2Response.put(locale, response);
		resp.getWriter().write(response);

		private StringBuffer buf;
		private int requestKind;
		private Locale locale;
		private AbstractHelpScope scope;
		private static final int REQUEST_SHOW_IN_TOC = 1;      // Get the path to an element an element based on its href
		private static final int REQUEST_SHOW_TOCS = 2;        // Show all the tocs but not their children
		private static final int REQUEST_SHOW_CHILDREN = 3;    // Show the children of a node
		private static final int REQUEST_EXPAND_PATH = 4;      // Get all the nodes requires to expand a path in the tree

		public Serializer(TocData data, Locale locale, AbstractHelpScope scope) {
			tocData = data;
			buf = new StringBuffer();
			this.locale = locale;
			this.scope = scope;
			if (tocData.isExpandPath()) {
				requestKind = REQUEST_EXPAND_PATH;
			} else if (tocData.getTopicHref() != null) {

				// Count the number of enabled tocs
				int enabled = 0;
				for (int i = 0; i <= selectedToc; i++) {
					if (ScopeUtils.showInTree(tocData.getTocs()[i], scope)) {
						enabled++;
					}
				}

	
		private void serializeToc(IToc toc, int tocIndex, ITopic[] topicPath, boolean isSelected) {		
			
			if (!ScopeUtils.showInTree(toc, scope)) {
				// do not generate toc when there are no leaf topics or if it is filtered out
				return;
			}
			ITopic[] topics = toc.getTopics();


		private void serializeTopic(ITopic topic, ITopic[] topicPath, boolean isSelected, String parentPath)  {
		    ITopic[] subtopics = topic.getSubtopics();
		     boolean isLeaf = !ScopeUtils.hasInScopeDescendent(topic, scope);
		    buf.append("<node"); //$NON-NLS-1$
			if (topic.getLabel() != null) { 
				buf.append('\n'	+ "      title=\"" + XMLGenerator.xmlEscape(topic.getLabel()) + '"'); //$NON-NLS-1$

				// Show the children of this node
				for (int subtopic = 0; subtopic < childTopics.length; subtopic++) {
				    ITopic childTopic = childTopics[subtopic];
				    if (ScopeUtils.showInTree(childTopic, scope)) {
					    serializeTopic(childTopic, null, false, addSuffix(parentPath, subtopic));
				    }
				}
			} else if (topicPath != null) {
				for (int subtopic = 0; subtopic < childTopics.length; subtopic++) {
					ITopic childTopic = childTopics[subtopic];
				    if (ScopeUtils.showInTree(childTopic, scope)) {
						if (topicPath[0].getLabel().equals(childTopic.getLabel())) {
							ITopic[] newPath = null;
							if (topicPath.length > 1) {

Return to bug 223475

Lines 26-31 Link Here

(-)src/org/eclipse/help/internal/webapp/data/SearchData.java (-4 / +7 lines)
26	import org.eclipse.help.IHelpResource;	26	import org.eclipse.help.IHelpResource;
27	import org.eclipse.help.IToc;	27	import org.eclipse.help.IToc;
28	import org.eclipse.help.ITopic;	28	import org.eclipse.help.ITopic;
		29	import org.eclipse.help.base.AbstractHelpScope;
29	import org.eclipse.help.internal.HelpPlugin;	30	import org.eclipse.help.internal.HelpPlugin;
30	import org.eclipse.help.internal.base.BaseHelpSystem;	31	import org.eclipse.help.internal.base.BaseHelpSystem;
31	import org.eclipse.help.internal.base.HelpBasePlugin;	32	import org.eclipse.help.internal.base.HelpBasePlugin;
Lines 348-354 Link Here
348	.getProgressMonitor(getLocale());	349	.getProgressMonitor(getLocale());
349	if (pm.isDone()) {	350	if (pm.isDone()) {
350	this.indexCompletion = 100;	351	this.indexCompletion = 100;
351	SearchResults results = createHitCollector();	352	AbstractHelpScope filter = RequestScope.getScopeFromRequest(request, response);
		353	SearchResults results = createHitCollector(filter);
352	BaseHelpSystem.getSearchManager().search(createSearchQuery(),	354	BaseHelpSystem.getSearchManager().search(createSearchQuery(),
353	results, pm);	355	results, pm);
354	hits = results.getSearchHits();	356	hits = results.getSearchHits();
Lines 386-392 Link Here
386	getLocale());	388	getLocale());
387	}	389	}
388		390
389	private SearchResults createHitCollector() {	391	private SearchResults createHitCollector(AbstractHelpScope filter) {
390	WorkingSet[] workingSets;	392	WorkingSet[] workingSets;
391	if (request.getParameterValues("scopedSearch") != null) { //$NON-NLS-1$	393	if (request.getParameterValues("scopedSearch") != null) { //$NON-NLS-1$
392	// scopes are books (advanced search)	394	// scopes are books (advanced search)
Lines 414-420 Link Here
414	} catch (NumberFormatException nfe) {	416	} catch (NumberFormatException nfe) {
415	}	417	}
416	}	418	}
417	return new SearchResultFilter(workingSets, maxHits, getLocale());	419	return new SearchResultFilter(workingSets, maxHits, getLocale(), filter);
418	}	420	}
419		421
420	/**	422	/**
Lines 533-540 Link Here
533	* that implement ISearchEngineResult2 and canOpen() returns true.	535	* that implement ISearchEngineResult2 and canOpen() returns true.
534	*/	536	*/
535	private static class SearchResultFilter extends SearchResults {	537	private static class SearchResultFilter extends SearchResults {
536	public SearchResultFilter(WorkingSet[] workingSets, int maxHits, String locale) {	538	public SearchResultFilter(WorkingSet[] workingSets, int maxHits, String locale, AbstractHelpScope filter) {
537	super(workingSets, maxHits, locale);	539	super(workingSets, maxHits, locale);
		540	setFilter(filter);
538	}	541	}
539	public void addHits(List hits, String highlightTerms) {	542	public void addHits(List hits, String highlightTerms) {
540	List filtered = new ArrayList();	543	List filtered = new ArrayList();

Added Link Here

(-)schema/scope.exsd (+109 lines)
1	<?xml version='1.0' encoding='UTF-8'?>
2	<!-- Schema file written by PDE -->
3	<schema targetNamespace="org.eclipse.help.base" xmlns="http://www.w3.org/2001/XMLSchema">
4	<annotation>
5	<appInfo>
6	<meta.schema plugin="org.eclipse.help.base" id="scope" name="Help Scope"/>
7	</appInfo>
8	<documentation>
9	Support for user defined scopes in the help table of contents, index and search results.
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="1" maxOccurs="unbounded">
21	<element ref="scope"/>
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="scope">
51	<annotation>
52	<documentation>
53	Defines a scope class which contains methods to determine which UA elements are in scope.
54	</documentation>
55	</annotation>
56	<complexType>
57	<attribute name="class" type="string" use="required">
58	<annotation>
59	<documentation>
60
61	</documentation>
62	<appInfo>
63	<meta.attribute kind="java"/>
64	</appInfo>
65	</annotation>
66	</attribute>
67	<attribute name="id" type="string" use="required">
68	<annotation>
69	<documentation>
70	An id for this scope which must be unique among scope ids.
71	</documentation>
72	</annotation>
73	</attribute>
74	</complexType>
75	</element>
76
77	<annotation>
78	<appInfo>
79	<meta.section type="since"/>
80	</appInfo>
81	<documentation>
82	3.5
83	</documentation>
84	</annotation>
85
86
87	<annotation>
88	<appInfo>
89	<meta.section type="apiinfo"/>
90	</appInfo>
91	<documentation>
92	A class which implements AbstractScope contains functions to determine which elemements should be displayed when the scope is active. The help UI allows the user to specify any of the predefiend scopes.
93	</documentation>
94	</annotation>
95
96
97	<annotation>
98	<appInfo>
99	<meta.section type="copyright"/>
100	</appInfo>
101	<documentation>
102	Copyright (c) 2010 IBM Corporation and others.<br>
103	All rights reserved. This program and the accompanying materials are made
104	available under the terms of the Eclipse Public License v1.0 which accompanies
105	this distribution, and is available at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>
106	</documentation>
107	</annotation>
108
109	</schema>

Added Link Here

(-)src/org/eclipse/help/base/AbstractHelpScope.java (+95 lines)
1	/*******************************************************************************
2	* Copyright (c) 2010 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
12	package org.eclipse.help.base;
13
14	import java.util.Locale;
15	import org.eclipse.help.IIndexEntry;
16	import org.eclipse.help.IIndexSee;
17	import org.eclipse.help.IToc;
18	import org.eclipse.help.ITopic;
19	import org.eclipse.help.IUAElement;
20	import org.eclipse.help.internal.base.scope.ScopeUtils;
21
22	/**
23	* Represents a scope which can be used to specify which topics are shown in the
24	* table of contents and which entries will show in the index. The inScope() functions
25	* are used by the help system to determine which elements to show. Both the table of
26	* contents and index are trees and the help system reads these trees starting with the
27	* root and working down through the children.
28	*
29	* @since 3.5
30	*/
31
32	public abstract class AbstractHelpScope {
33
34	/**
35	* Determine whether a table of contents is in scope
36	*/
37	public abstract boolean inScope(IToc toc);
38
39	/**
40	* Determine whether a topic is in scope
41	*/
42	public abstract boolean inScope(ITopic topic);
43
44	/**
45	* Determine whether an index entry is in scope
46	*/
47	public abstract boolean inScope(IIndexEntry entry);
48
49	/**
50	* a single information center instance can display content in multiple locales.
51	* This function exists to provide a name for a specific locale.
52	* @param locale a string representing the locale used for the UI
53	* @return a name for this scope appropriate for the locale which
54	* will be used in the scope selection dialog. It is recommended that
55	* the name be no more than 20 characters long.
56	*/
57	public abstract String getName(Locale locale);
58
59	/**
60	* In the default implementation of this method an IndexSee element is in scope
61	* if it's target is in scope. May be overridden to exclude more IndexSee elements
62	* from the scope
63	* @param see
64	* @return
65	*/
66	public boolean inScope(IIndexSee see) {
67	return hasInScopeChildren(see);
68	}
69
70	/**
71	* The help system can build the trees faster if it knows that an out of
72	* scope element cannot have child elements which are in scope. This
73	* is called a hierarchical scope. If an out of scope element can have
74	* in scope children this function should be overridden and the help
75	* system will perform a deeper search.
76	*/
77	public boolean isHierarchicalScope() {
78	return true;
79	}
80
81	/**
82	* Convenience method to make it easier to write subclasses
83	* In the case of an IIndexSee element this method tests
84	* to see if the target is in scope. For all other elements
85	* it tests all children and if this is not a hierarchical scope
86	* all descendants are tested.
87	* @param element An element which may have children
88	* @return true if at least one child is in scope
89	*/
90	public final boolean hasInScopeChildren(IUAElement element) {
91	return ScopeUtils.hasInScopeChildren(element, this);
92	}
93
94	}
95

Added Link Here

(-)src/org/eclipse/help/internal/base/scope/EnablementScope.java (+45 lines)
1	/*******************************************************************************
2	* Copyright (c) 2010 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
12	package org.eclipse.help.internal.base.scope;
13
14	import java.util.Locale;
15
16	import org.eclipse.help.IIndexEntry;
17	import org.eclipse.help.IIndexSee;
18	import org.eclipse.help.IToc;
19	import org.eclipse.help.ITopic;
20	import org.eclipse.help.base.AbstractHelpScope;
21	import org.eclipse.help.internal.base.HelpBasePlugin;
22
23	public class EnablementScope extends AbstractHelpScope {
24
25	public boolean inScope(IToc toc) {
26	return HelpBasePlugin.getActivitySupport().isEnabled(toc.getHref());
27	}
28
29	public boolean inScope(ITopic topic) {
30	return true;
31	}
32
33	public boolean inScope(IIndexEntry entry) {
34	return true;
35	}
36
37	public boolean inScope(IIndexSee see) {
38	return true;
39	}
40
41	public String getName(Locale locale) {
42	return null;
43	}
44
45	}

Lines 1-5 Link Here

(-)advanced/indexView.js (-2 / +3 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2005, 2007 Intel Corporation and others.	2	* Copyright (c) 2005, 2010 Intel 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 9-14 Link Here
9	* Intel Corporation - initial API and implementation	9	* Intel Corporation - initial API and implementation
10	* IBM Corporation 2006, refactored index view into a single frame	10	* IBM Corporation 2006, refactored index view into a single frame
11	* IBM Corporation 2007, allow partial loading of index	11	* IBM Corporation 2007, allow partial loading of index
		12	* IBM Corporation 2010, add filtering in toc and index view
12	*******************************************************************************/	13	*******************************************************************************/
13		14
14	var isMozilla = navigator.userAgent.indexOf("Mozilla") != -1 && parseInt(navigator.appVersion.substring(0,1)) >= 5;	15	var isMozilla = navigator.userAgent.indexOf("Mozilla") != -1 && parseInt(navigator.appVersion.substring(0,1)) >= 5;
Lines 204-210 Link Here
204	}	205	}
205		206
206	function makeNodeRequest(parameters) {	207	function makeNodeRequest(parameters) {
207	var href = "../indexfragment" + parameters;	208	var href = "indexfragment" + parameters;
208	var callback = function(xml) { updateIndexTree(xml);};	209	var callback = function(xml) { updateIndexTree(xml);};
209	var errorCallback = function() {	210	var errorCallback = function() {
210	// alert("ajax error");	211	// alert("ajax error");

Lines 1-5 Link Here

(-)advanced/tocTree.js (-14 / +6 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2006, 2009 IBM Corporation and others.	2	* Copyright (c) 2006, 2010 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 12-25 Link Here
12	// Tree code specific to the help toc	12	// Tree code specific to the help toc
13		13
14	var showExpanders = true;	14	var showExpanders = true;
15	var ajaxPrefix = "../tocfragment";	15	var ajaxPath = "tocfragment";
16	var pendingSynchTopic = null; // Should the toc be synchronized when the view becomes visible	16	var pendingSynchTopic = null; // Should the toc be synchronized when the view becomes visible
17		17
18	// The default value of ajaxPrefix works from jsp files but needs to be overridden to	18	// The default value of ajaxPath works from jsp files but needs to be overridden to
19	// a non relative path to work from scripts launched from any page	19	// a non relative path to work from scripts launched from any page
20		20
21	function setAjaxPrefix(prefix) {	21	function setAjaxPrefix(prefix) {
22	ajaxPrefix = prefix;	22	ajaxPath = prefix + "/tocfragment";
23	}	23	}
24		24
25	/*	25	/*
Lines 174-184 Link Here
174		174
175	function makeNodeRequest(parameters) {	175	function makeNodeRequest(parameters) {
176	var href;	176	var href;
177	if (ajaxPrefix) {	177	href = ajaxPath +parameters;
178	href = ajaxPrefix + "/tocfragment" +parameters;
179	} else {
180	href = "../tocfragment" + parameters;
181	}
182	var callback = function(xml) { updateTocTree(xml);};	178	var callback = function(xml) { updateTocTree(xml);};
183	var errorCallback = function() {	179	var errorCallback = function() {
184	// alert("ajax error");	180	// alert("ajax error");
Lines 188-198 Link Here
188		184
189	function makeShowInTocRequest(parameters) {	185	function makeShowInTocRequest(parameters) {
190	var href;	186	var href;
191	if (ajaxPrefix) {	187	href = ajaxPath +parameters;
192	href = ajaxPrefix + "/tocfragment" +parameters;
193	} else {
194	href = "../tocfragment" + parameters;
195	}
196	var callback = function(xml) { showInToc(xml);};	188	var callback = function(xml) { showInToc(xml);};
197	var errorCallback = function() {	189	var errorCallback = function() {
198	// alert("ajax error");	190	// alert("ajax error");