1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
|
// 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 "components/metrics/metrics_state_manager.h"
#include "base/command_line.h"
#include "base/guid.h"
#include "base/metrics/histogram.h"
#include "base/metrics/sparse_histogram.h"
#include "base/prefs/pref_registry_simple.h"
#include "base/prefs/pref_service.h"
#include "base/rand_util.h"
#include "base/strings/string_number_conversions.h"
#include "base/threading/thread_restrictions.h"
#include "base/time/time.h"
#include "components/metrics/cloned_install_detector.h"
#include "components/metrics/machine_id_provider.h"
#include "components/metrics/metrics_pref_names.h"
#include "components/metrics/metrics_switches.h"
#include "components/variations/caching_permuted_entropy_provider.h"
namespace metrics {
namespace {
// The argument used to generate a non-identifying entropy source. We want no
// more than 13 bits of entropy, so use this max to return a number in the range
// [0, 7999] as the entropy source (12.97 bits of entropy).
const int kMaxLowEntropySize = 8000;
// Default prefs value for prefs::kMetricsLowEntropySource to indicate that
// the value has not yet been set.
const int kLowEntropySourceNotSet = -1;
// Generates a new non-identifying entropy source used to seed persistent
// activities.
int GenerateLowEntropySource() {
return base::RandInt(0, kMaxLowEntropySize - 1);
}
} // namespace
// static
bool MetricsStateManager::instance_exists_ = false;
MetricsStateManager::MetricsStateManager(
PrefService* local_state,
const base::Callback<bool(void)>& is_reporting_enabled_callback,
const StoreClientInfoCallback& store_client_info,
const LoadClientInfoCallback& retrieve_client_info)
: local_state_(local_state),
is_reporting_enabled_callback_(is_reporting_enabled_callback),
store_client_info_(store_client_info),
load_client_info_(retrieve_client_info),
low_entropy_source_(kLowEntropySourceNotSet),
entropy_source_returned_(ENTROPY_SOURCE_NONE) {
ResetMetricsIDsIfNecessary();
if (IsMetricsReportingEnabled())
ForceClientIdCreation();
DCHECK(!instance_exists_);
instance_exists_ = true;
}
MetricsStateManager::~MetricsStateManager() {
DCHECK(instance_exists_);
instance_exists_ = false;
}
bool MetricsStateManager::IsMetricsReportingEnabled() {
return is_reporting_enabled_callback_.Run();
}
void MetricsStateManager::ForceClientIdCreation() {
if (!client_id_.empty())
return;
client_id_ = local_state_->GetString(prefs::kMetricsClientID);
if (!client_id_.empty()) {
// It is technically sufficient to only save a backup of the client id when
// it is initially generated below, but since the backup was only introduced
// in M38, seed it explicitly from here for some time.
BackUpCurrentClientInfo();
return;
}
const scoped_ptr<ClientInfo> client_info_backup =
LoadClientInfoAndMaybeMigrate();
if (client_info_backup) {
client_id_ = client_info_backup->client_id;
const base::Time now = base::Time::Now();
// Save the recovered client id and also try to reinstantiate the backup
// values for the dates corresponding with that client id in order to avoid
// weird scenarios where we could report an old client id with a recent
// install date.
local_state_->SetString(prefs::kMetricsClientID, client_id_);
local_state_->SetInt64(prefs::kInstallDate,
client_info_backup->installation_date != 0
? client_info_backup->installation_date
: now.ToTimeT());
local_state_->SetInt64(prefs::kMetricsReportingEnabledTimestamp,
client_info_backup->reporting_enabled_date != 0
? client_info_backup->reporting_enabled_date
: now.ToTimeT());
base::TimeDelta recovered_installation_age;
if (client_info_backup->installation_date != 0) {
recovered_installation_age =
now - base::Time::FromTimeT(client_info_backup->installation_date);
}
UMA_HISTOGRAM_COUNTS_10000("UMA.ClientIdBackupRecoveredWithAge",
recovered_installation_age.InHours());
// Flush the backup back to persistent storage in case we re-generated
// missing data above.
BackUpCurrentClientInfo();
return;
}
// Failing attempts at getting an existing client ID, generate a new one.
client_id_ = base::GenerateGUID();
local_state_->SetString(prefs::kMetricsClientID, client_id_);
if (local_state_->GetString(prefs::kMetricsOldClientID).empty()) {
// Record the timestamp of when the user opted in to UMA.
local_state_->SetInt64(prefs::kMetricsReportingEnabledTimestamp,
base::Time::Now().ToTimeT());
} else {
UMA_HISTOGRAM_BOOLEAN("UMA.ClientIdMigrated", true);
}
local_state_->ClearPref(prefs::kMetricsOldClientID);
BackUpCurrentClientInfo();
}
void MetricsStateManager::CheckForClonedInstall(
scoped_refptr<base::SingleThreadTaskRunner> task_runner) {
DCHECK(!cloned_install_detector_);
MachineIdProvider* provider = MachineIdProvider::CreateInstance();
if (!provider)
return;
cloned_install_detector_.reset(new ClonedInstallDetector(provider));
cloned_install_detector_->CheckForClonedInstall(local_state_, task_runner);
}
scoped_ptr<const base::FieldTrial::EntropyProvider>
MetricsStateManager::CreateEntropyProvider() {
// For metrics reporting-enabled users, we combine the client ID and low
// entropy source to get the final entropy source. Otherwise, only use the low
// entropy source.
// This has two useful properties:
// 1) It makes the entropy source less identifiable for parties that do not
// know the low entropy source.
// 2) It makes the final entropy source resettable.
const int low_entropy_source_value = GetLowEntropySource();
UMA_HISTOGRAM_SPARSE_SLOWLY("UMA.LowEntropySourceValue",
low_entropy_source_value);
if (IsMetricsReportingEnabled()) {
if (entropy_source_returned_ == ENTROPY_SOURCE_NONE)
entropy_source_returned_ = ENTROPY_SOURCE_HIGH;
const std::string high_entropy_source =
client_id_ + base::IntToString(low_entropy_source_value);
return scoped_ptr<const base::FieldTrial::EntropyProvider>(
new SHA1EntropyProvider(high_entropy_source));
}
if (entropy_source_returned_ == ENTROPY_SOURCE_NONE)
entropy_source_returned_ = ENTROPY_SOURCE_LOW;
#if defined(OS_ANDROID) || defined(OS_IOS)
return scoped_ptr<const base::FieldTrial::EntropyProvider>(
new CachingPermutedEntropyProvider(local_state_,
low_entropy_source_value,
kMaxLowEntropySize));
#else
return scoped_ptr<const base::FieldTrial::EntropyProvider>(
new PermutedEntropyProvider(low_entropy_source_value,
kMaxLowEntropySize));
#endif
}
// static
scoped_ptr<MetricsStateManager> MetricsStateManager::Create(
PrefService* local_state,
const base::Callback<bool(void)>& is_reporting_enabled_callback,
const StoreClientInfoCallback& store_client_info,
const LoadClientInfoCallback& retrieve_client_info) {
scoped_ptr<MetricsStateManager> result;
// Note: |instance_exists_| is updated in the constructor and destructor.
if (!instance_exists_) {
result.reset(new MetricsStateManager(local_state,
is_reporting_enabled_callback,
store_client_info,
retrieve_client_info));
}
return result.Pass();
}
// static
void MetricsStateManager::RegisterPrefs(PrefRegistrySimple* registry) {
registry->RegisterBooleanPref(prefs::kMetricsResetIds, false);
registry->RegisterStringPref(prefs::kMetricsClientID, std::string());
registry->RegisterInt64Pref(prefs::kMetricsReportingEnabledTimestamp, 0);
registry->RegisterIntegerPref(prefs::kMetricsLowEntropySource,
kLowEntropySourceNotSet);
ClonedInstallDetector::RegisterPrefs(registry);
CachingPermutedEntropyProvider::RegisterPrefs(registry);
// TODO(asvitkine): Remove these once a couple of releases have passed.
// http://crbug.com/357704
registry->RegisterStringPref(prefs::kMetricsOldClientID, std::string());
registry->RegisterIntegerPref(prefs::kMetricsOldLowEntropySource, 0);
}
void MetricsStateManager::BackUpCurrentClientInfo() {
// TODO(gayane): Eliminate use of ScopedAllowIO. crbug.com/413783
base::ThreadRestrictions::ScopedAllowIO allow_io;
ClientInfo client_info;
client_info.client_id = client_id_;
client_info.installation_date = local_state_->GetInt64(prefs::kInstallDate);
client_info.reporting_enabled_date =
local_state_->GetInt64(prefs::kMetricsReportingEnabledTimestamp);
store_client_info_.Run(client_info);
}
scoped_ptr<ClientInfo> MetricsStateManager::LoadClientInfoAndMaybeMigrate() {
scoped_ptr<ClientInfo> client_info = load_client_info_.Run();
// Prior to 2014-07, the client ID was stripped of its dashes before being
// saved. Migrate back to a proper GUID if this is the case. This migration
// code can be removed in M41+.
const size_t kGUIDLengthWithoutDashes = 32U;
if (client_info &&
client_info->client_id.length() == kGUIDLengthWithoutDashes) {
DCHECK(client_info->client_id.find('-') == std::string::npos);
std::string client_id_with_dashes;
client_id_with_dashes.reserve(kGUIDLengthWithoutDashes + 4U);
std::string::const_iterator client_id_it = client_info->client_id.begin();
for (size_t i = 0; i < kGUIDLengthWithoutDashes + 4U; ++i) {
if (i == 8U || i == 13U || i == 18U || i == 23U) {
client_id_with_dashes.push_back('-');
} else {
client_id_with_dashes.push_back(*client_id_it);
++client_id_it;
}
}
DCHECK(client_id_it == client_info->client_id.end());
client_info->client_id.assign(client_id_with_dashes);
}
// The GUID retrieved (and possibly fixed above) should be valid unless
// retrieval failed.
DCHECK(!client_info || base::IsValidGUID(client_info->client_id));
return client_info.Pass();
}
int MetricsStateManager::GetLowEntropySource() {
// Note that the default value for the low entropy source and the default pref
// value are both kLowEntropySourceNotSet, which is used to identify if the
// value has been set or not.
if (low_entropy_source_ != kLowEntropySourceNotSet)
return low_entropy_source_;
const base::CommandLine* command_line(base::CommandLine::ForCurrentProcess());
// Only try to load the value from prefs if the user did not request a
// reset.
// Otherwise, skip to generating a new value.
if (!command_line->HasSwitch(switches::kResetVariationState)) {
int value = local_state_->GetInteger(prefs::kMetricsLowEntropySource);
// If the value is outside the [0, kMaxLowEntropySize) range, re-generate
// it below.
if (value >= 0 && value < kMaxLowEntropySize) {
low_entropy_source_ = value;
UMA_HISTOGRAM_BOOLEAN("UMA.GeneratedLowEntropySource", false);
return low_entropy_source_;
}
}
UMA_HISTOGRAM_BOOLEAN("UMA.GeneratedLowEntropySource", true);
low_entropy_source_ = GenerateLowEntropySource();
local_state_->SetInteger(prefs::kMetricsLowEntropySource,
low_entropy_source_);
local_state_->ClearPref(prefs::kMetricsOldLowEntropySource);
CachingPermutedEntropyProvider::ClearCache(local_state_);
return low_entropy_source_;
}
void MetricsStateManager::ResetMetricsIDsIfNecessary() {
if (!local_state_->GetBoolean(prefs::kMetricsResetIds))
return;
UMA_HISTOGRAM_BOOLEAN("UMA.MetricsIDsReset", true);
DCHECK(client_id_.empty());
DCHECK_EQ(kLowEntropySourceNotSet, low_entropy_source_);
local_state_->ClearPref(prefs::kMetricsClientID);
local_state_->ClearPref(prefs::kMetricsLowEntropySource);
local_state_->ClearPref(prefs::kMetricsResetIds);
// Also clear the backed up client info.
store_client_info_.Run(ClientInfo());
}
} // namespace metrics
|