[Android] Update Protected Media Identifier Settings UI to reflect exceptions.

chrome/android/java/src/org/chromium/chrome/browser/preferences/website/WebsitePreferences.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.os.Bundle;
 import android.preference.Preference;
 import android.preference.Preference.OnPreferenceChangeListener;
 import android.preference.Preference.OnPreferenceClickListener;
@@ skipping 14 matching lines @@
 
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.preferences.ChromeBaseCheckBoxPreference;
 import org.chromium.chrome.browser.preferences.ChromeBasePreference;
 import org.chromium.chrome.browser.preferences.ChromeSwitchPreference;
 import org.chromium.chrome.browser.preferences.ExpandablePreferenceGroup;
 import org.chromium.chrome.browser.preferences.LocationSettings;
 import org.chromium.chrome.browser.preferences.ManagedPreferenceDelegate;
 import org.chromium.chrome.browser.preferences.ManagedPreferencesUtils;
 import org.chromium.chrome.browser.preferences.PrefServiceBridge;
+import org.chromium.chrome.browser.preferences.ProtectedContentResetCredentialConfirmDialogFragment;
 import org.chromium.chrome.browser.widget.TintedDrawable;
+import org.chromium.content.browser.MediaDrmCredentialManager;
+import org.chromium.content.browser.MediaDrmCredentialManager.MediaDrmCredentialManagerCallback;
 import org.chromium.ui.text.SpanApplier;
 import org.chromium.ui.text.SpanApplier.SpanInfo;
 
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
 /**
  * Shows a list of sites with their associated HTML5 settings. When the
  * users selects a site, a SingleWebsitePreferences fragment is launched to
  * allow the user to modify the settings.
  */
 public class WebsitePreferences extends PreferenceFragment
         implements OnPreferenceChangeListener, OnPreferenceClickListener,
-                   AddExceptionPreference.SiteAddedCallback {
+                   AddExceptionPreference.SiteAddedCallback,
+                   ProtectedContentResetCredentialConfirmDialogFragment.Listener {
     // The key to use to pass which category this preference should display,
     // e.g. Location/Popups/All sites (if blank).
     public static final String EXTRA_CATEGORY = "category";
     public static final String EXTRA_TITLE = "title";
 
     // The view to show when the list is empty.
     private TextView mEmptyView;
     // The view for searching the list of items.
     private SearchView mSearchView;
     // What category the list is filtered by (e.g. show all, location, storage,
@@ skipping 10 matching lines @@
     // Whether the Allowed list should be shown expanded.
     private boolean mAllowListExpanded = true;
     // Whether this is the first time this screen is shown.
     private boolean mIsInitialRun = true;
     // The number of sites that are on the Allowed list.
     private int mAllowedSiteCount = 0;
 
     // Keys for individual preferences.
     public static final String READ_WRITE_TOGGLE_KEY = "read_write_toggle";
     public static final String THIRD_PARTY_COOKIES_TOGGLE_KEY = "third_party_cookies";
+    public static final String EXPLAIN_PROTECTED_MEDIA_KEY = "protected_content_learn_more";
     private static final String ADD_EXCEPTION_KEY = "add_exception";
     // Keys for Allowed/Blocked preference groups/headers.
     private static final String ALLOWED_GROUP = "allowed_group";
     private static final String BLOCKED_GROUP = "blocked_group";
 
     private void getInfoForOrigins() {
         WebsitePermissionsFetcher fetcher = new WebsitePermissionsFetcher(new ResultsPopulator());
         fetcher.fetchPreferencesWithFilter(mCategoryFilter);
     }
 
@@ skipping 116 matching lines @@
         } else if (mFilter.showGeolocationSites(mCategoryFilter)) {
             return website.site().getGeolocationPermission() == ContentSetting.BLOCK;
         } else if (mFilter.showImagesSites(mCategoryFilter)) {
             return website.site().getImagesPermission() == ContentSetting.BLOCK;
         } else if (mFilter.showJavaScriptSites(mCategoryFilter)) {
             return website.site().getJavaScriptPermission() == ContentSetting.BLOCK;
         } else if (mFilter.showPopupSites(mCategoryFilter)) {
             return website.site().getPopupPermission() == ContentSetting.BLOCK;
         } else if (mFilter.showPushNotificationsSites(mCategoryFilter)) {
             return website.site().getPushNotificationPermission() == ContentSetting.BLOCK;
+        } else if (mFilter.showProtectedMediaSites(mCategoryFilter)) {
+            return website.site().getProtectedMediaIdentifierPermission() == ContentSetting.BLOCK;
         }
 
         return false;
     }
 
     /**
      * Update the Category Header for the Allowed list.
      * @param numAllowed The number of sites that are on the Allowed list
      * @param toggleValue The value the global toggle will have once precessing ends.
      */
@@ skipping 61 matching lines @@
         super.onActivityCreated(savedInstanceState);
     }
 
     @Override
     public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
         inflater.inflate(R.menu.website_preferences_menu, menu);
 
         MenuItem searchItem = menu.findItem(R.id.search);
         mSearchView = (SearchView) MenuItemCompat.getActionView(searchItem);
         mSearchView.setImeOptions(EditorInfo.IME_FLAG_NO_FULLSCREEN);
-
         SearchView.OnQueryTextListener queryTextListener =
                 new SearchView.OnQueryTextListener() {
                     @Override
                     public boolean onQueryTextSubmit(String query) {
                         return true;
                     }
 
                     @Override
                     public boolean onQueryTextChange(String query) {
                         if (query.equals(mSearch)) return true;
 
                         mSearch = query;
                         getInfoForOrigins();
                         return true;
                     }
                 };
         mSearchView.setOnQueryTextListener(queryTextListener);
+
+        if (!mFilter.showProtectedMediaSites(mCategoryFilter)) return;

[newt (away), 2015/04/30 00:31:59]

Early returns are dangerous. Other developers may add code further down in the
method and not realize that their code isn't being run. This early return in
particular is very easy to miss, so don't use it: put this entire block inside
the if statement.

A good rule of thumb for early returns is: only use an early return at the
beginning of a method if the entire method shouldn't be run because something is
null, not initialized, already destroyed, etc.

For example, this is OK:

    public void fireLasers() {
        if (mIsDestroyed) return;

        // lots of code
        // to fire lasers
    }

But don't use an early return just to reduce indentation in the bottom section
of a multi-part method. Before you know it, there will be a new bottom-er
section in that method.

(Not so) fun fact: Aurimas and I recently discovered some code that had existed
in our codebase for several years, but had never been run due to a sneaky early
return a few lines earlier in a big startup-related method. The result was that
certain widgets and preferences weren't getting updated on startup. Not good.
(https://chrome-internal-review.googlesource.com/212950)

[knn, 2015/04/30 16:00:36]

Looks really nasty, Done. Thanks for the explanation!

+        // Add a menu item to reset protected media identifier device credentials.
+        MenuItem resetMenu =
+                menu.add(Menu.NONE, Menu.NONE, Menu.FIRST, R.string.reset_device_credentials);
+        resetMenu.setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() {
+            @Override
+            public boolean onMenuItemClick(MenuItem menuItem) {
+                new ProtectedContentResetCredentialConfirmDialogFragment(WebsitePreferences.this)
+                        .show(getFragmentManager(), null);
+                return true;
+            }
+        });
     }
 
     @Override
     public boolean onPreferenceTreeClick(PreferenceScreen screen, Preference preference) {
         // Do not show the toast if the System Location setting is disabled.
         if (getPreferenceScreen().findPreference(READ_WRITE_TOGGLE_KEY) != null
                 && isCategoryManaged()) {
             showManagedToast();
             return false;
         }
@@ skipping 31 matching lines @@
             } else if (mFilter.showFullscreenSites(mCategoryFilter)) {
                 PrefServiceBridge.getInstance().setFullscreenAllowed((boolean) newValue);
             } else if (mFilter.showImagesSites(mCategoryFilter)) {
                 PrefServiceBridge.getInstance().setImagesEnabled((boolean) newValue);
             } else if (mFilter.showJavaScriptSites(mCategoryFilter)) {
                 PrefServiceBridge.getInstance().setJavaScriptEnabled((boolean) newValue);
             } else if (mFilter.showPopupSites(mCategoryFilter)) {
                 PrefServiceBridge.getInstance().setAllowPopupsEnabled((boolean) newValue);
             } else if (mFilter.showPushNotificationsSites(mCategoryFilter)) {
                 PrefServiceBridge.getInstance().setPushNotificationsEnabled((boolean) newValue);
+            } else if (mFilter.showProtectedMediaSites(mCategoryFilter)) {
+                PrefServiceBridge.getInstance().setProtectedMediaIdentifierEnabled(
+                        (boolean) newValue);
             }
 
             // Categories that support adding exceptions also manage the 'Add site' preference.
             if (mFilter.showImagesSites(mCategoryFilter)
                     || mFilter.showJavaScriptSites(mCategoryFilter)) {
                 if ((boolean) newValue) {
                     Preference addException = getPreferenceScreen().findPreference(
                             ADD_EXCEPTION_KEY);
                     if (addException != null) {  // Can be null in testing.
                         getPreferenceScreen().removePreference(addException);
@@ skipping 112 matching lines @@
                     new AddExceptionPreference(getActivity(), ADD_EXCEPTION_KEY,
                             getAddExceptionDialogMessage(), this));
         }
     }
 
     private void configureGlobalToggles() {
         // Only some have a global toggle at the top.
         ChromeSwitchPreference globalToggle = (ChromeSwitchPreference)
                 getPreferenceScreen().findPreference(READ_WRITE_TOGGLE_KEY);
 
+        // Configure/hide the third-party cookie toggle, as needed.
         Preference thirdPartyCookies = getPreferenceScreen().findPreference(
                 THIRD_PARTY_COOKIES_TOGGLE_KEY);
-
-        // Configure/hide the third-party cookie toggle, as needed.
         if (mFilter.showCookiesSites(mCategoryFilter)) {
             thirdPartyCookies.setOnPreferenceChangeListener(this);
             updateThirdPartyCookiesCheckBox();
         } else {
             getPreferenceScreen().removePreference(thirdPartyCookies);
         }
 
+        // Show/hide the link that explains protected media settings, as needed.
+        if (mFilter.showProtectedMediaSites(mCategoryFilter)) {
+            globalToggle.setDrawDivider(false);

[newt (away), 2015/04/30 00:31:59]

I think we should keep the divider, i.e. remove this line

[knn, 2015/04/30 16:00:36]

Done.

+        } else {
+            getPreferenceScreen().removePreference(
+                    getPreferenceScreen().findPreference(EXPLAIN_PROTECTED_MEDIA_KEY));
+        }
+
         if (mFilter.showAllSites(mCategoryFilter)
                     || mFilter.showStorageSites(mCategoryFilter)) {
             getPreferenceScreen().removePreference(globalToggle);
             getPreferenceScreen().removePreference(
                     getPreferenceScreen().findPreference(ALLOWED_GROUP));
             getPreferenceScreen().removePreference(
                     getPreferenceScreen().findPreference(BLOCKED_GROUP));
         } else {
             // When this menu opens, make sure the Blocked list is collapsed.
             if (!mGroupByAllowBlock) {
@@ skipping 61 matching lines @@
                 } else if (mFilter.showImagesSites(mCategoryFilter)) {
                     globalToggle.setChecked(
                             PrefServiceBridge.getInstance().imagesEnabled());
                 } else if (mFilter.showJavaScriptSites(mCategoryFilter)) {
                     globalToggle.setChecked(PrefServiceBridge.getInstance().javaScriptEnabled());
                 } else if (mFilter.showPopupSites(mCategoryFilter)) {
                     globalToggle.setChecked(PrefServiceBridge.getInstance().popupsEnabled());
                 } else if (mFilter.showPushNotificationsSites(mCategoryFilter)) {
                     globalToggle.setChecked(
                             PrefServiceBridge.getInstance().isPushNotificationsEnabled());
+                } else if (mFilter.showProtectedMediaSites(mCategoryFilter)) {
+                    globalToggle.setChecked(
+                            PrefServiceBridge.getInstance().isProtectedMediaIdentifierEnabled());
                 }
             }
         }
     }
 
     private void updateThirdPartyCookiesCheckBox() {
         ChromeBaseCheckBoxPreference thirdPartyCookiesPref = (ChromeBaseCheckBoxPreference)
                 getPreferenceScreen().findPreference(THIRD_PARTY_COOKIES_TOGGLE_KEY);
         thirdPartyCookiesPref.setEnabled(PrefServiceBridge.getInstance().isAcceptCookiesEnabled());
         thirdPartyCookiesPref.setManagedPreferenceDelegate(new ManagedPreferenceDelegate() {
             @Override
             public boolean isPreferenceControlledByPolicy(Preference preference) {
                 return PrefServiceBridge.getInstance().isBlockThirdPartyCookiesManaged();
             }
         });
     }
 
     private void showManagedToast() {
         if (isCategoryManagedByCustodian()) {
             ManagedPreferencesUtils.showManagedByParentToast(getActivity());
         } else {
             ManagedPreferencesUtils.showManagedByAdministratorToast(getActivity());
         }
     }
+
+    @Override

[newt (away), 2015/04/30 00:31:59]

add

    // ProtectedContentResetCredentialConfirmDialogFragment.Listener:

above this method

[knn, 2015/04/30 16:00:36]

Done.

+    public void resetDeviceCredential() {
+        MediaDrmCredentialManager.resetCredentials(new MediaDrmCredentialManagerCallback() {
+            @Override
+            public void onCredentialResetFinished(boolean succeeded) {
+                if (succeeded) return;
+                String message = getString(R.string.protected_content_reset_failed);
+                Toast.makeText(getActivity(), message, Toast.LENGTH_SHORT).show();
+            }
+        });
+    }
 }