// Copyright 2016 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_SIGNIN_SIGNIN_PROMO_UTIL_H_
#define CHROME_BROWSER_SIGNIN_SIGNIN_PROMO_UTIL_H_

#include "base/memory/raw_ref.h"
#include "base/scoped_observation.h"
#include "build/build_config.h"
#include "chrome/browser/signin/signin_promo.h"
#include "components/signin/public/base/signin_buildflags.h"
#include "components/signin/public/base/signin_prefs.h"
#include "components/signin/public/identity_manager/account_info.h"
#include "components/signin/public/identity_manager/identity_manager.h"
#include "extensions/buildflags/buildflags.h"

class Profile;

namespace signin_metrics {
enum class AccessPoint;
}

namespace autofill {
class AutofillProfile;
}

#if BUILDFLAG(ENABLE_EXTENSIONS)
namespace extensions {
class Extension;
}

class PrefService;

#endif  // BUILDFLAG(ENABLE_EXTENSIONS)

namespace signin {

class AccountPreviewDataService;

enum class SignInPromoType;

#if BUILDFLAG(ENABLE_EXTENSIONS)
// Whether we should show the sign in promo after an extension was installed.
bool ShouldShowExtensionSignInPromo(Profile& profile,
                                    const extensions::Extension& extension);
#endif  // BUILDFLAG(ENABLE_EXTENSIONS)

// Whether we should show the sign in promo after a password was saved.
bool ShouldShowPasswordSignInPromo(Profile& profile);

// Whether we should show the sign in promo after `address` was saved.
bool ShouldShowAddressSignInPromo(Profile& profile,
                                  const autofill::AutofillProfile& address);

// Returns true if the Search AI Mode sign in promo should be shown.
bool ShouldShowSearchAIModeSignInPromo(Profile& profile);

// Whether we should show the sign in promo after a bookmark was saved.
bool ShouldShowBookmarkSignInPromo(Profile& profile);

// Returns true if the Composebox Drive context menu option sign in promo
// should be shown.
bool ShouldShowComposeboxDriveContextMenuOptionSignInPromo(Profile& profile);

// Returns whether `access_point` has an equivalent signin promo which is its
// own bubble, rather than a footnote.
bool IsBubbleSigninPromo(signin_metrics::AccessPoint access_point);

// Returns whether `access_point` has an equivalent signin promo.
bool IsSignInPromo(signin_metrics::AccessPoint access_point);

SignInPromoType GetSignInPromoTypeFromAccessPoint(
    signin_metrics::AccessPoint access_point);

#if BUILDFLAG(ENABLE_DICE_SUPPORT)
// Records that the sign in promo was shown, either for the account used for the
// promo, or for the profile if there is no account available.
void RecordSignInPromoShown(signin_metrics::AccessPoint access_point,
                            Profile* profile);

// Structure containing information needed for the promos.
struct ProfileMenuAvatarButtonPromoInfo {
  // Different promo types that can be shown in the ProfileMenu and
  // AvatarButton.
  // These values are persisted to logs. Entries should not be renumbered and
  // numeric values should never be reused.
  //
  // LINT.IfChange(ProfileMenuAvatarButtonPromoType)
  enum class Type {
    kHistorySyncPromo = 0,
    kBatchUploadPromo = 1,
    kBatchUploadBookmarksPromo = 2,
    kBatchUploadWindows10DepreciationPromo = 3,
    kSyncPromo = 4,
    kSigninPromo = 5,

    kMaxValue = kSigninPromo,
  };
  // LINT.ThenChange(//tools/metrics/histograms/metadata/signin/enums.xml:ProfileMenuAvatarButtonPromoType)

  std::optional<Type> type;
  size_t local_data_count = 0;

  friend bool operator==(const ProfileMenuAvatarButtonPromoInfo& info1,
                         const ProfileMenuAvatarButtonPromoInfo& info2) =
      default;
};

// Returns true if the sign-in promo for `promo_type` should use the legacy
// global Autofill sign-in promo limits. This is true when the limits
// experiment is disabled and the promo type is not Search AI Mode.
bool ShouldUseAutofillSignInPromoLimits(signin::SignInPromoType promo_type);

// Records the show count at which the AvatarButton was showing `promo_type`
// for `gaia_id` that lead to the promo being accepted. `gaia_id` may be empty
// which will record the value from the Profile prefs.
void RecordAvatarButtonPromoAcceptedAtPromoShownCount(
    ProfileMenuAvatarButtonPromoInfo::Type promo_type,
    const GaiaId& gaia_id,
    PrefService& prefs);

// Access point used to mark the source from the AvatarButton click event for
// HistorySync promo.
inline constexpr signin_metrics::AccessPoint
    kHistoryOptinAvatarPromoAccessPoint =
        signin_metrics::AccessPoint::kHistorySyncOptinExpansionPillOnStartup;

// Based on the `profile` current state, compute the data to be shown for the
// promos, if any, based on the promo priority and the profile state. The promo
// between the ProfileMenu and the AvatarButton should always be aligned.
void ComputeProfileMenuAvatarButtonPromoInfo(
    Profile& profile,
    base::OnceCallback<void(ProfileMenuAvatarButtonPromoInfo)> result_callback);

// This class manages the Signin State and Used/Shown count for the AvatarButton
// promos based on the `ProfileMenuAvatarButtonPromoInfo::Type` that is
// inquired.
// It does not take care of the PromoType computation, which is done separately
// via `ComputeProfileMenuAvatarButtonPromoInfo()`.
class AvatarButtonPromoManager : public signin::IdentityManager::Observer {
 public:
  AvatarButtonPromoManager(
      signin::IdentityManager* identity_manager,
      signin::AccountPreviewDataService* account_preview_data_service,
      PrefService* pref_service);
  // Used only for testing.
  AvatarButtonPromoManager(
      signin::IdentityManager* identity_manager,
      signin::AccountPreviewDataService* account_preview_data_service,
      PrefService* pref_service,
      int max_shown_count,
      int max_used_count);
  ~AvatarButtonPromoManager() override;

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

  AvatarButtonPromoManager(AvatarButtonPromoManager&&) = delete;
  AvatarButtonPromoManager& operator=(AvatarButtonPromoManager&&) = delete;

  static void RegisterProfilePrefs(PrefRegistrySimple* registry);

  bool ShouldShowPromo(ProfileMenuAvatarButtonPromoInfo::Type promo_type);
  void RecordPromoShown(ProfileMenuAvatarButtonPromoInfo::Type promo_type);
  // Returns the `GaiaId` of the account tied to the promo being used. Might
  // return an empty `GaiaID` if no account is tied to the promo.
  GaiaId RecordPromoUsed(ProfileMenuAvatarButtonPromoInfo::Type promo_type);

  // signin::IdentityManager::Observer:
  void OnIdentityManagerShutdown(IdentityManager* identity_manager) override;

 private:
  bool ArePromotionsEnabled() const;

  bool IsSigninStateAlignedWithPromoType(
      ProfileMenuAvatarButtonPromoInfo::Type promo_type) const;

  raw_ptr<signin::IdentityManager> identity_manager_;
  // Only nullptr after the `identity_manager_` starts shutting down.
  std::unique_ptr<SigninPrefs> signin_prefs_;
  raw_ptr<PrefService> pref_service_;
  raw_ptr<signin::AccountPreviewDataService> account_preview_data_service_ =
      nullptr;

  const int max_shown_count_ = 0;
  const int max_used_count_ = 0;

  base::ScopedObservation<signin::IdentityManager,
                          signin::IdentityManager::Observer>
      identity_manager_scoped_observation_{this};
};
#endif  // BUILDFLAG(ENABLE_DICE_SUPPORT)

}  // namespace signin

#endif  // CHROME_BROWSER_SIGNIN_SIGNIN_PROMO_UTIL_H_