c385291f796df21a6581264eac3759e2a9e31d72
[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 "DocumentLoader.h"
36 #include "FormDataBuilder.h"
37 #include "FormDataList.h"
38 #include "Frame.h"
39 #include "HTMLFormControlElement.h"
40 #include "HTMLFormElement.h"
41 #include "HTMLInputElement.h"
42 #include "HTMLNames.h"
43 #include "HTMLOptionElement.h"
44 #include "HTMLOptionsCollection.h"
45 #include "HTMLSelectElement.h"
46 #include "TextEncoding.h"
47 #include "WebFormElement.h"
48 #include "WebInputElement.h"
49
50 using namespace WebCore;
51 using namespace HTMLNames;
52
53 namespace {
54
55 // Gets the encoding for the form.
56 void GetFormEncoding(const HTMLFormElement* form, TextEncoding* encoding)
57 {
58     String str(form->getAttribute(HTMLNames::accept_charsetAttr));
59     str.replace(',', ' ');
60     Vector<String> charsets;
61     str.split(' ', charsets);
62     for (Vector<String>::const_iterator i(charsets.begin()); i != charsets.end(); ++i) {
63         *encoding = TextEncoding(*i);
64         if (encoding->isValid())
65             return;
66     }
67     if (!form->document()->loader())
68          return;
69     *encoding = TextEncoding(form->document()->encoding());
70 }
71
72 // Returns true if the submit request results in an HTTP URL.
73 bool IsHTTPFormSubmit(const HTMLFormElement* form)
74 {
75     // FIXME: This function is insane. This is an overly complicated way to get this information.
76     String action(form->action());
77     // The isNull() check is trying to avoid completeURL returning KURL() when passed a null string.
78     return form->document()->completeURL(action.isNull() ? "" : action).protocolIs("http");
79 }
80
81 // If the form does not have an activated submit button, the first submit
82 // button is returned.
83 HTMLFormControlElement* GetButtonToActivate(HTMLFormElement* form)
84 {
85     HTMLFormControlElement* firstSubmitButton = 0;
86     // FIXME: Consider refactoring this code so that we don't call form->associatedElements() twice.
87     for (Vector<FormAssociatedElement*>::const_iterator i(form->associatedElements().begin()); i != form->associatedElements().end(); ++i) {
88       if (!(*i)->isFormControlElement())
89           continue;
90       HTMLFormControlElement* formElement = static_cast<HTMLFormControlElement*>(*i);
91       if (formElement->isActivatedSubmit())
92           // There's a button that is already activated for submit, return 0.
93           return 0;
94       if (!firstSubmitButton && formElement->isSuccessfulSubmitButton())
95           firstSubmitButton = formElement;
96     }
97     return firstSubmitButton;
98 }
99
100 // Returns true if the selected state of all the options matches the default
101 // selected state.
102 bool IsSelectInDefaultState(HTMLSelectElement* select)
103 {
104     const Vector<HTMLElement*>& listItems = select->listItems();
105     if (select->multiple() || select->size() > 1) {
106         for (Vector<HTMLElement*>::const_iterator i(listItems.begin()); i != listItems.end(); ++i) {
107             if (!(*i)->hasLocalName(HTMLNames::optionTag))
108                 continue;
109             HTMLOptionElement* optionElement = toHTMLOptionElement(*i);
110             if (optionElement->selected() != optionElement->hasAttribute(selectedAttr))
111                 return false;
112         }
113         return true;
114     }
115
116     // The select is rendered as a combobox (called menulist in WebKit). At
117     // least one item is selected, determine which one.
118     HTMLOptionElement* initialSelected = 0;
119     for (Vector<HTMLElement*>::const_iterator i(listItems.begin()); i != listItems.end(); ++i) {
120         if (!(*i)->hasLocalName(HTMLNames::optionTag))
121             continue;
122         HTMLOptionElement* optionElement = toHTMLOptionElement(*i);
123         if (optionElement->hasAttribute(selectedAttr)) {
124             // The page specified the option to select.
125             initialSelected = optionElement;
126             break;
127         }
128         if (!initialSelected)
129             initialSelected = optionElement;
130     }
131     return !initialSelected || initialSelected->selected();
132 }
133
134 // Returns true if the form element is in its default state, false otherwise.
135 // The default state is the state of the form element on initial load of the
136 // page, and varies depending upon the form element. For example, a checkbox is
137 // in its default state if the checked state matches the state of the checked attribute.
138 bool IsInDefaultState(HTMLFormControlElement* formElement)
139 {
140     if (formElement->hasTagName(HTMLNames::inputTag)) {
141         const HTMLInputElement* inputElement = static_cast<HTMLInputElement*>(formElement);
142         if (inputElement->isCheckbox() || inputElement->isRadioButton())
143             return inputElement->checked() == inputElement->hasAttribute(checkedAttr);
144     } else if (formElement->hasTagName(HTMLNames::selectTag))
145         return IsSelectInDefaultState(static_cast<HTMLSelectElement*>(formElement));
146     return true;
147 }
148
149 // Look for a suitable search text field in a given HTMLFormElement 
150 // Return nothing if one of those items are found:
151 //  - A text area field
152 //  - A file upload field 
153 //  - A Password field
154 //  - More than one text field
155 HTMLInputElement* findSuitableSearchInputElement(const HTMLFormElement* form)
156 {
157     HTMLInputElement* textElement = 0;
158     // FIXME: Consider refactoring this code so that we don't call form->associatedElements() twice.
159     for (Vector<FormAssociatedElement*>::const_iterator i(form->associatedElements().begin()); i != form->associatedElements().end(); ++i) {
160         if (!(*i)->isFormControlElement())
161             continue;
162
163         HTMLFormControlElement* formElement = static_cast<HTMLFormControlElement*>(*i);
164
165         if (formElement->disabled() || formElement->name().isNull())
166             continue;
167
168         if (!IsInDefaultState(formElement) || formElement->hasTagName(HTMLNames::textareaTag))
169             return 0;
170
171         if (formElement->hasTagName(HTMLNames::inputTag) && formElement->willValidate()) {
172             const HTMLInputElement* input = static_cast<const HTMLInputElement*>(formElement);
173
174             // Return nothing if a file upload field or a password field are found.
175             if (input->isFileUpload() || input->isPasswordField())
176                 return 0;
177
178             if (input->isTextField()) {
179                 if (textElement) {
180                     // The auto-complete bar only knows how to fill in one value.
181                     // This form has multiple fields; don't treat it as searchable.
182                     return 0;
183                 }
184                 textElement = static_cast<HTMLInputElement*>(formElement);
185             }
186         }
187     }
188     return textElement;
189 }
190
191 // Build a search string based on a given HTMLFormElement and HTMLInputElement
192 // 
193 // Search string output example from www.google.com:
194 // "hl=en&source=hp&biw=1085&bih=854&q={searchTerms}&btnG=Google+Search&aq=f&aqi=&aql=&oq="
195 // 
196 // Return false if the provided HTMLInputElement is not found in the form
197 bool buildSearchString(const HTMLFormElement* form, Vector<char>* encodedString, TextEncoding* encoding, const HTMLInputElement* textElement)
198 {
199     bool isElementFound = false;   
200
201     // FIXME: Consider refactoring this code so that we don't call form->associatedElements() twice.
202     for (Vector<FormAssociatedElement*>::const_iterator i(form->associatedElements().begin()); i != form->associatedElements().end(); ++i) {
203         if (!(*i)->isFormControlElement())
204             continue;
205
206         HTMLFormControlElement* formElement = static_cast<HTMLFormControlElement*>(*i);
207
208         if (formElement->disabled() || formElement->name().isNull())
209             continue;
210
211         FormDataList dataList(*encoding);
212         if (!formElement->appendFormData(dataList, false))
213             continue;
214
215         const Vector<FormDataList::Item>& items = dataList.items();
216
217         for (Vector<FormDataList::Item>::const_iterator j(items.begin()); j != items.end(); ++j) {
218             // Handle ISINDEX / <input name=isindex> specially, but only if it's
219             // the first entry.
220             if (!encodedString->isEmpty() || j->data() != "isindex") {
221                 if (!encodedString->isEmpty())
222                     encodedString->append('&');
223                 FormDataBuilder::encodeStringAsFormData(*encodedString, j->data());
224                 encodedString->append('=');
225             }
226             ++j;
227             if (formElement == textElement) {
228                 encodedString->append("{searchTerms}", 13);
229                 isElementFound = true;
230             } else
231                 FormDataBuilder::encodeStringAsFormData(*encodedString, j->data());
232         }
233     }
234     return isElementFound;
235 }
236 } // namespace
237
238 namespace WebKit {
239
240 WebSearchableFormData::WebSearchableFormData(const WebFormElement& form, const WebInputElement& selectedInputElement)
241 {
242     RefPtr<HTMLFormElement> formElement = form.operator PassRefPtr<HTMLFormElement>();
243     HTMLInputElement* inputElement = selectedInputElement.operator PassRefPtr<HTMLInputElement>().get();
244
245     // Only consider forms that GET data.
246     // Allow HTTPS only when an input element is provided. 
247     if (equalIgnoringCase(formElement->getAttribute(methodAttr), "post") 
248         || (!IsHTTPFormSubmit(formElement.get()) && !inputElement))
249         return;
250
251     Vector<char> encodedString;
252     TextEncoding encoding;
253
254     GetFormEncoding(formElement.get(), &encoding);
255     if (!encoding.isValid()) {
256         // Need a valid encoding to encode the form elements.
257         // If the encoding isn't found webkit ends up replacing the params with
258         // empty strings. So, we don't try to do anything here.
259         return;
260     } 
261
262     // Look for a suitable search text field in the form when a 
263     // selectedInputElement is not provided.
264     if (!inputElement) {
265         inputElement = findSuitableSearchInputElement(formElement.get());
266
267         // Return if no suitable text element has been found.
268         if (!inputElement)
269             return;
270     }
271
272     HTMLFormControlElement* firstSubmitButton = GetButtonToActivate(formElement.get());
273     if (firstSubmitButton) {
274         // The form does not have an active submit button, make the first button
275         // active. We need to do this, otherwise the URL will not contain the
276         // name of the submit button.
277         firstSubmitButton->setActivatedSubmit(true);
278     }
279
280     bool isValidSearchString = buildSearchString(formElement.get(), &encodedString, &encoding, inputElement);
281
282     if (firstSubmitButton)
283         firstSubmitButton->setActivatedSubmit(false);
284
285     // Return if the search string is not valid. 
286     if (!isValidSearchString)
287         return;
288
289     String action(formElement->action());
290     KURL url(formElement->document()->completeURL(action.isNull() ? "" : action));
291     RefPtr<FormData> formData = FormData::create(encodedString);
292     url.setQuery(formData->flattenToString());
293     m_url = url;
294     m_encoding = String(encoding.name()); 
295 }
296
297 } // namespace WebKit