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

#ifndef SERVICES_NETWORK_PUBLIC_CPP_PERMISSIONS_POLICY_PERMISSIONS_POLICY_FEATURES_H_
#define SERVICES_NETWORK_PUBLIC_CPP_PERMISSIONS_POLICY_PERMISSIONS_POLICY_FEATURES_H_

#include <map>

#include "base/component_export.h"
#include "services/network/public/mojom/permissions_policy/permissions_policy_feature.mojom-shared.h"
#include "url/origin.h"

namespace network {

// The PermissionsPolicyFeatureDefault enum defines the default enable state for
// a feature. For a top-level frame, this is the default enable state; for an
// iframe, this is the default enable state unless the iframe has an 'allow'
// attribute.
//
// See |PermissionsPolicy::InheritedValueForFeature| for usage.
//
// The 2 possibilities map directly to Permissions Policy Allowlist semantics.
//
// The default values for each feature are set in
// GetPermissionsPolicyFeatureList.
enum class PermissionsPolicyFeatureDefault {
  // Equivalent to ["self"]. If this default policy is in effect for a frame,
  // then the feature will be enabled for that frame, and any same-origin
  // child frames, but not for any cross-origin child frames.
  EnableForSelf,

  // Equivalent to ["*"]. If in effect for a frame, then the feature is
  // enabled for that frame and all of its children.
  EnableForAll,

  // Equivalent to ["()"]. If in effect for a frame, the feature is disabled
  // for that frame and any child frames. For the feature to be enabled, it
  // must be enabled by the headers and allowlists of this and all ancestor
  // frames.
  // This option is not yet standardized and should not be used except behind a
  // flag.
  // https://github.com/w3c/webappsec-permissions-policy/pull/515
  EnableForNone,
};

using PermissionsPolicyFeatureList =
    std::map<network::mojom::PermissionsPolicyFeature,
             PermissionsPolicyFeatureDefault>;

// `origin` is used, in combination with flags, to decide whether the "unload"
// feature will be enabled or disabled by default.
COMPONENT_EXPORT(NETWORK_CPP_WEB_PLATFORM)
const PermissionsPolicyFeatureList& GetPermissionsPolicyFeatureList(
    const url::Origin& origin);

// Updates the PermissionPolicyFeatureList based on the current feature flags.
// For efficiency, `GetPermissionPolicyFeatureList()` only calculates the
// default permissions policy once, so it does not track changes in feature
// flags that occur between tests. This function is intended to be used in tests
// that depend on the permission policy being set based the value on a feature
// flag to avoid flakiness. Note that, like the general feature flag
// calculation, if the flags for multiple `default_value_behind_flag` are
// enabled, the default from the first listed is used.
COMPONENT_EXPORT(NETWORK_CPP_WEB_PLATFORM)
void UpdatePermissionsPolicyFeatureListForTesting();

}  // namespace network

#endif  // SERVICES_NETWORK_PUBLIC_CPP_PERMISSIONS_POLICY_PERMISSIONS_POLICY_FEATURES_H_