content/browser/geolocation/geolocation_service_impl.cc

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "content/browser/geolocation/geolocation_service_impl.h"
   6
   7 #include "base/bind.h"
   8 #include "base/metrics/histogram.h"
   9 #include "content/browser/geolocation/geolocation_service_context.h"
  10 #include "content/public/common/mojo_geoposition.mojom.h"
  11
  12 namespace content {
  13
  14 namespace {
  15
  16 // Geoposition error codes for reporting in UMA.
  17 enum GeopositionErrorCode {
  18   // NOTE: Do not renumber these as that would confuse interpretation of
  19   // previously logged data. When making changes, also update the enum list
  20   // in tools/metrics/histograms/histograms.xml to keep it in sync.
  21
  22   // There was no error.
  23   GEOPOSITION_ERROR_CODE_NONE = 0,
  24
  25   // User denied use of geolocation.
  26   GEOPOSITION_ERROR_CODE_PERMISSION_DENIED = 1,
  27
  28   // Geoposition could not be determined.
  29   GEOPOSITION_ERROR_CODE_POSITION_UNAVAILABLE = 2,
  30
  31   // Timeout.
  32   GEOPOSITION_ERROR_CODE_TIMEOUT = 3,
  33
  34   // NOTE: Add entries only immediately above this line.
  35   GEOPOSITION_ERROR_CODE_COUNT = 4
  36 };
  37
  38 void RecordGeopositionErrorCode(Geoposition::ErrorCode error_code) {
  39   GeopositionErrorCode code = GEOPOSITION_ERROR_CODE_NONE;
  40   switch (error_code) {
  41     case Geoposition::ERROR_CODE_NONE:
  42       code = GEOPOSITION_ERROR_CODE_NONE;
  43       break;
  44     case Geoposition::ERROR_CODE_PERMISSION_DENIED:
  45       code = GEOPOSITION_ERROR_CODE_PERMISSION_DENIED;
  46       break;
  47     case Geoposition::ERROR_CODE_POSITION_UNAVAILABLE:
  48       code = GEOPOSITION_ERROR_CODE_POSITION_UNAVAILABLE;
  49       break;
  50     case Geoposition::ERROR_CODE_TIMEOUT:
  51       code = GEOPOSITION_ERROR_CODE_TIMEOUT;
  52       break;
  53   }
  54   UMA_HISTOGRAM_ENUMERATION("Geolocation.LocationUpdate.ErrorCode",
  55                             code,
  56                             GEOPOSITION_ERROR_CODE_COUNT);
  57 }
  58
  59 }  // namespace
  60
  61 GeolocationServiceImpl::GeolocationServiceImpl(
  62     GeolocationServiceContext* context,
  63     const base::Closure& update_callback)
  64     : context_(context),
  65       update_callback_(update_callback),
  66       high_accuracy_(false),
  67       has_position_to_report_(false) {
  68   DCHECK(context_);
  69 }
  70
  71 GeolocationServiceImpl::~GeolocationServiceImpl() {
  72   // Make sure to respond to any pending callback even without a valid position.
  73   if (!position_callback_.is_null()) {
  74     if (!current_position_.valid) {
  75       current_position_.error_code = MojoGeoposition::ErrorCode(
  76           GEOPOSITION_ERROR_CODE_POSITION_UNAVAILABLE);
  77       current_position_.error_message = mojo::String("");
  78     }
  79     ReportCurrentPosition();
  80   }
  81 }
  82
  83 void GeolocationServiceImpl::PauseUpdates() {
  84   geolocation_subscription_.reset();
  85 }
  86
  87 void GeolocationServiceImpl::ResumeUpdates() {
  88   if (position_override_.Validate()) {
  89     OnLocationUpdate(position_override_);
  90     return;
  91   }
  92
  93   StartListeningForUpdates();
  94 }
  95
  96 void GeolocationServiceImpl::StartListeningForUpdates() {
  97   geolocation_subscription_ =
  98       GeolocationProvider::GetInstance()->AddLocationUpdateCallback(
  99           base::Bind(&GeolocationServiceImpl::OnLocationUpdate,
 100                      base::Unretained(this)),
 101           high_accuracy_);
 102 }
 103
 104 void GeolocationServiceImpl::SetHighAccuracy(bool high_accuracy) {
 105   UMA_HISTOGRAM_BOOLEAN(
 106       "Geolocation.GeolocationDispatcherHostImpl.EnableHighAccuracy",
 107       high_accuracy);
 108   high_accuracy_ = high_accuracy;
 109
 110   if (position_override_.Validate()) {
 111     OnLocationUpdate(position_override_);
 112     return;
 113   }
 114
 115   StartListeningForUpdates();
 116 }
 117
 118 void GeolocationServiceImpl::QueryNextPosition(
 119     const PositionCallback& callback) {
 120   if (!position_callback_.is_null()) {
 121     DVLOG(1) << "Overlapped call to QueryNextPosition!";
 122     OnConnectionError();  // Simulate a connection error.
 123     return;
 124   }
 125
 126   position_callback_ = callback;
 127
 128   if (has_position_to_report_)
 129     ReportCurrentPosition();
 130 }
 131
 132 void GeolocationServiceImpl::SetOverride(const Geoposition& position) {
 133   position_override_ = position;
 134   if (!position_override_.Validate()) {
 135     ResumeUpdates();
 136   }
 137
 138   geolocation_subscription_.reset();
 139
 140   OnLocationUpdate(position_override_);
 141 }
 142
 143 void GeolocationServiceImpl::ClearOverride() {
 144   position_override_ = Geoposition();
 145   StartListeningForUpdates();
 146 }
 147
 148 void GeolocationServiceImpl::OnConnectionError() {
 149   context_->ServiceHadConnectionError(this);
 150
 151   // The above call deleted this instance, so the only safe thing to do is
 152   // return.
 153 }
 154
 155 void GeolocationServiceImpl::OnLocationUpdate(const Geoposition& position) {
 156   RecordGeopositionErrorCode(position.error_code);
 157   DCHECK(context_);
 158
 159   if (context_->paused())
 160     return;
 161
 162   update_callback_.Run();
 163
 164   current_position_.valid = position.Validate();
 165   current_position_.latitude = position.latitude;
 166   current_position_.longitude = position.longitude;
 167   current_position_.altitude = position.altitude;
 168   current_position_.accuracy = position.accuracy;
 169   current_position_.altitude_accuracy = position.altitude_accuracy;
 170   current_position_.heading = position.heading;
 171   current_position_.speed = position.speed;
 172   current_position_.timestamp = position.timestamp.ToDoubleT();
 173   current_position_.error_code =
 174       MojoGeoposition::ErrorCode(position.error_code);
 175   current_position_.error_message = position.error_message;
 176
 177   has_position_to_report_ = true;
 178
 179   if (!position_callback_.is_null())
 180     ReportCurrentPosition();
 181 }
 182
 183 void GeolocationServiceImpl::ReportCurrentPosition() {
 184   position_callback_.Run(current_position_.Clone());
 185   position_callback_.reset();
 186   has_position_to_report_ = false;
 187 }
 188
 189 }  // namespace content