chrome/browser/ui/android/tab_model/tab_model.h

// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_UI_ANDROID_TAB_MODEL_TAB_MODEL_H_
#define CHROME_BROWSER_UI_ANDROID_TAB_MODEL_TAB_MODEL_H_

#include <memory>

#include "base/android/scoped_java_ref.h"
#include "base/memory/raw_ptr.h"
#include "chrome/browser/flags/android/chrome_session_state.h"
#include "chrome/browser/ui/android/tab_model/android_live_tab_context.h"
#include "chrome/browser/ui/tabs/tab_list_interface.h"
#include "components/omnibox/browser/location_bar_model.h"
#include "components/omnibox/browser/location_bar_model_delegate.h"
#include "components/sessions/core/session_id.h"
#include "components/sync_sessions/synced_window_delegate.h"
#include "ui/base/unowned_user_data/scoped_unowned_user_data.h"

struct NavigateParams;

namespace browser_sync {
class SyncedWindowDelegateAndroid;
}

namespace content {
class WebContents;
}

namespace sync_sessions {
class SyncedWindowDelegate;
}

class Profile;
class TabAndroid;
class TabModelObserver;

// Abstract representation of a Tab Model for Android.  Since Android does
// not use Browser/BrowserList, this is required to allow Chrome to interact
// with Android's Tabs and Tab Model.
class TabModel : public TabListInterface {
 public:
  DECLARE_USER_DATA(TabModel);
  // LINT.IfChange(TabLaunchType)
  // Various ways tabs can be launched.
  // Values must be numbered from 0 and can't have gaps.
  // This enum is used to back a histogram, entries should not be renumbered or
  // reused.
  // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.tab
  enum class TabLaunchType {
    // Opened from a link. Sets up a relationship between the newly created tab
    // and its parent.
    FROM_LINK,
    // Opened by an external app.
    FROM_EXTERNAL_APP,
    // Catch-all for Tabs opened by Chrome UI not covered by more specific
    // TabLaunchTypes.
    // Examples include:
    // - Tabs created by the options menu.
    // - Tabs created via the New Tab button in the tab stack overview.
    // - Tabs created via Push Notifications.
    // - Tabs opened via a keyboard shortcut.
    FROM_CHROME_UI,
    // Opened during the restoration process on startup or when merging two
    //  instances of
    // Chrome in Android N+ multi-instance mode.
    FROM_RESTORE,
    // Opened from the long press context menu. Will be brought to the
    // foreground.
    // Like FROM_CHROME_UI, but also sets up a parent/child relationship like
    // FROM_LINK.
    FROM_LONGPRESS_FOREGROUND,
    // Opened from the long press context menu. Will not be brought to the
    // foreground.
    // Like FROM_CHROME_UI, but also sets up a parent/child relationship like
    // FROM_LINK.
    FROM_LONGPRESS_BACKGROUND,
    // Changed windows by moving from one activity to another. Will be opened
    // in the foreground.
    FROM_REPARENTING,
    // Opened from a launcher shortcut.
    FROM_LAUNCHER_SHORTCUT,
    // The tab is created by CCT in the background and detached from
    // ChromeActivity.
    FROM_SPECULATIVE_BACKGROUND_CREATION,
    // Opened in the background from Browser Actions context menu.
    FROM_BROWSER_ACTIONS,
    // Opened by an external application launching a new Chrome incognito tab.
    FROM_LAUNCH_NEW_INCOGNITO_TAB,
    // Opened a non-restored tab during the startup process
    FROM_STARTUP,
    // Opened from the start surface.
    // This is deprecated.
    FROM_START_SURFACE,
    // Opened from Tab group UI.
    // Tab group UI include:
    // - "+" button in the bottom tab strip
    // - "+" button in the tab grid dialog
    // - "New tab in group" option in the tab strip group context menu
    // - "Reopen" action in shared tab group messages.
    FROM_TAB_GROUP_UI,
    // Open from the long press context menu item 'Open in new tab in group'.
    // Will not be brought to the foreground.
    FROM_LONGPRESS_BACKGROUND_IN_GROUP,
    // Opened from an app widget.
    FROM_APP_WIDGET,
    // Open from the long press context menu item 'Open in Incognito Tab'.
    // This is deprecated; use `FROM_LONGPRESS_FOREGROUND` in new code.
    FROM_LONGPRESS_INCOGNITO,
    // Opened in background from Recent Tabs. This is a non-link launch with no
    // parent/child relationship. The tab is added to the end of the TabModel.
    // This does not include opening in the current tab.
    FROM_RECENT_TABS,
    // Opened from a Reading list. When going "back" on Android, the Reading
    // list should be reopened.
    FROM_READING_LIST,
    // Opened from Tab Switcher UI.
    FROM_TAB_SWITCHER_UI,
    // Opened from the Restore Tabs UI. When restoring synced tabs the first
    // tab is opened but not brought to the foreground.
    FROM_RESTORE_TABS_UI,
    // Opened to load an omnibox search query in a new tab.
    FROM_OMNIBOX,
    // Used for tab pre-warming where the reason for tab creation is not yet
    // known.
    UNSET,
    // Used when creating a tab to keep synced tab groups up to date.
    FROM_SYNC_BACKGROUND,
    // Open most recent tab in foregroud, used by ctrl-shift-t to restore
    // most recently closed tab or tabs.
    FROM_RECENT_TABS_FOREGROUND,
    // Open a new tab to prevent collaborations from having 0 tabs.
    FROM_COLLABORATION_BACKGROUND_IN_GROUP,
    // Opened from the bookmark bar. Will not be brought to the foreground.
    FROM_BOOKMARK_BAR_BACKGROUND,
    // Changed windows by moving from one activity to another. Will be opened
    // in the background. Use FROM_REPARENTING above to open the re-parented tab
    // in the foreground.
    FROM_REPARENTING_BACKGROUND,
    // From history navigation (back / forward) when opening a new tab/window in
    // the background.
    FROM_HISTORY_NAVIGATION_BACKGROUND,
    // From history navigation (back / forward) when opening a new tab/window in
    // the foreground.
    FROM_HISTORY_NAVIGATION_FOREGROUND,
    // Like FROM_LONGPRESS_FOREGROUND, but used when the parent tab is part of a
    // group.
    FROM_LONGPRESS_FOREGROUND_IN_GROUP,
    // Open tab using the TabListInterface API. This tab is created
    // programmatically from operations such as OpenTab or DuplicateTab.
    FROM_TAB_LIST_INTERFACE,
    // Open a link, creating a new window.
    FROM_LINK_CREATING_NEW_WINDOW,
    // Must be last.
    SIZE
  };
  // When adding a new TabLaunchType, make sure to update the following files.
  // Some of the files have multiple switch cases for TabLaunchType, so make
  // sure to update all of them! Note that there are likely other files that
  // need to be updated depending on the desired side-effects of the new
  // TabLaunchType.
  //
  // Long term, this would ideally be refactored to a traits system such that
  // the different types of side-effects are canonically defined, and listed
  // explicitly for each TabLaunchType in a single location.
  //
  // Multiple lines are not supported by IFTTT.
  // clang-format off
  // LINT.ThenChange(//tools/metrics/histograms/metadata/new_tab_page/enums.xml:TabLaunchType,//chrome/android/java/src/org/chromium/chrome/browser/tabmodel/ChromeTabCreator.java,//chrome/browser/tabpersistence/android/java/src/org/chromium/chrome/browser/tabpersistence/flatbuffer/tab_state_common.fbs,//chrome/browser/tabpersistence/android/java/src/org/chromium/chrome/browser/tabpersistence/FlatBufferTabStateSerializer.java)
  // clang-format on

  // Various ways tabs can be closed.
  // Values must be numbered from 0 and can't have gaps.
  // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.tab
  enum class TabClosingSource {
    // Tab closing from all other sources.
    UNKNOWN,
    // Tab closing from tablet tab strip.
    TABLET_TAB_STRIP,
    // Must be last.
    SIZE
  };

  // Various ways tabs can be selected.
  // Values must be numbered from 0 and can't have gaps.
  // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.tab
  enum class TabSelectionType {
    // Selection of adjacent tab when the active tab is closed in foreground.
    FROM_CLOSE,
    // Selection of adjacent tab when the active tab is closed upon app exit.
    FROM_EXIT,
    // Selection of newly created tab (e.g. for a URL intent or NTP).
    FROM_NEW,
    // User-originated switch to existing tab or selection of main tab on app
    // startup.
    FROM_USER,
    // User-originated switch to existing tab from Omnibox tab switch
    // suggestions.
    FROM_OMNIBOX,
    // Selection of a previously closed tab when closure is undone.
    FROM_UNDO,
    // Must be last.
    SIZE
  };

  // Various types of user agent.
  // Values must be numbered from 0 and can't have gaps.
  // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.tab
  enum class TabUserAgent {
    // Choose user agent based on default setting.
    DEFAULT,
    // Use mobile user agent.
    MOBILE,
    // Use desktop user agent.
    DESKTOP,
    // User agent not set, due to an earlier version not having the user agent
    // bit.
    UNSET,
    // Must be last.
    SIZE
  };

  TabModel(const TabModel&) = delete;
  TabModel& operator=(const TabModel&) = delete;

  virtual Profile* GetProfile() const;
  virtual bool IsOffTheRecord() const;
  virtual sync_sessions::SyncedWindowDelegate* GetSyncedWindowDelegate() const;
  virtual SessionID GetSessionId() const;
  virtual sessions::LiveTabContext* GetLiveTabContext() const;

  virtual content::WebContents* GetActiveWebContents() const;
  virtual content::WebContents* GetWebContentsAt(int index) const = 0;
  // This will return NULL if the tab has not yet been initialized.
  virtual TabAndroid* GetTabAt(int index) const = 0;
  virtual base::android::ScopedJavaLocalRef<jobject> GetJavaObject() const = 0;

  virtual void SetActiveIndex(int index) = 0;
  virtual void ForceCloseAllTabs() = 0;
  virtual void CloseTabAt(int index) = 0;

  // Used for restoring tabs from synced foreign sessions.
  virtual void CreateTab(TabAndroid* parent,
                         content::WebContents* web_contents,
                         bool select) = 0;

  virtual void HandlePopupNavigation(TabAndroid* parent,
                                     NavigateParams* params) = 0;

  // Used by Developer Tools to create a new tab with a given URL.
  // Replaces CreateTabForTesting.
  virtual content::WebContents* CreateNewTabForDevTools(const GURL& url,
                                                        bool new_window) = 0;

  // Return true if we are currently restoring sessions asynchronously.
  virtual bool IsSessionRestoreInProgress() const = 0;

  // Return true if this class is the currently selected in the correspond
  // tab model selector.
  virtual bool IsActiveModel() const = 0;

  // Adds an observer to this TabModel.
  virtual void AddObserver(TabModelObserver* observer) = 0;

  // Removes an observer from this TabModel.
  virtual void RemoveObserver(TabModelObserver* observer) = 0;

  // Return the count of non-custom tabs that were created or had a navigation
  // committed within the time range [`begin_time`, `end_time`).
  virtual int GetTabCountNavigatedInTimeWindow(
      const base::Time& begin_time,
      const base::Time& end_time) const = 0;

  // Closes non-custom tabs that were created or had a navigation
  // committed within the time range [`begin_time`, `end_time`).
  virtual void CloseTabsNavigatedInTimeWindow(const base::Time& begin_time,
                                              const base::Time& end_time) = 0;

  chrome::android::ActivityType activity_type() const { return activity_type_; }

 protected:
  TabModel(Profile* profile, chrome::android::ActivityType activity_type);
  ~TabModel() override;

  // Instructs the TabModel to broadcast a notification that all tabs are now
  // loaded from storage.
  void BroadcastSessionRestoreComplete();

  LocationBarModel* GetLocationBarModel();

 private:
  raw_ptr<Profile, DanglingUntriaged> profile_;

  chrome::android::ActivityType activity_type_;

  // The LiveTabContext associated with TabModel.
  // Used to restore closed tabs through the TabRestoreService.
  std::unique_ptr<AndroidLiveTabContext> live_tab_context_;

  // The SyncedWindowDelegate associated with this TabModel.
  std::unique_ptr<browser_sync::SyncedWindowDelegateAndroid>
      synced_window_delegate_;

  // Unique identifier of this TabModel for session restore. This id is only
  // unique within the current session, and is not guaranteed to be unique
  // across sessions.
  SessionID session_id_;

  // Records metrics about which percentage of syncable tabs are actually
  // synced.
  void RecordActualSyncedTabsHistogram();
};

#endif  // CHROME_BROWSER_UI_ANDROID_TAB_MODEL_TAB_MODEL_H_