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
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef EXTENSIONS_BROWSER_STATE_STORE_H_
#define EXTENSIONS_BROWSER_STATE_STORE_H_
#include <set>
#include <string>
#include "base/functional/callback.h"
#include "base/memory/weak_ptr.h"
#include "base/observer_list.h"
#include "base/scoped_observation.h"
#include "components/value_store/value_store_frontend.h"
#include "extensions/browser/extension_registry.h"
#include "extensions/browser/extension_registry_observer.h"
#include "extensions/common/extension_id.h"
namespace content {
class BrowserContext;
}
namespace value_store {
class ValueStore;
class ValueStoreFactory;
} // namespace value_store
namespace extensions {
// A storage area for per-extension state that needs to be persisted to disk.
class StateStore : public ExtensionRegistryObserver {
public:
using ReadCallback = value_store::ValueStoreFrontend::ReadCallback;
// The kind of extensions data stored in a backend.
enum class BackendType { RULES, STATE, SCRIPTS };
class TestObserver {
public:
virtual ~TestObserver() {}
virtual void WillSetExtensionValue(const ExtensionId& extension_id,
const std::string& key) = 0;
};
// If `deferred_load` is true, we will defer the database loading until the
// application is less busy on startup.
StateStore(content::BrowserContext* context,
const scoped_refptr<value_store::ValueStoreFactory>& store_factory,
BackendType backend_type,
bool deferred_load);
// This variant is useful for testing (using a mock ValueStore).
StateStore(content::BrowserContext* context,
std::optional<base::Value> store);
StateStore(const StateStore&) = delete;
StateStore& operator=(const StateStore&) = delete;
~StateStore() override;
// Register a key for removal upon extension install/uninstall. We remove
// for install to reset state when an extension upgrades.
void RegisterKey(const std::string& key);
// Get the value associated with the given extension and key, and pass
// it to `callback` asynchronously.
void GetExtensionValue(const ExtensionId& extension_id,
const std::string& key,
ReadCallback callback);
// Sets a value for a given extension and key.
void SetExtensionValue(const ExtensionId& extension_id,
const std::string& key,
base::Value value);
// Removes a value for a given extension and key.
void RemoveExtensionValue(const ExtensionId& extension_id,
const std::string& key);
// Return whether or not the StateStore has initialized itself.
bool IsInitialized() const;
void AddObserver(TestObserver* observer);
void RemoveObserver(TestObserver* observer);
// Flushes the state store (finishes any pending reads and writes). Should
// only be used for testing. Invokes `flushed_callback` upon completion.
void FlushForTesting(base::OnceClosure flushed_callback);
private:
class DelayedTaskQueue;
void Init();
// Removes all keys registered for the given extension.
void RemoveKeysForExtension(const ExtensionId& extension_id);
// ExtensionRegistryObserver implementation.
void OnExtensionUninstalled(content::BrowserContext* browser_context,
const Extension* extension,
extensions::UninstallReason reason) override;
void OnExtensionWillBeInstalled(content::BrowserContext* browser_context,
const Extension* extension,
bool is_update,
const std::string& old_name) override;
// The store that holds our key/values.
std::unique_ptr<value_store::ValueStoreFrontend> store_;
// List of all known keys. They will be cleared for each extension when it is
// (un)installed.
std::set<std::string> registered_keys_;
// Keeps track of tasks we have delayed while starting up.
std::unique_ptr<DelayedTaskQueue> task_queue_;
base::ObserverList<TestObserver>::Unchecked observers_;
base::ScopedObservation<ExtensionRegistry, ExtensionRegistryObserver>
extension_registry_observation_{this};
base::WeakPtrFactory<StateStore> weak_ptr_factory_{this};
};
} // namespace extensions
#endif // EXTENSIONS_BROWSER_STATE_STORE_H_
|
