Move CaptivePortalDetector to src/components/captive_portal

chrome/browser/captive_portal/captive_portal_service.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/captive_portal/captive_portal_service.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/logging.h"
 #include "base/message_loop/message_loop.h"
 #include "base/metrics/histogram.h"
 #include "base/prefs/pref_service.h"
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/common/pref_names.h"
+#include "components/captive_portal/captive_portal_types.h"
 #include "content/public/browser/notification_service.h"
 
 #if defined(OS_MACOSX)
 #include "base/mac/mac_util.h"
 #endif
 
 #if defined(OS_WIN)
 #include "base/win/windows_version.h"
 #endif
 
-namespace captive_portal {
+using captive_portal::CaptivePortalResult;
 
 namespace {
 
 // Make sure this enum is in sync with CaptivePortalDetectionResult enum
 // in histograms.xml. This enum is append-only, don't modify existing values.
 enum CaptivePortalDetectionResult {
   // There's a confirmed connection to the Internet.
   DETECTION_RESULT_INTERNET_CONNECTED,
   // Received a network or HTTP error, or a non-HTTP response.
   DETECTION_RESULT_NO_RESPONSE,
   // Encountered a captive portal with a non-HTTPS landing URL.
   DETECTION_RESULT_BEHIND_CAPTIVE_PORTAL,
   // Received a network or HTTP error with an HTTPS landing URL.
   DETECTION_RESULT_NO_RESPONSE_HTTPS_LANDING_URL,
   // Encountered a captive portal with an HTTPS landing URL.
   DETECTION_RESULT_BEHIND_CAPTIVE_PORTAL_HTTPS_LANDING_URL,
   DETECTION_RESULT_COUNT
 };
 
 // Records histograms relating to how often captive portal detection attempts
 // ended with |result| in a row, and for how long |result| was the last result
 // of a detection attempt.  Recorded both on quit and on a new Result.
 //
 // |repeat_count| may be 0 if there were no captive portal checks during
 // a session.
 //
 // |result_duration| is the time between when a captive portal check first
 // returned |result| and when a check returned a different result, or when the
 // CaptivePortalService was shut down.
-void RecordRepeatHistograms(Result result,
+void RecordRepeatHistograms(CaptivePortalResult result,
                             int repeat_count,
                             base::TimeDelta result_duration) {
   // Histogram macros can't be used with variable names, since they cache
   // pointers, so have to use the histogram functions directly.
 
   // Record number of times the last result was received in a row.
   base::HistogramBase* result_repeated_histogram =
       base::Histogram::FactoryGet(
-          "CaptivePortal.ResultRepeated." +
-              CaptivePortalDetector::CaptivePortalResultToString(result),
+          "CaptivePortal.ResultRepeated." + CaptivePortalResultToString(result),
           1,  // min
           100,  // max
           100,  // bucket_count
           base::Histogram::kUmaTargetedHistogramFlag);
   result_repeated_histogram->Add(repeat_count);
 
   if (repeat_count == 0)
     return;
 
   // Time between first request that returned |result| and now.
   base::HistogramBase* result_duration_histogram =
       base::Histogram::FactoryTimeGet(
-          "CaptivePortal.ResultDuration." +
-              CaptivePortalDetector::CaptivePortalResultToString(result),
+          "CaptivePortal.ResultDuration." + CaptivePortalResultToString(result),
           base::TimeDelta::FromSeconds(1),  // min
           base::TimeDelta::FromHours(1),  // max
           50,  // bucket_count
           base::Histogram::kUmaTargetedHistogramFlag);
   result_duration_histogram->AddTime(result_duration);
 }
 
 int GetHistogramEntryForDetectionResult(
-    const CaptivePortalDetector::Results& results) {
+    const captive_portal::CaptivePortalDetector::Results& results) {
   bool is_https = results.landing_url.SchemeIs("https");
   switch (results.result) {
-    case RESULT_INTERNET_CONNECTED:
+    case captive_portal::RESULT_INTERNET_CONNECTED:
       return DETECTION_RESULT_INTERNET_CONNECTED;
-    case RESULT_NO_RESPONSE:
+    case captive_portal::RESULT_NO_RESPONSE:
       return is_https ?
           DETECTION_RESULT_NO_RESPONSE_HTTPS_LANDING_URL :
           DETECTION_RESULT_NO_RESPONSE;
-    case RESULT_BEHIND_CAPTIVE_PORTAL:
+    case captive_portal::RESULT_BEHIND_CAPTIVE_PORTAL:
       return is_https ?
           DETECTION_RESULT_BEHIND_CAPTIVE_PORTAL_HTTPS_LANDING_URL :
           DETECTION_RESULT_BEHIND_CAPTIVE_PORTAL;
     default:
       NOTREACHED();
       return -1;
   }
 }
 
 bool ShouldDeferToNativeCaptivePortalDetection() {
@@ skipping 58 matching lines @@
   backoff_policy.entry_lifetime_ms = -1;
 
   backoff_policy.always_use_initial_delay = true;
 }
 
 CaptivePortalService::CaptivePortalService(Profile* profile)
     : profile_(profile),
       state_(STATE_IDLE),
       captive_portal_detector_(profile->GetRequestContext()),
       enabled_(false),
-      last_detection_result_(RESULT_INTERNET_CONNECTED),
+      last_detection_result_(captive_portal::RESULT_INTERNET_CONNECTED),
       num_checks_with_same_result_(0),
-      test_url_(CaptivePortalDetector::kDefaultURL) {
+      test_url_(captive_portal::CaptivePortalDetector::kDefaultURL) {
   // The order matters here:
   // |resolve_errors_with_web_service_| must be initialized and |backoff_entry_|
   // created before the call to UpdateEnabledState.
   resolve_errors_with_web_service_.Init(
       prefs::kAlternateErrorPagesEnabled,
       profile_->GetPrefs(),
       base::Bind(&CaptivePortalService::UpdateEnabledState,
                  base::Unretained(this)));
   ResetBackoffEntry(last_detection_result_);
 
@@ skipping 26 matching lines @@
   DCHECK(state_ == STATE_TIMER_RUNNING || state_ == STATE_IDLE);
   DCHECK(!TimerRunning());
 
   state_ = STATE_CHECKING_FOR_PORTAL;
 
   // When not enabled, just claim there's an Internet connection.
   if (!enabled_) {
     // Count this as a success, so the backoff entry won't apply exponential
     // backoff, but will apply the standard delay.
     backoff_entry_->InformOfRequest(true);
-    OnResult(RESULT_INTERNET_CONNECTED);
+    OnResult(captive_portal::RESULT_INTERNET_CONNECTED);
     return;
   }
 
   captive_portal_detector_.DetectCaptivePortal(
       test_url_, base::Bind(
           &CaptivePortalService::OnPortalDetectionCompleted,
           base::Unretained(this)));
 }
 
 void CaptivePortalService::OnPortalDetectionCompleted(
-    const CaptivePortalDetector::Results& results) {
+    const captive_portal::CaptivePortalDetector::Results& results) {
   DCHECK(CalledOnValidThread());
   DCHECK_EQ(STATE_CHECKING_FOR_PORTAL, state_);
   DCHECK(!TimerRunning());
   DCHECK(enabled_);
 
-  Result result = results.result;
+  CaptivePortalResult result = results.result;
   const base::TimeDelta& retry_after_delta = results.retry_after_delta;
   base::TimeTicks now = GetCurrentTimeTicks();
 
   // Record histograms.
   UMA_HISTOGRAM_ENUMERATION("CaptivePortal.DetectResult",
                             GetHistogramEntryForDetectionResult(results),
                             DETECTION_RESULT_COUNT);
 
   // If this isn't the first captive portal result, record stats.
   if (!last_check_time_.is_null()) {
@@ skipping 41 matching lines @@
 void CaptivePortalService::Shutdown() {
   DCHECK(CalledOnValidThread());
   if (enabled_) {
     RecordRepeatHistograms(
         last_detection_result_,
         num_checks_with_same_result_,
         GetCurrentTimeTicks() - first_check_time_with_same_result_);
   }
 }
 
-void CaptivePortalService::OnResult(Result result) {
+void CaptivePortalService::OnResult(CaptivePortalResult result) {
   DCHECK_EQ(STATE_CHECKING_FOR_PORTAL, state_);
   state_ = STATE_IDLE;
 
   Results results;
   results.previous_result = last_detection_result_;
   results.result = result;
   last_detection_result_ = result;
 
   content::NotificationService::current()->Notify(
       chrome::NOTIFICATION_CAPTIVE_PORTAL_CHECK_RESULT,
       content::Source<Profile>(profile_),
       content::Details<Results>(&results));
 }
 
-void CaptivePortalService::ResetBackoffEntry(Result result) {
-  if (!enabled_ || result == RESULT_BEHIND_CAPTIVE_PORTAL) {
+void CaptivePortalService::ResetBackoffEntry(CaptivePortalResult result) {
+  if (!enabled_ || result == captive_portal::RESULT_BEHIND_CAPTIVE_PORTAL) {
     // Use the shorter time when the captive portal service is not enabled, or
     // behind a captive portal.
     recheck_policy_.backoff_policy.initial_delay_ms =
         recheck_policy_.initial_backoff_portal_ms;
   } else {
     recheck_policy_.backoff_policy.initial_delay_ms =
         recheck_policy_.initial_backoff_no_portal_ms;
   }
 
   backoff_entry_.reset(new RecheckBackoffEntry(this));
@@ skipping 40 matching lines @@
     return time_ticks_for_testing_;
 }
 
 bool CaptivePortalService::DetectionInProgress() const {
   return state_ == STATE_CHECKING_FOR_PORTAL;
 }
 
 bool CaptivePortalService::TimerRunning() const {
   return check_captive_portal_timer_.IsRunning();
 }
-
-}  // namespace captive_portal