Make customization documents singletons.

chrome/browser/chromeos/customization_document.cc

 // Copyright (c) 2011 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/chromeos/customization_document.h"
 
+#include "base/file_path.h"
 #include "base/file_util.h"
 #include "base/json/json_reader.h"
 #include "base/logging.h"
 #include "base/string_tokenizer.h"
 #include "base/string_util.h"
+#include "chrome/browser/browser_process.h"
+#include "chrome/browser/chromeos/cros/cros_library.h"
+#include "chrome/browser/chromeos/cros/network_library.h"
 #include "chrome/browser/chromeos/system_access.h"
+#include "chrome/browser/prefs/pref_service.h"
+#include "chrome/browser/profiles/profile_manager.h"
+#include "content/browser/browser_thread.h"
 
 // Manifest attributes names.
 
 namespace {
 
 const char kVersionAttr[] = "version";
 const char kDefaultAttr[] = "default";
 const char kInitialLocaleAttr[] = "initial_locale";
 const char kInitialTimezoneAttr[] = "initial_timezone";
 const char kKeyboardLayoutAttr[] = "keyboard_layout";
 const char kRegistrationUrlAttr[] = "registration_url";
 const char kHwidMapAttr[] = "hwid_map";
 const char kHwidMaskAttr[] = "hwid_mask";
 const char kSetupContentAttr[] = "setup_content";
 const char kHelpPageAttr[] = "help_page";
 const char kEulaPageAttr[] = "eula_page";
 const char kAppContentAttr[] = "app_content";
 const char kInitialStartPageAttr[] = "initial_start_page";
 const char kSupportPageAttr[] = "support_page";
 
 const char kAcceptedManifestVersion[] = "1.0";
 
 const char kHwid[] = "hwid";
 
+// Path to OEM partner startup customization manifest.
+const char kStartupCustomizationManifestPath[] =
+    "/opt/oem/etc/startup_manifest.json";
+
+// URL where to fetch OEM services customization manifest from.
+const char kServicesCustomizationManifestUrl[] =
+    "file:///opt/oem/etc/services_manifest.json";
+
+// Name of local state option that tracks if services customization has been
+// applied.
+const char kServicesCustomizationAppliedPref[] = "ServicesCustomizationApplied";
+
+// Maximum number of retries to fetch file if network is not available.
+const int kMaxFetchRetries = 3;
+
+// Delay between file fetch retries if network is not available.
+const int kRetriesDelayInSec = 2;
+
 }  // anonymous namespace
 
+DISABLE_RUNNABLE_METHOD_REFCOUNT(chromeos::ServicesCustomizationDocument);
+
 namespace chromeos {
 
 // CustomizationDocument implementation.
 bool CustomizationDocument::LoadManifestFromFile(
     const FilePath& manifest_path) {
   std::string manifest;
   if (!file_util::ReadFileToString(manifest_path, &manifest))
     return false;
   return LoadManifestFromString(manifest);
 }
@@ skipping 36 matching lines @@
   DictionaryValue* default_dictionary = NULL;
   if (dictionary_content->GetDictionary(kDefaultAttr, &default_dictionary)) {
     std::string result;
     if (default_dictionary->GetString(entry_name, &result))
       return result;
   }
 
   return std::string();
 }
 
 // StartupCustomizationDocument implementation.

[Nikita (slow), 2011/04/27 13:57:07]

Please use this style here and trough the file:

// StartupCustomizationDocument implementation. -------------

[Dmitry Polukhin, 2011/04/27 14:56:15]

Done.

-StartupCustomizationDocument::StartupCustomizationDocument(
-    SystemAccess* system_access)
-    : system_access_(system_access) {
+StartupCustomizationDocument::StartupCustomizationDocument() {
+  {
+    // Loading manifest causes us to do blocking IO on UI thread.
+    // Temporarily allow it until we fix http://crosbug.com/11103
+    base::ThreadRestrictions::ScopedAllowIO allow_io;
+    LoadManifestFromFile(FilePath(kStartupCustomizationManifestPath));
+  }
+  Init(SystemAccess::GetInstance());
 }
 
-bool StartupCustomizationDocument::LoadManifestFromString(
-    const std::string& manifest) {
-  DCHECK(system_access_);
+StartupCustomizationDocument::StartupCustomizationDocument(
+    SystemAccess* system_access, const std::string& manifest) {
+  LoadManifestFromString(manifest);

[Nikita (slow), 2011/04/27 13:57:07]

Are thread restrictions applied during testing?

[Dmitry Polukhin, 2011/04/27 14:56:15]

I think so. But in test we don't ready manifest from file, only from string it
is more convenient.

+  Init(system_access);
+}
 
-  if (!CustomizationDocument::LoadManifestFromString(manifest)) {
-    return false;
-  }
+StartupCustomizationDocument* StartupCustomizationDocument::GetInstance() {
+  return Singleton<StartupCustomizationDocument,
+      DefaultSingletonTraits<StartupCustomizationDocument> >::get();
+}
+
+void StartupCustomizationDocument::Init(SystemAccess* system_access) {
+  if (!IsReady())
+    return;
 
   root_->GetString(kInitialLocaleAttr, &initial_locale_);
   root_->GetString(kInitialTimezoneAttr, &initial_timezone_);
   root_->GetString(kKeyboardLayoutAttr, &keyboard_layout_);
   root_->GetString(kRegistrationUrlAttr, &registration_url_);
 
   std::string hwid;
-  if (system_access_->GetMachineStatistic(kHwid, &hwid)) {
+  if (system_access->GetMachineStatistic(kHwid, &hwid)) {
     ListValue* hwid_list = NULL;
     if (root_->GetList(kHwidMapAttr, &hwid_list)) {
       for (size_t i = 0; i < hwid_list->GetSize(); ++i) {
         DictionaryValue* hwid_dictionary = NULL;
         std::string hwid_mask;
         if (hwid_list->GetDictionary(i, &hwid_dictionary) &&
             hwid_dictionary->GetString(kHwidMaskAttr, &hwid_mask)) {
           if (MatchPattern(hwid, hwid_mask)) {
             // If HWID for this machine matches some mask, use HWID specific
             // settings.
@@ skipping 10 matching lines @@
           // Don't break here to allow other entires to be applied if match.
         } else {
           LOG(ERROR) << "Syntax error in customization manifest";
         }
       }
     }
   } else {
     LOG(ERROR) << "HWID is missing in machine statistics";
   }
 
-  system_access_->GetMachineStatistic(kInitialLocaleAttr, &initial_locale_);
-  system_access_->GetMachineStatistic(kInitialTimezoneAttr, &initial_timezone_);
-  system_access_->GetMachineStatistic(kKeyboardLayoutAttr, &keyboard_layout_);
-
-  // system_access_ is no longer used.
-  system_access_ = NULL;
-
-  return true;
+  system_access->GetMachineStatistic(kInitialLocaleAttr, &initial_locale_);
+  system_access->GetMachineStatistic(kInitialTimezoneAttr, &initial_timezone_);
+  system_access->GetMachineStatistic(kKeyboardLayoutAttr, &keyboard_layout_);
 }
 
 std::string StartupCustomizationDocument::GetHelpPage(
     const std::string& locale) const {
   return GetLocaleSpecificString(locale, kSetupContentAttr, kHelpPageAttr);
 }
 
 std::string StartupCustomizationDocument::GetEULAPage(
     const std::string& locale) const {
   return GetLocaleSpecificString(locale, kSetupContentAttr, kEulaPageAttr);
 }
 
 // ServicesCustomizationDocument implementation.
+ServicesCustomizationDocument::ServicesCustomizationDocument()
+  : url_(kServicesCustomizationManifestUrl) {
+}
+
+ServicesCustomizationDocument::ServicesCustomizationDocument(
+    const std::string& manifest) {
+  LoadManifestFromString(manifest);

[Nikita (slow), 2011/04/27 13:57:07]

Instance enters into state when call on StartFetching() will start fetching
empty URL.
Could you at least check for empty URL in StartFetching()?

[Dmitry Polukhin, 2011/04/27 14:56:15]

Added DCHECK(url_.is_valid());

+}
+
+// static
+ServicesCustomizationDocument* ServicesCustomizationDocument::GetInstance() {
+  return Singleton<ServicesCustomizationDocument,
+      DefaultSingletonTraits<ServicesCustomizationDocument> >::get();
+}
+
+// static
+void ServicesCustomizationDocument::RegisterPrefs(PrefService* local_state) {
+  local_state->RegisterBooleanPref(kServicesCustomizationAppliedPref, false);

[Nikita (slow), 2011/04/27 14:50:02]

FYI http://codereview.chromium.org/6905044/

+}
+
+// static
+bool ServicesCustomizationDocument::WasApplied() {
+  PrefService* prefs = g_browser_process->local_state();
+  return prefs->GetBoolean(kServicesCustomizationAppliedPref);
+}
+
+// static
+void ServicesCustomizationDocument::SetApplied(bool val) {
+  PrefService* prefs = g_browser_process->local_state();
+  prefs->SetBoolean(kServicesCustomizationAppliedPref, val);
+}
+
+void ServicesCustomizationDocument::StartFetching() {
+  if (url_.SchemeIsFile()) {
+    BrowserThread::PostTask(BrowserThread::FILE, FROM_HERE,
+        NewRunnableMethod(this,
+            &ServicesCustomizationDocument::ReadFileInBackground,
+            FilePath(url_.path())));
+  } else {
+    StartFileFetch();
+  }
+}
+
+void ServicesCustomizationDocument::ReadFileInBackground(const FilePath& file) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
+
+  std::string manifest;
+  if (file_util::ReadFileToString(file, &manifest)) {
+    BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
+        NewRunnableMethod(
+            this,
+            &ServicesCustomizationDocument::LoadManifestFromString,
+            manifest));
+  } else {
+    VLOG(1) << "Failed to load services customization manifest from: "
+            << file.value();
+  }
+}
+
+void ServicesCustomizationDocument::StartFileFetch() {
+  url_fetcher_.reset(new URLFetcher(url_, URLFetcher::GET, this));
+  url_fetcher_->set_request_context(
+      ProfileManager::GetDefaultProfile()->GetRequestContext());
+  url_fetcher_->Start();
+}
+
+void ServicesCustomizationDocument::OnURLFetchComplete(
+    const URLFetcher* source,
+    const GURL& url,
+    const net::URLRequestStatus& status,
+    int response_code,
+    const ResponseCookies& cookies,
+    const std::string& data) {
+  if (response_code == 200) {
+    LoadManifestFromString(data);
+  } else {
+    NetworkLibrary* network = CrosLibrary::Get()->GetNetworkLibrary();
+    if (!network->Connected() && num_retries_ < kMaxFetchRetries) {
+      num_retries_++;
+      retry_timer_.Start(base::TimeDelta::FromSeconds(kRetriesDelayInSec),
+                         this, &ServicesCustomizationDocument::StartFileFetch);
+      return;
+    }
+    LOG(ERROR) << "URL fetch for services customization failed:"
+               << " response code = " << response_code
+               << " URL = " << url.spec();
+  }
+}
+
+bool ServicesCustomizationDocument::ApplyCustmization() {
+  // TODO(dpolukhin): apply customized apps, exts and support page.
+  SetApplied(true);
+  return true;
+}
+
 std::string ServicesCustomizationDocument::GetInitialStartPage(
     const std::string& locale) const {
   return GetLocaleSpecificString(
       locale, kAppContentAttr, kInitialStartPageAttr);
 }
 
 std::string ServicesCustomizationDocument::GetSupportPage(
     const std::string& locale) const {
   return GetLocaleSpecificString(
       locale, kAppContentAttr, kSupportPageAttr);
 }
 
 }  // namespace chromeos