chrome/browser/content_settings/one_time_permission_provider.h

// Copyright 2023 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_CONTENT_SETTINGS_ONE_TIME_PERMISSION_PROVIDER_H_
#define CHROME_BROWSER_CONTENT_SETTINGS_ONE_TIME_PERMISSION_PROVIDER_H_

#include <map>
#include <set>

#include "base/memory/raw_ptr.h"
#include "base/power_monitor/power_observer.h"
#include "base/time/time.h"
#include "chrome/browser/permissions/one_time_permissions_tracker_observer.h"
#include "components/content_settings/core/browser/content_settings_origin_value_map.h"
#include "components/content_settings/core/browser/content_settings_rule.h"
#include "components/content_settings/core/browser/user_modifiable_provider.h"
#include "components/content_settings/core/common/content_settings.h"
#include "components/content_settings/core/common/content_settings_pattern.h"
#include "components/content_settings/core/common/content_settings_types.h"
#include "components/permissions/permission_uma_util.h"

class OneTimePermissionsTracker;

// Stores one-time permission grants that expire when any of the following
// conditions is met:
// - All tabs of that origin have been closed or navigated away
// - All tabs of that origin have been discarded
// - All tabs of that origin have been backgrounded (without visible indicator)
//     for more than 5 minutes
// - `kOneTimePermissionMaximumLifetime` has elapsed since the one-time grant
// - The grant is manually revoked (via page info, settings, or a policy)
class OneTimePermissionProvider
    : public content_settings::UserModifiableProvider,
      public OneTimePermissionsTrackerObserver,
      public base::PowerSuspendObserver {
 public:
  explicit OneTimePermissionProvider(
      OneTimePermissionsTracker* one_time_permissions_tracker);

  ~OneTimePermissionProvider() override;

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

  // UserModifiableProvider:
  std::unique_ptr<content_settings::RuleIterator> GetRuleIterator(
      ContentSettingsType content_type,
      bool incognito) const override;
  std::unique_ptr<content_settings::Rule> GetRule(
      const GURL& primary_url,
      const GURL& secondary_url,
      ContentSettingsType content_type,
      bool off_the_record) const override;
  bool SetWebsiteSetting(
      const ContentSettingsPattern& primary_pattern,
      const ContentSettingsPattern& secondary_pattern,
      ContentSettingsType content_type,
      base::Value&& value,
      const content_settings::ContentSettingConstraints& constraints) override;
  void ClearAllContentSettingsRules(ContentSettingsType content_type) override;
  void ShutdownOnUIThread() override;
  bool UpdateLastUsedTime(const GURL& primary_url,
                          const GURL& secondary_url,
                          ContentSettingsType content_type,
                          const base::Time time) override;
  bool ResetLastVisitTime(const ContentSettingsPattern& primary_pattern,
                          const ContentSettingsPattern& secondary_pattern,
                          ContentSettingsType content_type) override;
  bool UpdateLastVisitTime(const ContentSettingsPattern& primary_pattern,
                           const ContentSettingsPattern& secondary_pattern,
                           ContentSettingsType content_type) override;
  std::optional<base::TimeDelta> RenewContentSetting(
      const GURL& primary_url,
      const GURL& secondary_url,
      ContentSettingsType type,
      std::optional<ContentSetting> setting_to_match) override;
  void SetClockForTesting(const base::Clock* clock) override;

  void ExpireWebsiteSetting(const ContentSettingsPattern& primary_pattern,
                            const ContentSettingsPattern& secondary_pattern,
                            ContentSettingsType content_settings_type) override;

  // PowerSuspendObserver:
  void OnSuspend() override;

  // OneTimePermissionsTrackerObserver:
  void OnLastPageFromOriginClosed(const url::Origin&) override;
  void OnAllTabsInBackgroundTimerExpired(
      const url::Origin& origin,
      const BackgroundExpiryType& expiry_type) override;
  void OnCapturingVideoExpired(const url::Origin&) override;
  void OnCapturingAudioExpired(const url::Origin&) override;

  void OnShutdown() override;

 private:
  struct ContentSettingEntry {
    ContentSettingsType type;
    ContentSettingsPattern primary_pattern;
    ContentSettingsPattern secondary_pattern;
  };

  void DeleteEntriesAndNotify(
      const std::vector<ContentSettingEntry>& entries_to_delete);

  // Deletes the matching entries and records matching UMA events.
  void DeleteEntriesMatchingGURL(
      ContentSettingsType content_setting_type,
      const GURL& origin_gurl,
      permissions::OneTimePermissionEvent trigger_event);

  content_settings::OriginValueMap value_map_;
  raw_ptr<OneTimePermissionsTracker> one_time_permissions_tracker_ = nullptr;

  // Unowned
  raw_ptr<const base::Clock> clock_;
};

#endif  // CHROME_BROWSER_CONTENT_SETTINGS_ONE_TIME_PERMISSION_PROVIDER_H_