// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_POLICY_CORE_COMMON_POLICY_DETAILS_H_
#define COMPONENTS_POLICY_CORE_COMMON_POLICY_DETAILS_H_

#include <stddef.h>

#include <string>

#include "base/functional/callback_forward.h"
#include "components/policy/policy_export.h"
#include "components/policy/risk_tag.h"

namespace policy {

// An enum defines what the policy can control, generated based on policy
// templates.
// Note that `kProfile` policy may be set to control all profiles simultaneously
// while `kSingleProfile` policy can only control one profile at a time.
enum Scope {
  kDevice,   // Policy controls Chrome OS device behavior, like wifi setup.
  kBrowser,  // Policy controls browser behavior, like guest profile setting.
  kProfile,  // Policy controls one or multiple profiles behavior, like homepage
             // url.
  kSingleProfile,  // Policy controls only one profile behavior, like the
                   // profile label.
};

// The restriction on the policy source.
enum PolicySourceRestriction {
  kSourceRestrictionNone,
  kSourceRestrictionCloudOnly,
};

// Contains read-only metadata about a Chrome policy.
struct POLICY_EXPORT PolicyDetails {
  // True if this policy has been deprecated.
  bool is_deprecated : 1;

  // True if the policy hasn't been released yet.
  bool is_future : 1;

  // True if this policy supports dynamic refresh (does not need browser
  // restart to take effect).
  bool supports_dynamic_refresh : 1;

  // The scope of the policy.
  Scope scope;

  // The restriction on the policy source.
  PolicySourceRestriction source_restriction;

  // The id of the protobuf field that contains this policy,
  // in the cloud policy protobuf.
  short id;

  // If this policy references external data then this is the maximum size
  // allowed for that data.
  // Otherwise this field is 0 and doesn't have any meaning.
  uint32_t max_external_data_size;

  // Contains tags that describe impact on a user's privacy or security.
  RiskTag risk_tags[kMaxRiskTagCount];

  // True if the policy can be set at both the machine and
  // user scopes simultaneously.
  bool uses_local_state_and_profile_prefs : 1;
};

// A typedef for functions that match the signature of
// GetChromePolicyDetails(). This can be used to inject that
// function into objects, so that it can be easily mocked for
// tests.
using GetChromePolicyDetailsCallback =
    base::RepeatingCallback<const PolicyDetails*(const std::string&)>;

}  // namespace policy

#endif  // COMPONENTS_POLICY_CORE_COMMON_POLICY_DETAILS_H_