File: policy_value_and_status_aggregator.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (132 lines) | stat: -rw-r--r-- 5,146 bytes parent folder | download | duplicates (5)
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
// Copyright 2022 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_POLICY_POLICY_VALUE_AND_STATUS_AGGREGATOR_H_
#define CHROME_BROWSER_POLICY_POLICY_VALUE_AND_STATUS_AGGREGATOR_H_

#include <memory>
#include <utility>
#include <vector>

#include "base/containers/flat_map.h"
#include "base/memory/raw_ptr.h"
#include "base/observer_list.h"
#include "base/scoped_multi_source_observation.h"
#include "base/scoped_observation.h"
#include "base/values.h"
#include "build/branding_buildflags.h"
#include "build/build_config.h"
#include "chrome/browser/policy/value_provider/policy_value_provider.h"
#include "chrome/browser/profiles/profile_observer.h"
#include "components/policy/core/browser/webui/policy_status_provider.h"
#include "extensions/buildflags/buildflags.h"

class Profile;

namespace policy {

extern const char kUserStatusKey[];
#if BUILDFLAG(IS_CHROMEOS)
extern const char kDeviceStatusKey[];
#endif  // BUILDFLAG(IS_CHROMEOS)

// PolicyValueAndStatusAggregator is a wrapper class that will contain all the
// platform-specific PolicyStatusProviders and PolicyValueProviders. It will
// call GetStatus(), GetValues(), GetNames() on the available providers, merge
// them and return the dictionary that contains all the available information.
class PolicyValueAndStatusAggregator : public PolicyValueProvider::Observer,
                                       public PolicyStatusProvider::Observer,
                                       public ProfileObserver {
 public:
  class Observer : public base::CheckedObserver {
   public:
    virtual void OnPolicyValueAndStatusChanged() = 0;
  };

  // Returns the PolicyValueAndStatusAggregator instance for the running
  // platform.
  static std::unique_ptr<PolicyValueAndStatusAggregator>
  CreateDefaultPolicyValueAndStatusAggregator(Profile* profile);

  PolicyValueAndStatusAggregator(const PolicyValueAndStatusAggregator&) =
      delete;
  PolicyValueAndStatusAggregator& operator=(
      const PolicyValueAndStatusAggregator&) = delete;
  ~PolicyValueAndStatusAggregator() override;

  // Returns the dictionary containing the policy metadata available for the
  // platform.
  base::Value::Dict GetAggregatedPolicyStatus();

  // Returns the dictionary containing policy names.
  base::Value::Dict GetAggregatedPolicyNames();

  // Returns the available policy values.
  base::Value::Dict GetAggregatedPolicyValues();

  // Refreshes the policy values by calling Refresh() on all
  // PolicyValueProviders and notifies the observers about policy value and
  // status change when the refresh is done.
  void Refresh();

  void AddObserver(Observer* observer);
  void RemoveObserver(Observer* observer);

  // PolicyValueProvider::Observer implementation.
  void OnPolicyValueChanged() override;

  // PolicyStatusProvider::Observer implementation.
  void OnPolicyStatusChanged() override;

  // ProfileObserver implementation.
  // Clears `value_providers_` as they depend on `profile`.
  void OnProfileWillBeDestroyed(Profile* profile) override;

  void AddPolicyValueProvider(
      std::unique_ptr<PolicyValueProvider> value_provider);

  void AddPolicyStatusProvider(
      std::string status_provider_description,
      std::unique_ptr<PolicyStatusProvider> status_provider);

  template <typename ProviderType>
  void AddPolicyStatusAndValueProvider(
      std::string status_provider_description,
      std::unique_ptr<ProviderType> status_and_value_provider) {
    AddPolicyValueProviderUnowned(status_and_value_provider.get());
    AddPolicyStatusProvider(status_provider_description,
                            std::move(status_and_value_provider));
  }

 private:
  explicit PolicyValueAndStatusAggregator(Profile* profile);

  void NotifyValueAndStatusChange();

  // Adds `value_provider` to `value_providers_unowned_`.
  void AddPolicyValueProviderUnowned(PolicyValueProvider* value_provider);

  // Contains the available PolicyStatusProviders for the platform with the
  // description strings.
  base::flat_map<std::string, std::unique_ptr<PolicyStatusProvider>>
      status_providers_;
  // Contains the PolicyValueProviders available for the platform.
  std::vector<std::unique_ptr<PolicyValueProvider>> value_providers_;
  // Contains the pointers to PolicyValueProvider which also implement
  // PolicyStatusProvider. The ownership of the instances will be in
  // `status_providers_`.
  std::vector<raw_ptr<PolicyValueProvider, VectorExperimental>>
      value_providers_unowned_;
  base::ObserverList<Observer> observers_;
  base::ScopedMultiSourceObservation<PolicyValueProvider,
                                     PolicyValueProvider::Observer>
      policy_value_provider_observations_{this};
  base::ScopedMultiSourceObservation<PolicyStatusProvider,
                                     PolicyStatusProvider::Observer>
      policy_status_provider_observations_{this};
  base::ScopedObservation<Profile, ProfileObserver> profile_observation_{this};
};
}  // namespace policy

#endif  // CHROME_BROWSER_POLICY_POLICY_VALUE_AND_STATUS_AGGREGATOR_H_