// 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_STORE_INTERFACE_H_
#define CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_STORE_INTERFACE_H_
#pragma once

#include "base/basictypes.h"
#include "base/compiler_specific.h"
#include "policy/configuration_policy_type.h"

class Value;

namespace policy {

// Constants for the "Proxy Server Mode" defined in the policies.
// Note that these diverge from internal presentation defined in
// ProxyPrefs::ProxyMode for legacy reasons. The following four
// PolicyProxyModeType types were not very precise and had overlapping use
// cases.
enum PolicyProxyModeType {
  // Disable Proxy, connect directly.
  kPolicyNoProxyServerMode = 0,
  // Auto detect proxy or use specific PAC script if given.
  kPolicyAutoDetectProxyServerMode = 1,
  // Use manually configured proxy servers (fixed servers).
  kPolicyManuallyConfiguredProxyServerMode = 2,
  // Use system proxy server.
  kPolicyUseSystemProxyServerMode = 3,

  MODE_COUNT
};

// An abstract super class for policy stores that provides a method that can be
// called by a |ConfigurationPolicyProvider| to specify a policy.
class ConfigurationPolicyStoreInterface {
 public:
  virtual ~ConfigurationPolicyStoreInterface() {}

  // A |ConfigurationPolicyProvider| specifies the value of a policy
  // setting through a call to |Apply|.  The configuration policy pref
  // store takes over the ownership of |value|.
  virtual void Apply(ConfigurationPolicyType policy, Value* value) = 0;

 protected:
  ConfigurationPolicyStoreInterface() {}

 private:
  DISALLOW_COPY_AND_ASSIGN(ConfigurationPolicyStoreInterface);
};

// Helper class. A pass-through ConfigurationPolicyStoreInterface, that observes
// the application of well-known policies.
class ObservingPolicyStoreInterface: public ConfigurationPolicyStoreInterface {
 public:
  explicit ObservingPolicyStoreInterface(
      ConfigurationPolicyStoreInterface* next)
      : next_(next),
        proxy_policy_applied_(false) {}

  // ConfigurationPolicyStoreInterface methods:
  virtual void Apply(ConfigurationPolicyType policy, Value* value) OVERRIDE;

  bool IsProxyPolicyApplied() const {
    return proxy_policy_applied_;
  }

 private:
  ConfigurationPolicyStoreInterface* next_;
  bool proxy_policy_applied_;

  DISALLOW_COPY_AND_ASSIGN(ObservingPolicyStoreInterface);
};

// Helper class. A ConfigurationPolicyStoreInterface that filters out most
// policies, and only applies well-known policies.
class FilteringPolicyStoreInterface: public ConfigurationPolicyStoreInterface {
 public:
  FilteringPolicyStoreInterface(ConfigurationPolicyStoreInterface* next,
                                bool apply_proxy_policies)
      : next_(next),
        apply_proxy_policies_(apply_proxy_policies) {}

  // ConfigurationPolicyStoreInterface methods:
  virtual void Apply(ConfigurationPolicyType policy, Value* value) OVERRIDE;

 private:
  ConfigurationPolicyStoreInterface* next_;
  bool apply_proxy_policies_;

  DISALLOW_COPY_AND_ASSIGN(FilteringPolicyStoreInterface);
};

}  // namespace policy

#endif  // CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_STORE_INTERFACE_H_