// Copyright 2015 The Chromium Authors
// 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.annotation.SuppressLint;
import android.os.Handler;
import android.os.Message;
import androidx.annotation.Nullable;
import org.chromium.cc.input.BrowserControlsState;
import org.chromium.chrome.browser.device.DeviceClassManager;
import org.chromium.chrome.browser.util.ChromeAccessibilityUtil;
import org.chromium.components.browser_ui.util.BrowserControlsVisibilityDelegate;
import org.chromium.components.dom_distiller.core.DomDistillerUrlUtils;
import org.chromium.components.embedder_support.util.UrlConstants;
import org.chromium.components.security_state.SecurityStateModel;
import org.chromium.content_public.browser.ImeAdapter;
import org.chromium.content_public.browser.ImeEventObserver;
import org.chromium.content_public.browser.NavigationHandle;
import org.chromium.content_public.browser.WebContents;
import org.chromium.ui.base.WindowAndroid;
import org.chromium.url.GURL;
/**
* Determines the desired visibility of the browser controls based on the current state of a given
* tab.
*/
public class TabStateBrowserControlsVisibilityDelegate extends BrowserControlsVisibilityDelegate
implements ImeEventObserver {
protected static final int MSG_ID_ENABLE_FULLSCREEN_AFTER_LOAD = 1;
/** The maximum amount of time to wait for a page to load before entering fullscreen. */
private static final long MAX_FULLSCREEN_LOAD_DELAY_MS = 3000;
private static boolean sDisableLoadingCheck;
protected final TabImpl mTab;
private WebContents mWebContents;
private boolean mIsFullscreenWaitingForLoad;
private boolean mIsFocusedNodeEditable;
/**
* Basic constructor.
* @param tab The associated {@link Tab}.
*/
public TabStateBrowserControlsVisibilityDelegate(Tab tab) {
super(BrowserControlsState.BOTH);
mTab = (TabImpl) tab;
mTab.addObserver(
new EmptyTabObserver() {
@SuppressLint("HandlerLeak")
private Handler mHandler =
new Handler() {
@Override
public void handleMessage(Message msg) {
if (msg == null) return;
if (msg.what == MSG_ID_ENABLE_FULLSCREEN_AFTER_LOAD) {
if (!mIsFullscreenWaitingForLoad) return;
updateWaitingForLoad(false);
}
}
};
private long getLoadDelayMs() {
return sDisableLoadingCheck ? 0 : MAX_FULLSCREEN_LOAD_DELAY_MS;
}
private void cancelEnableFullscreenLoadDelay() {
mHandler.removeMessages(MSG_ID_ENABLE_FULLSCREEN_AFTER_LOAD);
updateWaitingForLoad(false);
}
private void scheduleEnableFullscreenLoadDelayIfNecessary() {
if (mIsFullscreenWaitingForLoad
&& !mHandler.hasMessages(MSG_ID_ENABLE_FULLSCREEN_AFTER_LOAD)) {
mHandler.sendEmptyMessageDelayed(
MSG_ID_ENABLE_FULLSCREEN_AFTER_LOAD, getLoadDelayMs());
}
}
@Override
public void onContentChanged(Tab tab) {
onWebContentsUpdated(tab.getWebContents());
}
@Override
public void onWebContentsSwapped(
Tab tab, boolean didStartLoad, boolean didFinishLoad) {
if (!didStartLoad) return;
// As we may have missed the main frame commit notification for the
// swapped web contents, schedule the enabling of fullscreen now.
scheduleEnableFullscreenLoadDelayIfNecessary();
}
@Override
public void onDidFinishNavigationInPrimaryMainFrame(
Tab tab, NavigationHandle navigation) {
if (!navigation.hasCommitted()) return;
mHandler.removeMessages(MSG_ID_ENABLE_FULLSCREEN_AFTER_LOAD);
mHandler.sendEmptyMessageDelayed(
MSG_ID_ENABLE_FULLSCREEN_AFTER_LOAD, getLoadDelayMs());
}
@Override
public void onPageLoadStarted(Tab tab, GURL url) {
mHandler.removeMessages(MSG_ID_ENABLE_FULLSCREEN_AFTER_LOAD);
updateWaitingForLoad(!DomDistillerUrlUtils.isDistilledPage(url));
}
@Override
public void onPageLoadFinished(Tab tab, GURL url) {
// Handle the case where a commit or prerender swap notification failed to
// arrive and the enable fullscreen message was never enqueued.
scheduleEnableFullscreenLoadDelayIfNecessary();
}
@Override
public void onPageLoadFailed(Tab tab, int errorCode) {
// TODO(crbug.com/40926082): Associate events with navigation ids or
// urls, so that we can fully unlock controls here possible here.
// May have already received the start of a different navigation. Do not
// cancel the outstanding delay. See https://crbug.com/1447237.
scheduleEnableFullscreenLoadDelayIfNecessary();
}
@Override
public void onHidden(Tab tab, @TabHidingType int type) {
cancelEnableFullscreenLoadDelay();
}
@Override
public void onSSLStateUpdated(Tab tab) {
updateVisibilityConstraints();
}
@Override
public void onRendererResponsiveStateChanged(Tab tab, boolean isResponsive) {
updateVisibilityConstraints();
}
@Override
public void onShown(Tab tab, int type) {
updateVisibilityConstraints();
}
@Override
public void onActivityAttachmentChanged(
Tab tab, @Nullable WindowAndroid window) {
if (window != null) updateVisibilityConstraints();
}
@Override
public void onCrash(Tab tab) {
mIsFocusedNodeEditable = false;
}
@Override
public void onDestroyed(Tab tab) {
super.onDestroyed(tab);
// Remove pending handler actions to prevent memory leaks.
mHandler.removeCallbacksAndMessages(null);
}
});
onWebContentsUpdated(mTab.getWebContents());
updateVisibilityConstraints();
}
private void onWebContentsUpdated(WebContents contents) {
if (mWebContents == contents) return;
mWebContents = contents;
if (mWebContents == null) return;
ImeAdapter.fromWebContents(mWebContents).addEventObserver(this);
}
private void updateWaitingForLoad(boolean waiting) {
if (mIsFullscreenWaitingForLoad == waiting) return;
mIsFullscreenWaitingForLoad = waiting;
updateVisibilityConstraints();
}
private boolean enableHidingBrowserControls() {
WebContents webContents = mTab.getWebContents();
if (webContents == null || webContents.isDestroyed()) return false;
GURL url = mTab.getUrl();
boolean enableHidingBrowserControls = url != null;
enableHidingBrowserControls &= !url.getScheme().equals(UrlConstants.CHROME_SCHEME);
enableHidingBrowserControls &= !url.getScheme().equals(UrlConstants.CHROME_NATIVE_SCHEME);
enableHidingBrowserControls &=
!SecurityStateModel.isContentDangerous(mTab.getWebContents());
enableHidingBrowserControls &= !mIsFocusedNodeEditable;
enableHidingBrowserControls &= !mTab.isShowingErrorPage();
enableHidingBrowserControls &= !mTab.isRendererUnresponsive();
enableHidingBrowserControls &= !mTab.isHidden();
enableHidingBrowserControls &= !mIsFullscreenWaitingForLoad;
// TODO(tedchoc): AccessibilityUtil and DeviceClassManager checks do not belong in Tab
// logic. They should be moved to application level checks.
enableHidingBrowserControls &= !ChromeAccessibilityUtil.get().isAccessibilityEnabled();
enableHidingBrowserControls &= DeviceClassManager.enableFullscreen();
return enableHidingBrowserControls;
}
/**
* @return The constraints that determine the visibility of the browser controls.
*/
protected @BrowserControlsState int calculateVisibilityConstraints() {
return enableHidingBrowserControls()
? BrowserControlsState.BOTH
: BrowserControlsState.SHOWN;
}
/** Updates the browser controls visibility constraints based on the current configuration. */
protected void updateVisibilityConstraints() {
set(calculateVisibilityConstraints());
}
/** Disables the logic that prevents hiding the top controls during page load for testing. */
public static void disablePageLoadDelayForTests() {
sDisableLoadingCheck = true;
}
// ImeEventObserver
@Override
public void onNodeAttributeUpdated(boolean editable, boolean password) {
mIsFocusedNodeEditable = editable;
updateVisibilityConstraints();
}
}
Codebase Browser
chromium