[subresource_filter] Site Details UI for default state

chrome/android/java/src/org/chromium/chrome/browser/preferences/website/SingleWebsitePreferences.java

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.preferences.website;
 
 import android.content.Context;
 import android.content.DialogInterface;
 import android.content.res.Resources;
 import android.net.Uri;
@@ skipping 46 matching lines @@
 
     // Preference keys, see single_website_preferences.xml
     // Headings:
     public static final String PREF_SITE_TITLE = "site_title";
     public static final String PREF_USAGE = "site_usage";
     public static final String PREF_PERMISSIONS = "site_permissions";
     public static final String PREF_OS_PERMISSIONS_WARNING = "os_permissions_warning";
     public static final String PREF_OS_PERMISSIONS_WARNING_EXTRA = "os_permissions_warning_extra";
     public static final String PREF_OS_PERMISSIONS_WARNING_DIVIDER =
             "os_permissions_warning_divider";
+    public static final String PREF_SUBRESOURCE_FILTER_EXTRA_INFO =
+            "subresource_filter_permission_extra_info";
+    public static final String PREF_SUBRESOURCE_FILTER_EXTRA_INFO_DIVIDER =
+            "subresource_filter_permission_extra_info_divider";
     // Actions at the top (if adding new, see hasUsagePreferences below):
     public static final String PREF_CLEAR_DATA = "clear_data";
     // Buttons:
     public static final String PREF_RESET_SITE = "reset_site_button";
     // Website permissions (if adding new, see hasPermissionsPreferences and resetSite below):
     public static final String PREF_AUTOPLAY_PERMISSION = "autoplay_permission_list";
     public static final String PREF_BACKGROUND_SYNC_PERMISSION = "background_sync_permission_list";
     public static final String PREF_CAMERA_CAPTURE_PERMISSION = "camera_permission_list";
     public static final String PREF_COOKIES_PERMISSION = "cookies_permission_list";
     public static final String PREF_JAVASCRIPT_PERMISSION = "javascript_permission_list";
@@ skipping 185 matching lines @@
                 && (origin.equals(info.getEmbedderSafe()) || "*".equals(info.getEmbedderSafe()));
     }
 
     /**
      * Updates the permissions displayed in the UI by fetching them from mSite.
      * Must only be called once mSite is set.
      */
     private void displaySitePermissions() {
         addPreferencesFromResource(R.xml.single_website_preferences);
 
+        // If the subresource filter is activated, then this site will have resources filtered
+        // unless there is an explicit permission disallowing the filtering.
+        //
+        // This activation is encoded in |subresourceFilterActivated|, which controls how the
+        // subresource filter list preference behaves. If it is true, there is also an additional
+        // extra informational banner which shows at the top of the UI.
+        boolean subresourceFilterActivated = WebsitePreferenceBridge.getSubresourceFilterActivated(
+                mSite.getAddress().getOrigin());
+
         Set<String> permissionPreferenceKeys =
                 new HashSet<>(Arrays.asList(PERMISSION_PREFERENCE_KEYS));
         int maxPermissionOrder = 0;
         ListAdapter preferences = getPreferenceScreen().getRootAdapter();
         for (int i = 0; i < preferences.getCount(); ++i) {
             Preference preference = (Preference) preferences.getItem(i);
             if (PREF_SITE_TITLE.equals(preference.getKey())) {
                 preference.setTitle(mSite.getTitle());
             } else if (PREF_CLEAR_DATA.equals(preference.getKey())) {
                 long usage = mSite.getTotalUsage();
@@ skipping 24 matching lines @@
                 setUpListPreference(preference, mSite.getMicrophonePermission());
             } else if (PREF_MIDI_SYSEX_PERMISSION.equals(preference.getKey())) {
                 setUpListPreference(preference, mSite.getMidiPermission());
             } else if (PREF_NOTIFICATIONS_PERMISSION.equals(preference.getKey())) {
                 setUpListPreference(preference, mSite.getNotificationPermission());
             } else if (PREF_POPUP_PERMISSION.equals(preference.getKey())) {
                 setUpListPreference(preference, mSite.getPopupPermission());
             } else if (PREF_PROTECTED_MEDIA_IDENTIFIER_PERMISSION.equals(preference.getKey())) {
                 setUpListPreference(preference, mSite.getProtectedMediaIdentifierPermission());
             } else if (PREF_SUBRESOURCE_FILTER_PERMISSION.equals(preference.getKey())) {
-                setUpListPreference(preference, mSite.getSubresourceFilterPermission());
+                setUpSubresourceFilterPreference(preference, subresourceFilterActivated);
             }
 
             if (permissionPreferenceKeys.contains(preference.getKey())) {
                 maxPermissionOrder = Math.max(maxPermissionOrder, preference.getOrder());
             }
         }
 
         for (UsbInfo info : mSite.getUsbInfo()) {
             Preference preference = new Preference(getActivity());
             preference.getExtras().putSerializable(EXTRA_USB_INFO, info);
@@ skipping 24 matching lines @@
                     osWarning, osWarningExtra, getActivity(), false);
             if (osWarning.getTitle() == null) {
                 getPreferenceScreen().removePreference(
                         preferenceScreen.findPreference(PREF_OS_PERMISSIONS_WARNING));
             } else if (osWarningExtra.getTitle() == null) {
                 getPreferenceScreen().removePreference(
                         preferenceScreen.findPreference(PREF_OS_PERMISSIONS_WARNING_EXTRA));
             }
         }
 
+        // The subresource filter permission includes a header with some additional information, if
+        // it is being displayed on a site that is activated.
+        Preference subresourceFilterExtraInfo =
+                preferenceScreen.findPreference(PREF_SUBRESOURCE_FILTER_EXTRA_INFO);
+        Preference subresourceFilterExtraInfoDivider =
+                preferenceScreen.findPreference(PREF_SUBRESOURCE_FILTER_EXTRA_INFO_DIVIDER);
+        if (getPreferenceScreen().findPreference(PREF_SUBRESOURCE_FILTER_PERMISSION) != null
+                && subresourceFilterActivated) {
+            subresourceFilterExtraInfo.setTitle(R.string.subresource_filter_permission_extra_info);
+        } else {
+            getPreferenceScreen().removePreference(subresourceFilterExtraInfo);
+            getPreferenceScreen().removePreference(subresourceFilterExtraInfoDivider);
+        }
+
         // Remove categories if no sub-items.
         if (!hasUsagePreferences()) {
             Preference heading = preferenceScreen.findPreference(PREF_USAGE);
             preferenceScreen.removePreference(heading);
         }
         if (!hasPermissionsPreferences()) {
             Preference heading = preferenceScreen.findPreference(PREF_PERMISSIONS);
             preferenceScreen.removePreference(heading);
         }
     }
@@ skipping 119 matching lines @@
             String origin = mSite.getAddress().getOrigin();
             mSite.setGeolocationInfo(new GeolocationInfo(origin, origin, false));
             setUpListPreference(preference, (boolean) locationAllowed
                     ? ContentSetting.ALLOW : ContentSetting.BLOCK);
         } else {
             setUpListPreference(preference, permission);
         }
     }
 
     /**
+     * Updates the subresource filter list preference based on subresource filter activation. This
+     * has some custom behavior.
+     * 1. If the site is activated, the permission should show up even if it is set as the default

[Finnur, 2017/05/24 10:37:22]

s/site/filtering/ ?

[Charlie Harrison, 2017/05/25 15:57:19]

Done.

+     *    (e.g. |preference| is null).
+     * 2. The BLOCK string is custom.
+     * @param activated Whether the subresource filter is activated for this site (i.e. whether or
+     * not the site is a candidate for resource filtering).
+     */
+    private void setUpSubresourceFilterPreference(Preference preference, boolean activated) {
+        ContentSetting permission = mSite.getSubresourceFilterPermission();
+
+        // If |permission| is null, there is no explicit (non-default) permission set for this site.
+        // If the site is activated, we still want to show the permission as BLOCK.
+        if (permission == null) {
+            if (activated) {
+                permission = ContentSetting.BLOCK;
+
+                // Set the subresource filter exception on the associated website. This is necessary
+                // because we require an exception to be set in order to change content setting
+                // (see setSubresourceFilterPermission). Otherwise the UI will change but the
+                // underlying data will remain unchanged.
+                String origin = mSite.getAddress().getOrigin();
+                mSite.setSubresourceFilterException(new ContentSettingException(
+                        ContentSettingsType.CONTENT_SETTINGS_TYPE_SUBRESOURCE_FILTER, origin,
+                        permission, ""));
+            } else {
+                setUpListPreference(preference, null);
+                return;
+            }
+        }
+        assert permission != null;
+        setUpListPreference(preference, permission);
+
+        // The subresource filter permission has a custom BLOCK string.
+        ListPreference listPreference = (ListPreference) preference;
+        Resources res = getResources();
+        listPreference.setEntries(
+                new String[] {res.getString(R.string.website_settings_permissions_allow),
+                        res.getString(R.string.subresource_filter_permission_block)});
+        listPreference.setValueIndex(permission == ContentSetting.ALLOW ? 0 : 1);
+    }
+
+    /**
      * Returns true if the current host matches the default search engine host and location for the
      * default search engine is being granted via x-geo.
      * @param context The current context.
      */
     private boolean hasXGeoLocationPermission(Context context) {
         if (ChromeFeatureList.isEnabled(ChromeFeatureList.CONSISTENT_OMNIBOX_GEOLOCATION)) {
             return false;
         }
 
         String searchUrl = TemplateUrlService.getInstance().getUrlForSearchQuery("foo");
@@ skipping 213 matching lines @@
         if (mSite.getTotalUsage() > 0) {
             clearStoredData();
         } else {
             // Clearing stored data implies popping back to parent menu if there
             // is nothing left to show. Therefore, we only need to explicitly
             // close the activity if there's no stored data to begin with.
             getActivity().finish();
         }
     }
 }