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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
|
// Copyright (c) 2013 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/history/delete_directive_handler.h"
#include "base/json/json_writer.h"
#include "base/rand_util.h"
#include "base/time/time.h"
#include "base/values.h"
#include "chrome/browser/history/history_backend.h"
#include "chrome/browser/history/history_service.h"
#include "components/history/core/browser/history_db_task.h"
#include "sync/api/sync_change.h"
#include "sync/protocol/history_delete_directive_specifics.pb.h"
#include "sync/protocol/proto_value_conversions.h"
#include "sync/protocol/sync.pb.h"
namespace {
std::string RandASCIIString(size_t length) {
std::string result;
const int kMin = static_cast<int>(' ');
const int kMax = static_cast<int>('~');
for (size_t i = 0; i < length; ++i)
result.push_back(static_cast<char>(base::RandInt(kMin, kMax)));
return result;
}
std::string DeleteDirectiveToString(
const sync_pb::HistoryDeleteDirectiveSpecifics& delete_directive) {
scoped_ptr<base::DictionaryValue> value(
syncer::HistoryDeleteDirectiveSpecificsToValue(delete_directive));
std::string str;
base::JSONWriter::Write(value.get(), &str);
return str;
}
// Compare time range directives first by start time, then by end time.
bool TimeRangeLessThan(const syncer::SyncData& data1,
const syncer::SyncData& data2) {
const sync_pb::TimeRangeDirective& range1 =
data1.GetSpecifics().history_delete_directive().time_range_directive();
const sync_pb::TimeRangeDirective& range2 =
data2.GetSpecifics().history_delete_directive().time_range_directive();
if (range1.start_time_usec() < range2.start_time_usec())
return true;
if (range1.start_time_usec() > range2.start_time_usec())
return false;
return range1.end_time_usec() < range2.end_time_usec();
}
// Converts a Unix timestamp in microseconds to a base::Time value.
base::Time UnixUsecToTime(int64 usec) {
return base::Time::UnixEpoch() + base::TimeDelta::FromMicroseconds(usec);
}
// Converts a base::Time value to a Unix timestamp in microseconds.
int64 TimeToUnixUsec(base::Time time) {
DCHECK(!time.is_null());
return (time - base::Time::UnixEpoch()).InMicroseconds();
}
// Converts global IDs in |global_id_directive| to times.
void GetTimesFromGlobalIds(
const sync_pb::GlobalIdDirective& global_id_directive,
std::set<base::Time> *times) {
for (int i = 0; i < global_id_directive.global_id_size(); ++i) {
times->insert(
base::Time::FromInternalValue(global_id_directive.global_id(i)));
}
}
#if !defined(NDEBUG)
// Checks that the given delete directive is properly formed.
void CheckDeleteDirectiveValid(
const sync_pb::HistoryDeleteDirectiveSpecifics& delete_directive) {
if (delete_directive.has_global_id_directive()) {
const sync_pb::GlobalIdDirective& global_id_directive =
delete_directive.global_id_directive();
DCHECK(!delete_directive.has_time_range_directive());
DCHECK_NE(global_id_directive.global_id_size(), 0);
if (global_id_directive.has_start_time_usec())
DCHECK_GE(global_id_directive.start_time_usec(), 0);
if (global_id_directive.has_end_time_usec()) {
DCHECK_GT(global_id_directive.end_time_usec(), 0);
if (global_id_directive.has_start_time_usec()) {
DCHECK_LE(global_id_directive.start_time_usec(),
global_id_directive.end_time_usec());
}
}
} else if (delete_directive.has_time_range_directive()) {
const sync_pb::TimeRangeDirective& time_range_directive =
delete_directive.time_range_directive();
DCHECK(!delete_directive.has_global_id_directive());
DCHECK(time_range_directive.has_start_time_usec());
DCHECK(time_range_directive.has_end_time_usec());
DCHECK_GE(time_range_directive.start_time_usec(), 0);
DCHECK_GT(time_range_directive.end_time_usec(), 0);
DCHECK_GT(time_range_directive.end_time_usec(),
time_range_directive.start_time_usec());
} else {
NOTREACHED() << "Delete directive has no time range or global ID directive";
}
}
#endif // !defined(NDEBUG)
} // anonymous namespace
namespace history {
class DeleteDirectiveHandler::DeleteDirectiveTask : public HistoryDBTask {
public:
DeleteDirectiveTask(
base::WeakPtr<DeleteDirectiveHandler> delete_directive_handler,
const syncer::SyncDataList& delete_directive,
DeleteDirectiveHandler::PostProcessingAction post_processing_action)
: delete_directive_handler_(delete_directive_handler),
delete_directives_(delete_directive),
post_processing_action_(post_processing_action) {}
// Implements HistoryDBTask.
bool RunOnDBThread(history::HistoryBackend* backend,
history::HistoryDatabase* db) override;
void DoneRunOnMainThread() override;
private:
~DeleteDirectiveTask() override {}
// Process a list of global Id directives. Delete all visits to a URL in
// time ranges of directives if the timestamp of one visit matches with one
// global id.
void ProcessGlobalIdDeleteDirectives(
history::HistoryBackend* history_backend,
const syncer::SyncDataList& global_id_directives);
// Process a list of time range directives, all history entries within the
// time ranges are deleted. |time_range_directives| should be sorted by
// |start_time_usec| and |end_time_usec| already.
void ProcessTimeRangeDeleteDirectives(
history::HistoryBackend* history_backend,
const syncer::SyncDataList& time_range_directives);
base::WeakPtr<DeleteDirectiveHandler> delete_directive_handler_;
syncer::SyncDataList delete_directives_;
DeleteDirectiveHandler::PostProcessingAction post_processing_action_;
};
bool DeleteDirectiveHandler::DeleteDirectiveTask::RunOnDBThread(
history::HistoryBackend* backend,
history::HistoryDatabase* db) {
syncer::SyncDataList global_id_directives;
syncer::SyncDataList time_range_directives;
for (syncer::SyncDataList::const_iterator it = delete_directives_.begin();
it != delete_directives_.end(); ++it) {
DCHECK_EQ(it->GetDataType(), syncer::HISTORY_DELETE_DIRECTIVES);
const sync_pb::HistoryDeleteDirectiveSpecifics& delete_directive =
it->GetSpecifics().history_delete_directive();
if (delete_directive.has_global_id_directive()) {
global_id_directives.push_back(*it);
} else {
time_range_directives.push_back(*it);
}
}
ProcessGlobalIdDeleteDirectives(backend, global_id_directives);
std::sort(time_range_directives.begin(), time_range_directives.end(),
TimeRangeLessThan);
ProcessTimeRangeDeleteDirectives(backend, time_range_directives);
return true;
}
void DeleteDirectiveHandler::DeleteDirectiveTask::DoneRunOnMainThread() {
if (delete_directive_handler_.get()) {
delete_directive_handler_->FinishProcessing(post_processing_action_,
delete_directives_);
}
}
void
DeleteDirectiveHandler::DeleteDirectiveTask::ProcessGlobalIdDeleteDirectives(
history::HistoryBackend* history_backend,
const syncer::SyncDataList& global_id_directives) {
if (global_id_directives.empty())
return;
// Group times represented by global IDs by time ranges of delete directives.
// It's more efficient for backend to process all directives with same time
// range at once.
typedef std::map<std::pair<base::Time, base::Time>, std::set<base::Time> >
GlobalIdTimesGroup;
GlobalIdTimesGroup id_times_group;
for (size_t i = 0; i < global_id_directives.size(); ++i) {
DVLOG(1) << "Processing delete directive: "
<< DeleteDirectiveToString(
global_id_directives[i].GetSpecifics()
.history_delete_directive());
const sync_pb::GlobalIdDirective& id_directive =
global_id_directives[i].GetSpecifics().history_delete_directive()
.global_id_directive();
if (id_directive.global_id_size() == 0 ||
!id_directive.has_start_time_usec() ||
!id_directive.has_end_time_usec()) {
DLOG(ERROR) << "Invalid global id directive.";
continue;
}
GetTimesFromGlobalIds(
id_directive,
&id_times_group[
std::make_pair(UnixUsecToTime(id_directive.start_time_usec()),
UnixUsecToTime(id_directive.end_time_usec()))]);
}
if (id_times_group.empty())
return;
// Call backend to expire history of directives in each group.
for (GlobalIdTimesGroup::const_iterator group_it = id_times_group.begin();
group_it != id_times_group.end(); ++group_it) {
// Add 1us to cover history entries visited at the end time because time
// range in directive is inclusive.
history_backend->ExpireHistoryForTimes(
group_it->second,
group_it->first.first,
group_it->first.second + base::TimeDelta::FromMicroseconds(1));
}
}
void
DeleteDirectiveHandler::DeleteDirectiveTask::ProcessTimeRangeDeleteDirectives(
history::HistoryBackend* history_backend,
const syncer::SyncDataList& time_range_directives) {
if (time_range_directives.empty())
return;
// Iterate through time range directives. Expire history in combined
// time range for multiple directives whose time ranges overlap.
base::Time current_start_time;
base::Time current_end_time;
for (size_t i = 0; i < time_range_directives.size(); ++i) {
const sync_pb::HistoryDeleteDirectiveSpecifics& delete_directive =
time_range_directives[i].GetSpecifics().history_delete_directive();
DVLOG(1) << "Processing time range directive: "
<< DeleteDirectiveToString(delete_directive);
const sync_pb::TimeRangeDirective& time_range_directive =
delete_directive.time_range_directive();
if (!time_range_directive.has_start_time_usec() ||
!time_range_directive.has_end_time_usec() ||
time_range_directive.start_time_usec() >=
time_range_directive.end_time_usec()) {
DLOG(ERROR) << "Invalid time range directive.";
continue;
}
base::Time directive_start_time =
UnixUsecToTime(time_range_directive.start_time_usec());
base::Time directive_end_time =
UnixUsecToTime(time_range_directive.end_time_usec());
if (directive_start_time > current_end_time) {
if (!current_start_time.is_null()) {
// Add 1us to cover history entries visited at the end time because
// time range in directive is inclusive.
history_backend->ExpireHistoryBetween(
std::set<GURL>(), current_start_time,
current_end_time + base::TimeDelta::FromMicroseconds(1));
}
current_start_time = directive_start_time;
}
if (directive_end_time > current_end_time)
current_end_time = directive_end_time;
}
if (!current_start_time.is_null()) {
history_backend->ExpireHistoryBetween(
std::set<GURL>(), current_start_time,
current_end_time + base::TimeDelta::FromMicroseconds(1));
}
}
DeleteDirectiveHandler::DeleteDirectiveHandler()
: weak_ptr_factory_(this) {}
DeleteDirectiveHandler::~DeleteDirectiveHandler() {
weak_ptr_factory_.InvalidateWeakPtrs();
}
void DeleteDirectiveHandler::Start(
HistoryService* history_service,
const syncer::SyncDataList& initial_sync_data,
scoped_ptr<syncer::SyncChangeProcessor> sync_processor) {
DCHECK(thread_checker_.CalledOnValidThread());
sync_processor_ = sync_processor.Pass();
if (!initial_sync_data.empty()) {
// Drop processed delete directives during startup.
history_service->ScheduleDBTask(
scoped_ptr<history::HistoryDBTask>(
new DeleteDirectiveTask(weak_ptr_factory_.GetWeakPtr(),
initial_sync_data,
DROP_AFTER_PROCESSING)),
&internal_tracker_);
}
}
void DeleteDirectiveHandler::Stop() {
DCHECK(thread_checker_.CalledOnValidThread());
sync_processor_.reset();
}
bool DeleteDirectiveHandler::CreateDeleteDirectives(
const std::set<int64>& global_ids,
base::Time begin_time,
base::Time end_time) {
base::Time now = base::Time::Now();
sync_pb::HistoryDeleteDirectiveSpecifics delete_directive;
// Delete directives require a non-null begin time, so use 1 if it's null.
int64 begin_time_usecs =
begin_time.is_null() ? 0 : TimeToUnixUsec(begin_time);
// Determine the actual end time -- it should not be null or in the future.
// TODO(dubroy): Use sane time (crbug.com/146090) here when it's available.
base::Time end = (end_time.is_null() || end_time > now) ? now : end_time;
// -1 because end time in delete directives is inclusive.
int64 end_time_usecs = TimeToUnixUsec(end) - 1;
if (global_ids.empty()) {
sync_pb::TimeRangeDirective* time_range_directive =
delete_directive.mutable_time_range_directive();
time_range_directive->set_start_time_usec(begin_time_usecs);
time_range_directive->set_end_time_usec(end_time_usecs);
} else {
for (std::set<int64>::const_iterator it = global_ids.begin();
it != global_ids.end(); ++it) {
sync_pb::GlobalIdDirective* global_id_directive =
delete_directive.mutable_global_id_directive();
global_id_directive->add_global_id(*it);
global_id_directive->set_start_time_usec(begin_time_usecs);
global_id_directive->set_end_time_usec(end_time_usecs);
}
}
syncer::SyncError error = ProcessLocalDeleteDirective(delete_directive);
return !error.IsSet();
}
syncer::SyncError DeleteDirectiveHandler::ProcessLocalDeleteDirective(
const sync_pb::HistoryDeleteDirectiveSpecifics& delete_directive) {
DCHECK(thread_checker_.CalledOnValidThread());
if (!sync_processor_) {
return syncer::SyncError(
FROM_HERE,
syncer::SyncError::DATATYPE_ERROR,
"Cannot send local delete directive to sync",
syncer::HISTORY_DELETE_DIRECTIVES);
}
#if !defined(NDEBUG)
CheckDeleteDirectiveValid(delete_directive);
#endif
// Generate a random sync tag since history delete directives don't
// have a 'built-in' ID. 8 bytes should suffice.
std::string sync_tag = RandASCIIString(8);
sync_pb::EntitySpecifics entity_specifics;
entity_specifics.mutable_history_delete_directive()->CopyFrom(
delete_directive);
syncer::SyncData sync_data =
syncer::SyncData::CreateLocalData(
sync_tag, sync_tag, entity_specifics);
syncer::SyncChange change(
FROM_HERE, syncer::SyncChange::ACTION_ADD, sync_data);
syncer::SyncChangeList changes(1, change);
return sync_processor_->ProcessSyncChanges(FROM_HERE, changes);
}
syncer::SyncError DeleteDirectiveHandler::ProcessSyncChanges(
HistoryService* history_service,
const syncer::SyncChangeList& change_list) {
DCHECK(thread_checker_.CalledOnValidThread());
if (!sync_processor_) {
return syncer::SyncError(
FROM_HERE,
syncer::SyncError::DATATYPE_ERROR,
"Sync is disabled.",
syncer::HISTORY_DELETE_DIRECTIVES);
}
syncer::SyncDataList delete_directives;
for (syncer::SyncChangeList::const_iterator it = change_list.begin();
it != change_list.end(); ++it) {
switch (it->change_type()) {
case syncer::SyncChange::ACTION_ADD:
delete_directives.push_back(it->sync_data());
break;
case syncer::SyncChange::ACTION_DELETE:
// TODO(akalin): Keep track of existing delete directives.
break;
default:
NOTREACHED();
break;
}
}
if (!delete_directives.empty()) {
// Don't drop real-time delete directive so that sync engine can detect
// redelivered delete directives to avoid processing them again and again
// in one chrome session.
history_service->ScheduleDBTask(
scoped_ptr<history::HistoryDBTask>(
new DeleteDirectiveTask(weak_ptr_factory_.GetWeakPtr(),
delete_directives,
KEEP_AFTER_PROCESSING)),
&internal_tracker_);
}
return syncer::SyncError();
}
void DeleteDirectiveHandler::FinishProcessing(
PostProcessingAction post_processing_action,
const syncer::SyncDataList& delete_directives) {
DCHECK(thread_checker_.CalledOnValidThread());
// If specified, drop processed delete directive in sync model because they
// only need to be applied once.
if (sync_processor_.get() &&
post_processing_action == DROP_AFTER_PROCESSING) {
syncer::SyncChangeList change_list;
for (size_t i = 0; i < delete_directives.size(); ++i) {
change_list.push_back(
syncer::SyncChange(FROM_HERE, syncer::SyncChange::ACTION_DELETE,
delete_directives[i]));
}
sync_processor_->ProcessSyncChanges(FROM_HERE, change_list);
}
}
} // namespace history
|