Source/WebCore/loader/DocumentWriter.cpp

   1 /*
   2  * Copyright (C) 2010. Adam Barth. 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
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #include "config.h"
  30 #include "DocumentWriter.h"
  31
  32 #include "DOMImplementation.h"
  33 #include "DOMWindow.h"
  34 #include "Frame.h"
  35 #include "FrameLoader.h"
  36 #include "FrameLoaderClient.h"
  37 #include "FrameLoaderStateMachine.h"
  38 #include "FrameView.h"
  39 #include "MIMETypeRegistry.h"
  40 #include "MainFrame.h"
  41 #include "PluginDocument.h"
  42 #include "RawDataDocumentParser.h"
  43 #include "ScriptController.h"
  44 #include "ScriptableDocumentParser.h"
  45 #include "SecurityOrigin.h"
  46 #include "SegmentedString.h"
  47 #include "Settings.h"
  48 #include "SinkDocument.h"
  49 #include "TextResourceDecoder.h"
  50 #include <wtf/Ref.h>
  51
  52 namespace WebCore {
  53
  54 static inline bool canReferToParentFrameEncoding(const Frame* frame, const Frame* parentFrame)
  55 {
  56     return parentFrame && parentFrame->document()->securityOrigin()->canAccess(frame->document()->securityOrigin());
  57 }
  58
  59 DocumentWriter::DocumentWriter(Frame* frame)
  60     : m_frame(frame)
  61     , m_hasReceivedSomeData(false)
  62     , m_encodingWasChosenByUser(false)
  63     , m_state(NotStartedWritingState)
  64 {
  65 }
  66
  67 // This is only called by ScriptController::executeIfJavaScriptURL
  68 // and always contains the result of evaluating a javascript: url.
  69 // This is the <iframe src="javascript:'html'"> case.
  70 void DocumentWriter::replaceDocument(const String& source, Document* ownerDocument)
  71 {
  72     m_frame->loader().stopAllLoaders();
  73     begin(m_frame->document()->url(), true, ownerDocument);
  74
  75     if (!source.isNull()) {
  76         if (!m_hasReceivedSomeData) {
  77             m_hasReceivedSomeData = true;
  78             m_frame->document()->setCompatibilityMode(DocumentCompatibilityMode::NoQuirksMode);
  79         }
  80
  81         // FIXME: This should call DocumentParser::appendBytes instead of append
  82         // to support RawDataDocumentParsers.
  83         if (DocumentParser* parser = m_frame->document()->parser())
  84             parser->append(source.impl());
  85     }
  86
  87     end();
  88 }
  89
  90 void DocumentWriter::clear()
  91 {
  92     m_decoder = 0;
  93     m_hasReceivedSomeData = false;
  94     if (!m_encodingWasChosenByUser)
  95         m_encoding = String();
  96 }
  97
  98 void DocumentWriter::begin()
  99 {
 100     begin(URL());
 101 }
 102
 103 PassRefPtr<Document> DocumentWriter::createDocument(const URL& url)
 104 {
 105     if (!m_frame->loader().stateMachine().isDisplayingInitialEmptyDocument() && m_frame->loader().client().shouldAlwaysUsePluginDocument(m_mimeType))
 106         return PluginDocument::create(m_frame, url);
 107 #if PLATFORM(IOS)
 108     if (MIMETypeRegistry::isPDFMIMEType(m_mimeType) && (m_frame->isMainFrame() || !m_frame->settings().useImageDocumentForSubframePDF()))
 109         return SinkDocument::create(m_frame, url);
 110 #endif
 111     if (!m_frame->loader().client().hasHTMLView())
 112         return Document::createNonRenderedPlaceholder(m_frame, url);
 113     return DOMImplementation::createDocument(m_mimeType, m_frame, url);
 114 }
 115
 116 void DocumentWriter::begin(const URL& urlReference, bool dispatch, Document* ownerDocument)
 117 {
 118     // We grab a local copy of the URL because it's easy for callers to supply
 119     // a URL that will be deallocated during the execution of this function.
 120     // For example, see <https://bugs.webkit.org/show_bug.cgi?id=66360>.
 121     URL url = urlReference;
 122
 123     // Create a new document before clearing the frame, because it may need to
 124     // inherit an aliased security context.
 125     RefPtr<Document> document = createDocument(url);
 126
 127     // If the new document is for a Plugin but we're supposed to be sandboxed from Plugins,
 128     // then replace the document with one whose parser will ignore the incoming data (bug 39323)
 129     if (document->isPluginDocument() && document->isSandboxed(SandboxPlugins))
 130         document = SinkDocument::create(m_frame, url);
 131
 132     // FIXME: Do we need to consult the content security policy here about blocked plug-ins?
 133
 134     bool shouldReuseDefaultView = m_frame->loader().stateMachine().isDisplayingInitialEmptyDocument() && m_frame->document()->isSecureTransitionTo(url);
 135     if (shouldReuseDefaultView)
 136         document->takeDOMWindowFrom(m_frame->document());
 137     else
 138         document->createDOMWindow();
 139
 140     m_frame->loader().clear(document.get(), !shouldReuseDefaultView, !shouldReuseDefaultView);
 141     clear();
 142
 143     if (!shouldReuseDefaultView)
 144         m_frame->script().updatePlatformScriptObjects();
 145
 146     m_frame->loader().setOutgoingReferrer(url);
 147     m_frame->setDocument(document);
 148
 149     if (m_decoder)
 150         document->setDecoder(m_decoder.get());
 151     if (ownerDocument) {
 152         document->setCookieURL(ownerDocument->cookieURL());
 153         document->setSecurityOrigin(ownerDocument->securityOrigin());
 154     }
 155
 156     m_frame->loader().didBeginDocument(dispatch);
 157
 158     document->implicitOpen();
 159
 160     // We grab a reference to the parser so that we'll always send data to the
 161     // original parser, even if the document acquires a new parser (e.g., via
 162     // document.open).
 163     m_parser = document->parser();
 164
 165     if (m_frame->view() && m_frame->loader().client().hasHTMLView())
 166         m_frame->view()->setContentsSize(IntSize());
 167
 168     m_state = StartedWritingState;
 169 }
 170
 171 TextResourceDecoder* DocumentWriter::createDecoderIfNeeded()
 172 {
 173     if (!m_decoder) {
 174         m_decoder = TextResourceDecoder::create(m_mimeType,
 175             m_frame->settings().defaultTextEncodingName(),
 176             m_frame->settings().usesEncodingDetector());
 177         Frame* parentFrame = m_frame->tree().parent();
 178         // Set the hint encoding to the parent frame encoding only if
 179         // the parent and the current frames share the security origin.
 180         // We impose this condition because somebody can make a child frame
 181         // containing a carefully crafted html/javascript in one encoding
 182         // that can be mistaken for hintEncoding (or related encoding) by
 183         // an auto detector. When interpreted in the latter, it could be
 184         // an attack vector.
 185         // FIXME: This might be too cautious for non-7bit-encodings and
 186         // we may consider relaxing this later after testing.
 187         if (canReferToParentFrameEncoding(m_frame, parentFrame))
 188             m_decoder->setHintEncoding(parentFrame->document()->decoder());
 189         if (m_encoding.isEmpty()) {
 190             if (canReferToParentFrameEncoding(m_frame, parentFrame))
 191                 m_decoder->setEncoding(parentFrame->document()->inputEncoding(), TextResourceDecoder::EncodingFromParentFrame);
 192         } else {
 193             m_decoder->setEncoding(m_encoding,
 194                 m_encodingWasChosenByUser ? TextResourceDecoder::UserChosenEncoding : TextResourceDecoder::EncodingFromHTTPHeader);
 195         }
 196         m_frame->document()->setDecoder(m_decoder.get());
 197     }
 198     return m_decoder.get();
 199 }
 200
 201 void DocumentWriter::reportDataReceived()
 202 {
 203     ASSERT(m_decoder);
 204     if (m_hasReceivedSomeData)
 205         return;
 206     m_hasReceivedSomeData = true;
 207     if (m_decoder->encoding().usesVisualOrdering())
 208         m_frame->document()->setVisuallyOrdered();
 209     m_frame->document()->recalcStyle(Style::Force);
 210 }
 211
 212 void DocumentWriter::addData(const char* bytes, size_t length)
 213 {
 214     // Check that we're inside begin()/end().
 215     // FIXME: Change these to ASSERT once https://bugs.webkit.org/show_bug.cgi?id=80427 has
 216     // been resolved.
 217     if (m_state == NotStartedWritingState)
 218         CRASH();
 219     if (m_state == FinishedWritingState)
 220         CRASH();
 221
 222     ASSERT(m_parser);
 223     m_parser->appendBytes(*this, bytes, length);
 224 }
 225
 226 void DocumentWriter::end()
 227 {
 228     ASSERT(m_frame->page());
 229     ASSERT(m_frame->document());
 230
 231     // The parser is guaranteed to be released after this point. begin() would
 232     // have to be called again before we can start writing more data.
 233     m_state = FinishedWritingState;
 234
 235     // http://bugs.webkit.org/show_bug.cgi?id=10854
 236     // The frame's last ref may be removed and it can be deleted by checkCompleted(),
 237     // so we'll add a protective refcount
 238     Ref<Frame> protect(*m_frame);
 239
 240     if (!m_parser)
 241         return;
 242     // FIXME: m_parser->finish() should imply m_parser->flush().
 243     m_parser->flush(*this);
 244     if (!m_parser)
 245         return;
 246     m_parser->finish();
 247     m_parser = 0;
 248 }
 249
 250 void DocumentWriter::setEncoding(const String& name, bool userChosen)
 251 {
 252     m_encoding = name;
 253     m_encodingWasChosenByUser = userChosen;
 254 }
 255
 256 void DocumentWriter::setDocumentWasLoadedAsPartOfNavigation()
 257 {
 258     ASSERT(m_parser && !m_parser->isStopped());
 259     m_parser->setDocumentWasLoadedAsPartOfNavigation();
 260 }
 261
 262 } // namespace WebCore