components/enhanced_bookmarks/enhanced_bookmark_model.h

   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 #ifndef COMPONENTS_ENHANCED_BOOKMARKS_ENHANCED_BOOKMARK_MODEL_H_
   6 #define COMPONENTS_ENHANCED_BOOKMARKS_ENHANCED_BOOKMARK_MODEL_H_
   7
   8 #include <map>
   9 #include <string>
  10
  11 #include "base/cancelable_callback.h"
  12 #include "base/memory/linked_ptr.h"
  13 #include "base/memory/weak_ptr.h"
  14 #include "base/observer_list.h"
  15 #include "base/strings/string16.h"
  16 #include "components/bookmarks/browser/base_bookmark_model_observer.h"
  17 #include "components/bookmarks/browser/bookmark_node.h"
  18 #include "components/keyed_service/core/keyed_service.h"
  19
  20 namespace base {
  21 class Time;
  22 }  // namespace base
  23
  24 class BookmarkModel;
  25 class BookmarkNode;
  26 class GURL;
  27
  28 FORWARD_DECLARE_TEST(EnhancedBookmarkModelTest, SetMultipleMetaInfo);
  29
  30 namespace enhanced_bookmarks {
  31
  32 class EnhancedBookmarkModelObserver;
  33
  34 // Wrapper around BookmarkModel providing utility functions for enhanced
  35 // bookmarks.
  36 class EnhancedBookmarkModel : public KeyedService,
  37                               public bookmarks::BaseBookmarkModelObserver {
  38  public:
  39   EnhancedBookmarkModel(BookmarkModel* bookmark_model,
  40                         const std::string& version);
  41   ~EnhancedBookmarkModel() override;
  42
  43   void Shutdown() override;
  44
  45   void AddObserver(EnhancedBookmarkModelObserver* observer);
  46   void RemoveObserver(EnhancedBookmarkModelObserver* observer);
  47
  48   // Moves |node| to |new_parent| and inserts it at the given |index|.
  49   void Move(const BookmarkNode* node,
  50             const BookmarkNode* new_parent,
  51             int index);
  52
  53   // Adds a new folder node at the specified position.
  54   const BookmarkNode* AddFolder(const BookmarkNode* parent,
  55                                 int index,
  56                                 const base::string16& title);
  57
  58   // Adds a url at the specified position.
  59   const BookmarkNode* AddURL(const BookmarkNode* parent,
  60                              int index,
  61                              const base::string16& title,
  62                              const GURL& url,
  63                              const base::Time& creation_time);
  64
  65   // Returns the remote id for a bookmark |node|.
  66   std::string GetRemoteId(const BookmarkNode* node);
  67
  68   // Returns the bookmark node corresponding to the given |remote_id|, or NULL
  69   // if there is no node with the id.
  70   const BookmarkNode* BookmarkForRemoteId(const std::string& remote_id);
  71
  72   // Sets the description of a bookmark |node|.
  73   void SetDescription(const BookmarkNode* node, const std::string& description);
  74
  75   // Returns the description of a bookmark |node|.
  76   std::string GetDescription(const BookmarkNode* node);
  77
  78   // Sets the URL of an image representative of a bookmark |node|.
  79   // Expects the URL to be valid and not empty.
  80   // Returns true if the metainfo is successfully populated.
  81   bool SetOriginalImage(const BookmarkNode* node,
  82                         const GURL& url,
  83                         int width,
  84                         int height);
  85
  86   // Returns the url and dimensions of the original scraped image of a
  87   // bookmark |node|.
  88   // Returns true if the out variables are populated, false otherwise.
  89   bool GetOriginalImage(const BookmarkNode* node,
  90                         GURL* url,
  91                         int* width,
  92                         int* height);
  93
  94   // Returns the url and dimensions of the server provided thumbnail image for
  95   // a given bookmark |node|.
  96   // Returns true if the out variables are populated, false otherwise.
  97   bool GetThumbnailImage(const BookmarkNode* node,
  98                          GURL* url,
  99                          int* width,
 100                          int* height);
 101
 102   // Returns a brief server provided synopsis of the bookmarked page.
 103   // Returns the empty string if the snippet could not be extracted.
 104   std::string GetSnippet(const BookmarkNode* node);
 105
 106   // Sets a custom suffix to be added to the version field when writing meta
 107   // info fields.
 108   void SetVersionSuffix(const std::string& version_suffix);
 109
 110   // TODO(rfevang): Add method + enum for accessing/writing flags.
 111
 112   // Used for testing, simulates the process that creates the thumbnails. Will
 113   // remove existing entries for empty urls or set them if the url is not empty.
 114   // Expects valid or empty urls. Returns true if the metainfo is successfully
 115   // populated.
 116   // TODO(rfevang): Move this to a testing only utility file.
 117   bool SetAllImages(const BookmarkNode* node,
 118                     const GURL& image_url,
 119                     int image_width,
 120                     int image_height,
 121                     const GURL& thumbnail_url,
 122                     int thumbnail_width,
 123                     int thumbnail_height);
 124
 125   // TODO(rfevang): Ideally nothing should need the underlying bookmark model.
 126   // Remove when that is actually the case.
 127   BookmarkModel* bookmark_model() { return bookmark_model_; }
 128
 129   // Returns true if the enhanced bookmark model is done loading.
 130   bool loaded() { return loaded_; }
 131
 132   // Returns the version string to use when setting stars.version.
 133   std::string GetVersionString();
 134
 135  private:
 136   FRIEND_TEST_ALL_PREFIXES(::EnhancedBookmarkModelTest, SetMultipleMetaInfo);
 137
 138   typedef std::map<std::string, const BookmarkNode*> IdToNodeMap;
 139   typedef std::map<const BookmarkNode*, std::string> NodeToIdMap;
 140
 141   // bookmarks::BaseBookmarkModelObserver:
 142   void BookmarkModelChanged() override;
 143   void BookmarkModelLoaded(BookmarkModel* model, bool ids_reassigned) override;
 144   void BookmarkNodeAdded(BookmarkModel* model,
 145                          const BookmarkNode* parent,
 146                          int index) override;
 147   void BookmarkNodeRemoved(BookmarkModel* model,
 148                            const BookmarkNode* parent,
 149                            int old_index,
 150                            const BookmarkNode* node,
 151                            const std::set<GURL>& removed_urls) override;
 152   void BookmarkNodeChanged(BookmarkModel* model,
 153                            const BookmarkNode* node) override;
 154   void OnWillChangeBookmarkMetaInfo(BookmarkModel* model,
 155                                     const BookmarkNode* node) override;
 156   void BookmarkMetaInfoChanged(BookmarkModel* model,
 157                                const BookmarkNode* node) override;
 158   void BookmarkAllUserNodesRemoved(BookmarkModel* model,
 159                                    const std::set<GURL>& removed_urls) override;
 160
 161   // Initialize the mapping from remote ids to nodes.
 162   void InitializeIdMap();
 163
 164   // Adds a node to the id map if it has a (unique) remote id. Must be followed
 165   // by a (Schedule)ResetDuplicateRemoteIds call when done adding nodes.
 166   void AddToIdMap(const BookmarkNode* node);
 167
 168   // Recursively removes a node and all its children from the various maps.
 169   void RemoveNodeFromMaps(const BookmarkNode* node);
 170
 171   // If there are nodes that needs to reset their remote ids, schedules
 172   // ResetDuplicateRemoteIds to be run asynchronously.
 173   void ScheduleResetDuplicateRemoteIds();
 174
 175   // Clears out any duplicate remote ids detected by AddToIdMap calls.
 176   void ResetDuplicateRemoteIds();
 177
 178   // Sets the NEEDS_OFFLINE_PROCESSING flag on the given node.
 179   void SetNeedsOfflineProcessing(const BookmarkNode* node);
 180
 181   // Helper method for setting a meta info field on a node. Also updates the
 182   // version field.
 183   void SetMetaInfo(const BookmarkNode* node,
 184                    const std::string& field,
 185                    const std::string& value);
 186
 187   // Helper method for setting multiple meta info fields at once. All the fields
 188   // in |meta_info| will be set, but the method will not delete fields not
 189   // present.
 190   void SetMultipleMetaInfo(const BookmarkNode* node,
 191                            BookmarkNode::MetaInfoMap meta_info);
 192
 193   BookmarkModel* bookmark_model_;
 194   bool loaded_;
 195
 196   ObserverList<EnhancedBookmarkModelObserver> observers_;
 197
 198   IdToNodeMap id_map_;
 199   NodeToIdMap nodes_to_reset_;
 200
 201   // Pending SetNeedsOfflineProcessing calls are stored here, as they may need
 202   // to be cancelled if the node is removed.
 203   std::map<const BookmarkNode*, linked_ptr<base::CancelableClosure>>
 204       set_needs_offline_processing_tasks_;
 205
 206   // Caches the remote id of a node before its meta info changes.
 207   std::string prev_remote_id_;
 208
 209   std::string version_;
 210   std::string version_suffix_;
 211
 212   base::WeakPtrFactory<EnhancedBookmarkModel> weak_ptr_factory_;
 213 };
 214
 215 }  // namespace enhanced_bookmarks
 216
 217 #endif  // COMPONENTS_ENHANCED_BOOKMARKS_ENHANCED_BOOKMARK_MODEL_H_