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.
5 #include "components/autofill/content/renderer/form_autofill_util.h"
9 #include "base/command_line.h"
10 #include "base/logging.h"
11 #include "base/memory/scoped_vector.h"
12 #include "base/metrics/field_trial.h"
13 #include "base/strings/string_util.h"
14 #include "base/strings/utf_string_conversions.h"
15 #include "components/autofill/core/common/autofill_data_validation.h"
16 #include "components/autofill/core/common/autofill_switches.h"
17 #include "components/autofill/core/common/form_data.h"
18 #include "components/autofill/core/common/form_field_data.h"
19 #include "components/autofill/core/common/web_element_descriptor.h"
20 #include "third_party/WebKit/public/platform/WebString.h"
21 #include "third_party/WebKit/public/platform/WebVector.h"
22 #include "third_party/WebKit/public/web/WebDocument.h"
23 #include "third_party/WebKit/public/web/WebElement.h"
24 #include "third_party/WebKit/public/web/WebElementCollection.h"
25 #include "third_party/WebKit/public/web/WebExceptionCode.h"
26 #include "third_party/WebKit/public/web/WebFormControlElement.h"
27 #include "third_party/WebKit/public/web/WebFormElement.h"
28 #include "third_party/WebKit/public/web/WebInputElement.h"
29 #include "third_party/WebKit/public/web/WebLabelElement.h"
30 #include "third_party/WebKit/public/web/WebLocalFrame.h"
31 #include "third_party/WebKit/public/web/WebNode.h"
32 #include "third_party/WebKit/public/web/WebNodeList.h"
33 #include "third_party/WebKit/public/web/WebOptionElement.h"
34 #include "third_party/WebKit/public/web/WebSelectElement.h"
35 #include "third_party/WebKit/public/web/WebTextAreaElement.h"
37 using blink::WebDocument;
38 using blink::WebElement;
39 using blink::WebElementCollection;
40 using blink::WebExceptionCode;
41 using blink::WebFormControlElement;
42 using blink::WebFormElement;
43 using blink::WebFrame;
44 using blink::WebInputElement;
45 using blink::WebLabelElement;
47 using blink::WebNodeList;
48 using blink::WebOptionElement;
49 using blink::WebSelectElement;
50 using blink::WebTextAreaElement;
51 using blink::WebString;
52 using blink::WebVector;
57 // A bit field mask for FillForm functions to not fill some fields.
58 enum FieldFilterMask {
60 FILTER_DISABLED_ELEMENTS = 1 << 0,
61 FILTER_READONLY_ELEMENTS = 1 << 1,
62 FILTER_NON_FOCUSABLE_ELEMENTS = 1 << 2,
63 FILTER_ALL_NON_EDITIABLE_ELEMENTS = FILTER_DISABLED_ELEMENTS |
64 FILTER_READONLY_ELEMENTS |
65 FILTER_NON_FOCUSABLE_ELEMENTS,
68 bool IsOptionElement(const WebElement& element) {
69 CR_DEFINE_STATIC_LOCAL(WebString, kOption, ("option"));
70 return element.hasTagName(kOption);
73 bool IsScriptElement(const WebElement& element) {
74 CR_DEFINE_STATIC_LOCAL(WebString, kScript, ("script"));
75 return element.hasTagName(kScript);
78 bool IsNoScriptElement(const WebElement& element) {
79 CR_DEFINE_STATIC_LOCAL(WebString, kNoScript, ("noscript"));
80 return element.hasTagName(kNoScript);
83 bool HasTagName(const WebNode& node, const blink::WebString& tag) {
84 return node.isElementNode() && node.toConst<WebElement>().hasHTMLTagName(tag);
87 bool IsAutofillableElement(const WebFormControlElement& element) {
88 const WebInputElement* input_element = toWebInputElement(&element);
89 return IsAutofillableInputElement(input_element) ||
90 IsSelectElement(element) ||
91 IsTextAreaElement(element);
94 // Check whether the given field satisfies the REQUIRE_AUTOCOMPLETE requirement.
95 bool SatisfiesRequireAutocomplete(const WebInputElement& input_element) {
96 return input_element.autoComplete();
99 // Appends |suffix| to |prefix| so that any intermediary whitespace is collapsed
100 // to a single space. If |force_whitespace| is true, then the resulting string
101 // is guaranteed to have a space between |prefix| and |suffix|. Otherwise, the
102 // result includes a space only if |prefix| has trailing whitespace or |suffix|
103 // has leading whitespace.
105 // * CombineAndCollapseWhitespace("foo", "bar", false) -> "foobar"
106 // * CombineAndCollapseWhitespace("foo", "bar", true) -> "foo bar"
107 // * CombineAndCollapseWhitespace("foo ", "bar", false) -> "foo bar"
108 // * CombineAndCollapseWhitespace("foo", " bar", false) -> "foo bar"
109 // * CombineAndCollapseWhitespace("foo", " bar", true) -> "foo bar"
110 // * CombineAndCollapseWhitespace("foo ", " bar", false) -> "foo bar"
111 // * CombineAndCollapseWhitespace(" foo", "bar ", false) -> " foobar "
112 // * CombineAndCollapseWhitespace(" foo", "bar ", true) -> " foo bar "
113 const base::string16 CombineAndCollapseWhitespace(
114 const base::string16& prefix,
115 const base::string16& suffix,
116 bool force_whitespace) {
117 base::string16 prefix_trimmed;
118 base::TrimPositions prefix_trailing_whitespace =
119 base::TrimWhitespace(prefix, base::TRIM_TRAILING, &prefix_trimmed);
121 // Recursively compute the children's text.
122 base::string16 suffix_trimmed;
123 base::TrimPositions suffix_leading_whitespace =
124 base::TrimWhitespace(suffix, base::TRIM_LEADING, &suffix_trimmed);
126 if (prefix_trailing_whitespace || suffix_leading_whitespace ||
128 return prefix_trimmed + base::ASCIIToUTF16(" ") + suffix_trimmed;
130 return prefix_trimmed + suffix_trimmed;
134 // This is a helper function for the FindChildText() function (see below).
135 // Search depth is limited with the |depth| parameter.
136 base::string16 FindChildTextInner(const WebNode& node, int depth) {
137 if (depth <= 0 || node.isNull())
138 return base::string16();
140 // Skip over comments.
141 if (node.nodeType() == WebNode::CommentNode)
142 return FindChildTextInner(node.nextSibling(), depth - 1);
144 if (node.nodeType() != WebNode::ElementNode &&
145 node.nodeType() != WebNode::TextNode)
146 return base::string16();
148 // Ignore elements known not to contain inferable labels.
149 if (node.isElementNode()) {
150 const WebElement element = node.toConst<WebElement>();
151 if (IsOptionElement(element) ||
152 IsScriptElement(element) ||
153 IsNoScriptElement(element) ||
154 (element.isFormControlElement() &&
155 IsAutofillableElement(element.toConst<WebFormControlElement>()))) {
156 return base::string16();
160 // Extract the text exactly at this node.
161 base::string16 node_text = node.nodeValue();
163 // Recursively compute the children's text.
164 // Preserve inter-element whitespace separation.
165 base::string16 child_text = FindChildTextInner(node.firstChild(), depth - 1);
166 bool add_space = node.nodeType() == WebNode::TextNode && node_text.empty();
167 node_text = CombineAndCollapseWhitespace(node_text, child_text, add_space);
169 // Recursively compute the siblings' text.
170 // Again, preserve inter-element whitespace separation.
171 base::string16 sibling_text =
172 FindChildTextInner(node.nextSibling(), depth - 1);
173 add_space = node.nodeType() == WebNode::TextNode && node_text.empty();
174 node_text = CombineAndCollapseWhitespace(node_text, sibling_text, add_space);
179 // Returns the aggregated values of the descendants of |element| that are
180 // non-empty text nodes. This is a faster alternative to |innerText()| for
181 // performance critical operations. It does a full depth-first search so can be
182 // used when the structure is not directly known. However, unlike with
183 // |innerText()|, the search depth and breadth are limited to a fixed threshold.
184 // Whitespace is trimmed from text accumulated at descendant nodes.
185 base::string16 FindChildText(const WebNode& node) {
186 if (node.isTextNode())
187 return node.nodeValue();
189 WebNode child = node.firstChild();
191 const int kChildSearchDepth = 10;
192 base::string16 node_text = FindChildTextInner(child, kChildSearchDepth);
193 base::TrimWhitespace(node_text, base::TRIM_ALL, &node_text);
197 // Helper for |InferLabelForElement()| that infers a label, if possible, from
198 // a previous sibling of |element|,
199 // e.g. Some Text <input ...>
200 // or Some <span>Text</span> <input ...>
201 // or <p>Some Text</p><input ...>
202 // or <label>Some Text</label> <input ...>
203 // or Some Text <img><input ...>
204 // or <b>Some Text</b><br/> <input ...>.
205 base::string16 InferLabelFromPrevious(const WebFormControlElement& element) {
206 base::string16 inferred_label;
207 WebNode previous = element;
209 previous = previous.previousSibling();
210 if (previous.isNull())
213 // Skip over comments.
214 WebNode::NodeType node_type = previous.nodeType();
215 if (node_type == WebNode::CommentNode)
218 // Otherwise, only consider normal HTML elements and their contents.
219 if (node_type != WebNode::TextNode &&
220 node_type != WebNode::ElementNode)
223 // A label might be split across multiple "lightweight" nodes.
224 // Coalesce any text contained in multiple consecutive
225 // (a) plain text nodes or
226 // (b) inline HTML elements that are essentially equivalent to text nodes.
227 CR_DEFINE_STATIC_LOCAL(WebString, kBold, ("b"));
228 CR_DEFINE_STATIC_LOCAL(WebString, kStrong, ("strong"));
229 CR_DEFINE_STATIC_LOCAL(WebString, kSpan, ("span"));
230 CR_DEFINE_STATIC_LOCAL(WebString, kFont, ("font"));
231 if (previous.isTextNode() ||
232 HasTagName(previous, kBold) || HasTagName(previous, kStrong) ||
233 HasTagName(previous, kSpan) || HasTagName(previous, kFont)) {
234 base::string16 value = FindChildText(previous);
235 // A text node's value will be empty if it is for a line break.
236 bool add_space = previous.isTextNode() && value.empty();
238 CombineAndCollapseWhitespace(value, inferred_label, add_space);
242 // If we have identified a partial label and have reached a non-lightweight
243 // element, consider the label to be complete.
244 base::string16 trimmed_label;
245 base::TrimWhitespace(inferred_label, base::TRIM_ALL, &trimmed_label);
246 if (!trimmed_label.empty())
249 // <img> and <br> tags often appear between the input element and its
250 // label text, so skip over them.
251 CR_DEFINE_STATIC_LOCAL(WebString, kImage, ("img"));
252 CR_DEFINE_STATIC_LOCAL(WebString, kBreak, ("br"));
253 if (HasTagName(previous, kImage) || HasTagName(previous, kBreak))
256 // We only expect <p> and <label> tags to contain the full label text.
257 CR_DEFINE_STATIC_LOCAL(WebString, kPage, ("p"));
258 CR_DEFINE_STATIC_LOCAL(WebString, kLabel, ("label"));
259 if (HasTagName(previous, kPage) || HasTagName(previous, kLabel))
260 inferred_label = FindChildText(previous);
265 base::TrimWhitespace(inferred_label, base::TRIM_ALL, &inferred_label);
266 return inferred_label;
269 // Helper for |InferLabelForElement()| that infers a label, if possible, from
270 // enclosing list item,
271 // e.g. <li>Some Text<input ...><input ...><input ...></tr>
272 base::string16 InferLabelFromListItem(const WebFormControlElement& element) {
273 WebNode parent = element.parentNode();
274 CR_DEFINE_STATIC_LOCAL(WebString, kListItem, ("li"));
275 while (!parent.isNull() && parent.isElementNode() &&
276 !parent.to<WebElement>().hasTagName(kListItem)) {
277 parent = parent.parentNode();
280 if (!parent.isNull() && HasTagName(parent, kListItem))
281 return FindChildText(parent);
283 return base::string16();
286 // Helper for |InferLabelForElement()| that infers a label, if possible, from
287 // surrounding table structure,
288 // e.g. <tr><td>Some Text</td><td><input ...></td></tr>
289 // or <tr><th>Some Text</th><td><input ...></td></tr>
290 // or <tr><td><b>Some Text</b></td><td><b><input ...></b></td></tr>
291 // or <tr><th><b>Some Text</b></th><td><b><input ...></b></td></tr>
292 base::string16 InferLabelFromTableColumn(const WebFormControlElement& element) {
293 CR_DEFINE_STATIC_LOCAL(WebString, kTableCell, ("td"));
294 WebNode parent = element.parentNode();
295 while (!parent.isNull() && parent.isElementNode() &&
296 !parent.to<WebElement>().hasTagName(kTableCell)) {
297 parent = parent.parentNode();
301 return base::string16();
303 // Check all previous siblings, skipping non-element nodes, until we find a
304 // non-empty text block.
305 base::string16 inferred_label;
306 WebNode previous = parent.previousSibling();
307 CR_DEFINE_STATIC_LOCAL(WebString, kTableHeader, ("th"));
308 while (inferred_label.empty() && !previous.isNull()) {
309 if (HasTagName(previous, kTableCell) || HasTagName(previous, kTableHeader))
310 inferred_label = FindChildText(previous);
312 previous = previous.previousSibling();
315 return inferred_label;
318 // Helper for |InferLabelForElement()| that infers a label, if possible, from
319 // surrounding table structure,
320 // e.g. <tr><td>Some Text</td></tr><tr><td><input ...></td></tr>
321 base::string16 InferLabelFromTableRow(const WebFormControlElement& element) {
322 CR_DEFINE_STATIC_LOCAL(WebString, kTableRow, ("tr"));
323 WebNode parent = element.parentNode();
324 while (!parent.isNull() && parent.isElementNode() &&
325 !parent.to<WebElement>().hasTagName(kTableRow)) {
326 parent = parent.parentNode();
330 return base::string16();
332 // Check all previous siblings, skipping non-element nodes, until we find a
333 // non-empty text block.
334 base::string16 inferred_label;
335 WebNode previous = parent.previousSibling();
336 while (inferred_label.empty() && !previous.isNull()) {
337 if (HasTagName(previous, kTableRow))
338 inferred_label = FindChildText(previous);
340 previous = previous.previousSibling();
343 return inferred_label;
346 // Helper for |InferLabelForElement()| that infers a label, if possible, from
347 // a surrounding div table,
348 // e.g. <div>Some Text<span><input ...></span></div>
349 // e.g. <div>Some Text</div><div><input ...></div>
350 base::string16 InferLabelFromDivTable(const WebFormControlElement& element) {
351 WebNode node = element.parentNode();
352 bool looking_for_parent = true;
354 // Search the sibling and parent <div>s until we find a candidate label.
355 base::string16 inferred_label;
356 CR_DEFINE_STATIC_LOCAL(WebString, kDiv, ("div"));
357 CR_DEFINE_STATIC_LOCAL(WebString, kTable, ("table"));
358 CR_DEFINE_STATIC_LOCAL(WebString, kFieldSet, ("fieldset"));
359 while (inferred_label.empty() && !node.isNull()) {
360 if (HasTagName(node, kDiv)) {
361 looking_for_parent = false;
362 inferred_label = FindChildText(node);
363 } else if (looking_for_parent &&
364 (HasTagName(node, kTable) || HasTagName(node, kFieldSet))) {
365 // If the element is in a table or fieldset, its label most likely is too.
369 if (node.previousSibling().isNull()) {
370 // If there are no more siblings, continue walking up the tree.
371 looking_for_parent = true;
374 if (looking_for_parent)
375 node = node.parentNode();
377 node = node.previousSibling();
380 return inferred_label;
383 // Helper for |InferLabelForElement()| that infers a label, if possible, from
384 // a surrounding definition list,
385 // e.g. <dl><dt>Some Text</dt><dd><input ...></dd></dl>
386 // e.g. <dl><dt><b>Some Text</b></dt><dd><b><input ...></b></dd></dl>
387 base::string16 InferLabelFromDefinitionList(
388 const WebFormControlElement& element) {
389 CR_DEFINE_STATIC_LOCAL(WebString, kDefinitionData, ("dd"));
390 WebNode parent = element.parentNode();
391 while (!parent.isNull() && parent.isElementNode() &&
392 !parent.to<WebElement>().hasTagName(kDefinitionData))
393 parent = parent.parentNode();
395 if (parent.isNull() || !HasTagName(parent, kDefinitionData))
396 return base::string16();
398 // Skip by any intervening text nodes.
399 WebNode previous = parent.previousSibling();
400 while (!previous.isNull() && previous.isTextNode())
401 previous = previous.previousSibling();
403 CR_DEFINE_STATIC_LOCAL(WebString, kDefinitionTag, ("dt"));
404 if (previous.isNull() || !HasTagName(previous, kDefinitionTag))
405 return base::string16();
407 return FindChildText(previous);
410 // Infers corresponding label for |element| from surrounding context in the DOM,
411 // e.g. the contents of the preceding <p> tag or text element.
412 base::string16 InferLabelForElement(const WebFormControlElement& element) {
413 base::string16 inferred_label = InferLabelFromPrevious(element);
414 if (!inferred_label.empty())
415 return inferred_label;
417 // If we didn't find a label, check for list item case.
418 inferred_label = InferLabelFromListItem(element);
419 if (!inferred_label.empty())
420 return inferred_label;
422 // If we didn't find a label, check for table cell case.
423 inferred_label = InferLabelFromTableColumn(element);
424 if (!inferred_label.empty())
425 return inferred_label;
427 // If we didn't find a label, check for table row case.
428 inferred_label = InferLabelFromTableRow(element);
429 if (!inferred_label.empty())
430 return inferred_label;
432 // If we didn't find a label, check for definition list case.
433 inferred_label = InferLabelFromDefinitionList(element);
434 if (!inferred_label.empty())
435 return inferred_label;
437 // If we didn't find a label, check for div table case.
438 return InferLabelFromDivTable(element);
441 // Fills |option_strings| with the values of the <option> elements present in
443 void GetOptionStringsFromElement(const WebSelectElement& select_element,
444 std::vector<base::string16>* option_values,
445 std::vector<base::string16>* option_contents) {
446 DCHECK(!select_element.isNull());
448 option_values->clear();
449 option_contents->clear();
450 WebVector<WebElement> list_items = select_element.listItems();
452 // Constrain the maximum list length to prevent a malicious site from DOS'ing
453 // the browser, without entirely breaking autocomplete for some extreme
454 // legitimate sites: http://crbug.com/49332 and http://crbug.com/363094
455 if (list_items.size() > kMaxListSize)
458 option_values->reserve(list_items.size());
459 option_contents->reserve(list_items.size());
460 for (size_t i = 0; i < list_items.size(); ++i) {
461 if (IsOptionElement(list_items[i])) {
462 const WebOptionElement option = list_items[i].toConst<WebOptionElement>();
463 option_values->push_back(option.value());
464 option_contents->push_back(option.text());
469 // The callback type used by |ForEachMatchingFormField()|.
470 typedef void (*Callback)(const FormFieldData&,
471 bool, /* is_initiating_element */
472 blink::WebFormControlElement*);
474 // For each autofillable field in |data| that matches a field in the |form|,
475 // the |callback| is invoked with the corresponding |form| field data.
476 void ForEachMatchingFormField(const WebFormElement& form_element,
477 const WebElement& initiating_element,
478 const FormData& data,
479 FieldFilterMask filters,
482 std::vector<WebFormControlElement> control_elements;
483 ExtractAutofillableElements(form_element, REQUIRE_AUTOCOMPLETE,
486 if (control_elements.size() != data.fields.size()) {
487 // This case should be reachable only for pathological websites and tests,
488 // which add or remove form fields while the user is interacting with the
493 // It's possible that the site has injected fields into the form after the
494 // page has loaded, so we can't assert that the size of the cached control
495 // elements is equal to the size of the fields in |form|. Fortunately, the
496 // one case in the wild where this happens, paypal.com signup form, the fields
497 // are appended to the end of the form and are not visible.
498 for (size_t i = 0; i < control_elements.size(); ++i) {
499 WebFormControlElement* element = &control_elements[i];
501 if (base::string16(element->nameForAutofill()) != data.fields[i].name) {
502 // This case should be reachable only for pathological websites, which
503 // rename form fields while the user is interacting with the Autofill
504 // popup. I (isherman) am not aware of any such websites, and so am
505 // optimistically including a NOTREACHED(). If you ever trip this check,
506 // please file a bug against me.
511 bool is_initiating_element = (*element == initiating_element);
513 // Only autofill empty fields and the field that initiated the filling,
514 // i.e. the field the user is currently editing and interacting with.
515 const WebInputElement* input_element = toWebInputElement(element);
516 if (!force_override && !is_initiating_element &&
517 ((IsAutofillableInputElement(input_element) ||
518 IsTextAreaElement(*element)) &&
519 !element->value().isEmpty()))
522 if (((filters & FILTER_DISABLED_ELEMENTS) && !element->isEnabled()) ||
523 ((filters & FILTER_READONLY_ELEMENTS) && element->isReadOnly()) ||
524 ((filters & FILTER_NON_FOCUSABLE_ELEMENTS) && !element->isFocusable()))
527 callback(data.fields[i], is_initiating_element, element);
531 // Sets the |field|'s value to the value in |data|.
532 // Also sets the "autofilled" attribute, causing the background to be yellow.
533 void FillFormField(const FormFieldData& data,
534 bool is_initiating_node,
535 blink::WebFormControlElement* field) {
537 if (data.value.empty())
540 field->setAutofilled(true);
542 WebInputElement* input_element = toWebInputElement(field);
543 if (IsCheckableElement(input_element)) {
544 input_element->setChecked(data.is_checked, true);
546 base::string16 value = data.value;
547 if (IsTextInput(input_element) || IsMonthInput(input_element)) {
548 // If the maxlength attribute contains a negative value, maxLength()
549 // returns the default maxlength value.
550 value = value.substr(0, input_element->maxLength());
552 field->setValue(value, true);
555 if (is_initiating_node &&
556 ((IsTextInput(input_element) || IsMonthInput(input_element)) ||
557 IsTextAreaElement(*field))) {
558 int length = field->value().length();
559 field->setSelectionRange(length, length);
560 // Clear the current IME composition (the underline), if there is one.
561 field->document().frame()->unmarkText();
565 // Sets the |field|'s "suggested" (non JS visible) value to the value in |data|.
566 // Also sets the "autofilled" attribute, causing the background to be yellow.
567 void PreviewFormField(const FormFieldData& data,
568 bool is_initiating_node,
569 blink::WebFormControlElement* field) {
570 // Nothing to preview.
571 if (data.value.empty())
574 // Preview input, textarea and select fields. For input fields, excludes
575 // checkboxes and radio buttons, as there is no provision for
576 // setSuggestedCheckedValue in WebInputElement.
577 WebInputElement* input_element = toWebInputElement(field);
578 if (IsTextInput(input_element) || IsMonthInput(input_element)) {
579 // If the maxlength attribute contains a negative value, maxLength()
580 // returns the default maxlength value.
581 input_element->setSuggestedValue(
582 data.value.substr(0, input_element->maxLength()));
583 input_element->setAutofilled(true);
584 } else if (IsTextAreaElement(*field) || IsSelectElement(*field)) {
585 field->setSuggestedValue(data.value);
586 field->setAutofilled(true);
589 if (is_initiating_node &&
590 (IsTextInput(input_element) || IsTextAreaElement(*field))) {
591 // Select the part of the text that the user didn't type.
592 int start = field->value().length();
593 int end = field->suggestedValue().length();
594 field->setSelectionRange(start, end);
598 std::string RetrievalMethodToString(
599 const WebElementDescriptor::RetrievalMethod& method) {
601 case WebElementDescriptor::CSS_SELECTOR:
602 return "CSS_SELECTOR";
603 case WebElementDescriptor::ID:
605 case WebElementDescriptor::NONE:
612 // Recursively checks whether |node| or any of its children have a non-empty
613 // bounding box. The recursion depth is bounded by |depth|.
614 bool IsWebNodeVisibleImpl(const blink::WebNode& node, const int depth) {
617 if (node.hasNonEmptyBoundingBox())
620 // The childNodes method is not a const method. Therefore it cannot be called
621 // on a const reference. Therefore we need a const cast.
622 const blink::WebNodeList& children =
623 const_cast<blink::WebNode&>(node).childNodes();
624 size_t length = children.length();
625 for (size_t i = 0; i < length; ++i) {
626 const blink::WebNode& item = children.item(i);
627 if (IsWebNodeVisibleImpl(item, depth - 1))
635 const size_t kMaxParseableFields = 200;
637 bool IsMonthInput(const WebInputElement* element) {
638 CR_DEFINE_STATIC_LOCAL(WebString, kMonth, ("month"));
639 return element && element->formControlType() == kMonth;
642 // All text fields, including password fields, should be extracted.
643 bool IsTextInput(const WebInputElement* element) {
644 return element && element->isTextField();
647 bool IsSelectElement(const WebFormControlElement& element) {
648 // Static for improved performance.
649 CR_DEFINE_STATIC_LOCAL(WebString, kSelectOne, ("select-one"));
650 return element.formControlType() == kSelectOne;
653 bool IsTextAreaElement(const WebFormControlElement& element) {
654 // Static for improved performance.
655 CR_DEFINE_STATIC_LOCAL(WebString, kTextArea, ("textarea"));
656 return element.formControlType() == kTextArea;
659 bool IsCheckableElement(const WebInputElement* element) {
663 return element->isCheckbox() || element->isRadioButton();
666 bool IsAutofillableInputElement(const WebInputElement* element) {
667 return IsTextInput(element) ||
668 IsMonthInput(element) ||
669 IsCheckableElement(element);
672 const base::string16 GetFormIdentifier(const WebFormElement& form) {
673 base::string16 identifier = form.name();
674 CR_DEFINE_STATIC_LOCAL(WebString, kId, ("id"));
675 if (identifier.empty())
676 identifier = form.getAttribute(kId);
681 bool IsWebNodeVisible(const blink::WebNode& node) {
682 // In the bug http://crbug.com/237216 the form's bounding box is empty
683 // however the form has non empty children. Thus we need to look at the
685 int kNodeSearchDepth = 2;
686 return IsWebNodeVisibleImpl(node, kNodeSearchDepth);
689 bool ClickElement(const WebDocument& document,
690 const WebElementDescriptor& element_descriptor) {
691 WebString web_descriptor = WebString::fromUTF8(element_descriptor.descriptor);
692 blink::WebElement element;
694 switch (element_descriptor.retrieval_method) {
695 case WebElementDescriptor::CSS_SELECTOR: {
696 WebExceptionCode ec = 0;
697 element = document.querySelector(web_descriptor, ec);
699 DVLOG(1) << "Query selector failed. Error code: " << ec << ".";
702 case WebElementDescriptor::ID:
703 element = document.getElementById(web_descriptor);
705 case WebElementDescriptor::NONE:
709 if (element.isNull()) {
710 DVLOG(1) << "Could not find "
711 << element_descriptor.descriptor
713 << RetrievalMethodToString(element_descriptor.retrieval_method)
718 element.simulateClick();
722 // Fills |autofillable_elements| with all the auto-fillable form control
723 // elements in |form_element|.
724 void ExtractAutofillableElements(
725 const WebFormElement& form_element,
726 RequirementsMask requirements,
727 std::vector<WebFormControlElement>* autofillable_elements) {
728 WebVector<WebFormControlElement> control_elements;
729 form_element.getFormControlElements(control_elements);
731 autofillable_elements->clear();
732 for (size_t i = 0; i < control_elements.size(); ++i) {
733 WebFormControlElement element = control_elements[i];
734 if (!IsAutofillableElement(element))
737 if (requirements & REQUIRE_AUTOCOMPLETE) {
738 // TODO(isherman): WebKit currently doesn't handle the autocomplete
739 // attribute for select or textarea elements, but it probably should.
740 WebInputElement* input_element = toWebInputElement(&control_elements[i]);
741 if (IsAutofillableInputElement(input_element) &&
742 !SatisfiesRequireAutocomplete(*input_element))
746 autofillable_elements->push_back(element);
750 void WebFormControlElementToFormField(const WebFormControlElement& element,
751 ExtractMask extract_mask,
752 FormFieldData* field) {
754 DCHECK(!element.isNull());
755 CR_DEFINE_STATIC_LOCAL(WebString, kAutocomplete, ("autocomplete"));
757 // The label is not officially part of a WebFormControlElement; however, the
758 // labels for all form control elements are scraped from the DOM and set in
759 // WebFormElementToFormData.
760 field->name = element.nameForAutofill();
761 field->form_control_type = base::UTF16ToUTF8(element.formControlType());
762 field->autocomplete_attribute =
763 base::UTF16ToUTF8(element.getAttribute(kAutocomplete));
764 if (field->autocomplete_attribute.size() > kMaxDataLength) {
765 // Discard overly long attribute values to avoid DOS-ing the browser
766 // process. However, send over a default string to indicate that the
767 // attribute was present.
768 field->autocomplete_attribute = "x-max-data-length-exceeded";
771 if (!IsAutofillableElement(element))
774 const WebInputElement* input_element = toWebInputElement(&element);
775 if (IsAutofillableInputElement(input_element) ||
776 IsTextAreaElement(element)) {
777 field->is_autofilled = element.isAutofilled();
778 field->is_focusable = element.isFocusable();
779 field->should_autocomplete = element.autoComplete();
780 field->text_direction = element.directionForFormData() ==
781 "rtl" ? base::i18n::RIGHT_TO_LEFT : base::i18n::LEFT_TO_RIGHT;
784 if (IsAutofillableInputElement(input_element)) {
785 if (IsTextInput(input_element))
786 field->max_length = input_element->maxLength();
788 field->is_checkable = IsCheckableElement(input_element);
789 field->is_checked = input_element->isChecked();
790 } else if (IsTextAreaElement(element)) {
791 // Nothing more to do in this case.
792 } else if (extract_mask & EXTRACT_OPTIONS) {
793 // Set option strings on the field if available.
794 DCHECK(IsSelectElement(element));
795 const WebSelectElement select_element = element.toConst<WebSelectElement>();
796 GetOptionStringsFromElement(select_element,
797 &field->option_values,
798 &field->option_contents);
801 if (!(extract_mask & EXTRACT_VALUE))
804 base::string16 value = element.value();
806 if (IsSelectElement(element)) {
807 const WebSelectElement select_element = element.toConst<WebSelectElement>();
808 // Convert the |select_element| value to text if requested.
809 if (extract_mask & EXTRACT_OPTION_TEXT) {
810 WebVector<WebElement> list_items = select_element.listItems();
811 for (size_t i = 0; i < list_items.size(); ++i) {
812 if (IsOptionElement(list_items[i])) {
813 const WebOptionElement option_element =
814 list_items[i].toConst<WebOptionElement>();
815 if (option_element.value() == value) {
816 value = option_element.text();
824 // Constrain the maximum data length to prevent a malicious site from DOS'ing
825 // the browser: http://crbug.com/49332
826 if (value.size() > kMaxDataLength)
827 value = value.substr(0, kMaxDataLength);
829 field->value = value;
832 bool WebFormElementToFormData(
833 const blink::WebFormElement& form_element,
834 const blink::WebFormControlElement& form_control_element,
835 RequirementsMask requirements,
836 ExtractMask extract_mask,
838 FormFieldData* field) {
839 CR_DEFINE_STATIC_LOCAL(WebString, kLabel, ("label"));
840 CR_DEFINE_STATIC_LOCAL(WebString, kFor, ("for"));
841 CR_DEFINE_STATIC_LOCAL(WebString, kHidden, ("hidden"));
843 const WebFrame* frame = form_element.document().frame();
847 if (requirements & REQUIRE_AUTOCOMPLETE && !form_element.autoComplete())
850 form->name = GetFormIdentifier(form_element);
851 form->method = form_element.method();
852 form->origin = frame->document().url();
853 form->action = frame->document().completeURL(form_element.action());
854 form->user_submitted = form_element.wasUserSubmitted();
856 // If the completed URL is not valid, just use the action we get from
858 if (!form->action.is_valid())
859 form->action = GURL(form_element.action());
861 // A map from a FormFieldData's name to the FormFieldData itself.
862 std::map<base::string16, FormFieldData*> name_map;
864 // The extracted FormFields. We use pointers so we can store them in
866 ScopedVector<FormFieldData> form_fields;
868 WebVector<WebFormControlElement> control_elements;
869 form_element.getFormControlElements(control_elements);
871 // A vector of bools that indicate whether each field in the form meets the
872 // requirements and thus will be in the resulting |form|.
873 std::vector<bool> fields_extracted(control_elements.size(), false);
875 for (size_t i = 0; i < control_elements.size(); ++i) {
876 const WebFormControlElement& control_element = control_elements[i];
878 if (!IsAutofillableElement(control_element))
881 const WebInputElement* input_element = toWebInputElement(&control_element);
882 if (requirements & REQUIRE_AUTOCOMPLETE &&
883 IsAutofillableInputElement(input_element) &&
884 !SatisfiesRequireAutocomplete(*input_element))
887 // Create a new FormFieldData, fill it out and map it to the field's name.
888 FormFieldData* form_field = new FormFieldData;
889 WebFormControlElementToFormField(control_element, extract_mask, form_field);
890 form_fields.push_back(form_field);
891 // TODO(jhawkins): A label element is mapped to a form control element's id.
892 // field->name() will contain the id only if the name does not exist. Add
893 // an id() method to WebFormControlElement and use that here.
894 name_map[form_field->name] = form_field;
895 fields_extracted[i] = true;
898 // If we failed to extract any fields, give up. Also, to avoid overly
899 // expensive computation, we impose a maximum number of allowable fields.
900 if (form_fields.empty() || form_fields.size() > kMaxParseableFields)
903 // Loop through the label elements inside the form element. For each label
904 // element, get the corresponding form control element, use the form control
905 // element's name as a key into the <name, FormFieldData> map to find the
906 // previously created FormFieldData and set the FormFieldData's label to the
907 // label.firstChild().nodeValue() of the label element.
908 WebElementCollection labels = form_element.getElementsByTagName(kLabel);
909 DCHECK(!labels.isNull());
910 for (WebElement item = labels.firstItem(); !item.isNull();
911 item = labels.nextItem()) {
912 WebLabelElement label = item.to<WebLabelElement>();
913 WebFormControlElement field_element =
914 label.correspondingControl().to<WebFormControlElement>();
916 base::string16 element_name;
917 if (field_element.isNull()) {
918 // Sometimes site authors will incorrectly specify the corresponding
919 // field element's name rather than its id, so we compensate here.
920 element_name = label.getAttribute(kFor);
922 !field_element.isFormControlElement() ||
923 field_element.formControlType() == kHidden) {
926 element_name = field_element.nameForAutofill();
929 std::map<base::string16, FormFieldData*>::iterator iter =
930 name_map.find(element_name);
931 if (iter != name_map.end()) {
932 base::string16 label_text = FindChildText(label);
934 // Concatenate labels because some sites might have multiple label
936 if (!iter->second->label.empty() && !label_text.empty())
937 iter->second->label += base::ASCIIToUTF16(" ");
938 iter->second->label += label_text;
942 // Loop through the form control elements, extracting the label text from
943 // the DOM. We use the |fields_extracted| vector to make sure we assign the
944 // extracted label to the correct field, as it's possible |form_fields| will
945 // not contain all of the elements in |control_elements|.
946 for (size_t i = 0, field_idx = 0;
947 i < control_elements.size() && field_idx < form_fields.size(); ++i) {
948 // This field didn't meet the requirements, so don't try to find a label
950 if (!fields_extracted[i])
953 const WebFormControlElement& control_element = control_elements[i];
954 if (form_fields[field_idx]->label.empty())
955 form_fields[field_idx]->label = InferLabelForElement(control_element);
957 if (field && form_control_element == control_element)
958 *field = *form_fields[field_idx];
963 // Copy the created FormFields into the resulting FormData object.
964 for (ScopedVector<FormFieldData>::const_iterator iter = form_fields.begin();
965 iter != form_fields.end(); ++iter) {
966 form->fields.push_back(**iter);
972 bool FindFormAndFieldForFormControlElement(const WebFormControlElement& element,
974 FormFieldData* field,
975 RequirementsMask requirements) {
976 if (!IsAutofillableElement(element))
979 const WebFormElement form_element = element.form();
980 if (form_element.isNull())
983 ExtractMask extract_mask =
984 static_cast<ExtractMask>(EXTRACT_VALUE | EXTRACT_OPTIONS);
985 return WebFormElementToFormData(form_element,
993 void FillForm(const FormData& form, const WebFormControlElement& element) {
994 WebFormElement form_element = element.form();
995 if (form_element.isNull())
998 ForEachMatchingFormField(form_element,
1001 FILTER_ALL_NON_EDITIABLE_ELEMENTS,
1002 false, /* dont force override */
1006 void FillFormIncludingNonFocusableElements(const FormData& form_data,
1007 const WebFormElement& form_element) {
1008 if (form_element.isNull())
1011 FieldFilterMask filter_mask = static_cast<FieldFilterMask>(
1012 FILTER_DISABLED_ELEMENTS | FILTER_READONLY_ELEMENTS);
1013 ForEachMatchingFormField(form_element,
1017 true, /* force override */
1021 void FillFormForAllElements(const FormData& form_data,
1022 const WebFormElement& form_element) {
1023 if (form_element.isNull())
1026 ForEachMatchingFormField(form_element,
1030 true, /* force override */
1034 void PreviewForm(const FormData& form, const WebFormControlElement& element) {
1035 WebFormElement form_element = element.form();
1036 if (form_element.isNull())
1039 ForEachMatchingFormField(form_element,
1042 FILTER_ALL_NON_EDITIABLE_ELEMENTS,
1043 false, /* dont force override */
1047 bool ClearPreviewedFormWithElement(const WebFormControlElement& element,
1048 bool was_autofilled) {
1049 WebFormElement form_element = element.form();
1050 if (form_element.isNull())
1053 std::vector<WebFormControlElement> control_elements;
1054 ExtractAutofillableElements(form_element, REQUIRE_AUTOCOMPLETE,
1056 for (size_t i = 0; i < control_elements.size(); ++i) {
1057 // There might be unrelated elements in this form which have already been
1058 // auto-filled. For example, the user might have already filled the address
1059 // part of a form and now be dealing with the credit card section. We only
1060 // want to reset the auto-filled status for fields that were previewed.
1061 WebFormControlElement control_element = control_elements[i];
1063 // Only text input, textarea and select elements can be previewed.
1064 WebInputElement* input_element = toWebInputElement(&control_element);
1065 if (!IsTextInput(input_element) &&
1066 !IsMonthInput(input_element) &&
1067 !IsTextAreaElement(control_element) &&
1068 !IsSelectElement(control_element))
1071 // If the element is not auto-filled, we did not preview it,
1072 // so there is nothing to reset.
1073 if(!control_element.isAutofilled())
1076 if ((IsTextInput(input_element) ||
1077 IsMonthInput(input_element) ||
1078 IsTextAreaElement(control_element) ||
1079 IsSelectElement(control_element)) &&
1080 control_element.suggestedValue().isEmpty())
1083 // Clear the suggested value. For the initiating node, also restore the
1085 if (IsTextInput(input_element) || IsMonthInput(input_element) ||
1086 IsTextAreaElement(control_element)) {
1087 control_element.setSuggestedValue(WebString());
1088 bool is_initiating_node = (element == control_element);
1089 if (is_initiating_node) {
1090 control_element.setAutofilled(was_autofilled);
1091 // Clearing the suggested value in the focused node (above) can cause
1092 // selection to be lost. We force selection range to restore the text
1094 int length = control_element.value().length();
1095 control_element.setSelectionRange(length, length);
1097 control_element.setAutofilled(false);
1099 } else if (IsSelectElement(control_element)) {
1100 control_element.setSuggestedValue(WebString());
1101 control_element.setAutofilled(false);
1108 bool FormWithElementIsAutofilled(const WebInputElement& element) {
1109 WebFormElement form_element = element.form();
1110 if (form_element.isNull())
1113 std::vector<WebFormControlElement> control_elements;
1114 ExtractAutofillableElements(form_element, REQUIRE_AUTOCOMPLETE,
1116 for (size_t i = 0; i < control_elements.size(); ++i) {
1117 WebInputElement* input_element = toWebInputElement(&control_elements[i]);
1118 if (!IsAutofillableInputElement(input_element))
1121 if (input_element->isAutofilled())
1128 bool IsWebpageEmpty(const blink::WebFrame* frame) {
1129 blink::WebDocument document = frame->document();
1131 return IsWebElementEmpty(document.head()) &&
1132 IsWebElementEmpty(document.body());
1135 bool IsWebElementEmpty(const blink::WebElement& element) {
1136 // This array contains all tags which can be present in an empty page.
1137 const char* const kAllowedValue[] = {
1142 const size_t kAllowedValueLength = arraysize(kAllowedValue);
1144 if (element.isNull())
1146 // The childNodes method is not a const method. Therefore it cannot be called
1147 // on a const reference. Therefore we need a const cast.
1148 const blink::WebNodeList& children =
1149 const_cast<blink::WebElement&>(element).childNodes();
1150 for (size_t i = 0; i < children.length(); ++i) {
1151 const blink::WebNode& item = children.item(i);
1153 if (item.isTextNode() &&
1154 !base::ContainsOnlyChars(item.nodeValue().utf8(),
1155 base::kWhitespaceASCII))
1158 // We ignore all other items with names which begin with
1159 // the character # because they are not html tags.
1160 if (item.nodeName().utf8()[0] == '#')
1163 bool tag_is_allowed = false;
1164 // Test if the item name is in the kAllowedValue array
1165 for (size_t allowed_value_index = 0;
1166 allowed_value_index < kAllowedValueLength; ++allowed_value_index) {
1167 if (HasTagName(item,
1168 WebString::fromUTF8(kAllowedValue[allowed_value_index]))) {
1169 tag_is_allowed = true;
1173 if (!tag_is_allowed)
1179 gfx::RectF GetScaledBoundingBox(float scale, WebFormControlElement* element) {
1180 gfx::Rect bounding_box(element->boundsInViewportSpace());
1181 return gfx::RectF(bounding_box.x() * scale,
1182 bounding_box.y() * scale,
1183 bounding_box.width() * scale,
1184 bounding_box.height() * scale);
1187 } // namespace autofill