blob: b5a26331cf2f033b6c705b7439e15b81ed60e60d [file] [log] [blame]
// 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 <memory>
#include "base/callback.h"
#include "base/compiler_specific.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/sequence_checker.h"
#include "base/time/time.h"
#include "components/captive_portal/captive_portal_export.h"
#include "components/captive_portal/captive_portal_types.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "net/url_request/url_fetcher.h"
#include "net/url_request/url_fetcher_delegate.h"
#include "net/url_request/url_request_context_getter.h"
class GURL;
namespace captive_portal {
class CAPTIVE_PORTAL_EXPORT CaptivePortalDetector
: public net::URLFetcherDelegate {
struct Results {
: result(captive_portal::RESULT_NO_RESPONSE),
response_code(net::URLFetcher::RESPONSE_CODE_INVALID) {
captive_portal::CaptivePortalResult result;
int response_code;
base::TimeDelta retry_after_delta;
GURL landing_url;
typedef base::Callback<void(const Results& results)> DetectionCallback;
// The test URL. When connected to the Internet, it should return a
// blank page with a 204 status code. When behind a captive portal,
// requests for this URL should get an HTTP redirect or a login
// page. When neither is true, no server should respond to requests
// for this URL.
static const char kDefaultURL[];
explicit CaptivePortalDetector(
const scoped_refptr<net::URLRequestContextGetter>& request_context);
~CaptivePortalDetector() override;
// Triggers a check for a captive portal. After completion, runs the
// |callback|.
void DetectCaptivePortal(
const GURL& url,
const DetectionCallback& callback,
const net::NetworkTrafficAnnotationTag& traffic_annotation);
// Cancels captive portal check.
void Cancel();
friend class CaptivePortalDetectorTestBase;
// net::URLFetcherDelegate:
void OnURLFetchComplete(const net::URLFetcher* source) override;
// Takes a net::URLFetcher that has finished trying to retrieve the
// test URL, and fills a Results struct based on its result. If the
// response is a 503 with a Retry-After header, |retry_after| field
// of |results| is populated accordingly. Otherwise, it's set to
// base::TimeDelta().
void GetCaptivePortalResultFromResponse(const net::URLFetcher* url_fetcher,
Results* results) const;
// Returns the current time. Used only when determining time until a
// Retry-After date.
base::Time GetCurrentTime() const;
// Returns true if a captive portal check is currently running.
bool FetchingURL() const;
// Sets current test time. Used by unit tests.
void set_time_for_testing(const base::Time& time) {
time_for_testing_ = time;
// Advances current test time. Used by unit tests.
void advance_time_for_testing(const base::TimeDelta& delta) {
time_for_testing_ += delta;
// URL request context.
scoped_refptr<net::URLRequestContextGetter> request_context_;
DetectionCallback detection_callback_;
std::unique_ptr<net::URLFetcher> url_fetcher_;
// Test time used by unit tests.
base::Time time_for_testing_;
} // namespace captive_portal