chrome/browser/safe_browsing/incident_reporting/state_store.cc

   1 // Copyright 2015 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 "chrome/browser/safe_browsing/incident_reporting/state_store.h"
   6
   7 #include "base/prefs/pref_service.h"
   8 #include "base/strings/string_number_conversions.h"
   9 #include "base/values.h"
  10 #include "chrome/browser/profiles/profile.h"
  11 #include "chrome/browser/safe_browsing/incident_reporting/incident.h"
  12 #include "chrome/common/pref_names.h"
  13
  14 namespace safe_browsing {
  15
  16 // StateStore::Transaction -----------------------------------------------------
  17
  18 StateStore::Transaction::Transaction(StateStore* store) : store_(store) {
  19 #if DCHECK_IS_ON()
  20   DCHECK(!store_->has_transaction_);
  21   store_->has_transaction_ = true;
  22 #endif
  23 }
  24
  25 StateStore::Transaction::~Transaction() {
  26 #if DCHECK_IS_ON()
  27   store_->has_transaction_ = false;
  28 #endif
  29 }
  30
  31 void StateStore::Transaction::MarkAsReported(IncidentType type,
  32                                              const std::string& key,
  33                                              IncidentDigest digest) {
  34   std::string type_string(base::IntToString(static_cast<int32_t>(type)));
  35   base::DictionaryValue* incidents_sent = GetPrefDict();
  36   base::DictionaryValue* type_dict = nullptr;
  37   if (!incidents_sent->GetDictionaryWithoutPathExpansion(type_string,
  38                                                          &type_dict)) {
  39     type_dict = new base::DictionaryValue();
  40     incidents_sent->SetWithoutPathExpansion(type_string, type_dict);
  41   }
  42   type_dict->SetStringWithoutPathExpansion(key, base::UintToString(digest));
  43 }
  44
  45 void StateStore::Transaction::ClearForType(IncidentType type) {
  46   // Nothing to do if the pref dict does not exist.
  47   if (!store_->incidents_sent_)
  48     return;
  49
  50   // Use the read-only view on the preference to figure out if there is a value
  51   // to remove before committing to making a change since any use of GetPrefDict
  52   // will result in a full serialize-and-write operation on the preferences
  53   // store.
  54   std::string type_string(base::IntToString(static_cast<int32_t>(type)));
  55   const base::DictionaryValue* type_dict = nullptr;
  56   if (store_->incidents_sent_->GetDictionaryWithoutPathExpansion(type_string,
  57                                                                  &type_dict)) {
  58     GetPrefDict()->RemoveWithoutPathExpansion(type_string, nullptr);
  59   }
  60 }
  61
  62 base::DictionaryValue* StateStore::Transaction::GetPrefDict() {
  63   if (!pref_update_) {
  64     pref_update_.reset(new DictionaryPrefUpdate(
  65         store_->profile_->GetPrefs(), prefs::kSafeBrowsingIncidentsSent));
  66     // Getting the dict will cause it to be created if it doesn't exist.
  67     // Unconditionally refresh the store's read-only view on the preference so
  68     // that it will always be correct.
  69     store_->incidents_sent_ = pref_update_->Get();
  70   }
  71   return pref_update_->Get();
  72 }
  73
  74
  75 // StateStore ------------------------------------------------------------------
  76
  77 StateStore::StateStore(Profile* profile)
  78     : profile_(profile),
  79       incidents_sent_(nullptr)
  80 #if DCHECK_IS_ON()
  81       ,
  82       has_transaction_(false)
  83 #endif
  84 {
  85   // Cache a read-only view of the preference.
  86   const base::Value* value =
  87       profile_->GetPrefs()->GetUserPrefValue(prefs::kSafeBrowsingIncidentsSent);
  88   if (value)
  89     value->GetAsDictionary(&incidents_sent_);
  90
  91   Transaction transaction(this);
  92   CleanLegacyValues(&transaction);
  93 }
  94
  95 StateStore::~StateStore() {
  96 #if DCHECK_IS_ON()
  97   DCHECK(!has_transaction_);
  98 #endif
  99 }
 100
 101 bool StateStore::HasBeenReported(IncidentType type,
 102                                  const std::string& key,
 103                                  IncidentDigest digest) {
 104   const base::DictionaryValue* type_dict = nullptr;
 105   std::string digest_string;
 106   return (incidents_sent_ &&
 107           incidents_sent_->GetDictionaryWithoutPathExpansion(
 108               base::IntToString(static_cast<int32_t>(type)), &type_dict) &&
 109           type_dict->GetStringWithoutPathExpansion(key, &digest_string) &&
 110           digest_string == base::UintToString(digest));
 111 }
 112
 113 void StateStore::CleanLegacyValues(Transaction* transaction) {
 114   static const IncidentType kLegacyTypes[] = {
 115       // TODO(grt): remove in M44 (crbug.com/451173).
 116       IncidentType::OMNIBOX_INTERACTION,
 117   };
 118
 119   for (IncidentType type : kLegacyTypes)
 120     transaction->ClearForType(type);
 121 }
 122
 123 }  // namespace safe_browsing