blob: dc72c5c52fd1e54c740e44711acf57d976d9dda6 [file] [log] [blame]
// Copyright 2014 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/threading/thread_checker.h"
#include "base/timer/timer.h"
#include "chromeos/chromeos_export.h"
#include "chromeos/geolocation/geoposition.h"
#include "chromeos/network/network_util.h"
#include "net/url_request/url_fetcher.h"
#include "net/url_request/url_fetcher_delegate.h"
#include "url/gurl.h"
namespace net {
class URLRequestContextGetter;
namespace chromeos {
class SimpleGeolocationRequestTestMonitor;
// Sends request to a server to get local geolocation information.
// It performs formatting of the request and interpretation of the response.
// Request is owned and destroyed by caller (usually SimpleGeolocationProvider).
// - If error occurs, request is retried until timeout.
// - On successul response, callback is called.
// - On timeout, callback with last (failed) position is called.
// (position.status is set to STATUS_TIMEOUT.)
// - If request is destroyed while callback has not beed called yet, request
// is silently cancelled.
// Note: we need CHROMEOS_EXPORT for tests.
class CHROMEOS_EXPORT SimpleGeolocationRequest
: private net::URLFetcherDelegate {
// Called when a new geo geolocation information is available.
// The second argument indicates whether there was a server error or not.
// It is true when there was a server or network error - either no response
// or a 500 error code.
typedef base::Callback<void(const Geoposition& /* position*/,
bool /* server_error */,
const base::TimeDelta elapsed)> ResponseCallback;
// |url| is the server address to which the request wil be sent.
// |timeout| retry request on error until timeout.
// If wifi_data is not null, it will be sent to the geolocation server.
SimpleGeolocationRequest(net::URLRequestContextGetter* url_context_getter,
const GURL& service_url,
base::TimeDelta timeout,
std::unique_ptr<WifiAccessPointVector> wifi_data);
~SimpleGeolocationRequest() override;
// Initiates request.
// Note: if request object is destroyed before callback is called,
// request will be silently cancelled.
void MakeRequest(const ResponseCallback& callback);
void set_retry_sleep_on_server_error_for_testing(
const base::TimeDelta value) {
retry_sleep_on_server_error_ = value;
void set_retry_sleep_on_bad_response_for_testing(
const base::TimeDelta value) {
retry_sleep_on_bad_response_ = value;
// Sets global requests monitoring object for testing.
static void SetTestMonitor(SimpleGeolocationRequestTestMonitor* monitor);
std::string FormatRequestBodyForTesting() const;
// net::URLFetcherDelegate
void OnURLFetchComplete(const net::URLFetcher* source) override;
// Start new request.
void StartRequest();
// Schedules retry.
void Retry(bool server_error);
// Run callback and destroy "this".
void ReplyAndDestroySelf(const base::TimeDelta elapsed, bool server_error);
// Called by timeout_timer_ .
void OnTimeout();
// Returns API request body.
std::string FormatRequestBody() const;
scoped_refptr<net::URLRequestContextGetter> url_context_getter_;
// Service URL from constructor arguments.
const GURL service_url_;
ResponseCallback callback_;
// Actual URL with parameters.
GURL request_url_;
std::unique_ptr<net::URLFetcher> url_fetcher_;
// When request was actually started.
base::Time request_started_at_;
base::TimeDelta retry_sleep_on_server_error_;
base::TimeDelta retry_sleep_on_bad_response_;
const base::TimeDelta timeout_;
// Pending retry.
base::OneShotTimer request_scheduled_;
// Stop request on timeout.
base::OneShotTimer timeout_timer_;
// Number of retry attempts.
unsigned retries_;
// This is updated on each retry.
Geoposition position_;
std::unique_ptr<WifiAccessPointVector> wifi_data_;
// Creation and destruction should happen on the same thread.
base::ThreadChecker thread_checker_;
} // namespace chromeos