Add filtering support for duplicate files in nested projects (eclipse-platform#144)

* Add filtering support for duplicate files in nested projects

- add filter to File Search to remove duplicate file entries that
  are attributed to different projects in a nested project scenario
- fixes eclipse-platform#143

Author: jjohnstn

org.eclipse.search/search/org/eclipse/search/internal/ui/SearchMessages.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2017 IBM Corporation and others.
+ * Copyright (c) 2000, 2023 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -13,6 +13,7 @@
  *     Christian Walther (Indel AG) - Bug 399094: Add whole word option to file search
  *     Marco Descher <[email protected]> - Open Search dialog with previous page instead of using the current selection to detect the page - http://bugs.eclipse.org/33710
  *     Lucas Bullen (Red Hat Inc.) - [Bug 526453] disambiguate "Selected Resources"
+ *     Red Hat Inc. - add support for filtering innermost project files for file search
  *******************************************************************************/
 package org.eclipse.search.internal.ui;
 
@@ -127,6 +128,9 @@ private SearchMessages() {
 	public static String SearchPage_regularExpression;
 	public static String SearchPage_wholeWord;
 	public static String TextSearchEngine_statusMessage;
+	public static String TextSearchInnermostProjectFilter_action_label;
+	public static String TextSearchInnermostProjectFilter_name;
+	public static String TextSearchInnermostProjectFilter_description;
 	public static String TextSearchPage_replace_querycreationproblem_message;
 	public static String TextSearchPage_replace_runproblem_message;
 	public static String TextSearchPage_searchIn_label;
@@ -172,6 +176,8 @@ private SearchMessages() {
 	public static String FileSearchPage_sort_by_label;
 	public static String FileSearchPage_limited_format_files;
 	public static String FileSearchPage_limited_format_matches;
+	public static String FileSearchPage_filtered_message;
+	public static String FileSearchPage_filteredWithCount_message;
 	public static String WorkspaceScope;
 	public static String ScopePart_group_text;
 	public static String ScopePart_selectedResourcesScope_text;

org.eclipse.search/search/org/eclipse/search/internal/ui/SearchMessages.properties

@@ -1,5 +1,5 @@
 ###############################################################################
-# Copyright (c) 2000, 2017 IBM Corporation and others.
+# Copyright (c) 2000, 2023 IBM Corporation and others.
 #
 # This program and the accompanying materials
 # are made available under the terms of the Eclipse Public License 2.0
@@ -97,6 +97,9 @@ SearchPage_wholeWord= Who&le word
 
 TextSearchEngine_statusMessage= Problems encountered during text search.
 
+TextSearchInnermostProjectFilter_action_label=Show only most &nested match
+TextSearchInnermostProjectFilter_name=Duplicate match from outer project
+TextSearchInnermostProjectFilter_description= For files in nested projects, don't show matches for duplicate file references that are owned by projects that aren't the innermost project.
 TextSearchPage_searchIn_label=Search In
 TextSearchPage_searchDerived_label=Deri&ved resources
 TextSearchPage_searchBinary_label=&Binary files
@@ -180,6 +183,8 @@ FileSearchPage_sort_by_label=Sort By
 FileSearchPage_limited_format_files={0} (showing {1} of {2} files)
 FileSearchPage_limited_format_matches={0} (showing {1} of {2} matches)
 FileSearchPage_open_file_dialog_title=Open File
+FileSearchPage_filtered_message={0} (Filtered)
+FileSearchPage_filteredWithCount_message={0} ({1} matches filtered from view)
 
 WorkspaceScope= workspace
 

org.eclipse.search/search/org/eclipse/search/internal/ui/text/FileSearchPage.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2019 IBM Corporation and others.
+ * Copyright (c) 2000, 2023 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -13,6 +13,7 @@
  *     Juerg Billeter, [email protected] - 47136 Search view should show match objects
  *     Ulrich Etter, [email protected] - 47136 Search view should show match objects
  *     Roman Fuchs, [email protected] - 47136 Search view should show match objects
+ *     Red Hat Inc. - add support for filtering files that are not from innermost nested project
  *******************************************************************************/
 package org.eclipse.search.internal.ui.text;
 
@@ -27,11 +28,15 @@
 import org.eclipse.swt.dnd.DND;
 import org.eclipse.swt.dnd.Transfer;
 import org.eclipse.swt.widgets.Display;
+import org.eclipse.swt.widgets.Item;
+import org.eclipse.swt.widgets.Table;
+import org.eclipse.swt.widgets.Tree;
 
 import org.eclipse.core.runtime.IAdaptable;
 
 import org.eclipse.core.resources.IContainer;
 import org.eclipse.core.resources.IFile;
+import org.eclipse.core.resources.IResource;
 
 import org.eclipse.core.filebuffers.FileBuffers;
 import org.eclipse.core.filebuffers.ITextFileBuffer;
@@ -44,7 +49,6 @@
 import org.eclipse.jface.viewers.ILabelProvider;
 import org.eclipse.jface.viewers.ISelection;
 import org.eclipse.jface.viewers.ISelectionProvider;
-import org.eclipse.jface.viewers.IStructuredContentProvider;
 import org.eclipse.jface.viewers.IStructuredSelection;
 import org.eclipse.jface.viewers.ITreeContentProvider;
 import org.eclipse.jface.viewers.ITreeViewerListener;
@@ -74,6 +78,7 @@
 import org.eclipse.search.internal.ui.SearchMessages;
 import org.eclipse.search.ui.IContextMenuConstants;
 import org.eclipse.search.ui.ISearchResultViewPart;
+import org.eclipse.search.ui.NewSearchUI;
 import org.eclipse.search.ui.text.AbstractTextSearchResult;
 import org.eclipse.search.ui.text.AbstractTextSearchViewPage;
 import org.eclipse.search.ui.text.Match;
@@ -423,38 +428,113 @@ public <T> T getAdapter(Class<T> adapter) {
 		return null;
 	}
 
+	private boolean isQueryRunning() {
+		AbstractTextSearchResult result = getInput();
+		if (result != null) {
+			return NewSearchUI.isQueryRunning(result.getQuery());
+		}
+		return false;
+	}
+
 	@Override
 	public String getLabel() {
 		String label= super.getLabel();
 		StructuredViewer viewer= getViewer();
-		if (viewer instanceof TableViewer) {
-			TableViewer tv= (TableViewer) viewer;
-
-			AbstractTextSearchResult result= getInput();
-			if (result != null) {
-				int itemCount= ((IStructuredContentProvider) tv.getContentProvider()).getElements(getInput()).length;
+		AbstractTextSearchResult result = getInput();
+		String msg = label;
+		if (result != null) {
+			if (viewer instanceof TableViewer) {
+				TableViewer tv = (TableViewer) viewer;
+
+				int itemCount = ((FileTableContentProvider) tv.getContentProvider())
+						.getUnfilteredElements(getInput()).length;
 				if (showLineMatches()) {
 					int matchCount= getInput().getMatchCount();
 					if (itemCount < matchCount) {
-						return Messages.format(SearchMessages.FileSearchPage_limited_format_matches, new Object[]{label, Integer.valueOf(itemCount), Integer.valueOf(matchCount)});
+						msg = Messages.format(SearchMessages.FileSearchPage_limited_format_matches,
+								new Object[] { label, Integer.valueOf(itemCount), Integer.valueOf(matchCount) });
 					}
 				} else {
 					int fileCount= getInput().getElements().length;
 					if (itemCount < fileCount) {
-						return Messages.format(SearchMessages.FileSearchPage_limited_format_files, new Object[]{label, Integer.valueOf(itemCount), Integer.valueOf(fileCount)});
+						msg = Messages.format(SearchMessages.FileSearchPage_limited_format_files,
+								new Object[] { label, Integer.valueOf(itemCount), Integer.valueOf(fileCount) });
 					}
 				}
+
+			}
+			if (result.getActiveMatchFilters() != null && result.getActiveMatchFilters().length > 0) {
+				if (isQueryRunning()) {
+					String message = SearchMessages.FileSearchPage_filtered_message;
+					return Messages.format(message, new Object[] { msg });
+
+				} else {
+					int filteredOut = result.getMatchCount() - getFilteredMatchCount();
+					String message = SearchMessages.FileSearchPage_filteredWithCount_message;
+					return Messages.format(message, new Object[] { msg, String.valueOf(filteredOut) });
+				}
 			}
 		}
-		return label;
+		return msg;
+	}
+
+	private int getFilteredMatchCount() {
+		StructuredViewer viewer = getViewer();
+		if (viewer instanceof TreeViewer) {
+			ITreeContentProvider tp = (ITreeContentProvider) viewer.getContentProvider();
+			return getMatchCount(tp, getRootElements((TreeViewer) getViewer()));
+		} else {
+			return getMatchCount((TableViewer) viewer);
+		}
+	}
+
+	private Object[] getRootElements(TreeViewer viewer) {
+		Tree t = viewer.getTree();
+		Item[] roots = t.getItems();
+		Object[] elements = new Object[roots.length];
+		for (int i = 0; i < elements.length; i++) {
+			elements[i] = roots[i].getData();
+		}
+		return elements;
+	}
+
+	private Object[] getRootElements(TableViewer viewer) {
+		Table t = viewer.getTable();
+		Item[] roots = t.getItems();
+		Object[] elements = new Object[roots.length];
+		for (int i = 0; i < elements.length; i++) {
+			elements[i] = roots[i].getData();
+		}
+		return elements;
+	}
+
+	private int getMatchCount(ITreeContentProvider cp, Object[] elements) {
+		int count = 0;
+		for (Object element : elements) {
+			count += getDisplayedMatchCount(element);
+			Object[] children = cp.getChildren(element);
+			count += getMatchCount(cp, children);
+		}
+		return count;
+	}
+
+	private int getMatchCount(TableViewer viewer) {
+		int count = 0;
+		for (Object element : getRootElements(viewer)) {
+			count += getDisplayedMatchCount(element);
+		}
+		return count;
 	}
 
 	@Override
 	public int getDisplayedMatchCount(Object element) {
 		if (showLineMatches()) {
 			if (element instanceof LineElement) {
 				LineElement lineEntry= (LineElement) element;
-				return lineEntry.getNumberOfMatches(getInput());
+				IResource res = lineEntry.getParent();
+				if (super.getDisplayedMatchCount(res) > 0) {
+					return lineEntry.getNumberOfMatches(getInput());
+				}
 			}
 			return 0;
 		}
@@ -466,7 +546,10 @@ public Match[] getDisplayedMatches(Object element) {
 		if (showLineMatches()) {
 			if (element instanceof LineElement) {
 				LineElement lineEntry= (LineElement) element;
-				return lineEntry.getMatches(getInput());
+				IResource res = lineEntry.getParent();
+				if (super.getDisplayedMatchCount(res) > 0) {
+					return lineEntry.getMatches(getInput());
+				}
 			}
 			return new Match[0];
 		}

org.eclipse.search/search/org/eclipse/search/internal/ui/text/FileSearchResult.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2008 IBM Corporation and others.
+ * Copyright (c) 2000, 2023 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -10,9 +10,13 @@
  *
  * Contributors:
  *     IBM Corporation - initial API and implementation
+ *     Red Hat Inc. - add support for filtering files from innermost nested projects
  *******************************************************************************/
 package org.eclipse.search.internal.ui.text;
 
+import java.util.HashSet;
+import java.util.StringTokenizer;
+
 import org.eclipse.core.resources.IFile;
 
 import org.eclipse.jface.resource.ImageDescriptor;
@@ -21,12 +25,14 @@
 import org.eclipse.ui.IEditorPart;
 import org.eclipse.ui.IFileEditorInput;
 
+import org.eclipse.search.internal.ui.SearchPlugin;
 import org.eclipse.search.internal.ui.SearchPluginImages;
 import org.eclipse.search.ui.ISearchQuery;
 import org.eclipse.search.ui.text.AbstractTextSearchResult;
 import org.eclipse.search.ui.text.IEditorMatchAdapter;
 import org.eclipse.search.ui.text.IFileMatchAdapter;
 import org.eclipse.search.ui.text.Match;
+import org.eclipse.search.ui.text.MatchFilter;
 
 public class FileSearchResult extends AbstractTextSearchResult implements IEditorMatchAdapter, IFileMatchAdapter {
 	private final Match[] EMPTY_ARR= new Match[0];
@@ -35,20 +41,88 @@ public class FileSearchResult extends AbstractTextSearchResult implements IEdito
 
 	public FileSearchResult(FileSearchQuery job) {
 		fQuery= job;
+		setActiveMatchFilters(getLastUsedFilters());
 	}
+
 	@Override
 	public ImageDescriptor getImageDescriptor() {
 		return SearchPluginImages.DESC_OBJ_TSEARCH_DPDN;
 	}
+
 	@Override
 	public String getLabel() {
 		return fQuery.getResultLabel(getMatchCount());
 	}
+
 	@Override
 	public String getTooltip() {
 		return getLabel();
 	}
 
+	private static MatchFilter INNERMOST_PROJECT = new OuterProjectFileFilter();
+	private static MatchFilter[] ALL_MATCH_FILTERS = new MatchFilter[] { INNERMOST_PROJECT };
+	private static final String SETTINGS_LAST_USED_FILTERS = "filters_last_used"; //$NON-NLS-1$
+
+	@Override
+	public MatchFilter[] getAllMatchFilters() {
+		return ALL_MATCH_FILTERS;
+	}
+
+	@Override
+	public synchronized void setActiveMatchFilters(MatchFilter[] filters) {
+		// TODO Auto-generated method stub
+		super.setActiveMatchFilters(filters);
+		setLastUsedFilters(filters);
+	}
+
+	@Override
+	public synchronized MatchFilter[] getActiveMatchFilters() {
+		// TODO Auto-generated method stub
+		return super.getActiveMatchFilters();
+	}
+
+	public static MatchFilter[] getLastUsedFilters() {
+		String string = SearchPlugin.getDefault().getDialogSettings().get(SETTINGS_LAST_USED_FILTERS);
+		if (string != null) {
+			return decodeFiltersString(string);
+		}
+		return new MatchFilter[0];
+	}
+
+	public static void setLastUsedFilters(MatchFilter[] filters) {
+		String encoded = encodeFilters(filters);
+		SearchPlugin.getDefault().getDialogSettings().put(SETTINGS_LAST_USED_FILTERS, encoded);
+	}
+
+	private static String encodeFilters(MatchFilter[] enabledFilters) {
+		StringBuilder buf = new StringBuilder();
+		for (MatchFilter matchFilter : enabledFilters) {
+			buf.append(matchFilter.getID());
+			buf.append(';');
+		}
+		return buf.toString();
+	}
+
+	private static MatchFilter[] decodeFiltersString(String encodedString) {
+		StringTokenizer tokenizer = new StringTokenizer(encodedString, String.valueOf(';'));
+		HashSet<MatchFilter> result = new HashSet<>();
+		while (tokenizer.hasMoreTokens()) {
+			MatchFilter curr = findMatchFilter(tokenizer.nextToken());
+			if (curr != null) {
+				result.add(curr);
+			}
+		}
+		return result.toArray(new MatchFilter[result.size()]);
+	}
+
+	private static MatchFilter findMatchFilter(String id) {
+		for (MatchFilter matchFilter : ALL_MATCH_FILTERS) {
+			if (matchFilter.getID().equals(id))
+				return matchFilter;
+		}
+		return null;
+	}
+
 	@Override
 	public Match[] computeContainedMatches(AbstractTextSearchResult result, IFile file) {
 		return getMatches(file);