Introduce BookmarkClient interface to abstract embedder

chrome/browser/bookmarks/bookmark_model.h

 // Copyright (c) 2012 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 CHROME_BROWSER_BOOKMARKS_BOOKMARK_MODEL_H_
 #define CHROME_BROWSER_BOOKMARKS_BOOKMARK_MODEL_H_
 
 #include <map>
 #include <set>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/observer_list.h"
 #include "base/strings/string16.h"
 #include "base/synchronization/lock.h"
 #include "base/synchronization/waitable_event.h"
-#include "base/task/cancelable_task_tracker.h"
+#include "components/bookmarks/core/browser/bookmark_client.h"
 #include "components/bookmarks/core/browser/bookmark_node.h"
 #include "components/bookmarks/core/browser/bookmark_service.h"
-#include "components/favicon_base/favicon_types.h"
-#include "components/keyed_service/core/keyed_service.h"
-#include "content/public/browser/notification_observer.h"
-#include "content/public/browser/notification_registrar.h"
 #include "ui/gfx/image/image.h"
 #include "url/gurl.h"
 
 class BookmarkExpandedStateTracker;
 class BookmarkIndex;
 class BookmarkLoadDetails;
 class BookmarkModelObserver;
 class BookmarkStorage;
 struct BookmarkMatch;
-class Profile;
+class PrefService;
 class ScopedGroupBookmarkActions;
 
 namespace base {
+class FilePath;
 class SequencedTaskRunner;
 }
 
-namespace chrome {
+namespace favicon_base {
 struct FaviconImageResult;
 }
 
+namespace test {
+class TestBookmarkClient;
+}
+
 // BookmarkModel --------------------------------------------------------------
 
 // BookmarkModel provides a directed acyclic graph of URLs and folders.
 // Three graphs are provided for the three entry points: those on the 'bookmarks
 // bar', those in the 'other bookmarks' folder and those in the 'mobile' folder.
 //
 // An observer may be attached to observe relevant events.
 //
 // You should NOT directly create a BookmarkModel, instead go through the
 // BookmarkModelFactory.
-class BookmarkModel : public content::NotificationObserver,
-                      public BookmarkService,
-                      public KeyedService {
+class BookmarkModel : public BookmarkService {
  public:
   // |index_urls| says whether URLs should be stored in the BookmarkIndex
   // in addition to bookmark titles.
-  BookmarkModel(Profile* profile, bool index_urls);
+  BookmarkModel(BookmarkClient* client, bool index_urls);
   virtual ~BookmarkModel();
 
   // Invoked prior to destruction to release any necessary resources.
-  virtual void Shutdown() OVERRIDE;
+  void Shutdown();
 
   // Loads the bookmarks. This is called upon creation of the
   // BookmarkModel. You need not invoke this directly.
-  // All load operations will be executed on |task_runner|.
-  void Load(const scoped_refptr<base::SequencedTaskRunner>& task_runner);
+  // All load operations will be executed on |io_task_runner| and the completion
+  // callback will be called from |ui_task_runner|.
+  void Load(PrefService* pref_service,
+            const std::string& accept_languages,
+            const base::FilePath& profile_path,
+            const scoped_refptr<base::SequencedTaskRunner>& io_task_runner,
+            const scoped_refptr<base::SequencedTaskRunner>& ui_task_runner);
 
   // Returns true if the model finished loading.
   bool loaded() const { return loaded_; }
 
   // Returns the root node. The 'bookmark bar' node and 'other' node are
   // children of the root node.
   const BookmarkNode* root_node() const { return &root_; }
 
   // Returns the 'bookmark bar' node. This is NULL until loaded.
   const BookmarkNode* bookmark_bar_node() const { return bookmark_bar_node_; }
@@ skipping 168 matching lines @@
                        const std::string& value);
   void SetNodeMetaInfoMap(const BookmarkNode* node,
                           const BookmarkNode::MetaInfoMap& meta_info_map);
   void DeleteNodeMetaInfo(const BookmarkNode* node,
                           const std::string& key);
 
   // Sets the sync transaction version of |node|.
   void SetNodeSyncTransactionVersion(const BookmarkNode* node,
                                      int64 sync_transaction_version);
 
-  // Returns the profile that corresponds to this BookmarkModel.
-  Profile* profile() { return profile_; }
+  // Notify BookmarkModel that the favicons for |urls| have changed and have to
+  // be refetched. This notification is sent by BookmarkClient.
+  void OnFaviconChanged(const std::set<GURL>& 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 test::TestBookmarkClient;
 
   // Used to order BookmarkNodes by URL.
   class NodeURLComparator {
    public:
     bool operator()(const BookmarkNode* n1, const BookmarkNode* n2) const {
       return n1->url() < n2->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);
 
   // Invoked when loading is finished. Sets |loaded_| and notifies observers.
   // BookmarkModel takes ownership of |details|.
-  void DoneLoading(BookmarkLoadDetails* details);
+  void DoneLoading(scoped_ptr<BookmarkLoadDetails> details);
 
   // Populates |nodes_ordered_by_url_set_| from root.
   void PopulateNodesByURL(BookmarkNode* node);
 
   // Removes the node from its parent, but does not delete it. No notifications
   // are sent. |removed_urls| is populated with the urls which no longer have
   // any bookmarks associated with them.
   // This method should be called after acquiring |url_lock_|.
   void RemoveNodeAndGetRemovedUrls(BookmarkNode* node,
                                    std::set<GURL>* removed_urls);
 
   // Removes the node from its parent, sends notification, and deletes it.
   // type specifies how the node should be removed.
   void RemoveAndDeleteNode(BookmarkNode* delete_me);
 
   // Remove |node| from |nodes_ordered_by_url_set_|.
   void RemoveNodeFromURLSet(BookmarkNode* node);
 
-  // Notifies the history backend about urls of removed bookmarks.
-  void NotifyHistoryAboutRemovedBookmarks(
-      const std::set<GURL>& removed_bookmark_urls) const;
-
   // Adds the |node| at |parent| in the specified |index| and notifies its
   // observers.
   BookmarkNode* AddNode(BookmarkNode* parent,
                         int index,
                         BookmarkNode* node);
 
   // Returns true if the parent and index are valid.
   bool IsValidIndex(const BookmarkNode* parent, int index, bool allow_end);
 
   // Creates one of the possible permanent nodes (bookmark bar node, other node
@@ skipping 14 matching lines @@
   void FaviconLoaded(const 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();
 
-  // content::NotificationObserver:
-  virtual void Observe(int type,
-                       const content::NotificationSource& source,
-                       const content::NotificationDetails& details) OVERRIDE;
-
   // Generates and returns the next node ID.
   int64 generate_next_node_id();
 
   // Sets the maximum node ID to the given value.
   // This is used by BookmarkCodec to report the maximum ID after it's done
   // decoding since during decoding codec assigns node IDs.
   void set_next_node_id(int64 id) { next_node_id_ = id; }
 
   // Creates and returns a new BookmarkLoadDetails. It's up to the caller to
   // delete the returned object.
-  BookmarkLoadDetails* CreateLoadDetails();
+  scoped_ptr<BookmarkLoadDetails> CreateLoadDetails(
+      const std::string& accept_languages);
 
-  content::NotificationRegistrar registrar_;
-
-  Profile* profile_;
+  BookmarkClient* const client_;
 
   // Whether the initial set of data has been loaded.
   bool loaded_;
 
   // The root node. This contains the bookmark bar node and the 'other' node as
   // children.
   BookmarkNode root_;
 
   BookmarkPermanentNode* bookmark_bar_node_;
   BookmarkPermanentNode* other_node_;
@@ skipping 29 matching lines @@
 
   // See description of IsDoingExtensiveChanges above.
   int extensive_changes_;
 
   scoped_ptr<BookmarkExpandedStateTracker> expanded_state_tracker_;
 
   DISALLOW_COPY_AND_ASSIGN(BookmarkModel);
 };
 
 #endif  // CHROME_BROWSER_BOOKMARKS_BOOKMARK_MODEL_H_