1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_CHROMEOS_REPORTING_USER_REPORTING_SETTINGS_H_
#define CHROME_BROWSER_CHROMEOS_REPORTING_USER_REPORTING_SETTINGS_H_
#include <map>
#include <memory>
#include "base/callback_list.h"
#include "base/functional/callback_forward.h"
#include "base/memory/weak_ptr.h"
#include "base/scoped_observation.h"
#include "base/sequence_checker.h"
#include "base/thread_annotations.h"
#include "base/values.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/profiles/profile_observer.h"
#include "components/prefs/pref_change_registrar.h"
#include "components/reporting/metrics/reporting_settings.h"
namespace reporting {
// `UserReportingSettings` is used to fetch user reporting settings via the pref
// store. Extends a convenient common interface that metric reporting components
// use to access reporting settings and subscribe to reporting setting updates.
// Needs to be accessed from the main thread given its dependency on user
// profiles and the user pref store.
class UserReportingSettings : public ReportingSettings, public ProfileObserver {
public:
explicit UserReportingSettings(base::WeakPtr<Profile> profile);
UserReportingSettings(const UserReportingSettings& other) = delete;
UserReportingSettings& operator=(const UserReportingSettings& other) = delete;
~UserReportingSettings() override;
// ReportingSettings:
base::CallbackListSubscription AddSettingsObserver(
const std::string& path,
base::RepeatingClosure callback) override;
bool PrepareTrustedValues(base::OnceClosure callback) override;
bool GetBoolean(const std::string& path, bool* out_value) const override;
bool GetInteger(const std::string& path, int* out_value) const override;
bool GetList(const std::string& path,
const base::Value::List** out_value) const override;
// Only bool and List are allowed, otherwise will return false.
bool GetReportingEnabled(const std::string& path,
bool* out_value) const override;
// Returns whether the specified setting is being observed for testing
// purposes.
bool IsObservingSettingsForTest(const std::string& path);
private:
// ProfileObserver:
void OnProfileWillBeDestroyed(Profile* profile) override;
// Internal callback triggered when the setting value is updated.
void OnPrefChanged(const std::string& path);
SEQUENCE_CHECKER(sequence_checker_);
const base::WeakPtr<Profile> profile_;
std::unique_ptr<PrefChangeRegistrar> pref_change_registrar_;
// A map of setting names to a list of observers. Observers are triggered in
// the order they are added.
std::map<std::string, std::unique_ptr<base::RepeatingClosureList>>
settings_observers_ GUARDED_BY_CONTEXT(sequence_checker_);
// Observer that is used to track profile lifecycle so we can perform
// cleanup tasks on destruction.
base::ScopedObservation<Profile, ProfileObserver> scoped_profile_observer_
GUARDED_BY_CONTEXT(sequence_checker_){this};
base::WeakPtrFactory<UserReportingSettings> weak_ptr_factory_{this};
};
} // namespace reporting
#endif // CHROME_BROWSER_CHROMEOS_REPORTING_USER_REPORTING_SETTINGS_H_
|