Out-of-process import on Windows.

chrome/browser/first_run/first_run.cc

 // 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.
 
 #include "chrome/browser/first_run/first_run.h"
 
 #include <algorithm>
 
 #include "base/command_line.h"
 #include "base/compiler_specific.h"
@@ skipping 10 matching lines @@
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/extensions/updater/extension_updater.h"
 #include "chrome/browser/first_run/first_run_dialog.h"
 #include "chrome/browser/first_run/first_run_internal.h"
 #include "chrome/browser/google/google_util.h"
 #include "chrome/browser/importer/external_process_importer_host.h"
 #include "chrome/browser/importer/importer_host.h"
 #include "chrome/browser/importer/importer_list.h"
 #include "chrome/browser/importer/importer_progress_observer.h"
 #include "chrome/browser/importer/importer_type.h"
+#include "chrome/browser/importer/profile_writer.h"
 #include "chrome/browser/profiles/profile_manager.h"
 #include "chrome/browser/search_engines/template_url_service.h"
 #include "chrome/browser/search_engines/template_url_service_factory.h"
 #include "chrome/browser/shell_integration.h"
 #include "chrome/browser/signin/signin_manager.h"
 #include "chrome/browser/signin/signin_manager_factory.h"
 #include "chrome/browser/signin/signin_tracker.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_finder.h"
 #include "chrome/browser/ui/global_error/global_error_service.h"
@@ skipping 15 matching lines @@
 #include "content/public/browser/notification_types.h"
 #include "content/public/browser/user_metrics.h"
 #include "content/public/browser/web_contents.h"
 #include "google_apis/gaia/gaia_auth_util.h"
 #include "googleurl/src/gurl.h"
 
 using content::UserMetricsAction;
 
 namespace {
 
+// A bitfield formed from values in AutoImportState to record the state of
+// AutoImport. This is used in testing to verify import startup actions that
+// occur before an observer can be registered in the test.
+int g_auto_import_state = first_run::AUTO_IMPORT_NONE;
+
 // Flags for functions of similar name.
 bool g_should_show_welcome_page = false;
 bool g_should_do_autofill_personal_data_manager_first_run = false;
 
-// Flags indicating whether a first-run profile auto import was performed, and
-// whether the importer process exited successfully.
-bool did_perform_profile_import = false;
-bool profile_import_exited_successfully = false;
+// This class acts as an observer for the ImporterProgressObserver::ImportEnded
+// callback. When the import process is started, certain errors may cause
+// ImportEnded() to be called synchronously, but the typical case is that
+// ImportEnded() is called asynchronously. Thus we have to handle both cases.
+class ImportEndedObserver : public importer::ImporterProgressObserver {
+ public:
+  ImportEndedObserver() : ended_(false),
+                          should_quit_message_loop_(false) {}
+  virtual ~ImportEndedObserver() {}
+
+  // importer::ImporterProgressObserver:
+  virtual void ImportStarted() OVERRIDE {}
+  virtual void ImportItemStarted(importer::ImportItem item) OVERRIDE {}
+  virtual void ImportItemEnded(importer::ImportItem item) OVERRIDE {}
+  virtual void ImportEnded() OVERRIDE {
+    ended_ = true;
+    if (should_quit_message_loop_)
+      MessageLoop::current()->Quit();
+  }
+
+  void set_should_quit_message_loop() {
+    should_quit_message_loop_ = true;
+  }
+
+  bool ended() const {
+    return ended_;
+  }
+
+ private:
+  // Set if the import has ended.
+  bool ended_;
+
+  // Set by the client (via set_should_quit_message_loop) if, when the import
+  // ends, this class should quit the message loop.
+  bool should_quit_message_loop_;
+};
 
 // Helper class that performs delayed first-run tasks that need more of the
 // chrome infrastructure to be up and running before they can be attempted.
 class FirstRunDelayedTasks : public content::NotificationObserver {
  public:
   enum Tasks {
     NO_TASK,
     INSTALL_EXTENSIONS
   };
 
@@ skipping 102 matching lines @@
     if (user_prefs->GetBoolean(pref_path))
       *items |= import_type;
   } else { // no policy (recommended or managed) is set
     if (should_import)
       *items |= import_type;
   }
 
   user_prefs->ClearPref(pref_path);
 }
 
-// Imports bookmarks from an html file. The path to the file is provided in
-// the command line.
-void ImportFromFile(Profile* profile, const CommandLine& cmdline) {
-  base::FilePath file_path =
-      cmdline.GetSwitchValuePath(switches::kImportFromFile);
-  if (file_path.empty()) {
-    NOTREACHED();
-    return;
-  }
-  scoped_refptr<ImporterHost> importer_host(new ImporterHost);
-  importer_host->set_headless();
-
-  importer::SourceProfile source_profile;
-  source_profile.importer_type = importer::TYPE_BOOKMARKS_FILE;
-  source_profile.source_path = file_path;
-
-  first_run::internal::ImportEndedObserver observer;
+// Launches the import, via |importer_host|, from |source_profile| into
+// |target_profile| for the items specified in the |items_to_import| bitfield.
+// This may be done in a separate process depending on the platform, but it will
+// always block until done.
+void ImportFromSourceProfile(scoped_refptr<ImporterHost> importer_host,
+                             const importer::SourceProfile& source_profile,
+                             Profile* target_profile,
+                             uint16 items_to_import) {
+  ImportEndedObserver observer;
   importer_host->SetObserver(&observer);
-  importer_host->StartImportSettings(
-      source_profile, profile, importer::FAVORITES, new ProfileWriter(profile));
+  importer_host->StartImportSettings(source_profile,
+                                     target_profile,
+                                     items_to_import,
+                                     new ProfileWriter(target_profile));
   // If the import process has not errored out, block on it.
   if (!observer.ended()) {
     observer.set_should_quit_message_loop();
     MessageLoop::current()->Run();
   }
 }
 
+// Imports bookmarks from an html file whose path is provided by
+// |import_bookmarks_path|.
+void ImportFromFile(Profile* profile,
+                   scoped_refptr<ImporterHost> file_importer_host,
+                   const std::string& import_bookmarks_path) {
+  importer::SourceProfile source_profile;
+  source_profile.importer_type = importer::TYPE_BOOKMARKS_FILE;
+
+  const base::FilePath::StringType& import_bookmarks_path_str =
+#if defined(OS_WIN)
+      UTF8ToUTF16(import_bookmarks_path);
+#else
+      import_bookmarks_path;
+#endif
+  source_profile.source_path = base::FilePath(import_bookmarks_path_str);
+
+  ImportFromSourceProfile(file_importer_host, source_profile, profile,
+                          importer::FAVORITES);
+  g_auto_import_state |= first_run::AUTO_IMPORT_BOOKMARKS_FILE_IMPORTED;
+}
+
+// Imports settings from the first profile in |importer_list|.
+void ImportSettings(Profile* profile,
+                    scoped_refptr<ImporterHost> importer_host,
+                    scoped_refptr<ImporterList> importer_list,
+                    int items_to_import) {
+  const importer::SourceProfile& source_profile =
+      importer_list->GetSourceProfileAt(0);
+
+  // Ensure that importers aren't requested to import items that they do not
+  // support. If there is no overlap, skip.
+  items_to_import &= source_profile.services_supported;
+  if (items_to_import == 0)
+    return;
+
+  ImportFromSourceProfile(importer_host, source_profile, profile,
+                          items_to_import);
+  g_auto_import_state |= first_run::AUTO_IMPORT_PROFILE_IMPORTED;
+}
+
 GURL UrlFromString(const std::string& in) {
   return GURL(in);
 }
 
 void ConvertStringVectorToGURLVector(
     const std::vector<std::string>& src,
     std::vector<GURL>* ret) {
   ret->resize(src.size());
   std::transform(src.begin(), src.end(), ret->begin(), &UrlFromString);
 }
 
 }  // namespace
 
 namespace first_run {
 namespace internal {
 
 FirstRunState first_run_ = FIRST_RUN_UNKNOWN;
 
 static base::LazyInstance<base::FilePath> master_prefs_path_for_testing
     = LAZY_INSTANCE_INITIALIZER;
 
-// TODO(gab): This will go back inline above when it is moved to first_run.cc
-// (see TODO above), but needs to be separate for now to satisfy clang error:
-// "[chromium-style] virtual methods with non-empty bodies shouldn't be declared
-// inline".
-void ImportEndedObserver::ImportEnded() {
-  ended_ = true;
-  if (should_quit_message_loop_)
-    MessageLoop::current()->Quit();
-}
-
 installer::MasterPreferences*
     LoadMasterPrefs(base::FilePath* master_prefs_path) {
   if (!master_prefs_path_for_testing.Get().empty())
     *master_prefs_path = master_prefs_path_for_testing.Get();
   else
     *master_prefs_path = base::FilePath(MasterPrefsPath());
   if (master_prefs_path->empty())
     return NULL;
   installer::MasterPreferences* install_prefs =
       new installer::MasterPreferences(*master_prefs_path);
@@ skipping 83 matching lines @@
           &value) && value) {
     out_prefs->make_chrome_default = true;
   }
 
   if (install_prefs.GetBool(
           installer::master_preferences::kSuppressFirstRunDefaultBrowserPrompt,
           &value) && value) {
     out_prefs->suppress_first_run_default_browser_prompt = true;
   }
 
+  install_prefs.GetString(
+          installer::master_preferences::kDistroImportBookmarksFromFilePref,
+          &out_prefs->import_bookmarks_path);
+
   out_prefs->variations_seed = install_prefs.GetVariationsSeed();
 
   install_prefs.GetString(
      installer::master_preferences::kDistroSuppressDefaultBrowserPromptPref,
      &out_prefs->suppress_default_browser_prompt_for_version);
 }
 
 void SetDefaultBrowser(installer::MasterPreferences* install_prefs){
   // Even on the first run we only allow for the user choice to take effect if
   // no policy has been set by the admin.
@@ skipping 16 matching lines @@
 // -- Platform-specific functions --
 
 #if !defined(OS_LINUX) && !defined(OS_BSD)
 bool IsOrganicFirstRun() {
   std::string brand;
   google_util::GetBrand(&brand);
   return google_util::IsOrganicFirstRun(brand);
 }
 #endif
 
-int ImportBookmarkFromFileIfNeeded(Profile* profile,
-                                   const CommandLine& cmdline) {
-  if (cmdline.HasSwitch(switches::kImportFromFile)) {
-    // Silently import preset bookmarks from file.
-    // This is an OEM scenario.
-    ImportFromFile(profile, cmdline);
-  }
-  // ImportBookmarkFromFileIfNeeded() will go away as part of
-  // http://crbug.com/219419, so it is fine to hardcode |true| for now.
-  return true;
-}
-
 }  // namespace internal
 }  // namespace first_run
 
 namespace first_run {
 
 MasterPrefs::MasterPrefs()
     : ping_delay(0),
       homepage_defined(false),
       do_import_items(0),
       dont_import_items(0),
@@ skipping 75 matching lines @@
   bool retval = g_should_do_autofill_personal_data_manager_first_run;
   g_should_do_autofill_personal_data_manager_first_run = false;
   return retval;
 }
 
 void LogFirstRunMetric(FirstRunBubbleMetric metric) {
   UMA_HISTOGRAM_ENUMERATION("FirstRun.SearchEngineBubble", metric,
                             NUM_FIRST_RUN_BUBBLE_METRICS);
 }
 
-namespace {
-CommandLine* GetExtraArgumentsInstance() {
-  CR_DEFINE_STATIC_LOCAL(CommandLine, arguments, (CommandLine::NoProgram()));
-  return &arguments;
-}
-}  // namespace
-
-void SetExtraArgumentsForImportProcess(const CommandLine& arguments) {
-  GetExtraArgumentsInstance()->AppendArguments(arguments, false);
-}
-
-const CommandLine& GetExtraArgumentsForImportProcess() {
-  return *GetExtraArgumentsInstance();
-}
-
 // static
 void FirstRunBubbleLauncher::ShowFirstRunBubbleSoon() {
   SetShowFirstRunBubblePref(FIRST_RUN_BUBBLE_SHOW);
   // This FirstRunBubbleLauncher instance will manage its own lifetime.
   new FirstRunBubbleLauncher();
 }
 
 FirstRunBubbleLauncher::FirstRunBubbleLauncher() {
   registrar_.Add(this, content::NOTIFICATION_LOAD_COMPLETED_MAIN_FRAME,
                  content::NotificationService::AllSources());
@@ skipping 101 matching lines @@
     if (!internal::ShowPostInstallEULAIfNeeded(install_prefs.get()))
       return EULA_EXIT_NOW;
 
     if (!internal::CopyPrefFile(user_data_dir, master_prefs_path))
       DLOG(ERROR) << "Failed to copy master_preferences to user data dir.";
 
     DoDelayedInstallExtensionsIfNeeded(install_prefs.get());
 
     internal::SetupMasterPrefsFromInstallPrefs(*install_prefs, out_prefs);
 
-    internal::SetImportPreferencesAndLaunchImport(out_prefs,
-                                                  install_prefs.get());
-
     internal::SetDefaultBrowser(install_prefs.get());
   }
 
   return DO_FIRST_RUN_TASKS;
 }
 
 void AutoImport(
     Profile* profile,
     bool homepage_defined,
     int import_items,
-    int dont_import_items) {
+    int dont_import_items,
+    const std::string& import_bookmarks_path) {
 #if !defined(USE_AURA)
   scoped_refptr<ImporterHost> importer_host;
   // TODO(csilv,mirandac): Out-of-process import has only been qualified on
-  // MacOS X, so we will only use it on that platform since it is required.
-  // Remove this conditional logic once oop import is qualified for
-  // Linux/Windows. http://crbug.com/22142
-#if defined(OS_MACOSX)
+  // MacOS X and Windows, so we will only use it on those platforms.
+  // Linux still uses the in-process import (http://crbug.com/56816).
+#if defined(OS_MACOSX) || defined(OS_WIN)
   importer_host = new ExternalProcessImporterHost;
 #else
   importer_host = new ImporterHost;
 #endif
 
   base::FilePath local_state_path;
   PathService::Get(chrome::FILE_LOCAL_STATE, &local_state_path);
   bool local_state_file_exists = file_util::PathExists(local_state_path);
 
   scoped_refptr<ImporterList> importer_list(new ImporterList(NULL));
@@ skipping 45 matching lines @@
     SetImportItem(user_prefs,
                   prefs::kImportBookmarks,
                   import_items,
                   dont_import_items,
                   importer::FAVORITES,
                   &items);
 
     importer::LogImporterUseToMetrics(
         "AutoImport", importer_list->GetSourceProfileAt(0).importer_type);
 
-    profile_import_exited_successfully =
-        internal::ImportSettings(profile, importer_host, importer_list, items);
-    DCHECK(profile_import_exited_successfully);
+    ImportSettings(profile, importer_host, importer_list, items);
+  }
+
+  if (!import_bookmarks_path.empty()) {
+    scoped_refptr<ImporterHost> file_importer_host;
+    // TODO(gab): Make Linux use OOP import as well (http://crbug.com/56816) and
+    // get rid of these ugly ifdefs.
+#if defined(OS_MACOSX) || defined(OS_WIN)
+    file_importer_host = new ExternalProcessImporterHost;
+#else
+    file_importer_host = new ImporterHost;
+#endif
+    file_importer_host->set_headless();
+
+    ImportFromFile(profile, file_importer_host, import_bookmarks_path);
   }
 
   content::RecordAction(UserMetricsAction("FirstRunDef_Accept"));
 
 #endif  // !defined(USE_AURA)
-  did_perform_profile_import = true;
+  g_auto_import_state |= AUTO_IMPORT_CALLED;
 }
 
 void DoPostImportTasks(Profile* profile, bool make_chrome_default) {
   if (make_chrome_default &&
       ShellIntegration::CanSetAsDefaultBrowser() ==
           ShellIntegration::SET_DEFAULT_UNATTENDED) {
     ShellIntegration::SetAsDefaultBrowser();
   }
 
   base::FilePath local_state_path;
@@ skipping 10 matching lines @@
   TemplateURLService* template_url =
       TemplateURLServiceFactory::GetForProfile(profile);
   if (template_url && template_url->GetDefaultSearchProvider())
     FirstRunBubbleLauncher::ShowFirstRunBubbleSoon();
   SetShouldShowWelcomePage();
   SetShouldDoPersonalDataManagerFirstRun();
 
   internal::DoPostImportPlatformSpecificTasks();
 }
 
-bool DidPerformProfileImport(bool* exited_successfully) {
-  if (exited_successfully)
-    *exited_successfully = profile_import_exited_successfully;
-  return did_perform_profile_import;
+int GetAutoImportState() {

[Miranda Callahan, 2013/04/24 15:16:40]

This should probably just be called "g_auto_import_state()" to match Google
getter style.

[gab, 2013/04/24 20:24:59]

How about auto_import_state() to:
1) Not use the same name as the variable.
2) Not care about the g_ prefix, just like we don't add the _ suffix in class
member getters.
?

[Miranda Callahan, 2013/04/25 11:37:06]

yes, that's even better. :-)

On 2013/04/24 20:24:59, gab wrote:

+  return g_auto_import_state;
 }
 
 }  // namespace first_run