components/enhanced_bookmarks/bookmark_server_service.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_BOOKMARK_SERVER_SERVICE_H_
   6 #define COMPONENTS_ENHANCED_BOOKMARKS_BOOKMARK_SERVER_SERVICE_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "components/enhanced_bookmarks/enhanced_bookmark_model_observer.h"
  12 #include "google_apis/gaia/google_service_auth_error.h"
  13 #include "google_apis/gaia/oauth2_token_service.h"
  14 #include "net/url_request/url_fetcher.h"
  15 #include "net/url_request/url_fetcher_delegate.h"
  16 #include "net/url_request/url_request_context_getter.h"
  17
  18 class ProfileOAuth2TokenService;
  19 class SigninManagerBase;
  20 class BookmarkNode;
  21
  22 namespace enhanced_bookmarks {
  23
  24 class BookmarkServerService;
  25 class EnhancedBookmarkModel;
  26
  27 class BookmarkServerServiceObserver {
  28  public:
  29   virtual void OnChange(BookmarkServerService* service) = 0;
  30
  31  protected:
  32   virtual ~BookmarkServerServiceObserver() {}
  33 };
  34
  35 // This abstract class manages the connection to the bookmark servers and
  36 // stores the maps necessary to translate the response from stars.id to
  37 // BookmarkNodes. Subclasses just have to provide the right query and the
  38 // parsing of the response.
  39 class BookmarkServerService : protected net::URLFetcherDelegate,
  40                               private OAuth2TokenService::Consumer,
  41                               public EnhancedBookmarkModelObserver {
  42  public:
  43   BookmarkServerService(
  44       scoped_refptr<net::URLRequestContextGetter> request_context_getter,
  45       ProfileOAuth2TokenService* token_service,
  46       SigninManagerBase* signin_manager,
  47       EnhancedBookmarkModel* enhanced_bookmark_model);
  48   virtual ~BookmarkServerService();
  49
  50   void AddObserver(BookmarkServerServiceObserver* observer);
  51   void RemoveObserver(BookmarkServerServiceObserver* observer);
  52
  53  protected:
  54   // Retrieves a bookmark by using its remote id. Returns null if nothing
  55   // matches.
  56   virtual const BookmarkNode* BookmarkForRemoteId(
  57       const std::string& remote_id) const;
  58   const std::string RemoteIDForBookmark(const BookmarkNode* bookmark) const;
  59
  60   // Notifies the observers that something changed.
  61   void Notify();
  62
  63   // Triggers a fetch.
  64   void TriggerTokenRequest(bool cancel_previous);
  65
  66   // Build the query to send to the server. Returns a newly created url_fetcher.
  67   virtual net::URLFetcher* CreateFetcher() = 0;
  68
  69   // Processes the response to the query. Returns true on successful parsing,
  70   // false on failure. The implementation can assume that |should_notify| is set
  71   // to true by default, if changed to false there will be no OnChange
  72   // notification send.
  73   virtual bool ProcessResponse(const std::string& response,
  74                                bool* should_notify) = 0;
  75
  76   // If the token can't be retrieved or the query fails this method is called.
  77   virtual void CleanAfterFailure() = 0;
  78
  79   // EnhancedBookmarkModelObserver:
  80   virtual void EnhancedBookmarkModelShuttingDown() OVERRIDE;
  81
  82   SigninManagerBase* GetSigninManager();
  83
  84   // Cached pointer to the bookmarks model.
  85   EnhancedBookmarkModel* model_;  // weak
  86
  87  private:
  88   FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest, Cluster);
  89   FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest,
  90                            ClearClusterMapOnRemoveAllBookmarks);
  91
  92   // net::URLFetcherDelegate methods. Called when the query is finished.
  93   virtual void OnURLFetchComplete(const net::URLFetcher* source) OVERRIDE;
  94
  95   // OAuth2TokenService::Consumer methods.
  96   virtual void OnGetTokenSuccess(const OAuth2TokenService::Request* request,
  97                                  const std::string& access_token,
  98                                  const base::Time& expiration_time) OVERRIDE;
  99   virtual void OnGetTokenFailure(const OAuth2TokenService::Request* request,
 100                                  const GoogleServiceAuthError& error) OVERRIDE;
 101
 102   // The observers.
 103   ObserverList<BookmarkServerServiceObserver> observers_;
 104   // The Auth service is used to get a token for auth with the server.
 105   ProfileOAuth2TokenService* token_service_;  // Weak
 106   // The request to the token service.
 107   scoped_ptr<OAuth2TokenService::Request> token_request_;
 108   // To get the currently signed in user.
 109   SigninManagerBase* signin_manager_;  // Weak
 110   // To have access to the right context getter for the profile.
 111   scoped_refptr<net::URLRequestContextGetter> request_context_getter_;
 112   // The fetcher used to query the server.
 113   scoped_ptr<net::URLFetcher> url_fetcher_;
 114   // A map from stars.id to bookmark nodes. With no null entries.
 115   std::map<std::string, const BookmarkNode*> starsid_to_bookmark_;
 116
 117   DISALLOW_COPY_AND_ASSIGN(BookmarkServerService);
 118 };
 119 }  // namespace enhanced_bookmarks
 120
 121 #endif  // COMPONENTS_ENHANCED_BOOKMARKS_BOOKMARK_SERVER_SERVICE_H_