src/components/rappor/rappor_service.h

   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 #ifndef COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_
   6 #define COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_
   7
   8 #include <map>
   9 #include <string>
  10
  11 #include "base/basictypes.h"
  12 #include "base/macros.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/timer/timer.h"
  15
  16 class PrefRegistrySimple;
  17 class PrefService;
  18
  19 namespace net {
  20 class URLRequestContextGetter;
  21 }
  22
  23 namespace rappor {
  24
  25 class LogUploader;
  26 class RapporMetric;
  27 class RapporReports;
  28 struct RapporParameters;
  29
  30 // The type of data stored in a metric.
  31 enum RapporType {
  32   // For sampling the eTLD+1 of a URL.
  33   ETLD_PLUS_ONE_RAPPOR_TYPE = 0,
  34   NUM_RAPPOR_TYPES
  35 };
  36
  37 // This class provides an interface for recording samples for rappor metrics,
  38 // and periodically generates and uploads reports based on the collected data.
  39 class RapporService {
  40  public:
  41   RapporService();
  42   virtual ~RapporService();
  43
  44   // Starts the periodic generation of reports and upload attempts.
  45   void Start(PrefService* pref_service,
  46              net::URLRequestContextGetter* context,
  47              bool metrics_enabled);
  48
  49   // Records a sample of the rappor metric specified by |metric_name|.
  50   // Creates and initializes the metric, if it doesn't yet exist.
  51   void RecordSample(const std::string& metric_name,
  52                     RapporType type,
  53                     const std::string& sample);
  54
  55   // Sets the cohort value.  For use by tests only.
  56   void SetCohortForTesting(uint32_t cohort) { cohort_ = cohort; }
  57
  58   // Sets the secret value.  For use by tests only.
  59   void SetSecretForTesting(const std::string& secret) { secret_ = secret; }
  60
  61   // Registers the names of all of the preferences used by RapporService in the
  62   // provided PrefRegistry. This should be called before calling Start().
  63   static void RegisterPrefs(PrefRegistrySimple* registry);
  64
  65  protected:
  66   // Logs all of the collected metrics to the reports proto message and clears
  67   // the internal map.  Exposed for tests.  Returns true if any metrics were
  68   // recorded.
  69   bool ExportMetrics(RapporReports* reports);
  70
  71   // Records a sample of the rappor metric specified by |parameters|.
  72   // Creates and initializes the metric, if it doesn't yet exist.
  73   // Exposed for tests.
  74   void RecordSampleInternal(const std::string& metric_name,
  75                             const RapporParameters& parameters,
  76                             const std::string& sample);
  77
  78  private:
  79   // Check if the service has been started successfully.
  80   bool IsInitialized() const;
  81
  82   // Retrieves the cohort number this client was assigned to, generating it if
  83   // doesn't already exist.  The cohort should be persistent.
  84   void LoadCohort(PrefService* pref_service);
  85
  86   // Retrieves the value for secret_ from preferences, generating it if doesn't
  87   // already exist.  The secret should be persistent, so that additional bits
  88   // from the client do not get exposed over time.
  89   void LoadSecret(PrefService* pref_service);
  90
  91   // Called whenever the logging interval elapses to generate a new log of
  92   // reports and pass it to the uploader.
  93   void OnLogInterval();
  94
  95   // Finds a metric in the metrics_map_, creating it if it doesn't already
  96   // exist.
  97   RapporMetric* LookUpMetric(const std::string& metric_name,
  98                              const RapporParameters& parameters);
  99
 100   // Client-side secret used to generate fake bits.
 101   std::string secret_;
 102
 103   // The cohort this client is assigned to. -1 is uninitialized.
 104   int32_t cohort_;
 105
 106   // Timer which schedules calls to OnLogInterval().
 107   base::OneShotTimer<RapporService> log_rotation_timer_;
 108
 109   // A private LogUploader instance for sending reports to the server.
 110   scoped_ptr<LogUploader> uploader_;
 111
 112   // We keep all registered metrics in a map, from name to metric.
 113   // The map owns the metrics it contains.
 114   std::map<std::string, RapporMetric*> metrics_map_;
 115
 116   DISALLOW_COPY_AND_ASSIGN(RapporService);
 117 };
 118
 119 }  // namespace rappor
 120
 121 #endif  // COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_