Separate WebDataRequest functionality from 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/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/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 "content/public/browser/browser_thread.h"
 #include "sql/init_status.h"
 
 class AutocompleteSyncableService;
 class AutofillChange;
 class AutofillProfileSyncableService;
 struct DefaultWebIntentService;
 class GURL;
 #if defined(OS_WIN)
 struct IE7PasswordInfo;
@@ skipping 53 matching lines @@
   int builtin_keyword_version;
 };
 
 class WebDataServiceConsumer;
 
 class WebDataService
     : public WebDataServiceBase,
       public AutofillWebData,
       public RefcountedProfileKeyedService {
  public:
-  //////////////////////////////////////////////////////////////////////////////
-  //
-  // 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,
-                   Handle handle,
-                   WebDataServiceConsumer* consumer);
-
-    virtual ~WebDataRequest();
-
-    Handle GetHandle() const;
-
-    // Retrieves the |consumer_| set in the constructor.  If the request was
-    // cancelled via the |Cancel()| method then |true| is returned and
-    // |*consumer| is set to NULL.  The |consumer| parameter may be set to NULL
-    // if only the return value is desired.
-    bool IsCancelled(WebDataServiceConsumer** consumer) const;
-
-    // This can be invoked from any thread. From this point we assume that
-    // our consumer_ reference is invalid.
-    void Cancel();
-
-    // Invoked by the service when this request has been completed.
-    // This will notify the service in whatever thread was used to create this
-    // request.
-    void RequestComplete();
-
-    // The result is owned by the request.
-    void SetResult(WDTypedResult* r);
-    const WDTypedResult* GetResult() const;
-
-   private:
-    scoped_refptr<WebDataService> service_;
-    MessageLoop* message_loop_;
-    Handle handle_;
-
-    // A lock to protect against simultaneous cancellations of the request.
-    // Cancellation affects both the |cancelled_| flag and |consumer_|.
-    mutable base::Lock cancel_lock_;
-    bool cancelled_;
-    WebDataServiceConsumer* consumer_;
-
-    WDTypedResult* result_;
-
-    DISALLOW_COPY_AND_ASSIGN(WebDataRequest);
-  };
-
-  //
-  // Internally we use instances of the following template to represent
-  // requests.
-  //
-  template <class T>
-  class GenericRequest : public WebDataRequest {
-   public:
-    GenericRequest(WebDataService* service,
-                   Handle handle,
-                   WebDataServiceConsumer* consumer,
-                   const T& arg)
-        : WebDataRequest(service, handle, consumer),
-          arg_(arg) {
-    }
-
-    virtual ~GenericRequest() {
-    }
-
-    const T& arg() const { return arg_; }
-
-   private:
-    T arg_;
-  };
-
-  template <class T, class U>
-  class GenericRequest2 : public WebDataRequest {
-   public:
-    GenericRequest2(WebDataService* service,
-                    Handle handle,
-                    WebDataServiceConsumer* consumer,
-                    const T& arg1,
-                    const U& arg2)
-        : WebDataRequest(service, handle, consumer),
-          arg1_(arg1),
-          arg2_(arg2) {
-    }
-
-    virtual ~GenericRequest2() { }
-
-    const T& arg1() const { return arg1_; }
-
-    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.
@@ skipping 188 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;
 
+  virtual void DestroyAutofillProfileResult(const WDTypedResult* result);

[dhollowa, 2013/01/04 23:57:36]

Can these be private?

[Cait (Slow), 2013/01/07 17:08:54]

Done.

+  virtual void DestroyAutofillCreditCardResult(const WDTypedResult* result);
   // Testing
 #ifdef UNIT_TEST
   void set_failed_init(bool value) { failed_init_ = value; }
 #endif
 
  protected:
   friend class TemplateURLServiceTest;
   friend class TemplateURLServiceTestingProfile;
   friend class WebDataServiceTest;
   friend class WebDataRequest;
 
   virtual ~WebDataService();
 
   // This is invoked by the unit test; path is the path of the Web Data file.
   bool InitWithPath(const FilePath& path);
 
   // Invoked by request implementations when a request has been processed.
   void RequestCompleted(Handle h);
 
-  // Register the request as a pending request.
-  void RegisterRequest(WebDataRequest* request);
-
   //////////////////////////////////////////////////////////////////////////////
   //
   // The following methods are only invoked in the web data service thread.
   //
   //////////////////////////////////////////////////////////////////////////////
  private:
   friend struct content::BrowserThread::DeleteOnThread<
       content::BrowserThread::UI>;
   friend class base::DeleteHelper<WebDataService>;
 
@@ skipping 21 matching lines @@
   // Commit the current transaction and creates a new one.
   void Commit();
 
   // Schedule a task on our worker thread.
   void ScheduleTask(const tracked_objects::Location& from_here,
                     const base::Closure& task);
 
   // Schedule a commit if one is not already pending.
   void ScheduleCommit();
 
-  // Return the next request handle.
-  int GetNextRequestHandle();
-
   //////////////////////////////////////////////////////////////////////////////
   //
   // Keywords.
   //
   //////////////////////////////////////////////////////////////////////////////
   void AddKeywordImpl(GenericRequest<TemplateURLData>* request);
   void RemoveKeywordImpl(GenericRequest<TemplateURLID>* request);
   void UpdateKeywordImpl(GenericRequest<TemplateURLData>* request);
   void GetKeywordsImpl(WebDataRequest* request);
   void SetDefaultSearchProviderImpl(GenericRequest<TemplateURLID>* r);
@@ skipping 81 matching lines @@
   // True once initialization has started.
   bool is_running_;
 
   // The path with which to initialize the database.
   FilePath path_;
 
   // Our database.  We own the |db_|, but don't use a |scoped_ptr| because the
   // |db_| lifetime must be managed on the database thread.
   WebDatabase* db_;
 
+  // Keeps track of all pending requests made to the db.
+  scoped_ptr<WebDataRequestManager> request_manager_;
+
   // 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_;
 
   // Whether the database failed to initialize.  We use this to avoid
   // continually trying to reinit.
   bool failed_init_;
 
   // Whether we should commit the database.
   bool should_commit_;
 
-  // A lock to protect pending requests and next request handle.
-  base::Lock pending_lock_;
-
-  // Next handle to be used for requests. Incremented for each use.
-  Handle next_request_handle_;
-
-  typedef std::map<Handle, WebDataRequest*> RequestMap;
-  RequestMap pending_requests_;
-
   // MessageLoop the WebDataService is created on.
   MessageLoop* main_loop_;
 
   DISALLOW_COPY_AND_ASSIGN(WebDataService);
 };
 
 #endif  // CHROME_BROWSER_WEBDATA_WEB_DATA_SERVICE_H__