299e47b2ef9fca31ef71b2c308b000ae4db26264
[WebKit-https.git] / Source / WebCore / html / HTMLPlugInElement.cpp
1 /**
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2000 Stefan Schimanski (1Stein@gmx.de)
5  * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #include "config.h"
24 #include "HTMLPlugInElement.h"
25
26 #include "Attribute.h"
27 #include "Chrome.h"
28 #include "ChromeClient.h"
29 #include "CSSPropertyNames.h"
30 #include "Document.h"
31 #include "Frame.h"
32 #include "FrameLoader.h"
33 #include "FrameTree.h"
34 #include "HTMLNames.h"
35 #include "Page.h"
36 #include "RenderEmbeddedObject.h"
37 #include "RenderWidget.h"
38 #include "Settings.h"
39 #include "Widget.h"
40
41 #if ENABLE(NETSCAPE_PLUGIN_API)
42 #include "npruntime_impl.h"
43 #endif
44
45 namespace WebCore {
46
47 using namespace HTMLNames;
48
49 HTMLPlugInElement::HTMLPlugInElement(const QualifiedName& tagName, Document* doc)
50     : HTMLFrameOwnerElement(tagName, doc)
51     , m_inBeforeLoadEventHandler(false)
52 #if ENABLE(NETSCAPE_PLUGIN_API)
53     , m_NPObject(0)
54 #endif
55     , m_isCapturingMouseEvents(false)
56 {
57 }
58
59 HTMLPlugInElement::~HTMLPlugInElement()
60 {
61     ASSERT(!m_instance); // cleared in detach()
62
63 #if ENABLE(NETSCAPE_PLUGIN_API)
64     if (m_NPObject) {
65         _NPN_ReleaseObject(m_NPObject);
66         m_NPObject = 0;
67     }
68 #endif
69 }
70
71 void HTMLPlugInElement::detach()
72 {
73     m_instance.clear();
74
75     if (m_isCapturingMouseEvents) {
76         if (Frame* frame = document()->frame())
77             frame->eventHandler()->setCapturingMouseEventsNode(0);
78         m_isCapturingMouseEvents = false;
79     }
80
81     HTMLFrameOwnerElement::detach();
82 }
83
84 void HTMLPlugInElement::removedFromDocument()
85 {
86 #if ENABLE(NETSCAPE_PLUGIN_API)
87     if (m_NPObject) {
88         _NPN_ReleaseObject(m_NPObject);
89         m_NPObject = 0;
90     }
91 #endif
92
93     HTMLFrameOwnerElement::removedFromDocument();
94 }
95
96 PassScriptInstance HTMLPlugInElement::getInstance()
97 {
98     Frame* frame = document()->frame();
99     if (!frame)
100         return 0;
101
102     // If the host dynamically turns off JavaScript (or Java) we will still return
103     // the cached allocated Bindings::Instance.  Not supporting this edge-case is OK.
104     if (m_instance)
105         return m_instance;
106
107     if (Widget* widget = pluginWidget())
108         m_instance = frame->script()->createScriptInstanceForWidget(widget);
109
110     return m_instance;
111 }
112
113 bool HTMLPlugInElement::guardedDispatchBeforeLoadEvent(const String& sourceURL)
114 {
115     // FIXME: Our current plug-in loading design can't guarantee the following
116     // assertion is true, since plug-in loading can be initiated during layout,
117     // and synchronous layout can be initiated in a beforeload event handler!
118     // See <http://webkit.org/b/71264>.
119     // ASSERT(!m_inBeforeLoadEventHandler);
120     m_inBeforeLoadEventHandler = true;
121     // static_cast is used to avoid a compile error since dispatchBeforeLoadEvent
122     // is intentionally undefined on this class.
123     bool beforeLoadAllowedLoad = static_cast<HTMLFrameOwnerElement*>(this)->dispatchBeforeLoadEvent(sourceURL);
124     m_inBeforeLoadEventHandler = false;
125     return beforeLoadAllowedLoad;
126 }
127
128 Widget* HTMLPlugInElement::pluginWidget()
129 {
130     if (m_inBeforeLoadEventHandler) {
131         // The plug-in hasn't loaded yet, and it makes no sense to try to load if beforeload handler happened to touch the plug-in element.
132         // That would recursively call beforeload for the same element.
133         return 0;
134     }
135
136     RenderWidget* renderWidget = renderWidgetForJSBindings();
137     if (!renderWidget)
138         return 0;
139
140     return renderWidget->widget();
141 }
142
143 bool HTMLPlugInElement::isPresentationAttribute(const QualifiedName& name) const
144 {
145     if (name == widthAttr || name == heightAttr || name == vspaceAttr || name == hspaceAttr || name == alignAttr)
146         return true;
147     return HTMLFrameOwnerElement::isPresentationAttribute(name);
148 }
149
150 void HTMLPlugInElement::collectStyleForAttribute(Attribute* attr, StylePropertySet* style)
151 {
152     if (attr->name() == widthAttr)
153         addHTMLLengthToStyle(style, CSSPropertyWidth, attr->value());
154     else if (attr->name() == heightAttr)
155         addHTMLLengthToStyle(style, CSSPropertyHeight, attr->value());
156     else if (attr->name() == vspaceAttr) {
157         addHTMLLengthToStyle(style, CSSPropertyMarginTop, attr->value());
158         addHTMLLengthToStyle(style, CSSPropertyMarginBottom, attr->value());
159     } else if (attr->name() == hspaceAttr) {
160         addHTMLLengthToStyle(style, CSSPropertyMarginLeft, attr->value());
161         addHTMLLengthToStyle(style, CSSPropertyMarginRight, attr->value());
162     } else if (attr->name() == alignAttr)
163         applyAlignmentAttributeToStyle(attr, style);
164     else
165         HTMLFrameOwnerElement::collectStyleForAttribute(attr, style);
166 }
167
168 void HTMLPlugInElement::defaultEventHandler(Event* event)
169 {
170     // Firefox seems to use a fake event listener to dispatch events to plug-in (tested with mouse events only).
171     // This is observable via different order of events - in Firefox, event listeners specified in HTML attributes fires first, then an event
172     // gets dispatched to plug-in, and only then other event listeners fire. Hopefully, this difference does not matter in practice.
173
174     // FIXME: Mouse down and scroll events are passed down to plug-in via custom code in EventHandler; these code paths should be united.
175
176     RenderObject* r = renderer();
177     if (r && r->isEmbeddedObject() && toRenderEmbeddedObject(r)->showsMissingPluginIndicator()) {
178         toRenderEmbeddedObject(r)->handleMissingPluginIndicatorEvent(event);
179         return;
180     }
181
182     if (!r || !r->isWidget())
183         return;
184     RefPtr<Widget> widget = toRenderWidget(r)->widget();
185     if (!widget)
186         return;
187     widget->handleEvent(event);
188     if (event->defaultHandled())
189         return;
190     HTMLFrameOwnerElement::defaultEventHandler(event);
191 }
192
193 #if ENABLE(NETSCAPE_PLUGIN_API)
194
195 NPObject* HTMLPlugInElement::getNPObject()
196 {
197     ASSERT(document()->frame());
198     if (!m_NPObject)
199         m_NPObject = document()->frame()->script()->createScriptObjectForPluginElement(this);
200     return m_NPObject;
201 }
202
203 #endif /* ENABLE(NETSCAPE_PLUGIN_API) */
204
205 }