Sending the proto files for review to unblcok the server team

chrome/browser/sync/glue/autofill_profile_model_associator.h

+// Copyright (c) 2010 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_SYNC_GLUE_AUTOFILL_PROFILE_MODEL_ASSOCIATOR_H_
+#define CHROME_BROWSER_SYNC_GLUE_AUTOFILL_PROFILE_MODEL_ASSOCIATOR_H_
+#pragma once
+
+#include <map>
+#include <set>
+#include <string>
+#include <vector>
+
+#include "base/basictypes.h"
+#include "base/lock.h"
+#include "base/ref_counted.h"
+#include "chrome/browser/autofill/personal_data_manager.h"
+#include "chrome/browser/sync/engine/syncapi.h"
+#include "chrome/browser/sync/glue/model_associator.h"
+#include "chrome/browser/sync/protocol/autofill_specifics.pb.h"
+#include "chrome/browser/webdata/autofill_entry.h"
+
+class AutoFillProfile;
+
+class ProfileSyncService;
+class WebDatabase;
+
+namespace sync_api {
+class WriteTransaction;
+}
+
+namespace browser_sync {
+
+class AutofillChangeProcessor;
+class UnrecoverableErrorHandler;
+
+// Contains all model association related logic:
+// * Algorithm to associate autofill model and sync model.
+// We do not check if we have local data before this run; we always
+// merge and sync.
+class AutofillProfileModelAssociator
+    : public PerDataTypeAssociatorInterface<std::string, std::string> {
+ public:
+  AutofillProfileModelAssociator(ProfileSyncService* sync_service,
+                                 WebDatabase* web_database,
+                                 PersonalDataManager* data_manager);
+  virtual ~AutofillProfileModelAssociator();
+
+  // A convenience wrapper of a bunch of state we pass around while
+  // associating models, and send to the WebDatabase for persistence.
+  // We do this so we hold the write lock for only a small period.
+  // When storing the web db we are out of the write lock.
+  struct DataBundle;
+
+  static syncable::ModelType model_type() { return syncable::AUTOFILL_PROFILE; }
+
+  // PerDataTypeAssociatorInterface implementation.
+  //
+  // Iterates through the sync model looking for matched pairs of items.
+  virtual bool AssociateModels();
+
+  // Clears all associations.
+  virtual bool DisassociateModels();
+
+  // [TODO] The has_nodes out param is true if the sync model has nodes other
+  // than the permanent tagged nodes.
+  virtual bool SyncModelHasUserCreatedNodes(bool* has_nodes);
+
+  // See ModelAssociator interface.
+  virtual void AbortAssociation();
+
+  // [TODO]Not implemented. Does not seemt to be necessary.
+  virtual const std::string* GetChromeNodeFromSyncId(
+      int64 sync_id) {
+    return NULL;
+  }
+
+  // [TODO]Not implemented. Does not seem to be necessary.
+  virtual bool InitSyncNodeFromChromeId(std::string node_id,
+                                        sync_api::BaseNode* sync_node) {
+    return false;
+  }
+
+  // Returns the sync id for the given autofill name, or sync_api::kInvalidId
+  // if the autofill name is not associated to any sync id.
+  virtual int64 GetSyncIdFromChromeId(std::string node_id);
+
+  // Associates the given autofill name with the given sync id.
+  virtual void Associate(const std::string* node, int64 sync_id);
+
+  // Remove the association that corresponds to the given sync id.
+  virtual void Disassociate(int64 sync_id);
+
+  // [TODO] Returns whether a node with the
+  // given permanent tag was found and update
+  // |sync_id| with that node's id. No current use. To Implement
+  // only for completeness.
+  virtual bool GetSyncIdForTaggedNode(const std::string& tag, int64* sync_id) {
+    return false;
+  }
+
+  // Returns sync service instance.
+  ProfileSyncService* sync_service() { return sync_service_; }
+
+ protected:
+    AutofillProfileModelAssociator() {}
+    virtual sync_api::ReadNode* GetReadNode(sync_api::WriteTransaction *trans);
+    bool TraverseAndAssociateChromeAutoFillProfiles(
+        sync_api::WriteTransaction* write_trans,
+        const sync_api::ReadNode& autofill_root,
+        const std::vector<AutoFillProfile*>& all_profiles_from_db,
+        std::set<std::string>* current_profiles,
+        std::vector<AutoFillProfile*>* updated_profiles);
+
+  // Helper to insert an AutoFillProfile into the WebDatabase (e.g. in response
+  // to encountering a sync node that doesn't exist yet locally).
+  virtual void AddNativeProfileIfNeeded(
+      const sync_pb::AutofillProfile2Specifics& profile,
+      DataBundle* bundle,
+      const sync_api::ReadNode& node);
+
+  // Helper to insert a sync node for the given AutoFillProfile (e.g. in
+  // response to encountering a native profile that doesn't exist yet in the
+  // cloud).
+  virtual bool MakeNewAutofillProfileSyncNode(
+      sync_api::WriteTransaction* trans,
+      const sync_api::BaseNode& autofill_root,
+      const AutoFillProfile& profile,
+      int64* sync_id);
+
+  // Once the above traversals are complete, we traverse the sync model to
+  // associate all remaining nodes.
+  bool TraverseAndAssociateAllSyncNodes(
+      sync_api::WriteTransaction* write_trans,
+      const sync_api::ReadNode& autofill_root,
+      DataBundle* bundle);
+
+  static bool OverwriteProfileWithServerData(
+      AutoFillProfile* merge_into,
+      const sync_pb::AutofillProfile2Specifics& specifics);
+
+  virtual bool EnsureOnThread(BrowserThread::ID);
+
+  // This is used by test cases that test this object.
+  // Since destructor cannot really call any overloaded methods
+  // it makes it impossible
+  // For us to override the ::currentlyon function. So setting this boolean
+  // indicates we should not perform the check.
+  bool dontCheckThreadOnExit_;
+ private:
+  typedef std::map<std::string, int64> AutofillToSyncIdMap;
+  typedef std::map<int64, std::string> SyncIdToAutofillMap;
+
+  // A convenience wrapper of a bunch of state we pass around while associating
+  // models, and send to the WebDatabase for persistence.
+  // struct DataBundle;
+
+  // Helper to query WebDatabase for the current autofill state.
+  bool LoadAutofillData(std::vector<AutoFillProfile*>* profiles);
+
+  static bool MergeField(FormGroup* f,
+                         AutoFillFieldType t,
+                         const std::string& specifics_field);
+
+  // Helper to persist any changes that occured during model association to
+  // the WebDatabase.
+  bool SaveChangesToWebData(const DataBundle& bundle);
+
+  // Called at various points in model association to determine if the
+  // user requested an abort.
+  bool IsAbortPending();
+
+  ProfileSyncService* sync_service_;
+  WebDatabase* web_database_;
+  PersonalDataManager* personal_data_;
+  int64 autofill_node_id_;
+
+  AutofillToSyncIdMap id_map_;
+  SyncIdToAutofillMap id_map_inverse_;
+
+  // Abort association pending flag and lock.  If this is set to true
+  // (via the AbortAssociation method), return from the
+  // AssociateModels method as soon as possible.
+  Lock abort_association_pending_lock_;
+  bool abort_association_pending_;
+
+  DISALLOW_COPY_AND_ASSIGN(AutofillProfileModelAssociator);
+};
+
+struct AutofillProfileModelAssociator::DataBundle {
+  std::set<std::string> current_profiles;
+  std::vector<AutoFillProfile*> updated_profiles;
+  std::vector<AutoFillProfile*> new_profiles;  // We own these pointers.
+  ~DataBundle() { STLDeleteElements(&new_profiles); }
+};
+
+}  // namespace browser_sync
+
+#endif  // CHROME_BROWSER_SYNC_GLUE_AUTOFILL_PROFILE_MODEL_ASSOCIATOR_H_