components/services/app_service/public/cpp/permission.h

// Copyright 2022 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 COMPONENTS_SERVICES_APP_SERVICE_PUBLIC_CPP_PERMISSION_H_
#define COMPONENTS_SERVICES_APP_SERVICE_PUBLIC_CPP_PERMISSION_H_

#include <utility>
#include <vector>

#include "base/component_export.h"
#include "components/services/app_service/public/mojom/types.mojom.h"
#include "third_party/abseil-cpp/absl/types/optional.h"

namespace apps {

// The types of permissions in App Service.
enum class PermissionType {
  kUnknown = 0,
  kCamera = 1,
  kLocation = 2,
  kMicrophone = 3,
  kNotifications = 4,
  kContacts = 5,
  kStorage = 6,
  kPrinting = 7,
};

enum class TriState {
  kAllow,
  kBlock,
  kAsk,
};

// The permission value could be a TriState or a bool
struct COMPONENT_EXPORT(APP_TYPES) PermissionValue {
  explicit PermissionValue(bool bool_value);
  explicit PermissionValue(TriState tristate_value);
  PermissionValue(const PermissionValue&) = delete;
  PermissionValue& operator=(const PermissionValue&) = delete;
  ~PermissionValue();

  bool operator==(const PermissionValue& other) const;

  std::unique_ptr<PermissionValue> Clone() const;

  // Checks whether this is equal to permission enabled. If it is TriState, only
  // Allow represent permission enabled.
  bool IsPermissionEnabled();

  absl::optional<bool> bool_value;
  absl::optional<TriState> tristate_value;
};

using PermissionValuePtr = std::unique_ptr<PermissionValue>;

struct COMPONENT_EXPORT(APP_TYPES) Permission {
  Permission(PermissionType permission_type,
             PermissionValuePtr value,
             bool is_managed);
  Permission(const Permission&) = delete;
  Permission& operator=(const Permission&) = delete;
  ~Permission();

  bool operator==(const Permission& other) const;
  bool operator!=(const Permission& other) const;

  std::unique_ptr<Permission> Clone() const;

  PermissionType permission_type;
  std::unique_ptr<PermissionValue> value;
  // If the permission is managed by an enterprise policy.
  bool is_managed;
};

using PermissionPtr = std::unique_ptr<Permission>;
using Permissions = std::vector<PermissionPtr>;

// Creates a deep copy of `source_permissions`.
COMPONENT_EXPORT(APP_TYPES)
Permissions ClonePermissions(const Permissions& source_permissions);

COMPONENT_EXPORT(APP_TYPES)
bool IsEqual(const Permissions& source, const Permissions& target);

// TODO(crbug.com/1253250): Remove these functions after migrating to non-mojo
// AppService.
COMPONENT_EXPORT(APP_TYPES)
PermissionType ConvertMojomPermissionTypeToPermissionType(
    apps::mojom::PermissionType mojom_permission_type);

COMPONENT_EXPORT(APP_TYPES)
apps::mojom::PermissionType ConvertPermissionTypeToMojomPermissionType(
    PermissionType permission_type);

COMPONENT_EXPORT(APP_TYPES)
TriState ConvertMojomTriStateToTriState(apps::mojom::TriState mojom_tri_state);

COMPONENT_EXPORT(APP_TYPES)
apps::mojom::TriState ConvertTriStateToMojomTriState(TriState tri_state);

COMPONENT_EXPORT(APP_TYPES)
PermissionValuePtr ConvertMojomPermissionValueToPermissionValue(
    const apps::mojom::PermissionValuePtr& mojom_permission_value);

COMPONENT_EXPORT(APP_TYPES)
apps::mojom::PermissionValuePtr ConvertPermissionValueToMojomPermissionValue(
    const PermissionValuePtr& permission_value);

COMPONENT_EXPORT(APP_TYPES)
PermissionPtr ConvertMojomPermissionToPermission(
    const apps::mojom::PermissionPtr& mojom_permission);

COMPONENT_EXPORT(APP_TYPES)
apps::mojom::PermissionPtr ConvertPermissionToMojomPermission(
    const PermissionPtr& permission);

}  // namespace apps

#endif  // COMPONENTS_SERVICES_APP_SERVICE_PUBLIC_CPP_PERMISSION_H_