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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
|
// Copyright 2014 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 "components/bookmarks/browser/bookmark_codec.h"
#include <algorithm>
#include "base/json/json_string_value_serializer.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/values.h"
#include "components/bookmarks/browser/bookmark_model.h"
#include "grit/components_strings.h"
#include "ui/base/l10n/l10n_util.h"
#include "url/gurl.h"
using base::Time;
namespace bookmarks {
const char* BookmarkCodec::kRootsKey = "roots";
const char* BookmarkCodec::kRootFolderNameKey = "bookmark_bar";
const char* BookmarkCodec::kOtherBookmarkFolderNameKey = "other";
// The value is left as 'synced' for historical reasons.
const char* BookmarkCodec::kMobileBookmarkFolderNameKey = "synced";
const char* BookmarkCodec::kVersionKey = "version";
const char* BookmarkCodec::kChecksumKey = "checksum";
const char* BookmarkCodec::kIdKey = "id";
const char* BookmarkCodec::kTypeKey = "type";
const char* BookmarkCodec::kNameKey = "name";
const char* BookmarkCodec::kDateAddedKey = "date_added";
const char* BookmarkCodec::kURLKey = "url";
const char* BookmarkCodec::kDateModifiedKey = "date_modified";
const char* BookmarkCodec::kChildrenKey = "children";
const char* BookmarkCodec::kMetaInfo = "meta_info";
const char* BookmarkCodec::kSyncTransactionVersion = "sync_transaction_version";
const char* BookmarkCodec::kTypeURL = "url";
const char* BookmarkCodec::kTypeFolder = "folder";
// Current version of the file.
static const int kCurrentVersion = 1;
BookmarkCodec::BookmarkCodec()
: ids_reassigned_(false),
ids_valid_(true),
maximum_id_(0),
model_sync_transaction_version_(
BookmarkNode::kInvalidSyncTransactionVersion) {
}
BookmarkCodec::~BookmarkCodec() {}
base::Value* BookmarkCodec::Encode(BookmarkModel* model) {
return Encode(model->bookmark_bar_node(),
model->other_node(),
model->mobile_node(),
model->root_node()->GetMetaInfoMap(),
model->root_node()->sync_transaction_version());
}
base::Value* BookmarkCodec::Encode(
const BookmarkNode* bookmark_bar_node,
const BookmarkNode* other_folder_node,
const BookmarkNode* mobile_folder_node,
const BookmarkNode::MetaInfoMap* model_meta_info_map,
int64_t sync_transaction_version) {
ids_reassigned_ = false;
InitializeChecksum();
base::DictionaryValue* roots = new base::DictionaryValue();
roots->Set(kRootFolderNameKey, EncodeNode(bookmark_bar_node));
roots->Set(kOtherBookmarkFolderNameKey, EncodeNode(other_folder_node));
roots->Set(kMobileBookmarkFolderNameKey, EncodeNode(mobile_folder_node));
if (model_meta_info_map)
roots->Set(kMetaInfo, EncodeMetaInfo(*model_meta_info_map));
if (sync_transaction_version !=
BookmarkNode::kInvalidSyncTransactionVersion) {
roots->SetString(kSyncTransactionVersion,
base::Int64ToString(sync_transaction_version));
}
base::DictionaryValue* main = new base::DictionaryValue();
main->SetInteger(kVersionKey, kCurrentVersion);
FinalizeChecksum();
// We are going to store the computed checksum. So set stored checksum to be
// the same as computed checksum.
stored_checksum_ = computed_checksum_;
main->Set(kChecksumKey, new base::StringValue(computed_checksum_));
main->Set(kRootsKey, roots);
return main;
}
bool BookmarkCodec::Decode(BookmarkNode* bb_node,
BookmarkNode* other_folder_node,
BookmarkNode* mobile_folder_node,
int64_t* max_id,
const base::Value& value) {
ids_.clear();
ids_reassigned_ = false;
ids_valid_ = true;
maximum_id_ = 0;
stored_checksum_.clear();
InitializeChecksum();
bool success = DecodeHelper(bb_node, other_folder_node, mobile_folder_node,
value);
FinalizeChecksum();
// If either the checksums differ or some IDs were missing/not unique,
// reassign IDs.
if (!ids_valid_ || computed_checksum() != stored_checksum())
ReassignIDs(bb_node, other_folder_node, mobile_folder_node);
*max_id = maximum_id_ + 1;
return success;
}
base::Value* BookmarkCodec::EncodeNode(const BookmarkNode* node) {
base::DictionaryValue* value = new base::DictionaryValue();
std::string id = base::Int64ToString(node->id());
value->SetString(kIdKey, id);
const base::string16& title = node->GetTitle();
value->SetString(kNameKey, title);
value->SetString(kDateAddedKey,
base::Int64ToString(node->date_added().ToInternalValue()));
if (node->is_url()) {
value->SetString(kTypeKey, kTypeURL);
std::string url = node->url().possibly_invalid_spec();
value->SetString(kURLKey, url);
UpdateChecksumWithUrlNode(id, title, url);
} else {
value->SetString(kTypeKey, kTypeFolder);
value->SetString(
kDateModifiedKey,
base::Int64ToString(node->date_folder_modified().ToInternalValue()));
UpdateChecksumWithFolderNode(id, title);
base::ListValue* child_values = new base::ListValue();
value->Set(kChildrenKey, child_values);
for (int i = 0; i < node->child_count(); ++i)
child_values->Append(EncodeNode(node->GetChild(i)));
}
const BookmarkNode::MetaInfoMap* meta_info_map = node->GetMetaInfoMap();
if (meta_info_map)
value->Set(kMetaInfo, EncodeMetaInfo(*meta_info_map));
if (node->sync_transaction_version() !=
BookmarkNode::kInvalidSyncTransactionVersion) {
value->SetString(kSyncTransactionVersion,
base::Int64ToString(node->sync_transaction_version()));
}
return value;
}
base::Value* BookmarkCodec::EncodeMetaInfo(
const BookmarkNode::MetaInfoMap& meta_info_map) {
base::DictionaryValue* meta_info = new base::DictionaryValue;
for (BookmarkNode::MetaInfoMap::const_iterator it = meta_info_map.begin();
it != meta_info_map.end(); ++it) {
meta_info->SetStringWithoutPathExpansion(it->first, it->second);
}
return meta_info;
}
bool BookmarkCodec::DecodeHelper(BookmarkNode* bb_node,
BookmarkNode* other_folder_node,
BookmarkNode* mobile_folder_node,
const base::Value& value) {
const base::DictionaryValue* d_value = nullptr;
if (!value.GetAsDictionary(&d_value))
return false; // Unexpected type.
int version;
if (!d_value->GetInteger(kVersionKey, &version) || version != kCurrentVersion)
return false; // Unknown version.
const base::Value* checksum_value;
if (d_value->Get(kChecksumKey, &checksum_value)) {
if (checksum_value->GetType() != base::Value::TYPE_STRING)
return false;
if (!checksum_value->GetAsString(&stored_checksum_))
return false;
}
const base::Value* roots;
if (!d_value->Get(kRootsKey, &roots))
return false; // No roots.
const base::DictionaryValue* roots_d_value = nullptr;
if (!roots->GetAsDictionary(&roots_d_value))
return false; // Invalid type for roots.
const base::Value* root_folder_value;
const base::Value* other_folder_value = nullptr;
const base::DictionaryValue* root_folder_d_value = nullptr;
const base::DictionaryValue* other_folder_d_value = nullptr;
if (!roots_d_value->Get(kRootFolderNameKey, &root_folder_value) ||
!root_folder_value->GetAsDictionary(&root_folder_d_value) ||
!roots_d_value->Get(kOtherBookmarkFolderNameKey, &other_folder_value) ||
!other_folder_value->GetAsDictionary(&other_folder_d_value)) {
return false; // Invalid type for root folder and/or other
// folder.
}
DecodeNode(*root_folder_d_value, nullptr, bb_node);
DecodeNode(*other_folder_d_value, nullptr, other_folder_node);
// Fail silently if we can't deserialize mobile bookmarks. We can't require
// them to exist in order to be backwards-compatible with older versions of
// chrome.
const base::Value* mobile_folder_value;
const base::DictionaryValue* mobile_folder_d_value = nullptr;
if (roots_d_value->Get(kMobileBookmarkFolderNameKey, &mobile_folder_value) &&
mobile_folder_value->GetAsDictionary(&mobile_folder_d_value)) {
DecodeNode(*mobile_folder_d_value, nullptr, mobile_folder_node);
} else {
// If we didn't find the mobile folder, we're almost guaranteed to have a
// duplicate id when we add the mobile folder. Consequently, if we don't
// intend to reassign ids in the future (ids_valid_ is still true), then at
// least reassign the mobile bookmarks to avoid it colliding with anything
// else.
if (ids_valid_)
ReassignIDsHelper(mobile_folder_node);
}
if (!DecodeMetaInfo(*roots_d_value, &model_meta_info_map_,
&model_sync_transaction_version_))
return false;
std::string sync_transaction_version_str;
if (roots_d_value->GetString(kSyncTransactionVersion,
&sync_transaction_version_str) &&
!base::StringToInt64(sync_transaction_version_str,
&model_sync_transaction_version_))
return false;
// Need to reset the type as decoding resets the type to FOLDER. Similarly
// we need to reset the title as the title is persisted and restored from
// the file.
bb_node->set_type(BookmarkNode::BOOKMARK_BAR);
other_folder_node->set_type(BookmarkNode::OTHER_NODE);
mobile_folder_node->set_type(BookmarkNode::MOBILE);
bb_node->SetTitle(l10n_util::GetStringUTF16(IDS_BOOKMARK_BAR_FOLDER_NAME));
other_folder_node->SetTitle(
l10n_util::GetStringUTF16(IDS_BOOKMARK_BAR_OTHER_FOLDER_NAME));
mobile_folder_node->SetTitle(
l10n_util::GetStringUTF16(IDS_BOOKMARK_BAR_MOBILE_FOLDER_NAME));
return true;
}
bool BookmarkCodec::DecodeChildren(const base::ListValue& child_value_list,
BookmarkNode* parent) {
for (size_t i = 0; i < child_value_list.GetSize(); ++i) {
const base::Value* child_value;
if (!child_value_list.Get(i, &child_value))
return false;
const base::DictionaryValue* child_d_value = nullptr;
if (!child_value->GetAsDictionary(&child_d_value))
return false;
DecodeNode(*child_d_value, parent, nullptr);
}
return true;
}
bool BookmarkCodec::DecodeNode(const base::DictionaryValue& value,
BookmarkNode* parent,
BookmarkNode* node) {
// If no |node| is specified, we'll create one and add it to the |parent|.
// Therefore, in that case, |parent| must be non-NULL.
if (!node && !parent) {
NOTREACHED();
return false;
}
std::string id_string;
int64_t id = 0;
if (ids_valid_) {
if (!value.GetString(kIdKey, &id_string) ||
!base::StringToInt64(id_string, &id) ||
ids_.count(id) != 0) {
ids_valid_ = false;
} else {
ids_.insert(id);
}
}
maximum_id_ = std::max(maximum_id_, id);
base::string16 title;
value.GetString(kNameKey, &title);
std::string date_added_string;
if (!value.GetString(kDateAddedKey, &date_added_string))
date_added_string = base::Int64ToString(Time::Now().ToInternalValue());
int64_t internal_time;
base::StringToInt64(date_added_string, &internal_time);
std::string type_string;
if (!value.GetString(kTypeKey, &type_string))
return false;
if (type_string != kTypeURL && type_string != kTypeFolder)
return false; // Unknown type.
if (type_string == kTypeURL) {
std::string url_string;
if (!value.GetString(kURLKey, &url_string))
return false;
GURL url = GURL(url_string);
if (!node && url.is_valid())
node = new BookmarkNode(id, url);
else
return false; // Node invalid.
if (parent)
parent->Add(node, parent->child_count());
node->set_type(BookmarkNode::URL);
UpdateChecksumWithUrlNode(id_string, title, url_string);
} else {
std::string last_modified_date;
if (!value.GetString(kDateModifiedKey, &last_modified_date))
last_modified_date = base::Int64ToString(Time::Now().ToInternalValue());
const base::Value* child_values;
if (!value.Get(kChildrenKey, &child_values))
return false;
if (child_values->GetType() != base::Value::TYPE_LIST)
return false;
if (!node) {
node = new BookmarkNode(id, GURL());
} else {
// If a new node is not created, explicitly assign ID to the existing one.
node->set_id(id);
}
node->set_type(BookmarkNode::FOLDER);
int64_t internal_time;
base::StringToInt64(last_modified_date, &internal_time);
node->set_date_folder_modified(Time::FromInternalValue(internal_time));
if (parent)
parent->Add(node, parent->child_count());
UpdateChecksumWithFolderNode(id_string, title);
const base::ListValue* child_l_values = nullptr;
if (!child_values->GetAsList(&child_l_values))
return false;
if (!DecodeChildren(*child_l_values, node))
return false;
}
node->SetTitle(title);
node->set_date_added(Time::FromInternalValue(internal_time));
int64_t sync_transaction_version = node->sync_transaction_version();
BookmarkNode::MetaInfoMap meta_info_map;
if (!DecodeMetaInfo(value, &meta_info_map, &sync_transaction_version))
return false;
node->SetMetaInfoMap(meta_info_map);
std::string sync_transaction_version_str;
if (value.GetString(kSyncTransactionVersion, &sync_transaction_version_str) &&
!base::StringToInt64(sync_transaction_version_str,
&sync_transaction_version))
return false;
node->set_sync_transaction_version(sync_transaction_version);
return true;
}
bool BookmarkCodec::DecodeMetaInfo(const base::DictionaryValue& value,
BookmarkNode::MetaInfoMap* meta_info_map,
int64_t* sync_transaction_version) {
DCHECK(meta_info_map);
DCHECK(sync_transaction_version);
meta_info_map->clear();
const base::Value* meta_info;
if (!value.Get(kMetaInfo, &meta_info))
return true;
scoped_ptr<base::Value> deserialized_holder;
// Meta info used to be stored as a serialized dictionary, so attempt to
// parse the value as one.
if (meta_info->IsType(base::Value::TYPE_STRING)) {
std::string meta_info_str;
meta_info->GetAsString(&meta_info_str);
JSONStringValueDeserializer deserializer(meta_info_str);
deserialized_holder.reset(deserializer.Deserialize(nullptr, nullptr));
if (!deserialized_holder)
return false;
meta_info = deserialized_holder.get();
}
// meta_info is now either the kMetaInfo node, or the deserialized node if it
// was stored as a string. Either way it should now be a (possibly nested)
// dictionary of meta info values.
const base::DictionaryValue* meta_info_dict;
if (!meta_info->GetAsDictionary(&meta_info_dict))
return false;
DecodeMetaInfoHelper(*meta_info_dict, std::string(), meta_info_map);
// Previously sync transaction version was stored in the meta info field
// using this key. If the key is present when decoding, set the sync
// transaction version to its value, then delete the field.
if (deserialized_holder) {
const char kBookmarkTransactionVersionKey[] = "sync.transaction_version";
BookmarkNode::MetaInfoMap::iterator it =
meta_info_map->find(kBookmarkTransactionVersionKey);
if (it != meta_info_map->end()) {
base::StringToInt64(it->second, sync_transaction_version);
meta_info_map->erase(it);
}
}
return true;
}
void BookmarkCodec::DecodeMetaInfoHelper(
const base::DictionaryValue& dict,
const std::string& prefix,
BookmarkNode::MetaInfoMap* meta_info_map) {
for (base::DictionaryValue::Iterator it(dict); !it.IsAtEnd(); it.Advance()) {
if (it.value().IsType(base::Value::TYPE_DICTIONARY)) {
const base::DictionaryValue* subdict;
it.value().GetAsDictionary(&subdict);
DecodeMetaInfoHelper(*subdict, prefix + it.key() + ".", meta_info_map);
} else if (it.value().IsType(base::Value::TYPE_STRING)) {
it.value().GetAsString(&(*meta_info_map)[prefix + it.key()]);
}
}
}
void BookmarkCodec::ReassignIDs(BookmarkNode* bb_node,
BookmarkNode* other_node,
BookmarkNode* mobile_node) {
maximum_id_ = 0;
ReassignIDsHelper(bb_node);
ReassignIDsHelper(other_node);
ReassignIDsHelper(mobile_node);
ids_reassigned_ = true;
}
void BookmarkCodec::ReassignIDsHelper(BookmarkNode* node) {
DCHECK(node);
node->set_id(++maximum_id_);
for (int i = 0; i < node->child_count(); ++i)
ReassignIDsHelper(node->GetChild(i));
}
void BookmarkCodec::UpdateChecksum(const std::string& str) {
base::MD5Update(&md5_context_, str);
}
void BookmarkCodec::UpdateChecksum(const base::string16& str) {
base::MD5Update(&md5_context_,
base::StringPiece(
reinterpret_cast<const char*>(str.data()),
str.length() * sizeof(str[0])));
}
void BookmarkCodec::UpdateChecksumWithUrlNode(const std::string& id,
const base::string16& title,
const std::string& url) {
DCHECK(base::IsStringUTF8(url));
UpdateChecksum(id);
UpdateChecksum(title);
UpdateChecksum(kTypeURL);
UpdateChecksum(url);
}
void BookmarkCodec::UpdateChecksumWithFolderNode(const std::string& id,
const base::string16& title) {
UpdateChecksum(id);
UpdateChecksum(title);
UpdateChecksum(kTypeFolder);
}
void BookmarkCodec::InitializeChecksum() {
base::MD5Init(&md5_context_);
}
void BookmarkCodec::FinalizeChecksum() {
base::MD5Digest digest;
base::MD5Final(&digest, &md5_context_);
computed_checksum_ = base::MD5DigestToBase16(digest);
}
} // namespace bookmarks
|