// Copyright 2021 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_BROWSER_WEBUI_POLICY_STATUS_PROVIDER_H_
#define COMPONENTS_POLICY_CORE_BROWSER_WEBUI_POLICY_STATUS_PROVIDER_H_

#include <memory>

#include "base/functional/callback_helpers.h"
#include "base/observer_list.h"
#include "base/observer_list_types.h"
#include "base/time/clock.h"
#include "base/time/time.h"
#include "base/values.h"
#include "components/policy/policy_export.h"
#include "components/policy/resources/webui/mojom/policy.mojom-forward.h"

class PrefService;

namespace base {
class Time;
}

namespace enterprise_management {
class PolicyData;
}

namespace policy {
class CloudPolicyClient;
class CloudPolicyCore;
class CloudPolicyRefreshScheduler;
class CloudPolicyStore;

inline constexpr char kPolicyDescriptionKey[] = "policyDescriptionKey";
inline constexpr char kFlexOrgWarningKey[] = "flexOrgWarning";

// The following constants identify top-level keys in the dictionary returned by
// PolicyStatusProvider.
inline constexpr char kAssetIdKey[] = "assetId";
inline constexpr char kLocationKey[] = "location";
inline constexpr char kDirectoryApiIdKey[] = "directoryApiId";
inline constexpr char kGaiaIdKey[] = "gaiaId";
inline constexpr char kClientIdKey[] = "clientId";
inline constexpr char kUsernameKey[] = "username";
inline constexpr char kEnterpriseDomainManagerKey[] = "enterpriseDomainManager";
inline constexpr char kDomainKey[] = "domain";
inline constexpr char kEnrollmentTokenKey[] = "enrollmentToken";

// An interface for querying the status of a policy provider.  It surfaces
// things like last fetch time or status of the backing store, but not the
// actual policies themselves.
class POLICY_EXPORT PolicyStatusProvider {
 public:
  class Observer : public base::CheckedObserver {
   public:
    virtual void OnPolicyStatusChanged() = 0;
  };

  PolicyStatusProvider();
  PolicyStatusProvider(const PolicyStatusProvider&) = delete;
  PolicyStatusProvider& operator=(const PolicyStatusProvider&) = delete;
  virtual ~PolicyStatusProvider();

  // Returns a dictionary with metadata about policies.
  virtual base::DictValue GetStatus();
  // TODO: crbug.com/40897784 - once all providers implement `GetStatusMojo`
  // remove `GetStatus` and `SupportsMojoStatus`.
  virtual policy::mojom::StatusPtr GetStatusMojo();

  // Returns a dictionary with metadata about policies from a
  // CloudPolicyCore instance. If |is_extension_install_policy| is true, the
  // dictionary will be for extension install policies.
  static base::DictValue GetStatusFromCore(
      const CloudPolicyCore* core,
      bool is_extension_install_policy = false);
  static void PopulateStatusFromCore(const CloudPolicyCore* core,
                                     bool is_extension_install_policy,
                                     policy::mojom::StatusPtr& status);
  static base::DictValue GetStatusFromPolicyData(
      const enterprise_management::PolicyData* policy);
  static void PopulateStatusFromPolicyData(
      const enterprise_management::PolicyData* policy,
      policy::mojom::StatusPtr& status);

  // Overrides clock in tests. Returned closure removes the override when
  // destroyed.
  static base::ScopedClosureRunner OverrideClockForTesting(
      base::Clock* clock_for_testing);

  void AddObserver(Observer* observer);
  void RemoveObserver(Observer* observer);

 protected:
  void NotifyStatusChange();
  static std::u16string GetPolicyStatusFromStore(const CloudPolicyStore*,
                                                 const CloudPolicyClient*);
  static std::u16string GetTimeSinceLastActionString(base::Time);

  // TODO: crbug.com/40897784 - remove once all status providers implement the
  // mojo version of `GetStatus()`.
  static policy::mojom::StatusPtr DictStatusToMojo(const base::DictValue& dict);

  // Add policy push information along with conditional refresh interval into
  // policy `status` dictionary.
  static void SetPolicyPushAndRefreshStatus(
      base::DictValue& status,
      const CloudPolicyRefreshScheduler* refresh_scheduler);
  static void SetPolicyPushAndRefreshStatus(
      policy::mojom::StatusPtr& status,
      const CloudPolicyRefreshScheduler* refresh_scheduler);

  // Add last report uploaded timestamp into policy `status` dictionary from
  // `prefs`.
  static void UpdateLastReportTimestamp(
      base::DictValue& status,
      PrefService* prefs,
      const std::string& report_timestamp_pref_path);
  static void UpdateLastReportTimestamp(
      policy::mojom::StatusPtr& status,
      PrefService* prefs,
      const std::string& report_timestamp_pref_path);

 private:
  base::ObserverList<Observer, /*check_empty=*/true> observers_;
};

}  // namespace policy

#endif  // COMPONENTS_POLICY_CORE_BROWSER_WEBUI_POLICY_STATUS_PROVIDER_H_