| OLD | NEW |
| 1 // Copyright 2014 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef CHROME_BROWSER_METRICS_METRICS_STATE_MANAGER_H_ | 5 #ifndef CHROME_BROWSER_METRICS_METRICS_STATE_MANAGER_H_ |
| 6 #define CHROME_BROWSER_METRICS_METRICS_STATE_MANAGER_H_ | 6 #define CHROME_BROWSER_METRICS_METRICS_STATE_MANAGER_H_ |
| 7 | 7 |
| 8 #include <string> | 8 #include <string> |
| 9 | 9 |
| 10 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
| 11 #include "base/callback.h" |
| 11 #include "base/gtest_prod_util.h" | 12 #include "base/gtest_prod_util.h" |
| 12 #include "base/memory/scoped_ptr.h" | 13 #include "base/memory/scoped_ptr.h" |
| 13 #include "base/metrics/field_trial.h" | 14 #include "base/metrics/field_trial.h" |
| 14 | 15 |
| 15 class PrefService; | 16 class PrefService; |
| 16 class PrefRegistrySimple; | 17 class PrefRegistrySimple; |
| 17 | 18 |
| 18 namespace metrics { | 19 namespace metrics { |
| 19 | 20 |
| 20 class ClonedInstallDetector; | 21 class ClonedInstallDetector; |
| 21 | 22 |
| 22 // Responsible for managing MetricsService state prefs, specifically the UMA | 23 // Responsible for managing MetricsService state prefs, specifically the UMA |
| 23 // client id and low entropy source. Code outside the metrics directory should | 24 // client id and low entropy source. Code outside the metrics directory should |
| 24 // not be instantiating or using this class directly. | 25 // not be instantiating or using this class directly. |
| 25 class MetricsStateManager { | 26 class MetricsStateManager { |
| 26 public: | 27 public: |
| 27 virtual ~MetricsStateManager(); | 28 virtual ~MetricsStateManager(); |
| 28 | 29 |
| 29 // Returns true if the user opted in to sending metric reports. | 30 // Returns true if the user opted in to sending metric reports. |
| 30 // TODO(asvitkine): This function does not report the correct value on | |
| 31 // Android, see http://crbug.com/362192. | |
| 32 bool IsMetricsReportingEnabled(); | 31 bool IsMetricsReportingEnabled(); |
| 33 | 32 |
| 34 // Returns the client ID for this client, or the empty string if the user is | 33 // Returns the client ID for this client, or the empty string if the user is |
| 35 // not opted in to metrics reporting. | 34 // not opted in to metrics reporting. |
| 36 const std::string& client_id() const { return client_id_; } | 35 const std::string& client_id() const { return client_id_; } |
| 37 | 36 |
| 38 // Forces the client ID to be generated. This is useful in case it's needed | 37 // Forces the client ID to be generated. This is useful in case it's needed |
| 39 // before recording. | 38 // before recording. |
| 40 void ForceClientIdCreation(); | 39 void ForceClientIdCreation(); |
| 41 | 40 |
| 42 // Checks if this install was cloned or imaged from another machine. If a | 41 // Checks if this install was cloned or imaged from another machine. If a |
| 43 // clone is detected, resets the client id and low entropy source. This | 42 // clone is detected, resets the client id and low entropy source. This |
| 44 // should not be called more than once. | 43 // should not be called more than once. |
| 45 void CheckForClonedInstall(); | 44 void CheckForClonedInstall(); |
| 46 | 45 |
| 47 // Returns the preferred entropy provider used to seed persistent activities | 46 // Returns the preferred entropy provider used to seed persistent activities |
| 48 // based on whether or not metrics reporting is permitted on this client. | 47 // based on whether or not metrics reporting is permitted on this client. |
| 49 // | 48 // |
| 50 // If metrics reporting is enabled, this method returns an entropy provider | 49 // If metrics reporting is enabled, this method returns an entropy provider |
| 51 // that has a high source of entropy, partially based on the client ID. | 50 // that has a high source of entropy, partially based on the client ID. |
| 52 // Otherwise, it returns an entropy provider that is based on a low entropy | 51 // Otherwise, it returns an entropy provider that is based on a low entropy |
| 53 // source. | 52 // source. |
| 54 scoped_ptr<const base::FieldTrial::EntropyProvider> CreateEntropyProvider(); | 53 scoped_ptr<const base::FieldTrial::EntropyProvider> CreateEntropyProvider(); |
| 55 | 54 |
| 56 // Creates the MetricsStateManager, enforcing that only a single instance | 55 // Creates the MetricsStateManager, enforcing that only a single instance |
| 57 // of the class exists at a time. Returns NULL if an instance exists already. | 56 // of the class exists at a time. Returns NULL if an instance exists already. |
| 58 static scoped_ptr<MetricsStateManager> Create(PrefService* local_state); | 57 static scoped_ptr<MetricsStateManager> Create( |
| 58 PrefService* local_state, |
| 59 const base::Callback<bool(void)>& is_reporting_enabled_callback); |
| 59 | 60 |
| 60 // Registers local state prefs used by this class. | 61 // Registers local state prefs used by this class. |
| 61 static void RegisterPrefs(PrefRegistrySimple* registry); | 62 static void RegisterPrefs(PrefRegistrySimple* registry); |
| 62 | 63 |
| 63 private: | 64 private: |
| 64 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, EntropySourceUsed_Low); | 65 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, EntropySourceUsed_Low); |
| 65 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, EntropySourceUsed_High); | 66 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, EntropySourceUsed_High); |
| 66 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, LowEntropySource0NotReset); | 67 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, LowEntropySource0NotReset); |
| 67 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, | 68 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, |
| 68 PermutedEntropyCacheClearedWhenLowEntropyReset); | 69 PermutedEntropyCacheClearedWhenLowEntropyReset); |
| 69 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, ResetMetricsIDs); | 70 FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, ResetMetricsIDs); |
| 70 | 71 |
| 71 // Designates which entropy source was returned from this class. | 72 // Designates which entropy source was returned from this class. |
| 72 // This is used for testing to validate that we return the correct source | 73 // This is used for testing to validate that we return the correct source |
| 73 // depending on the state of the service. | 74 // depending on the state of the service. |
| 74 enum EntropySourceType { | 75 enum EntropySourceType { |
| 75 ENTROPY_SOURCE_NONE, | 76 ENTROPY_SOURCE_NONE, |
| 76 ENTROPY_SOURCE_LOW, | 77 ENTROPY_SOURCE_LOW, |
| 77 ENTROPY_SOURCE_HIGH, | 78 ENTROPY_SOURCE_HIGH, |
| 78 }; | 79 }; |
| 79 | 80 |
| 80 // Creates the MetricsStateManager with the given |local_state|. Clients | 81 // Creates the MetricsStateManager with the given |local_state|. Calls |
| 81 // should instead use Create(), which enforces a single instance of this class | 82 // |is_reporting_enabled_callback| to query whether metrics reporting is |
| 82 // is alive at any given time. | 83 // enabled. Clients should instead use Create(), which enforces a single |
| 83 explicit MetricsStateManager(PrefService* local_state); | 84 // instance of this class is alive at any given time. |
| 85 MetricsStateManager( |
| 86 PrefService* local_state, |
| 87 const base::Callback<bool(void)>& is_reporting_enabled_callback); |
| 84 | 88 |
| 85 // Returns the low entropy source for this client. This is a random value | 89 // Returns the low entropy source for this client. This is a random value |
| 86 // that is non-identifying amongst browser clients. This method will | 90 // that is non-identifying amongst browser clients. This method will |
| 87 // generate the entropy source value if it has not been called before. | 91 // generate the entropy source value if it has not been called before. |
| 88 int GetLowEntropySource(); | 92 int GetLowEntropySource(); |
| 89 | 93 |
| 90 // Returns the first entropy source that was returned by this service since | 94 // Returns the first entropy source that was returned by this service since |
| 91 // start up, or NONE if neither was returned yet. This is exposed for testing | 95 // start up, or NONE if neither was returned yet. This is exposed for testing |
| 92 // only. | 96 // only. |
| 93 EntropySourceType entropy_source_returned() const { | 97 EntropySourceType entropy_source_returned() const { |
| 94 return entropy_source_returned_; | 98 return entropy_source_returned_; |
| 95 } | 99 } |
| 96 | 100 |
| 97 // Reset the client id and low entropy source if the kMetricsResetMetricIDs | 101 // Reset the client id and low entropy source if the kMetricsResetMetricIDs |
| 98 // pref is true. | 102 // pref is true. |
| 99 void ResetMetricsIDsIfNecessary(); | 103 void ResetMetricsIDsIfNecessary(); |
| 100 | 104 |
| 101 // Whether an instance of this class exists. Used to enforce that there aren't | 105 // Whether an instance of this class exists. Used to enforce that there aren't |
| 102 // multiple instances of this class at a given time. | 106 // multiple instances of this class at a given time. |
| 103 static bool instance_exists_; | 107 static bool instance_exists_; |
| 104 | 108 |
| 105 // Weak pointer to the local state prefs store. | 109 // Weak pointer to the local state prefs store. |
| 106 PrefService* local_state_; | 110 PrefService* const local_state_; |
| 111 |
| 112 const base::Callback<bool(void)> is_reporting_enabled_callback_; |
| 107 | 113 |
| 108 // The identifier that's sent to the server with the log reports. | 114 // The identifier that's sent to the server with the log reports. |
| 109 std::string client_id_; | 115 std::string client_id_; |
| 110 | 116 |
| 111 // The non-identifying low entropy source value. | 117 // The non-identifying low entropy source value. |
| 112 int low_entropy_source_; | 118 int low_entropy_source_; |
| 113 | 119 |
| 114 // The last entropy source returned by this service, used for testing. | 120 // The last entropy source returned by this service, used for testing. |
| 115 EntropySourceType entropy_source_returned_; | 121 EntropySourceType entropy_source_returned_; |
| 116 | 122 |
| 117 scoped_ptr<ClonedInstallDetector> cloned_install_detector_; | 123 scoped_ptr<ClonedInstallDetector> cloned_install_detector_; |
| 118 | 124 |
| 119 DISALLOW_COPY_AND_ASSIGN(MetricsStateManager); | 125 DISALLOW_COPY_AND_ASSIGN(MetricsStateManager); |
| 120 }; | 126 }; |
| 121 | 127 |
| 122 } // namespace metrics | 128 } // namespace metrics |
| 123 | 129 |
| 124 #endif // CHROME_BROWSER_METRICS_METRICS_STATE_MANAGER_H_ | 130 #endif // CHROME_BROWSER_METRICS_METRICS_STATE_MANAGER_H_ |
| OLD | NEW |