Source code

Revision control

Other Tools

1
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
3
/* This Source Code Form is subject to the terms of the Mozilla Public
4
* License, v. 2.0. If a copy of the MPL was not distributed with this
5
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6
7
#ifndef mozilla_dom_StorageNotifierService_h
8
#define mozilla_dom_StorageNotifierService_h
9
10
class nsPIDOMWindowInner;
11
12
namespace mozilla {
13
namespace dom {
14
15
class StorageEvent;
16
17
/**
18
* Enables the StorageNotifierService to check whether an observer is interested
19
* in receiving events for the given principal before calling the method, an
20
* optimization refactoring.
21
*
22
* Expected to only be implemented by nsGlobalWindowObserver or its succesor.
23
*/
24
class StorageNotificationObserver {
25
public:
26
NS_INLINE_DECL_PURE_VIRTUAL_REFCOUNTING
27
28
virtual void ObserveStorageNotification(StorageEvent* aEvent,
29
const char16_t* aStorageType,
30
bool aPrivateBrowsing) = 0;
31
32
virtual bool IsPrivateBrowsing() const = 0;
33
34
virtual nsIPrincipal* GetEffectiveStoragePrincipal() const = 0;
35
36
virtual nsIEventTarget* GetEventTarget() const = 0;
37
};
38
39
/**
40
* A specialized version of the observer service that uses the custom
41
* StorageNotificationObserver so that principal checks can happen in this class
42
* rather than in the nsIObserver::observe method where they used to happen.
43
*
44
* The only expected consumers are nsGlobalWindowInner instances via their
45
* nsGlobalWindowObserver helper that avoids being able to use the window as an
46
* nsIObserver.
47
*/
48
class StorageNotifierService final {
49
public:
50
NS_INLINE_DECL_REFCOUNTING(StorageNotifierService)
51
52
static StorageNotifierService* GetOrCreate();
53
54
static void Broadcast(StorageEvent* aEvent, const char16_t* aStorageType,
55
bool aPrivateBrowsing, bool aImmediateDispatch);
56
57
void Register(StorageNotificationObserver* aObserver);
58
59
void Unregister(StorageNotificationObserver* aObserver);
60
61
private:
62
StorageNotifierService();
63
~StorageNotifierService();
64
65
nsTObserverArray<RefPtr<StorageNotificationObserver>> mObservers;
66
};
67
68
} // namespace dom
69
} // namespace mozilla
70
71
#endif // mozilla_dom_StorageNotifierService_h