Create syncable metadata table for Wallet credit cards and addresses.

components/autofill/core/browser/webdata/autofill_table.h

 // Copyright 2013 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 COMPONENTS_AUTOFILL_CORE_BROWSER_WEBDATA_AUTOFILL_TABLE_H_
 #define COMPONENTS_AUTOFILL_CORE_BROWSER_WEBDATA_AUTOFILL_TABLE_H_
 
 #include <vector>
 
 #include "base/compiler_specific.h"
@@ skipping 145 matching lines @@
 //   exp_year           Four-digit year: 2017
 //
 // unmasked_credit_cards
 //                      When a masked credit credit card is unmasked and the
 //                      full number is downloaded, it will be stored here.
 //
 //   id                 Server ID. This can be joined with the id in the
 //                      masked_credit_cards table to get the rest of the data.
 //   card_number_encrypted
 //                      Full card number, encrypted.
-//   use_count          The number of times this card has been used to fill
-//                      a form. Added in version 62.
-//   use_date           The date this card was last used to fill a form, in
-//                      internal time format (NOT time_t). Added in version 62.
+//   use_count          DEPRECATED in version 65. See server_card_metadata.
+//   use_date           DEPRECATED in version 65. See server_card_metadata.
 //   unmask_date        The date this card was unmasked in units of
 //                      Time::ToInternalValue. Added in version 64.
 //
+// server_card_metadata
+//                      Metadata (currently, usage data) about server credit
+//                      cards. This will be synced.
+//
+//   id                 The server ID, which matches an ID from the
+//                      masked_credit_cards table.
+//   use_count          The number of times this card has been used to fill
+//                      a form.
+//   use_date           The date this card was last used to fill a form,
+//                      in internal t.
+//
 // server_addresses     This table contains Autofill address data synced from
 //                      the wallet server. It's basically the same as the
 //                      autofill_profiles table but locally immutable.
 //
 //   id                 String assigned by the server to identify this address.
 //                      This is opaque to the client.
 //   recipient_name     Added in v63.
 //   company_name
 //   street_address     The combined lines of the street address.
 //   address_1          Also known as "administrative area". This is normally
 //                      the state or province in most countries.
 //   address_2          Also known as "locality". In the US this is the city.
 //   address_3          A sub-classification beneath the city, e.g. an
 //                      inner-city district or suburb. Also known as
 //                      "dependent_locality".
 //   address_4          Used in certain countries. Also known as
 //                      "sub_dependent_locality".
 //   postal_code
 //   sorting_code       Similar to the zipcode column, but used for businesses
 //                      or organizations that might not be geographically
 //                      contiguous. The canonical example is CEDEX in France.
 //   country_code
 //   language_code      The BCP 47 language code used to format the address for
 //                      display. For example, a JP address with "ja" language
 //                      code starts with the postal code, but a JP address with
 //                      "ja-latn" language code starts with the recipient name.
 //   phone_number       Phone number. This is a string and has no formatting
 //                      constraints. Added in version 64.
+//
+// server_address_metadata
+//                      Metadata (currently, usage data) about server addresses.
+//                      This will be synced.
+//
+//   id                 The server ID, which matches an ID from the
+//                      server_addresses table.
+//   use_count          The number of times this address has been used to fill
+//                      a form.
+//   use_date           The date this address was last used to fill a form,
+//                      in internal t.
+
 class AutofillTable : public WebDatabaseTable {
  public:
   explicit AutofillTable(const std::string& app_locale);
   ~AutofillTable() override;
 
   // Retrieves the AutofillTable* owned by |database|.
   static AutofillTable* FromWebDatabase(WebDatabase* db);
 
   WebDatabaseTable::TypeKey GetTypeKey() const override;
   bool CreateTablesIfNecessary() override;
@@ skipping 98 matching lines @@
   virtual bool GetCreditCards(std::vector<CreditCard*>* credit_cards);
   virtual bool GetServerCreditCards(std::vector<CreditCard*>* credit_cards);
 
   // Replaces all server credit cards with the given vector. Unmasked cards
   // present in the new list will be preserved (even if the input is MASKED).
   void SetServerCreditCards(const std::vector<CreditCard>& credit_cards);
 
   // Cards synced from the server may be "masked" (only last 4 digits
   // available) or "unmasked" (everything is available). These functions set
   // that state.
-  bool UnmaskServerCreditCard(const std::string& id,
+  bool UnmaskServerCreditCard(const CreditCard& masked,
                               const base::string16& full_number);
   bool MaskServerCreditCard(const std::string& id);
 
-  // Updates the use count and last use date for an unmasked server card.
-  bool UpdateUnmaskedCardUsageStats(const CreditCard& credit_card);
+  bool UpdateServerCardUsageStats(const CreditCard& credit_card);
+  bool UpdateServerAddressUsageStats(const AutofillProfile& profile);
 
   // Deletes all data from the server card and profile tables. Returns true if
   // any data was deleted, false if not (so false means "commit not needed"
   // rather than "error").
   bool ClearAllServerData();
 
   // Removes rows from autofill_profiles and credit_cards if they were created
   // on or after |delete_begin| and strictly before |delete_end|.  Returns the
   // list of deleted profile guids in |profile_guids|.  Return value is true if
   // all rows were successfully removed.  Returns false on database error.  In
@@ skipping 23 matching lines @@
   // Empties the Autofill profiles "trash can".
   bool EmptyAutofillProfilesTrash();
 
   // Retrieves all profiles in the database that have been deleted since last
   // "empty" of the trash.
   bool AddAutofillGUIDToTrash(const std::string& guid);
 
   // Clear all profiles.
   bool ClearAutofillProfiles();
 
-  // Table migration functions.
+  // Table migration functions. NB: These do not and should not rely on other
+  // functions in this class. The implementation of a function such as
+  // GetCreditCard may change over time, but MigrateToVersionXX should never
+  // change.
   bool MigrateToVersion54AddI18nFieldsAndRemoveDeprecatedFields();
   bool MigrateToVersion55MergeAutofillDatesTable();
   bool MigrateToVersion56AddProfileLanguageCodeForFormatting();
   bool MigrateToVersion57AddFullNameField();
   bool MigrateToVersion60AddServerCards();
   bool MigrateToVersion61AddUsageStats();
   bool MigrateToVersion62AddUsageStatsForUnmaskedCards();
   bool MigrateToVersion63AddServerRecipientName();
   bool MigrateToVersion64AddUnmaskDate();
+  bool MigrateToVersion65AddServerMetadataTables();
 
   // Max data length saved in the table;
   static const size_t kMaxDataLength;
 
  private:
   FRIEND_TEST_ALL_PREFIXES(AutofillTableTest, Autofill);
   FRIEND_TEST_ALL_PREFIXES(AutofillTableTest, Autofill_AddChanges);
   FRIEND_TEST_ALL_PREFIXES(AutofillTableTest, Autofill_RemoveBetweenChanges);
   FRIEND_TEST_ALL_PREFIXES(AutofillTableTest, Autofill_UpdateDontReplace);
   FRIEND_TEST_ALL_PREFIXES(
@@ skipping 49 matching lines @@
   bool InitMainTable();
   bool InitCreditCardsTable();
   bool InitDatesTable();
   bool InitProfilesTable();
   bool InitProfileNamesTable();
   bool InitProfileEmailsTable();
   bool InitProfilePhonesTable();
   bool InitProfileTrashTable();
   bool InitMaskedCreditCardsTable();
   bool InitUnmaskedCreditCardsTable();
+  bool InitServerCardMetadataTable();
   bool InitServerAddressesTable();
+  bool InitServerAddressMetadataTable();
 
   // The application locale.  The locale is needed for the migration to version
   // 35. Since it must be read on the UI thread, it is set when the table is
   // created (on the UI thread), and cached here so that it can be used for
   // migrations (on the DB thread).
   std::string app_locale_;
 
   DISALLOW_COPY_AND_ASSIGN(AutofillTable);
 };
 
 }  // namespace autofill
 
 #endif  // COMPONENTS_AUTOFILL_CORE_BROWSER_WEBDATA_AUTOFILL_TABLE_H_