Drop non-standard [IsIndex] WebKit IDL extended attribute
[WebKit-https.git] / 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 "SecurityOriginPolicy.h"
47 #include "SegmentedString.h"
48 #include "Settings.h"
49 #include "SinkDocument.h"
50 #include "TextResourceDecoder.h"
51 #include <wtf/Ref.h>
52
53 namespace WebCore {
54
55 static inline bool canReferToParentFrameEncoding(const Frame* frame, const Frame* parentFrame) 
56 {
57     return parentFrame && parentFrame->document()->securityOrigin()->canAccess(frame->document()->securityOrigin());
58 }
59     
60 DocumentWriter::DocumentWriter(Frame* frame)
61     : m_frame(frame)
62     , m_hasReceivedSomeData(false)
63     , m_encodingWasChosenByUser(false)
64     , m_state(NotStartedWritingState)
65 {
66 }
67
68 // This is only called by ScriptController::executeIfJavaScriptURL
69 // and always contains the result of evaluating a javascript: url.
70 // This is the <iframe src="javascript:'html'"> case.
71 void DocumentWriter::replaceDocument(const String& source, Document* ownerDocument)
72 {
73     m_frame->loader().stopAllLoaders();
74     begin(m_frame->document()->url(), true, ownerDocument);
75
76     if (!source.isNull()) {
77         if (!m_hasReceivedSomeData) {
78             m_hasReceivedSomeData = true;
79             m_frame->document()->setCompatibilityMode(DocumentCompatibilityMode::NoQuirksMode);
80         }
81
82         // FIXME: This should call DocumentParser::appendBytes instead of append
83         // to support RawDataDocumentParsers.
84         if (DocumentParser* parser = m_frame->document()->parser())
85             parser->append(source.impl());
86     }
87
88     end();
89 }
90
91 void DocumentWriter::clear()
92 {
93     m_decoder = nullptr;
94     m_hasReceivedSomeData = false;
95     if (!m_encodingWasChosenByUser)
96         m_encoding = String();
97 }
98
99 void DocumentWriter::begin()
100 {
101     begin(URL());
102 }
103
104 Ref<Document> DocumentWriter::createDocument(const URL& url)
105 {
106     if (!m_frame->loader().stateMachine().isDisplayingInitialEmptyDocument() && m_frame->loader().client().shouldAlwaysUsePluginDocument(m_mimeType))
107         return PluginDocument::create(m_frame, url);
108 #if PLATFORM(IOS)
109     if (MIMETypeRegistry::isPDFMIMEType(m_mimeType) && (m_frame->isMainFrame() || !m_frame->settings().useImageDocumentForSubframePDF()))
110         return SinkDocument::create(m_frame, url);
111 #endif
112     if (!m_frame->loader().client().hasHTMLView())
113         return Document::createNonRenderedPlaceholder(m_frame, url);
114     return DOMImplementation::createDocument(m_mimeType, m_frame, url);
115 }
116
117 void DocumentWriter::begin(const URL& urlReference, bool dispatch, Document* ownerDocument)
118 {
119     // We grab a local copy of the URL because it's easy for callers to supply
120     // a URL that will be deallocated during the execution of this function.
121     // For example, see <https://bugs.webkit.org/show_bug.cgi?id=66360>.
122     URL url = urlReference;
123
124     // Create a new document before clearing the frame, because it may need to
125     // inherit an aliased security context.
126     Ref<Document> document = createDocument(url);
127     
128     // If the new document is for a Plugin but we're supposed to be sandboxed from Plugins,
129     // then replace the document with one whose parser will ignore the incoming data (bug 39323)
130     if (document->isPluginDocument() && document->isSandboxed(SandboxPlugins))
131         document = SinkDocument::create(m_frame, url);
132
133     // FIXME: Do we need to consult the content security policy here about blocked plug-ins?
134
135     bool shouldReuseDefaultView = m_frame->loader().stateMachine().isDisplayingInitialEmptyDocument() && m_frame->document()->isSecureTransitionTo(url);
136     if (shouldReuseDefaultView)
137         document->takeDOMWindowFrom(m_frame->document());
138     else
139         document->createDOMWindow();
140
141     m_frame->loader().clear(document.ptr(), !shouldReuseDefaultView, !shouldReuseDefaultView);
142     clear();
143
144     if (!shouldReuseDefaultView)
145         m_frame->script().updatePlatformScriptObjects();
146
147     m_frame->loader().setOutgoingReferrer(url);
148     m_frame->setDocument(document.copyRef());
149
150     if (m_decoder)
151         document->setDecoder(m_decoder.get());
152     if (ownerDocument) {
153         document->setCookieURL(ownerDocument->cookieURL());
154         document->setSecurityOriginPolicy(ownerDocument->securityOriginPolicy());
155     }
156
157     m_frame->loader().didBeginDocument(dispatch);
158
159     document->implicitOpen();
160
161     // We grab a reference to the parser so that we'll always send data to the
162     // original parser, even if the document acquires a new parser (e.g., via
163     // document.open).
164     m_parser = document->parser();
165
166     if (m_frame->view() && m_frame->loader().client().hasHTMLView())
167         m_frame->view()->setContentsSize(IntSize());
168
169     m_state = StartedWritingState;
170 }
171
172 TextResourceDecoder* DocumentWriter::createDecoderIfNeeded()
173 {
174     if (!m_decoder) {
175         m_decoder = TextResourceDecoder::create(m_mimeType,
176             m_frame->settings().defaultTextEncodingName(),
177             m_frame->settings().usesEncodingDetector());
178         Frame* parentFrame = m_frame->tree().parent();
179         // Set the hint encoding to the parent frame encoding only if
180         // the parent and the current frames share the security origin.
181         // We impose this condition because somebody can make a child frame
182         // containing a carefully crafted html/javascript in one encoding
183         // that can be mistaken for hintEncoding (or related encoding) by
184         // an auto detector. When interpreted in the latter, it could be
185         // an attack vector.
186         // FIXME: This might be too cautious for non-7bit-encodings and
187         // we may consider relaxing this later after testing.
188         if (canReferToParentFrameEncoding(m_frame, parentFrame))
189             m_decoder->setHintEncoding(parentFrame->document()->decoder());
190         if (m_encoding.isEmpty()) {
191             if (canReferToParentFrameEncoding(m_frame, parentFrame))
192                 m_decoder->setEncoding(TextEncoding(parentFrame->document()->encoding()), TextResourceDecoder::EncodingFromParentFrame);
193         } else {
194             m_decoder->setEncoding(m_encoding,
195                 m_encodingWasChosenByUser ? TextResourceDecoder::UserChosenEncoding : TextResourceDecoder::EncodingFromHTTPHeader);
196         }
197         m_frame->document()->setDecoder(m_decoder.get());
198     }
199     return m_decoder.get();
200 }
201
202 void DocumentWriter::reportDataReceived()
203 {
204     ASSERT(m_decoder);
205     if (m_hasReceivedSomeData)
206         return;
207     m_hasReceivedSomeData = true;
208     if (m_decoder->encoding().usesVisualOrdering())
209         m_frame->document()->setVisuallyOrdered();
210     m_frame->document()->recalcStyle(Style::Force);
211 }
212
213 void DocumentWriter::addData(const char* bytes, size_t length)
214 {
215     // Check that we're inside begin()/end().
216     // FIXME: Change these to ASSERT once https://bugs.webkit.org/show_bug.cgi?id=80427 has
217     // been resolved.
218     if (m_state == NotStartedWritingState)
219         CRASH();
220     if (m_state == FinishedWritingState)
221         CRASH();
222
223     ASSERT(m_parser);
224     m_parser->appendBytes(*this, bytes, length);
225 }
226
227 void DocumentWriter::end()
228 {
229     ASSERT(m_frame->page());
230     ASSERT(m_frame->document());
231
232     // The parser is guaranteed to be released after this point. begin() would
233     // have to be called again before we can start writing more data.
234     m_state = FinishedWritingState;
235
236     // http://bugs.webkit.org/show_bug.cgi?id=10854
237     // The frame's last ref may be removed and it can be deleted by checkCompleted(), 
238     // so we'll add a protective refcount
239     Ref<Frame> protect(*m_frame);
240
241     if (!m_parser)
242         return;
243     // FIXME: m_parser->finish() should imply m_parser->flush().
244     m_parser->flush(*this);
245     if (!m_parser)
246         return;
247     m_parser->finish();
248     m_parser = nullptr;
249 }
250
251 void DocumentWriter::setEncoding(const String& name, bool userChosen)
252 {
253     m_encoding = name;
254     m_encodingWasChosenByUser = userChosen;
255 }
256
257 void DocumentWriter::setDocumentWasLoadedAsPartOfNavigation()
258 {
259     ASSERT(m_parser && !m_parser->isStopped());
260     m_parser->setDocumentWasLoadedAsPartOfNavigation();
261 }
262
263 } // namespace WebCore