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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_COOKIES_COOKIE_MONSTER_CHANGE_DISPATCHER_H_
#define NET_COOKIES_COOKIE_MONSTER_CHANGE_DISPATCHER_H_
#include <map>
#include <memory>
#include <string>
#include "base/callback_list.h"
#include "base/containers/linked_list.h"
#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"
#include "base/task/single_thread_task_runner.h"
#include "base/threading/thread_checker.h"
#include "net/cookies/cookie_change_dispatcher.h"
#include "net/cookies/cookie_partition_key_collection.h"
#include "url/gurl.h"
namespace net {
class CookieAccessDelegate;
class CookieMonster;
// CookieChangeDispatcher implementation used by CookieMonster.
class CookieMonsterChangeDispatcher : public CookieChangeDispatcher {
public:
using CookieChangeCallbackList =
base::RepeatingCallbackList<void(const CookieChangeInfo&)>;
// Expects |cookie_monster| to outlive this.
explicit CookieMonsterChangeDispatcher(const CookieMonster* cookie_monster);
CookieMonsterChangeDispatcher(const CookieMonsterChangeDispatcher&) = delete;
CookieMonsterChangeDispatcher& operator=(
const CookieMonsterChangeDispatcher&) = delete;
~CookieMonsterChangeDispatcher() override;
// The key in CookieNameMap for a cookie name.
static std::string NameKey(std::string name);
// The key in CookieDomainName for a cookie domain.
static std::string DomainKey(const std::string& domain);
// The key in CookieDomainName for a listener URL.
static std::string DomainKey(const GURL& url);
// net::CookieChangeDispatcher
[[nodiscard]] std::unique_ptr<CookieChangeSubscription> AddCallbackForCookie(
const GURL& url,
const std::string& name,
const std::optional<CookiePartitionKey>& cookie_partition_key,
CookieChangeCallback callback) override;
[[nodiscard]] std::unique_ptr<CookieChangeSubscription> AddCallbackForUrl(
const GURL& url,
const std::optional<CookiePartitionKey>& cookie_partition_key,
CookieChangeCallback callback) override;
[[nodiscard]] std::unique_ptr<CookieChangeSubscription>
AddCallbackForAllChanges(CookieChangeCallback callback) override;
// |notify_global_hooks| is true if the function should run the
// global hooks in addition to the per-cookie hooks.
//
// TODO(pwnall): Remove |notify_global_hooks| and fix consumers.
void DispatchChange(const CookieChangeInfo& change, bool notify_global_hooks);
private:
class Subscription : public base::LinkNode<Subscription>,
public CookieChangeSubscription {
public:
Subscription(base::WeakPtr<CookieMonsterChangeDispatcher> change_dispatcher,
std::string domain_key,
std::string name_key,
GURL url,
CookiePartitionKeyCollection cookie_partition_key_collection,
net::CookieChangeCallback callback);
Subscription(const Subscription&) = delete;
Subscription& operator=(const Subscription&) = delete;
~Subscription() override;
// The lookup key used in the domain subscription map.
//
// The empty string means no domain filtering.
const std::string& domain_key() const { return domain_key_; }
// The lookup key used in the name subscription map.
//
// The empty string means no name filtering.
const std::string& name_key() const { return name_key_; }
// Dispatches a cookie change notification if the listener is interested.
void DispatchChange(const CookieChangeInfo& change,
const CookieAccessDelegate* cookie_access_delegate);
private:
base::WeakPtr<CookieMonsterChangeDispatcher> change_dispatcher_;
const std::string domain_key_; // kGlobalDomainKey means no filtering.
const std::string name_key_; // kGlobalNameKey means no filtering.
const GURL url_; // empty() means no URL-based filtering.
const CookiePartitionKeyCollection cookie_partition_key_collection_;
const net::CookieChangeCallback callback_;
void DoDispatchChange(const CookieChangeInfo& change) const;
// Used to post DoDispatchChange() calls to this subscription's thread.
scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
THREAD_CHECKER(thread_checker_);
// Used to cancel delayed calls to DoDispatchChange() when the subscription
// gets destroyed.
base::WeakPtrFactory<Subscription> weak_ptr_factory_{this};
};
// The last level of the subscription data structures.
using SubscriptionList = base::LinkedList<Subscription>;
// Buckets subscriptions according to cookie names.
//
// Map keys are cookie names, as we only support exact name matching.
using CookieNameMap = std::map<std::string, SubscriptionList>;
// Buckets subscriptions according to cookie domains.
//
// Map keys are the eTLD+1 of cookie domains. Cookies are either host-locked,
// or visible to all the subdomain of a given domain. A cookie's scope cannot
// exceed eTLD+1, so we stop there.
using CookieDomainMap = std::map<std::string, CookieNameMap>;
void DispatchChangeToDomainKey(const CookieChangeInfo& change,
const std::string& domain_key);
void DispatchChangeToNameKey(const CookieChangeInfo& change,
CookieNameMap& name_map,
const std::string& name_key);
// Inserts a subscription into the map.
//
// Called by the AddCallback* methods, after creating the Subscription.
void LinkSubscription(Subscription* subscription);
// Removes a subscription from the map.
//
// Called by the Subscription destructor.
void UnlinkSubscription(Subscription* subscription);
raw_ptr<const CookieMonster> cookie_monster_;
CookieDomainMap cookie_domain_map_;
THREAD_CHECKER(thread_checker_);
// Vends weak pointers to subscriptions.
base::WeakPtrFactory<CookieMonsterChangeDispatcher> weak_ptr_factory_{this};
};
} // namespace net
#endif // NET_COOKIES_COOKIE_MONSTER_CHANGE_DISPATCHER_H_
|
