components/suggestions/suggestions_store.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 "components/suggestions/suggestions_store.h"
   6
   7 #include <string>
   8
   9 #include "base/base64.h"
  10 #include "base/prefs/pref_service.h"
  11 #include "base/time/default_clock.h"
  12 #include "base/time/time.h"
  13 #include "components/pref_registry/pref_registry_syncable.h"
  14 #include "components/suggestions/suggestions_pref_names.h"
  15
  16 namespace suggestions {
  17
  18 SuggestionsStore::SuggestionsStore(PrefService* profile_prefs)
  19     : pref_service_(profile_prefs), clock_(new base::DefaultClock()) {
  20   DCHECK(profile_prefs);
  21 }
  22
  23 SuggestionsStore::SuggestionsStore() {
  24 }
  25
  26 SuggestionsStore::~SuggestionsStore() {}
  27
  28 void SuggestionsStore::SetClockForTesting(scoped_ptr<base::Clock> test_clock) {
  29   this->clock_ = test_clock.Pass();
  30 }
  31
  32 bool SuggestionsStore::LoadSuggestions(SuggestionsProfile* suggestions) {
  33   DCHECK(suggestions);
  34
  35   const std::string base64_suggestions_data =
  36       pref_service_->GetString(prefs::kSuggestionsData);
  37   if (base64_suggestions_data.empty()) {
  38     suggestions->Clear();
  39     return false;
  40   }
  41
  42   // If the decode process fails, assume the pref value is corrupt and clear it.
  43   std::string suggestions_data;
  44   if (!base::Base64Decode(base64_suggestions_data, &suggestions_data) ||
  45       !suggestions->ParseFromString(suggestions_data)) {
  46     VLOG(1) << "Suggestions data in profile pref is corrupt, clearing it.";
  47     suggestions->Clear();
  48     ClearSuggestions();
  49     return false;
  50   }
  51
  52   // Filter expired suggestions and update the stored suggestions if at least
  53   // one was filtered. Return false if all suggestions are filtered.
  54   int unfiltered_size = suggestions->suggestions_size();
  55   FilterExpiredSuggestions(suggestions);
  56   if (suggestions->suggestions_size() != unfiltered_size) {
  57     if (!suggestions->suggestions_size()) {
  58       suggestions->Clear();
  59       ClearSuggestions();
  60       return false;
  61     } else {
  62       StoreSuggestions(*suggestions);
  63     }
  64   }
  65
  66   return true;
  67 }
  68
  69 void SuggestionsStore::FilterExpiredSuggestions(
  70     SuggestionsProfile* suggestions) {
  71   SuggestionsProfile filtered_suggestions;
  72   int64 now_usec =
  73       (this->clock_->Now() - base::Time::UnixEpoch()).ToInternalValue();
  74
  75   for (int i = 0; i < suggestions->suggestions_size(); ++i) {
  76     ChromeSuggestion* suggestion = suggestions->mutable_suggestions(i);
  77     if (!suggestion->has_expiry_ts() || suggestion->expiry_ts() > now_usec) {
  78       filtered_suggestions.add_suggestions()->Swap(suggestion);
  79     }
  80   }
  81   suggestions->Swap(&filtered_suggestions);
  82 }
  83
  84 bool SuggestionsStore::StoreSuggestions(const SuggestionsProfile& suggestions) {
  85   std::string suggestions_data;
  86   if (!suggestions.SerializeToString(&suggestions_data)) return false;
  87
  88   std::string base64_suggestions_data;
  89   base::Base64Encode(suggestions_data, &base64_suggestions_data);
  90
  91   pref_service_->SetString(prefs::kSuggestionsData, base64_suggestions_data);
  92   return true;
  93 }
  94
  95 void SuggestionsStore::ClearSuggestions() {
  96   pref_service_->ClearPref(prefs::kSuggestionsData);
  97 }
  98
  99 // static
 100 void SuggestionsStore::RegisterProfilePrefs(
 101     user_prefs::PrefRegistrySyncable* registry) {
 102   registry->RegisterStringPref(
 103       prefs::kSuggestionsData, std::string(),
 104       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
 105 }
 106
 107 }  // namespace suggestions