| OLD | NEW |
| 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_READER_H_ | 5 #ifndef CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_READER_H_ |
| 6 #define CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_READER_H_ | 6 #define CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_READER_H_ |
| 7 #pragma once | 7 #pragma once |
| 8 | 8 |
| 9 #include "base/observer_list.h" |
| 9 #include "base/scoped_ptr.h" | 10 #include "base/scoped_ptr.h" |
| 10 #include "base/values.h" | 11 #include "base/values.h" |
| 11 #include "chrome/browser/policy/configuration_policy_provider.h" | 12 #include "chrome/browser/policy/configuration_policy_provider.h" |
| 12 #include "chrome/browser/policy/policy_status_info.h" | 13 #include "chrome/browser/policy/policy_status_info.h" |
| 13 | 14 |
| 14 namespace policy { | 15 namespace policy { |
| 15 | 16 |
| 16 class ConfigurationPolicyStatusKeeper; | 17 class ConfigurationPolicyStatusKeeper; |
| 17 | 18 |
| 18 // This class reads policy information from a ConfigurationPolicyProvider in | 19 // This class reads policy information from a ConfigurationPolicyProvider in |
| 19 // order to determine the status of a policy (this includes its value and | 20 // order to determine the status of a policy (this includes its value and |
| 20 // whether it could be enforced on the client or not), as required by the | 21 // whether it could be enforced on the client or not), as required by the |
| 21 // about:policy UI. | 22 // about:policy UI. |
| 22 class ConfigurationPolicyReader : public ConfigurationPolicyProvider::Observer { | 23 class ConfigurationPolicyReader : public ConfigurationPolicyProvider::Observer { |
| 23 public: | 24 public: |
| 25 |
| 26 // Observer class for the ConfigurationPolicyReader. Observer objects are |
| 27 // notified when policy values have changed. |
| 28 class Observer { |
| 29 public: |
| 30 // Called on an observer when the policy values have changed. |
| 31 virtual void OnPolicyValuesChanged() = 0; |
| 32 |
| 33 protected: |
| 34 virtual ~Observer() {} |
| 35 }; |
| 36 |
| 24 ConfigurationPolicyReader(ConfigurationPolicyProvider* provider, | 37 ConfigurationPolicyReader(ConfigurationPolicyProvider* provider, |
| 25 PolicyStatusInfo::PolicyLevel policy_level); | 38 PolicyStatusInfo::PolicyLevel policy_level); |
| 26 virtual ~ConfigurationPolicyReader(); | 39 virtual ~ConfigurationPolicyReader(); |
| 27 | 40 |
| 28 // ConfigurationPolicyProvider::Observer methods: | 41 // ConfigurationPolicyProvider::Observer methods: |
| 29 virtual void OnUpdatePolicy(); | 42 virtual void OnUpdatePolicy(); |
| 30 virtual void OnProviderGoingAway(); | 43 virtual void OnProviderGoingAway(); |
| 31 | 44 |
| 45 // Methods to handle Observers. |observer| must be non-NULL. |
| 46 void AddObserver(Observer* observer); |
| 47 void RemoveObserver(Observer* observer); |
| 48 |
| 32 // Creates a ConfigurationPolicyReader that reads managed platform policy. | 49 // Creates a ConfigurationPolicyReader that reads managed platform policy. |
| 33 static ConfigurationPolicyReader* | 50 static ConfigurationPolicyReader* CreateManagedPlatformPolicyReader(); |
| 34 CreateManagedPlatformPolicyReader(); | |
| 35 | 51 |
| 36 // Creates a ConfigurationPolicyReader that reads managed cloud policy. | 52 // Creates a ConfigurationPolicyReader that reads managed cloud policy. |
| 37 static ConfigurationPolicyReader* | 53 static ConfigurationPolicyReader* CreateManagedCloudPolicyReader(); |
| 38 CreateManagedCloudPolicyReader(); | |
| 39 | 54 |
| 40 // Creates a ConfigurationPolicyReader that reads recommended platform policy. | 55 // Creates a ConfigurationPolicyReader that reads recommended platform policy. |
| 41 static ConfigurationPolicyReader* | 56 static ConfigurationPolicyReader* CreateRecommendedPlatformPolicyReader(); |
| 42 CreateRecommendedPlatformPolicyReader(); | |
| 43 | 57 |
| 44 // Creates a ConfigurationPolicyReader that reads recommended cloud policy. | 58 // Creates a ConfigurationPolicyReader that reads recommended cloud policy. |
| 45 static ConfigurationPolicyReader* | 59 static ConfigurationPolicyReader* CreateRecommendedCloudPolicyReader(); |
| 46 CreateRecommendedCloudPolicyReader(); | |
| 47 | 60 |
| 48 // Returns a pointer to a DictionaryValue object containing policy status | 61 // Returns a pointer to a DictionaryValue object containing policy status |
| 49 // information for the UI. Ownership of the return value is acquired by the | 62 // information for the UI. Ownership of the return value is acquired by the |
| 50 // caller. Returns NULL if the reader is not aware of the given policy. | 63 // caller. Returns NULL if the reader is not aware of the given policy. |
| 51 virtual DictionaryValue* | 64 virtual DictionaryValue* |
| 52 GetPolicyStatus(ConfigurationPolicyType policy) const; | 65 GetPolicyStatus(ConfigurationPolicyType policy) const; |
| 53 | 66 |
| 54 private: | 67 private: |
| 55 friend class MockConfigurationPolicyReader; | 68 friend class MockConfigurationPolicyReader; |
| 56 | 69 |
| 57 // Only used in tests. | 70 // Only used in tests. |
| 58 ConfigurationPolicyReader(); | 71 ConfigurationPolicyReader(); |
| 59 | 72 |
| 60 // Updates the policy information held in this reader. This is called when | 73 // Updates the policy information held in this reader. This is called when |
| 61 // the ConfigurationPolicyProvider is updated. | 74 // the ConfigurationPolicyProvider is updated. |
| 62 void Refresh(); | 75 void Refresh(); |
| 63 | 76 |
| 64 // The policy provider from which policy settings are read. | 77 // The policy provider from which policy settings are read. |
| 65 ConfigurationPolicyProvider* provider_; | 78 ConfigurationPolicyProvider* provider_; |
| 66 | 79 |
| 67 // Whether this ConfigurationPolicyReader contains managed policies. | 80 // Whether this ConfigurationPolicyReader contains managed policies. |
| 68 PolicyStatusInfo::PolicyLevel policy_level_; | 81 PolicyStatusInfo::PolicyLevel policy_level_; |
| 69 | 82 |
| 70 // Current policy status. | 83 // Current policy status. |
| 71 scoped_ptr<ConfigurationPolicyStatusKeeper> policy_keeper_; | 84 scoped_ptr<ConfigurationPolicyStatusKeeper> policy_keeper_; |
| 72 | 85 |
| 86 // The list of observers for this ConfigurationPolicyReader. |
| 87 ObserverList<Observer, true> observers_; |
| 88 |
| 73 ConfigurationPolicyObserverRegistrar registrar_; | 89 ConfigurationPolicyObserverRegistrar registrar_; |
| 74 | 90 |
| 75 DISALLOW_COPY_AND_ASSIGN(ConfigurationPolicyReader); | 91 DISALLOW_COPY_AND_ASSIGN(ConfigurationPolicyReader); |
| 76 }; | 92 }; |
| 77 | 93 |
| 78 // This class combines the policy information from different | 94 // This class combines the policy information from different |
| 79 // ConfigurationPolicyReaders into a single list of policy information that the | 95 // ConfigurationPolicyReaders into a single list of policy information that the |
| 80 // about:policy UI can display. | 96 // about:policy UI can display. |
| 81 class PolicyStatus { | 97 class PolicyStatus { |
| 82 public: | 98 public: |
| 99 typedef ConfigurationPolicyReader::Observer Observer; |
| 83 PolicyStatus(ConfigurationPolicyReader* managed_platform, | 100 PolicyStatus(ConfigurationPolicyReader* managed_platform, |
| 84 ConfigurationPolicyReader* managed_cloud, | 101 ConfigurationPolicyReader* managed_cloud, |
| 85 ConfigurationPolicyReader* recommended_platform, | 102 ConfigurationPolicyReader* recommended_platform, |
| 86 ConfigurationPolicyReader* recommended_cloud); | 103 ConfigurationPolicyReader* recommended_cloud); |
| 87 ~PolicyStatus(); | 104 ~PolicyStatus(); |
| 88 | 105 |
| 106 // Adds an observer to each one of the ConfigurationPolicyReaders. |
| 107 void AddObserver(Observer* observer) const; |
| 108 |
| 109 // Removes an observer from each one of the ConfigurationPolicyReaders. |
| 110 void RemoveObserver(Observer* observer) const; |
| 111 |
| 89 // Returns a ListValue pointer containing the status information of all | 112 // Returns a ListValue pointer containing the status information of all |
| 90 // policies supported by the client. |any_policies_sent| is set to true if | 113 // policies supported by the client. |any_policies_set| is set to true if |
| 91 // there are policies in the list that were sent by a provider, otherwise | 114 // there are policies in the list that were sent by a provider, otherwise |
| 92 // it is set to false. This is for the about:policy UI to display. | 115 // it is set to false. This is for the about:policy UI to display. |
| 93 ListValue* GetPolicyStatusList(bool* any_policies_sent) const; | 116 ListValue* GetPolicyStatusList(bool* any_policies_set) const; |
| 94 | 117 |
| 95 // Returns a string16 containing the actual name of the policy corresponding | 118 // Returns a string16 containing the actual name of the policy corresponding |
| 96 // to |policy_type|. Returns an empty string if there is no such policy_type | 119 // to |policy_type|. Returns an empty string if there is no such policy_type |
| 97 // among the policies supported by the client. | 120 // among the policies supported by the client. |
| 98 static string16 GetPolicyName(ConfigurationPolicyType policy_type); | 121 static string16 GetPolicyName(ConfigurationPolicyType policy_type); |
| 99 | 122 |
| 100 private: | 123 private: |
| 101 typedef ConfigurationPolicyProvider::PolicyDefinitionList | 124 typedef ConfigurationPolicyProvider::PolicyDefinitionList |
| 102 PolicyDefinitionList; | 125 PolicyDefinitionList; |
| 103 | 126 |
| 104 // Add the policy information for |policy| to the ListValue pointed to be | 127 // Add the policy information for |policy| to the ListValue pointed to be |
| 105 // |list| as it is returned by the different ConfigurationPolicyReader | 128 // |list| as it is returned by the different ConfigurationPolicyReader |
| 106 // objects. Returns true if a policy was added and false otherwise. | 129 // objects. Returns true if a policy was added and false otherwise. |
| 107 bool AddPolicyFromReaders(ConfigurationPolicyType policy, | 130 bool AddPolicyFromReaders(ConfigurationPolicyType policy, |
| 108 ListValue* list) const; | 131 ListValue* list) const; |
| 109 | 132 |
| 110 scoped_ptr<ConfigurationPolicyReader> managed_platform_; | 133 scoped_ptr<ConfigurationPolicyReader> managed_platform_; |
| 111 scoped_ptr<ConfigurationPolicyReader> managed_cloud_; | 134 scoped_ptr<ConfigurationPolicyReader> managed_cloud_; |
| 112 scoped_ptr<ConfigurationPolicyReader> recommended_platform_; | 135 scoped_ptr<ConfigurationPolicyReader> recommended_platform_; |
| 113 scoped_ptr<ConfigurationPolicyReader> recommended_cloud_; | 136 scoped_ptr<ConfigurationPolicyReader> recommended_cloud_; |
| 114 | 137 |
| 115 DISALLOW_COPY_AND_ASSIGN(PolicyStatus); | 138 DISALLOW_COPY_AND_ASSIGN(PolicyStatus); |
| 116 }; | 139 }; |
| 117 | 140 |
| 118 } // namespace policy | 141 } // namespace policy |
| 119 | 142 |
| 120 #endif // CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_READER_H_ | 143 #endif // CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_READER_H_ |
| OLD | NEW |