path: root/chrome/browser/autofill/form_field.cc

// 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.

#include "chrome/browser/autofill/form_field.h"

#include "base/string_util.h"
#include "chrome/browser/autofill/address_field.h"
#include "chrome/browser/autofill/autofill_field.h"
#include "chrome/browser/autofill/credit_card_field.h"
#include "chrome/browser/autofill/name_field.h"
#include "chrome/browser/autofill/phone_field.h"
#include "third_party/WebKit/WebKit/chromium/public/WebRegularExpression.h"
#include "third_party/WebKit/WebKit/chromium/public/WebString.h"

class EmailField : public FormField {
 public:
  virtual bool GetFieldInfo(FieldTypeMap* field_type_map) const {
    bool ok = Add(field_type_map, field_, AutoFillType(EMAIL_ADDRESS));
    DCHECK(ok);
    return true;
  }

  static EmailField* Parse(std::vector<AutoFillField*>::const_iterator* iter,
                          bool is_ecml) {
    string16 pattern;
    if (is_ecml) {
      pattern = GetEcmlPattern(kEcmlShipToEmail, kEcmlBillToEmail, '|');
    } else {
      pattern = ASCIIToUTF16("email|e-mail");
    }

    AutoFillField* field;
    if (ParseText(iter, pattern, &field))
      return new EmailField(field);

    return NULL;
  }

 private:
  explicit EmailField(AutoFillField *field) : field_(field) {}

  AutoFillField* field_;
};

// static
bool FormField::Match(AutoFillField* field,
                      const string16& pattern,
                      bool match_label_only) {
  WebKit::WebRegularExpression re(WebKit::WebString(pattern),
                                  WebKit::WebTextCaseInsensitive);

  if (match_label_only) {
    // TODO(jhawkins): Remove StringToLowerASCII.  WebRegularExpression needs to
    // be fixed to take WebTextCaseInsensitive into account.
    if (re.match(WebKit::WebString(StringToLowerASCII(field->label()))) != -1) {
      return true;
    }
  } else {
    // For now, we apply the same pattern to the field's label and the field's
    // name.  Matching the name is a bit of a long shot for many patterns, but
    // it generally doesn't hurt to try.
    //
    // TODO(jhawkins): Remove StringToLowerASCII.  WebRegularExpression needs to
    // be fixed to take WebTextCaseInsensitive into account.
    if (re.match(WebKit::WebString(StringToLowerASCII(field->label()))) != -1 ||
        re.match(WebKit::WebString(StringToLowerASCII(field->name()))) != -1) {
      return true;
    }
  }

  return false;
}

// static
FormField* FormField::ParseFormField(
    std::vector<AutoFillField*>::const_iterator* iter,
    bool is_ecml) {
  FormField *field;
  field = EmailField::Parse(iter, is_ecml);
  if (field != NULL)
    return field;
  field = PhoneField::Parse(iter, is_ecml);
  if (field != NULL)
    return field;
  field = AddressField::Parse(iter, is_ecml);
  if (field != NULL)
    return field;
  field = CreditCardField::Parse(iter, is_ecml);
  if (field != NULL)
    return field;

  // We search for a NameField last since it matches the word "name", which is
  // relatively general.
  return NameField::Parse(iter, is_ecml);
}

// static
bool FormField::ParseText(std::vector<AutoFillField*>::const_iterator* iter,
                          const string16& pattern) {
  AutoFillField* field;
  return ParseText(iter, pattern, &field);
}

// static
bool FormField::ParseText(std::vector<AutoFillField*>::const_iterator* iter,
                          const string16& pattern,
                          AutoFillField** dest) {
  return ParseText(iter, pattern, dest, false);
}

// static
bool FormField::ParseLabelText(
    std::vector<AutoFillField*>::const_iterator* iter,
    const string16& pattern,
    AutoFillField** dest) {
  return ParseText(iter, pattern, dest, true);
}

// static
bool FormField::ParseText(std::vector<AutoFillField*>::const_iterator* iter,
                          const string16& pattern,
                          AutoFillField** dest,
                          bool match_label_only) {
  AutoFillField* field = **iter;
  if (!field)
    return false;

  if (Match(field, pattern, match_label_only)) {
    *dest = field;
    (*iter)++;
    return true;
  }

  return false;
}

// static
bool FormField::ParseEmpty(std::vector<AutoFillField*>::const_iterator* iter) {
  // TODO(jhawkins): Handle select fields.
  return ParseText(iter, ASCIIToUTF16("^$"));
}

// static
bool FormField::Add(FieldTypeMap* field_type_map, AutoFillField* field,
               const AutoFillType& type) {
  // Several fields are optional.
  if (field)
    field_type_map->insert(make_pair(field->unique_name(), type.field_type()));

  return true;
}

string16 FormField::GetEcmlPattern(const string16& ecml_name) {
  return ASCIIToUTF16("^") + ecml_name;
}

string16 FormField::GetEcmlPattern(const string16& ecml_name1,
                                   const string16& ecml_name2,
                                   string16::value_type pattern_operator) {
  string16 begins_with = ASCIIToUTF16("^");
  return begins_with + ecml_name1 + pattern_operator + begins_with + ecml_name2;
}

FormFieldSet::FormFieldSet(FormStructure* fields) {
  std::vector<AddressField*> addresses;

  // First, find if there is one form field with an ECML name.  If there is,
  // then we will match an element only if it is in the standard.
  bool is_ecml = CheckECML(fields);

  // Parse fields.
  std::vector<AutoFillField*>::const_iterator field = fields->begin();
  while (field != fields->end() && *field != NULL) {
    FormField* form_field = FormField::ParseFormField(&field, is_ecml);
    if (!form_field) {
      field++;
      continue;
    }

    push_back(form_field);

    if (form_field->GetFormFieldType() == kAddressType) {
      AddressField* address = static_cast<AddressField*>(form_field);
      if (address->IsFullAddress())
        addresses.push_back(address);
    }
  }

  // Now determine an address type for each address. Note, if this is an ECML
  // form, then we already got this info from the field names.
  if (!is_ecml && !addresses.empty()) {
    if (addresses.size() == 1) {
      addresses[0]->SetType(addresses[0]->FindType());
    } else {
      AddressType type0 = addresses[0]->FindType();
      AddressType type1 = addresses[1]->FindType();

      // When there are two addresses on a page, they almost always appear in
      // the order (billing, shipping).
      bool reversed = (type0 == kShippingAddress && type1 == kBillingAddress);
      addresses[0]->SetType(reversed ? kShippingAddress : kBillingAddress);
      addresses[1]->SetType(reversed ? kBillingAddress : kShippingAddress);
    }
  }
}

bool FormFieldSet::CheckECML(FormStructure* fields) {
  size_t num_fields = fields->field_count();
  for (size_t index = 0; index < num_fields; ++index) {
    string16 name(fields->field(index)->name());
    if (name.substr(0, 4) == ASCIIToUTF16("ecom") &&
        (StartsWith(name, kEcmlShipToTitle, false) ||
         StartsWith(name, kEcmlShipToFirstName, false) ||
         StartsWith(name, kEcmlShipToMiddleName, false) ||
         StartsWith(name, kEcmlShipToLastName, false) ||
         StartsWith(name, kEcmlShipToNameSuffix, false) ||
         StartsWith(name, kEcmlShipToCompanyName, false) ||
         StartsWith(name, kEcmlShipToAddress1, false) ||
         StartsWith(name, kEcmlShipToAddress2, false) ||
         StartsWith(name, kEcmlShipToAddress3, false) ||
         StartsWith(name, kEcmlShipToCity, false) ||
         StartsWith(name, kEcmlShipToStateProv, false) ||
         StartsWith(name, kEcmlShipToPostalCode, false) ||
         StartsWith(name, kEcmlShipToCountry, false) ||
         StartsWith(name, kEcmlShipToPhone, false) ||
         StartsWith(name, kEcmlShipToPhone, false) ||
         StartsWith(name, kEcmlShipToEmail, false) ||
         StartsWith(name, kEcmlBillToTitle, false) ||
         StartsWith(name, kEcmlBillToFirstName, false) ||
         StartsWith(name, kEcmlBillToMiddleName, false) ||
         StartsWith(name, kEcmlBillToLastName, false) ||
         StartsWith(name, kEcmlBillToNameSuffix, false) ||
         StartsWith(name, kEcmlBillToCompanyName, false) ||
         StartsWith(name, kEcmlBillToAddress1, false) ||
         StartsWith(name, kEcmlBillToAddress2, false) ||
         StartsWith(name, kEcmlBillToAddress3, false) ||
         StartsWith(name, kEcmlBillToCity, false) ||
         StartsWith(name, kEcmlBillToStateProv, false) ||
         StartsWith(name, kEcmlBillToPostalCode, false) ||
         StartsWith(name, kEcmlBillToCountry, false) ||
         StartsWith(name, kEcmlBillToPhone, false) ||
         StartsWith(name, kEcmlBillToPhone, false) ||
         StartsWith(name, kEcmlBillToEmail, false) ||
         StartsWith(name, kEcmlCardHolder, false) ||
         StartsWith(name, kEcmlCardType, false) ||
         StartsWith(name, kEcmlCardNumber, false) ||
         StartsWith(name, kEcmlCardVerification, false) ||
         StartsWith(name, kEcmlCardExpireMonth, false) ||
         StartsWith(name, kEcmlCardExpireYear, false))) {
      return true;
    }
  }
  return false;
}