summaryrefslogtreecommitdiffstats
path: root/dom/storage/StorageObserver.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
commit2aa4a82499d4becd2284cdb482213d541b8804dd (patch)
treeb80bf8bf13c3766139fbacc530efd0dd9d54394c /dom/storage/StorageObserver.h
parentInitial commit. (diff)
downloadfirefox-2aa4a82499d4becd2284cdb482213d541b8804dd.tar.xz
firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.zip
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/storage/StorageObserver.h')
-rw-r--r--dom/storage/StorageObserver.h75
1 files changed, 75 insertions, 0 deletions
diff --git a/dom/storage/StorageObserver.h b/dom/storage/StorageObserver.h
new file mode 100644
index 0000000000..3d359d4ea4
--- /dev/null
+++ b/dom/storage/StorageObserver.h
@@ -0,0 +1,75 @@
+/* -*- 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_dom_StorageObserver_h
+#define mozilla_dom_StorageObserver_h
+
+#include "nsIObserver.h"
+#include "nsITimer.h"
+#include "nsWeakReference.h"
+#include "nsTObserverArray.h"
+#include "nsString.h"
+
+namespace mozilla {
+namespace dom {
+
+class StorageObserver;
+
+// Main-thread interface implemented by legacy LocalStorageManager and current
+// SessionStorageManager for direct consumption. Also implemented by legacy
+// StorageDBParent and current SessionStorageObserverParent for propagation to
+// content processes.
+class StorageObserverSink {
+ public:
+ virtual ~StorageObserverSink() = default;
+
+ private:
+ friend class StorageObserver;
+ virtual nsresult Observe(const char* aTopic,
+ const nsAString& aOriginAttributesPattern,
+ const nsACString& aOriginScope) = 0;
+};
+
+// Statically (through layout statics) initialized observer receiving and
+// processing chrome clearing notifications, such as cookie deletion etc.
+class StorageObserver : public nsIObserver, public nsSupportsWeakReference {
+ public:
+ NS_DECL_ISUPPORTS
+ NS_DECL_NSIOBSERVER
+
+ static nsresult Init();
+ static nsresult Shutdown();
+ static StorageObserver* Self() { return sSelf; }
+
+ void AddSink(StorageObserverSink* aObs);
+ void RemoveSink(StorageObserverSink* aObs);
+ void Notify(const char* aTopic,
+ const nsAString& aOriginAttributesPattern = u""_ns,
+ const nsACString& aOriginScope = ""_ns);
+
+ void NoteBackgroundThread(uint32_t aPrivateBrowsingId,
+ nsIEventTarget* aBackgroundThread);
+
+ private:
+ virtual ~StorageObserver() = default;
+
+ nsresult GetOriginScope(const char16_t* aData, nsACString& aOriginScope);
+
+ static void TestingPrefChanged(const char* aPrefName, void* aClosure);
+
+ static StorageObserver* sSelf;
+
+ nsCOMPtr<nsIEventTarget> mBackgroundThread[2];
+
+ // Weak references
+ nsTObserverArray<StorageObserverSink*> mSinks;
+ nsCOMPtr<nsITimer> mDBThreadStartDelayTimer;
+};
+
+} // namespace dom
+} // namespace mozilla
+
+#endif // mozilla_dom_StorageObserver_h