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 void FillFormField(const AutofillField& field, 58 size_t variant, 59 const std::string& app_locale, 60 FormFieldData* field_data) 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 // Set |field_data|'s value for phone number based on contents of |this|. 72 // The |field| specifies the type of the phone and whether this is a 73 // phone prefix or suffix. The |variant| parameter specifies which value in a 74 // multi-valued profile. 75 void FillPhoneNumberField(const AutofillField& field, 76 size_t variant, 77 const std::string& app_locale, 78 FormFieldData* field_data) const; 79 80 // The user-visible label of the profile, generated in relation to other 81 // profiles. Shows at least 2 fields that differentiate profile from other 82 // profiles. See AdjustInferredLabels() further down for more description. 83 const base::string16 Label() const; 84 85 // Returns true if there are no values (field types) set. 86 bool IsEmpty(const std::string& app_locale) const; 87 88 // Returns true if the |type| of data in this profile is present, but invalid. 89 // Otherwise returns false. 90 bool IsPresentButInvalid(ServerFieldType type) const; 91 92 // Comparison for Sync. Returns 0 if the profile is the same as |this|, 93 // or < 0, or > 0 if it is different. The implied ordering can be used for 94 // culling duplicates. The ordering is based on collation order of the 95 // textual contents of the fields. 96 // GUIDs and origins are not compared, only the values of the contents 97 // themselves. Full profile comparision, comparison includes multi-valued 98 // fields. 99 int Compare(const AutofillProfile& profile) const; 100 101 // Equality operators compare GUIDs, origins, and the contents in the 102 // comparison. 103 bool operator==(const AutofillProfile& profile) const; 104 virtual bool operator!=(const AutofillProfile& profile) const; 105 106 // Returns concatenation of full name and address line 1. This acts as the 107 // basis of comparison for new values that are submitted through forms to 108 // aid with correct aggregation of new data. 109 const base::string16 PrimaryValue() const; 110 111 // Returns true if the data in this AutofillProfile is a subset of the data in 112 // |profile|. 113 bool IsSubsetOf(const AutofillProfile& profile, 114 const std::string& app_locale) const; 115 116 // Overwrites the single-valued field data in |profile| with this 117 // Profile. Or, for multi-valued fields append the new values. 118 void OverwriteWithOrAddTo(const AutofillProfile& profile, 119 const std::string& app_locale); 120 121 // Returns |true| if |type| accepts multi-values. 122 static bool SupportsMultiValue(ServerFieldType type); 123 124 // Adjusts the labels according to profile data. 125 // Labels contain minimal different combination of: 126 // 1. Full name. 127 // 2. Address. 128 // 3. E-mail. 129 // 4. Phone. 130 // 5. Company name. 131 // Profile labels are changed accordingly to these rules. 132 // Returns true if any of the profiles were updated. 133 // This function is useful if you want to adjust unique labels for all 134 // profiles. For non permanent situations (selection of profile, when user 135 // started typing in the field, for example) use CreateInferredLabels(). 136 static bool AdjustInferredLabels(std::vector<AutofillProfile*>* profiles); 137 138 // Creates inferred labels for |profiles|, according to the rules above and 139 // stores them in |created_labels|. If |suggested_fields| is not NULL, the 140 // resulting label fields are drawn from |suggested_fields|, except excluding 141 // |excluded_field|. Otherwise, the label fields are drawn from a default set, 142 // and |excluded_field| is ignored; by convention, it should be of 143 // |UNKNOWN_TYPE| when |suggested_fields| is NULL. Each label includes at 144 // least |minimal_fields_shown| fields, if possible. 145 static void CreateInferredLabels( 146 const std::vector<AutofillProfile*>* profiles, 147 const std::vector<ServerFieldType>* suggested_fields, 148 ServerFieldType excluded_field, 149 size_t minimal_fields_shown, 150 std::vector<base::string16>* created_labels); 151 152 private: 153 typedef std::vector<const FormGroup*> FormGroupList; 154 155 // FormGroup: 156 virtual bool FillCountrySelectControl(const std::string& app_locale, 157 FormFieldData* field) const OVERRIDE; 158 virtual void GetSupportedTypes( 159 ServerFieldTypeSet* supported_types) const OVERRIDE; 160 161 // Shared implementation for GetRawMultiInfo() and GetMultiInfo(). Pass an 162 // empty |app_locale| to get the raw info; otherwise, the returned info is 163 // canonicalized according to the given |app_locale|, if appropriate. 164 void GetMultiInfoImpl(const AutofillType& type, 165 const std::string& app_locale, 166 std::vector<base::string16>* values) const; 167 168 // Checks if the |phone| is in the |existing_phones| using fuzzy matching: 169 // for example, "1-800-FLOWERS", "18003569377", "(800)356-9377" and "356-9377" 170 // are considered the same. 171 // Adds the |phone| to the |existing_phones| if not already there. 172 void AddPhoneIfUnique(const base::string16& phone, 173 const std::string& app_locale, 174 std::vector<base::string16>* existing_phones); 175 176 // Builds inferred label from the first |num_fields_to_include| non-empty 177 // fields in |label_fields|. Uses as many fields as possible if there are not 178 // enough non-empty fields. 179 base::string16 ConstructInferredLabel( 180 const std::vector<ServerFieldType>& label_fields, 181 size_t num_fields_to_include) const; 182 183 // Creates inferred labels for |profiles| at indices corresponding to 184 // |indices|, and stores the results to the corresponding elements of 185 // |created_labels|. These labels include enough fields to differentiate among 186 // the profiles, if possible; and also at least |num_fields_to_include| 187 // fields, if possible. The label fields are drawn from |fields|. 188 static void CreateDifferentiatingLabels( 189 const std::vector<AutofillProfile*>& profiles, 190 const std::list<size_t>& indices, 191 const std::vector<ServerFieldType>& fields, 192 size_t num_fields_to_include, 193 std::vector<base::string16>* created_labels); 194 195 // Utilities for listing and lookup of the data members that constitute 196 // user-visible profile information. 197 FormGroupList FormGroups() const; 198 const FormGroup* FormGroupForType(const AutofillType& type) const; 199 FormGroup* MutableFormGroupForType(const AutofillType& type); 200 201 // The label presented to the user when selecting a profile. 202 base::string16 label_; 203 204 // Personal information for this profile. 205 std::vector<NameInfo> name_; 206 std::vector<EmailInfo> email_; 207 CompanyInfo company_; 208 std::vector<PhoneNumber> phone_number_; 209 Address address_; 210 }; 211 212 // So we can compare AutofillProfiles with EXPECT_EQ(). 213 std::ostream& operator<<(std::ostream& os, const AutofillProfile& profile); 214 215 } // namespace autofill 216 217 #endif // COMPONENTS_AUTOFILL_CORE_BROWSER_AUTOFILL_PROFILE_H_ 218
