[rlz,cros] RLZ glue for ChromeOS.

chrome/browser/rlz/rlz.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.
 //
 // This code glues the RLZ library DLL with Chrome. It allows Chrome to work
 // with or without the DLL being present. If the DLL is not present the
 // functions do nothing and just return false.
 
 #include "chrome/browser/rlz/rlz.h"
 
 #include <algorithm>
 
 #include "base/bind.h"
+#include "base/command_line.h"
 #include "base/debug/trace_event.h"
 #include "base/message_loop.h"
 #include "base/string_util.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/google/google_util.h"
+#include "chrome/browser/prefs/pref_service.h"
+#include "chrome/browser/prefs/session_startup_pref.h"
 #include "chrome/browser/search_engines/template_url.h"
 #include "chrome/browser/search_engines/template_url_service.h"
 #include "chrome/browser/search_engines/template_url_service_factory.h"
+#include "chrome/browser/ui/startup/startup_browser_creator.h"
 #include "chrome/common/chrome_notification_types.h"
+#include "chrome/common/pref_names.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/notification_service.h"
 #include "net/http/http_util.h"
 
-#if defined(OS_CHROMEOS)
-#include "base/threading/sequenced_worker_pool.h"
-#endif
-
 #if defined(OS_WIN)
 #include "chrome/installer/util/google_update_settings.h"
 #else
 namespace GoogleUpdateSettings {
 static bool GetLanguage(string16* language) {
   // TODO(thakis): Implement.
   NOTIMPLEMENTED();
   return false;
 }
 
 // The referral program is defunct and not used. No need to implement these
 // functions on non-Win platforms.
 static bool GetReferral(string16* referral) {
   return true;
 }
 static bool ClearReferral() {
   return true;
 }
 }  // namespace GoogleUpdateSettings
 #endif
 
 using content::BrowserThread;
 using content::NavigationEntry;
 
 namespace {
 
-const char kRlzThreadName[] = "RLZ_thread";
+bool IsGoogleUrl(const GURL& url) {
+  return google_util::IsGoogleHomePageUrl(url.possibly_invalid_spec());
+}
 
 bool IsBrandOrganic(const std::string& brand) {
   return brand.empty() || google_util::IsOrganic(brand);
 }
 
 void RecordProductEvents(bool first_run,
                          bool is_google_default_search,
                          bool is_google_homepage,
                          bool is_google_in_startpages,
                          bool already_ran,
@@ skipping 100 matching lines @@
 RLZTracker* RLZTracker::GetInstance() {
   return tracker_ ? tracker_ : Singleton<RLZTracker>::get();
 }
 
 RLZTracker::RLZTracker()
     : first_run_(false),
       send_ping_immediately_(false),
       is_google_default_search_(false),
       is_google_homepage_(false),
       is_google_in_startpages_(false),
-      rlz_thread_(kRlzThreadName),
-      blocking_task_runner_(NULL),
-      url_request_context_(NULL),
       already_ran_(false),
       omnibox_used_(false),
       homepage_used_(false) {
 }
 
 RLZTracker::~RLZTracker() {
 }
 
 // static
 bool RLZTracker::InitRlzDelayed(bool first_run,
                                 int delay,
                                 bool is_google_default_search,
                                 bool is_google_homepage,
                                 bool is_google_in_startpages) {
   return GetInstance()->Init(first_run, delay, is_google_default_search,
                              is_google_homepage, is_google_in_startpages);
 }
 
+// static
+bool RLZTracker::InitRlzFromProfileDelayed(Profile* profile,
+                                           bool first_run,
+                                           int delay) {
+  bool is_google_default_search = false;
+  TemplateURLService* template_url_service =
+      TemplateURLServiceFactory::GetForProfile(profile);
+  if (template_url_service) {
+    const TemplateURL* url_template =
+        template_url_service->GetDefaultSearchProvider();
+    is_google_default_search =
+        url_template && url_template->url_ref().HasGoogleBaseURLs();
+  }
+
+  PrefService* pref_service = profile->GetPrefs();
+  bool is_google_homepage = google_util::IsGoogleHomePageUrl(
+      pref_service->GetString(prefs::kHomePage));
+
+  bool is_google_in_startpages = false;
+  SessionStartupPref session_startup_prefs =
+      StartupBrowserCreator::GetSessionStartupPref(
+          *CommandLine::ForCurrentProcess(), profile);
+  if (session_startup_prefs.type == SessionStartupPref::URLS) {
+    is_google_in_startpages = std::count_if(session_startup_prefs.urls.begin(),
+                                            session_startup_prefs.urls.end(),
+                                            IsGoogleUrl) > 0;
+  }
+
+  if (!InitRlzDelayed(first_run, delay,
+                      is_google_default_search, is_google_homepage,
+                      is_google_in_startpages)) {
+    return false;
+  }
+
+  // Prime the RLZ cache for the home page access point so that its avaiable
+  // for the startup page if needed (i.e., when the startup page is set to
+  // the home page).
+  GetAccessPointRlz(CHROME_HOME_PAGE, NULL);
+
+  return true;
+}
+
 bool RLZTracker::Init(bool first_run,
                       int delay,
                       bool is_google_default_search,
                       bool is_google_homepage,
                       bool is_google_in_startpages) {
   first_run_ = first_run;
   is_google_default_search_ = is_google_default_search;
   is_google_homepage_ = is_google_homepage;
   is_google_in_startpages_ = is_google_in_startpages;
 
-  if (!InitWorkers())
-    return false;
-
   // A negative delay means that a financial ping should be sent immediately
   // after a first search is recorded, without waiting for the next restart
   // of chrome. However, we only want this behaviour on first run.
   send_ping_immediately_ = false;
   if (delay < 0) {
     send_ping_immediately_ = true;
     delay = -delay;
   }
 
   // Maximum and minimum delay we would allow to be set through master
   // preferences. Somewhat arbitrary, may need to be adjusted in future.
   const int kMaxDelay = 200 * 1000;
   const int kMinDelay = 20 * 1000;
 
   delay *= 1000;
   delay = (delay < kMinDelay) ? kMinDelay : delay;
   delay = (delay > kMaxDelay) ? kMaxDelay : delay;
 
-  std::string brand;
-  if (google_util::GetBrand(&brand) && !IsBrandOrganic(brand)) {
+  if (google_util::GetBrand(&brand_) && !IsBrandOrganic(brand_)) {
     // Register for notifications from the omnibox so that we can record when
     // the user performs a first search.
     registrar_.Add(this, chrome::NOTIFICATION_OMNIBOX_OPENED_URL,
                    content::NotificationService::AllSources());
     // If instant is enabled we'll start searching as soon as the user starts
     // typing in the omnibox (which triggers INSTANT_CONTROLLER_UPDATED).
     registrar_.Add(this, chrome::NOTIFICATION_INSTANT_CONTROLLER_UPDATED,
                    content::NotificationService::AllSources());
 
     // Register for notifications from navigations, to see if the user has used
     // the home page.
     registrar_.Add(this, content::NOTIFICATION_NAV_ENTRY_PENDING,
                    content::NotificationService::AllSources());
   }
+  google_util::GetReactivationBrand(&reactivation_brand_);
 
-  url_request_context_ = g_browser_process->system_request_context();
+  rlz_lib::SetURLRequestContext(g_browser_process->system_request_context());
   ScheduleDelayedInit(delay);
 
   return true;
 }
 
 void RLZTracker::ScheduleDelayedInit(int delay) {
   // The RLZTracker is a singleton object that outlives any runnable tasks
   // that will be queued up.
-  blocking_task_runner_->PostDelayedTask(
+  BrowserThread::GetBlockingPool()->PostDelayedTask(
       FROM_HERE,
       base::Bind(&RLZTracker::DelayedInit, base::Unretained(this)),
       base::TimeDelta::FromMilliseconds(delay));
 }
 
-bool RLZTracker::InitWorkers() {
-  base::Thread::Options options;
-  options.message_loop_type = MessageLoop::TYPE_IO;
-  if (!rlz_thread_.StartWithOptions(options))
-    return false;
-  blocking_task_runner_ = rlz_thread_.message_loop_proxy();
-
-#if defined(OS_CHROMEOS)
-  base::SequencedWorkerPool* worker_pool =
-      content::BrowserThread::GetBlockingPool();
-  if (!worker_pool)
-    return false;
-  rlz_lib::SetIOTaskRunner(
-      worker_pool->GetSequencedTaskRunnerWithShutdownBehavior(
-          worker_pool->GetSequenceToken(),
-          base::SequencedWorkerPool::BLOCK_SHUTDOWN));
-#endif
-  return true;
-}
-
 void RLZTracker::DelayedInit() {
-  if (!already_ran_)
-    rlz_lib::SetURLRequestContext(url_request_context_);
+  worker_pool_token_ = BrowserThread::GetBlockingPool()->GetSequenceToken();
 
   bool schedule_ping = false;
 
   // For organic brandcodes do not use rlz at all. Empty brandcode usually
   // means a chromium install. This is ok.
-  std::string brand;
-  if (google_util::GetBrand(&brand) && !IsBrandOrganic(brand)) {
+  if (!IsBrandOrganic(brand_)) {
     RecordProductEvents(first_run_, is_google_default_search_,
                         is_google_homepage_, is_google_in_startpages_,
                         already_ran_, omnibox_used_, homepage_used_);
     schedule_ping = true;
   }
 
   // If chrome has been reactivated, record the events for this brand
   // as well.
-  std::string reactivation_brand;
-  if (google_util::GetReactivationBrand(&reactivation_brand) &&
-      !IsBrandOrganic(reactivation_brand)) {
-    rlz_lib::SupplementaryBranding branding(reactivation_brand.c_str());
+  if (!IsBrandOrganic(reactivation_brand_)) {
+    rlz_lib::SupplementaryBranding branding(reactivation_brand_.c_str());
     RecordProductEvents(first_run_, is_google_default_search_,
                         is_google_homepage_, is_google_in_startpages_,
                         already_ran_, omnibox_used_, homepage_used_);
     schedule_ping = true;
   }
 
   already_ran_ = true;
 
   if (schedule_ping)
     ScheduleFinancialPing();
 }
 
 void RLZTracker::ScheduleFinancialPing() {
-  blocking_task_runner_->PostTask(
+  BrowserThread::GetBlockingPool()->PostSequencedWorkerTask(
+      worker_pool_token_,
       FROM_HERE,
       base::Bind(&RLZTracker::PingNowImpl, base::Unretained(this)));
 }
 
 void RLZTracker::PingNowImpl() {
   TRACE_EVENT0("RLZ", "RLZTracker::PingNowImpl");
   string16 lang;
   GoogleUpdateSettings::GetLanguage(&lang);
   if (lang.empty())
     lang = ASCIIToUTF16("en");
   string16 referral;
   GoogleUpdateSettings::GetReferral(&referral);
 
-  std::string brand;
-  if (google_util::GetBrand(&brand) && !IsBrandOrganic(brand) &&
-      SendFinancialPing(brand, lang, referral)) {
+  if (!IsBrandOrganic(brand_) && SendFinancialPing(brand_, lang, referral)) {
     GoogleUpdateSettings::ClearReferral();
 
     {
       base::AutoLock lock(cache_lock_);
       rlz_cache_.clear();
     }
 
     // Prime the RLZ cache for the access points we are interested in.
     GetAccessPointRlz(RLZTracker::CHROME_OMNIBOX, NULL);
     GetAccessPointRlz(RLZTracker::CHROME_HOME_PAGE, NULL);
   }
 
-  std::string reactivation_brand;
-  if (google_util::GetReactivationBrand(&reactivation_brand) &&
-      !IsBrandOrganic(reactivation_brand)) {
-    rlz_lib::SupplementaryBranding branding(reactivation_brand.c_str());
-    SendFinancialPing(reactivation_brand, lang, referral);
+  if (!IsBrandOrganic(reactivation_brand_)) {
+    rlz_lib::SupplementaryBranding branding(reactivation_brand_.c_str());
+    SendFinancialPing(reactivation_brand_, lang, referral);
   }
 }
 
 bool RLZTracker::SendFinancialPing(const std::string& brand,
                                    const string16& lang,
                                    const string16& referral) {
   return ::SendFinancialPing(brand, lang, referral);
 }
 
 void RLZTracker::Observe(int type,
@@ skipping 37 matching lines @@
                                         rlz_lib::AccessPoint point,
                                         rlz_lib::Event event_id) {
   // Make sure we don't access disk outside of the I/O thread.
   // In such case we repost the task on the right thread and return error.
   if (ScheduleRecordProductEvent(product, point, event_id))
     return true;
 
   bool ret = rlz_lib::RecordProductEvent(product, point, event_id);
 
   // If chrome has been reactivated, record the event for this brand as well.
-  std::string reactivation_brand;
-  if (google_util::GetReactivationBrand(&reactivation_brand)) {
-    rlz_lib::SupplementaryBranding branding(reactivation_brand.c_str());
+  if (!reactivation_brand_.empty()) {
+    rlz_lib::SupplementaryBranding branding(reactivation_brand_.c_str());
     ret &= rlz_lib::RecordProductEvent(product, point, event_id);
   }
 
   return ret;
 }
 
 bool RLZTracker::ScheduleRecordProductEvent(rlz_lib::Product product,
                                             rlz_lib::AccessPoint point,
                                             rlz_lib::Event event_id) {
   if (!BrowserThread::CurrentlyOn(BrowserThread::UI))
     return false;
-  if (!blocking_task_runner_) {
+  if (!already_ran_) {
     LOG(ERROR) << "Attempted recording RLZ event before RLZ init.";
     return true;
   }
 
-  blocking_task_runner_->PostTask(
+  BrowserThread::GetBlockingPool()->PostSequencedWorkerTask(
+      worker_pool_token_,
       FROM_HERE,
       base::Bind(base::IgnoreResult(&RLZTracker::RecordProductEvent),
                  product, point, event_id));
 
   return true;
 }
 
 void RLZTracker::RecordFirstSearch(rlz_lib::AccessPoint point) {
   // Make sure we don't access disk outside of the I/O thread.
   // In such case we repost the task on the right thread and return error.
   if (ScheduleRecordFirstSearch(point))
     return;
 
   bool* record_used = point == CHROME_OMNIBOX ?
       &omnibox_used_ : &homepage_used_;
 
   // Try to record event now, else set the flag to try later when we
   // attempt the ping.
   if (!RecordProductEvent(rlz_lib::CHROME, point, rlz_lib::FIRST_SEARCH))
     *record_used = true;
   else if (send_ping_immediately_ && point == CHROME_OMNIBOX)
     ScheduleDelayedInit(0);
 }
 
 bool RLZTracker::ScheduleRecordFirstSearch(rlz_lib::AccessPoint point) {
   if (!BrowserThread::CurrentlyOn(BrowserThread::UI))
     return false;
-  blocking_task_runner_->PostTask(
+  BrowserThread::GetBlockingPool()->PostSequencedWorkerTask(
+      worker_pool_token_,
       FROM_HERE,
       base::Bind(&RLZTracker::RecordFirstSearch,
                  base::Unretained(this), point));
   return true;
 }
 
 // static
 std::string RLZTracker::GetAccessPointHttpHeader(rlz_lib::AccessPoint point) {
   TRACE_EVENT0("RLZ", "RLZTracker::GetAccessPointHttpHeader");
   std::string extra_headers;
@@ skipping 47 matching lines @@
   base::AutoLock lock(cache_lock_);
   rlz_cache_[point] = rlz_local;
   return true;
 }
 
 bool RLZTracker::ScheduleGetAccessPointRlz(rlz_lib::AccessPoint point) {
   if (!BrowserThread::CurrentlyOn(BrowserThread::UI))
     return false;
 
   string16* not_used = NULL;
-  blocking_task_runner_->PostTask(
+  BrowserThread::GetBlockingPool()->PostSequencedWorkerTask(
+      worker_pool_token_,
       FROM_HERE,
       base::Bind(base::IgnoreResult(&RLZTracker::GetAccessPointRlz), point,
                  not_used));
   return true;
 }
 
 // static
 void RLZTracker::CleanupRlz() {
   GetInstance()->rlz_cache_.clear();
   GetInstance()->registrar_.RemoveAll();
 }