🏠 Extract the ContentSuggestionManager interface from NTP

chrome/android/java/src/org/chromium/chrome/browser/ntp/NewTabPageView.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.ntp;
 
 import android.annotation.SuppressLint;
 import android.content.Context;
 import android.content.res.Configuration;
 import android.content.res.Resources;
@@ skipping 24 matching lines @@
 import android.widget.FrameLayout;
 import android.widget.ImageView;
 import android.widget.TextView;
 
 import org.chromium.base.ApiCompatibilityUtils;
 import org.chromium.base.Callback;
 import org.chromium.base.Log;
 import org.chromium.base.VisibleForTesting;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.ChromeActivity;
-import org.chromium.chrome.browser.favicon.FaviconHelper.FaviconImageCallback;
-import org.chromium.chrome.browser.favicon.FaviconHelper.IconAvailabilityCallback;
 import org.chromium.chrome.browser.favicon.LargeIconBridge.LargeIconCallback;
 import org.chromium.chrome.browser.ntp.LogoBridge.Logo;
 import org.chromium.chrome.browser.ntp.LogoBridge.LogoObserver;
 import org.chromium.chrome.browser.ntp.MostVisitedItem.MostVisitedItemManager;
 import org.chromium.chrome.browser.ntp.NewTabPage.DestructionObserver;
 import org.chromium.chrome.browser.ntp.NewTabPage.OnSearchBoxScrollListener;
 import org.chromium.chrome.browser.ntp.cards.CardsVariationParameters;
 import org.chromium.chrome.browser.ntp.cards.NewTabPageAdapter;
 import org.chromium.chrome.browser.ntp.cards.NewTabPageRecyclerView;
-import org.chromium.chrome.browser.ntp.snippets.SnippetArticle;
 import org.chromium.chrome.browser.ntp.snippets.SnippetsConfig;
-import org.chromium.chrome.browser.ntp.snippets.SuggestionsSource;
 import org.chromium.chrome.browser.offlinepages.OfflinePageBridge;
 import org.chromium.chrome.browser.profiles.MostVisitedSites.MostVisitedURLsObserver;
 import org.chromium.chrome.browser.profiles.Profile;
-import org.chromium.chrome.browser.suggestions.SuggestionsMetricsReporter;
+import org.chromium.chrome.browser.suggestions.SuggestionsUiDelegate;
 import org.chromium.chrome.browser.tab.Tab;
 import org.chromium.chrome.browser.util.MathUtils;
 import org.chromium.chrome.browser.util.ViewUtils;
 import org.chromium.chrome.browser.widget.RoundedIconGenerator;
 import org.chromium.ui.base.DeviceFormFactor;
 
 import java.util.Arrays;
 import java.util.HashSet;
 import java.util.Set;
 
@@ skipping 22 matching lines @@
     private NewTabPageRecyclerView mRecyclerView;
 
     private NewTabPageLayout mNewTabPageLayout;
     private LogoView mSearchProviderLogoView;
     private View mSearchBoxView;
     private ImageView mVoiceSearchButton;
     private MostVisitedLayout mMostVisitedLayout;
     private View mMostVisitedPlaceholder;
     private View mNoSearchLogoSpacer;
 
-    /** Adapter for {@link #mRecyclerView}. Will be {@code null} when using the old UI */
-    private NewTabPageAdapter mNewTabPageAdapter;
-
     private OnSearchBoxScrollListener mSearchBoxScrollListener;
 
     private ChromeActivity mActivity;
     private NewTabPageManager mManager;
     private UiConfig mUiConfig;
     private MostVisitedDesign mMostVisitedDesign;
     private MostVisitedItem[] mMostVisitedItems;
     private boolean mFirstShow = true;
     private boolean mSearchProviderHasLogo = true;
     private boolean mHasReceivedMostVisitedSites;
@@ skipping 14 matching lines @@
     private boolean mSnapshotMostVisitedChanged;
     private boolean mNewTabPageRecyclerViewChanged;
     private int mSnapshotWidth;
     private int mSnapshotHeight;
     private int mSnapshotScrollY;
     private ContextMenuManager mContextMenuManager;
 
     /**
      * Manages the view interaction with the rest of the system.
      */
-    public interface NewTabPageManager extends MostVisitedItemManager {
+    public interface NewTabPageManager extends MostVisitedItemManager, SuggestionsUiDelegate {
         /** @return Whether the location bar is shown in the NTP. */
         boolean isLocationBarShownInNTP();
 
         /** @return Whether voice search is enabled and the microphone should be shown. */
         boolean isVoiceSearchEnabled();
 
         /** @return Whether the omnibox 'Search or type URL' text should be shown. */
         boolean isFakeOmniboxTextEnabledTablet();
 
-        /** @return Whether context menus should allow the option to open a link in a new window. */
-        boolean isOpenInNewWindowEnabled();
-
-        /** @return Whether context menus should allow the option to open a link in incognito. */
-        boolean isOpenInIncognitoEnabled();
-
-        /** Opens the bookmarks page in the current tab. */
-        void navigateToBookmarks();
-
-        /** Opens the recent tabs page in the current tab. */
-        void navigateToRecentTabs();
-
-        /** Opens the Download Manager UI in the current tab. */
-        void navigateToDownloadManager();
-
-        /**
-         * Opens a content suggestion and records related metrics.
-         * @param windowOpenDisposition How to open (current tab, new tab, new window etc).
-         * @param article The content suggestion to open.
-         */
-        void openSnippet(int windowOpenDisposition, SnippetArticle article);
-
         /**
          * Animates the search box up into the omnibox and bring up the keyboard.
          * @param beginVoiceSearch Whether to begin a voice search.
          * @param pastedText Text to paste in the omnibox after it's been focused. May be null.
          */
         void focusSearchBox(boolean beginVoiceSearch, String pastedText);
 
         /**
          * Gets the list of most visited sites.
          * @param observer The observer to be notified with the list of sites.
          * @param numResults The maximum number of sites to retrieve.
          */
         void setMostVisitedURLsObserver(MostVisitedURLsObserver observer, int numResults);
 
         /**
-         * Gets the favicon image for a given URL.
-         * @param url The URL of the site whose favicon is being requested.
-         * @param size The desired size of the favicon in pixels.
-         * @param faviconCallback The callback to be notified when the favicon is available.
-         */
-        void getLocalFaviconImageForURL(
-                String url, int size, FaviconImageCallback faviconCallback);
-
-        /**
-         * Gets the large icon (e.g. favicon or touch icon) for a given URL.
-         * @param url The URL of the site whose icon is being requested.
-         * @param size The desired size of the icon in pixels.
-         * @param callback The callback to be notified when the icon is available.
-         */
-        void getLargeIconForUrl(String url, int size, LargeIconCallback callback);
-
-        /**
-         * Checks if an icon with the given URL is available. If not,
-         * downloads it and stores it as a favicon/large icon for the given {@code pageUrl}.
-         * @param pageUrl The URL of the site whose icon is being requested.
-         * @param iconUrl The URL of the favicon/large icon.
-         * @param isLargeIcon Whether the {@code iconUrl} represents a large icon or favicon.
-         * @param callback The callback to be notified when the favicon has been checked.
-         */
-        void ensureIconIsAvailable(String pageUrl, String iconUrl, boolean isLargeIcon,
-                boolean isTemporary, IconAvailabilityCallback callback);
-
-        /**
-         * Checks if the pages with the given URLs are available offline.
-         * @param pageUrls The URLs of the sites whose offline availability is requested.
-         * @param callback Fired when the results are available.
-         */
-        void getUrlsAvailableOffline(Set<String> pageUrls, Callback<Set<String>> callback);
-
-        /**
          * Called when the user clicks on the logo.
          * @param isAnimatedLogoShowing Whether the animated GIF logo is playing.
          */
         void onLogoClicked(boolean isAnimatedLogoShowing);
 
         /**
          * Gets the default search provider's logo and calls logoObserver with the result.
          * @param logoObserver The callback to notify when the logo is available.
          */
         void getSearchProviderLogo(LogoObserver logoObserver);
 
         /**
          * Called when the NTP has completely finished loading (all views will be inflated
          * and any dependent resources will have been loaded).
          * @param mostVisitedItems The MostVisitedItem shown on the NTP. Used to record metrics.
          */
         void onLoadingComplete(MostVisitedItem[] mostVisitedItems);
 
         /**
-         * Handles clicks on the "learn more" link in the footer.
-         */
-        void onLearnMoreClicked();
-
-        /**
-         * Returns the SuggestionsSource or null if it doesn't exist. The SuggestionsSource is
-         * invalidated (has destroy() called) when the NewTabPage is destroyed so use this method
-         * instead of keeping your own reference.
-         */
-        @Nullable SuggestionsSource getSuggestionsSource();
-
-        /**
-         * Registers a {@link DestructionObserver}, notified when the New Tab Page goes away.
-         */
-        void addDestructionObserver(DestructionObserver destructionObserver);
-
-        /**
          * @return whether the {@link NewTabPage} associated with this manager is the current page
          * displayed to the user.
          */
         boolean isCurrentPage();
 
         /**
          * @return The context menu manager. Will be {@code null} if the {@link NewTabPageView} is
          * not done initialising.
          */
         @Nullable
         ContextMenuManager getContextMenuManager();
-
-        /**
-         * @return The suggestion metrics reporter. Will be {@code null} if the
-         * {@link NewTabPageView} is not done initialising.
-         */
-        @Nullable
-        SuggestionsMetricsReporter getSuggestionsMetricsReporter();
     }
 
     /**
      * Default constructor required for XML inflation.
      */
     public NewTabPageView(Context context, AttributeSet attrs) {
         super(context, attrs);
     }
 
     /**
@@ skipping 41 matching lines @@
                 }
             });
         } else {
             stub.setLayoutResource(R.layout.new_tab_page_scroll_view);
             mScrollView = (NewTabPageScrollView) stub.inflate();
             mScrollView.setBackgroundColor(
                     ApiCompatibilityUtils.getColor(getResources(), R.color.ntp_bg));
             mScrollView.enableBottomShadow(SHADOW_COLOR);
             mNewTabPageLayout = (NewTabPageLayout) findViewById(R.id.ntp_content);
         }
-        mContextMenuManager = new ContextMenuManager(mActivity, mManager,
+        mContextMenuManager = new ContextMenuManager(mActivity, mManager.getNavigationDelegate(),
                 mUseCardsUi ? mRecyclerView : mScrollView);
         mActivity.getWindowAndroid().addContextMenuCloseListener(mContextMenuManager);
         manager.addDestructionObserver(new DestructionObserver() {
             @Override
             public void onDestroy() {
                 mActivity.getWindowAndroid().removeContextMenuCloseListener(mContextMenuManager);
             }
         });
 
         mMostVisitedDesign = new MostVisitedDesign(getContext());
@@ skipping 12 matching lines @@
 
         mNewTabPageLayout.addOnLayoutChangeListener(this);
         setSearchProviderHasLogo(searchProviderHasLogo);
 
         mPendingLoadTasks++;
         mManager.setMostVisitedURLsObserver(
                 this, mMostVisitedDesign.getNumberOfTiles(searchProviderHasLogo));
 
         // Set up snippets
         if (mUseCardsUi) {
-            mNewTabPageAdapter = new NewTabPageAdapter(mManager, mNewTabPageLayout, mUiConfig,
-                    OfflinePageBridge.getForProfile(Profile.getLastUsedProfile()));
-            mRecyclerView.setAdapter(mNewTabPageAdapter);
+            NewTabPageAdapter newTabPageAdapter = new NewTabPageAdapter(mManager, mNewTabPageLayout,
+                    mUiConfig, OfflinePageBridge.getForProfile(Profile.getLastUsedProfile()),
+                    mContextMenuManager);
+            mRecyclerView.setAdapter(newTabPageAdapter);
 
             int scrollOffset;
             if (CardsVariationParameters.isScrollBelowTheFoldEnabled()) {
-                scrollPosition = mNewTabPageAdapter.getFirstHeaderPosition();
+                scrollPosition = newTabPageAdapter.getFirstHeaderPosition();
                 scrollOffset = getResources().getDimensionPixelSize(R.dimen.ntp_search_box_height);
             } else {
                 scrollOffset = 0;
             }
             mRecyclerView.getLinearLayoutManager().scrollToPositionWithOffset(
                     scrollPosition, scrollOffset);
 
             mRecyclerView.setUpSwipeToDismiss();
 
             initializeSearchBoxRecyclerViewScrollHandling();
 
             // When the NewTabPageAdapter's data changes we need to invalidate any previous
             // screen captures of the NewTabPageView.
-            mNewTabPageAdapter.registerAdapterDataObserver(new AdapterDataObserver() {
+            newTabPageAdapter.registerAdapterDataObserver(new AdapterDataObserver() {
                 @Override
                 public void onChanged() {
                     mNewTabPageRecyclerViewChanged = true;
                 }
 
                 @Override
                 public void onItemRangeChanged(int positionStart, int itemCount) {
                     onChanged();
                 }
 
@@ skipping 72 matching lines @@
         NewTabPageToolbar toolbar = (NewTabPageToolbar) findViewById(R.id.ntp_toolbar);
         if (SnippetsConfig.isEnabled()) {
             ((ViewGroup) toolbar.getParent()).removeView(toolbar);
             MarginLayoutParams params = (MarginLayoutParams) getWrapperView().getLayoutParams();
             params.bottomMargin = 0;
         } else {
             toolbar.getRecentTabsButton().setOnClickListener(new View.OnClickListener() {
                 @Override
                 public void onClick(View v) {
                     NewTabPageUma.recordAction(NewTabPageUma.ACTION_OPENED_RECENT_TABS_MANAGER);
-                    mManager.navigateToRecentTabs();
+                    mManager.getNavigationDelegate().navigateToRecentTabs();
                 }
             });
             toolbar.getBookmarksButton().setOnClickListener(new View.OnClickListener() {
                 @Override
                 public void onClick(View v) {
                     NewTabPageUma.recordAction(NewTabPageUma.ACTION_OPENED_BOOKMARKS_MANAGER);
-                    mManager.navigateToBookmarks();
+                    mManager.getNavigationDelegate().navigateToBookmarks();
                 }
             });
         }
     }
 
     private void updateSearchBoxOnScroll() {
         if (mDisableUrlFocusChangeAnimations) return;
 
         // When the page changes (tab switching or new page loading), it is possible that events
         // (e.g. delayed RecyclerView change notifications) trigger calls to these methods after
@@ skipping 716 matching lines @@
     public int getScrollPosition() {
         if (mUseCardsUi) return mRecyclerView.getScrollPosition();
         return RecyclerView.NO_POSITION;
     }
 
     /** @return the context menu manager. */
     public ContextMenuManager getContextMenuManager() {
         return mContextMenuManager;
     }
 }