Refactor notifications of chrome/browser/webdata

chrome/browser/webdata/web_data_service.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.
 
 // Chromium settings and storage represent user-selected preferences and
 // information and MUST not be extracted, overwritten or modified except
 // through Chromium defined APIs.
 
 #ifndef CHROME_BROWSER_WEBDATA_WEB_DATA_SERVICE_H__
 #define CHROME_BROWSER_WEBDATA_WEB_DATA_SERVICE_H__
 
 #include <map>
 #include <string>
-#include <vector>
 
 #include "base/callback_forward.h"
 #include "base/files/file_path.h"
 #include "base/location.h"
 #include "base/memory/ref_counted.h"
+#include "base/observer_list.h"
 #include "base/sequenced_task_runner_helpers.h"
 #include "base/synchronization/lock.h"
-#include "chrome/browser/api/webdata/autofill_web_data_service.h"
+#include "chrome/browser/api/webdata/autofill_web_data.h"
 #include "chrome/browser/api/webdata/web_data_results.h"
 #include "chrome/browser/api/webdata/web_data_service_base.h"
 #include "chrome/browser/api/webdata/web_data_service_consumer.h"
 #include "chrome/browser/profiles/refcounted_profile_keyed_service.h"
 #include "chrome/browser/search_engines/template_url.h"
 #include "chrome/browser/search_engines/template_url_id.h"
 #include "chrome/browser/webdata/keyword_table.h"
 #include "chrome/browser/webdata/web_data_request_manager.h"
 #include "chrome/browser/webdata/web_database.h"
+#include "components/autofill/common/form_field_data.h"
 #include "content/public/browser/browser_thread.h"
 #include "sql/init_status.h"
 
 class AutocompleteSyncableService;
 class AutofillChange;
+class AutofillProfile;
 class AutofillProfileSyncableService;
+class CreditCard;
 struct DefaultWebIntentService;
 class GURL;
 #if defined(OS_WIN)
 struct IE7PasswordInfo;
 #endif
 class MessageLoop;
 class Profile;
 class SkBitmap;
 class WebDatabaseService;
 
@@ skipping 14 matching lines @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
 
 ////////////////////////////////////////////////////////////////////////////////
 //
 // WebDataService results
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-typedef std::vector<AutofillChange> AutofillChangeList;
-
 typedef base::Callback<scoped_ptr<WDTypedResult>(void)> ResultTask;
 
 // Result from GetWebAppImages.
 struct WDAppImagesResult {
   WDAppImagesResult();
   ~WDAppImagesResult();
 
   // True if SetWebAppHasAllImages(true) was invoked.
   bool has_all_images;
 
   // The images, may be empty.
   std::vector<SkBitmap> images;
 };
 
 struct WDKeywordsResult {
   WDKeywordsResult();
   ~WDKeywordsResult();
 
   KeywordTable::Keywords keywords;
   // Identifies the ID of the TemplateURL that is the default search. A value of
   // 0 indicates there is no default search provider.
   int64 default_search_provider_id;
   // Version of the built-in keywords. A value of 0 indicates a first run.
   int builtin_keyword_version;
 };
 
 class WebDataServiceConsumer;
+class WebDataServiceObserver;
 
 class WebDataService
     : public WebDataServiceBase,
       public AutofillWebData,
       public RefcountedProfileKeyedService {
  public:
   explicit WebDataService(WebDatabaseService* wdbs);
 
   // WebDataServiceBase implementation.
   virtual void CancelRequest(Handle h) OVERRIDE;
-  virtual content::NotificationSource GetNotificationSource() OVERRIDE;
 
   // Notifies listeners on the UI thread that multiple changes have been made to
   // to Autofill records of the database.
   // NOTE: This method is intended to be called from the DB thread.  It
   // it asynchronously notifies listeners on the UI thread.
   // |web_data_service| may be NULL for testing purposes.
   static void NotifyOfMultipleAutofillChanges(WebDataService* web_data_service);
 
   // RefcountedProfileKeyedService override:
   // Shutdown the web data service. The service can no longer be used after this
@@ skipping 176 matching lines @@
   // Returns the syncable service for Autofill addresses and credit cards stored
   // in this table. The returned service is owned by |this| object.
   virtual AutofillProfileSyncableService*
       GetAutofillProfileSyncableService() const;
 
   // Returns the syncable service for field autocomplete stored in this table.
   // The returned service is owned by |this| object.
   virtual AutocompleteSyncableService*
       GetAutocompleteSyncableService() const;
 
+  void AddObserver(WebDataServiceObserver* observer);
+  void RemoveObserver(WebDataServiceObserver* observer);
+
  protected:
   friend class TemplateURLServiceTest;
   friend class TemplateURLServiceTestingProfile;
   friend class WebDataServiceTest;
   friend class WebDataRequest;
 
   virtual ~WebDataService();
 
   //////////////////////////////////////////////////////////////////////////////
   //
   // The following methods are only invoked in the web data service thread.
   //
   //////////////////////////////////////////////////////////////////////////////
+  void NotifyDatabaseLoadedOnUIThread();

[dhollowa, 2013/03/12 22:22:28]

It looks like you made this protected for use by tests.  Please make that test
class a friend (here) instead, and keep this method private.

[kaiwang, 2013/03/13 04:57:20]

But it's FakeWebDataService in an anonymous namespace..
Since it's a subclass of WebDataService, I think make this protected is more
nature

[dhollowa, 2013/03/13 16:15:28]

Ok.

+
  private:
   friend struct content::BrowserThread::DeleteOnThread<
       content::BrowserThread::UI>;
   friend class base::DeleteHelper<WebDataService>;
 
   // Initialize any syncable services.
   void InitializeSyncableServices();
 
   // Deletes the syncable services.
   void ShutdownSyncableServices();
 
   void DBInitFailed(sql::InitStatus sql_status);
-  void NotifyDatabaseLoadedOnUIThread();
   void OnDatabaseInit(sql::InitStatus status);
 
   //////////////////////////////////////////////////////////////////////////////
   //
   // Keywords.
   //
   //////////////////////////////////////////////////////////////////////////////
   WebDatabase::State AddKeywordImpl(
       const TemplateURLData& data, WebDatabase* db);
   WebDatabase::State RemoveKeywordImpl(
@@ skipping 94 matching lines @@
   WebDatabase::State AddCreditCardImpl(
       const CreditCard& credit_card, WebDatabase* db);
   WebDatabase::State UpdateCreditCardImpl(
       const CreditCard& credit_card, WebDatabase* db);
   WebDatabase::State RemoveCreditCardImpl(
       const std::string& guid, WebDatabase* db);
   scoped_ptr<WDTypedResult> GetCreditCardsImpl(WebDatabase* db);
   WebDatabase::State RemoveAutofillProfilesAndCreditCardsModifiedBetweenImpl(
       const base::Time& delete_begin, const base::Time& delete_end,
       WebDatabase* db);
+  void NotifyAutofillMultipleChangedOnUIThread();
 
   // Callbacks to ensure that sensitive info is destroyed if request is
   // cancelled.
   void DestroyAutofillProfileResult(const WDTypedResult* result);
   void DestroyAutofillCreditCardResult(const WDTypedResult* result);
 
   // Our database service (not owned by us as it is a profile keyed service).
   WebDatabaseService* wdbs_;
 
   // True if we've received a notification that the WebDatabase has loaded.
   bool db_loaded_;
 
   // Syncable services for the database data.  We own the services, but don't
   // use |scoped_ptr|s because the lifetimes must be managed on the database
   // thread.
   // Currently only Autocomplete and Autofill profiles use the new Sync API, but
   // all the database data should migrate to this API over time.
   AutocompleteSyncableService* autocomplete_syncable_service_;
   AutofillProfileSyncableService* autofill_profile_syncable_service_;
 
+  ObserverList<WebDataServiceObserver> observer_list_;
+
   DISALLOW_COPY_AND_ASSIGN(WebDataService);
 };
 
 #endif  // CHROME_BROWSER_WEBDATA_WEB_DATA_SERVICE_H__