3a260d7d4329b9c69810a045420ce6e1ddcb161f
[WebKit-https.git] / Source / WebCore / loader / SubframeLoader.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
4  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
5  * Copyright (C) 2008 Alp Toker <alp@atoker.com>
6  * Copyright (C) Research In Motion Limited 2009. All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1.  Redistributions of source code must retain the above copyright
13  *     notice, this list of conditions and the following disclaimer. 
14  * 2.  Redistributions in binary form must reproduce the above copyright
15  *     notice, this list of conditions and the following disclaimer in the
16  *     documentation and/or other materials provided with the distribution. 
17  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
18  *     its contributors may be used to endorse or promote products derived
19  *     from this software without specific prior written permission. 
20  *
21  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
22  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
25  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
28  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #include "config.h"
34 #include "SubframeLoader.h"
35
36 #include "Chrome.h"
37 #include "ChromeClient.h"
38 #include "ContentSecurityPolicy.h"
39 #include "DiagnosticLoggingClient.h"
40 #include "DiagnosticLoggingKeys.h"
41 #include "Frame.h"
42 #include "FrameLoader.h"
43 #include "FrameLoaderClient.h"
44 #include "HTMLAppletElement.h"
45 #include "HTMLAudioElement.h"
46 #include "HTMLFrameElementBase.h"
47 #include "HTMLNames.h"
48 #include "HTMLObjectElement.h"
49 #include "MIMETypeRegistry.h"
50 #include "MainFrame.h"
51 #include "Page.h"
52 #include "PluginData.h"
53 #include "PluginDocument.h"
54 #include "RenderEmbeddedObject.h"
55 #include "RenderView.h"
56 #include "ScriptController.h"
57 #include "SecurityOrigin.h"
58 #include "SecurityPolicy.h"
59 #include "Settings.h"
60
61 namespace WebCore {
62     
63 using namespace HTMLNames;
64
65 SubframeLoader::SubframeLoader(Frame& frame)
66     : m_containsPlugins(false)
67     , m_frame(frame)
68 {
69 }
70
71 void SubframeLoader::clear()
72 {
73     m_containsPlugins = false;
74 }
75
76 bool SubframeLoader::requestFrame(HTMLFrameOwnerElement& ownerElement, const String& urlString, const AtomicString& frameName, LockHistory lockHistory, LockBackForwardList lockBackForwardList)
77 {
78     // Support for <frame src="javascript:string">
79     URL scriptURL;
80     URL url;
81     if (protocolIsJavaScript(urlString)) {
82         scriptURL = completeURL(urlString); // completeURL() encodes the URL.
83         url = blankURL();
84     } else
85         url = completeURL(urlString);
86
87     Frame* frame = loadOrRedirectSubframe(ownerElement, url, frameName, lockHistory, lockBackForwardList);
88     if (!frame)
89         return false;
90
91     if (!scriptURL.isEmpty())
92         frame->script().executeIfJavaScriptURL(scriptURL);
93
94     return true;
95 }
96     
97 bool SubframeLoader::resourceWillUsePlugin(const String& url, const String& mimeType, bool shouldPreferPlugInsForImages)
98 {
99     URL completedURL;
100     if (!url.isEmpty())
101         completedURL = completeURL(url);
102
103     bool useFallback;
104     return shouldUsePlugin(completedURL, mimeType, shouldPreferPlugInsForImages, false, useFallback);
105 }
106
107 bool SubframeLoader::pluginIsLoadable(HTMLPlugInImageElement& pluginElement, const URL& url, const String& mimeType)
108 {
109     if (MIMETypeRegistry::isJavaAppletMIMEType(mimeType)) {
110         if (!m_frame.settings().isJavaEnabled())
111             return false;
112         if (document() && document()->securityOrigin()->isLocal() && !m_frame.settings().isJavaEnabledForLocalFiles())
113             return false;
114     }
115
116     if (document()) {
117         if (document()->isSandboxed(SandboxPlugins))
118             return false;
119
120         if (!document()->securityOrigin()->canDisplay(url)) {
121             FrameLoader::reportLocalLoadFailed(&m_frame, url.string());
122             return false;
123         }
124
125         String declaredMimeType = document()->isPluginDocument() && document()->ownerElement() ?
126             document()->ownerElement()->fastGetAttribute(HTMLNames::typeAttr) :
127             pluginElement.fastGetAttribute(HTMLNames::typeAttr);
128         if (!document()->contentSecurityPolicy()->allowObjectFromSource(url)
129             || !document()->contentSecurityPolicy()->allowPluginType(mimeType, declaredMimeType, url)) {
130             RenderEmbeddedObject* renderer = pluginElement.renderEmbeddedObject();
131             renderer->setPluginUnavailabilityReason(RenderEmbeddedObject::PluginBlockedByContentSecurityPolicy);
132             return false;
133         }
134
135         if (!m_frame.loader().mixedContentChecker().canRunInsecureContent(document()->securityOrigin(), url))
136             return false;
137     }
138
139     return true;
140 }
141
142 bool SubframeLoader::requestPlugin(HTMLPlugInImageElement& ownerElement, const URL& url, const String& mimeType, const Vector<String>& paramNames, const Vector<String>& paramValues, bool useFallback)
143 {
144     // Application plug-ins are plug-ins implemented by the user agent, for example Qt plug-ins,
145     // as opposed to third-party code such as Flash. The user agent decides whether or not they are
146     // permitted, rather than WebKit.
147     if ((!allowPlugins(AboutToInstantiatePlugin) && !MIMETypeRegistry::isApplicationPluginMIMEType(mimeType)))
148         return false;
149
150     if (!pluginIsLoadable(ownerElement, url, mimeType))
151         return false;
152
153     ASSERT(ownerElement.hasTagName(objectTag) || ownerElement.hasTagName(embedTag));
154     return loadPlugin(ownerElement, url, mimeType, paramNames, paramValues, useFallback);
155 }
156
157 static String findPluginMIMETypeFromURL(Page* page, const String& url)
158 {
159     if (!url)
160         return String();
161
162     size_t dotIndex = url.reverseFind('.');
163     if (dotIndex == notFound)
164         return String();
165
166     String extension = url.substring(dotIndex + 1);
167
168     const PluginData& pluginData = page->pluginData();
169
170     for (size_t i = 0; i < pluginData.mimes().size(); ++i) {
171         const MimeClassInfo& mimeClassInfo = pluginData.mimes()[i];
172         for (size_t j = 0; j < mimeClassInfo.extensions.size(); ++j) {
173             if (equalIgnoringCase(extension, mimeClassInfo.extensions[j]))
174                 return mimeClassInfo.type;
175         }
176     }
177
178     return String();
179 }
180
181 static void logPluginRequest(Page* page, const String& mimeType, const String& url, bool success)
182 {
183     if (!page || !page->settings().diagnosticLoggingEnabled())
184         return;
185
186     String newMIMEType = mimeType;
187     if (!newMIMEType) {
188         // Try to figure out the MIME type from the URL extension.
189         newMIMEType = findPluginMIMETypeFromURL(page, url);
190         if (!newMIMEType)
191             return;
192     }
193
194     String pluginFile = page->pluginData().pluginFileForMimeType(newMIMEType);
195     String description = !pluginFile ? newMIMEType : pluginFile;
196
197     DiagnosticLoggingClient* diagnosticLoggingClient = page->mainFrame().diagnosticLoggingClient();
198     if (!diagnosticLoggingClient)
199         return;
200
201     diagnosticLoggingClient->logDiagnosticMessage(success ? DiagnosticLoggingKeys::pluginLoadedKey() : DiagnosticLoggingKeys::pluginLoadingFailedKey(), description);
202
203     if (!page->hasSeenAnyPlugin())
204         diagnosticLoggingClient->logDiagnosticMessage(DiagnosticLoggingKeys::pageContainsAtLeastOnePluginKey(), emptyString());
205
206     if (!page->hasSeenPlugin(description))
207         diagnosticLoggingClient->logDiagnosticMessage(DiagnosticLoggingKeys::pageContainsPluginKey(), description);
208
209     page->sawPlugin(description);
210 }
211
212 bool SubframeLoader::requestObject(HTMLPlugInImageElement& ownerElement, const String& url, const AtomicString& frameName, const String& mimeType, const Vector<String>& paramNames, const Vector<String>& paramValues)
213 {
214     if (url.isEmpty() && mimeType.isEmpty())
215         return false;
216
217     URL completedURL;
218     if (!url.isEmpty())
219         completedURL = completeURL(url);
220
221     bool hasFallbackContent = is<HTMLObjectElement>(ownerElement) && downcast<HTMLObjectElement>(ownerElement).hasFallbackContent();
222
223     bool useFallback;
224     if (shouldUsePlugin(completedURL, mimeType, ownerElement.shouldPreferPlugInsForImages(), hasFallbackContent, useFallback)) {
225         bool success = requestPlugin(ownerElement, completedURL, mimeType, paramNames, paramValues, useFallback);
226         logPluginRequest(document()->page(), mimeType, completedURL, success);
227         return success;
228     }
229
230     // If the plug-in element already contains a subframe, loadOrRedirectSubframe will re-use it. Otherwise,
231     // it will create a new frame and set it as the RenderWidget's Widget, causing what was previously 
232     // in the widget to be torn down.
233     return loadOrRedirectSubframe(ownerElement, completedURL, frameName, LockHistory::Yes, LockBackForwardList::Yes);
234 }
235
236 PassRefPtr<Widget> SubframeLoader::createJavaAppletWidget(const IntSize& size, HTMLAppletElement& element, const Vector<String>& paramNames, const Vector<String>& paramValues)
237 {
238     String baseURLString;
239     String codeBaseURLString;
240
241     for (size_t i = 0; i < paramNames.size(); ++i) {
242         if (equalIgnoringCase(paramNames[i], "baseurl"))
243             baseURLString = paramValues[i];
244         else if (equalIgnoringCase(paramNames[i], "codebase"))
245             codeBaseURLString = paramValues[i];
246     }
247
248     if (!codeBaseURLString.isEmpty()) {
249         URL codeBaseURL = completeURL(codeBaseURLString);
250         if (!element.document().securityOrigin()->canDisplay(codeBaseURL)) {
251             FrameLoader::reportLocalLoadFailed(&m_frame, codeBaseURL.string());
252             return nullptr;
253         }
254
255         const char javaAppletMimeType[] = "application/x-java-applet";
256         if (!element.document().contentSecurityPolicy()->allowObjectFromSource(codeBaseURL)
257             || !element.document().contentSecurityPolicy()->allowPluginType(javaAppletMimeType, javaAppletMimeType, codeBaseURL))
258             return nullptr;
259     }
260
261     if (baseURLString.isEmpty())
262         baseURLString = m_frame.document()->baseURL().string();
263     URL baseURL = completeURL(baseURLString);
264
265     RefPtr<Widget> widget;
266     if (allowPlugins(AboutToInstantiatePlugin))
267         widget = m_frame.loader().client().createJavaAppletWidget(size, &element, baseURL, paramNames, paramValues);
268
269     logPluginRequest(document()->page(), element.serviceType(), String(), widget);
270
271     if (!widget) {
272         RenderEmbeddedObject* renderer = element.renderEmbeddedObject();
273
274         if (!renderer->isPluginUnavailable())
275             renderer->setPluginUnavailabilityReason(RenderEmbeddedObject::PluginMissing);
276         return nullptr;
277     }
278
279     m_containsPlugins = true;
280     return widget;
281 }
282
283 Frame* SubframeLoader::loadOrRedirectSubframe(HTMLFrameOwnerElement& ownerElement, const URL& url, const AtomicString& frameName, LockHistory lockHistory, LockBackForwardList lockBackForwardList)
284 {
285     Frame* frame = ownerElement.contentFrame();
286     if (frame)
287         frame->navigationScheduler().scheduleLocationChange(m_frame.document()->securityOrigin(), url, m_frame.loader().outgoingReferrer(), lockHistory, lockBackForwardList);
288     else
289         frame = loadSubframe(ownerElement, url, frameName, m_frame.loader().outgoingReferrer());
290
291     if (!frame)
292         return nullptr;
293
294     ASSERT(ownerElement.contentFrame() == frame || !ownerElement.contentFrame());
295     return ownerElement.contentFrame();
296 }
297
298 Frame* SubframeLoader::loadSubframe(HTMLFrameOwnerElement& ownerElement, const URL& url, const String& name, const String& referrer)
299 {
300     Ref<Frame> protect(m_frame);
301
302     bool allowsScrolling = true;
303     int marginWidth = -1;
304     int marginHeight = -1;
305     if (is<HTMLFrameElementBase>(ownerElement)) {
306         HTMLFrameElementBase& frameElementBase = downcast<HTMLFrameElementBase>(ownerElement);
307         allowsScrolling = frameElementBase.scrollingMode() != ScrollbarAlwaysOff;
308         marginWidth = frameElementBase.marginWidth();
309         marginHeight = frameElementBase.marginHeight();
310     }
311
312     if (!ownerElement.document().securityOrigin()->canDisplay(url)) {
313         FrameLoader::reportLocalLoadFailed(&m_frame, url.string());
314         return nullptr;
315     }
316
317     if (!SubframeLoadingDisabler::canLoadFrame(ownerElement))
318         return nullptr;
319
320     String referrerToUse = SecurityPolicy::generateReferrerHeader(ownerElement.document().referrerPolicy(), url, referrer);
321     RefPtr<Frame> frame = m_frame.loader().client().createFrame(url, name, &ownerElement, referrerToUse, allowsScrolling, marginWidth, marginHeight);
322
323     if (!frame)  {
324         m_frame.loader().checkCallImplicitClose();
325         return nullptr;
326     }
327     
328     // All new frames will have m_isComplete set to true at this point due to synchronously loading
329     // an empty document in FrameLoader::init(). But many frames will now be starting an
330     // asynchronous load of url, so we set m_isComplete to false and then check if the load is
331     // actually completed below. (Note that we set m_isComplete to false even for synchronous
332     // loads, so that checkCompleted() below won't bail early.)
333     // FIXME: Can we remove this entirely? m_isComplete normally gets set to false when a load is committed.
334     frame->loader().started();
335    
336     auto* renderer = ownerElement.renderer();
337     FrameView* view = frame->view();
338     if (is<RenderWidget>(renderer) && view)
339         downcast<RenderWidget>(*renderer).setWidget(view);
340     
341     m_frame.loader().checkCallImplicitClose();
342     
343     // Some loads are performed synchronously (e.g., about:blank and loads
344     // cancelled by returning a null ResourceRequest from requestFromDelegate).
345     // In these cases, the synchronous load would have finished
346     // before we could connect the signals, so make sure to send the 
347     // completed() signal for the child by hand and mark the load as being
348     // complete.
349     // FIXME: In this case the Frame will have finished loading before 
350     // it's being added to the child list. It would be a good idea to
351     // create the child first, then invoke the loader separately.
352     if (frame->loader().state() == FrameStateComplete && !frame->loader().policyDocumentLoader())
353         frame->loader().checkCompleted();
354
355     return frame.get();
356 }
357
358 bool SubframeLoader::allowPlugins(ReasonForCallingAllowPlugins)
359 {
360     return m_frame.settings().arePluginsEnabled();
361 }
362
363 bool SubframeLoader::shouldUsePlugin(const URL& url, const String& mimeType, bool shouldPreferPlugInsForImages, bool hasFallback, bool& useFallback)
364 {
365     if (m_frame.loader().client().shouldAlwaysUsePluginDocument(mimeType)) {
366         useFallback = false;
367         return true;
368     }
369
370     // Allow other plug-ins to win over QuickTime because if the user has installed a plug-in that
371     // can handle TIFF (which QuickTime can also handle) they probably intended to override QT.
372     if (m_frame.page() && (mimeType == "image/tiff" || mimeType == "image/tif" || mimeType == "image/x-tiff")) {
373         String pluginName = m_frame.page()->pluginData().pluginNameForMimeType(mimeType);
374         if (!pluginName.isEmpty() && !pluginName.contains("QuickTime", false)) 
375             return true;
376     }
377         
378     ObjectContentType objectType = m_frame.loader().client().objectContentType(url, mimeType, shouldPreferPlugInsForImages);
379     // If an object's content can't be handled and it has no fallback, let
380     // it be handled as a plugin to show the broken plugin icon.
381     useFallback = objectType == ObjectContentNone && hasFallback;
382     return objectType == ObjectContentNone || objectType == ObjectContentNetscapePlugin || objectType == ObjectContentOtherPlugin;
383 }
384
385 Document* SubframeLoader::document() const
386 {
387     return m_frame.document();
388 }
389
390 bool SubframeLoader::loadPlugin(HTMLPlugInImageElement& pluginElement, const URL& url, const String& mimeType, const Vector<String>& paramNames, const Vector<String>& paramValues, bool useFallback)
391 {
392     RenderEmbeddedObject* renderer = pluginElement.renderEmbeddedObject();
393
394     // FIXME: This code should not depend on renderer!
395     if (!renderer || useFallback)
396         return false;
397
398     pluginElement.subframeLoaderWillCreatePlugIn(url);
399
400     IntSize contentSize = roundedIntSize(LayoutSize(renderer->contentWidth(), renderer->contentHeight()));
401     bool loadManually = is<PluginDocument>(*document()) && !m_containsPlugins && downcast<PluginDocument>(*document()).shouldLoadPluginManually();
402
403 #if PLATFORM(IOS)
404     // On iOS, we only tell the plugin to be in full page mode if the containing plugin document is the top level document.
405     if (document()->ownerElement())
406         loadManually = false;
407 #endif
408
409     RefPtr<Widget> widget = m_frame.loader().client().createPlugin(contentSize, &pluginElement, url, paramNames, paramValues, mimeType, loadManually);
410
411     if (!widget) {
412         if (!renderer->isPluginUnavailable())
413             renderer->setPluginUnavailabilityReason(RenderEmbeddedObject::PluginMissing);
414         return false;
415     }
416
417     pluginElement.subframeLoaderDidCreatePlugIn(*widget);
418     renderer->setWidget(widget);
419     m_containsPlugins = true;
420     return true;
421 }
422
423 URL SubframeLoader::completeURL(const String& url) const
424 {
425     ASSERT(m_frame.document());
426     return m_frame.document()->completeURL(url);
427 }
428
429 } // namespace WebCore