123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305 |
- // 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 "services/device/geolocation/network_location_provider.h"
- #include <utility>
- #include "base/bind.h"
- #include "base/location.h"
- #include "base/memory/scoped_refptr.h"
- #include "base/metrics/histogram_macros.h"
- #include "base/strings/utf_string_conversions.h"
- #include "base/task/single_thread_task_runner.h"
- #include "base/task/task_runner.h"
- #include "base/threading/thread_task_runner_handle.h"
- #include "base/time/time.h"
- #include "build/build_config.h"
- #include "net/traffic_annotation/network_traffic_annotation.h"
- #include "services/device/geolocation/position_cache.h"
- #include "services/device/public/cpp/geolocation/geoposition.h"
- #include "services/network/public/cpp/shared_url_loader_factory.h"
- #if BUILDFLAG(IS_MAC)
- #include "services/device/public/cpp/device_features.h"
- #endif
- namespace device {
- namespace {
- // The maximum period of time we'll wait for a complete set of wifi data
- // before sending the request.
- const int kDataCompleteWaitSeconds = 2;
- // The maximum age of a cached network location estimate before it can no longer
- // be returned as a fresh estimate. This should be at least as long as the
- // longest polling interval used by the WifiDataProvider.
- const int kLastPositionMaxAgeSeconds = 10 * 60; // 10 minutes
- } // namespace
- // NetworkLocationProvider
- NetworkLocationProvider::NetworkLocationProvider(
- scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
- GeolocationManager* geolocation_manager,
- const scoped_refptr<base::SingleThreadTaskRunner> main_task_runner,
- const std::string& api_key,
- PositionCache* position_cache)
- : wifi_data_update_callback_(
- base::BindRepeating(&NetworkLocationProvider::OnWifiDataUpdate,
- base::Unretained(this))),
- is_wifi_data_complete_(false),
- position_cache_(position_cache),
- is_permission_granted_(false),
- is_new_data_available_(false),
- request_(new NetworkLocationRequest(
- std::move(url_loader_factory),
- api_key,
- base::BindRepeating(&NetworkLocationProvider::OnLocationResponse,
- base::Unretained(this)))) {
- DCHECK(position_cache_);
- #if BUILDFLAG(IS_MAC)
- geolocation_manager_ = geolocation_manager;
- permission_observers_ = geolocation_manager->GetObserverList();
- permission_observers_->AddObserver(this);
- main_task_runner->PostTaskAndReplyWithResult(
- FROM_HERE,
- base::BindOnce(&GeolocationManager::GetSystemPermission,
- base::Unretained(geolocation_manager)),
- base::BindOnce(&NetworkLocationProvider::OnSystemPermissionUpdated,
- weak_factory_.GetWeakPtr()));
- #endif
- }
- NetworkLocationProvider::~NetworkLocationProvider() {
- DCHECK(thread_checker_.CalledOnValidThread());
- #if BUILDFLAG(IS_MAC)
- permission_observers_->RemoveObserver(this);
- #endif
- if (IsStarted())
- StopProvider();
- }
- void NetworkLocationProvider::SetUpdateCallback(
- const LocationProvider::LocationProviderUpdateCallback& callback) {
- DCHECK(thread_checker_.CalledOnValidThread());
- location_provider_update_callback_ = callback;
- }
- void NetworkLocationProvider::OnPermissionGranted() {
- const bool was_permission_granted = is_permission_granted_;
- is_permission_granted_ = true;
- if (!was_permission_granted && IsStarted())
- RequestPosition();
- }
- void NetworkLocationProvider::OnSystemPermissionUpdated(
- LocationSystemPermissionStatus new_status) {
- is_awaiting_initial_permission_status_ = false;
- const bool was_permission_granted = is_system_permission_granted_;
- is_system_permission_granted_ =
- (new_status == LocationSystemPermissionStatus::kAllowed);
- if (!is_system_permission_granted_ && location_provider_update_callback_) {
- mojom::Geoposition error_position;
- error_position.error_code =
- mojom::Geoposition::ErrorCode::PERMISSION_DENIED;
- error_position.error_message =
- "User has not allowed access to system location.";
- location_provider_update_callback_.Run(this, error_position);
- }
- if (!was_permission_granted && is_system_permission_granted_ && IsStarted()) {
- wifi_data_provider_handle_->ForceRescan();
- OnWifiDataUpdate();
- }
- }
- void NetworkLocationProvider::OnWifiDataUpdate() {
- DCHECK(thread_checker_.CalledOnValidThread());
- DCHECK(IsStarted());
- #if BUILDFLAG(IS_MAC)
- if (!is_system_permission_granted_) {
- if (!is_awaiting_initial_permission_status_) {
- mojom::Geoposition error_position;
- error_position.error_code =
- mojom::Geoposition::ErrorCode::PERMISSION_DENIED;
- error_position.error_message =
- "User has not allowed access to system location.";
- location_provider_update_callback_.Run(this, error_position);
- }
- return;
- }
- #endif
- is_wifi_data_complete_ = wifi_data_provider_handle_->GetData(&wifi_data_);
- if (is_wifi_data_complete_) {
- wifi_timestamp_ = base::Time::Now();
- is_new_data_available_ = true;
- }
- // When RequestPosition is called, the most recent wifi data is sent to the
- // geolocation service. If the wifi data is incomplete but a cached estimate
- // is available, the cached estimate may be returned instead.
- //
- // If no wifi data is available or the data is incomplete, it may mean the
- // provider is still performing the wifi scan. In this case we should wait
- // for the scan to complete rather than return cached data.
- //
- // A lack of wifi data may also mean the scan is delayed due to the wifi
- // scanning policy. This delay can vary based on how frequently the wifi
- // data changes, but is on the order of a few seconds to several minutes.
- // In this case it is better to call RequestPosition and return a cached
- // position estimate if it is available.
- bool delayed = wifi_data_provider_handle_->DelayedByPolicy();
- if (is_wifi_data_complete_ || delayed)
- RequestPosition();
- }
- void NetworkLocationProvider::OnLocationResponse(
- const mojom::Geoposition& position,
- bool server_error,
- const WifiData& wifi_data) {
- DCHECK(thread_checker_.CalledOnValidThread());
- // Record the position and update our cache.
- position_cache_->SetLastUsedNetworkPosition(position);
- if (ValidateGeoposition(position))
- position_cache_->CachePosition(wifi_data, position);
- // Let listeners know that we now have a position available.
- if (!location_provider_update_callback_.is_null()) {
- location_provider_update_callback_.Run(this, position);
- }
- }
- void NetworkLocationProvider::StartProvider(bool high_accuracy) {
- DCHECK(thread_checker_.CalledOnValidThread());
- if (IsStarted())
- return;
- // Registers a callback with the data provider.
- // Releasing the handle will automatically unregister the callback.
- wifi_data_provider_handle_ =
- WifiDataProviderHandle::CreateHandle(&wifi_data_update_callback_);
- base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
- FROM_HERE,
- base::BindOnce(&NetworkLocationProvider::RequestPosition,
- weak_factory_.GetWeakPtr()),
- base::Seconds(kDataCompleteWaitSeconds));
- OnWifiDataUpdate();
- }
- void NetworkLocationProvider::StopProvider() {
- DCHECK(thread_checker_.CalledOnValidThread());
- DCHECK(IsStarted());
- wifi_data_provider_handle_ = nullptr;
- weak_factory_.InvalidateWeakPtrs();
- }
- const mojom::Geoposition& NetworkLocationProvider::GetPosition() {
- return position_cache_->GetLastUsedNetworkPosition();
- }
- void NetworkLocationProvider::RequestPosition() {
- DCHECK(thread_checker_.CalledOnValidThread());
- #if BUILDFLAG(IS_MAC)
- if (!is_system_permission_granted_) {
- return;
- }
- #endif
- // The wifi polling policy may require us to wait for several minutes before
- // fresh wifi data is available. To ensure we can return a position estimate
- // quickly when the network location provider is the primary provider, allow
- // a cached value to be returned under certain conditions.
- //
- // If we have a sufficiently recent network location estimate and we do not
- // expect to receive a new one soon (i.e., no new wifi data is available and
- // there is no pending network request), report the last network position
- // estimate as if it were a fresh estimate.
- const mojom::Geoposition& last_position =
- position_cache_->GetLastUsedNetworkPosition();
- if (!is_new_data_available_ && !request_->is_request_pending() &&
- ValidateGeoposition(last_position)) {
- base::Time now = base::Time::Now();
- base::TimeDelta last_position_age = now - last_position.timestamp;
- if (last_position_age.InSeconds() < kLastPositionMaxAgeSeconds &&
- !location_provider_update_callback_.is_null()) {
- // Update the timestamp to the current time.
- mojom::Geoposition position = last_position;
- position.timestamp = now;
- location_provider_update_callback_.Run(this, position);
- }
- }
- if (!is_new_data_available_ || !is_wifi_data_complete_)
- return;
- DCHECK(!wifi_timestamp_.is_null())
- << "|wifi_timestamp_| must be set before looking up position";
- const mojom::Geoposition* cached_position =
- position_cache_->FindPosition(wifi_data_);
- UMA_HISTOGRAM_BOOLEAN("Geolocation.PositionCache.CacheHit",
- cached_position != nullptr);
- UMA_HISTOGRAM_COUNTS_100("Geolocation.PositionCache.CacheSize",
- position_cache_->GetPositionCacheSize());
- if (cached_position) {
- mojom::Geoposition position(*cached_position);
- DCHECK(ValidateGeoposition(position));
- // The timestamp of a position fix is determined by the timestamp
- // of the source data update. (The value of position.timestamp from
- // the cache could be from weeks ago!)
- position.timestamp = wifi_timestamp_;
- is_new_data_available_ = false;
- // Record the position.
- position_cache_->SetLastUsedNetworkPosition(position);
- // Let listeners know that we now have a position available.
- if (!location_provider_update_callback_.is_null())
- location_provider_update_callback_.Run(this, position);
- return;
- }
- // Don't send network requests until authorized. http://crbug.com/39171
- if (!is_permission_granted_)
- return;
- is_new_data_available_ = false;
- // TODO(joth): Rather than cancel pending requests, we should create a new
- // NetworkLocationRequest for each and hold a set of pending requests.
- DLOG_IF(WARNING, request_->is_request_pending())
- << "NetworkLocationProvider - pre-empting pending network request "
- "with new data. Wifi APs: "
- << wifi_data_.access_point_data.size();
- net::PartialNetworkTrafficAnnotationTag partial_traffic_annotation =
- net::DefinePartialNetworkTrafficAnnotation("network_location_provider",
- "network_location_request",
- R"(
- semantics {
- sender: "Network Location Provider"
- }
- policy {
- setting:
- "Users can control this feature via the Location setting under "
- "'Privacy', 'Content Settings', 'Location'."
- chrome_policy {
- DefaultGeolocationSetting {
- DefaultGeolocationSetting: 2
- }
- }
- })");
- request_->MakeRequest(wifi_data_, wifi_timestamp_,
- partial_traffic_annotation);
- }
- bool NetworkLocationProvider::IsStarted() const {
- return wifi_data_provider_handle_ != nullptr;
- }
- } // namespace device
|