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
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_VALUE_STORE_VALUE_STORE_H_
#define CHROME_BROWSER_VALUE_STORE_VALUE_STORE_H_
#include <string>
#include <vector>
#include "base/memory/scoped_ptr.h"
#include "base/values.h"
#include "chrome/browser/value_store/value_store_change.h"
// Interface for a storage area for Value objects.
class ValueStore {
public:
// Error codes returned from storage methods.
enum ErrorCode {
OK,
// The failure was due to some kind of database corruption. Depending on
// what is corrupted, some part of the database may be recoverable.
//
// For example, if the on-disk representation of leveldb is corrupted, it's
// likely the whole database will need to be wiped and started again.
//
// If a single key has been committed with an invalid JSON representation,
// just that key can be deleted without affecting the rest of the database.
CORRUPTION,
// The failure was due to the store being read-only (for example, policy).
READ_ONLY,
// The failure was due to the store running out of space.
QUOTA_EXCEEDED,
// Any other error.
OTHER_ERROR,
};
// Bundles an ErrorCode with further metadata.
struct Error {
Error(ErrorCode code,
const std::string& message,
scoped_ptr<std::string> key);
~Error();
static scoped_ptr<Error> Create(ErrorCode code,
const std::string& message,
scoped_ptr<std::string> key) {
return make_scoped_ptr(new Error(code, message, key.Pass()));
}
// The error code.
const ErrorCode code;
// Message associated with the error.
const std::string message;
// The key associated with the error, if any. Use a scoped_ptr here
// because empty-string is a valid key.
//
// TODO(kalman): add test(s) for an empty key.
const scoped_ptr<std::string> key;
private:
DISALLOW_COPY_AND_ASSIGN(Error);
};
// The result of a read operation (Get).
class ReadResultType {
public:
explicit ReadResultType(scoped_ptr<base::DictionaryValue> settings);
explicit ReadResultType(scoped_ptr<Error> error);
~ReadResultType();
bool HasError() const { return error_; }
// Gets the settings read from the storage. Note that this represents
// the root object. If you request the value for key "foo", that value will
// be in |settings|.|foo|.
//
// Must only be called if there is no error.
base::DictionaryValue& settings() { return *settings_; }
scoped_ptr<base::DictionaryValue> PassSettings() {
return settings_.Pass();
}
// Only call if HasError is true.
const Error& error() const { return *error_; }
scoped_ptr<Error> PassError() { return error_.Pass(); }
private:
scoped_ptr<base::DictionaryValue> settings_;
scoped_ptr<Error> error_;
DISALLOW_COPY_AND_ASSIGN(ReadResultType);
};
typedef scoped_ptr<ReadResultType> ReadResult;
// The result of a write operation (Set/Remove/Clear).
class WriteResultType {
public:
explicit WriteResultType(scoped_ptr<ValueStoreChangeList> changes);
explicit WriteResultType(scoped_ptr<Error> error);
~WriteResultType();
bool HasError() const { return error_; }
// Gets the list of changes to the settings which resulted from the write.
// Won't be present if the NO_GENERATE_CHANGES WriteOptions was given.
// Only call if HasError is false.
ValueStoreChangeList& changes() { return *changes_; }
scoped_ptr<ValueStoreChangeList> PassChanges() { return changes_.Pass(); }
// Only call if HasError is true.
const Error& error() const { return *error_; }
scoped_ptr<Error> PassError() { return error_.Pass(); }
private:
scoped_ptr<ValueStoreChangeList> changes_;
scoped_ptr<Error> error_;
DISALLOW_COPY_AND_ASSIGN(WriteResultType);
};
typedef scoped_ptr<WriteResultType> WriteResult;
// Options for write operations.
enum WriteOptionsValues {
// Callers should usually use this.
DEFAULTS = 0,
// Ignore any quota restrictions.
IGNORE_QUOTA = 1<<1,
// Don't generate the changes for a WriteResult.
NO_GENERATE_CHANGES = 1<<2,
};
typedef int WriteOptions;
virtual ~ValueStore() {}
// Helpers for making a Read/WriteResult.
template<typename T>
static ReadResult MakeReadResult(scoped_ptr<T> arg) {
return ReadResult(new ReadResultType(arg.Pass()));
}
template<typename T>
static WriteResult MakeWriteResult(scoped_ptr<T> arg) {
return WriteResult(new WriteResultType(arg.Pass()));
}
// Gets the amount of space being used by a single value, in bytes.
// Note: The GetBytesInUse methods are only used by extension settings at the
// moment. If these become more generally useful, the
// SettingsStorageQuotaEnforcer and WeakUnlimitedSettingsStorage classes
// should be moved to the value_store directory.
virtual size_t GetBytesInUse(const std::string& key) = 0;
// Gets the total amount of space being used by multiple values, in bytes.
virtual size_t GetBytesInUse(const std::vector<std::string>& keys) = 0;
// Gets the total amount of space being used by this storage area, in bytes.
virtual size_t GetBytesInUse() = 0;
// Gets a single value from storage.
virtual ReadResult Get(const std::string& key) = 0;
// Gets multiple values from storage.
virtual ReadResult Get(const std::vector<std::string>& keys) = 0;
// Gets all values from storage.
virtual ReadResult Get() = 0;
// Sets a single key to a new value.
virtual WriteResult Set(WriteOptions options,
const std::string& key,
const base::Value& value) = 0;
// Sets multiple keys to new values.
virtual WriteResult Set(
WriteOptions options, const base::DictionaryValue& values) = 0;
// Removes a key from the storage.
virtual WriteResult Remove(const std::string& key) = 0;
// Removes multiple keys from the storage.
virtual WriteResult Remove(const std::vector<std::string>& keys) = 0;
// Clears the storage.
virtual WriteResult Clear() = 0;
};
#endif // CHROME_BROWSER_VALUE_STORE_VALUE_STORE_H_
|
