Update all bookmarks which use an icon URL when a favicon's bitmap is updated

components/bookmarks/browser/bookmark_model.h

 // 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.
 
 #ifndef COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_MODEL_H_
 #define COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_MODEL_H_
 
 #include <map>
 #include <set>
 #include <vector>
@@ skipping 148 matching lines @@
 
   // Sets the URL of |node|.
   void SetURL(const BookmarkNode* node, const GURL& url);
 
   // Sets the date added time of |node|.
   void SetDateAdded(const BookmarkNode* node, base::Time date_added);
 
   // Returns the set of nodes with the |url|.
   void GetNodesByURL(const GURL& url, std::vector<const BookmarkNode*>* nodes);
 
+  // Returns the set of nodes which use the favicon at |icon_url|.
+  void GetNodesByIconURL(const GURL& icon_url,
+                         std::vector<const BookmarkNode*>* nodes);
+
   // Returns the most recently added user node for the |url|; urls from any
   // nodes that are not editable by the user are never returned by this call.
   // Returns NULL if |url| is not bookmarked.
   const BookmarkNode* GetMostRecentlyAddedUserNodeForURL(const GURL& url);
 
   // Returns true if there are bookmarks, otherwise returns false.
   // This method is thread safe.
   bool HasBookmarks();
 
   // Returns true if the specified URL is bookmarked.
@@ skipping 110 matching lines @@
   // Returns the set of meta info keys that should not be copied when a node is
   // cloned.
   const std::set<std::string>& non_cloned_keys() const {
     return non_cloned_keys_;
   }
 
   // Sets the sync transaction version of |node|.
   void SetNodeSyncTransactionVersion(const BookmarkNode* node,
                                      int64 sync_transaction_version);
 
-  // Notify BookmarkModel that the favicons for |urls| have changed and have to
+  // Notify BookmarkModel that the favicons for the given page URLs
+  // (e.g. http://www.google.com) and the given icon URLs (e.g.
+  // http://www.google.com/favicon.ico) have changed and have to
   // be refetched. This notification is sent by BookmarkClient.
-  void OnFaviconChanged(const std::set<GURL>& urls);
+  void OnFaviconsChanged(const std::vector<GURL>& page_urls,
+                         const std::vector<GURL>& icon_urls);
 
   // Returns the client used by this BookmarkModel.
   BookmarkClient* client() const { return client_; }
 
  private:
   friend class BookmarkCodecTest;
+  friend class BookmarkModelTest;
   friend class BookmarkStorage;
   friend class ScopedGroupBookmarkActions;
   friend class TestBookmarkClient;
 
   // Used to order BookmarkNodes by URL.
   class NodeURLComparator {
    public:
     bool operator()(const BookmarkNode* n1, const BookmarkNode* n2) const {
       return n1->url() < n2->url();
     }
   };
 
+  // Used to order BookmarkNodes by icon URL.
+  class NodeIconURLComparator {
+   public:
+    bool operator()(const BookmarkNode* n1, BookmarkNode* n2) const {
+      return n1->icon_url() < n2->icon_url();
+    }
+  };
+
   // Implementation of IsBookmarked. Before calling this the caller must obtain
   // a lock on |url_lock_|.
   bool IsBookmarkedNoLock(const GURL& url);
 
   // Removes the node from internal maps and recurses through all children. If
   // the node is a url, its url is added to removed_urls.
   //
   // This does NOT delete the node.
   void RemoveNode(BookmarkNode* node, std::set<GURL>* removed_urls);
 
@@ skipping 41 matching lines @@
       favicon_base::IconType icon_type,
       const favicon_base::FaviconImageResult& image_result);
 
   // Invoked from the node to load the favicon. Requests the favicon from the
   // favicon service.
   void LoadFavicon(BookmarkNode* node, favicon_base::IconType icon_type);
 
   // Called to notify the observers that the favicon has been loaded.
   void FaviconLoaded(const BookmarkNode* node);
 
+  // Sets |node|'s favicon URL.
+  void SetFaviconURL(BookmarkNode* node, const GURL& icon_url);
+
+  // Clear |node|'s favicon data. Also cancel's any pending favicon load
+  // requests for |node|.
+  void InvalidateFavicon(BookmarkNode* node);
+
   // If we're waiting on a favicon for node, the load request is canceled.
   void CancelPendingFaviconLoadRequests(BookmarkNode* node);
 
   // Notifies the observers that a set of changes initiated by a single user
   // action is about to happen and has completed.
   void BeginGroupedChanges();
   void EndGroupedChanges();
 
   // Generates and returns the next node ID.
   int64 generate_next_node_id();
@@ skipping 28 matching lines @@
   ObserverList<BookmarkModelObserver> observers_;
 
   // Set of nodes ordered by URL. This is not a map to avoid copying the
   // urls.
   // WARNING: |nodes_ordered_by_url_set_| is accessed on multiple threads. As
   // such, be sure and wrap all usage of it around |url_lock_|.
   typedef std::multiset<BookmarkNode*, NodeURLComparator> NodesOrderedByURLSet;
   NodesOrderedByURLSet nodes_ordered_by_url_set_;
   base::Lock url_lock_;
 
+  // Set of nodes ordered by favicon URL. Does not contain nodes whose favicon
+  // has not been loaded or which do not have a favicon.
+  // WARNING: Only access from the UI thread.
+  typedef std::multiset<BookmarkNode*, NodeIconURLComparator>
+      NodesOrderedByIconURLSet;
+  NodesOrderedByIconURLSet nodes_ordered_by_favicon_url_set_;

[sky, 2015/06/15 14:40:54]

If you're saying the favicons rarely change, then I don't see the point in
maintaining the set. Am I missing something?

[pkotwicz, 2015/06/15 14:50:21]

I expect there to be 5 - 10 changes a day when syncing a Mac/iOS device with a
non-Mac device.

I don't know if this is considered "rare".

+
   // Used for loading favicons.
   base::CancelableTaskTracker cancelable_task_tracker_;
 
   // Reads/writes bookmarks to disk.
   scoped_ptr<BookmarkStorage> store_;
 
   scoped_ptr<BookmarkIndex> index_;
 
   base::WaitableEvent loaded_signal_;
 
   // See description of IsDoingExtensiveChanges above.
   int extensive_changes_;
 
   scoped_ptr<BookmarkExpandedStateTracker> expanded_state_tracker_;
 
   std::set<std::string> non_cloned_keys_;
 
   DISALLOW_COPY_AND_ASSIGN(BookmarkModel);
 };
 
 }  // namespace bookmarks
 
 #endif  // COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_MODEL_H_