// 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 CHROME_BROWSER_SAFE_BROWSING_TAILORED_SECURITY_CHROME_TAILORED_SECURITY_SERVICE_H_
#define CHROME_BROWSER_SAFE_BROWSING_TAILORED_SECURITY_CHROME_TAILORED_SECURITY_SERVICE_H_

#include "base/gtest_prod_util.h"
#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
#include "build/build_config.h"
#include "chrome/browser/safe_browsing/tailored_security/message_retry_handler.h"
#include "chrome/browser/user_education/user_education_service.h"
#include "components/safe_browsing/core/browser/tailored_security_service/tailored_security_service.h"
#include "components/safe_browsing/core/browser/tailored_security_service/tailored_security_service_observer.h"
#include "components/safe_browsing/core/common/safe_browsing_prefs.h"
#include "components/user_education/product_messaging/product_messaging_controller.h"

#if BUILDFLAG(IS_ANDROID)
#include "chrome/browser/safe_browsing/tailored_security/consented_message_android.h"
#include "chrome/browser/ui/android/tab_model/tab_model_list_observer.h"
#include "chrome/browser/ui/android/tab_model/tab_model_observer.h"
#else
#include "chrome/browser/ui/views/safe_browsing/tailored_security_desktop_dialog_manager.h"
#endif

class BrowserWindowInterface;
class Profile;

#if !BUILDFLAG(IS_ANDROID)
DECLARE_PRODUCT_MESSAGE_KEY(
    kEnabledEnhancedBrowsingNotice,
    user_education::ProductMessageType::kLegalOrComplianceNotice);
DECLARE_PRODUCT_MESSAGE_KEY(
    kDisabledEnhancedBrowsingNotice,
    user_education::ProductMessageType::kLegalOrComplianceNotice);
#endif

namespace safe_browsing {

#if BUILDFLAG(IS_ANDROID)
class ChromeTailoredSecurityService : public TailoredSecurityService,
                                      public TailoredSecurityServiceObserver,
                                      public TabModelObserver,
                                      public TabModelListObserver
#else
class ChromeTailoredSecurityService : public TailoredSecurityService,
                                      public TailoredSecurityServiceObserver
#endif
{
 public:
  // The amount of time to wait after construction before checking if a retry is
  // needed.
  static constexpr const base::TimeDelta kRetryAttemptStartupDelay =
      base::Minutes(2);
  // The amount of time to wait between retry attempts.
  static constexpr const base::TimeDelta kRetryNextAttemptDelay = base::Days(1);
  // Length of time that the retry mechanism will wait before running. This
  // delay is used for the case where the tailored security service can't tell
  // if it succeeded in the past.
  static constexpr const base::TimeDelta kWaitingPeriodInterval =
      base::Days(90);

  explicit ChromeTailoredSecurityService(Profile* profile);
  ~ChromeTailoredSecurityService() override;

  void OnSyncNotificationMessageRequest(bool is_enabled) override;
#if BUILDFLAG(IS_ANDROID)
  // TabModelObserver::
  void DidAddTab(TabAndroid* tab, TabModel::TabLaunchType type) override;
  // TabModelListObserver::
  void OnTabModelAdded(TabModel* tab_model) override;
  void OnTabModelRemoved(TabModel* tab_model) override;
#endif

#if !BUILDFLAG(IS_ANDROID)
  void TriggerDialogDisplay(
      bool is_enabled,
      user_education::ProductMessagingHandle messaging_priority_handle);
  void ReleaseEnabledQueueHandle();
  void ReleaseDisabledQueueHandle();
  void QueueNotice(bool is_enabled);
#endif

 protected:
#if !BUILDFLAG(IS_ANDROID)
  // Shows a dialog on the provided `browser`. If `show_enable_dialog` is
  // true, display the enabled dialog; otherwise show the disabled dialog.
  // This method is virtual to support testing.
  virtual void DisplayDesktopDialog(BrowserWindowInterface* browser,
                                    bool show_enable_dialog);
#endif

  scoped_refptr<network::SharedURLLoaderFactory> GetURLLoaderFactory() override;

 private:
  FRIEND_TEST_ALL_PREFIXES(ChromeTailoredSecurityServiceTest,
                           WhenRetryNeededAndEnoughTimeHasPassedRetries);
  FRIEND_TEST_ALL_PREFIXES(
      ChromeTailoredSecurityServiceTest,
      WhenRetryNeededButNotEnoughTimeHasPassedDoesNotRetry);
  FRIEND_TEST_ALL_PREFIXES(
      ChromeTailoredSecurityServiceTest,
      WhenRetryNotSetAndEnhancedProtectionEnabledViaTailoredSecurityDoesNotSetNextSyncFlowTimestamp);
  FRIEND_TEST_ALL_PREFIXES(
      ChromeTailoredSecurityServiceTest,
      WhenRetryNotSetAndNextSyncFlowHasNotPassedDoesNotRunRetryLogic);
  FRIEND_TEST_ALL_PREFIXES(
      ChromeTailoredSecurityServiceTest,
      WhenRetryNotSetAndNextSyncFlowNotSetSetsNextSyncFlowToWaitingIntervalFromNow);
  FRIEND_TEST_ALL_PREFIXES(ChromeTailoredSecurityServiceTest,
                           WhenRetryNotSetAndNextSyncFlowHasPassedRunsRetry);

  // These values are persisted to logs. Entries should not be renumbered and
  // numeric values should never be reused.
  enum class TailoredSecurityShouldRetryOutcome {
    kUnknownType = 0,
    kRetryNeededDoRetry = 1,
    kRetryNeededKeepWaiting = 2,
    kUnsetInitializeWaitingPeriod = 3,
    kUnsetRetryBecauseDoneWaiting = 4,
    kUnsetStillWaiting = 5,
    kMaxValue = kUnsetStillWaiting,
  };

  friend void LogShouldRetryOutcome(
      ChromeTailoredSecurityService::TailoredSecurityShouldRetryOutcome
          outcome);

#if BUILDFLAG(IS_ANDROID)
  void MessageDismissed();

  // Registers this as an observer on the TabModelList and, if possible, on a
  // TabModel.
  void RegisterObserver();
  void AddTabModelListObserver();
  void AddTabModelObserver();
  void RemoveTabModelListObserver();
  void RemoveTabModelObserver();
  // This tab model is used for the observer based retry mechanism.
  // We can't depend on this being set as a tab can be deleted at
  // any time.
  raw_ptr<TabModel> observed_tab_model_ = nullptr;
  bool observing_tab_model_list_ = false;
  std::unique_ptr<TailoredSecurityConsentedModalAndroid> message_;
#else
  TailoredSecurityDesktopDialogManager dialog_manager_;
#endif

  void MaybeRetryForSyncUsers();
  bool ShouldRetryForSyncUsers();

  raw_ptr<Profile> profile_;

  base::OneShotTimer retry_timer_;
  // The retry handler used to manage retry logic.
  std::unique_ptr<MessageRetryHandler> retry_handler_;

#if !BUILDFLAG(IS_ANDROID)
  user_education::ProductMessagingHandle enabled_notice_handle_;
  user_education::ProductMessagingHandle disabled_notice_handle_;
  base::WeakPtrFactory<ChromeTailoredSecurityService> weak_factory_{this};
#endif
};

}  // namespace safe_browsing

#endif  // CHROME_BROWSER_SAFE_BROWSING_TAILORED_SECURITY_CHROME_TAILORED_SECURITY_SERVICE_H_