1 // Copyright 2013 The Chromium Authors. All rights reserved. 2 // Use of this source code is governed by a BSD-style license that can be 3 // found in the LICENSE file. 4 5 #ifndef COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_PROFILE_H_ 6 #define COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_PROFILE_H_ 7 8 #include <stddef.h> 9 10 #include <iosfwd> 11 #include <list> 12 #include <string> 13 #include <vector> 14 15 #include "base/compiler_specific.h" 16 #include "base/strings/string16.h" 17 #include "components/autofill/core/browser/address.h" 18 #include "components/autofill/core/browser/autofill_data_model.h" 19 #include "components/autofill/core/browser/autofill_type.h" 20 #include "components/autofill/core/browser/contact_info.h" 21 #include "components/autofill/core/browser/phone_number.h" 22 23 namespace autofill { 24 25 struct FormFieldData; 26 27 // A collection of FormGroups stored in a profile. AutofillProfile also 28 // implements the FormGroup interface so that owners of this object can request 29 // form information from the profile, and the profile will delegate the request 30 // to the requested form group type. 31 class AutofillProfile : public AutofillDataModel { 32 public: 33 AutofillProfile(const std::string& guid, const std::string& origin); 34 35 // For use in STL containers. 36 AutofillProfile(); 37 AutofillProfile(const AutofillProfile& profile); 38 virtual ~AutofillProfile(); 39 40 AutofillProfile& operator=(const AutofillProfile& profile); 41 42 // FormGroup: 43 virtual void GetMatchingTypes( 44 const base::string16& text, 45 const std::string& app_locale, 46 ServerFieldTypeSet* matching_types) const OVERRIDE; 47 virtual base::string16 GetRawInfo(ServerFieldType type) const OVERRIDE; 48 virtual void SetRawInfo(ServerFieldType type, 49 const base::string16& value) OVERRIDE; 50 virtual base::string16 GetInfo(const AutofillType& type, 51 const std::string& app_locale) const OVERRIDE; 52 virtual bool SetInfo(const AutofillType& type, 53 const base::string16& value, 54 const std::string& app_locale) OVERRIDE; 55 56 // AutofillDataModel: 57 virtual base::string16 GetInfoForVariant( 58 const AutofillType& type, 59 size_t variant, 60 const std::string& app_locale) const OVERRIDE; 61 62 // Multi-value equivalents to |GetInfo| and |SetInfo|. 63 void SetRawMultiInfo(ServerFieldType type, 64 const std::vector<base::string16>& values); 65 void GetRawMultiInfo(ServerFieldType type, 66 std::vector<base::string16>* values) const; 67 void GetMultiInfo(const AutofillType& type, 68 const std::string& app_locale, 69 std::vector<base::string16>* values) const; 70 71 // Returns true if there are no values (field types) set. 72 bool IsEmpty(const std::string& app_locale) const; 73 74 // Returns true if the |type| of data in this profile is present, but invalid. 75 // Otherwise returns false. 76 bool IsPresentButInvalid(ServerFieldType type) const; 77 78 // Comparison for Sync. Returns 0 if the profile is the same as |this|, 79 // or < 0, or > 0 if it is different. The implied ordering can be used for 80 // culling duplicates. The ordering is based on collation order of the 81 // textual contents of the fields. 82 // GUIDs and origins are not compared, only the values of the contents 83 // themselves. Full profile comparision, comparison includes multi-valued 84 // fields. 85 int Compare(const AutofillProfile& profile) const; 86 87 // Equality operators compare GUIDs, origins, and the contents in the 88 // comparison. 89 bool operator==(const AutofillProfile& profile) const; 90 virtual bool operator!=(const AutofillProfile& profile) const; 91 92 // Returns concatenation of full name and address line 1. This acts as the 93 // basis of comparison for new values that are submitted through forms to 94 // aid with correct aggregation of new data. 95 const base::string16 PrimaryValue() const; 96 97 // Returns true if the data in this AutofillProfile is a subset of the data in 98 // |profile|. 99 bool IsSubsetOf(const AutofillProfile& profile, 100 const std::string& app_locale) const; 101 102 // Overwrites the single-valued field data in |profile| with this 103 // Profile. Or, for multi-valued fields append the new values. 104 void OverwriteWithOrAddTo(const AutofillProfile& profile, 105 const std::string& app_locale); 106 107 // Returns |true| if |type| accepts multi-values. 108 static bool SupportsMultiValue(ServerFieldType type); 109 110 // Creates a differentiating label for each of the |profiles|. 111 // Labels consist of the minimal differentiating combination of: 112 // 1. Full name. 113 // 2. Address. 114 // 3. E-mail. 115 // 4. Phone. 116 // 5. Company name. 117 static void CreateDifferentiatingLabels( 118 const std::vector<AutofillProfile*>& profiles, 119 std::vector<base::string16>* labels); 120 121 // Creates inferred labels for |profiles|, according to the rules above and 122 // stores them in |created_labels|. If |suggested_fields| is not NULL, the 123 // resulting label fields are drawn from |suggested_fields|, except excluding 124 // |excluded_field|. Otherwise, the label fields are drawn from a default set, 125 // and |excluded_field| is ignored; by convention, it should be of 126 // |UNKNOWN_TYPE| when |suggested_fields| is NULL. Each label includes at 127 // least |minimal_fields_shown| fields, if possible. 128 static void CreateInferredLabels( 129 const std::vector<AutofillProfile*>& profiles, 130 const std::vector<ServerFieldType>* suggested_fields, 131 ServerFieldType excluded_field, 132 size_t minimal_fields_shown, 133 std::vector<base::string16>* labels); 134 135 private: 136 typedef std::vector<const FormGroup*> FormGroupList; 137 138 // FormGroup: 139 virtual void GetSupportedTypes( 140 ServerFieldTypeSet* supported_types) const OVERRIDE; 141 142 // Shared implementation for GetRawMultiInfo() and GetMultiInfo(). Pass an 143 // empty |app_locale| to get the raw info; otherwise, the returned info is 144 // canonicalized according to the given |app_locale|, if appropriate. 145 void GetMultiInfoImpl(const AutofillType& type, 146 const std::string& app_locale, 147 std::vector<base::string16>* values) const; 148 149 // Checks if the |phone| is in the |existing_phones| using fuzzy matching: 150 // for example, "1-800-FLOWERS", "18003569377", "(800)356-9377" and "356-9377" 151 // are considered the same. 152 // Adds the |phone| to the |existing_phones| if not already there. 153 void AddPhoneIfUnique(const base::string16& phone, 154 const std::string& app_locale, 155 std::vector<base::string16>* existing_phones); 156 157 // Builds inferred label from the first |num_fields_to_include| non-empty 158 // fields in |label_fields|. Uses as many fields as possible if there are not 159 // enough non-empty fields. 160 base::string16 ConstructInferredLabel( 161 const std::vector<ServerFieldType>& label_fields, 162 size_t num_fields_to_include) const; 163 164 // Creates inferred labels for |profiles| at indices corresponding to 165 // |indices|, and stores the results to the corresponding elements of 166 // |labels|. These labels include enough fields to differentiate among the 167 // profiles, if possible; and also at least |num_fields_to_include| fields, if 168 // possible. The label fields are drawn from |fields|. 169 static void CreateInferredLabelsHelper( 170 const std::vector<AutofillProfile*>& profiles, 171 const std::list<size_t>& indices, 172 const std::vector<ServerFieldType>& fields, 173 size_t num_fields_to_include, 174 std::vector<base::string16>* labels); 175 176 // Utilities for listing and lookup of the data members that constitute 177 // user-visible profile information. 178 FormGroupList FormGroups() const; 179 const FormGroup* FormGroupForType(const AutofillType& type) const; 180 FormGroup* MutableFormGroupForType(const AutofillType& type); 181 182 // Personal information for this profile. 183 std::vector<NameInfo> name_; 184 std::vector<EmailInfo> email_; 185 CompanyInfo company_; 186 std::vector<PhoneNumber> phone_number_; 187 Address address_; 188 }; 189 190 // So we can compare AutofillProfiles with EXPECT_EQ(). 191 std::ostream& operator<<(std::ostream& os, const AutofillProfile& profile); 192 193 } // namespace autofill 194 195 #endif // COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_PROFILE_H_ 196