| // Copyright (c) 2012 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. |
| |
| #ifndef CHROME_BROWSER_UI_STARTUP_STARTUP_BROWSER_CREATOR_IMPL_H_ |
| #define CHROME_BROWSER_UI_STARTUP_STARTUP_BROWSER_CREATOR_IMPL_H_ |
| |
| #include <string> |
| #include <vector> |
| |
| #include "base/files/file_path.h" |
| #include "base/gtest_prod_util.h" |
| #include "base/macros.h" |
| #include "chrome/browser/sessions/session_restore.h" |
| #include "chrome/browser/ui/startup/startup_tab.h" |
| #include "chrome/browser/ui/startup/startup_types.h" |
| #include "url/gurl.h" |
| |
| class Browser; |
| class Profile; |
| class StartupBrowserCreator; |
| class StartupTabProvider; |
| struct SessionStartupPref; |
| |
| namespace base { |
| class CommandLine; |
| class FilePath; |
| } |
| |
| namespace internals { |
| GURL GetTriggeredResetSettingsURL(); |
| GURL GetWelcomePageURL(); |
| } // namespace internals |
| |
| // Assists launching the application and appending the initial tabs for a |
| // browser window. |
| class StartupBrowserCreatorImpl { |
| public: |
| // There are two ctors. The first one implies a NULL browser_creator object |
| // and thus no access to distribution-specific first-run behaviors. The |
| // second one is always called when the browser starts even if it is not |
| // the first run. |is_first_run| indicates that this is a new profile. |
| StartupBrowserCreatorImpl(const base::FilePath& cur_dir, |
| const base::CommandLine& command_line, |
| chrome::startup::IsFirstRun is_first_run); |
| StartupBrowserCreatorImpl(const base::FilePath& cur_dir, |
| const base::CommandLine& command_line, |
| StartupBrowserCreator* browser_creator, |
| chrome::startup::IsFirstRun is_first_run); |
| ~StartupBrowserCreatorImpl(); |
| |
| // Creates the necessary windows for startup. Returns true on success, |
| // false on failure. process_startup is true if Chrome is just |
| // starting up. If process_startup is false, it indicates Chrome was |
| // already running and the user wants to launch another instance. |
| bool Launch(Profile* profile, |
| const std::vector<GURL>& urls_to_open, |
| bool process_startup); |
| |
| // Convenience for OpenTabsInBrowser that converts |urls| into a set of |
| // Tabs. |
| Browser* OpenURLsInBrowser(Browser* browser, |
| bool process_startup, |
| const std::vector<GURL>& urls); |
| |
| private: |
| FRIEND_TEST_ALL_PREFIXES(BrowserTest, RestorePinnedTabs); |
| FRIEND_TEST_ALL_PREFIXES(BrowserTest, AppIdSwitch); |
| FRIEND_TEST_ALL_PREFIXES(StartupBrowserCreatorImplTest, DetermineStartupTabs); |
| FRIEND_TEST_ALL_PREFIXES(StartupBrowserCreatorImplTest, |
| DetermineStartupTabs_Incognito); |
| FRIEND_TEST_ALL_PREFIXES(StartupBrowserCreatorImplTest, |
| DetermineStartupTabs_Crash); |
| FRIEND_TEST_ALL_PREFIXES(StartupBrowserCreatorImplTest, |
| DetermineStartupTabs_MasterPrefs); |
| FRIEND_TEST_ALL_PREFIXES(StartupBrowserCreatorImplTest, |
| DetermineStartupTabs_CommandLine); |
| FRIEND_TEST_ALL_PREFIXES(StartupBrowserCreatorImplTest, |
| DetermineStartupTabs_NewTabPage); |
| FRIEND_TEST_ALL_PREFIXES(StartupBrowserCreatorImplTest, |
| DetermineStartupTabs_WelcomeBackPage); |
| FRIEND_TEST_ALL_PREFIXES(StartupBrowserCreatorImplTest, |
| DetermineBrowserOpenBehavior_Startup); |
| FRIEND_TEST_ALL_PREFIXES(StartupBrowserCreatorImplTest, |
| DetermineBrowserOpenBehavior_CmdLineTabs); |
| FRIEND_TEST_ALL_PREFIXES(StartupBrowserCreatorImplTest, |
| DetermineBrowserOpenBehavior_PostCrash); |
| FRIEND_TEST_ALL_PREFIXES(StartupBrowserCreatorImplTest, |
| DetermineBrowserOpenBehavior_NotStartup); |
| |
| enum class WelcomeRunType { |
| NONE, // Do not inject the welcome page for this run. |
| FIRST_TAB, // Inject the welcome page as the first tab. |
| FIRST_RUN_LAST_TAB, // Inject the welcome page as the last first-run tab. |
| }; |
| |
| // Window behaviors possible when opening Chrome. |
| enum class BrowserOpenBehavior { |
| NEW, // Open in a new browser. |
| SYNCHRONOUS_RESTORE, // Attempt a synchronous session restore. |
| USE_EXISTING, // Attempt to add to an existing tabbed browser. |
| }; |
| |
| // Boolean flags used to indicate state for DetermineBrowserOpenBehavior. |
| enum BehaviorFlags { |
| PROCESS_STARTUP = (1 << 0), |
| IS_POST_CRASH_LAUNCH = (1 << 1), |
| HAS_NEW_WINDOW_SWITCH = (1 << 2), |
| HAS_CMD_LINE_TABS = (1 << 3), |
| }; |
| |
| using BrowserOpenBehaviorOptions = uint32_t; |
| |
| // Creates a tab for each of the Tabs in |tabs|. If browser is non-null |
| // and a tabbed browser, the tabs are added to it. Otherwise a new tabbed |
| // browser is created and the tabs are added to it. The browser the tabs |
| // are added to is returned, which is either |browser| or the newly created |
| // browser. |
| Browser* OpenTabsInBrowser(Browser* browser, |
| bool process_startup, |
| const StartupTabs& tabs); |
| |
| // If the process was launched with the web application command line flags, |
| // e.g. --app=http://www.google.com/ or --app_id=... return true. |
| // In this case |app_url| or |app_id| are populated if they're non-null. |
| bool IsAppLaunch(std::string* app_url, std::string* app_id); |
| |
| // If IsAppLaunch is true, tries to open an application window. |
| // If the app is specified to start in a tab, or IsAppLaunch is false, |
| // returns false to specify default processing. |
| bool OpenApplicationWindow(Profile* profile); |
| |
| // If IsAppLaunch is true and the user set a pref indicating that the app |
| // should open in a tab, do so. |
| bool OpenApplicationTab(Profile* profile); |
| |
| // Determines the URLs to be shown at startup by way of various policies |
| // (onboarding, pinned tabs, etc.), determines whether a session restore |
| // is necessary, and opens the URLs in a new or restored browser accordingly. |
| void DetermineURLsAndLaunch(bool process_startup, |
| const std::vector<GURL>& cmd_line_urls); |
| |
| // Returns the tabs to be shown on startup, based on the policy functions in |
| // the given StartupTabProvider, the given tabs passed by the command line, |
| // and the interactions between those policies. |
| StartupTabs DetermineStartupTabs(const StartupTabProvider& provider, |
| const StartupTabs& cmd_line_tabs, |
| bool process_startup, |
| bool is_ephemeral_profile, |
| bool is_post_crash_launch, |
| bool has_incompatible_applications, |
| bool promotional_tabs_enabled, |
| bool onboarding_enabled); |
| |
| // Begins an asynchronous session restore if current state allows it (e.g., |
| // this is not process startup) and SessionService indicates that one is |
| // necessary. Returns true if restore was initiated, or false if launch |
| // should continue (either synchronously, or asynchronously without |
| // restoring). |
| bool MaybeAsyncRestore(const StartupTabs& tabs, |
| bool process_startup, |
| bool is_post_crash_launch); |
| |
| // Returns a browser displaying the contents of |tabs|. Based on |behavior|, |
| // this may attempt a session restore or create a new browser. May also allow |
| // DOM Storage to begin cleanup once it's clear it is not needed anymore. |
| Browser* RestoreOrCreateBrowser( |
| const StartupTabs& tabs, BrowserOpenBehavior behavior, |
| SessionRestore::BehaviorBitmask restore_options, bool process_startup, |
| bool is_post_crash_launch); |
| |
| |
| // Adds any startup infobars to the selected tab of the given browser. |
| void AddInfoBarsIfNecessary( |
| Browser* browser, |
| chrome::startup::IsProcessStartup is_process_startup); |
| |
| // Records Rappor metrics on startup URLs. |
| void RecordRapporOnStartupURLs(const std::vector<GURL>& urls_to_open); |
| |
| // Determines how the launch flow should obtain a Browser. |
| static BrowserOpenBehavior DetermineBrowserOpenBehavior( |
| const SessionStartupPref& pref, |
| BrowserOpenBehaviorOptions options); |
| |
| // Returns the relevant bitmask options which must be passed when restoring a |
| // session. |
| static SessionRestore::BehaviorBitmask DetermineSynchronousRestoreOptions( |
| bool has_create_browser_default, |
| bool has_create_browser_switch, |
| bool was_mac_login_or_resume); |
| |
| const base::FilePath cur_dir_; |
| const base::CommandLine& command_line_; |
| Profile* profile_; |
| StartupBrowserCreator* browser_creator_; |
| bool is_first_run_; |
| DISALLOW_COPY_AND_ASSIGN(StartupBrowserCreatorImpl); |
| }; |
| |
| #endif // CHROME_BROWSER_UI_STARTUP_STARTUP_BROWSER_CREATOR_IMPL_H_ |