1eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch// Copyright 2013 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#ifndef COMPONENTS_AUTOFILL_CORE_BROWSER_CREDIT_CARD_H_ 6eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#define COMPONENTS_AUTOFILL_CORE_BROWSER_CREDIT_CARD_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <iosfwd> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "base/compiler_specific.h" 13868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include "base/strings/string16.h" 14eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "components/autofill/core/browser/autofill_data_model.h" 15c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 16c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)namespace autofill { 172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)struct FormFieldData; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A form group that stores credit card information. 21c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)class CreditCard : public AutofillDataModel { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 23c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) CreditCard(const std::string& guid, const std::string& origin); 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For use in STL containers. 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CreditCard(); 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CreditCard(const CreditCard& credit_card); 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~CreditCard(); 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a version of |number| that has any separator characters removed. 31c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) static const base::string16 StripSeparators(const base::string16& number); 32c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 33c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // The user-visible type of the card, e.g. 'Mastercard'. 34c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) static base::string16 TypeForDisplay(const std::string& type); 352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 367d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) // The ResourceBundle ID for the appropriate credit card image. 377d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) static int IconResourceId(const std::string& type); 387d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) 39eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // Returns the internal representation of credit card type corresponding to 40eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // the given |number|. The credit card type is determined purely according to 41eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // the Issuer Identification Number (IIN), a.k.a. the "Bank Identification 42eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // Number (BIN)", which is parsed from the relevant prefix of the |number|. 43eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // This function performs no additional validation checks on the |number|. 44eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // Hence, the returned type for both the valid card "4111-1111-1111-1111" and 45eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // the invalid card "4garbage" will be Visa, which has an IIN of 4. 46116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch static const char* GetCreditCardType(const base::string16& number); 47a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) 48c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // FormGroup: 493240926e260ce088908e02ac07a6cf7b0c0cbf44Ben Murdoch virtual void GetMatchingTypes( 503240926e260ce088908e02ac07a6cf7b0c0cbf44Ben Murdoch const base::string16& text, 513240926e260ce088908e02ac07a6cf7b0c0cbf44Ben Murdoch const std::string& app_locale, 523240926e260ce088908e02ac07a6cf7b0c0cbf44Ben Murdoch ServerFieldTypeSet* matching_types) const OVERRIDE; 533240926e260ce088908e02ac07a6cf7b0c0cbf44Ben Murdoch virtual base::string16 GetRawInfo(ServerFieldType type) const OVERRIDE; 543240926e260ce088908e02ac07a6cf7b0c0cbf44Ben Murdoch virtual void SetRawInfo(ServerFieldType type, 55c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const base::string16& value) OVERRIDE; 563240926e260ce088908e02ac07a6cf7b0c0cbf44Ben Murdoch virtual base::string16 GetInfo(const AutofillType& type, 57c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const std::string& app_locale) const OVERRIDE; 583240926e260ce088908e02ac07a6cf7b0c0cbf44Ben Murdoch virtual bool SetInfo(const AutofillType& type, 59c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const base::string16& value, 602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const std::string& app_locale) OVERRIDE; 61c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Credit card preview summary, for example: ******1234, Exp: 01/2020 63c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const base::string16 Label() const; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Special method to set value for HTML5 month input type. 66c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void SetInfoForMonthInputType(const base::string16& value); 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The number altered for display, for example: ******1234 69c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) base::string16 ObfuscatedNumber() const; 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The last four digits of the credit card number. 71c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) base::string16 LastFourDigits() const; 722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The user-visible type of the card, e.g. 'Mastercard'. 73c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) base::string16 TypeForDisplay() const; 742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // A label for this credit card formatted as 'Cardname - 2345'. 75c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) base::string16 TypeAndLastFourDigits() const; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& type() const { return type_; } 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int expiration_month() const { return expiration_month_; } 802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int expiration_year() const { return expiration_year_; } 812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For use in STL containers. 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void operator=(const CreditCard& credit_card); 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // If the card numbers for |this| and |imported_card| match, and merging the 86c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // two wouldn't result in unverified data overwriting verified data, 87c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // overwrites |this| card's data with the data in |credit_card|. 88c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Returns true if the card numbers match, false otherwise. 892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool UpdateFromImportedCard(const CreditCard& imported_card, 902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const std::string& app_locale) WARN_UNUSED_RESULT; 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Comparison for Sync. Returns 0 if the credit card is the same as |this|, 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // or < 0, or > 0 if it is different. The implied ordering can be used for 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // culling duplicates. The ordering is based on collation order of the 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // textual contents of the fields. 96c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // GUIDs, origins, labels, and unique IDs are not compared, only the values of 97c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // the credit cards themselves. 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int Compare(const CreditCard& credit_card) const; 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Used by tests. 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator==(const CreditCard& credit_card) const; 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator!=(const CreditCard& credit_card) const; 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if there are no values (field types) set. 105c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool IsEmpty(const std::string& app_locale) const; 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if all field types have valid values set. 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool IsComplete() const; 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 110eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // Returns true if all field types have valid values set and the card is not 111eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // expired. 112eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch bool IsValid() const; 113eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the credit card number. 115c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const base::string16& number() const { return number_; } 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // FormGroup: 1193240926e260ce088908e02ac07a6cf7b0c0cbf44Ben Murdoch virtual void GetSupportedTypes( 1203240926e260ce088908e02ac07a6cf7b0c0cbf44Ben Murdoch ServerFieldTypeSet* supported_types) const OVERRIDE; 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The month and year are zero if not present. 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int Expiration4DigitYear() const { return expiration_year_; } 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int Expiration2DigitYear() const { return expiration_year_ % 100; } 125c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) base::string16 ExpirationMonthAsString() const; 126c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) base::string16 Expiration4DigitYearAsString() const; 127c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) base::string16 Expiration2DigitYearAsString() const; 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets |expiration_month_| to the integer conversion of |text|. 130c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void SetExpirationMonthFromString(const base::string16& text, 1312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const std::string& app_locale); 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets |expiration_year_| to the integer conversion of |text|. 134c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void SetExpirationYearFromString(const base::string16& text); 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets |number_| to |number| and computes the appropriate card |type_|. 137c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void SetNumber(const base::string16& number); 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These setters verify that the month and year are within appropriate 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ranges. 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetExpirationMonth(int expiration_month); 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetExpirationYear(int expiration_year); 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 144c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) base::string16 number_; // The credit card number. 145c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) base::string16 name_on_card_; // The cardholder's name. 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string type_; // The type of the card. 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These members are zero if not present. 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int expiration_month_; 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int expiration_year_; 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// So we can compare CreditCards with EXPECT_EQ(). 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)std::ostream& operator<<(std::ostream& os, const CreditCard& credit_card); 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The string identifiers for credit card icon resources. 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char* const kAmericanExpressCard; 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char* const kDinersCard; 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char* const kDiscoverCard; 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char* const kGenericCard; 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char* const kJCBCard; 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char* const kMasterCard; 1637dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdochextern const char* const kUnionPay; 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char* const kVisaCard; 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 166c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)} // namespace autofill 167c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 168eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#endif // COMPONENTS_AUTOFILL_CORE_BROWSER_CREDIT_CARD_H_ 169