[ImportantSites] JNI bindings for CBD filtering and Important Sites.

chrome/android/java/src/org/chromium/chrome/browser/preferences/PrefServiceBridge.java

 // Copyright 2014 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;
 
 import android.content.Context;
 import android.content.SharedPreferences;
 import android.preference.PreferenceManager;
 import android.util.Log;
@@ skipping 23 matching lines @@
     public static final int SUPERVISED_USER_FILTERING_WARN = 1;
     public static final int SUPERVISED_USER_FILTERING_BLOCK = 2;
 
     private static final String MIGRATION_PREF_KEY = "PrefMigrationVersion";
     private static final int MIGRATION_CURRENT_VERSION = 4;
 
     private static final String HTTPS_SCHEME = "https";
 
     // Object to notify when "clear browsing data" completes.
     private OnClearBrowsingDataListener mClearBrowsingDataListener;
+    // Object to notify when we finished fetching important sites.
+    private ImportantSitesCallback mImportantSitesCallback;
     private static final String LOG_TAG = "PrefServiceBridge";
 
     // Constants related to the Contextual Search preference.
     private static final String CONTEXTUAL_SEARCH_DISABLED = "false";
     private static final String CONTEXTUAL_SEARCH_ENABLED = "true";
 
     // The key to store whether the Location Permission was automatically added for the search
     // engine set as default.
     public static final String LOCATION_AUTO_ALLOWED = "search_engine_location_auto_allowed";
 
@@ skipping 19 matching lines @@
     }
 
     /**
      * Interface for a class that is listening to clear browser data events.
      */
     public interface OnClearBrowsingDataListener {
         public abstract void onBrowsingDataCleared();
     }
 
     /**
+     * Interface for a class that is fetching important site information.
+     */
+    public interface ImportantSitesCallback {
+        /**
+         * Called by native code to populate the set of important registerable domains.

[Theresa, 2016/04/21 16:05:28]

Technically this isn't called by native code (it's called in a Java method
below). Maybe something like "Called when the list of important registerable
domains has been fetched."?

Nit on the @param line -- capitalize Important.

[dmurph, 2016/04/21 18:53:25]

Done.

+         * See net/base/registry_controlled_domains/registry_controlled_domain.h for more details on
+         * registrable domains and the current list of effective eTLDs.
+         * @param domains important registerable domains.
+         */
+        public abstract void setImportantRegisterableDomains(String[] domains);
+    }
+
+    /**
      * Interface to a class that receives callbacks instructing it to inform the user about other
      * forms of browsing history.
      */
     public interface OtherFormsOfBrowsingHistoryListener {
         /**
          * Called by the web history service when it discovers that other forms of browsing history
          * exist.
          */
         @CalledByNative("OtherFormsOfBrowsingHistoryListener")
         public abstract void enableDialogAboutOtherFormsOfBrowsingHistory();
@@ skipping 630 matching lines @@
      * It can be null, but many operations (e.g. navigation) are
      * ill-advised while browsing data is being cleared.
      * @param listener A listener to call back when the clearing is finished.
      * @param dataTypes An array of browsing data types to delete, represented as values from
      *      the shared enum {@link org.chromium.chrome.browser.BrowsingDataType}.
      * @param timePeriod The time period for which to delete the data, represented as a value from
      *      the shared enum {@link org.chromium.chrome.browser.TimePeriod}.
      */
     public void clearBrowsingData(
             OnClearBrowsingDataListener listener, int[] dataTypes, int timePeriod) {
+        clearBrowsingDataExcludingDomains(listener, dataTypes, timePeriod, new String[0]);
+    }
+
+    /**
+     * Same as above, but now we can specify a list of domains to exclude from clearing browsing
+     * data.
+     * Do not use this method unless caller knows what they're doing. Not all backends are supported
+     * yet, and more data than expected could be deleted. See crbug.com/113621.
+     */
+    public void clearBrowsingDataExcludingDomains(OnClearBrowsingDataListener listener,

[Theresa, 2016/04/21 16:05:28]

add JavaDocs for the params (or at least the extra origins param) please -- also
consider renaming to blacklistDomains to match the native method

[dmurph, 2016/04/21 18:53:25]

Done.

[dmurph, 2016/04/21 18:53:25]

Done.

+            int[] dataTypes, int timePeriod, String[] origins) {
         assert mClearBrowsingDataListener == null;
         mClearBrowsingDataListener = listener;
-        nativeClearBrowsingData(dataTypes, timePeriod);
+        nativeClearBrowsingData(dataTypes, timePeriod, origins);
     }
 
     /*
      * Whether browser history can be deleted by the user.
      */
     public boolean canDeleteBrowsingHistory() {
         return nativeCanDeleteBrowsingHistory();
     }
 
     @CalledByNative
     private void browsingDataCleared() {
         if (mClearBrowsingDataListener != null) {
             mClearBrowsingDataListener.onBrowsingDataCleared();
             mClearBrowsingDataListener = null;
         }
     }
 
     /**
+     * This fetches sites (registerable domains) that we consider important. This combines many
+     * pieces of information, including site engagement and permissions. The callback is called
+     * with the list of important registerable domains.
+     *
+     * See net/base/registry_controlled_domains/registry_controlled_domain.h for more details on
+     * registrable domains and the current list of effective eTLDs.
+     * @param callback the callback that will be used to set the list of important sites.

[Theresa, 2016/04/21 16:05:28]

nit: capitalize The

[dmurph, 2016/04/21 18:53:25]

Done.

+     */
+    public void fetchImportantSites(ImportantSitesCallback callback) {
+        assert mImportantSitesCallback == null;
+        mImportantSitesCallback = callback;
+        nativeFetchImportantSites();
+    }
+
+    @CalledByNative
+    private void importantSitesFetched(String[] domains) {
+        if (mImportantSitesCallback != null) {
+            mImportantSitesCallback.setImportantRegisterableDomains(domains);
+            mImportantSitesCallback = null;
+        }
+    }
+
+    /**
      * Requests that the web history service finds out if we should inform the user about the
      * existence of other forms of browsing history. The response will be asynchronous, through
      * {@link OtherFormsOfBrowsingHistoryListener}.
      */
     public void requestInfoAboutOtherFormsOfBrowsingHistory(
             OtherFormsOfBrowsingHistoryListener listener) {
         nativeRequestInfoAboutOtherFormsOfBrowsingHistory(listener);
     }
 
     public void setAllowCookiesEnabled(boolean allow) {
@@ skipping 279 matching lines @@
     private native boolean nativeGetPrintingManaged();
     private native boolean nativeGetSupervisedUserSafeSitesEnabled();
     private native void nativeSetTranslateEnabled(boolean enabled);
     private native void nativeSetAutoDetectEncodingEnabled(boolean enabled);
     private native void nativeResetTranslateDefaults();
     private native void nativeMigrateJavascriptPreference();
     private native boolean nativeGetBrowsingDataDeletionPreference(int dataType);
     private native void nativeSetBrowsingDataDeletionPreference(int dataType, boolean value);
     private native int nativeGetBrowsingDataDeletionTimePeriod();
     private native void nativeSetBrowsingDataDeletionTimePeriod(int timePeriod);
-    private native void nativeClearBrowsingData(int[] dataTypes, int timePeriod);
+    private native void nativeClearBrowsingData(
+            int[] dataTypes, int timePeriod, String[] blacklistDomains);
     private native void nativeRequestInfoAboutOtherFormsOfBrowsingHistory(
             OtherFormsOfBrowsingHistoryListener listener);
     private native boolean nativeCanDeleteBrowsingHistory();
+    private native void nativeFetchImportantSites();
     private native void nativeSetAllowCookiesEnabled(boolean allow);
     private native void nativeSetBackgroundSyncEnabled(boolean allow);
     private native void nativeSetBlockThirdPartyCookiesEnabled(boolean enabled);
     private native void nativeSetDoNotTrackEnabled(boolean enabled);
     private native void nativeSetFullscreenAllowed(boolean allowed);
     private native void nativeSetRememberPasswordsEnabled(boolean allow);
     private native void nativeSetPasswordManagerAutoSigninEnabled(boolean enabled);
     private native void nativeSetProtectedMediaIdentifierEnabled(boolean enabled);
     private native boolean nativeGetAllowLocationEnabled();
     private native boolean nativeGetNotificationsEnabled();
@@ skipping 33 matching lines @@
     private native String nativeGetSupervisedUserSecondCustodianName();
     private native String nativeGetSupervisedUserSecondCustodianEmail();
     private native String nativeGetSupervisedUserSecondCustodianProfileImageURL();
     private native boolean nativeGetMetricsReportingEnabled();
     private native void nativeSetMetricsReportingEnabled(boolean enabled);
     private native boolean nativeHasSetMetricsReporting();
     private native void nativeSetClickedUpdateMenuItem(boolean clicked);
     private native boolean nativeGetClickedUpdateMenuItem();
     private native void nativeSetSupervisedUserId(String supervisedUserId);
 }