Introduce a couple of abstract bases for WebDataService.

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/file_path.h"
 #include "base/location.h"
 #include "base/memory/ref_counted.h"
 #include "base/sequenced_task_runner_helpers.h"
 #include "base/synchronization/lock.h"
-#include "chrome/browser/profiles/refcounted_profile_keyed_service.h"
+#include "chrome/browser/api/webdata/autofill_web_data_service.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/search_engines/template_url.h"
 #include "chrome/browser/search_engines/template_url_id.h"
 #include "chrome/browser/webdata/keyword_table.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 WebDatabase;
 
 namespace base {
 class Thread;
 }
 
-namespace webkit {
-namespace forms {
-struct FormField;
-}
-}
-
 namespace webkit_glue {
 struct WebIntentServiceData;
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 //
 // WebDataService is a generic data repository for meta data associated with
 // web pages. All data is retrieved and archived in an asynchronous way.
 //
 // All requests return a handle. The handle can be used to cancel the request.
 //
 ////////////////////////////////////////////////////////////////////////////////
 
 
 ////////////////////////////////////////////////////////////////////////////////
 //
 // WebDataService results
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-//
-// Result types
-//
-typedef enum {
-  BOOL_RESULT = 1,             // WDResult<bool>
-  KEYWORDS_RESULT,             // WDResult<WDKeywordsResult>
-  INT64_RESULT,                // WDResult<int64>
-#if defined(OS_WIN)
-  PASSWORD_IE7_RESULT,         // WDResult<IE7PasswordInfo>
-#endif
-  WEB_APP_IMAGES,              // WDResult<WDAppImagesResult>
-  TOKEN_RESULT,                // WDResult<std::vector<std::string>>
-  AUTOFILL_VALUE_RESULT,       // WDResult<std::vector<string16>>
-  AUTOFILL_CHANGES,            // WDResult<std::vector<AutofillChange>>
-  AUTOFILL_PROFILE_RESULT,     // WDResult<AutofillProfile>
-  AUTOFILL_PROFILES_RESULT,    // WDResult<std::vector<AutofillProfile*>>
-  AUTOFILL_CREDITCARD_RESULT,  // WDResult<CreditCard>
-  AUTOFILL_CREDITCARDS_RESULT, // WDResult<std::vector<CreditCard*>>
-  WEB_INTENTS_RESULT,          // WDResult<std::vector<WebIntentServiceData>>
-  WEB_INTENTS_DEFAULTS_RESULT, // WDResult<std::vector<DefaultWebIntentService>>
-} WDResultType;
-
 typedef std::vector<AutofillChange> AutofillChangeList;
 
 // Result from GetWebAppImages.
 struct WDAppImagesResult {
   WDAppImagesResult();
   ~WDAppImagesResult();
 
   // True if SetWebAppHasAllImages(true) was invoked.
   bool has_all_images;
 
@@ skipping 12 matching lines @@
   // Version of the built-in keywords. A value of 0 indicates a first run.
   int builtin_keyword_version;
   // Backup of the default search provider, and whether the backup is valid.
   bool backup_valid;
   TemplateURLData default_search_provider_backup;
   // Indicates if default search provider has been changed by something
   // other than user's action in the browser.
   bool did_default_search_provider_change;
 };
 
-//
-// The top level class for a result.
-//
-class WDTypedResult {
- public:
-  virtual ~WDTypedResult() {}
-
-  // Return the result type.
-  WDResultType GetType() const {
-    return type_;
-  }
-
- protected:
-  explicit WDTypedResult(WDResultType type) : type_(type) {
-  }
-
- private:
-  WDResultType type_;
-  DISALLOW_COPY_AND_ASSIGN(WDTypedResult);
-};
-
-// A result containing one specific pointer or literal value.
-template <class T> class WDResult : public WDTypedResult {
- public:
-
-  WDResult(WDResultType type, const T& v) : WDTypedResult(type), value_(v) {
-  }
-
-  virtual ~WDResult() {
-  }
-
-  // Return a single value result.
-  T GetValue() const {
-    return value_;
-  }
-
- private:
-  T value_;
-
-  DISALLOW_COPY_AND_ASSIGN(WDResult);
-};
-
-template <class T> class WDObjectResult : public WDTypedResult {
- public:
-  explicit WDObjectResult(WDResultType type) : WDTypedResult(type) {
-  }
-
-  T* GetValue() const {
-    return &value_;
-  }
-
- private:
-  // mutable to keep GetValue() const.
-  mutable T value_;
-  DISALLOW_COPY_AND_ASSIGN(WDObjectResult);
-};
-
 class WebDataServiceConsumer;
 
-class WebDataService : public RefcountedProfileKeyedService {
+class WebDataService
+    : public WebDataServiceBase,
+      public AutofillWebData,
+      public RefcountedProfileKeyedService {
  public:
-  // All requests return an opaque handle of the following type.
-  typedef int Handle;
-
   //////////////////////////////////////////////////////////////////////////////
   //
   // Internal requests
   //
   // Every request is processed using a request object. The object contains
   // both the request parameters and the results.
   //////////////////////////////////////////////////////////////////////////////
   class WebDataRequest {
    public:
     WebDataRequest(WebDataService* service,
@@ skipping 82 matching lines @@
 
     const U& arg2() const { return arg2_; }
 
    private:
     T arg1_;
     U arg2_;
   };
 
   WebDataService();
 
+  // 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
   // call.
   virtual void ShutdownOnUIThread() OVERRIDE;
 
   // Initializes the web data service. Returns false on failure
   // Takes the path of the profile directory as its argument.
   bool Init(const FilePath& profile_path);
 
   // Returns false if Shutdown() has been called.
   bool IsRunning() const;
 
   // Unloads the database without actually shutting down the service.  This can
   // be used to temporarily reduce the browser process' memory footprint.
   void UnloadDatabase();
 
-  // Cancel any pending request. You need to call this method if your
-  // WebDataServiceConsumer is about to be deleted.
-  void CancelRequest(Handle h);
-
   virtual bool IsDatabaseLoaded();
   virtual WebDatabase* GetDatabase();
 
   //////////////////////////////////////////////////////////////////////////////
   //
   // Keywords
   //
   //////////////////////////////////////////////////////////////////////////////
 
   // As the database processes requests at a later date, all deletion is
@@ skipping 119 matching lines @@
   Handle GetIE7Login(const IE7PasswordInfo& info,
                      WebDataServiceConsumer* consumer);
 #endif  // defined(OS_WIN)
 
   //////////////////////////////////////////////////////////////////////////////
   //
   // Autofill.
   //
   //////////////////////////////////////////////////////////////////////////////
 
-  // Schedules a task to add form fields to the web database.
+  // AutofillWebData implementation.
   virtual void AddFormFields(
-      const std::vector<webkit::forms::FormField>& fields);
-
-  // Initiates the request for a vector of values which have been entered in
-  // form input fields named |name|.  The method OnWebDataServiceRequestDone of
-  // |consumer| gets called back when the request is finished, with the vector
-  // included in the argument |result|.
-  Handle GetFormValuesForElementName(const string16& name,
-                                     const string16& prefix,
-                                     int limit,
-                                     WebDataServiceConsumer* consumer);
-
-  // Removes form elements recorded for Autocomplete from the database.
-  void RemoveFormElementsAddedBetween(const base::Time& delete_begin,
-                                      const base::Time& delete_end);
-  void RemoveExpiredFormElements();
-  void RemoveFormValueForElementName(const string16& name,
-                                     const string16& value);
-
-  // Schedules a task to add an Autofill profile to the web database.
-  void AddAutofillProfile(const AutofillProfile& profile);
-
-  // Schedules a task to update an Autofill profile in the web database.
-  void UpdateAutofillProfile(const AutofillProfile& profile);
-
-  // Schedules a task to remove an Autofill profile from the web database.
-  // |guid| is the identifer of the profile to remove.
-  void RemoveAutofillProfile(const std::string& guid);
-
-  // Initiates the request for all Autofill profiles.  The method
-  // OnWebDataServiceRequestDone of |consumer| gets called when the request is
-  // finished, with the profiles included in the argument |result|.  The
-  // consumer owns the profiles.
-  Handle GetAutofillProfiles(WebDataServiceConsumer* consumer);
-
-  // Remove "trashed" profile guids from the web database and optionally send
-  // notifications to tell Sync that the items have been removed.
-  void EmptyMigrationTrash(bool notify_sync);
-
-  // Schedules a task to add credit card to the web database.
-  void AddCreditCard(const CreditCard& credit_card);
-
-  // Schedules a task to update credit card in the web database.
-  void UpdateCreditCard(const CreditCard& credit_card);
-
-  // Schedules a task to remove a credit card from the web database.
-  // |guid| is identifer of the credit card to remove.
-  void RemoveCreditCard(const std::string& guid);
-
-  // Initiates the request for all credit cards.  The method
-  // OnWebDataServiceRequestDone of |consumer| gets called when the request is
-  // finished, with the credit cards included in the argument |result|.  The
-  // consumer owns the credit cards.
-  Handle GetCreditCards(WebDataServiceConsumer* consumer);
+      const std::vector<webkit::forms::FormField>& fields) OVERRIDE;
+  virtual Handle GetFormValuesForElementName(
+      const string16& name,
+      const string16& prefix,
+      int limit,
+      WebDataServiceConsumer* consumer) OVERRIDE;
+  virtual void RemoveExpiredFormElements() OVERRIDE;
+  virtual void RemoveFormValueForElementName(const string16& name,
+                                             const string16& value) OVERRIDE;
+  virtual void AddAutofillProfile(const AutofillProfile& profile) OVERRIDE;
+  virtual void UpdateAutofillProfile(const AutofillProfile& profile) OVERRIDE;
+  virtual void RemoveAutofillProfile(const std::string& guid) OVERRIDE;
+  virtual Handle GetAutofillProfiles(WebDataServiceConsumer* consumer) OVERRIDE;
+  virtual void EmptyMigrationTrash(bool notify_sync) OVERRIDE;
+  virtual void AddCreditCard(const CreditCard& credit_card) OVERRIDE;
+  virtual void UpdateCreditCard(const CreditCard& credit_card) OVERRIDE;
+  virtual void RemoveCreditCard(const std::string& guid) OVERRIDE;
+  virtual Handle GetCreditCards(WebDataServiceConsumer* consumer) OVERRIDE;
 
   // Removes Autofill records from the database.
   void RemoveAutofillProfilesAndCreditCardsModifiedBetween(
       const base::Time& delete_begin,
       const base::Time& delete_end);
 
+  // Removes form elements recorded for Autocomplete from the database.
+  void RemoveFormElementsAddedBetween(const base::Time& delete_begin,
+                                      const base::Time& delete_end);
+
   // 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;
 
@@ skipping 187 matching lines @@
 
   typedef std::map<Handle, WebDataRequest*> RequestMap;
   RequestMap pending_requests_;
 
   // MessageLoop the WebDataService is created on.
   MessageLoop* main_loop_;
 
   DISALLOW_COPY_AND_ASSIGN(WebDataService);
 };
 
-////////////////////////////////////////////////////////////////////////////////
-//
-// WebDataServiceConsumer.
-//
-// All requests to the web data service are asynchronous. When the request has
-// been performed, the data consumer is notified using the following interface.
-//
-////////////////////////////////////////////////////////////////////////////////
-
-class WebDataServiceConsumer {
- public:
-
-  // Called when a request is done. h uniquely identifies the request.
-  // result can be NULL, if no result is expected or if the database could
-  // not be opened. The result object is destroyed after this call.
-  virtual void OnWebDataServiceRequestDone(WebDataService::Handle h,
-                                           const WDTypedResult* result) = 0;
-
- protected:
-  virtual ~WebDataServiceConsumer() {}
-};
-
 #endif  // CHROME_BROWSER_WEBDATA_WEB_DATA_SERVICE_H__