Adding BlimpNavigationController to Tab

chrome/android/java/src/org/chromium/chrome/browser/tab/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.tab;
 
 import android.app.Activity;
 import android.app.Application;
 import android.content.Context;
 import android.content.Intent;
@@ skipping 21 matching lines @@
 import org.chromium.base.ApplicationStatus;
 import org.chromium.base.ContextUtils;
 import org.chromium.base.ObserverList;
 import org.chromium.base.ObserverList.RewindableIterator;
 import org.chromium.base.ThreadUtils;
 import org.chromium.base.TraceEvent;
 import org.chromium.base.VisibleForTesting;
 import org.chromium.base.annotations.CalledByNative;
 import org.chromium.base.metrics.RecordHistogram;
 import org.chromium.base.metrics.RecordUserAction;
+import org.chromium.blimp_public.contents.BlimpContents;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.ChromeActivity;
 import org.chromium.chrome.browser.ChromeApplication;
 import org.chromium.chrome.browser.ChromeFeatureList;
 import org.chromium.chrome.browser.ChromeVersionInfo;
 import org.chromium.chrome.browser.FrozenNativePage;
 import org.chromium.chrome.browser.IntentHandler;
 import org.chromium.chrome.browser.IntentHandler.TabOpenType;
 import org.chromium.chrome.browser.NativePage;
 import org.chromium.chrome.browser.SwipeRefreshHandler;
 import org.chromium.chrome.browser.TabState;
 import org.chromium.chrome.browser.TabState.WebContentsState;
 import org.chromium.chrome.browser.UrlConstants;
 import org.chromium.chrome.browser.WebContentsFactory;
 import org.chromium.chrome.browser.banners.AppBannerManager;
+import org.chromium.chrome.browser.blimp.BlimpClientContextFactory;
 import org.chromium.chrome.browser.bookmarks.BookmarkUtils;
 import org.chromium.chrome.browser.compositor.layouts.content.TabContentManager;
 import org.chromium.chrome.browser.contextmenu.ContextMenuPopulator;
 import org.chromium.chrome.browser.contextualsearch.ContextualSearchTabHelper;
 import org.chromium.chrome.browser.crash.MinidumpDirectoryObserver;
 import org.chromium.chrome.browser.crash.MinidumpUploadService;
 import org.chromium.chrome.browser.customtabs.CustomTabActivity;
 import org.chromium.chrome.browser.download.ChromeDownloadDelegate;
 import org.chromium.chrome.browser.fullscreen.FullscreenManager;
 import org.chromium.chrome.browser.help.HelpAndFeedback;
@@ skipping 93 matching lines @@
     private static final String TAG = "Tab";
 
     private long mNativeTabAndroid;
 
     /** Unique id of this tab (within its container). */
     private final int mId;
 
     /** Whether or not this tab is an incognito tab. */
     private final boolean mIncognito;
 
+    /** Whether or not this tab is running in blimp mode. */
+    private final boolean mBlimp;
+
     /**
      * An Application {@link Context}.  Unlike {@link #mActivity}, this is the only one that is
      * publicly exposed to help prevent leaking the {@link Activity}.
      */
     private final Context mThemedApplicationContext;
 
     /** Gives {@link Tab} a way to interact with the Android window. */
     private WindowAndroid mWindowAndroid;
 
     /** Whether or not this {@link Tab} is initialized and should be interacted with. */
@@ skipping 26 matching lines @@
     /**
      * A list of {@link ContentViewCore} overlay objects that are managed by external components but
      * need to be sized and rendered along side this {@link Tab}s content.
      */
     private final List<ContentViewCore> mOverlayContentViewCores = new ArrayList<ContentViewCore>();
 
     // Content layer Observers and Delegates
     private ContentViewClient mContentViewClient;
     private TabWebContentsObserver mWebContentsObserver;
     private TabWebContentsDelegateAndroid mWebContentsDelegate;
+    private BlimpContents mBlimpContents;
 
     /**
      * If this tab was opened from another tab, store the id of the tab that
      * caused it to be opened so that we can activate it when this tab gets
      * closed.
      */
     private int mParentId = INVALID_TAB_ID;
 
     /**
      * If this tab was opened from another tab in another Activity, this is the Intent that can be
@@ skipping 415 matching lines @@
             mDefaultThemeColor = mIncognito
                     ? ApiCompatibilityUtils.getColor(resources, R.color.incognito_primary_color)
                     : ApiCompatibilityUtils.getColor(resources, R.color.default_primary_color);
             mThemeColor = calculateThemeColor(false);
         } else {
             mIdealFaviconSize = 16;
             mDefaultThemeColor = 0;
             mThemeColor = mDefaultThemeColor;
         }
 
+        mBlimp = BlimpClientContextFactory

[David Trainor- moved to gerrit, 2016/08/18 17:06:30]

We should pass this into tab.  Some tabs will not be running in Blimp mode
(incognito mode for example).  Tab.java shouldn't be the one deciding this, the
creator should.

[shaktisahu, 2016/08/18 19:36:06]

Yes, the creator should pass this to tab. But that requires TabModel,
TabCreator, TabModelSelector classes to be aware of blimp, which I think might
change in future depending on how seamless transition is decided. The plan is
that BlimpClientContext.isEnabled() would return if user has enabled blimp from
the settings menu. Let me know what you think.

+                         .getBlimpClientContextForProfile(
+                                 Profile.getLastUsedProfile().getOriginalProfile())
+                         .isBlimpEnabled();

[David Trainor- moved to gerrit, 2016/08/18 18:28:19]

&& !mIsIncognito

[shaktisahu, 2016/08/18 19:36:06]

Done.

+
         // Restore data from the TabState, if it existed.
         if (frozenState != null) {
             assert type == TabLaunchType.FROM_RESTORE;
             restoreFieldsFromState(frozenState);
         }
 
         setContentViewClient(new TabContentViewClient());
 
         mHandler = new Handler() {
             @Override
@@ skipping 66 matching lines @@
      * @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.
      */
     public boolean canGoBack() {
-        return getWebContents() != null && getWebContents().getNavigationController().canGoBack();
+        if (isBlimpTab()) {
+            return getBlimpContents() != null
+                    && getBlimpContents().getNavigationController().canGoBack();
+        } else {
+            return getWebContents() != null
+                    && getWebContents().getNavigationController().canGoBack();
+        }
     }
 
     /**
      * @return Whether or not this tab has a navigation entry after the current one.
      */
     public boolean canGoForward() {
-        return getWebContents() != null && getWebContents().getNavigationController()
-                .canGoForward();
+        if (isBlimpTab()) {
+            return getBlimpContents() != null
+                    && getBlimpContents().getNavigationController().canGoForward();
+        } else {
+            return getWebContents() != null
+                    && getWebContents().getNavigationController().canGoForward();
+        }
     }
 
     /**
      * Goes to the navigation entry before the current one.
      */
     public void goBack() {
-        if (getWebContents() != null) getWebContents().getNavigationController().goBack();
+        if (isBlimpTab()) {
+            if (getBlimpContents() != null) getBlimpContents().getNavigationController().goBack();
+        } else {
+            if (getWebContents() != null) getWebContents().getNavigationController().goBack();
+        }
     }
 
     /**
      * Goes to the navigation entry after the current one.
      */
     public void goForward() {
-        if (getWebContents() != null) getWebContents().getNavigationController().goForward();
+        if (isBlimpTab()) {
+            if (getBlimpContents() != null) {
+                getBlimpContents().getNavigationController().goForward();
+            }
+        } else {
+            if (getWebContents() != null) getWebContents().getNavigationController().goForward();
+        }
     }
 
     /**
      * Loads the current navigation if there is a pending lazy load (after tab restore).
      */
     public void loadIfNecessary() {
         if (getWebContents() != null) getWebContents().getNavigationController().loadIfNecessary();
     }
 
     /**
@@ skipping 214 matching lines @@
 
         printingController.setPendingPrint(new TabPrinter(this),
                 new PrintManagerDelegateImpl(getActivity()));
     }
 
     /**
      * Reloads the current page content.
      */
     public void reload() {
         // TODO(dtrainor): Should we try to rebuild the ContentView if it's frozen?
-        if (getWebContents() != null) getWebContents().getNavigationController().reload(true);
+        if (isBlimpTab()) {
+            if (getBlimpContents() != null) {
+                getBlimpContents().getNavigationController().reload();
+            }
+        } else {
+            if (getWebContents() != null) getWebContents().getNavigationController().reload(true);
+        }
     }
 
     /**
      * Reloads the current page content.
      * This version ignores the cache and reloads from the network.
      */
     public void reloadIgnoringCache() {
         if (getWebContents() != null) {
             getWebContents().getNavigationController().reloadBypassingCache(true);
         }
@@ skipping 120 matching lines @@
     }
 
     /**
      * @return The web contents associated with this tab.
      */
     public WebContents getWebContents() {
         return mContentViewCore != null ? mContentViewCore.getWebContents() : null;
     }
 
     /**
+     * @return The {@link BlimpContents} associated with this tab, if in blimp mode.
+     */
+    public BlimpContents getBlimpContents() {
+        return mBlimpContents;
+    }
+
+    /**
+     * @return Whether or not this tab is running in blimp mode.
+     */
+    public boolean isBlimpTab() {
+        return mBlimp;
+    }
+
+    /**
      * @return The profile associated with this tab.
      */
     public Profile getProfile() {
         if (mNativeTabAndroid == 0) return null;
         return nativeGetProfileAndroid(mNativeTabAndroid);
     }
 
     /**
      * For more information about the uniqueness of {@link #getId()} see comments on {@link Tab}.
      * @see Tab
      * @return The id representing this tab.
      */
     @CalledByNative
     public int getId() {
         return mId;
     }
 
     /**
      * @return Whether or not this tab is incognito.
      */
+    @CalledByNative
     public boolean isIncognito() {
         return mIncognito;
     }
 
     /**
      * @return The {@link ContentViewCore} associated with the current page, or {@code null} if
      *         there is no current page or the current page is displayed using a native view.
      */
     public ContentViewCore getContentViewCore() {
         return mNativePage == null ? mContentViewCore : null;
@@ skipping 16 matching lines @@
     }
 
     /**
      * 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.
      */
     public void setUseDesktopUserAgent(boolean useDesktop, boolean reloadOnChange) {
         if (getWebContents() != null) {
-            getWebContents().getNavigationController()
-                    .setUseDesktopUserAgent(useDesktop, reloadOnChange);
+            getWebContents().getNavigationController().setUseDesktopUserAgent(
+                    useDesktop, reloadOnChange);
         }
     }
 
     /**
      * @return Whether or not the {@link ContentViewCore} is using a desktop user agent.
      */
     public boolean getUseDesktopUserAgent() {
-        return getWebContents() != null && getWebContents().getNavigationController()
-                .getUseDesktopUserAgent();
+        return getWebContents() != null
+                && getWebContents().getNavigationController().getUseDesktopUserAgent();
     }
 
     /**
      * @return The current {@link ConnectionSecurityLevel} for the tab.
      */
     // TODO(tedchoc): Remove this and transition all clients to use ToolbarModel directly.
     public int getSecurityLevel() {
         return SecurityStateModel.getSecurityLevelForWebContents(getWebContents());
     }
 
@@ skipping 231 matching lines @@
             // TODO(dtrainor): Remove this and move to a pull model instead of pushing the layer.
             attachTabContentManager(tabContentManager);
 
             // If there is a frozen WebContents state or a pending lazy load, don't create a new
             // WebContents.
             if (getFrozenContentsState() != null || getPendingLoadParams() != null) {
                 if (unfreeze) unfreezeContents();
                 return;
             }
 
+            if (isBlimpTab() && getBlimpContents() == null) {
+                nativeInitBlimpContents(mNativeTabAndroid);

[David Trainor- moved to gerrit, 2016/08/18 17:06:30]

Can we just return the BlimpContents from this?

[shaktisahu, 2016/08/18 19:36:06]

Done. Removing the nativeGetBlimpContents method.

+                mBlimpContents = nativeGetBlimpContents(mNativeTabAndroid);
+                getBlimpContents().addObserver(new TabBlimpContentsObserver(this));
+            }
+
             boolean creatingWebContents = webContents == null;
             if (creatingWebContents) {
                 webContents = WebContentsFactory.createWebContents(isIncognito(), initiallyHidden);
             }
 
             ContentViewCore contentViewCore = ContentViewCore.fromWebContents(webContents);
 
             if (contentViewCore == null) {
                 initContentViewCore(webContents);
             } else {
@@ skipping 546 matching lines @@
         if (mTabUma != null) mTabUma.onDestroy();
 
         for (TabObserver observer : mObservers) observer.onDestroyed(this);
         mObservers.clear();
 
         NativePage currentNativePage = mNativePage;
         mNativePage = null;
         destroyNativePageInternal(currentNativePage);
         destroyContentViewCore(true);
 
+        mBlimpContents = null;

[David Trainor- moved to gerrit, 2016/08/18 17:06:30]

Who destroys this?  When do we drop the native pointer?

[shaktisahu, 2016/08/18 19:36:06]

The native pointer is a unique_ptr owned by TabAndroid which is destroyed on the
next line. I am clearing the Java reference before that.

[David Trainor- moved to gerrit, 2016/08/22 21:30:00]

Can you add a comment to that effect?  Thanks!

+
         // Destroys the native tab after destroying the ContentView but before destroying the
         // InfoBarContainer. The native tab should be destroyed before the infobar container as
         // destroying the native tab cleanups up any remaining infobars. The infobar container
         // expects all infobars to be cleaned up before its own destruction.
         assert mNativeTabAndroid != 0;
         nativeDestroy(mNativeTabAndroid);
         assert mNativeTabAndroid == 0;
 
         if (mInfoBarContainer != null) {
             mInfoBarContainer.destroy();
@@ skipping 14 matching lines @@
         return mIsInitialized;
     }
 
     /**
      * @return The URL associated with the tab.
      */
     @CalledByNative
     public String getUrl() {
         String url = getWebContents() != null ? getWebContents().getUrl() : "";
 
+        if (isBlimpTab() && getBlimpContents() != null) {
+            url = getBlimpContents().getNavigationController().getUrl();
+        }
+
         // If we have a ContentView, or a NativePage, or the url is not empty, we have a WebContents
         // so cache the WebContent's url. If not use the cached version.
         if (getContentViewCore() != null || getNativePage() != null || !TextUtils.isEmpty(url)) {
             mUrl = url;
         }
 
         return mUrl != null ? mUrl : "";
     }
 
     /**
      * @return The tab title.
      */
     @CalledByNative
     public String getTitle() {
         if (mTitle == null) updateTitle();
         return mTitle;
     }
 
     void updateTitle() {
         if (isFrozen()) return;
 
         // When restoring the tabs, the title will no longer be populated, so request it from the
         // ContentViewCore or NativePage (if present).
         String title = "";
         if (mNativePage != null) {
             title = mNativePage.getTitle();
+        } else if (getBlimpContents() != null) {
+            title = getBlimpContents().getNavigationController().getTitle();
         } else if (getWebContents() != null) {
             title = getWebContents().getTitle();
         }
         updateTitle(title);
     }
 
     /**
      * Cache the title for the current page.
      *
      * {@link ContentViewClient#onUpdateTitle} is unreliable, particularly for navigating backwards
@@ skipping 1155 matching lines @@
         String packageName = ContextUtils.getApplicationContext().getPackageName();
         return getLaunchType() == TabLaunchType.FROM_EXTERNAL_APP
                 && !TextUtils.equals(getAppAssociatedWith(), packageName);
     }
 
     private native void nativeInit();
     private native void nativeDestroy(long nativeTabAndroid);
     private native void nativeInitWebContents(long nativeTabAndroid, boolean incognito,
             WebContents webContents, TabWebContentsDelegateAndroid delegate,
             ContextMenuPopulator contextMenuPopulator);
+    private native void nativeInitBlimpContents(long nativeTabAndroid);

[David Trainor- moved to gerrit, 2016/08/18 18:28:19]

Make this take a profile?

Profile profile = Profile.getLastUsedProfile();
if (isIncognito()) profile = profile.getOffTheRecordProfile();

mBlimpContents = nativeInitBlimpContents(..., profile);

+    private native BlimpContents nativeGetBlimpContents(long nativeTabAndroid);
     private native void nativeUpdateDelegates(long nativeTabAndroid,
             TabWebContentsDelegateAndroid delegate, ContextMenuPopulator contextMenuPopulator);
     private native void nativeDestroyWebContents(long nativeTabAndroid, boolean deleteNative);
     private native Profile nativeGetProfileAndroid(long nativeTabAndroid);
     private native int nativeLoadUrl(long nativeTabAndroid, String url, String extraHeaders,
             ResourceRequestBody postData, int transition, String referrerUrl, int referrerPolicy,
             boolean isRendererInitiated, boolean shoulReplaceCurrentEntry,
             long intentReceivedTimestamp, boolean hasUserGesture);
     private native void nativeSetActiveNavigationEntryTitleForUrl(long nativeTabAndroid, String url,
             String title);
@@ skipping 10 matching lines @@
     private native void nativeSetInterceptNavigationDelegate(long nativeTabAndroid,
             InterceptNavigationDelegate delegate);
     private native void nativeAttachToTabContentManager(long nativeTabAndroid,
             TabContentManager tabContentManager);
     private native void nativeAttachOverlayWebContents(
             long nativeTabAndroid, WebContents webContents, boolean visible);
     private native void nativeDetachOverlayWebContents(
             long nativeTabAndroid, WebContents webContents);
     private native boolean nativeHasPrerenderedUrl(long nativeTabAndroid, String url);
 }