1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/* 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_nsCookieBannerService_h__
#define mozilla_nsCookieBannerService_h__
#include "nsICookieBannerRule.h"
#include "nsICookieBannerService.h"
#include "nsICookieBannerListService.h"
#include "nsCOMPtr.h"
#include "nsTHashMap.h"
#include "nsIObserver.h"
#include "mozilla/RefPtr.h"
#include "mozilla/StaticPtr.h"
namespace mozilla {
class CookieBannerDomainPrefService;
class nsCookieBannerService final : public nsIObserver,
public nsICookieBannerService {
NS_DECL_ISUPPORTS
NS_DECL_NSIOBSERVER
NS_DECL_NSICOOKIEBANNERSERVICE
public:
static already_AddRefed<nsCookieBannerService> GetSingleton();
private:
nsCookieBannerService() = default;
~nsCookieBannerService() = default;
// Whether the service is enabled and ready to accept requests.
bool mIsInitialized = false;
nsCOMPtr<nsICookieBannerListService> mListService;
RefPtr<CookieBannerDomainPrefService> mDomainPrefService;
// Map of site specific cookie banner rules keyed by domain.
nsTHashMap<nsCStringHashKey, nsCOMPtr<nsICookieBannerRule>> mRules;
// Map of global cookie banner rules keyed by id.
nsTHashMap<nsCStringHashKey, nsCOMPtr<nsICookieBannerRule>> mGlobalRules;
// Pref change callback which initializes and shuts down the service. This is
// also called on startup.
static void OnPrefChange(const char* aPref, void* aData);
/**
* Initializes internal state. Will be called on profile-after-change and on
* pref changes.
*/
[[nodiscard]] nsresult Init();
/**
* Cleanup method to be called on shutdown or pref change.
*/
[[nodiscard]] nsresult Shutdown();
nsresult GetClickRulesForDomainInternal(
const nsACString& aDomain, const bool aIsTopLevel,
nsTArray<RefPtr<nsIClickRule>>& aRules);
nsresult GetCookieRulesForDomainInternal(
const nsACString& aBaseDomain, const nsICookieBannerService::Modes aMode,
const bool aIsTopLevel, nsTArray<RefPtr<nsICookieRule>>& aCookies);
nsresult HasRuleForBrowsingContextInternal(
mozilla::dom::BrowsingContext* aBrowsingContext, bool aIgnoreDomainPref,
bool& aHasClickRule, bool& aHasCookieRule);
nsresult GetRuleForDomain(const nsACString& aDomain,
nsICookieBannerRule** aRule);
nsresult GetServiceModeForBrowsingContext(
dom::BrowsingContext* aBrowsingContext, bool aIgnoreDomainPref,
nsICookieBannerService::Modes* aMode);
/**
* Lookup a domain pref by base domain.
*/
nsresult GetDomainPrefInternal(const nsACString& aBaseDomain,
const bool aIsPrivate,
nsICookieBannerService::Modes* aModes);
nsresult SetDomainPrefInternal(nsIURI* aTopLevelURI,
nsICookieBannerService::Modes aModes,
const bool aIsPrivate,
const bool aPersistInPrivateBrowsing);
void DailyReportTelemetry();
// A record that stores whether we have executed the banner click for the
// context.
typedef struct ExecutedData {
ExecutedData()
: countExecutedInTop(0),
countExecutedInFrame(0),
countExecutedInTopPrivate(0),
countExecutedInFramePrivate(0) {}
uint8_t countExecutedInTop;
uint8_t countExecutedInFrame;
uint8_t countExecutedInTopPrivate;
uint8_t countExecutedInFramePrivate;
} ExecutedData;
// Map of the sites (eTLD+1) that we have executed the cookie banner handling
// for this session.
nsTHashMap<nsCStringHashKey, ExecutedData> mExecutedDataForSites;
};
} // namespace mozilla
#endif
|
