If customization includes default wallpaper, download and apply it.

chrome/browser/chromeos/customization_document.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/chromeos/customization_document.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/file_util.h"
 #include "base/files/file_path.h"
 #include "base/json/json_reader.h"
 #include "base/logging.h"
 #include "base/memory/weak_ptr.h"
 #include "base/metrics/histogram.h"
+#include "base/path_service.h"
 #include "base/prefs/pref_registry_simple.h"
 #include "base/prefs/pref_service.h"
 #include "base/strings/string_split.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/time/time.h"
 #include "chrome/browser/browser_process.h"
+#include "chrome/browser/chromeos/customization_wallpaper_downloader.h"
+#include "chrome/browser/chromeos/login/wallpaper_manager.h"
 #include "chrome/browser/chromeos/login/wizard_controller.h"
 #include "chrome/browser/chromeos/net/delay_network_call.h"
 #include "chrome/browser/extensions/external_loader.h"
 #include "chrome/browser/extensions/external_provider_impl.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/ui/app_list/app_list_syncable_service.h"
 #include "chrome/browser/ui/app_list/app_list_syncable_service_factory.h"
+#include "chrome/common/chrome_paths.h"
 #include "chrome/common/extensions/extension_constants.h"
+#include "chrome/common/pref_names.h"
 #include "chromeos/network/network_state.h"
 #include "chromeos/network/network_state_handler.h"
 #include "chromeos/system/statistics_provider.h"
 #include "components/user_prefs/pref_registry_syncable.h"
 #include "content/public/browser/browser_thread.h"
 #include "net/base/load_flags.h"
 #include "net/http/http_response_headers.h"
 #include "net/http/http_status_code.h"
 #include "net/url_request/url_fetcher.h"
 
@@ skipping 16 matching lines @@
 const char kDefaultAppsAttr[] = "default_apps";
 const char kLocalizedContent[] = "localized_content";
 const char kDefaultAppsFolderName[] = "default_apps_folder_name";
 
 const char kAcceptedManifestVersion[] = "1.0";
 
 // Path to OEM partner startup customization manifest.
 const char kStartupCustomizationManifestPath[] =
     "/opt/oem/etc/startup_manifest.json";
 
+static const char kCustomizationDefaultWallpaperDir[] = "customization/";

[bshe, 2014/03/24 21:30:49]

nit: remove static keyword to keep it consistent with other variables.

[Alexander Alekseev, 2014/03/25 14:38:29]

Done.

+
+// The original downloaded image file is stored under this name.
+static const char kCustomizationDefaultWallpaperDownloadedFile[] =
+    "default.downloaded";

[bshe, 2014/03/24 21:30:49]

ditto

[Alexander Alekseev, 2014/03/25 14:38:29]

Done.

+
 // 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;
 
@@ skipping 39 matching lines @@
   const base::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();
 }
 
+void CheckWallpaperCacheExists(const base::FilePath& path, bool* exists) {
+  DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::FILE));

[bshe, 2014/03/24 21:30:49]

It looks like this is called on worker pool thread, not file thread.

[Alexander Alekseev, 2014/03/25 14:38:29]

Yes, but there is no direct way to check that we're on a worker pool.
CurrentlyOn(FILE) is true on WorkerPool (WorkerPool is a replacement for FILE,
isn't it?).

+  DCHECK(exists);
+  *exists = base::PathExists(path);
+}
+
 }  // anonymous namespace
 
 namespace chromeos {
 
 // Template URL where to fetch OEM services customization manifest from.
 const char ServicesCustomizationDocument::kManifestUrl[] =
     "https://ssl.gstatic.com/chrome/chromeos-customization/%s.json";
 
 // A custom extensions::ExternalLoader that the ServicesCustomizationDocument
 // creates and uses to publish OEM default apps to the extensions system.
@@ skipping 213 matching lines @@
 // static
 ServicesCustomizationDocument* ServicesCustomizationDocument::GetInstance() {
   return Singleton<ServicesCustomizationDocument,
       DefaultSingletonTraits<ServicesCustomizationDocument> >::get();
 }
 
 // static
 void ServicesCustomizationDocument::RegisterPrefs(
     PrefRegistrySimple* registry) {
   registry->RegisterBooleanPref(kServicesCustomizationAppliedPref, false);
+  registry->RegisterStringPref(prefs::kCustomizationDefaultWallpaperURL, "");
 }
 
 // static
 void ServicesCustomizationDocument::RegisterProfilePrefs(
     user_prefs::PrefRegistrySyncable* registry) {
   registry->RegisterDictionaryPref(
       kServicesCustomizationKey,
       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
 }
 
@@ skipping 140 matching lines @@
     // This doesn't stop fetching manifest on next restart.
     LOG(ERROR) << "URL fetch for services customization failed:"
                << " response code = " << source->GetResponseCode()
                << " URL = " << source->GetURL().spec();
 
     LogManifestLoadResult(HISTOGRAM_LOAD_RESULT_RETRIES_FAIL);
   }
   fetch_started_ = false;
 }
 
+void ServicesCustomizationDocument::StartOEMWallpaperDownload(
+    const GURL& wallpaper_url) {
+  DCHECK(wallpaper_url.is_valid());
+
+  const base::FilePath dir = GetCustomizedWallpaperCacheDir();
+  const base::FilePath file = GetCustomizedWallpaperDownloadedFileName();
+  if (!dir.empty() && !file.empty()) {
+    wallpaper_downloader_.reset(new CustomizationWallpaperDownloader(
+        g_browser_process->system_request_context(), wallpaper_url, dir, file));
+
+    wallpaper_downloader_->Start();
+  }
+}
+
+// static
+base::FilePath ServicesCustomizationDocument::GetCustomizedWallpaperCacheDir() {
+  base::FilePath custom_wallpaper_dir;
+  const bool success = PathService::Get(chrome::DIR_CHROMEOS_CUSTOM_WALLPAPERS,
+                                        &custom_wallpaper_dir);
+  DCHECK(success);

[bshe, 2014/03/24 21:30:49]

why do you DCHECK here and have a if statement below?

[Alexander Alekseev, 2014/03/25 14:38:29]

The idea is that we should fail in tests here, but probably should not crash if
some configuration has changed and wallpapers disappeared.

+
+  if (success)
+    return custom_wallpaper_dir.Append(kCustomizationDefaultWallpaperDir);
+
+  return custom_wallpaper_dir;
+}
+
+// static
+base::FilePath
+ServicesCustomizationDocument::GetCustomizedWallpaperDownloadedFileName() {

[bshe, 2014/03/24 21:30:49]

nit: 4 spaces indent

[Alexander Alekseev, 2014/03/25 14:38:29]

Done. (Strange, but clang-format doesn't agree with you here).

+  const base::FilePath dir = GetCustomizedWallpaperCacheDir();
+  if (dir.empty())
+    return dir;
+  return dir.Append(kCustomizationDefaultWallpaperDownloadedFile);
+}
+
+// static
+void ServicesCustomizationDocument::SetDefaultWallpaperPath(
+    const GURL& wallpaper_url) {
+  DCHECK(wallpaper_url.is_valid());
+
+  VLOG(1) << "Setting default wallpaper to '"
+          << GetCustomizedWallpaperDownloadedFileName().value() << "' ('"
+          << wallpaper_url.spec() << "')";
+  WallpaperManager::Get()->SetCustomizedDefaultWallpaper(
+      wallpaper_url,
+      GetCustomizedWallpaperDownloadedFileName(),
+      GetCustomizedWallpaperCacheDir());
+}
+
+// static
+void ServicesCustomizationDocument::DestroyWallpaperDownloader() {
+  ServicesCustomizationDocument* self =
+      ServicesCustomizationDocument::GetInstance();
+  DCHECK(self);
+  self->wallpaper_downloader_.reset();
+}
+
+void ServicesCustomizationDocument::ApplyWallpaper(
+    bool default_wallpaper_file_exists) {
+  GURL wallpaper_url = GetDefaultWallpaperUrl();
+  DCHECK(wallpaper_url.is_valid());
+
+  PrefService* prefService = g_browser_process->local_state();
+  DCHECK(prefService);

[Mattias Nissler (ping if slow), 2014/03/24 20:38:54]

Remove, you'll get a crash report anyways below in line 604 if prefService ==
NULL.

[Alexander Alekseev, 2014/03/25 14:38:29]

Done.

+
+  std::string current_url =
+      prefService->GetString(prefs::kCustomizationDefaultWallpaperURL);
+  if (current_url != wallpaper_url.spec()) {
+    VLOG(1) << "ServicesCustomizationDocument::ApplyWallpaper() : "

[Mattias Nissler (ping if slow), 2014/03/24 20:38:54]

This VLOG is misleading, because the code below only uses current_url if it's
valid (i.e. empty string gets ignored too).

[Alexander Alekseev, 2014/03/25 14:38:29]

If "current_url" is empty, "GURL(current_url).is_valid()" will fail and we will
start downloading new wallaper.

If "current_url" is valid, we would always use old wallpaper, but it seems
reasonable to me to signal that it has changed in manifest.

+            << "Wallpaper URL in customization document '"
+            << wallpaper_url.spec() << "' differs from current '" << current_url
+            << "'. Ignored.";
+  }
+  // Never update system-wide wallpaper (i.e. do not check
+  // current_url == wallpaper_url.spec() )

[bshe, 2014/03/24 21:30:49]

I am not sure I understand this. What is we want to add a larger default
wallpaper for xhdpi screen? it would not possible?

[Alexander Alekseev, 2014/03/25 14:38:29]

This is mentioned in design document: customization document might be updated,
but we never update default wallpaper in order not to confuse user.

+  if (GURL(current_url).is_valid() && default_wallpaper_file_exists) {
+    VLOG(1)
+        << "ServicesCustomizationDocument::ApplyWallpaper() : reuse existing";
+    SetDefaultWallpaperPath(GURL(current_url));

[bshe, 2014/03/24 21:30:49]

could we call:
WallpaperManager::Get()->SetCustomizedDefaultWallpaper(
       wallpaper_url,
       GetCustomizedWallpaperDownloadedFileName(),
       GetCustomizedWallpaperCacheDir());

directly from here? The static function SetDefaultWallpaperPath doesn't seem to
do much thing? You include the VLOG in the SetCustomizedDefaultWallpaper.

[Alexander Alekseev, 2014/03/25 14:38:29]

SetDefaultWallpaperPath() is called both from here and from
customization_wallpaper_downloader. So I've created that function as  a single
point of setting default wallpaper path in this object.

+  } else {
+    VLOG(1)
+        << "ServicesCustomizationDocument::ApplyWallpaper() : start download";
+    StartOEMWallpaperDownload(wallpaper_url);
+  }
+}
+
+void ServicesCustomizationDocument::OnCheckedWallpaperCacheExists(
+    scoped_ptr<bool> exists) {
+  DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
+  DCHECK(exists.get());
+
+  ApplyWallpaper(*exists);
+}
+
+void ServicesCustomizationDocument::CheckAndApplyWallpaper() {
+  GURL wallpaper_url = GetDefaultWallpaperUrl();
+  // Should fail if this ever happens in tests.
+  DCHECK(wallpaper_url.is_valid() || wallpaper_url.is_empty());
+  if (!wallpaper_url.is_valid()) {
+    if (!wallpaper_url.is_empty()) {
+      LOG(WARNING) << "Invalid Customized Wallpaper URL.";
+    }
+    return;
+  }
+  scoped_ptr<bool> exists(new bool(false));
+
+  base::Closure check_file_exists =
+      base::Bind(&CheckWallpaperCacheExists,
+                 GetCustomizedWallpaperDownloadedFileName(),
+                 base::Unretained(exists.get()));
+  base::Closure on_checked_closure =
+      base::Bind(&ServicesCustomizationDocument::OnCheckedWallpaperCacheExists,
+                 weak_ptr_factory_.GetWeakPtr(),
+                 base::Passed(exists.Pass()));
+  if (!content::BrowserThread::PostBlockingPoolTaskAndReply(
+          FROM_HERE, check_file_exists, on_checked_closure)) {
+    LOG(WARNING) << "Failed to start check Wallpaper cache exists.";
+  }
+}
+
 bool ServicesCustomizationDocument::ApplyOOBECustomization() {
-  // TODO(dpolukhin): apply default wallpaper, crbug.com/348136.
+  CheckAndApplyWallpaper();
   SetApplied(true);
   return true;
 }
 
 GURL ServicesCustomizationDocument::GetDefaultWallpaperUrl() const {
   if (!IsReady())
     return GURL();
 
   std::string url;
   root_->GetString(kDefaultWallpaperAttr, &url);
@@ skipping 110 matching lines @@
 }
 
 std::string ServicesCustomizationDocument::GetOemAppsFolderNameImpl(
     const std::string& locale,
     const base::DictionaryValue& root) const {
   return GetLocaleSpecificStringImpl(
       &root, locale, kLocalizedContent, kDefaultAppsFolderName);
 }
 
 }  // namespace chromeos