chrome/browser/ui/startup/startup_browser_creator_impl.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_UI_STARTUP_STARTUP_BROWSER_CREATOR_IMPL_H_
   6 #define CHROME_BROWSER_UI_STARTUP_STARTUP_BROWSER_CREATOR_IMPL_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/files/file_path.h"
  12 #include "base/gtest_prod_util.h"
  13 #include "chrome/browser/ui/host_desktop.h"
  14 #include "chrome/browser/ui/startup/startup_tab.h"
  15 #include "chrome/browser/ui/startup/startup_types.h"
  16 #include "url/gurl.h"
  17
  18 class Browser;
  19 class Profile;
  20 class StartupBrowserCreator;
  21
  22 namespace base {
  23 class CommandLine;
  24 class FilePath;
  25 }
  26
  27 namespace content {
  28 class WebContents;
  29 }
  30
  31 namespace internals {
  32 GURL GetWelcomePageURL();
  33 }  // namespace internals
  34
  35 // Assists launching the application and appending the initial tabs for a
  36 // browser window.
  37 class StartupBrowserCreatorImpl {
  38  public:
  39   // There are two ctors. The first one implies a NULL browser_creator object
  40   // and thus no access to distribution-specific first-run behaviors. The
  41   // second one is always called when the browser starts even if it is not
  42   // the first run.  |is_first_run| indicates that this is a new profile.
  43   StartupBrowserCreatorImpl(const base::FilePath& cur_dir,
  44                             const base::CommandLine& command_line,
  45                             chrome::startup::IsFirstRun is_first_run);
  46   StartupBrowserCreatorImpl(const base::FilePath& cur_dir,
  47                             const base::CommandLine& command_line,
  48                             StartupBrowserCreator* browser_creator,
  49                             chrome::startup::IsFirstRun is_first_run);
  50   ~StartupBrowserCreatorImpl();
  51
  52   // Creates the necessary windows for startup. Returns true on success,
  53   // false on failure. process_startup is true if Chrome is just
  54   // starting up. If process_startup is false, it indicates Chrome was
  55   // already running and the user wants to launch another instance.
  56   bool Launch(Profile* profile,
  57               const std::vector<GURL>& urls_to_open,
  58               bool process_startup,
  59               chrome::HostDesktopType desktop_type);
  60
  61   // Convenience for OpenTabsInBrowser that converts |urls| into a set of
  62   // Tabs.
  63   Browser* OpenURLsInBrowser(Browser* browser,
  64                              bool process_startup,
  65                              const std::vector<GURL>& urls,
  66                              chrome::HostDesktopType desktop_type);
  67
  68  private:
  69   FRIEND_TEST_ALL_PREFIXES(BrowserTest, RestorePinnedTabs);
  70   FRIEND_TEST_ALL_PREFIXES(BrowserTest, AppIdSwitch);
  71
  72   enum class WelcomeRunType {
  73     NONE,                // Do not inject the welcome page for this run.
  74     FIRST_TAB,           // Inject the welcome page as the first tab.
  75     FIRST_RUN_LAST_TAB,  // Inject the welcome page as the last first-run tab.
  76   };
  77
  78   // Creates a tab for each of the Tabs in |tabs|. If browser is non-null
  79   // and a tabbed browser, the tabs are added to it. Otherwise a new tabbed
  80   // browser is created and the tabs are added to it. The browser the tabs
  81   // are added to is returned, which is either |browser| or the newly created
  82   // browser.
  83   Browser* OpenTabsInBrowser(Browser* browser,
  84                              bool process_startup,
  85                              const StartupTabs& tabs,
  86                              chrome::HostDesktopType desktop_type);
  87
  88   // If the process was launched with the web application command line flags,
  89   // e.g. --app=http://www.google.com/ or --app_id=... return true.
  90   // In this case |app_url| or |app_id| are populated if they're non-null.
  91   bool IsAppLaunch(std::string* app_url, std::string* app_id);
  92
  93   // If IsAppLaunch is true, tries to open an application window.
  94   // If the app is specified to start in a tab, or IsAppLaunch is false,
  95   // returns false to specify default processing.
  96   bool OpenApplicationWindow(Profile* profile);
  97
  98   // If IsAppLaunch is true and the user set a pref indicating that the app
  99   // should open in a tab, do so.
 100   bool OpenApplicationTab(Profile* profile);
 101
 102   // Invoked from Launch to handle processing of urls. This may do any of the
 103   // following:
 104   // . Invoke ProcessStartupURLs if |process_startup| is true.
 105   // . If |process_startup| is false, restore the last session if necessary,
 106   //   or invoke ProcessSpecifiedURLs.
 107   // . Open the urls directly.
 108   void ProcessLaunchURLs(bool process_startup,
 109                          const std::vector<GURL>& urls_to_open,
 110                          chrome::HostDesktopType desktop_type);
 111
 112   // Does the following:
 113   // . If the user's startup pref is to restore the last session (or the
 114   //   command line flag is present to force using last session), it is
 115   //   restored.
 116   // . Otherwise invoke ProcessSpecifiedURLs
 117   // If a browser was created, true is returned.  Otherwise returns false and
 118   // the caller must create a new browser.
 119   bool ProcessStartupURLs(const std::vector<GURL>& urls_to_open,
 120                           chrome::HostDesktopType desktop_type);
 121
 122   // Invoked from either ProcessLaunchURLs or ProcessStartupURLs to handle
 123   // processing of URLs where the behavior is common between process startup
 124   // and launch via an existing process (i.e. those explicitly specified by
 125   // the user somehow).  Does the following:
 126   // . Attempts to restore any pinned tabs from last run of chrome.
 127   // . If urls_to_open is non-empty, they are opened.
 128   // . If the user's startup pref is to launch a specific set of URLs they
 129   //   are opened.
 130   //
 131   // If any tabs were opened, the Browser which was created is returned.
 132   // Otherwise null is returned and the caller must create a new browser.
 133   Browser* ProcessSpecifiedURLs(const std::vector<GURL>& urls_to_open,
 134                                 chrome::HostDesktopType desktop_type);
 135
 136   // Adds a Tab to |tabs| for each url in |urls| that doesn't already exist
 137   // in |tabs|.
 138   void AddUniqueURLs(const std::vector<GURL>& urls, StartupTabs* tabs);
 139
 140   // Adds any startup infobars to the selected tab of the given browser.
 141   void AddInfoBarsIfNecessary(
 142       Browser* browser,
 143       chrome::startup::IsProcessStartup is_process_startup);
 144
 145   // Adds additional startup URLs to the specified vector.
 146   void AddStartupURLs(std::vector<GURL>* startup_urls) const;
 147
 148   // Initializes |welcome_run_type_| for this launch. Also persists state to
 149   // suppress injecting the welcome page for future launches.
 150   void InitializeWelcomeRunType(const std::vector<GURL>& urls_to_open);
 151
 152   // Record Rappor metrics on startup URLs.
 153   void RecordRapporOnStartupURLs(const std::vector<GURL>& urls_to_open);
 154
 155   const base::FilePath cur_dir_;
 156   const base::CommandLine& command_line_;
 157   Profile* profile_;
 158   StartupBrowserCreator* browser_creator_;
 159   bool is_first_run_;
 160   WelcomeRunType welcome_run_type_;
 161   DISALLOW_COPY_AND_ASSIGN(StartupBrowserCreatorImpl);
 162 };
 163
 164 #endif  // CHROME_BROWSER_UI_STARTUP_STARTUP_BROWSER_CREATOR_IMPL_H_