Make Frame's ScriptController an OwnPtr and remove the #include
[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 Computer, 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 "DiagnosticLoggingKeys.h"
40 #include "Frame.h"
41 #include "FrameLoader.h"
42 #include "FrameLoaderClient.h"
43 #include "HTMLAppletElement.h"
44 #include "HTMLFrameElementBase.h"
45 #include "HTMLNames.h"
46 #include "HTMLPlugInImageElement.h"
47 #include "MIMETypeRegistry.h"
48 #include "Page.h"
49 #include "PluginData.h"
50 #include "PluginDocument.h"
51 #include "RenderEmbeddedObject.h"
52 #include "RenderView.h"
53 #include "ScriptController.h"
54 #include "SecurityOrigin.h"
55 #include "SecurityPolicy.h"
56 #include "Settings.h"
57
58 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
59 #include "HTMLMediaElement.h"
60 #include "RenderVideo.h"
61 #endif
62
63 namespace WebCore {
64     
65 using namespace HTMLNames;
66
67 SubframeLoader::SubframeLoader(Frame* frame)
68     : m_containsPlugins(false)
69     , m_frame(frame)
70 {
71 }
72
73 void SubframeLoader::clear()
74 {
75     m_containsPlugins = false;
76 }
77
78 bool SubframeLoader::requestFrame(HTMLFrameOwnerElement* ownerElement, const String& urlString, const AtomicString& frameName, bool lockHistory, bool lockBackForwardList)
79 {
80     // Support for <frame src="javascript:string">
81     KURL scriptURL;
82     KURL url;
83     if (protocolIsJavaScript(urlString)) {
84         scriptURL = completeURL(urlString); // completeURL() encodes the URL.
85         url = blankURL();
86     } else
87         url = completeURL(urlString);
88
89     Frame* frame = loadOrRedirectSubframe(ownerElement, url, frameName, lockHistory, lockBackForwardList);
90     if (!frame)
91         return false;
92
93     if (!scriptURL.isEmpty())
94         frame->script()->executeIfJavaScriptURL(scriptURL);
95
96     return true;
97 }
98     
99 bool SubframeLoader::resourceWillUsePlugin(const String& url, const String& mimeType, bool shouldPreferPlugInsForImages)
100 {
101     KURL completedURL;
102     if (!url.isEmpty())
103         completedURL = completeURL(url);
104
105     bool useFallback;
106     return shouldUsePlugin(completedURL, mimeType, shouldPreferPlugInsForImages, false, useFallback);
107 }
108
109 bool SubframeLoader::pluginIsLoadable(HTMLPlugInImageElement* pluginElement, const KURL& url, const String& mimeType)
110 {
111     Settings* settings = m_frame->settings();
112     if (!settings)
113         return false;
114
115     if (MIMETypeRegistry::isJavaAppletMIMEType(mimeType)) {
116         if (!settings->isJavaEnabled())
117             return false;
118         if (document() && document()->securityOrigin()->isLocal() && !settings->isJavaEnabledForLocalFiles())
119             return false;
120     }
121
122     if (document()) {
123         if (document()->isSandboxed(SandboxPlugins))
124             return false;
125
126         if (!document()->securityOrigin()->canDisplay(url)) {
127             FrameLoader::reportLocalLoadFailed(m_frame, url.string());
128             return false;
129         }
130
131         String declaredMimeType = document()->isPluginDocument() && document()->ownerElement() ?
132             document()->ownerElement()->fastGetAttribute(HTMLNames::typeAttr) :
133             pluginElement->fastGetAttribute(HTMLNames::typeAttr);
134         if (!document()->contentSecurityPolicy()->allowObjectFromSource(url)
135             || !document()->contentSecurityPolicy()->allowPluginType(mimeType, declaredMimeType, url)) {
136             RenderEmbeddedObject* renderer = pluginElement->renderEmbeddedObject();
137             renderer->setPluginUnavailabilityReason(RenderEmbeddedObject::PluginBlockedByContentSecurityPolicy);
138             return false;
139         }
140
141         if (m_frame->loader() && !m_frame->loader()->mixedContentChecker()->canRunInsecureContent(document()->securityOrigin(), url))
142             return false;
143     }
144
145     return true;
146 }
147
148 bool SubframeLoader::requestPlugin(HTMLPlugInImageElement* ownerElement, const KURL& url, const String& mimeType, const Vector<String>& paramNames, const Vector<String>& paramValues, bool useFallback)
149 {
150
151     // Application plug-ins are plug-ins implemented by the user agent, for example Qt plug-ins,
152     // as opposed to third-party code such as Flash. The user agent decides whether or not they are
153     // permitted, rather than WebKit.
154     if ((!allowPlugins(AboutToInstantiatePlugin) && !MIMETypeRegistry::isApplicationPluginMIMEType(mimeType)))
155         return false;
156
157     if (!pluginIsLoadable(ownerElement, url, mimeType))
158         return false;
159
160     ASSERT(ownerElement->hasTagName(objectTag) || ownerElement->hasTagName(embedTag));
161     return loadPlugin(ownerElement, url, mimeType, paramNames, paramValues, useFallback);
162 }
163
164 static String findPluginMIMETypeFromURL(Page* page, const String& url)
165 {
166     if (!url)
167         return String();
168
169     size_t dotIndex = url.reverseFind('.');
170     if (dotIndex == notFound)
171         return String();
172
173     String extension = url.substring(dotIndex + 1);
174
175     PluginData* pluginData = page->pluginData();
176     if (!pluginData)
177         return String();
178
179     for (size_t i = 0; i < pluginData->mimes().size(); ++i) {
180         const MimeClassInfo& mimeClassInfo = pluginData->mimes()[i];
181         for (size_t j = 0; j < mimeClassInfo.extensions.size(); ++j) {
182             if (equalIgnoringCase(extension, mimeClassInfo.extensions[j]))
183                 return mimeClassInfo.type;
184         }
185     }
186
187     return String();
188 }
189
190 static void logPluginRequest(Page* page, const String& mimeType, const String& url, bool success)
191 {
192     if (!page || !page->settings()->diagnosticLoggingEnabled())
193         return;
194
195     String newMIMEType = mimeType;
196     if (!newMIMEType) {
197         // Try to figure out the MIME type from the URL extension.
198         newMIMEType = findPluginMIMETypeFromURL(page, url);
199         if (!newMIMEType)
200             return;
201     }
202
203     PluginData* pluginData = page->pluginData();
204     String pluginFile = pluginData ? pluginData->pluginFileForMimeType(newMIMEType) : String();
205     String description = !pluginFile ? newMIMEType : pluginFile;
206
207     ChromeClient* client = page->chrome()->client();
208     client->logDiagnosticMessage(success ? DiagnosticLoggingKeys::pluginLoadedKey() : DiagnosticLoggingKeys::pluginLoadingFailedKey(), description, DiagnosticLoggingKeys::noopKey());
209
210     if (!page->hasSeenAnyPlugin())
211         client->logDiagnosticMessage(DiagnosticLoggingKeys::pageContainsAtLeastOnePluginKey(), emptyString(), DiagnosticLoggingKeys::noopKey());
212     
213     if (!page->hasSeenPlugin(description))
214         client->logDiagnosticMessage(DiagnosticLoggingKeys::pageContainsPluginKey(), description, DiagnosticLoggingKeys::noopKey());
215
216     page->sawPlugin(description);
217 }
218
219 bool SubframeLoader::requestObject(HTMLPlugInImageElement* ownerElement, const String& url, const AtomicString& frameName, const String& mimeType, const Vector<String>& paramNames, const Vector<String>& paramValues)
220 {
221     if (url.isEmpty() && mimeType.isEmpty())
222         return false;
223
224     // FIXME: None of this code should use renderers!
225     RenderEmbeddedObject* renderer = ownerElement->renderEmbeddedObject();
226     ASSERT(renderer);
227     if (!renderer)
228         return false;
229
230     KURL completedURL;
231     if (!url.isEmpty())
232         completedURL = completeURL(url);
233
234     bool useFallback;
235     if (shouldUsePlugin(completedURL, mimeType, ownerElement->shouldPreferPlugInsForImages(), renderer->hasFallbackContent(), useFallback)) {
236         bool success = requestPlugin(ownerElement, completedURL, mimeType, paramNames, paramValues, useFallback);
237         logPluginRequest(document()->page(), mimeType, completedURL, success);
238         return success;
239     }
240
241     // If the plug-in element already contains a subframe, loadOrRedirectSubframe will re-use it. Otherwise,
242     // it will create a new frame and set it as the RenderPart's widget, causing what was previously 
243     // in the widget to be torn down.
244     return loadOrRedirectSubframe(ownerElement, completedURL, frameName, true, true);
245 }
246
247 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
248 PassRefPtr<Widget> SubframeLoader::loadMediaPlayerProxyPlugin(Node* node, const KURL& url,
249     const Vector<String>& paramNames, const Vector<String>& paramValues)
250 {
251     ASSERT(node->hasTagName(videoTag) || node->hasTagName(audioTag));
252
253     KURL completedURL;
254     if (!url.isEmpty())
255         completedURL = completeURL(url);
256
257     if (!m_frame->document()->securityOrigin()->canDisplay(completedURL)) {
258         FrameLoader::reportLocalLoadFailed(m_frame, completedURL.string());
259         return 0;
260     }
261
262     if (!m_frame->document()->contentSecurityPolicy()->allowMediaFromSource(completedURL))
263         return 0;
264
265     HTMLMediaElement* mediaElement = static_cast<HTMLMediaElement*>(node);
266     RenderPart* renderer = toRenderPart(node->renderer());
267     IntSize size;
268
269     if (renderer)
270         size = roundedIntSize(LayoutSize(renderer->contentWidth(), renderer->contentHeight()));
271     else if (mediaElement->isVideo())
272         size = RenderVideo::defaultSize();
273
274     if (!m_frame->loader()->mixedContentChecker()->canRunInsecureContent(m_frame->document()->securityOrigin(), completedURL))
275         return 0;
276
277     RefPtr<Widget> widget = m_frame->loader()->client()->createMediaPlayerProxyPlugin(size, mediaElement, completedURL,
278                                          paramNames, paramValues, "application/x-media-element-proxy-plugin");
279
280     if (widget && renderer) {
281         renderer->setWidget(widget);
282         renderer->node()->setNeedsStyleRecalc(SyntheticStyleChange);
283     }
284     m_containsPlugins = true;
285
286     return widget ? widget.release() : 0;
287 }
288 #endif // ENABLE(PLUGIN_PROXY_FOR_VIDEO)
289
290 PassRefPtr<Widget> SubframeLoader::createJavaAppletWidget(const IntSize& size, HTMLAppletElement* element, const Vector<String>& paramNames, const Vector<String>& paramValues)
291 {
292     String baseURLString;
293     String codeBaseURLString;
294
295     for (size_t i = 0; i < paramNames.size(); ++i) {
296         if (equalIgnoringCase(paramNames[i], "baseurl"))
297             baseURLString = paramValues[i];
298         else if (equalIgnoringCase(paramNames[i], "codebase"))
299             codeBaseURLString = paramValues[i];
300     }
301
302     if (!codeBaseURLString.isEmpty()) {
303         KURL codeBaseURL = completeURL(codeBaseURLString);
304         if (!element->document()->securityOrigin()->canDisplay(codeBaseURL)) {
305             FrameLoader::reportLocalLoadFailed(m_frame, codeBaseURL.string());
306             return 0;
307         }
308
309         const char javaAppletMimeType[] = "application/x-java-applet";
310         if (!element->document()->contentSecurityPolicy()->allowObjectFromSource(codeBaseURL)
311             || !element->document()->contentSecurityPolicy()->allowPluginType(javaAppletMimeType, javaAppletMimeType, codeBaseURL))
312             return 0;
313     }
314
315     if (baseURLString.isEmpty())
316         baseURLString = m_frame->document()->baseURL().string();
317     KURL baseURL = completeURL(baseURLString);
318
319     RefPtr<Widget> widget;
320     if (allowPlugins(AboutToInstantiatePlugin))
321         widget = m_frame->loader()->client()->createJavaAppletWidget(size, element, baseURL, paramNames, paramValues);
322
323     logPluginRequest(document()->page(), element->serviceType(), String(), widget);
324
325     if (!widget) {
326         RenderEmbeddedObject* renderer = element->renderEmbeddedObject();
327
328         if (!renderer->showsUnavailablePluginIndicator())
329             renderer->setPluginUnavailabilityReason(RenderEmbeddedObject::PluginMissing);
330         return 0;
331     }
332
333     m_containsPlugins = true;
334     return widget;
335 }
336
337 Frame* SubframeLoader::loadOrRedirectSubframe(HTMLFrameOwnerElement* ownerElement, const KURL& url, const AtomicString& frameName, bool lockHistory, bool lockBackForwardList)
338 {
339     Frame* frame = ownerElement->contentFrame();
340     if (frame)
341         frame->navigationScheduler()->scheduleLocationChange(m_frame->document()->securityOrigin(), url.string(), m_frame->loader()->outgoingReferrer(), lockHistory, lockBackForwardList);
342     else
343         frame = loadSubframe(ownerElement, url, frameName, m_frame->loader()->outgoingReferrer());
344
345     ASSERT(ownerElement->contentFrame() == frame || !ownerElement->contentFrame());
346     return ownerElement->contentFrame();
347 }
348
349 Frame* SubframeLoader::loadSubframe(HTMLFrameOwnerElement* ownerElement, const KURL& url, const String& name, const String& referrer)
350 {
351     RefPtr<Frame> protect(m_frame);
352
353     bool allowsScrolling = true;
354     int marginWidth = -1;
355     int marginHeight = -1;
356     if (ownerElement->hasTagName(frameTag) || ownerElement->hasTagName(iframeTag)) {
357         HTMLFrameElementBase* o = static_cast<HTMLFrameElementBase*>(ownerElement);
358         allowsScrolling = o->scrollingMode() != ScrollbarAlwaysOff;
359         marginWidth = o->marginWidth();
360         marginHeight = o->marginHeight();
361     }
362
363     if (!ownerElement->document()->securityOrigin()->canDisplay(url)) {
364         FrameLoader::reportLocalLoadFailed(m_frame, url.string());
365         return 0;
366     }
367
368     String referrerToUse = SecurityPolicy::generateReferrerHeader(ownerElement->document()->referrerPolicy(), url, referrer);
369     RefPtr<Frame> frame = m_frame->loader()->client()->createFrame(url, name, ownerElement, referrerToUse, allowsScrolling, marginWidth, marginHeight);
370
371     if (!frame)  {
372         m_frame->loader()->checkCallImplicitClose();
373         return 0;
374     }
375     
376     // All new frames will have m_isComplete set to true at this point due to synchronously loading
377     // an empty document in FrameLoader::init(). But many frames will now be starting an
378     // asynchronous load of url, so we set m_isComplete to false and then check if the load is
379     // actually completed below. (Note that we set m_isComplete to false even for synchronous
380     // loads, so that checkCompleted() below won't bail early.)
381     // FIXME: Can we remove this entirely? m_isComplete normally gets set to false when a load is committed.
382     frame->loader()->started();
383    
384     RenderObject* renderer = ownerElement->renderer();
385     FrameView* view = frame->view();
386     if (renderer && renderer->isWidget() && view)
387         toRenderWidget(renderer)->setWidget(view);
388     
389     m_frame->loader()->checkCallImplicitClose();
390     
391     // Some loads are performed synchronously (e.g., about:blank and loads
392     // cancelled by returning a null ResourceRequest from requestFromDelegate).
393     // In these cases, the synchronous load would have finished
394     // before we could connect the signals, so make sure to send the 
395     // completed() signal for the child by hand and mark the load as being
396     // complete.
397     // FIXME: In this case the Frame will have finished loading before 
398     // it's being added to the child list. It would be a good idea to
399     // create the child first, then invoke the loader separately.
400     if (frame->loader()->state() == FrameStateComplete && !frame->loader()->policyDocumentLoader())
401         frame->loader()->checkCompleted();
402
403     return frame.get();
404 }
405
406 bool SubframeLoader::allowPlugins(ReasonForCallingAllowPlugins reason)
407 {
408     Settings* settings = m_frame->settings();
409     bool allowed = m_frame->loader()->client()->allowPlugins(settings && settings->arePluginsEnabled());
410     if (!allowed && reason == AboutToInstantiatePlugin)
411         m_frame->loader()->client()->didNotAllowPlugins();
412     return allowed;
413 }
414
415 bool SubframeLoader::shouldUsePlugin(const KURL& url, const String& mimeType, bool shouldPreferPlugInsForImages, bool hasFallback, bool& useFallback)
416 {
417     if (m_frame->loader()->client()->shouldUsePluginDocument(mimeType)) {
418         useFallback = false;
419         return true;
420     }
421
422     // Allow other plug-ins to win over QuickTime because if the user has installed a plug-in that
423     // can handle TIFF (which QuickTime can also handle) they probably intended to override QT.
424     if (m_frame->page() && (mimeType == "image/tiff" || mimeType == "image/tif" || mimeType == "image/x-tiff")) {
425         const PluginData* pluginData = m_frame->page()->pluginData();
426         String pluginName = pluginData ? pluginData->pluginNameForMimeType(mimeType) : String();
427         if (!pluginName.isEmpty() && !pluginName.contains("QuickTime", false)) 
428             return true;
429     }
430         
431     ObjectContentType objectType = m_frame->loader()->client()->objectContentType(url, mimeType, shouldPreferPlugInsForImages);
432     // If an object's content can't be handled and it has no fallback, let
433     // it be handled as a plugin to show the broken plugin icon.
434     useFallback = objectType == ObjectContentNone && hasFallback;
435     return objectType == ObjectContentNone || objectType == ObjectContentNetscapePlugin || objectType == ObjectContentOtherPlugin;
436 }
437
438 Document* SubframeLoader::document() const
439 {
440     return m_frame->document();
441 }
442
443 bool SubframeLoader::loadPlugin(HTMLPlugInImageElement* pluginElement, const KURL& url, const String& mimeType,
444     const Vector<String>& paramNames, const Vector<String>& paramValues, bool useFallback)
445 {
446     RenderEmbeddedObject* renderer = pluginElement->renderEmbeddedObject();
447
448     // FIXME: This code should not depend on renderer!
449     if (!renderer || useFallback)
450         return false;
451
452     pluginElement->subframeLoaderWillCreatePlugIn(url);
453
454     IntSize contentSize = roundedIntSize(LayoutSize(renderer->contentWidth(), renderer->contentHeight()));
455     bool loadManually = document()->isPluginDocument() && !m_containsPlugins && toPluginDocument(document())->shouldLoadPluginManually();
456     RefPtr<Widget> widget = m_frame->loader()->client()->createPlugin(contentSize,
457         pluginElement, url, paramNames, paramValues, mimeType, loadManually);
458
459     if (!widget) {
460         if (!renderer->showsUnavailablePluginIndicator())
461             renderer->setPluginUnavailabilityReason(RenderEmbeddedObject::PluginMissing);
462         return false;
463     }
464
465     pluginElement->subframeLoaderDidCreatePlugIn(widget.get());
466     renderer->setWidget(widget);
467     m_containsPlugins = true;
468  
469 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
470     pluginElement->setNeedsStyleRecalc(SyntheticStyleChange);
471 #endif
472     return true;
473 }
474
475 KURL SubframeLoader::completeURL(const String& url) const
476 {
477     ASSERT(m_frame->document());
478     return m_frame->document()->completeURL(url);
479 }
480
481 } // namespace WebCore