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     mojo::InterfaceRequest<GeolocationService> request,
  63     GeolocationServiceContext* context,
  64     const base::Closure& update_callback)
  65     : binding_(this, request.Pass()),
  66       context_(context),
  67       update_callback_(update_callback),
  68       high_accuracy_(false),
  69       has_position_to_report_(false) {
  70   DCHECK(context_);
  71   binding_.set_error_handler(this);
  72 }
  73
  74 GeolocationServiceImpl::~GeolocationServiceImpl() {
  75   // Make sure to respond to any pending callback even without a valid position.
  76   if (!position_callback_.is_null()) {
  77     if (!current_position_.valid) {
  78       current_position_.error_code = MojoGeoposition::ErrorCode(
  79           GEOPOSITION_ERROR_CODE_POSITION_UNAVAILABLE);
  80       current_position_.error_message = mojo::String("");
  81     }
  82     ReportCurrentPosition();
  83   }
  84 }
  85
  86 void GeolocationServiceImpl::PauseUpdates() {
  87   geolocation_subscription_.reset();
  88 }
  89
  90 void GeolocationServiceImpl::ResumeUpdates() {
  91   if (position_override_.Validate()) {
  92     OnLocationUpdate(position_override_);
  93     return;
  94   }
  95
  96   StartListeningForUpdates();
  97 }
  98
  99 void GeolocationServiceImpl::StartListeningForUpdates() {
 100   geolocation_subscription_ =
 101       GeolocationProvider::GetInstance()->AddLocationUpdateCallback(
 102           base::Bind(&GeolocationServiceImpl::OnLocationUpdate,
 103                      base::Unretained(this)),
 104           high_accuracy_);
 105 }
 106
 107 void GeolocationServiceImpl::SetHighAccuracy(bool high_accuracy) {
 108   UMA_HISTOGRAM_BOOLEAN(
 109       "Geolocation.GeolocationDispatcherHostImpl.EnableHighAccuracy",
 110       high_accuracy);
 111   high_accuracy_ = high_accuracy;
 112
 113   if (position_override_.Validate()) {
 114     OnLocationUpdate(position_override_);
 115     return;
 116   }
 117
 118   StartListeningForUpdates();
 119 }
 120
 121 void GeolocationServiceImpl::QueryNextPosition(
 122     const PositionCallback& callback) {
 123   if (!position_callback_.is_null()) {
 124     DVLOG(1) << "Overlapped call to QueryNextPosition!";
 125     OnConnectionError();  // Simulate a connection error.
 126     return;
 127   }
 128
 129   position_callback_ = callback;
 130
 131   if (has_position_to_report_)
 132     ReportCurrentPosition();
 133 }
 134
 135 void GeolocationServiceImpl::SetOverride(const Geoposition& position) {
 136   position_override_ = position;
 137   if (!position_override_.Validate()) {
 138     ResumeUpdates();
 139   }
 140
 141   geolocation_subscription_.reset();
 142
 143   OnLocationUpdate(position_override_);
 144 }
 145
 146 void GeolocationServiceImpl::ClearOverride() {
 147   position_override_ = Geoposition();
 148   StartListeningForUpdates();
 149 }
 150
 151 void GeolocationServiceImpl::OnConnectionError() {
 152   context_->ServiceHadConnectionError(this);
 153
 154   // The above call deleted this instance, so the only safe thing to do is
 155   // return.
 156 }
 157
 158 void GeolocationServiceImpl::OnLocationUpdate(const Geoposition& position) {
 159   RecordGeopositionErrorCode(position.error_code);
 160   DCHECK(context_);
 161
 162   if (context_->paused())
 163     return;
 164
 165   update_callback_.Run();
 166
 167   current_position_.valid = position.Validate();
 168   current_position_.latitude = position.latitude;
 169   current_position_.longitude = position.longitude;
 170   current_position_.altitude = position.altitude;
 171   current_position_.accuracy = position.accuracy;
 172   current_position_.altitude_accuracy = position.altitude_accuracy;
 173   current_position_.heading = position.heading;
 174   current_position_.speed = position.speed;
 175   current_position_.timestamp = position.timestamp.ToDoubleT();
 176   current_position_.error_code =
 177       MojoGeoposition::ErrorCode(position.error_code);
 178   current_position_.error_message = position.error_message;
 179
 180   has_position_to_report_ = true;
 181
 182   if (!position_callback_.is_null())
 183     ReportCurrentPosition();
 184 }
 185
 186 void GeolocationServiceImpl::ReportCurrentPosition() {
 187   position_callback_.Run(current_position_.Clone());
 188   position_callback_.reset();
 189   has_position_to_report_ = false;
 190 }
 191
 192 }  // namespace content