Adding CrHome-specific implementation for home page tile.

chrome/android/java/src/org/chromium/chrome/browser/suggestions/MostVisitedSitesBridge.java

 // Copyright 2013 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.suggestions;
 
+import static org.chromium.base.ContextUtils.getApplicationContext;

[dgn, 2017/05/25 10:33:33]

just use a regular import here, and call ContextUtils.getApplicationContext.

For tests static imports are fine to make things less verbose, but it just looks
confusing in production code.

[fhorschig, 2017/05/30 10:25:21]

Done.

+
 import org.chromium.base.annotations.JNIAdditionalImport;
+import org.chromium.chrome.browser.ChromeFeatureList;
+import org.chromium.chrome.browser.UrlConstants;
+import org.chromium.chrome.browser.partnercustomizations.HomepageManager;
 import org.chromium.chrome.browser.profiles.Profile;
 
 /**
  * Methods to bridge into native history to provide most recent urls, titles and thumbnails.
  */
 @JNIAdditionalImport(MostVisitedSites.class) // Needed for the Observer usage in the native calls.
-public class MostVisitedSitesBridge implements MostVisitedSites {
+public class MostVisitedSitesBridge
+        implements MostVisitedSites, HomepageManager.HomepageStateListener {
     private long mNativeMostVisitedSitesBridge;
 
     /**
      * MostVisitedSites constructor requires a valid user profile object.
      *
      * @param profile The profile for which to fetch most visited sites.
      */
     public MostVisitedSitesBridge(Profile profile) {
         mNativeMostVisitedSitesBridge = nativeInit(profile);
+        // The first tile replaces the home page button (only) in Chrome Home.
+        if (ChromeFeatureList.isEnabled(ChromeFeatureList.CHROME_HOME)) {
+            initializeClient();
+            HomepageManager.getInstance(getApplicationContext()).addListener(this);

[dgn, 2017/05/25 10:33:33]

when should the listener be removed? destroy() ?

[fhorschig, 2017/05/30 10:25:21]

Yes. Done.

+        }
     }
 
     /**
      * Cleans up the C++ side of this class. This instance must not be used after calling destroy().
      */
     @Override
     public void destroy() {
         assert mNativeMostVisitedSitesBridge != 0;
         nativeDestroy(mNativeMostVisitedSitesBridge);
         mNativeMostVisitedSitesBridge = 0;
@@ skipping 35 matching lines @@
     public void recordPageImpression(int[] tileTypes, int[] sources, String[] tileUrls) {
         nativeRecordPageImpression(mNativeMostVisitedSitesBridge, tileTypes, sources, tileUrls);
     }
 
     @Override
     public void recordOpenedMostVisitedItem(
             int index, @TileVisualType int type, @TileSource int source) {
         nativeRecordOpenedMostVisitedItem(mNativeMostVisitedSitesBridge, index, type, source);
     }
 
+    @Override
+    public void onHomepageStateUpdated() {
+        if (mNativeMostVisitedSitesBridge == 0) {

[dgn, 2017/05/25 10:33:33]

can it happen in the normal functioning of the class? just assert otherwise?
That's what we do in the other functions.

[fhorschig, 2017/05/30 10:25:21]

Changed to assert.
This can not happen anymore (because the listener is always removed before
destroy()-ing the mNativeBridge; and initialized after native initialization).

+            return; // Calling the blacklist only works if the native side of the bridge is alive.
+        }
+        // Ensure the home page is set as first tile if (re-)enabled - even if blacklisted before.

[dgn, 2017/05/25 10:33:33]

how does that set the tile as first? to me it only looks like it just removes it
from the backlist. Isn't the order implementation detail thus not useful as a
comment here?

[fhorschig, 2017/05/30 10:25:21]

Absolutely. Gone.

+        if (HomepageManager.isHomepageEnabled(getApplicationContext())) {
+            removeBlacklistedUrl(HomepageManager.getHomepageUri(getApplicationContext()));
+        }
+    }
+
+    private void initializeClient() {
+        nativeSetClient(mNativeMostVisitedSitesBridge, new Client() {
+            @Override
+            public boolean isHomePageEnabled() {
+                return HomepageManager.isHomepageEnabled(getApplicationContext());
+            }
+
+            @Override
+            public boolean isNewTabPageUsedAsHomePage() {
+                return HomepageManager.getHomepageUri(getApplicationContext())

[dgn, 2017/05/25 10:33:33]

compare strings with TextUtils.equals(s1, s2), the home page URI being null here
would cause a crash. Also, why not just use getHomePageUrl here?

[fhorschig, 2017/05/30 10:25:21]

Thanks, done and used.
(This code used to work because isHomePageEnabled() is checked before anything
else but it's of course better to avoid the pitfalls for future changes.)

+                        .equals(UrlConstants.NTP_URL);
+            }
+
+            @Override
+            public String getHomePageUrl() {

[dgn, 2017/05/25 10:33:33]

this can return null, mark @Nullable? also, does the backend properly handle
that?

[fhorschig, 2017/05/30 10:25:21]

@Nullable added.
The backend handles null values now. (Previously, it relied on checking whether
the feature is enabled. But setting an empty page would have crashed.)

+                return HomepageManager.getHomepageUri(getApplicationContext());
+            }
+        });
+    }
+
     private native long nativeInit(Profile profile);
     private native void nativeDestroy(long nativeMostVisitedSitesBridge);
     private native void nativeSetObserver(
             long nativeMostVisitedSitesBridge, MostVisitedSites.Observer observer, int numSites);
+    private native void nativeSetClient(
+            long nativeMostVisitedSitesBridge, MostVisitedSites.Client client);
     private native void nativeAddOrRemoveBlacklistedUrl(
             long nativeMostVisitedSitesBridge, String url, boolean addUrl);
     private native void nativeRecordPageImpression(
             long nativeMostVisitedSitesBridge, int[] tileTypes, int[] sources, String[] tileUrls);
     private native void nativeRecordOpenedMostVisitedItem(
             long nativeMostVisitedSitesBridge, int index, int tileType, int source);
 }