File: state_store.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (198 lines) | stat: -rw-r--r-- 6,558 bytes parent folder | download | duplicates (9)
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
// 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.

#include "extensions/browser/state_store.h"

#include <stddef.h>

#include <utility>

#include "base/functional/bind.h"
#include "base/location.h"
#include "base/observer_list.h"
#include "components/value_store/value_store_factory.h"
#include "content/public/browser/browser_context.h"
#include "content/public/browser/browser_task_traits.h"
#include "content/public/browser/browser_thread.h"
#include "extensions/browser/extension_file_task_runner.h"
#include "extensions/common/constants.h"
#include "extensions/common/extension.h"
#include "extensions/common/extension_id.h"

namespace {

std::string GetFullKey(const extensions::ExtensionId& extension_id,
                       const std::string& key) {
  return extension_id + "." + key;
}

}  // namespace

namespace extensions {

// Helper class to delay tasks until we're ready to start executing them.
class StateStore::DelayedTaskQueue {
 public:
  DelayedTaskQueue() : ready_(false) {}
  ~DelayedTaskQueue() {}

  // Queues up a task for invoking once we're ready. Invokes immediately if
  // we're already ready.
  void InvokeWhenReady(base::OnceClosure task);

  // Marks us ready, and invokes all pending tasks.
  void SetReady();

  // Return whether or not the DelayedTaskQueue is |ready_|.
  bool ready() const { return ready_; }

 private:
  bool ready_;
  std::vector<base::OnceClosure> pending_tasks_;
};

void StateStore::DelayedTaskQueue::InvokeWhenReady(base::OnceClosure task) {
  if (ready_) {
    std::move(task).Run();
  } else {
    pending_tasks_.push_back(std::move(task));
  }
}

void StateStore::DelayedTaskQueue::SetReady() {
  ready_ = true;

  for (base::OnceClosure& task : pending_tasks_)
    std::move(task).Run();
  pending_tasks_.clear();
}

StateStore::StateStore(
    content::BrowserContext* context,
    const scoped_refptr<value_store::ValueStoreFactory>& store_factory,
    BackendType backend_type,
    bool deferred_load)
    : task_queue_(std::make_unique<DelayedTaskQueue>()) {
  switch (backend_type) {
    case BackendType::RULES:
      store_ = std::make_unique<value_store::ValueStoreFrontend>(
          store_factory, base::FilePath(kRulesStoreName),
          kRulesDatabaseUMAClientName, content::GetUIThreadTaskRunner({}),
          GetExtensionFileTaskRunner());
      break;
    case BackendType::STATE:
      store_ = std::make_unique<value_store::ValueStoreFrontend>(
          store_factory, base::FilePath(kStateStoreName),
          kStateDatabaseUMAClientName, content::GetUIThreadTaskRunner({}),
          GetExtensionFileTaskRunner());
      break;
    case BackendType::SCRIPTS:
      store_ = std::make_unique<value_store::ValueStoreFrontend>(
          store_factory, base::FilePath(kScriptsStoreName),
          kScriptsDatabaseUMAClientName, content::GetUIThreadTaskRunner({}),
          GetExtensionFileTaskRunner());
      break;
  }

  extension_registry_observation_.Observe(ExtensionRegistry::Get(context));

  if (deferred_load) {
    // Call `Init()` asynchronously with a low priority to not delay startup.
    content::GetUIThreadTaskRunner({base::TaskPriority::USER_VISIBLE})
        ->PostTask(FROM_HERE, base::BindOnce(&StateStore::Init,
                                             weak_ptr_factory_.GetWeakPtr()));
  } else {
    Init();
  }
}

StateStore::~StateStore() {
}

void StateStore::RegisterKey(const std::string& key) {
  registered_keys_.insert(key);
}

void StateStore::GetExtensionValue(const ExtensionId& extension_id,
                                   const std::string& key,
                                   ReadCallback callback) {
  task_queue_->InvokeWhenReady(base::BindOnce(
      &value_store::ValueStoreFrontend::Get, base::Unretained(store_.get()),
      GetFullKey(extension_id, key), std::move(callback)));
}

void StateStore::SetExtensionValue(const ExtensionId& extension_id,
                                   const std::string& key,
                                   base::Value value) {
  for (TestObserver& observer : observers_)
    observer.WillSetExtensionValue(extension_id, key);

  task_queue_->InvokeWhenReady(base::BindOnce(
      &value_store::ValueStoreFrontend::Set, base::Unretained(store_.get()),
      GetFullKey(extension_id, key), std::move(value)));
}

void StateStore::RemoveExtensionValue(const ExtensionId& extension_id,
                                      const std::string& key) {
  task_queue_->InvokeWhenReady(base::BindOnce(
      &value_store::ValueStoreFrontend::Remove, base::Unretained(store_.get()),
      GetFullKey(extension_id, key)));
}

void StateStore::AddObserver(TestObserver* observer) {
  observers_.AddObserver(observer);
}

void StateStore::RemoveObserver(TestObserver* observer) {
  observers_.RemoveObserver(observer);
}

void StateStore::FlushForTesting(base::OnceClosure flushed_callback) {
  // Look up a key in the database. This serves as a roundtrip to the DB and
  // back; the value of the key doesn't matter.
  GetExtensionValue("fake_id", "fake_key",
                    base::BindOnce(
                        [](base::OnceClosure flushed_callback,
                           std::optional<base::Value> ignored) {
                          std::move(flushed_callback).Run();
                        },
                        std::move(flushed_callback)));
}

bool StateStore::IsInitialized() const {
  return task_queue_->ready();
}

void StateStore::OnExtensionWillBeInstalled(
    content::BrowserContext* browser_context,
    const Extension* extension,
    bool is_update,
    const std::string& old_name) {
  RemoveKeysForExtension(extension->id());
}

void StateStore::OnExtensionUninstalled(
    content::BrowserContext* browser_context,
    const Extension* extension,
    extensions::UninstallReason reason) {
  RemoveKeysForExtension(extension->id());
}

void StateStore::Init() {
  // TODO(cmumford): The store now always lazily initializes upon first access.
  // A follow-on CL will remove this deferred initialization implementation
  // which is now vestigial.
  task_queue_->SetReady();
}

void StateStore::RemoveKeysForExtension(const ExtensionId& extension_id) {
  for (auto key = registered_keys_.begin(); key != registered_keys_.end();
       ++key) {
    task_queue_->InvokeWhenReady(base::BindOnce(
        &value_store::ValueStoreFrontend::Remove,
        base::Unretained(store_.get()), GetFullKey(extension_id, *key)));
  }
}

}  // namespace extensions