components/enhanced_bookmarks/enhanced_bookmark_model.cc

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "components/enhanced_bookmarks/enhanced_bookmark_model.h"
   6
   7 #include <iomanip>
   8 #include <sstream>
   9
  10 #include "base/base64.h"
  11 #include "base/logging.h"
  12 #include "base/message_loop/message_loop_proxy.h"
  13 #include "base/rand_util.h"
  14 #include "base/strings/string_number_conversions.h"
  15 #include "components/bookmarks/browser/bookmark_model.h"
  16 #include "components/bookmarks/browser/bookmark_node.h"
  17 #include "components/enhanced_bookmarks/enhanced_bookmark_model_observer.h"
  18 #include "components/enhanced_bookmarks/proto/metadata.pb.h"
  19 #include "ui/base/models/tree_node_iterator.h"
  20 #include "url/gurl.h"
  21
  22 namespace {
  23 const char* kBookmarkBarId = "f_bookmarks_bar";
  24
  25 const char* kFlagsKey = "stars.flags";
  26 const char* kIdKey = "stars.id";
  27 const char* kImageDataKey = "stars.imageData";
  28 const char* kNoteKey = "stars.note";
  29 const char* kOldIdKey = "stars.oldId";
  30 const char* kPageDataKey = "stars.pageData";
  31 const char* kVersionKey = "stars.version";
  32
  33 const char* kBookmarkPrefix = "ebc_";
  34
  35 enum Flags {
  36   // When set the server will attempt to fill in image and snippet information.
  37   NEEDS_OFFLINE_PROCESSING = 0x1,
  38 };
  39
  40 // Helper method for working with bookmark metainfo.
  41 std::string DataForMetaInfoField(const BookmarkNode* node,
  42                                  const std::string& field) {
  43   std::string value;
  44   if (!node->GetMetaInfo(field, &value))
  45     return std::string();
  46
  47   std::string decoded;
  48   if (!base::Base64Decode(value, &decoded))
  49     return std::string();
  50
  51   return decoded;
  52 }
  53
  54 // Helper method for working with ImageData_ImageInfo.
  55 bool PopulateImageData(const image::collections::ImageData_ImageInfo& info,
  56                        GURL* out_url,
  57                        int* width,
  58                        int* height) {
  59   if (!info.has_url() || !info.has_width() || !info.has_height())
  60     return false;
  61
  62   GURL url(info.url());
  63   if (!url.is_valid())
  64     return false;
  65
  66   *out_url = url;
  67   *width = info.width();
  68   *height = info.height();
  69   return true;
  70 }
  71
  72 // Generate a random remote id, with a prefix that depends on whether the node
  73 // is a folder or a bookmark.
  74 std::string GenerateRemoteId() {
  75   std::stringstream random_id;
  76   random_id << kBookmarkPrefix;
  77
  78   // Generate 32 digit hex string random suffix.
  79   random_id << std::hex << std::setfill('0') << std::setw(16);
  80   random_id << base::RandUint64() << base::RandUint64();
  81   return random_id.str();
  82 }
  83 }  // namespace
  84
  85 namespace enhanced_bookmarks {
  86
  87 EnhancedBookmarkModel::EnhancedBookmarkModel(BookmarkModel* bookmark_model,
  88                                              const std::string& version)
  89     : bookmark_model_(bookmark_model),
  90       loaded_(false),
  91       version_(version),
  92       weak_ptr_factory_(this) {
  93   bookmark_model_->AddObserver(this);
  94   bookmark_model_->AddNonClonedKey(kIdKey);
  95   if (bookmark_model_->loaded()) {
  96     InitializeIdMap();
  97     loaded_ = true;
  98   }
  99 }
 100
 101 EnhancedBookmarkModel::~EnhancedBookmarkModel() {
 102   Shutdown();
 103 }
 104
 105 void EnhancedBookmarkModel::Shutdown() {
 106   if (bookmark_model_) {
 107     FOR_EACH_OBSERVER(EnhancedBookmarkModelObserver,
 108                       observers_,
 109                       EnhancedBookmarkModelShuttingDown());
 110     weak_ptr_factory_.InvalidateWeakPtrs();
 111     bookmark_model_->RemoveObserver(this);
 112     bookmark_model_ = NULL;
 113   }
 114 }
 115
 116 void EnhancedBookmarkModel::AddObserver(
 117     EnhancedBookmarkModelObserver* observer) {
 118   observers_.AddObserver(observer);
 119 }
 120
 121 void EnhancedBookmarkModel::RemoveObserver(
 122     EnhancedBookmarkModelObserver* observer) {
 123   observers_.RemoveObserver(observer);
 124 }
 125
 126 // Moves |node| to |new_parent| and inserts it at the given |index|.
 127 void EnhancedBookmarkModel::Move(const BookmarkNode* node,
 128                                  const BookmarkNode* new_parent,
 129                                  int index) {
 130   bookmark_model_->Move(node, new_parent, index);
 131 }
 132
 133 // Adds a new folder node at the specified position.
 134 const BookmarkNode* EnhancedBookmarkModel::AddFolder(
 135     const BookmarkNode* parent,
 136     int index,
 137     const base::string16& title) {
 138   return bookmark_model_->AddFolder(parent, index, title);
 139 }
 140
 141 // Adds a url at the specified position.
 142 const BookmarkNode* EnhancedBookmarkModel::AddURL(
 143     const BookmarkNode* parent,
 144     int index,
 145     const base::string16& title,
 146     const GURL& url,
 147     const base::Time& creation_time) {
 148   BookmarkNode::MetaInfoMap meta_info;
 149   meta_info[kIdKey] = GenerateRemoteId();
 150   return bookmark_model_->AddURLWithCreationTimeAndMetaInfo(
 151       parent, index, title, url, creation_time, &meta_info);
 152 }
 153
 154 std::string EnhancedBookmarkModel::GetRemoteId(const BookmarkNode* node) {
 155   if (node == bookmark_model_->bookmark_bar_node())
 156     return kBookmarkBarId;
 157
 158   std::string id;
 159   if (!node->GetMetaInfo(kIdKey, &id))
 160     return std::string();
 161   return id;
 162 }
 163
 164 const BookmarkNode* EnhancedBookmarkModel::BookmarkForRemoteId(
 165     const std::string& remote_id) {
 166   IdToNodeMap::iterator it = id_map_.find(remote_id);
 167   if (it != id_map_.end())
 168     return it->second;
 169   return NULL;
 170 }
 171
 172 void EnhancedBookmarkModel::SetDescription(const BookmarkNode* node,
 173                                            const std::string& description) {
 174   SetMetaInfo(node, kNoteKey, description);
 175 }
 176
 177 std::string EnhancedBookmarkModel::GetDescription(const BookmarkNode* node) {
 178   // First, look for a custom note set by the user.
 179   std::string description;
 180   if (node->GetMetaInfo(kNoteKey, &description) && !description.empty())
 181     return description;
 182
 183   // If none are present, return the snippet.
 184   return GetSnippet(node);
 185 }
 186
 187 bool EnhancedBookmarkModel::SetOriginalImage(const BookmarkNode* node,
 188                                              const GURL& url,
 189                                              int width,
 190                                              int height) {
 191   DCHECK(node->is_url());
 192   DCHECK(url.is_valid());
 193
 194   std::string decoded(DataForMetaInfoField(node, kImageDataKey));
 195   image::collections::ImageData data;
 196
 197   // Try to populate the imageData with the existing data.
 198   if (decoded != "") {
 199     // If the parsing fails, something is wrong. Immediately fail.
 200     bool result = data.ParseFromString(decoded);
 201     if (!result)
 202       return false;
 203   }
 204
 205   scoped_ptr<image::collections::ImageData_ImageInfo> info(
 206       new image::collections::ImageData_ImageInfo);
 207   info->set_url(url.spec());
 208   info->set_width(width);
 209   info->set_height(height);
 210   data.set_allocated_original_info(info.release());
 211
 212   std::string output;
 213   bool result = data.SerializePartialToString(&output);
 214   if (!result)
 215     return false;
 216
 217   std::string encoded;
 218   base::Base64Encode(output, &encoded);
 219   SetMetaInfo(node, kImageDataKey, encoded);
 220   return true;
 221 }
 222
 223 bool EnhancedBookmarkModel::GetOriginalImage(const BookmarkNode* node,
 224                                              GURL* url,
 225                                              int* width,
 226                                              int* height) {
 227   std::string decoded(DataForMetaInfoField(node, kImageDataKey));
 228   if (decoded == "")
 229     return false;
 230
 231   image::collections::ImageData data;
 232   bool result = data.ParseFromString(decoded);
 233   if (!result)
 234     return false;
 235
 236   if (!data.has_original_info())
 237     return false;
 238
 239   return PopulateImageData(data.original_info(), url, width, height);
 240 }
 241
 242 bool EnhancedBookmarkModel::GetThumbnailImage(const BookmarkNode* node,
 243                                               GURL* url,
 244                                               int* width,
 245                                               int* height) {
 246   std::string decoded(DataForMetaInfoField(node, kImageDataKey));
 247   if (decoded == "")
 248     return false;
 249
 250   image::collections::ImageData data;
 251   bool result = data.ParseFromString(decoded);
 252   if (!result)
 253     return false;
 254
 255   if (!data.has_thumbnail_info())
 256     return false;
 257
 258   return PopulateImageData(data.thumbnail_info(), url, width, height);
 259 }
 260
 261 std::string EnhancedBookmarkModel::GetSnippet(const BookmarkNode* node) {
 262   std::string decoded(DataForMetaInfoField(node, kPageDataKey));
 263   if (decoded.empty())
 264     return decoded;
 265
 266   image::collections::PageData data;
 267   bool result = data.ParseFromString(decoded);
 268   if (!result)
 269     return std::string();
 270
 271   return data.snippet();
 272 }
 273
 274 void EnhancedBookmarkModel::SetVersionSuffix(
 275     const std::string& version_suffix) {
 276   version_suffix_ = version_suffix;
 277 }
 278
 279 void EnhancedBookmarkModel::BookmarkModelChanged() {
 280 }
 281
 282 void EnhancedBookmarkModel::BookmarkModelLoaded(BookmarkModel* model,
 283                                                 bool ids_reassigned) {
 284   InitializeIdMap();
 285   loaded_ = true;
 286   FOR_EACH_OBSERVER(
 287       EnhancedBookmarkModelObserver, observers_, EnhancedBookmarkModelLoaded());
 288 }
 289
 290 void EnhancedBookmarkModel::BookmarkNodeAdded(BookmarkModel* model,
 291                                               const BookmarkNode* parent,
 292                                               int index) {
 293   const BookmarkNode* node = parent->GetChild(index);
 294   std::string remote_id;
 295   if (node->GetMetaInfo(kIdKey, &remote_id)) {
 296     AddToIdMap(node);
 297     ScheduleResetDuplicateRemoteIds();
 298   } else if (node->is_url()) {
 299     set_needs_offline_processing_tasks_[node] =
 300         make_linked_ptr(new base::CancelableClosure(
 301             base::Bind(&EnhancedBookmarkModel::SetNeedsOfflineProcessing,
 302                        weak_ptr_factory_.GetWeakPtr(),
 303                        base::Unretained(node))));
 304     base::MessageLoopProxy::current()->PostTask(
 305         FROM_HERE, set_needs_offline_processing_tasks_[node]->callback());
 306   }
 307   FOR_EACH_OBSERVER(
 308       EnhancedBookmarkModelObserver, observers_, EnhancedBookmarkAdded(node));
 309 }
 310
 311 void EnhancedBookmarkModel::BookmarkNodeRemoved(
 312     BookmarkModel* model,
 313     const BookmarkNode* parent,
 314     int old_index,
 315     const BookmarkNode* node,
 316     const std::set<GURL>& removed_urls) {
 317   RemoveNodeFromMaps(node);
 318   FOR_EACH_OBSERVER(
 319       EnhancedBookmarkModelObserver, observers_, EnhancedBookmarkRemoved(node));
 320 }
 321
 322 void EnhancedBookmarkModel::BookmarkNodeChanged(BookmarkModel* model,
 323                                                 const BookmarkNode* node) {
 324   FOR_EACH_OBSERVER(
 325       EnhancedBookmarkModelObserver, observers_,
 326       EnhancedBookmarkNodeChanged(node));
 327 }
 328
 329 void EnhancedBookmarkModel::OnWillChangeBookmarkMetaInfo(
 330     BookmarkModel* model,
 331     const BookmarkNode* node) {
 332   prev_remote_id_ = GetRemoteId(node);
 333 }
 334
 335 void EnhancedBookmarkModel::BookmarkMetaInfoChanged(BookmarkModel* model,
 336                                                     const BookmarkNode* node) {
 337   std::string remote_id = GetRemoteId(node);
 338   if (remote_id != prev_remote_id_) {
 339     id_map_.erase(prev_remote_id_);
 340     if (!remote_id.empty()) {
 341       AddToIdMap(node);
 342       ScheduleResetDuplicateRemoteIds();
 343     }
 344     FOR_EACH_OBSERVER(
 345         EnhancedBookmarkModelObserver,
 346         observers_,
 347         EnhancedBookmarkRemoteIdChanged(node, prev_remote_id_, remote_id));
 348   }
 349 }
 350
 351 void EnhancedBookmarkModel::BookmarkAllUserNodesRemoved(
 352     BookmarkModel* model,
 353     const std::set<GURL>& removed_urls) {
 354   id_map_.clear();
 355   // Re-initialize so non-user nodes with remote ids are present in the map.
 356   InitializeIdMap();
 357   FOR_EACH_OBSERVER(EnhancedBookmarkModelObserver,
 358                     observers_,
 359                     EnhancedBookmarkAllUserNodesRemoved());
 360 }
 361
 362 void EnhancedBookmarkModel::InitializeIdMap() {
 363   ui::TreeNodeIterator<const BookmarkNode> iterator(
 364       bookmark_model_->root_node());
 365   while (iterator.has_next()) {
 366     AddToIdMap(iterator.Next());
 367   }
 368   ScheduleResetDuplicateRemoteIds();
 369 }
 370
 371 void EnhancedBookmarkModel::AddToIdMap(const BookmarkNode* node) {
 372   std::string remote_id = GetRemoteId(node);
 373   if (remote_id.empty())
 374     return;
 375
 376   // Try to insert the node.
 377   std::pair<IdToNodeMap::iterator, bool> result =
 378       id_map_.insert(make_pair(remote_id, node));
 379   if (!result.second) {
 380     // Some node already had the same remote id, so add both nodes to the
 381     // to-be-reset set.
 382     nodes_to_reset_[result.first->second] = remote_id;
 383     nodes_to_reset_[node] = remote_id;
 384   }
 385 }
 386
 387 void EnhancedBookmarkModel::RemoveNodeFromMaps(const BookmarkNode* node) {
 388   for (int i = 0; i < node->child_count(); i++) {
 389     RemoveNodeFromMaps(node->GetChild(i));
 390   }
 391   std::string remote_id = GetRemoteId(node);
 392   id_map_.erase(remote_id);
 393   nodes_to_reset_.erase(node);
 394   set_needs_offline_processing_tasks_.erase(node);
 395 }
 396
 397 void EnhancedBookmarkModel::ScheduleResetDuplicateRemoteIds() {
 398   if (!nodes_to_reset_.empty()) {
 399     base::MessageLoopProxy::current()->PostTask(
 400         FROM_HERE,
 401         base::Bind(&EnhancedBookmarkModel::ResetDuplicateRemoteIds,
 402                    weak_ptr_factory_.GetWeakPtr()));
 403   }
 404 }
 405
 406 void EnhancedBookmarkModel::ResetDuplicateRemoteIds() {
 407   for (NodeToIdMap::iterator it = nodes_to_reset_.begin();
 408        it != nodes_to_reset_.end();
 409        ++it) {
 410     BookmarkNode::MetaInfoMap meta_info;
 411     meta_info[kIdKey] = "";
 412     meta_info[kOldIdKey] = it->second;
 413     SetMultipleMetaInfo(it->first, meta_info);
 414   }
 415   nodes_to_reset_.clear();
 416 }
 417
 418 void EnhancedBookmarkModel::SetNeedsOfflineProcessing(
 419     const BookmarkNode* node) {
 420   set_needs_offline_processing_tasks_.erase(node);
 421   int flags = 0;
 422   std::string flags_str;
 423   if (node->GetMetaInfo(kFlagsKey, &flags_str)) {
 424     if (!base::StringToInt(flags_str, &flags))
 425       flags = 0;
 426   }
 427   flags |= NEEDS_OFFLINE_PROCESSING;
 428   SetMetaInfo(node, kFlagsKey, base::IntToString(flags));
 429 }
 430
 431 void EnhancedBookmarkModel::SetMetaInfo(const BookmarkNode* node,
 432                                         const std::string& field,
 433                                         const std::string& value) {
 434   DCHECK(!bookmark_model_->is_permanent_node(node));
 435
 436   BookmarkNode::MetaInfoMap meta_info;
 437   const BookmarkNode::MetaInfoMap* old_meta_info = node->GetMetaInfoMap();
 438   if (old_meta_info)
 439     meta_info.insert(old_meta_info->begin(), old_meta_info->end());
 440
 441   // Don't update anything if the value to set is already there.
 442   BookmarkNode::MetaInfoMap::iterator it = meta_info.find(field);
 443   if (it != meta_info.end() && it->second == value)
 444     return;
 445
 446   meta_info[field] = value;
 447   meta_info[kVersionKey] = GetVersionString();
 448   bookmark_model_->SetNodeMetaInfoMap(node, meta_info);
 449 }
 450
 451 std::string EnhancedBookmarkModel::GetVersionString() {
 452   if (version_suffix_.empty())
 453     return version_;
 454   return version_ + '/' + version_suffix_;
 455 }
 456
 457 void EnhancedBookmarkModel::SetMultipleMetaInfo(
 458     const BookmarkNode* node,
 459     BookmarkNode::MetaInfoMap meta_info) {
 460   DCHECK(!bookmark_model_->is_permanent_node(node));
 461
 462   // Don't update anything if every value is already set correctly.
 463   if (node->GetMetaInfoMap()) {
 464     bool changed = false;
 465     const BookmarkNode::MetaInfoMap* old_meta_info = node->GetMetaInfoMap();
 466     for (BookmarkNode::MetaInfoMap::iterator it = meta_info.begin();
 467          it != meta_info.end();
 468          ++it) {
 469       BookmarkNode::MetaInfoMap::const_iterator old_field =
 470           old_meta_info->find(it->first);
 471       if (old_field == old_meta_info->end() ||
 472           old_field->second != it->second) {
 473         changed = true;
 474         break;
 475       }
 476     }
 477     if (!changed)
 478       return;
 479
 480     // Fill in the values that aren't changing
 481     meta_info.insert(old_meta_info->begin(), old_meta_info->end());
 482   }
 483
 484   meta_info[kVersionKey] = GetVersionString();
 485   bookmark_model_->SetNodeMetaInfoMap(node, meta_info);
 486 }
 487
 488 bool EnhancedBookmarkModel::SetAllImages(const BookmarkNode* node,
 489                                          const GURL& image_url,
 490                                          int image_width,
 491                                          int image_height,
 492                                          const GURL& thumbnail_url,
 493                                          int thumbnail_width,
 494                                          int thumbnail_height) {
 495   DCHECK(node->is_url());
 496   DCHECK(image_url.is_valid() || image_url.is_empty());
 497   DCHECK(thumbnail_url.is_valid() || thumbnail_url.is_empty());
 498   std::string decoded(DataForMetaInfoField(node, kImageDataKey));
 499   image::collections::ImageData data;
 500
 501   // Try to populate the imageData with the existing data.
 502   if (decoded != "") {
 503     // If the parsing fails, something is wrong. Immediately fail.
 504     bool result = data.ParseFromString(decoded);
 505     if (!result)
 506       return false;
 507   }
 508
 509   if (image_url.is_empty()) {
 510     data.release_original_info();
 511   } else {
 512     // Regardless of whether an image info exists, we make a new one.
 513     // Intentially make a raw pointer.
 514     image::collections::ImageData_ImageInfo* info =
 515         new image::collections::ImageData_ImageInfo;
 516     info->set_url(image_url.spec());
 517     info->set_width(image_width);
 518     info->set_height(image_height);
 519     // This method consumes the raw pointer.
 520     data.set_allocated_original_info(info);
 521   }
 522
 523   if (thumbnail_url.is_empty()) {
 524     data.release_thumbnail_info();
 525   } else {
 526     // Regardless of whether an image info exists, we make a new one.
 527     // Intentially make a raw pointer.
 528     image::collections::ImageData_ImageInfo* info =
 529         new image::collections::ImageData_ImageInfo;
 530     info->set_url(thumbnail_url.spec());
 531     info->set_width(thumbnail_width);
 532     info->set_height(thumbnail_height);
 533     // This method consumes the raw pointer.
 534     data.set_allocated_thumbnail_info(info);
 535   }
 536   std::string output;
 537   bool result = data.SerializePartialToString(&output);
 538   if (!result)
 539     return false;
 540
 541   std::string encoded;
 542   base::Base64Encode(output, &encoded);
 543   bookmark_model_->SetNodeMetaInfo(node, kImageDataKey, encoded);
 544   return true;
 545 }
 546
 547 }  // namespace enhanced_bookmarks