blob: c0c3f7473e7202972961d2741e6101b65d6ecaf2 [file] [log] [blame]
// 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.
#ifndef CHROME_BROWSER_PREFS_TRACKED_TRACKED_PREFERENCE_HELPER_H_
#define CHROME_BROWSER_PREFS_TRACKED_TRACKED_PREFERENCE_HELPER_H_
#include <string>
#include "base/macros.h"
#include "chrome/browser/prefs/pref_hash_filter.h"
#include "chrome/browser/prefs/pref_hash_store_transaction.h"
// A TrackedPreferenceHelper is a helper class for TrackedPreference which
// handles decision making and reporting for TrackedPreference's
// implementations.
class TrackedPreferenceHelper {
public:
enum ResetAction {
DONT_RESET,
// WANTED_RESET is reported when DO_RESET would have been reported but the
// current |enforcement_level| doesn't allow a reset for the detected state.
WANTED_RESET,
DO_RESET,
};
TrackedPreferenceHelper(const std::string& pref_path,
size_t reporting_id,
size_t reporting_ids_count,
PrefHashFilter::EnforcementLevel enforcement_level);
// Returns a ResetAction stating whether a reset is desired (DO_RESET) or not
// (DONT_RESET) based on observing |value_state|. Can also return WANTED_RESET
// if a reset would have been desired but the current |enforcement_level|
// doesn't allow it.
ResetAction GetAction(
PrefHashStoreTransaction::ValueState value_state) const;
// Reports |value_state| via UMA under |reporting_id_|.
void ReportValidationResult(
PrefHashStoreTransaction::ValueState value_state) const;
// Reports |reset_action| via UMA under |reporting_id_|.
void ReportAction(ResetAction reset_action) const;
// Reports, via UMA, the |count| of split preference entries that were
// considered invalid in a CHANGED event.
void ReportSplitPreferenceChangedCount(size_t count) const;
private:
const std::string pref_path_;
const size_t reporting_id_;
const size_t reporting_ids_count_;
// Deny setting changes and hash seeding/migration.
const bool enforce_;
DISALLOW_COPY_AND_ASSIGN(TrackedPreferenceHelper);
};
#endif // CHROME_BROWSER_PREFS_TRACKED_TRACKED_PREFERENCE_HELPER_H_