7a40add9812f0da13250a8d8a3b8f59457db00c1
[WebKit-https.git] / Source / WebCore / html / HTMLPlugInImageElement.cpp
1 /*
2  * Copyright (C) 2008, 2011, 2012 Apple Inc. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  *
19  */
20
21 #include "config.h"
22 #include "HTMLPlugInImageElement.h"
23
24 #include "Frame.h"
25 #include "FrameLoader.h"
26 #include "FrameLoaderClient.h"
27 #include "HTMLImageLoader.h"
28 #include "HTMLNames.h"
29 #include "Image.h"
30 #include "MouseEvent.h"
31 #include "NodeRenderStyle.h"
32 #include "Page.h"
33 #include "RenderEmbeddedObject.h"
34 #include "RenderImage.h"
35 #include "RenderSnapshottedPlugIn.h"
36 #include "SecurityOrigin.h"
37 #include "Settings.h"
38 #include "StyleResolver.h"
39
40 namespace WebCore {
41
42 // This delay should not exceed the snapshot delay in PluginView.cpp
43 static const double simulatedMouseClickTimerDelay = .75;
44
45 HTMLPlugInImageElement::HTMLPlugInImageElement(const QualifiedName& tagName, Document* document, bool createdByParser, PreferPlugInsForImagesOption preferPlugInsForImagesOption)
46     : HTMLPlugInElement(tagName, document)
47     // m_needsWidgetUpdate(!createdByParser) allows HTMLObjectElement to delay
48     // widget updates until after all children are parsed.  For HTMLEmbedElement
49     // this delay is unnecessary, but it is simpler to make both classes share
50     // the same codepath in this class.
51     , m_needsWidgetUpdate(!createdByParser)
52     , m_shouldPreferPlugInsForImages(preferPlugInsForImagesOption == ShouldPreferPlugInsForImages)
53     , m_needsDocumentActivationCallbacks(false)
54     , m_simulatedMouseClickTimer(this, &HTMLPlugInImageElement::simulatedMouseClickTimerFired, simulatedMouseClickTimerDelay)
55 {
56     setHasCustomCallbacks();
57
58     if (document->page()
59         && document->page()->settings()->plugInSnapshottingEnabled()
60         && !ScriptController::processingUserGesture())
61         setDisplayState(WaitingForSnapshot);
62 }
63
64 HTMLPlugInImageElement::~HTMLPlugInImageElement()
65 {
66     if (m_needsDocumentActivationCallbacks)
67         document()->unregisterForPageCacheSuspensionCallbacks(this);
68 }
69
70 RenderEmbeddedObject* HTMLPlugInImageElement::renderEmbeddedObject() const
71 {
72     // HTMLObjectElement and HTMLEmbedElement may return arbitrary renderers
73     // when using fallback content.
74     if (!renderer() || !renderer()->isEmbeddedObject())
75         return 0;
76     return toRenderEmbeddedObject(renderer());
77 }
78
79 bool HTMLPlugInImageElement::isImageType()
80 {
81     if (m_serviceType.isEmpty() && protocolIs(m_url, "data"))
82         m_serviceType = mimeTypeFromDataURL(m_url);
83
84     if (Frame* frame = document()->frame()) {
85         KURL completedURL = document()->completeURL(m_url);
86         return frame->loader()->client()->objectContentType(completedURL, m_serviceType, shouldPreferPlugInsForImages()) == ObjectContentImage;
87     }
88
89     return Image::supportsType(m_serviceType);
90 }
91
92 // We don't use m_url, as it may not be the final URL that the object loads,
93 // depending on <param> values. 
94 bool HTMLPlugInImageElement::allowedToLoadFrameURL(const String& url)
95 {
96     KURL completeURL = document()->completeURL(url);
97
98     if (contentFrame() && protocolIsJavaScript(completeURL)
99         && !document()->securityOrigin()->canAccess(contentDocument()->securityOrigin()))
100         return false;
101
102     return document()->frame()->isURLAllowed(completeURL);
103 }
104
105 // We don't use m_url, or m_serviceType as they may not be the final values
106 // that <object> uses depending on <param> values. 
107 bool HTMLPlugInImageElement::wouldLoadAsNetscapePlugin(const String& url, const String& serviceType)
108 {
109     ASSERT(document());
110     ASSERT(document()->frame());
111     KURL completedURL;
112     if (!url.isEmpty())
113         completedURL = document()->completeURL(url);
114
115     FrameLoader* frameLoader = document()->frame()->loader();
116     ASSERT(frameLoader);
117     if (frameLoader->client()->objectContentType(completedURL, serviceType, shouldPreferPlugInsForImages()) == ObjectContentNetscapePlugin)
118         return true;
119     return false;
120 }
121
122 RenderObject* HTMLPlugInImageElement::createRenderer(RenderArena* arena, RenderStyle* style)
123 {
124     // Once a PlugIn Element creates its renderer, it needs to be told when the Document goes
125     // inactive or reactivates so it can clear the renderer before going into the page cache.
126     if (!m_needsDocumentActivationCallbacks) {
127         m_needsDocumentActivationCallbacks = true;
128         document()->registerForPageCacheSuspensionCallbacks(this);
129     }
130     
131     // Fallback content breaks the DOM->Renderer class relationship of this
132     // class and all superclasses because createObject won't necessarily
133     // return a RenderEmbeddedObject, RenderPart or even RenderWidget.
134     if (useFallbackContent())
135         return RenderObject::createObject(this, style);
136     if (isImageType()) {
137         RenderImage* image = new (arena) RenderImage(this);
138         image->setImageResource(RenderImageResource::create());
139         return image;
140     }
141
142     if (document()->page() && document()->page()->settings()->plugInSnapshottingEnabled())
143         return new (arena) RenderSnapshottedPlugIn(this);
144     return new (arena) RenderEmbeddedObject(this);
145 }
146
147 bool HTMLPlugInImageElement::willRecalcStyle(StyleChange)
148 {
149     // FIXME: Why is this necessary?  Manual re-attach is almost always wrong.
150     if (!useFallbackContent() && needsWidgetUpdate() && renderer() && !isImageType())
151         reattach();
152     return true;
153 }
154
155 void HTMLPlugInImageElement::attach()
156 {
157     PostAttachCallbackDisabler disabler(this);
158
159     bool isImage = isImageType();
160     
161     if (!isImage)
162         queuePostAttachCallback(&HTMLPlugInImageElement::updateWidgetCallback, this);
163
164     HTMLPlugInElement::attach();
165
166     if (isImage && renderer() && !useFallbackContent()) {
167         if (!m_imageLoader)
168             m_imageLoader = adoptPtr(new HTMLImageLoader(this));
169         m_imageLoader->updateFromElement();
170     }
171 }
172
173 void HTMLPlugInImageElement::detach()
174 {
175     // FIXME: Because of the insanity that is HTMLPlugInImageElement::recalcStyle,
176     // we can end up detaching during an attach() call, before we even have a
177     // renderer.  In that case, don't mark the widget for update.
178     if (attached() && renderer() && !useFallbackContent())
179         // Update the widget the next time we attach (detaching destroys the plugin).
180         setNeedsWidgetUpdate(true);
181     HTMLPlugInElement::detach();
182 }
183
184 void HTMLPlugInImageElement::updateWidgetIfNecessary()
185 {
186     document()->updateStyleIfNeeded();
187
188     if (!needsWidgetUpdate() || useFallbackContent() || isImageType())
189         return;
190
191     if (!renderEmbeddedObject() || renderEmbeddedObject()->showsUnavailablePluginIndicator())
192         return;
193
194     updateWidget(CreateOnlyNonNetscapePlugins);
195 }
196
197 void HTMLPlugInImageElement::finishParsingChildren()
198 {
199     HTMLPlugInElement::finishParsingChildren();
200     if (useFallbackContent())
201         return;
202     
203     setNeedsWidgetUpdate(true);
204     if (inDocument())
205         setNeedsStyleRecalc();    
206 }
207
208 void HTMLPlugInImageElement::didMoveToNewDocument(Document* oldDocument)
209 {
210     if (m_needsDocumentActivationCallbacks) {
211         if (oldDocument)
212             oldDocument->unregisterForPageCacheSuspensionCallbacks(this);
213         document()->registerForPageCacheSuspensionCallbacks(this);
214     }
215
216     if (m_imageLoader)
217         m_imageLoader->elementDidMoveToNewDocument();
218     HTMLPlugInElement::didMoveToNewDocument(oldDocument);
219 }
220
221 void HTMLPlugInImageElement::documentWillSuspendForPageCache()
222 {
223     if (RenderStyle* renderStyle = this->renderStyle()) {
224         m_customStyleForPageCache = RenderStyle::clone(renderStyle);
225         m_customStyleForPageCache->setDisplay(NONE);
226         recalcStyle(Force);
227     }
228
229     HTMLPlugInElement::documentWillSuspendForPageCache();
230 }
231
232 void HTMLPlugInImageElement::documentDidResumeFromPageCache()
233 {
234     if (m_customStyleForPageCache) {
235         m_customStyleForPageCache = 0;
236         recalcStyle(Force);
237     }
238     
239     HTMLPlugInElement::documentDidResumeFromPageCache();
240 }
241
242 PassRefPtr<RenderStyle> HTMLPlugInImageElement::customStyleForRenderer()
243 {
244     if (!m_customStyleForPageCache)
245         return document()->styleResolver()->styleForElement(this);
246     return m_customStyleForPageCache;
247 }
248
249 void HTMLPlugInImageElement::updateWidgetCallback(Node* n, unsigned)
250 {
251     static_cast<HTMLPlugInImageElement*>(n)->updateWidgetIfNecessary();
252 }
253
254 void HTMLPlugInImageElement::updateSnapshot(PassRefPtr<Image> image)
255 {
256     if (displayState() > WaitingForSnapshot || !renderer()->isSnapshottedPlugIn())
257         return;
258
259     toRenderSnapshottedPlugIn(renderer())->updateSnapshot(image);
260     setDisplayState(DisplayingSnapshot);
261 }
262
263 void HTMLPlugInImageElement::setPendingClickEvent(PassRefPtr<MouseEvent> event)
264 {
265     m_pendingClickEventFromSnapshot = event;
266 }
267
268 void HTMLPlugInImageElement::dispatchPendingMouseClick()
269 {
270     ASSERT(!m_simulatedMouseClickTimer.isActive());
271     m_simulatedMouseClickTimer.restart();
272 }
273
274 void HTMLPlugInImageElement::simulatedMouseClickTimerFired(DeferrableOneShotTimer<HTMLPlugInImageElement>*)
275 {
276     ASSERT(displayState() == PlayingWithPendingMouseClick);
277     ASSERT(m_pendingClickEventFromSnapshot);
278
279     dispatchSimulatedClick(m_pendingClickEventFromSnapshot.get(), SendMouseOverUpDownEvents, DoNotShowPressedLook);
280
281     setDisplayState(Playing);
282     m_pendingClickEventFromSnapshot = nullptr;
283 }
284
285 } // namespace WebCore