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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
// 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.
#include "chrome/browser/extensions/activity_log/activity_database.h"
#include <string>
#include "base/command_line.h"
#include "base/logging.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/threading/thread.h"
#include "base/threading/thread_checker.h"
#include "base/time/clock.h"
#include "base/time/time.h"
#include "chrome/browser/extensions/activity_log/fullstream_ui_policy.h"
#include "chrome/common/chrome_switches.h"
#include "sql/error_delegate_util.h"
#include "sql/transaction.h"
#include "third_party/sqlite/sqlite3.h"
#if defined(OS_MACOSX)
#include "base/mac/mac_util.h"
#endif
using content::BrowserThread;
namespace extensions {
// A size threshold at which data should be flushed to the database. The
// ActivityDatabase will signal the Delegate to write out data based on a
// periodic timer, but will also initiate a flush if AdviseFlush indicates that
// more than kSizeThresholdForFlush action records are queued in memory. This
// should be set large enough that write costs can be amortized across many
// records, but not so large that too much space can be tied up holding records
// in memory.
static const int kSizeThresholdForFlush = 200;
ActivityDatabase::ActivityDatabase(ActivityDatabase::Delegate* delegate)
: delegate_(delegate),
valid_db_(false),
batch_mode_(true),
already_closed_(false),
did_init_(false) {
if (CommandLine::ForCurrentProcess()->HasSwitch(
switches::kEnableExtensionActivityLogTesting)) {
batching_period_ = base::TimeDelta::FromSeconds(10);
} else {
batching_period_ = base::TimeDelta::FromMinutes(2);
}
}
ActivityDatabase::~ActivityDatabase() {}
void ActivityDatabase::Init(const base::FilePath& db_name) {
if (did_init_) return;
did_init_ = true;
if (BrowserThread::IsMessageLoopValid(BrowserThread::DB))
DCHECK_CURRENTLY_ON(BrowserThread::DB);
db_.set_histogram_tag("Activity");
db_.set_error_callback(
base::Bind(&ActivityDatabase::DatabaseErrorCallback,
base::Unretained(this)));
db_.set_page_size(4096);
db_.set_cache_size(32);
if (!db_.Open(db_name)) {
LOG(ERROR) << db_.GetErrorMessage();
return LogInitFailure();
}
// Wrap the initialization in a transaction so that the db doesn't
// get corrupted if init fails/crashes.
sql::Transaction committer(&db_);
if (!committer.Begin())
return LogInitFailure();
#if defined(OS_MACOSX)
// Exclude the database from backups.
base::mac::SetFileBackupExclusion(db_name);
#endif
if (!delegate_->InitDatabase(&db_))
return LogInitFailure();
sql::InitStatus stat = committer.Commit() ? sql::INIT_OK : sql::INIT_FAILURE;
if (stat != sql::INIT_OK)
return LogInitFailure();
// Pre-loads the first <cache-size> pages into the cache.
// Doesn't do anything if the database is new.
db_.Preload();
valid_db_ = true;
timer_.Start(FROM_HERE,
batching_period_,
this,
&ActivityDatabase::RecordBatchedActions);
}
void ActivityDatabase::LogInitFailure() {
LOG(ERROR) << "Couldn't initialize the activity log database.";
SoftFailureClose();
}
void ActivityDatabase::AdviseFlush(int size) {
if (!valid_db_)
return;
if (!batch_mode_ || size == kFlushImmediately ||
size >= kSizeThresholdForFlush) {
if (!delegate_->FlushDatabase(&db_))
SoftFailureClose();
}
}
void ActivityDatabase::RecordBatchedActions() {
if (valid_db_) {
if (!delegate_->FlushDatabase(&db_))
SoftFailureClose();
}
}
void ActivityDatabase::SetBatchModeForTesting(bool batch_mode) {
if (batch_mode && !batch_mode_) {
timer_.Start(FROM_HERE,
batching_period_,
this,
&ActivityDatabase::RecordBatchedActions);
} else if (!batch_mode && batch_mode_) {
timer_.Stop();
RecordBatchedActions();
}
batch_mode_ = batch_mode;
}
sql::Connection* ActivityDatabase::GetSqlConnection() {
if (BrowserThread::IsMessageLoopValid(BrowserThread::DB))
DCHECK_CURRENTLY_ON(BrowserThread::DB);
if (valid_db_) {
return &db_;
} else {
LOG(WARNING) << "Activity log database is not valid";
return NULL;
}
}
void ActivityDatabase::Close() {
timer_.Stop();
if (!already_closed_) {
RecordBatchedActions();
db_.reset_error_callback();
}
valid_db_ = false;
already_closed_ = true;
// Call DatabaseCloseCallback() just before deleting the ActivityDatabase
// itself--these two objects should have the same lifetime.
delegate_->OnDatabaseClose();
delete this;
}
void ActivityDatabase::HardFailureClose() {
if (already_closed_) return;
valid_db_ = false;
timer_.Stop();
db_.reset_error_callback();
db_.RazeAndClose();
delegate_->OnDatabaseFailure();
already_closed_ = true;
}
void ActivityDatabase::SoftFailureClose() {
valid_db_ = false;
timer_.Stop();
delegate_->OnDatabaseFailure();
}
void ActivityDatabase::DatabaseErrorCallback(int error, sql::Statement* stmt) {
if (sql::IsErrorCatastrophic(error)) {
LOG(ERROR) << "Killing the ActivityDatabase due to catastrophic error.";
HardFailureClose();
} else if (error != SQLITE_BUSY) {
// We ignore SQLITE_BUSY errors because they are presumably transient.
LOG(ERROR) << "Closing the ActivityDatabase due to error.";
SoftFailureClose();
}
}
void ActivityDatabase::RecordBatchedActionsWhileTesting() {
RecordBatchedActions();
timer_.Stop();
}
void ActivityDatabase::SetTimerForTesting(int ms) {
timer_.Stop();
timer_.Start(FROM_HERE,
base::TimeDelta::FromMilliseconds(ms),
this,
&ActivityDatabase::RecordBatchedActionsWhileTesting);
}
// static
bool ActivityDatabase::InitializeTable(sql::Connection* db,
const char* table_name,
const char* content_fields[],
const char* field_types[],
const int num_content_fields) {
if (!db->DoesTableExist(table_name)) {
std::string table_creator =
base::StringPrintf("CREATE TABLE %s (", table_name);
for (int i = 0; i < num_content_fields; i++) {
table_creator += base::StringPrintf("%s%s %s",
i == 0 ? "" : ", ",
content_fields[i],
field_types[i]);
}
table_creator += ")";
if (!db->Execute(table_creator.c_str()))
return false;
} else {
// In case we ever want to add new fields, this initializes them to be
// empty strings.
for (int i = 0; i < num_content_fields; i++) {
if (!db->DoesColumnExist(table_name, content_fields[i])) {
std::string table_updater = base::StringPrintf(
"ALTER TABLE %s ADD COLUMN %s %s; ",
table_name,
content_fields[i],
field_types[i]);
if (!db->Execute(table_updater.c_str()))
return false;
}
}
}
return true;
}
} // namespace extensions
|