ios/chrome/browser/safety_check_notifications/utils/utils.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 IOS_CHROME_BROWSER_SAFETY_CHECK_NOTIFICATIONS_UTILS_UTILS_H_
#define IOS_CHROME_BROWSER_SAFETY_CHECK_NOTIFICATIONS_UTILS_UTILS_H_

#import <Foundation/Foundation.h>
#import <UserNotifications/UserNotifications.h>

#import <optional>

#import "ios/chrome/browser/passwords/model/password_checkup_utils.h"
#import "ios/chrome/browser/safety_check/model/ios_chrome_safety_check_manager_constants.h"

enum class SafetyCheckNotificationType;
enum class SafetyCheckNotificationsOptInSource;
struct ScheduledNotificationRequest;

// Logs the source of a user's decision to opt-in or opt-out of Safety Check
// notifications. Determines the current notification permission status
// internally using
// `push_notification_settings::GetMobileNotificationPermissionStatusForClient`
// and records the appropriate histogram value in
// `IOS.Notifications.SafetyCheck.NotificationsOptInSource` based on whether
// notifications are enabled or disabled.
void LogSafetyCheckNotificationOptInSource(
    SafetyCheckNotificationsOptInSource opt_in_source,
    SafetyCheckNotificationsOptInSource opt_out_source);

// Returns a notification request for the most critical Password issue
// found using `state` and `insecure_password_counts`. Returns `std::nullopt` if
// no notification request can be created.
std::optional<ScheduledNotificationRequest> GetPasswordNotificationRequest(
    PasswordSafetyCheckState state,
    password_manager::InsecurePasswordCounts insecure_password_counts);

// Returns notification content for the most critical Password issue found using
// `state` and `insecure_password_counts`. Returns `nil` if no notification
// content can be created, i.e., no issue is found.
UNNotificationContent* NotificationForPasswordCheckState(
    PasswordSafetyCheckState state,
    password_manager::InsecurePasswordCounts insecure_password_counts);

// Returns a notification request for the most critical Update Chrome issue
// found using `state`. Returns `std::nullopt` if no notification request can be
// created.
std::optional<ScheduledNotificationRequest> GetUpdateChromeNotificationRequest(
    UpdateChromeSafetyCheckState state);

// Returns notification content for the most critical Update Chrome issue found
// using `state`. Returns `nil` if no notification content can be created, i.e.,
// no issue is found.
UNNotificationContent* NotificationForUpdateChromeCheckState(
    UpdateChromeSafetyCheckState state);

// Returns a notification request for the most critical Safe Browsing issue
// found using `state`. Returns `std::nullopt` if no notification request can be
// created.
std::optional<ScheduledNotificationRequest> GetSafeBrowsingNotificationRequest(
    SafeBrowsingSafetyCheckState state);

// Returns notification content for the most critical Safe Browsing issue found
// using `state`. Returns `nil` if no notification content can be created, i.e.,
// no issue is found.
UNNotificationContent* NotificationForSafeBrowsingCheckState(
    SafeBrowsingSafetyCheckState state);

// Returns the `SafetyCheckNotificationType` for the given `request`, or
// `std::nullopt` if the `request` is not a Safety Check notification.
std::optional<SafetyCheckNotificationType> ParseSafetyCheckNotificationType(
    UNNotificationRequest* request);

#endif  // IOS_CHROME_BROWSER_SAFETY_CHECK_NOTIFICATIONS_UTILS_UTILS_H_