// Copyright (c) 2009 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_AUTOFILL_FORM_STRUCTURE_H_ #define CHROME_BROWSER_AUTOFILL_FORM_STRUCTURE_H_ #include #include #include "base/scoped_vector.h" #include "chrome/browser/autofill/autofill_field.h" #include "chrome/browser/autofill/autofill_type.h" #include "chrome/browser/autofill/field_types.h" #include "googleurl/src/gurl.h" #include "webkit/glue/form_data.h" namespace buzz { class XmlElement; } // namespace buzz enum RequestMethod { GET, POST }; enum UploadRequired { UPLOAD_NOT_REQUIRED, UPLOAD_REQUIRED, USE_UPLOAD_RATES }; // FormStructure stores a single HTML form together with the values entered // in the fields along with additional information needed by AutoFill. class FormStructure { public: explicit FormStructure(const webkit_glue::FormData& form); // Encodes the XML upload request from this FormStructure. bool EncodeUploadRequest(bool auto_fill_used, std::string* encoded_xml) const; // Encodes the XML query request for the set of forms. // All fields are returned in one XML. For example, there are three forms, // with 2, 4, and 3 fields. The returned XML would have type info for 9 // fields, first two of which would be for the first form, next 4 for the // second, and the rest is for the third. static bool EncodeQueryRequest(const ScopedVector& forms, std::string* encoded_xml); // Parses the field types from the server query response. |forms| must be the // same as the one passed to EncodeQueryRequest when constructing the query. static void ParseQueryResponse(const std::string& response_xml, const std::vector& forms, UploadRequired* upload_required); // The unique signature for this form, composed of the target url domain, // the form name, and the form field names in a 64-bit hash. std::string FormSignature() const; // Runs a quick heuristic to rule out pages but obviously not auto-fillable, // like google/yahoo/msn search, etc. bool IsAutoFillable() const; // Returns true if at least one of the form fields relevant for AutoFill // is not empty. bool HasAutoFillableValues() const; // Returns true if at least one of the form fields is a billing field, which // includes billing address fields and credit card fields. bool HasBillingFields() const; // Returns true if at least one of the form fields is a non-billing field, // which includes billing address fields and credit card fields. bool HasNonBillingFields() const; // Resets |autofill_count_| and counts the number of auto-fillable fields. // This is used when we receive server data for form fields. At that time, // we may have more known fields than just the number of fields we matched // heuristically. void UpdateAutoFillCount(); // Sets the possible types for the field at |index|. void set_possible_types(int index, const FieldTypeSet& types); const AutoFillField* field(int index) const; size_t field_count() const; // Returns the number of fields that are able to be autofilled. size_t autofill_count() const { return autofill_count_; } // Converts this object to a FormData object. webkit_glue::FormData ConvertToFormData() const; // Used for iterating over the fields. std::vector::const_iterator begin() const { return fields_.begin(); } std::vector::const_iterator end() const { return fields_.end(); } bool operator==(const webkit_glue::FormData& form) const; bool operator!=(const webkit_glue::FormData& form) const; private: enum EncodeRequestType { QUERY, UPLOAD, }; // Runs several heuristics against the form fields to determine their possible // types. void GetHeuristicAutoFillTypes(); // Associates the field with the heuristic type for each of the field views. void GetHeuristicFieldInfo(FieldTypeMap* field_types_map); // Adds form info to |encompassing_xml_element|. |request_type| indicates if // it is a query or upload. bool EncodeFormRequest(EncodeRequestType request_type, buzz::XmlElement* encompassing_xml_element) const; // The name of the form. string16 form_name_; // The source URL. GURL source_url_; // The target URL. GURL target_url_; bool has_credit_card_field_; bool has_autofillable_field_; bool has_password_fields_; // The number of fields able to be autofilled. size_t autofill_count_; // A vector of all the input fields in the form. The vector is terminated by // a NULL entry. ScopedVector fields_; // The names of the form input elements, that are part of the form signature. // The string starts with "&" and the names are also separated by the "&" // character. E.g.: "&form_input1_name&form_input2_name&...&form_inputN_name" std::string form_signature_field_names_; // GET or POST. RequestMethod method_; DISALLOW_COPY_AND_ASSIGN(FormStructure); }; #endif // CHROME_BROWSER_AUTOFILL_FORM_STRUCTURE_H_