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