ConfigurationPolicyPrefStore refactoring to surface error messages.

chrome/browser/policy/configuration_policy_handler.h

+// Copyright (c) 2011 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_POLICY_CONFIGURATION_POLICY_HANDLER_H_
+#define CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_HANDLER_H_
+#pragma once
+
+#include <string>
+
+#include "base/memory/scoped_ptr.h"
+#include "base/values.h"
+#include "chrome/browser/policy/configuration_policy_handler_interface.h"
+#include "chrome/browser/policy/policy_error_map.h"
+#include "chrome/browser/policy/policy_map.h"
+#include "chrome/browser/prefs/incognito_mode_prefs.h"
+#include "chrome/browser/prefs/pref_value_map.h"
+#include "policy/configuration_policy_type.h"
+
+namespace policy {
+
+// Abstract class derived from ConfigurationPolicyHandlerInterface that should
+// be subclassed to handle a single policy (not a combination of policies).
+class TypeCheckingPolicyHandler : public ConfigurationPolicyHandlerInterface {
+ public:
+  TypeCheckingPolicyHandler(ConfigurationPolicyType policy,
+                            base::Value::Type value_type);
+
+  // ConfigurationPolicyHandlerInterface method. Returns true if the value of
+  // the policy is of the correct type and false otherwise.
+  virtual bool CheckPolicySettings(const PolicyMap* policies,
+                                   PolicyErrorMap* errors) OVERRIDE;
+  virtual void ApplyPolicySettings(const PolicyMap* policies,
+                                   PrefValueMap* prefs) OVERRIDE;
+  virtual void ApplyPolicyValue(PrefValueMap* prefs, const Value* value) = 0;

[Mattias Nissler (ping if slow), 2011/09/26 13:30:48]

Please document.

[simo, 2011/09/29 09:33:08]

Done.

+
+ protected:
+  virtual ~TypeCheckingPolicyHandler();
+
+  ConfigurationPolicyType policy_type() const;
+
+ private:
+  static std::string ValueTypeToString(Value::Type type);
+
+  // The ConfigurationPolicyType of the policy.
+  ConfigurationPolicyType policy_type_;
+
+  // The type the value of the policy should have.
+  base::Value::Type value_type_;
+
+  DISALLOW_COPY_AND_ASSIGN(TypeCheckingPolicyHandler );
+};
+
+// ConfigurationPolicyHandlerInterface implementation for policies that map
+// directly to a preference.
+class SimplePolicyHandler : public TypeCheckingPolicyHandler  {
+ public:
+  SimplePolicyHandler(ConfigurationPolicyType policy,
+                      base::Value::Type value_type,
+                      const char* pref_path);
+  virtual ~SimplePolicyHandler();
+
+  // ConfigurationPolicyHandlerInterface method:

[Mattias Nissler (ping if slow), 2011/09/26 13:30:48]

This is actually a TypeCheckingPolicyHandler override.

[simo, 2011/09/29 09:33:08]

Done.

+  virtual void ApplyPolicyValue(PrefValueMap* prefs,
+                                const Value* value) OVERRIDE;
+
+ private:
+  // The DictionaryValue path of the preference the policy maps to.
+  const char* pref_path_;
+
+  DISALLOW_COPY_AND_ASSIGN(SimplePolicyHandler);
+};
+
+// ConfigurationPolicyHandlerInterface implementation for the SyncDisabled
+// policy.
+class SyncPolicyHandler : public TypeCheckingPolicyHandler  {
+ public:
+  SyncPolicyHandler();
+  virtual ~SyncPolicyHandler();
+
+  // TypeCheckingPolicyHandler method:
+  virtual void ApplyPolicyValue(PrefValueMap* prefs,
+                                const Value* value) OVERRIDE;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(SyncPolicyHandler);
+};
+
+// ConfigurationPolicyHandlerInterface implementation for the AutofillEnabled
+// policy.
+class AutofillPolicyHandler : public TypeCheckingPolicyHandler  {
+ public:
+  AutofillPolicyHandler();
+  virtual ~AutofillPolicyHandler();
+
+  // ConfigurationPolicyHandlerInterface method:
+//  virtual void ApplyPolicySettings(const PolicyMap* policies,
+//                                   PrefValueMap* prefs) OVERRIDE;

[Mattias Nissler (ping if slow), 2011/09/26 13:30:48]

remove old code.

[simo, 2011/09/29 09:33:08]

Done.

+  virtual void ApplyPolicyValue(PrefValueMap* prefs,
+                                const Value* value) OVERRIDE;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(AutofillPolicyHandler);
+};
+
+// ConfigurationPolicyHandlerInterface implementation for the DownloadDirectory
+// policy.
+class DownloadDirPolicyHandler : public TypeCheckingPolicyHandler  {
+ public:
+  DownloadDirPolicyHandler();
+  virtual ~DownloadDirPolicyHandler();
+

[Mattias Nissler (ping if slow), 2011/09/26 13:30:48]

remove extra newline

[simo, 2011/09/29 09:33:08]

Done.

+
+  // TypeCheckingPolicyHandler methods:
+  virtual bool CheckPolicySettings(const PolicyMap* map,
+                                   PolicyErrorMap* errors) OVERRIDE;
+  virtual void ApplyPolicyValue(PrefValueMap* prefs,
+                                const Value* value) OVERRIDE;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(DownloadDirPolicyHandler);
+};
+
+// ConfigurationPolicyHandlerInterface implementation for the DiskCacheDir
+// policy.
+class DiskCacheDirPolicyHandler : public TypeCheckingPolicyHandler  {
+ public:
+  explicit DiskCacheDirPolicyHandler();
+  virtual ~DiskCacheDirPolicyHandler();
+
+  // TypeCheckingPolicyHandler method:
+  virtual void ApplyPolicyValue(PrefValueMap* prefs,
+                                const Value* value) OVERRIDE;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(DiskCacheDirPolicyHandler);
+};
+
+// ConfigurationPolicyHandlerInterface implementation for the
+// FileSelectionDialogsHandler policy.
+class FileSelectionDialogsHandler : public TypeCheckingPolicyHandler  {
+ public:
+  FileSelectionDialogsHandler();
+  virtual ~FileSelectionDialogsHandler();
+
+  // TypeCheckingPolicyHandler method:
+  virtual void ApplyPolicyValue(PrefValueMap* prefs,
+                                const Value* value) OVERRIDE;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(FileSelectionDialogsHandler);
+};
+
+// ConfigurationPolicyHandlerInterface implementation for the BookmarkBarEnabled
+// policy.
+class BookmarksPolicyHandler : public TypeCheckingPolicyHandler  {
+ public:
+  BookmarksPolicyHandler();
+  virtual ~BookmarksPolicyHandler();
+
+  // TypeCheckingPolicyHandler method:
+  virtual void ApplyPolicyValue(PrefValueMap* prefs,
+                                const Value* value) OVERRIDE;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(BookmarksPolicyHandler);
+};
+
+// ConfigurationPolicyHandlerInterface implementation for the incognito mode
+// policies.
+class IncognitoModePolicyHandler : public ConfigurationPolicyHandlerInterface {
+ public:
+  IncognitoModePolicyHandler();
+  virtual ~IncognitoModePolicyHandler();
+
+  // TypeCheckingPolicyHandler methods:
+  virtual bool CheckPolicySettings(const PolicyMap* policies,
+                                   PolicyErrorMap* errors) OVERRIDE;
+  virtual void ApplyPolicySettings(const PolicyMap* policies,
+                                   PrefValueMap* prefs) OVERRIDE;
+
+ private:
+  IncognitoModePrefs::Availability GetAvailabilityValueAsEnum(
+      const Value* availability);
+
+  DISALLOW_COPY_AND_ASSIGN(IncognitoModePolicyHandler);
+};
+
+// ConfigurationPolicyHandlerInterface implementation for the
+// DefaultSearchEncodings policy.
+class DefaultSearchEncodingsPolicyHandler : public TypeCheckingPolicyHandler  {
+ public:
+  DefaultSearchEncodingsPolicyHandler();
+  virtual ~DefaultSearchEncodingsPolicyHandler();
+
+  // TypeCheckingPolicyHandler method:
+  virtual void ApplyPolicyValue(PrefValueMap* prefs,
+                                const Value* value) OVERRIDE;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(DefaultSearchEncodingsPolicyHandler);
+};
+
+// ConfigurationPolicyHandlerInterface implementation for the default search
+// policies.
+class DefaultSearchPolicyHandler : public ConfigurationPolicyHandlerInterface {
+ public:
+  DefaultSearchPolicyHandler();
+  virtual ~DefaultSearchPolicyHandler();
+
+  // ConfigurationPolicyHandlerInterface methods:
+  virtual bool CheckPolicySettings(const PolicyMap* policies,
+                                   PolicyErrorMap* errors) OVERRIDE;
+  virtual void ApplyPolicySettings(const PolicyMap* policies,
+                                   PrefValueMap* prefs) OVERRIDE;
+
+ private:
+  typedef std::vector<ConfigurationPolicyHandlerInterface*> HandlerList;
+
+  // Calls |CheckPolicySettings()| on each of the handlers in |handlers_|
+  // and returns true if all of the calls return true and false otherwise.
+  bool CheckIndividualPolicies(const PolicyMap* policies,
+                               PolicyErrorMap* errors);
+
+  // Returns true if the default search provider is disabled and false
+  // otherwise.
+  bool DefaultSearchProviderIsDisabled(const PolicyMap* policies);
+
+  // Returns true if the default search URL was set and is valid and false
+  // otherwise.
+  bool DefaultSearchURLIsPresentAndValid(const PolicyMap* policies);
+
+  // Make sure that the |path| if present in |prefs_|.  If not, set it to
+  // a blank string.
+  void EnsureStringPrefExists(PrefValueMap* prefs, const std::string& path);
+
+  // Copies all default search preferences in |temp_prefs| to |prefs|.
+  void CopyTempPrefsToRealPrefs(PrefValueMap* temp_prefs, PrefValueMap* prefs);
+
+  // Clears all default search preferences in |prefs|.
+  void ClearDefaultSearchPreferences(PrefValueMap* prefs);
+
+  // The ConfigurationPolicyHandlerInterface handlers for each of default search
+  // policies.
+  HandlerList handlers_;
+
+  DISALLOW_COPY_AND_ASSIGN(DefaultSearchPolicyHandler);
+};
+
+// ConfigurationPolicyHandlerInterface implementation for the proxy policies.
+class ProxyPolicyHandler : public ConfigurationPolicyHandlerInterface {
+ public:
+  ProxyPolicyHandler();
+  virtual ~ProxyPolicyHandler();
+
+  // ConfigurationPolicyHandlerInterface methods:
+  virtual bool CheckPolicySettings(const PolicyMap* policies,
+                                   PolicyErrorMap* errors) OVERRIDE;
+  virtual void ApplyPolicySettings(const PolicyMap* policies,
+                                   PrefValueMap* prefs) OVERRIDE;
+
+ private:
+  const Value* GetProxyPolicyValue(const PolicyMap* policies,
+                                   ConfigurationPolicyType policy);
+
+  // Converts the deprecated ProxyServerMode policy value to a ProxyMode value
+  // and places the result in |mode_value|. Returns true if the conversion
+  // succeeded and false otherwise.
+  bool CheckProxyModeAndServerMode(const PolicyMap* policies,
+                                   PolicyErrorMap* errors,
+                                   std::string* mode_value);
+
+  DISALLOW_COPY_AND_ASSIGN(ProxyPolicyHandler);
+};
+
+}  // namespace policy
+
+#endif  // CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_HANDLER_H_