Source/WebCore/loader/FormSubmission.cpp

   1 /*
   2  * Copyright (C) 2010 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 "FormSubmission.h"
  33
  34 #include "DOMFormData.h"
  35 #include "Document.h"
  36 #include "Event.h"
  37 #include "FormData.h"
  38 #include "FormDataBuilder.h"
  39 #include "FormState.h"
  40 #include "Frame.h"
  41 #include "FrameLoadRequest.h"
  42 #include "FrameLoader.h"
  43 #include "HTMLFormControlElement.h"
  44 #include "HTMLFormElement.h"
  45 #include "HTMLInputElement.h"
  46 #include "HTMLNames.h"
  47 #include "HTMLParserIdioms.h"
  48 #include "TextEncoding.h"
  49 #include <wtf/CurrentTime.h>
  50 #include <wtf/RandomNumber.h>
  51
  52 namespace WebCore {
  53
  54 using namespace HTMLNames;
  55
  56 static int64_t generateFormDataIdentifier()
  57 {
  58     // Initialize to the current time to reduce the likelihood of generating
  59     // identifiers that overlap with those from past/future browser sessions.
  60     static int64_t nextIdentifier = static_cast<int64_t>(currentTime() * 1000000.0);
  61     return ++nextIdentifier;
  62 }
  63
  64 static void appendMailtoPostFormDataToURL(KURL& url, const FormData& data, const String& encodingType)
  65 {
  66     String body = data.flattenToString();
  67
  68     if (equalIgnoringCase(encodingType, "text/plain")) {
  69         // Convention seems to be to decode, and s/&/\r\n/. Also, spaces are encoded as %20.
  70         body = decodeURLEscapeSequences(body.replace('&', "\r\n").replace('+', ' ') + "\r\n");
  71     }
  72
  73     Vector<char> bodyData;
  74     bodyData.append("body=", 5);
  75     FormDataBuilder::encodeStringAsFormData(bodyData, body.utf8());
  76     body = String(bodyData.data(), bodyData.size()).replace('+', "%20");
  77
  78     String query = url.query();
  79     if (!query.isEmpty())
  80         query.append('&');
  81     query.append(body);
  82     url.setQuery(query);
  83 }
  84
  85 void FormSubmission::Attributes::parseAction(const String& action)
  86 {
  87     // FIXME: Can we parse into a KURL?
  88     m_action = stripLeadingAndTrailingHTMLSpaces(action);
  89 }
  90
  91 String FormSubmission::Attributes::parseEncodingType(const String& type)
  92 {
  93     if (equalIgnoringCase(type, "multipart/form-data"))
  94         return "multipart/form-data";
  95     if (equalIgnoringCase(type, "text/plain"))
  96         return "text/plain";
  97     return "application/x-www-form-urlencoded";
  98 }
  99
 100 void FormSubmission::Attributes::updateEncodingType(const String& type)
 101 {
 102     m_encodingType = parseEncodingType(type);
 103     m_isMultiPartForm = (m_encodingType == "multipart/form-data");
 104 }
 105
 106 FormSubmission::Method FormSubmission::Attributes::parseMethodType(const String& type)
 107 {
 108     return equalIgnoringCase(type, "post") ? FormSubmission::PostMethod : FormSubmission::GetMethod;
 109 }
 110
 111 void FormSubmission::Attributes::updateMethodType(const String& type)
 112 {
 113     m_method = parseMethodType(type);
 114 }
 115
 116 void FormSubmission::Attributes::copyFrom(const Attributes& other)
 117 {
 118     m_method = other.m_method;
 119     m_isMultiPartForm = other.m_isMultiPartForm;
 120
 121     m_action = other.m_action;
 122     m_target = other.m_target;
 123     m_encodingType = other.m_encodingType;
 124     m_acceptCharset = other.m_acceptCharset;
 125 }
 126
 127 inline FormSubmission::FormSubmission(Method method, const KURL& action, const String& target, const String& contentType, PassRefPtr<FormState> state, PassRefPtr<FormData> data, const String& boundary, bool lockHistory, PassRefPtr<Event> event)
 128     : m_method(method)
 129     , m_action(action)
 130     , m_target(target)
 131     , m_contentType(contentType)
 132     , m_formState(state)
 133     , m_formData(data)
 134     , m_boundary(boundary)
 135     , m_lockHistory(lockHistory)
 136     , m_event(event)
 137 {
 138 }
 139
 140 PassRefPtr<FormSubmission> FormSubmission::create(HTMLFormElement* form, const Attributes& attributes, PassRefPtr<Event> event, bool lockHistory, FormSubmissionTrigger trigger)
 141 {
 142     ASSERT(form);
 143
 144     HTMLFormControlElement* submitButton = 0;
 145     if (event && event->target()) {
 146         Node* node = event->target()->toNode();
 147         if (node && node->isElementNode() && toElement(node)->isFormControlElement())
 148             submitButton = static_cast<HTMLFormControlElement*>(node);
 149     }
 150
 151     FormSubmission::Attributes copiedAttributes;
 152     copiedAttributes.copyFrom(attributes);
 153     if (submitButton) {
 154         String attributeValue;
 155         if (!(attributeValue = submitButton->getAttribute(formactionAttr)).isNull())
 156             copiedAttributes.parseAction(attributeValue);
 157         if (!(attributeValue = submitButton->getAttribute(formenctypeAttr)).isNull())
 158             copiedAttributes.updateEncodingType(attributeValue);
 159         if (!(attributeValue = submitButton->getAttribute(formmethodAttr)).isNull())
 160             copiedAttributes.updateMethodType(attributeValue);
 161         if (!(attributeValue = submitButton->getAttribute(formtargetAttr)).isNull())
 162             copiedAttributes.setTarget(attributeValue);
 163     }
 164
 165     Document* document = form->document();
 166     KURL actionURL = document->completeURL(copiedAttributes.action().isEmpty() ? document->url().string() : copiedAttributes.action());
 167     bool isMailtoForm = actionURL.protocolIs("mailto");
 168     bool isMultiPartForm = false;
 169     String encodingType = copiedAttributes.encodingType();
 170
 171     if (copiedAttributes.method() == PostMethod) {
 172         isMultiPartForm = copiedAttributes.isMultiPartForm();
 173         if (isMultiPartForm && isMailtoForm) {
 174             encodingType = "application/x-www-form-urlencoded";
 175             isMultiPartForm = false;
 176         }
 177     }
 178
 179     TextEncoding dataEncoding = isMailtoForm ? UTF8Encoding() : FormDataBuilder::encodingFromAcceptCharset(copiedAttributes.acceptCharset(), document);
 180     RefPtr<DOMFormData> domFormData = DOMFormData::create(dataEncoding.encodingForFormSubmission());
 181     Vector<pair<String, String> > formValues;
 182
 183     bool containsPasswordData = false;
 184     for (unsigned i = 0; i < form->associatedElements().size(); ++i) {
 185         FormAssociatedElement* control = form->associatedElements()[i];
 186         HTMLElement* element = toHTMLElement(control);
 187         if (!element->disabled())
 188             control->appendFormData(*domFormData, isMultiPartForm);
 189         if (element->hasLocalName(inputTag)) {
 190             HTMLInputElement* input = static_cast<HTMLInputElement*>(control);
 191             if (input->isTextField()) {
 192                 formValues.append(pair<String, String>(input->name().string(), input->value()));
 193                 if (input->isSearchField())
 194                     input->addSearchResult();
 195             }
 196             if (input->isPasswordField() && !input->value().isEmpty())
 197                 containsPasswordData = true;
 198         }
 199     }
 200
 201     RefPtr<FormData> formData;
 202     String boundary;
 203
 204     if (isMultiPartForm) {
 205         formData = FormData::createMultiPart(*(static_cast<FormDataList*>(domFormData.get())), domFormData->encoding(), document);
 206         boundary = formData->boundary().data();
 207     } else {
 208         formData = FormData::create(*(static_cast<FormDataList*>(domFormData.get())), domFormData->encoding(), attributes.method() == GetMethod ? FormData::FormURLEncoded : FormData::parseEncodingType(encodingType));
 209         if (copiedAttributes.method() == PostMethod && isMailtoForm) {
 210             // Convert the form data into a string that we put into the URL.
 211             appendMailtoPostFormDataToURL(actionURL, *formData, encodingType);
 212             formData = FormData::create();
 213         }
 214     }
 215
 216     formData->setIdentifier(generateFormDataIdentifier());
 217     formData->setContainsPasswordData(containsPasswordData);
 218     String targetOrBaseTarget = copiedAttributes.target().isEmpty() ? document->baseTarget() : copiedAttributes.target();
 219     RefPtr<FormState> formState = FormState::create(form, formValues, document->frame(), trigger);
 220     return adoptRef(new FormSubmission(copiedAttributes.method(), actionURL, targetOrBaseTarget, encodingType, formState.release(), formData.release(), boundary, lockHistory, event));
 221 }
 222
 223 KURL FormSubmission::requestURL() const
 224 {
 225     if (m_method == FormSubmission::PostMethod)
 226         return m_action;
 227
 228     KURL requestURL(m_action);
 229     requestURL.setQuery(m_formData->flattenToString());
 230     return requestURL;
 231 }
 232
 233 void FormSubmission::populateFrameLoadRequest(FrameLoadRequest& frameRequest)
 234 {
 235     if (!m_target.isEmpty())
 236         frameRequest.setFrameName(m_target);
 237
 238     if (!m_referrer.isEmpty())
 239         frameRequest.resourceRequest().setHTTPReferrer(m_referrer);
 240
 241     if (m_method == FormSubmission::PostMethod) {
 242         frameRequest.resourceRequest().setHTTPMethod("POST");
 243         frameRequest.resourceRequest().setHTTPBody(m_formData);
 244
 245         // construct some user headers if necessary
 246         if (m_contentType.isNull() || m_contentType == "application/x-www-form-urlencoded")
 247             frameRequest.resourceRequest().setHTTPContentType(m_contentType);
 248         else // contentType must be "multipart/form-data"
 249             frameRequest.resourceRequest().setHTTPContentType(m_contentType + "; boundary=" + m_boundary);
 250     }
 251
 252     frameRequest.resourceRequest().setURL(requestURL());
 253     FrameLoader::addHTTPOriginIfNeeded(frameRequest.resourceRequest(), m_origin);
 254 }
 255
 256 }