Removing NavigationClient dependencies from Tab.

chrome/android/java/src/org/chromium/chrome/browser/Tab.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;
 
 import android.app.Activity;
 import android.content.Context;
 import android.graphics.Bitmap;
 import android.graphics.Color;
 import android.view.ContextMenu;
 import android.view.View;
 
 import org.chromium.base.CalledByNative;
 import org.chromium.base.ObserverList;
-import org.chromium.base.TraceEvent;
 import org.chromium.base.VisibleForTesting;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.banners.AppBannerManager;
 import org.chromium.chrome.browser.contextmenu.ChromeContextMenuItemDelegate;
 import org.chromium.chrome.browser.contextmenu.ChromeContextMenuPopulator;
 import org.chromium.chrome.browser.contextmenu.ContextMenuParams;
 import org.chromium.chrome.browser.contextmenu.ContextMenuPopulator;
 import org.chromium.chrome.browser.contextmenu.ContextMenuPopulatorWrapper;
 import org.chromium.chrome.browser.contextmenu.EmptyChromeContextMenuItemDelegate;
 import org.chromium.chrome.browser.dom_distiller.DomDistillerFeedbackReporter;
 import org.chromium.chrome.browser.infobar.AutoLoginProcessor;
 import org.chromium.chrome.browser.infobar.InfoBarContainer;
 import org.chromium.chrome.browser.profiles.Profile;
 import org.chromium.chrome.browser.toolbar.ToolbarModel;
 import org.chromium.content.browser.ContentView;
 import org.chromium.content.browser.ContentViewClient;
 import org.chromium.content.browser.ContentViewCore;
-import org.chromium.content.browser.NavigationClient;
 import org.chromium.content.browser.WebContentsObserver;
 import org.chromium.content_public.browser.LoadUrlParams;
+import org.chromium.content_public.browser.NavigationController;
+import org.chromium.content_public.browser.NavigationEntry;
 import org.chromium.content_public.browser.NavigationHistory;
 import org.chromium.content_public.browser.WebContents;
 import org.chromium.ui.base.Clipboard;
 import org.chromium.ui.base.WindowAndroid;
 
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
  * The basic Java representation of a tab.  Contains and manages a {@link ContentView}.
  *
@@ skipping 18 matching lines @@
  *  to the parameter passed to that method.  This should be used when doing things like loading
  *  persisted {@link Tab}s from disk on process start to ensure all new {@link Tab}s don't have id
  *  collision.
  *    Some {@link Activity}s will not call this because they do not persist state, which means those
  *  ids can potentially conflict with the ones restored from persisted state depending on which
  *  {@link Activity} runs first on process start.  If {@link Tab}s are ever shared across
  *  {@link Activity}s or mixed with {@link Tab}s from other {@link Activity}s conflicts can occur
  *  unless special care is taken to make sure {@link Tab#incrementIdCounterTo(int)} is called with
  *  the correct value across all affected {@link Activity}s.
  */
-public class Tab implements NavigationClient {
+public class Tab implements NavigationController {

[Ted C, 2014/10/22 17:41:33]

We shouldn't be doing this.

Some of these methods are here for convenience, but we don't want to add all of
the rest.

It is find to just remove NavigationClient from Tab and leave the methods as
they were.

[Yaron, 2014/10/22 17:54:04]

Ya, I definitely agree with Ted here

[AKVT, 2014/10/23 13:34:27]

Done. Thank you

[AKVT, 2014/10/23 13:34:27]

Done. Thank you

     public static final int INVALID_TAB_ID = -1;
 
     /** Used for automatically generating tab ids. */
     private static final AtomicInteger sIdCounter = new AtomicInteger();
 
     private long mNativeTabAndroid;
 
     /** Unique id of this tab (within its container). */
     private final int mId;
 
@@ skipping 290 matching lines @@
      * Removes a {@link TabObserver}.
      * @param observer The {@link TabObserver} to remove.
      */
     public void removeObserver(TabObserver observer) {
         mObservers.removeObserver(observer);
     }
 
     /**
      * @return Whether or not this tab has a previous navigation entry.
      */
+    @Override
     public boolean canGoBack() {
         return getWebContents() != null && getWebContents().getNavigationController().canGoBack();
     }
 
     /**
      * @return Whether or not this tab has a navigation entry after the current one.
      */
+    @Override
     public boolean canGoForward() {
         return getWebContents() != null && getWebContents().getNavigationController()
                 .canGoForward();
     }
 
     /**
      * Goes to the navigation entry before the current one.
      */
+    @Override
     public void goBack() {
         if (getWebContents() != null) getWebContents().getNavigationController().goBack();
     }
 
     /**
      * Goes to the navigation entry after the current one.
      */
+    @Override
     public void goForward() {
         if (getWebContents() != null) getWebContents().getNavigationController().goForward();
     }
 
     @Override
     public NavigationHistory getDirectedNavigationHistory(boolean isForward, int itemLimit) {
         if (getWebContents() != null) {
             return getWebContents().getNavigationController()
                     .getDirectedNavigationHistory(isForward, itemLimit);
         } else {
             return new NavigationHistory();
         }
     }
 
     @Override
     public void goToNavigationIndex(int index) {
         if (getWebContents() != null) {
             getWebContents().getNavigationController().goToNavigationIndex(index);
         }
     }
 
     /**
+     * @return The pending {@link NavigationEntry} for this tab or {@code null} if none
+     *         exists.
+     */
+    @Override
+    public NavigationEntry getPendingEntry() {
+        if (getWebContents() == null) return null;
+        return getWebContents().getNavigationController().getPendingEntry();
+    }
+
+    /**
      * Loads the current navigation if there is a pending lazy load (after tab restore).
      */
+    @Override
     public void loadIfNecessary() {
         if (getWebContents() != null) getWebContents().getNavigationController().loadIfNecessary();
     }
 
     /**
      * Requests the current navigation to be loaded upon the next call to loadIfNecessary().
      */
-    protected void requestRestoreLoad() {
+    @Override
+    public void requestRestoreLoad() {
         if (getWebContents() != null) {
             getWebContents().getNavigationController().requestRestoreLoad();
         }
     }
 
     /**
      * Causes this tab to navigate to the specified URL.
      * @param params parameters describing the url load. Note that it is important to set correct
      *               page transition as it is used for ranking URLs in the history so the omnibox
      *               can report suggestions correctly.
-     * @return FULL_PRERENDERED_PAGE_LOAD or PARTIAL_PRERENDERED_PAGE_LOAD if the page has been
-     *         prerendered. DEFAULT_PAGE_LOAD if it had not.
      */
-    public int loadUrl(LoadUrlParams params) {
-        TraceEvent.begin();
-
-        // We load the URL from the tab rather than directly from the ContentView so the tab has a
-        // chance of using a prerenderer page is any.
-        int loadType = nativeLoadUrl(
-                mNativeTabAndroid,
-                params.getUrl(),
-                params.getVerbatimHeaders(),
-                params.getPostData(),
-                params.getTransitionType(),
-                params.getReferrer() != null ? params.getReferrer().getUrl() : null,
-                // Policy will be ignored for null referrer url, 0 is just a placeholder.
-                // TODO(ppi): Should we pass Referrer jobject and add JNI methods to read it from
-                //            the native?
-                params.getReferrer() != null ? params.getReferrer().getPolicy() : 0,
-                params.getIsRendererInitiated());
-
-        TraceEvent.end();
-
-        for (TabObserver observer : mObservers) {
-            observer.onLoadUrl(this, params.getUrl(), loadType);
-        }
-        return loadType;
+    @Override
+    public void loadUrl(LoadUrlParams params) {
+        if (getWebContents() != null) getWebContents().getNavigationController().loadUrl(params);
     }
 
     /**
+     * Clears SSL preferences for this Tab.
+     */
+    @Override
+    public void clearSslPreferences() {
+        if (getWebContents() != null) {
+            getWebContents().getNavigationController().clearSslPreferences();
+        }
+    }
+
+    /**
+     * Get Original URL for current Navigation entry of Tab.
+     * @return The original request URL for the current navigation entry, or null if there is no
+     *         current entry.
+     */
+    @Override
+    public String getOriginalUrlForVisibleNavigationEntry() {
+        if (getWebContents() == null) return null;
+        return getWebContents().getNavigationController()
+                .getOriginalUrlForVisibleNavigationEntry();
+    }
+
+    /**
+     * Get a copy of the navigation history of NavigationController.
+     * @return navigation history of Tab.
+     */
+    @Override
+    public NavigationHistory getNavigationHistory() {
+        if (getWebContents() == null) return null;
+        return getWebContents().getNavigationController().getNavigationHistory();
+    }
+
+     /**
+     * Clears Tab's page history in both backwards and
+     * forwards directions.
+     */
+    @Override
+    public void clearHistory() {
+        if (getWebContents() != null) getWebContents().getNavigationController().clearHistory();
+    }
+
+    /**
+     * Continue the pending reload.
+     */
+    @Override
+    public void continuePendingReload() {
+        if (getWebContents() != null) {
+            getWebContents().getNavigationController().continuePendingReload();
+        }
+    }
+
+    /**
+     * Cancel the pending reload.
+     */
+    @Override
+    public void cancelPendingReload() {
+        if (getWebContents() != null) {
+            getWebContents().getNavigationController().continuePendingReload();
+        }
+    }
+
+    /**
+     * @param offset The offset into the navigation history.
+     * @return Whether we can move in history by given offset
+     */
+    @Override
+    public boolean canGoToOffset(int offset) {
+        if (getWebContents() == null) return false;
+        return getWebContents().getNavigationController().canGoToOffset(offset);
+    }
+
+    /**
+     * Navigates to the specified offset from the "current entry". Does nothing if the offset is
+     * out of bounds.
+     * @param offset The offset into the navigation history.
+     */
+    @Override
+    public void goToOffset(int offset) {
+        if (getWebContents() != null) {
+            getWebContents().getNavigationController().goToOffset(offset);
+        }
+    }
+
+    /**
      * @return Whether or not the {@link Tab} is currently showing an interstitial page, such as
      *         a bad HTTPS page.
      */
     public boolean isShowingInterstitialPage() {
         return getWebContents() != null && getWebContents().isShowingInterstitialPage();
     }
 
     /**
      * @return Whether or not the tab has something valid to render.
      */
@@ skipping 60 matching lines @@
      * @return Whether the printing process is started successfully.
      **/
     public boolean print() {
         assert mNativeTabAndroid != 0;
         return nativePrint(mNativeTabAndroid);
     }
 
     /**
      * Reloads the current page content.
      */
-    public void reload() {
+    @Override
+    public void reload(boolean checkForRepost) {
         // TODO(dtrainor): Should we try to rebuild the ContentView if it's frozen?
-        if (getWebContents() != null) getWebContents().getNavigationController().reload(true);
+        if (getWebContents() != null) {
+            getWebContents().getNavigationController().reload(checkForRepost);
+        }
     }
 
     /**
      * Reloads the current page content.
      * This version ignores the cache and reloads from the network.
      */
-    public void reloadIgnoringCache() {
+    @Override
+    public void reloadIgnoringCache(boolean checkForRepost) {
         if (getWebContents() != null) {
-            getWebContents().getNavigationController().reloadIgnoringCache(true);
+            getWebContents().getNavigationController().reloadIgnoringCache(checkForRepost);
         }
     }
 
     /** Stop the current navigation. */
     public void stopLoading() {
         if (getWebContents() != null) getWebContents().stop();
     }
 
     /**
      * @return The background color of the tab.
@@ skipping 59 matching lines @@
     public boolean isNativePage() {
         return mNativePage != null;
     }
 
     /**
      * Set whether or not the {@link ContentViewCore} should be using a desktop user agent for the
      * currently loaded page.
      * @param useDesktop     If {@code true}, use a desktop user agent.  Otherwise use a mobile one.
      * @param reloadOnChange Reload the page if the user agent has changed.
      */
+    @Override
     public void setUseDesktopUserAgent(boolean useDesktop, boolean reloadOnChange) {
         if (getWebContents() != null) {
             getWebContents().getNavigationController()
                     .setUseDesktopUserAgent(useDesktop, reloadOnChange);
         }
     }
 
     /**
      * @return Whether or not the {@link ContentViewCore} is using a desktop user agent.
      */
+    @Override
     public boolean getUseDesktopUserAgent() {
         return getWebContents() != null && getWebContents().getNavigationController()
                 .getUseDesktopUserAgent();
     }
 
     /**
      * @return The current {ToolbarModelSecurityLevel} for the tab.
      */
     // TODO(tedchoc): Remove this and transition all clients to use ToolbarModel directly.
     public int getSecurityLevel() {
@@ skipping 556 matching lines @@
     private native Profile nativeGetProfileAndroid(long nativeTabAndroid);
     private native int nativeLoadUrl(long nativeTabAndroid, String url, String extraHeaders,
             byte[] postData, int transition, String referrerUrl, int referrerPolicy,
             boolean isRendererInitiated);
     private native void nativeSetActiveNavigationEntryTitleForUrl(long nativeTabAndroid, String url,
             String title);
     private native boolean nativePrint(long nativeTabAndroid);
     private native Bitmap nativeGetFavicon(long nativeTabAndroid);
     private native boolean nativeIsFaviconValid(long nativeTabAndroid);
 }