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