components/permissions/notifications_engagement_service.h

// Copyright 2022 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_PERMISSIONS_NOTIFICATIONS_ENGAGEMENT_SERVICE_H_
#define COMPONENTS_PERMISSIONS_NOTIFICATIONS_ENGAGEMENT_SERVICE_H_

#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
#include "base/values.h"
#include "components/content_settings/core/browser/host_content_settings_map.h"
#include "components/content_settings/core/common/content_settings.h"
#include "components/keyed_service/core/keyed_service.h"

class GURL;
class PrefService;

namespace content {
class BrowserContext;
}  // namespace content

namespace permissions {

// This class records and stores notification engagement per origin for the
// past 30 days. Engagements per origin are bucketed daily: A notification
// engagement or display is assigned to the midnight in local time.
class NotificationsEngagementService : public KeyedService {
 public:
  explicit NotificationsEngagementService(content::BrowserContext* context,
                                          PrefService* pref_service);

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

  ~NotificationsEngagementService() override = default;

  // KeyedService implementation.
  void Shutdown() override;

  void RecordNotificationDisplayed(const GURL& url);
  void RecordNotificationDisplayed(const GURL& url, int display_count);
  void RecordNotificationInteraction(const GURL& url);

  static std::map<std::pair<ContentSettingsPattern, ContentSettingsPattern>,
                  int>
  GetNotificationCountMapPerPatternPair(const HostContentSettingsMap* hcsm);
  static int GetDailyAverageNotificationCount(
      const base::Value::Dict& engagement);

  static std::string GetBucketLabel(base::Time time);
  static std::optional<base::Time> ParsePeriodBeginFromBucketLabel(
      const std::string& label);

 private:
  void IncrementCounts(const GURL& url,
                       const int display_count_delta,
                       const int click_count_delta);

  static int GetDailyAverageNotificationCount(
      const ContentSettingPatternSource& setting);

  raw_ptr<PrefService> pref_service_;
  raw_ptr<content::BrowserContext> browser_context_;

  // Used to update the notification engagement per URL.
  raw_ptr<HostContentSettingsMap> settings_map_;
};

}  // namespace permissions

#endif  // COMPONENTS_PERMISSIONS_NOTIFICATIONS_ENGAGEMENT_SERVICE_H_