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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_DOM_STORAGE_DOM_STORAGE_CONTEXT_WRAPPER_H_
#define CONTENT_BROWSER_DOM_STORAGE_DOM_STORAGE_CONTEXT_WRAPPER_H_
#include <map>
#include <optional>
#include <string>
#include "base/memory/memory_pressure_listener.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/ref_counted.h"
#include "base/synchronization/lock.h"
#include "base/task/sequenced_task_runner.h"
#include "base/thread_annotations.h"
#include "base/threading/sequence_bound.h"
#include "components/services/storage/public/mojom/local_storage_control.mojom.h"
#include "components/services/storage/public/mojom/session_storage_control.mojom.h"
#include "components/services/storage/public/mojom/storage_usage_info.mojom.h"
#include "content/browser/child_process_security_policy_impl.h"
#include "content/common/content_export.h"
#include "content/public/browser/dom_storage_context.h"
#include "mojo/public/cpp/bindings/message.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "mojo/public/cpp/bindings/remote.h"
#include "storage/browser/quota/storage_policy_observer.h"
#include "third_party/blink/public/common/tokens/tokens.h"
#include "third_party/blink/public/mojom/dom_storage/session_storage_namespace.mojom.h"
#include "third_party/blink/public/mojom/dom_storage/storage_area.mojom.h"
namespace blink {
class StorageKey;
} // namespace blink
namespace storage {
class SpecialStoragePolicy;
} // namespace storage
namespace content {
class SessionStorageNamespaceImpl;
class StoragePartitionImpl;
// This is owned by Storage Partition and encapsulates all its dom storage
// state.
// Can only be accessed on the UI thread, except for the AddNamespace and
// RemoveNamespace methods.
class CONTENT_EXPORT DOMStorageContextWrapper
: public DOMStorageContext,
public base::RefCountedThreadSafe<DOMStorageContextWrapper> {
public:
// Option for PurgeMemory.
enum PurgeOption {
// Determines if purging is required based on the usage and the platform.
PURGE_IF_NEEDED,
// Purge unopened areas only.
PURGE_UNOPENED,
// Purge aggressively, i.e. discard cache even for areas that have
// non-zero open count.
PURGE_AGGRESSIVE,
};
static scoped_refptr<DOMStorageContextWrapper> Create(
StoragePartitionImpl* partition,
scoped_refptr<storage::SpecialStoragePolicy> special_storage_policy);
DOMStorageContextWrapper() = delete;
explicit DOMStorageContextWrapper(StoragePartitionImpl* partition);
DOMStorageContextWrapper(const DOMStorageContextWrapper&) = delete;
DOMStorageContextWrapper& operator=(const DOMStorageContextWrapper&) = delete;
storage::mojom::SessionStorageControl* GetSessionStorageControl();
storage::mojom::LocalStorageControl* GetLocalStorageControl();
void PerformLocalStorageCleanup(base::OnceClosure callback);
void PerformSessionStorageCleanup(base::OnceClosure callback);
using GetSessionStorageUsageCallback =
base::OnceCallback<void(const std::vector<SessionStorageUsageInfo>&)>;
void GetSessionStorageUsage(GetSessionStorageUsageCallback callback);
// DOMStorageContext implementation.
void GetLocalStorageUsage(GetLocalStorageUsageCallback callback) override;
void DeleteLocalStorage(const blink::StorageKey& storage_key,
base::OnceClosure callback) override;
void DeleteSessionStorage(const SessionStorageUsageInfo& usage_info,
base::OnceClosure callback) override;
scoped_refptr<SessionStorageNamespace> RecreateSessionStorage(
const std::string& namespace_id) override;
void StartScavengingUnusedSessionStorage() override;
// Used by content settings to alter the behavior around
// what data to keep and what data to discard at shutdown.
// The policy is not so straight forward to describe, see
// the implementation for details.
void SetForceKeepSessionState();
// Called when the BrowserContext/Profile is going away.
void Shutdown();
void Flush();
void OpenLocalStorage(
const blink::StorageKey& storage_key,
std::optional<blink::LocalFrameToken> local_frame_token,
mojo::PendingReceiver<blink::mojom::StorageArea> receiver,
ChildProcessSecurityPolicyImpl::Handle security_policy_handle,
mojo::ReportBadMessageCallback bad_message_callback);
void BindNamespace(
const std::string& namespace_id,
mojo::ReportBadMessageCallback bad_message_callback,
mojo::PendingReceiver<blink::mojom::SessionStorageNamespace> receiver);
void BindStorageArea(
const blink::StorageKey& storage_key,
std::optional<blink::LocalFrameToken> local_frame_token,
const std::string& namespace_id,
mojo::PendingReceiver<blink::mojom::StorageArea> receiver,
ChildProcessSecurityPolicyImpl::Handle security_policy_handle,
mojo::ReportBadMessageCallback bad_message_callback);
// Pushes information about known Session Storage namespaces down to the
// Storage Service instance after a crash. This in turn allows renderer
// clients to re-establish working connections.
void OnSessionStorageDisconnected();
// Resets LocalStorage related StorageAreas after disconnection.
void OnLocalStorageDisconnected();
private:
friend class DOMStorageContextWrapperTest;
friend class base::RefCountedThreadSafe<DOMStorageContextWrapper>;
friend class SessionStorageNamespaceImpl; // For MaybeGetExistingNamespace()
~DOMStorageContextWrapper() override;
void MaybeBindSessionStorageControl();
void MaybeBindLocalStorageControl();
scoped_refptr<SessionStorageNamespaceImpl> MaybeGetExistingNamespace(
const std::string& namespace_id) const;
// Note: can be called on multiple threads, protected by a mutex.
void AddNamespace(const std::string& namespace_id,
SessionStorageNamespaceImpl* session_namespace);
// Note: can be called on multiple threads, protected by a mutex.
void RemoveNamespace(const std::string& namespace_id);
// Called on UI thread when the system is under memory pressure.
void OnMemoryPressure(
base::MemoryPressureListener::MemoryPressureLevel memory_pressure_level);
void PurgeMemory(PurgeOption purge_option);
void OnStartupUsageRetrieved(
std::vector<storage::mojom::StorageUsageInfoPtr> usage);
void ApplyPolicyUpdates(
std::vector<storage::mojom::StoragePolicyUpdatePtr> policy_updates);
enum class StorageType {
kLocalStorage,
kSessionStorage,
};
bool IsRequestValid(
const StorageType type,
const blink::StorageKey& storage_key,
std::optional<blink::LocalFrameToken> local_frame_token,
ChildProcessSecurityPolicyImpl::Handle security_policy_handle,
mojo::ReportBadMessageCallback bad_message_callback);
// Since the tab restore code keeps a reference to the session namespaces
// of recently closed tabs (see sessions::ContentPlatformSpecificTabData and
// sessions::TabRestoreService), a SessionStorageNamespaceImpl can outlive the
// destruction of the browser window. A session restore can also happen
// without the browser context being shutdown or destroyed in between. The
// design of SessionStorageNamespaceImpl assumes there is only one object per
// namespace. A session restore creates new objects for all tabs while the
// Profile wasn't destructed. This map allows the restored session to re-use
// the SessionStorageNamespaceImpl objects that are still alive thanks to the
// sessions component.
std::map<std::string, raw_ptr<SessionStorageNamespaceImpl, CtnExperimental>>
alive_namespaces_ GUARDED_BY(alive_namespaces_lock_);
mutable base::Lock alive_namespaces_lock_;
// Unowned reference to our owning partition. This is always valid until it's
// reset to null if/when the partition is destroyed. May also be null in
// tests.
raw_ptr<StoragePartitionImpl> partition_;
// To receive memory pressure signals.
std::unique_ptr<base::MemoryPressureListener> memory_pressure_listener_;
// Connections to the partition's Session and Local Storage control interfaces
// within the Storage Service.
mojo::Remote<storage::mojom::SessionStorageControl> session_storage_control_;
mojo::Remote<storage::mojom::LocalStorageControl> local_storage_control_;
std::optional<storage::StoragePolicyObserver> storage_policy_observer_;
};
} // namespace content
#endif // CONTENT_BROWSER_DOM_STORAGE_DOM_STORAGE_CONTEXT_WRAPPER_H_
|
