chrome/browser/supervised_user/supervised_user_verification_page.h

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

#ifndef CHROME_BROWSER_SUPERVISED_USER_SUPERVISED_USER_VERIFICATION_PAGE_H_
#define CHROME_BROWSER_SUPERVISED_USER_SUPERVISED_USER_VERIFICATION_PAGE_H_

#include <memory>
#include <string>

#include "base/callback_list.h"
#include "base/memory/raw_ptr.h"
#include "components/security_interstitials/content/security_interstitial_page.h"
#include "components/supervised_user/core/browser/child_account_service.h"
#include "content/public/browser/web_contents.h"
#include "services/metrics/public/cpp/ukm_source_id.h"

class GURL;

// This class is responsible for showing/hiding the interstitial page that
// occurs when a supervised user tries to access a page that requires
// verification.
class SupervisedUserVerificationPage
    : public security_interstitials::SecurityInterstitialPage {
 public:
  // The purpose of the interstitial determines its layout and displayed texts.
  enum class VerificationPurpose {
    REAUTH_REQUIRED_SITE,  // Show the interstitial for sites requiring
                           // re-authentication with generic descriptions
    BLOCKED_SITE  // The interstitial is displayed for a blocked site, for which
                  // parent's approvals require re-authentication.
  };

  // The status of the interstitial used for metrics recording purposes.
  enum class Status { SHOWN, REAUTH_STARTED, REAUTH_COMPLETED };

  // Interstitial type, used in tests.
  static const security_interstitials::SecurityInterstitialPage::TypeID
      kTypeForTesting;

  // `request_url` is the URL which triggered the interstitial page. It can be
  // a main frame or a subresource URL.
  // `child_account_service` should only be null for demo interstitials, such as
  // for "chrome://interstitials/supervised-user-verify".
  SupervisedUserVerificationPage(
      content::WebContents* web_contents,
      const std::string& email_to_reauth,
      const GURL& request_url,
      VerificationPurpose verification_purpose,
      supervised_user::ChildAccountService* child_account_service,
      ukm::SourceId source_id,
      std::unique_ptr<
          security_interstitials::SecurityInterstitialControllerClient>
          controller_client);

  SupervisedUserVerificationPage(const SupervisedUserVerificationPage&) =
      delete;
  SupervisedUserVerificationPage& operator=(
      const SupervisedUserVerificationPage&) = delete;

  ~SupervisedUserVerificationPage() override;

  // SecurityInterstitialPage method:
  security_interstitials::SecurityInterstitialPage::TypeID GetTypeForTesting()
      override;

  // Reloads the interstitial page and records metrics if necessary.
  void OnReauthenticationCompleted();

 protected:
  void CommandReceived(const std::string& command) override;
  void PopulateInterstitialStrings(base::Value::Dict& load_time_data) override;
  void OnInterstitialClosing() override;
  int GetHTMLTemplateId() override;

 private:
  void PopulateStringsForSharedHTML(base::Value::Dict& load_time_data);
  void RecordYouTubeReauthStatusUkm(Status status);
  base::CallbackListSubscription google_auth_state_subscription_;
  const std::string email_to_reauth_;
  const GURL request_url_;
  const VerificationPurpose verification_purpose_;
  raw_ptr<supervised_user::ChildAccountService> child_account_service_;
  ukm::SourceId source_id_;
};

#endif  // CHROME_BROWSER_SUPERVISED_USER_SUPERVISED_USER_VERIFICATION_PAGE_H_