Adding upstream version 124.0.1.upstream/124.0.1

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 110 insertions, 0 deletions

diff --git a/toolkit/components/antitracking/bouncetrackingprotection/BounceTrackingStateGlobal.h b/toolkit/components/antitracking/bouncetrackingprotection/BounceTrackingStateGlobal.h
new file mode 100644
index 0000000000..6680ceae6f
--- /dev/null
+++ b/toolkit/components/antitracking/bouncetrackingprotection/BounceTrackingStateGlobal.h
@@ -0,0 +1,110 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef mozilla_BounceTrackingStateGlobal_h
+#define mozilla_BounceTrackingStateGlobal_h
+
+#include "BounceTrackingProtectionStorage.h"
+#include "mozilla/WeakPtr.h"
+#include "nsCycleCollectionParticipant.h"
+#include "nsTHashMap.h"
+#include "nsISupports.h"
+
+namespace mozilla {
+
+/**
+ * This class holds the global state maps which are used to keep track of
+ * potential bounce trackers and user activations.
+ * @see BounceTrackingState for the per browser / tab state.
+ *
+ * Updates to the state maps are persisted to storage.
+ */
+class BounceTrackingStateGlobal final {
+ public:
+  NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(BounceTrackingStateGlobal);
+  NS_DECL_CYCLE_COLLECTION_NATIVE_CLASS(BounceTrackingStateGlobal);
+
+  BounceTrackingStateGlobal(BounceTrackingProtectionStorage* aStorage,
+                            const OriginAttributes& aAttrs);
+
+  bool IsPrivateBrowsing() const {
+    return mOriginAttributes.mPrivateBrowsingId !=
+           nsIScriptSecurityManager::DEFAULT_PRIVATE_BROWSING_ID;
+  }
+
+  bool ShouldPersistToDisk() const { return !IsPrivateBrowsing(); }
+
+  bool HasUserActivation(const nsACString& aSiteHost) const;
+
+  // Store a user interaction flag for  the given host. This will remove the
+  // host from the bounce tracker map if it exists.
+  [[nodiscard]] nsresult RecordUserActivation(const nsACString& aSiteHost,
+                                              PRTime aTime,
+                                              bool aSkipStorage = false);
+
+  // Test-only method to clear a user activation flag.
+  [[nodiscard]] nsresult TestRemoveUserActivation(const nsACString& aSiteHost);
+
+  // Clear any user interactions that happened before aTime.
+  [[nodiscard]] nsresult ClearUserActivationBefore(PRTime aTime);
+
+  bool HasBounceTracker(const nsACString& aSiteHost) const;
+
+  // Store a bounce tracker flag for the given host. A host which received user
+  // interaction recently can not be recorded as a bounce tracker.
+  [[nodiscard]] nsresult RecordBounceTracker(const nsACString& aSiteHost,
+                                             PRTime aTime,
+                                             bool aSkipStorage = false);
+
+  // Remove one or many bounce trackers identified by site host.
+  [[nodiscard]] nsresult RemoveBounceTrackers(
+      const nsTArray<nsCString>& aSiteHosts);
+
+  [[nodiscard]] nsresult ClearSiteHost(const nsACString& aSiteHost,
+                                       bool aSkipStorage = false);
+
+  [[nodiscard]] nsresult ClearByTimeRange(
+      PRTime aFrom, Maybe<PRTime> aTo = Nothing(),
+      Maybe<BounceTrackingProtectionStorage::EntryType> aEntryType = Nothing(),
+      bool aSkipStorage = false);
+
+  const nsTHashMap<nsCStringHashKey, PRTime>& UserActivationMapRef() {
+    return mUserActivation;
+  }
+
+  const nsTHashMap<nsCStringHashKey, PRTime>& BounceTrackersMapRef() {
+    return mBounceTrackers;
+  }
+
+ private:
+  ~BounceTrackingStateGlobal() = default;
+
+  // The storage which manages this state global. Used to persist changes to
+  // this state global in storage.
+  // This needs to be a weak pointer to avoid BounceTrackingProtectionStorage
+  // and BounceTrackingStateGlobal holding strong references to each other
+  // leading to memory leaks.
+  WeakPtr<BounceTrackingProtectionStorage> mStorage;
+
+  // Origin attributes this state global is associated with. e.g. if the state
+  // was associated with a PBM window this would set privateBrowsingId: 1.
+  OriginAttributes mOriginAttributes;
+
+  // Map of site hosts to moments. The moments represent the most recent wall
+  // clock time at which the user activated a top-level document on the
+  // associated site host.
+  nsTHashMap<nsCStringHashKey, PRTime> mUserActivation{};
+
+  // Map of site hosts to moments. The moments represent the first wall clock
+  // time since the last execution of the bounce tracking timer at which a page
+  // on the given site host performed an action that could indicate stateful
+  // bounce tracking took place.
+  nsTHashMap<nsCStringHashKey, PRTime> mBounceTrackers{};
+};
+
+}  // namespace mozilla
+
+#endif