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 "public/web/WebSearchableFormData.h" 33 34 #include "core/HTMLNames.h" 35 #include "core/dom/Document.h" 36 #include "core/html/FormDataList.h" 37 #include "core/html/HTMLFormControlElement.h" 38 #include "core/html/HTMLFormElement.h" 39 #include "core/html/HTMLInputElement.h" 40 #include "core/html/HTMLOptionElement.h" 41 #include "core/html/HTMLSelectElement.h" 42 #include "platform/network/FormDataBuilder.h" 43 #include "public/web/WebFormElement.h" 44 #include "public/web/WebInputElement.h" 45 #include "wtf/text/TextEncoding.h" 46 47 using namespace WebCore; 48 using namespace HTMLNames; 49 50 namespace { 51 52 // Gets the encoding for the form. 53 void GetFormEncoding(const HTMLFormElement* form, WTF::TextEncoding* encoding) 54 { 55 String str(form->getAttribute(HTMLNames::accept_charsetAttr)); 56 str.replace(',', ' '); 57 Vector<String> charsets; 58 str.split(' ', charsets); 59 for (Vector<String>::const_iterator i(charsets.begin()); i != charsets.end(); ++i) { 60 *encoding = WTF::TextEncoding(*i); 61 if (encoding->isValid()) 62 return; 63 } 64 if (!form->document().loader()) 65 return; 66 *encoding = WTF::TextEncoding(form->document().encoding()); 67 } 68 69 // Returns true if the submit request results in an HTTP URL. 70 bool IsHTTPFormSubmit(const HTMLFormElement* form) 71 { 72 // FIXME: This function is insane. This is an overly complicated way to get this information. 73 String action(form->action()); 74 // The isNull() check is trying to avoid completeURL returning KURL() when passed a null string. 75 return form->document().completeURL(action.isNull() ? "" : action).protocolIs("http"); 76 } 77 78 // If the form does not have an activated submit button, the first submit 79 // button is returned. 80 HTMLFormControlElement* GetButtonToActivate(HTMLFormElement* form) 81 { 82 HTMLFormControlElement* firstSubmitButton = 0; 83 const FormAssociatedElement::List& element = form->associatedElements(); 84 for (FormAssociatedElement::List::const_iterator i(element.begin()); i != element.end(); ++i) { 85 if (!(*i)->isFormControlElement()) 86 continue; 87 HTMLFormControlElement* control = toHTMLFormControlElement(*i); 88 if (control->isActivatedSubmit()) { 89 // There's a button that is already activated for submit, return 0. 90 return 0; 91 } 92 if (!firstSubmitButton && control->isSuccessfulSubmitButton()) 93 firstSubmitButton = control; 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 WillBeHeapVector<RawPtrWillBeMember<HTMLElement> >& listItems = select->listItems(); 103 if (select->multiple() || select->size() > 1) { 104 for (WillBeHeapVector<RawPtrWillBeMember<HTMLElement> >::const_iterator i(listItems.begin()); i != listItems.end(); ++i) { 105 if (!(*i)->hasLocalName(HTMLNames::optionTag)) 106 continue; 107 HTMLOptionElement* optionElement = toHTMLOptionElement(*i); 108 if (optionElement->selected() != optionElement->hasAttribute(selectedAttr)) 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 (WillBeHeapVector<RawPtrWillBeMember<HTMLElement> >::const_iterator i(listItems.begin()); i != listItems.end(); ++i) { 118 if (!(*i)->hasLocalName(HTMLNames::optionTag)) 119 continue; 120 HTMLOptionElement* optionElement = toHTMLOptionElement(*i); 121 if (optionElement->hasAttribute(selectedAttr)) { 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 ASSERT(formElement); 139 if (isHTMLInputElement(*formElement)) { 140 const HTMLInputElement& inputElement = toHTMLInputElement(*formElement); 141 if (inputElement.isCheckbox() || inputElement.isRadioButton()) 142 return inputElement.checked() == inputElement.hasAttribute(checkedAttr); 143 } else if (isHTMLSelectElement(*formElement)) { 144 return IsSelectInDefaultState(toHTMLSelectElement(formElement)); 145 } 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 const FormAssociatedElement::List& element = form->associatedElements(); 159 for (FormAssociatedElement::List::const_iterator i(element.begin()); i != element.end(); ++i) { 160 if (!(*i)->isFormControlElement()) 161 continue; 162 163 HTMLFormControlElement* control = toHTMLFormControlElement(*i); 164 165 if (control->isDisabledFormControl() || control->name().isNull()) 166 continue; 167 168 if (!IsInDefaultState(control) || isHTMLTextAreaElement(*control)) 169 return 0; 170 171 if (isHTMLInputElement(*control) && control->willValidate()) { 172 const HTMLInputElement& input = toHTMLInputElement(*control); 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 = toHTMLInputElement(control); 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, WTF::TextEncoding* encoding, const HTMLInputElement* textElement) 198 { 199 bool isElementFound = false; 200 201 const FormAssociatedElement::List& elements = form->associatedElements(); 202 for (FormAssociatedElement::List::const_iterator i(elements.begin()); i != elements.end(); ++i) { 203 if (!(*i)->isFormControlElement()) 204 continue; 205 206 HTMLFormControlElement* control = toHTMLFormControlElement(*i); 207 208 if (control->isDisabledFormControl() || control->name().isNull()) 209 continue; 210 211 FormDataList dataList(*encoding); 212 if (!control->appendFormData(dataList, false)) 213 continue; 214 215 const WillBeHeapVector<FormDataList::Item>& items = dataList.items(); 216 217 for (WillBeHeapVector<FormDataList::Item>::const_iterator j(items.begin()); j != items.end(); ++j) { 218 if (!encodedString->isEmpty()) 219 encodedString->append('&'); 220 FormDataBuilder::encodeStringAsFormData(*encodedString, j->data()); 221 encodedString->append('='); 222 ++j; 223 if (control == textElement) { 224 encodedString->append("{searchTerms}", 13); 225 isElementFound = true; 226 } else 227 FormDataBuilder::encodeStringAsFormData(*encodedString, j->data()); 228 } 229 } 230 return isElementFound; 231 } 232 } // namespace 233 234 namespace blink { 235 236 WebSearchableFormData::WebSearchableFormData(const WebFormElement& form, const WebInputElement& selectedInputElement) 237 { 238 RefPtrWillBeRawPtr<HTMLFormElement> formElement = static_cast<PassRefPtrWillBeRawPtr<HTMLFormElement> >(form); 239 HTMLInputElement* inputElement = static_cast<PassRefPtrWillBeRawPtr<HTMLInputElement> >(selectedInputElement).get(); 240 241 // Only consider forms that GET data. 242 // Allow HTTPS only when an input element is provided. 243 if (equalIgnoringCase(formElement->getAttribute(methodAttr), "post") 244 || (!IsHTTPFormSubmit(formElement.get()) && !inputElement)) 245 return; 246 247 Vector<char> encodedString; 248 WTF::TextEncoding encoding; 249 250 GetFormEncoding(formElement.get(), &encoding); 251 if (!encoding.isValid()) { 252 // Need a valid encoding to encode the form elements. 253 // If the encoding isn't found webkit ends up replacing the params with 254 // empty strings. So, we don't try to do anything here. 255 return; 256 } 257 258 // Look for a suitable search text field in the form when a 259 // selectedInputElement is not provided. 260 if (!inputElement) { 261 inputElement = findSuitableSearchInputElement(formElement.get()); 262 263 // Return if no suitable text element has been found. 264 if (!inputElement) 265 return; 266 } 267 268 HTMLFormControlElement* firstSubmitButton = GetButtonToActivate(formElement.get()); 269 if (firstSubmitButton) { 270 // The form does not have an active submit button, make the first button 271 // active. We need to do this, otherwise the URL will not contain the 272 // name of the submit button. 273 firstSubmitButton->setActivatedSubmit(true); 274 } 275 276 bool isValidSearchString = buildSearchString(formElement.get(), &encodedString, &encoding, inputElement); 277 278 if (firstSubmitButton) 279 firstSubmitButton->setActivatedSubmit(false); 280 281 // Return if the search string is not valid. 282 if (!isValidSearchString) 283 return; 284 285 String action(formElement->action()); 286 KURL url(formElement->document().completeURL(action.isNull() ? "" : action)); 287 RefPtr<FormData> formData = FormData::create(encodedString); 288 url.setQuery(formData->flattenToString()); 289 m_url = url; 290 m_encoding = String(encoding.name()); 291 } 292 293 } // namespace blink 294