[cros] RLZ tracking can be turned off via a flag file.

chrome/browser/chromeos/login/login_utils.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/login/login_utils.h"
 
 #include <algorithm>
 #include <vector>
 
 #include "ash/ash_switches.h"
 #include "base/chromeos/chromeos_version.h"
 #include "base/command_line.h"
 #include "base/compiler_specific.h"
 #include "base/file_path.h"
 #include "base/file_util.h"
 #include "base/location.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/singleton.h"
 #include "base/path_service.h"
 #include "base/prefs/public/pref_member.h"
 #include "base/string_util.h"
 #include "base/stringprintf.h"
 #include "base/synchronization/lock.h"
-#include "base/threading/thread_restrictions.h"
+#include "base/task_runner_util.h"
+#include "base/threading/worker_pool.h"
 #include "base/time.h"
 #include "base/utf_string_conversions.h"
 #include "cc/switches.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/browser_shutdown.h"
 #include "chrome/browser/chromeos/boot_times_loader.h"
 #include "chrome/browser/chromeos/cros/cert_library.h"
 #include "chrome/browser/chromeos/cros/cros_library.h"
 #include "chrome/browser/chromeos/cros/cryptohome_library.h"
 #include "chrome/browser/chromeos/cros/network_library.h"
 #include "chrome/browser/chromeos/input_method/input_method_configuration.h"
 #include "chrome/browser/chromeos/input_method/input_method_manager.h"
 #include "chrome/browser/chromeos/input_method/input_method_util.h"
 #include "chrome/browser/chromeos/login/language_switch_menu.h"
 #include "chrome/browser/chromeos/login/login_display_host.h"
 #include "chrome/browser/chromeos/login/oauth1_token_fetcher.h"
 #include "chrome/browser/chromeos/login/oauth_login_verifier.h"
 #include "chrome/browser/chromeos/login/parallel_authenticator.h"
 #include "chrome/browser/chromeos/login/policy_oauth_fetcher.h"
 #include "chrome/browser/chromeos/login/screen_locker.h"
 #include "chrome/browser/chromeos/login/user_manager.h"
 #include "chrome/browser/chromeos/settings/cros_settings.h"
 #include "chrome/browser/chromeos/settings/cros_settings_names.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/first_run/first_run.h"
+#include "chrome/browser/google/google_util_chromeos.h"
 #include "chrome/browser/net/chrome_url_request_context.h"
 #include "chrome/browser/net/preconnect.h"
 #include "chrome/browser/policy/browser_policy_connector.h"
 #include "chrome/browser/policy/cloud_policy_client.h"
 #include "chrome/browser/policy/cloud_policy_service.h"
 #include "chrome/browser/policy/network_configuration_updater.h"
 #include "chrome/browser/prefs/pref_service.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/profiles/profile_manager.h"
 #include "chrome/browser/rlz/rlz.h"
@@ skipping 119 matching lines @@
 void TransferDefaultAuthCacheOnIOThread(
     net::URLRequestContextGetter* auth_context,
       net::URLRequestContextGetter* new_context) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
   net::HttpAuthCache* new_cache = new_context->GetURLRequestContext()->
       http_transaction_factory()->GetSession()->http_auth_cache();
   new_cache->UpdateAllFrom(*auth_context->GetURLRequestContext()->
       http_transaction_factory()->GetSession()->http_auth_cache());
 }
 
+#if defined(ENABLE_RLZ)
+// Flag file that disables RLZ tracking, when present.
+const char kRLZDisabledFlagName[] = FILE_PATH_LITERAL(".rlz_disabled");
+
+FilePath GetRlzDisabledFlagPath() {
+  return file_util::GetHomeDir().Append(kRLZDisabledFlagName);
+}
+#endif
+
 }  // namespace
 
 // Used to request a restart to switch to the guest mode.
 class JobRestartRequest
     : public base::RefCountedThreadSafe<JobRestartRequest> {
  public:
   JobRestartRequest(int pid, const std::string& command_line)
       : pid_(pid),
         command_line_(command_line),
         local_state_(g_browser_process->local_state()) {
@@ skipping 92 matching lines @@
   virtual void StartTokenServices(Profile* user_profile) OVERRIDE;
   virtual void StartSignedInServices(
       Profile* profile,
       const GaiaAuthConsumer::ClientLoginResult& credentials) OVERRIDE;
   virtual void TransferDefaultCookiesAndServerBoundCerts(
       Profile* default_profile,
       Profile* new_profile) OVERRIDE;
   virtual void TransferDefaultAuthCache(Profile* default_profile,
                                         Profile* new_profile) OVERRIDE;
   virtual void StopBackgroundFetchers() OVERRIDE;
+  virtual void InitRlzDelayed(Profile* user_profile) OVERRIDE;
 
   // OAuth1TokenFetcher::Delegate overrides.
   void OnOAuth1AccessTokenAvailable(const std::string& token,
                                     const std::string& secret) OVERRIDE;
   void OnOAuth1AccessTokenFetchFailed() OVERRIDE;
 
   // OAuthLoginVerifier::Delegate overrides.
   virtual void OnOAuthVerificationSucceeded(const std::string& user_name,
                                             const std::string& sid,
                                             const std::string& lsid,
@@ skipping 50 matching lines @@
                         const std::string& token,
                         const std::string& secret);
 
   // Check user's profile for kApplicationLocale setting.
   void RespectLocalePreference(Profile* pref);
 
   // Callback for asynchronous profile creation.
   void OnProfileCreated(Profile* profile,
                         Profile::CreateStatus status);
 
+  // Initializes RLZ. If |disabled| is true, financial pings are turned off.

[Peter Kasting, 2012/12/17 20:14:03]

Nit: What is a "financial ping"?  Do you just mean to say "RLZ is disabled"? 
What's the difference between non-initialized RLZ state and
initialized-but-disabled state?

[Ivan Korotkov, 2012/12/20 09:20:42]

Financial pings are pings with recorded product events sent to google servers.
RLZTracker in initialized-but-disabled state behaves like in organic Chrome(ium)
builds: it doesn't send anything but still records these events.

From RLZTracker comments:
// If the chrome brand is organic (no partners) then the pings don't occur.

Let's rephrase it to 'RLZ pings are disabled' because financial ping is too
specific indeed.

+  void InitRlz(Profile* user_profile, bool disabled);
+
   std::string password_;
   bool pending_requests_;
   bool using_oauth_;
   bool has_cookies_;
   // Has to be scoped_refptr, see comment for CreateAuthenticator(...).
   scoped_refptr<Authenticator> authenticator_;
   scoped_ptr<PolicyOAuthFetcher> policy_oauth_fetcher_;
   scoped_ptr<OAuth1TokenFetcher> oauth1_token_fetcher_;
   scoped_ptr<OAuthLoginVerifier> oauth_login_verifier_;
 
@@ skipping 267 matching lines @@
 
   user_profile->OnLogin();
 
   // Send the notification before creating the browser so additional objects
   // that need the profile (e.g. the launcher) can be created first.
   content::NotificationService::current()->Notify(
       chrome::NOTIFICATION_LOGIN_USER_PROFILE_PREPARED,
       content::NotificationService::AllSources(),
       content::Details<Profile>(user_profile));
 
-#if defined(ENABLE_RLZ)
-  // Init the RLZ library.
-  int ping_delay = user_profile->GetPrefs()->GetInteger(
-      first_run::GetPingDelayPrefName().c_str());
-  RLZTracker::InitRlzFromProfileDelayed(
-      user_profile, UserManager::Get()->IsCurrentUserNew(), ping_delay);
-#endif
+  InitRlzDelayed(user_profile);
 
   // TODO(altimofeev): This pointer should probably never be NULL, but it looks
   // like LoginUtilsImpl::OnProfileCreated() may be getting called before
   // LoginUtilsImpl::PrepareProfile() has set |delegate_| when Chrome is killed
   // during shutdown in tests -- see http://crosbug.com/18269.  Replace this
   // 'if' statement with a CHECK(delegate_) once the underlying issue is
   // resolved.
   if (delegate_)
     delegate_->OnProfilePrepared(user_profile);
 }
 
+void LoginUtilsImpl::InitRlzDelayed(Profile* user_profile) {
+#if defined(ENABLE_RLZ)
+  if (!g_browser_process->local_state()->HasPrefPath(prefs::kRLZBrand)) {
+    // Read brand code asynchronously from an OEM file and repost ourselves.
+    google_util::chromeos::SetBrandFromFile(
+        base::Bind(&LoginUtilsImpl::InitRlzDelayed, AsWeakPtr(), user_profile));
+    return;
+  }
+  base::PostTaskAndReplyWithResult(
+      base::WorkerPool::GetTaskRunner(false /* task_is_slow */),

[Peter Kasting, 2012/12/17 20:14:03]

Nit: Don't document argument names like this in general, people can look at the
declaration if they need to know.

[Ivan Korotkov, 2012/12/20 09:20:42]

Done.

+      FROM_HERE,
+      base::Bind(&file_util::PathExists, GetRlzDisabledFlagPath()),
+      base::Bind(&LoginUtilsImpl::InitRlz, AsWeakPtr(), user_profile));
+#endif
+}
+
+void LoginUtilsImpl::InitRlz(Profile* user_profile, bool disabled) {
+#if defined(ENABLE_RLZ)
+  if (disabled) {
+    // Empty brand code turns financial pings off.

[Peter Kasting, 2012/12/17 20:14:03]

Nit: Again, this phrase that has no context or explanation.

[Ivan Korotkov, 2012/12/20 09:20:42]

Rephrased.

+    google_util::chromeos::ClearBrandForCurrentSession();
+  }
+  // Init the RLZ library.
+  int ping_delay = user_profile->GetPrefs()->GetInteger(
+      first_run::GetPingDelayPrefName().c_str());
+  RLZTracker::InitRlzFromProfileDelayed(
+      user_profile, UserManager::Get()->IsCurrentUserNew(), ping_delay);
+#endif
+}
+
 void LoginUtilsImpl::StartTokenServices(Profile* user_profile) {
   std::string oauth1_token;
   std::string oauth1_secret;
   if (!ReadOAuth1AccessToken(user_profile, &oauth1_token, &oauth1_secret))
     return;
 
   FetchSecondaryTokens(user_profile->GetOffTheRecordProfile(),
                        oauth1_token, oauth1_secret);
 }
 
@@ skipping 584 matching lines @@
 bool LoginUtils::IsWhitelisted(const std::string& username) {
   CrosSettings* cros_settings = CrosSettings::Get();
   bool allow_new_user = false;
   cros_settings->GetBoolean(kAccountsPrefAllowNewUser, &allow_new_user);
   if (allow_new_user)
     return true;
   return cros_settings->FindEmailInList(kAccountsPrefUsers, username);
 }
 
 }  // namespace chromeos