Allow page to suppress all of its content from search.
To suppress things from search, we usually use preferencecontroller to
control individual items. But a page can sometimes to disabled
entirely. Now it can set isPageSearchEnabled to false to achieve that.
Change-Id: I39424b7fdc6460e27fd7c83cf09b5ace12d1cc37
Fix: 36201167
Test: make RunSettingsRoboTests
diff --git a/src/com/android/settings/SettingsActivity.java b/src/com/android/settings/SettingsActivity.java
index 7a4d5f8..00a2c7d 100644
--- a/src/com/android/settings/SettingsActivity.java
+++ b/src/com/android/settings/SettingsActivity.java
@@ -64,6 +64,7 @@
import com.android.settings.dashboard.DashboardFeatureProvider;
import com.android.settings.dashboard.DashboardSummary;
import com.android.settings.dashboard.SearchResultsSummary;
+import com.android.settings.enterprise.EnterprisePrivacySettings;
import com.android.settings.overlay.FeatureFactory;
import com.android.settings.search.DynamicIndexableContentMonitor;
import com.android.settings.search2.SearchFeatureProvider;
@@ -945,8 +946,7 @@
setTileEnabled(new ComponentName(packageName,
Settings.EnterprisePrivacySettingsActivity.class.getName()),
- FeatureFactory.getFactory(this).getEnterprisePrivacyFeatureProvider(this)
- .hasDeviceOwner(), isAdmin);
+ EnterprisePrivacySettings.isPageEnabled(this), isAdmin);
setTileEnabled(new ComponentName(packageName,
Settings.WifiDisplaySettingsActivity.class.getName()),
diff --git a/src/com/android/settings/enterprise/EnterprisePrivacySettings.java b/src/com/android/settings/enterprise/EnterprisePrivacySettings.java
index 140a05c..3f66f02 100644
--- a/src/com/android/settings/enterprise/EnterprisePrivacySettings.java
+++ b/src/com/android/settings/enterprise/EnterprisePrivacySettings.java
@@ -23,6 +23,7 @@
import com.android.settings.R;
import com.android.settings.core.PreferenceController;
import com.android.settings.dashboard.DashboardFragment;
+import com.android.settings.overlay.FeatureFactory;
import com.android.settings.search.BaseSearchIndexProvider;
import java.util.ArrayList;
@@ -71,14 +72,25 @@
return controllers;
}
+ public static boolean isPageEnabled(Context context) {
+ return FeatureFactory.getFactory(context)
+ .getEnterprisePrivacyFeatureProvider(context)
+ .hasDeviceOwner();
+ }
+
public static final SearchIndexProvider SEARCH_INDEX_DATA_PROVIDER =
- new BaseSearchIndexProvider() {
- @Override
- public List<SearchIndexableResource> getXmlResourcesToIndex(
- Context context, boolean enabled) {
- final SearchIndexableResource sir = new SearchIndexableResource(context);
- sir.xmlResId = R.xml.enterprise_privacy_settings;
- return Arrays.asList(sir);
- }
- };
+ new BaseSearchIndexProvider() {
+ @Override
+ protected boolean isPageSearchEnabled(Context context) {
+ return isPageEnabled(context);
+ }
+
+ @Override
+ public List<SearchIndexableResource> getXmlResourcesToIndex(
+ Context context, boolean enabled) {
+ final SearchIndexableResource sir = new SearchIndexableResource(context);
+ sir.xmlResId = R.xml.enterprise_privacy_settings;
+ return Arrays.asList(sir);
+ }
+ };
}
diff --git a/src/com/android/settings/search/BaseSearchIndexProvider.java b/src/com/android/settings/search/BaseSearchIndexProvider.java
index 38c8d40..54f66ea 100644
--- a/src/com/android/settings/search/BaseSearchIndexProvider.java
+++ b/src/com/android/settings/search/BaseSearchIndexProvider.java
@@ -17,10 +17,20 @@
package com.android.settings.search;
import android.content.Context;
+import android.content.res.XmlResourceParser;
import android.provider.SearchIndexableResource;
+import android.text.TextUtils;
+import android.util.AttributeSet;
+import android.util.Log;
+import android.util.Xml;
import com.android.settings.core.PreferenceController;
+import com.android.settings.search2.XmlParserUtils;
+import org.xmlpull.v1.XmlPullParser;
+import org.xmlpull.v1.XmlPullParserException;
+
+import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
@@ -30,6 +40,7 @@
*/
public class BaseSearchIndexProvider implements Indexable.SearchIndexProvider {
+ private static final String TAG = "BaseSearchIndex";
private static final List<String> EMPTY_LIST = Collections.emptyList();
public BaseSearchIndexProvider() {
@@ -47,6 +58,10 @@
@Override
public List<String> getNonIndexableKeys(Context context) {
+ if (!isPageSearchEnabled(context)) {
+ // Entire page should be suppressed, mark all keys from this page as non-indexable.
+ return getNonIndexableKeysFromXml(context);
+ }
final List<PreferenceController> controllers = getPreferenceControllers(context);
if (controllers != null && !controllers.isEmpty()) {
final List<String> nonIndexableKeys = new ArrayList<>();
@@ -63,4 +78,37 @@
public List<PreferenceController> getPreferenceControllers(Context context) {
return null;
}
+
+ /**
+ * Returns true if the page should be considered in search query. If return false, entire page
+ * will be suppressed during search query.
+ */
+ protected boolean isPageSearchEnabled(Context context) {
+ return true;
+ }
+
+ private List<String> getNonIndexableKeysFromXml(Context context) {
+ final List<SearchIndexableResource> resources = getXmlResourcesToIndex(
+ context, true /* not used*/);
+ if (resources == null || resources.isEmpty()) {
+ return EMPTY_LIST;
+ }
+ final List<String> nonIndexableKeys = new ArrayList<>();
+ for (SearchIndexableResource res : resources) {
+ final XmlResourceParser parser = context.getResources().getXml(res.xmlResId);
+ final AttributeSet attrs = Xml.asAttributeSet(parser);
+ try {
+ while (parser.next() != XmlPullParser.END_DOCUMENT) {
+ final String key = XmlParserUtils.getDataKey(context, attrs);
+ if (!TextUtils.isEmpty(key)) {
+ nonIndexableKeys.add(key);
+ }
+ }
+ } catch (IOException | XmlPullParserException e) {
+ Log.w(TAG, "Error parsing non-indexable from xml " + res.xmlResId);
+ }
+ }
+ return nonIndexableKeys;
+ }
+
}