2011-02-10 Nate Chapin <japhet@chromium.org>
[WebKit-https.git] / Source / WebKit / chromium / src / WebSearchableFormData.cpp
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #include "WebSearchableFormData.h"
33
34 #include "Document.h"
35 #include "FormDataBuilder.h"
36 #include "FormDataList.h"
37 #include "Frame.h"
38 #include "HTMLFormControlElement.h"
39 #include "HTMLFormElement.h"
40 #include "HTMLInputElement.h"
41 #include "HTMLNames.h"
42 #include "HTMLOptionElement.h"
43 #include "HTMLOptionsCollection.h"
44 #include "HTMLSelectElement.h"
45 #include "TextEncoding.h"
46 #include "WebFormElement.h"
47
48 using namespace WebCore;
49 using namespace HTMLNames;
50
51 namespace {
52
53 // Gets the encoding for the form.
54 void GetFormEncoding(const HTMLFormElement* form, TextEncoding* encoding)
55 {
56     String str(form->getAttribute(HTMLNames::accept_charsetAttr));
57     str.replace(',', ' ');
58     Vector<String> charsets;
59     str.split(' ', charsets);
60     for (Vector<String>::const_iterator i(charsets.begin()); i != charsets.end(); ++i) {
61         *encoding = TextEncoding(*i);
62         if (encoding->isValid())
63             return;
64     }
65     *encoding = TextEncoding(form->document()->loader()->writer()->encoding());
66 }
67
68 // Returns true if the submit request results in an HTTP URL.
69 bool IsHTTPFormSubmit(const HTMLFormElement* form)
70 {
71     String action(form->action());
72     return form->document()->frame()->loader()->completeURL(action.isNull() ? "" : action).protocol() == "http";
73 }
74
75 // If the form does not have an activated submit button, the first submit
76 // button is returned.
77 HTMLFormControlElement* GetButtonToActivate(HTMLFormElement* form)
78 {
79     HTMLFormControlElement* firstSubmitButton = 0;
80     // FIXME: Consider refactoring this code so that we don't call form->associatedElements() twice.
81     for (Vector<FormAssociatedElement*>::const_iterator i(form->associatedElements().begin()); i != form->associatedElements().end(); ++i) {
82       if (!(*i)->isFormControlElement())
83           continue;
84       HTMLFormControlElement* formElement = static_cast<HTMLFormControlElement*>(*i);
85       if (formElement->isActivatedSubmit())
86           // There's a button that is already activated for submit, return 0.
87           return 0;
88       if (!firstSubmitButton && formElement->isSuccessfulSubmitButton())
89           firstSubmitButton = formElement;
90     }
91     return firstSubmitButton;
92 }
93
94 // Returns true if the selected state of all the options matches the default
95 // selected state.
96 bool IsSelectInDefaultState(const HTMLSelectElement* select)
97 {
98     const Vector<Element*>& listItems = select->listItems();
99     if (select->multiple() || select->size() > 1) {
100         for (Vector<Element*>::const_iterator i(listItems.begin()); i != listItems.end(); ++i) {
101             if (!(*i)->hasLocalName(HTMLNames::optionTag))
102                 continue;
103             const HTMLOptionElement* optionElement = static_cast<const HTMLOptionElement*>(*i);
104             if (optionElement->selected() != optionElement->defaultSelected())
105                 return false;
106         }
107         return true;
108     }
109
110     // The select is rendered as a combobox (called menulist in WebKit). At
111     // least one item is selected, determine which one.
112     const HTMLOptionElement* initialSelected = 0;
113     for (Vector<Element*>::const_iterator i(listItems.begin()); i != listItems.end(); ++i) {
114         if (!(*i)->hasLocalName(HTMLNames::optionTag))
115             continue;
116         const HTMLOptionElement* optionElement = static_cast<const HTMLOptionElement*>(*i);
117         if (optionElement->defaultSelected()) {
118             // The page specified the option to select.
119             initialSelected = optionElement;
120             break;
121         }
122         if (!initialSelected)
123             initialSelected = optionElement;
124     }
125     return initialSelected ? initialSelected->selected() : true;
126 }
127
128 // Returns true if the form element is in its default state, false otherwise.
129 // The default state is the state of the form element on initial load of the
130 // page, and varies depending upon the form element. For example, a checkbox is
131 // in its default state if the checked state matches the state of the checked attribute.
132 bool IsInDefaultState(const HTMLFormControlElement* formElement)
133 {
134     if (formElement->hasTagName(HTMLNames::inputTag)) {
135         const HTMLInputElement* inputElement = static_cast<const HTMLInputElement*>(formElement);
136         if (inputElement->isCheckbox() || inputElement->isRadioButton())
137             return inputElement->checked() == inputElement->hasAttribute(checkedAttr);
138     } else if (formElement->hasTagName(HTMLNames::selectTag))
139         return IsSelectInDefaultState(static_cast<const HTMLSelectElement*>(formElement));
140     return true;
141 }
142
143 // If form has only one text input element, return true. If a valid input
144 // element is not found, return false. Additionally, the form data for all
145 // elements is added to enc_string and the encoding used is set in
146 // encoding_name.
147 bool HasSuitableTextElement(const HTMLFormElement* form, Vector<char>* encodedString, String* encodingName)
148 {
149     TextEncoding encoding;
150     GetFormEncoding(form, &encoding);
151     if (!encoding.isValid()) {
152         // Need a valid encoding to encode the form elements.
153         // If the encoding isn't found webkit ends up replacing the params with
154         // empty strings. So, we don't try to do anything here.
155         return 0;
156     }
157     *encodingName = encoding.name();
158
159     HTMLInputElement* textElement = 0;
160     // FIXME: Consider refactoring this code so that we don't call form->associatedElements() twice.
161     for (Vector<FormAssociatedElement*>::const_iterator i(form->associatedElements().begin()); i != form->associatedElements().end(); ++i) {
162         if (!(*i)->isFormControlElement())
163             continue;
164         HTMLFormControlElement* formElement = static_cast<HTMLFormControlElement*>(*i);
165         if (formElement->disabled() || formElement->name().isNull())
166             continue;
167
168         if (!IsInDefaultState(formElement) || formElement->hasTagName(HTMLNames::textareaTag))
169             return 0;
170
171         bool isTextElement = false;
172         if (formElement->hasTagName(HTMLNames::inputTag)) {
173             const HTMLInputElement* input = static_cast<const HTMLInputElement*>(formElement);
174             if (input->isFileUpload()) {
175                 // Too big, don't try to index this.
176                 return 0;
177             }
178
179             if (input->isPasswordField()) {
180                 // Don't store passwords! This is most likely an https anyway.
181                 return 0;
182             }
183
184             if (input->isTextField())
185                 isTextElement = true;
186       }
187
188       FormDataList dataList(encoding);
189       if (!formElement->appendFormData(dataList, false))
190           continue;
191
192       const Vector<FormDataList::Item>& items = dataList.items();
193       if (isTextElement && !items.isEmpty()) {
194           if (textElement) {
195               // The auto-complete bar only knows how to fill in one value.
196               // This form has multiple fields; don't treat it as searchable.
197               return false;
198           }
199           textElement = static_cast<HTMLInputElement*>(formElement);
200       }
201       for (Vector<FormDataList::Item>::const_iterator j(items.begin()); j != items.end(); ++j) {
202           // Handle ISINDEX / <input name=isindex> specially, but only if it's
203           // the first entry.
204           if (!encodedString->isEmpty() || j->data() != "isindex") {
205               if (!encodedString->isEmpty())
206                   encodedString->append('&');
207               FormDataBuilder::encodeStringAsFormData(*encodedString, j->data());
208               encodedString->append('=');
209           }
210           ++j;
211           if (formElement == textElement)
212               encodedString->append("{searchTerms}", 13);
213           else
214               FormDataBuilder::encodeStringAsFormData(*encodedString, j->data());
215       }
216     }
217
218     return textElement;
219 }
220
221 } // namespace
222
223 namespace WebKit {
224
225 WebSearchableFormData::WebSearchableFormData(const WebFormElement& form)
226 {
227     RefPtr<HTMLFormElement> formElement = form.operator PassRefPtr<HTMLFormElement>();
228     const Frame* frame = formElement->document()->frame();
229     if (!frame)
230         return;
231
232     // Only consider forms that GET data and the action targets an http page.
233     if (equalIgnoringCase(formElement->getAttribute(HTMLNames::methodAttr), "post") || !IsHTTPFormSubmit(formElement.get()))
234         return;
235
236     HTMLFormControlElement* firstSubmitButton = GetButtonToActivate(formElement.get());
237     if (firstSubmitButton) {
238         // The form does not have an active submit button, make the first button
239         // active. We need to do this, otherwise the URL will not contain the
240         // name of the submit button.
241         firstSubmitButton->setActivatedSubmit(true);
242     }
243     Vector<char> encodedString;
244     String encoding;
245     bool hasElement = HasSuitableTextElement(formElement.get(), &encodedString, &encoding);
246     if (firstSubmitButton)
247         firstSubmitButton->setActivatedSubmit(false);
248     if (!hasElement) {
249         // Not a searchable form.
250         return;
251     }
252
253     String action(formElement->action());
254     KURL url(frame->loader()->completeURL(action.isNull() ? "" : action));
255     RefPtr<FormData> formData = FormData::create(encodedString);
256     url.setQuery(formData->flattenToString());
257     m_url = url;
258     m_encoding = encoding;
259 }
260
261 } // namespace WebKit