WebCore: HTML5 Conformance Test failure: approved/xhtml5/object_border_pixel.xhtml
[WebKit-https.git] / WebCore / html / HTMLObjectElement.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, 2007, 2008, 2009 Apple Inc. All rights reserved.
6  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23
24 #include "config.h"
25 #include "HTMLObjectElement.h"
26
27 #include "Attribute.h"
28 #include "CSSValueKeywords.h"
29 #include "EventNames.h"
30 #include "ExceptionCode.h"
31 #include "Frame.h"
32 #include "HTMLDocument.h"
33 #include "HTMLFormElement.h"
34 #include "HTMLImageLoader.h"
35 #include "HTMLNames.h"
36 #include "HTMLParamElement.h"
37 #include "HTMLParserIdioms.h"
38 #include "MIMETypeRegistry.h"
39 #include "RenderEmbeddedObject.h"
40 #include "RenderImage.h"
41 #include "RenderWidget.h"
42 #include "ScriptController.h"
43 #include "ScriptEventListener.h"
44 #include "Text.h"
45
46 namespace WebCore {
47
48 using namespace HTMLNames;
49
50 inline HTMLObjectElement::HTMLObjectElement(const QualifiedName& tagName, Document* document, HTMLFormElement* form, bool createdByParser) 
51     : HTMLPlugInImageElement(tagName, document, createdByParser)
52     , FormAssociatedElement(form)
53     , m_docNamedItem(true)
54     , m_useFallbackContent(false)
55 {
56     ASSERT(hasTagName(objectTag));
57     if (!this->form())
58         setForm(findFormAncestor());
59     if (this->form())
60         this->form()->registerFormElement(this);
61 }
62
63 inline HTMLObjectElement::~HTMLObjectElement()
64 {
65     if (form())
66         form()->removeFormElement(this);
67 }
68
69 PassRefPtr<HTMLObjectElement> HTMLObjectElement::create(const QualifiedName& tagName, Document* document, HTMLFormElement* form, bool createdByParser)
70 {
71     return adoptRef(new HTMLObjectElement(tagName, document, form, createdByParser));
72 }
73
74 RenderWidget* HTMLObjectElement::renderWidgetForJSBindings() const
75 {
76     document()->updateLayoutIgnorePendingStylesheets();
77     return renderPart(); // This will return 0 if the renderer is not a RenderPart.
78 }
79
80 void HTMLObjectElement::parseMappedAttribute(Attribute* attr)
81 {
82     if (attr->name() == typeAttr) {
83         m_serviceType = attr->value().lower();
84         size_t pos = m_serviceType.find(";");
85         if (pos != notFound)
86             m_serviceType = m_serviceType.left(pos);
87         if (renderer())
88             setNeedsWidgetUpdate(true);
89         if (!isImageType() && m_imageLoader)
90             m_imageLoader.clear();
91     } else if (attr->name() == dataAttr) {
92         m_url = stripLeadingAndTrailingHTMLSpaces(attr->value());
93         if (renderer()) {
94             setNeedsWidgetUpdate(true);
95             if (isImageType()) {
96                 if (!m_imageLoader)
97                     m_imageLoader = adoptPtr(new HTMLImageLoader(this));
98                 m_imageLoader->updateFromElementIgnoringPreviousError();
99             }
100         }
101     } else if (attr->name() == classidAttr) {
102         m_classId = attr->value();
103         if (renderer())
104             setNeedsWidgetUpdate(true);
105     } else if (attr->name() == onloadAttr)
106         setAttributeEventListener(eventNames().loadEvent, createAttributeEventListener(this, attr));
107     else if (attr->name() == onbeforeloadAttr)
108         setAttributeEventListener(eventNames().beforeloadEvent, createAttributeEventListener(this, attr));
109     else if (attr->name() == nameAttr) {
110         const AtomicString& newName = attr->value();
111         if (isDocNamedItem() && inDocument() && document()->isHTMLDocument()) {
112             HTMLDocument* document = static_cast<HTMLDocument*>(this->document());
113             document->removeNamedItem(m_name);
114             document->addNamedItem(newName);
115         }
116         m_name = newName;
117     } else if (attr->name() == borderAttr) {
118         addCSSLength(attr, CSSPropertyBorderWidth, attr->value().toInt() ? attr->value() : "0");
119         addCSSProperty(attr, CSSPropertyBorderTopStyle, CSSValueSolid);
120         addCSSProperty(attr, CSSPropertyBorderRightStyle, CSSValueSolid);
121         addCSSProperty(attr, CSSPropertyBorderBottomStyle, CSSValueSolid);
122         addCSSProperty(attr, CSSPropertyBorderLeftStyle, CSSValueSolid);
123     } else if (isIdAttributeName(attr->name())) {
124         const AtomicString& newId = attr->value();
125         if (isDocNamedItem() && inDocument() && document()->isHTMLDocument()) {
126             HTMLDocument* document = static_cast<HTMLDocument*>(this->document());
127             document->removeExtraNamedItem(m_id);
128             document->addExtraNamedItem(newId);
129         }
130         m_id = newId;
131         // also call superclass
132         HTMLPlugInImageElement::parseMappedAttribute(attr);
133     } else
134         HTMLPlugInImageElement::parseMappedAttribute(attr);
135 }
136
137 static void mapDataParamToSrc(Vector<String>* paramNames, Vector<String>* paramValues)
138 {
139     // Some plugins don't understand the "data" attribute of the OBJECT tag (i.e. Real and WMP
140     // require "src" attribute).
141     int srcIndex = -1, dataIndex = -1;
142     for (unsigned int i = 0; i < paramNames->size(); ++i) {
143         if (equalIgnoringCase((*paramNames)[i], "src"))
144             srcIndex = i;
145         else if (equalIgnoringCase((*paramNames)[i], "data"))
146             dataIndex = i;
147     }
148     
149     if (srcIndex == -1 && dataIndex != -1) {
150         paramNames->append("src");
151         paramValues->append((*paramValues)[dataIndex]);
152     }
153 }
154
155 // FIXME: This function should not deal with url or serviceType!
156 void HTMLObjectElement::parametersForPlugin(Vector<String>& paramNames, Vector<String>& paramValues, String& url, String& serviceType)
157 {
158     HashSet<StringImpl*, CaseFoldingHash> uniqueParamNames;
159     String urlParameter;
160     
161     // Scan the PARAM children and store their name/value pairs.
162     // Get the URL and type from the params if we don't already have them.
163     for (Node* child = firstChild(); child; child = child->nextSibling()) {
164         if (!child->hasTagName(paramTag))
165             continue;
166
167         HTMLParamElement* p = static_cast<HTMLParamElement*>(child);
168         String name = p->name();
169         if (name.isEmpty())
170             continue;
171
172         uniqueParamNames.add(name.impl());
173         paramNames.append(p->name());
174         paramValues.append(p->value());
175
176         // FIXME: url adjustment does not belong in this function.
177         if (url.isEmpty() && urlParameter.isEmpty() && (equalIgnoringCase(name, "src") || equalIgnoringCase(name, "movie") || equalIgnoringCase(name, "code") || equalIgnoringCase(name, "url")))
178             urlParameter = stripLeadingAndTrailingHTMLSpaces(p->value());
179         // FIXME: serviceType calculation does not belong in this function.
180         if (serviceType.isEmpty() && equalIgnoringCase(name, "type")) {
181             serviceType = p->value();
182             size_t pos = serviceType.find(";");
183             if (pos != notFound)
184                 serviceType = serviceType.left(pos);
185         }
186     }
187     
188     // When OBJECT is used for an applet via Sun's Java plugin, the CODEBASE attribute in the tag
189     // points to the Java plugin itself (an ActiveX component) while the actual applet CODEBASE is
190     // in a PARAM tag. See <http://java.sun.com/products/plugin/1.2/docs/tags.html>. This means
191     // we have to explicitly suppress the tag's CODEBASE attribute if there is none in a PARAM,
192     // else our Java plugin will misinterpret it. [4004531]
193     String codebase;
194     if (MIMETypeRegistry::isJavaAppletMIMEType(serviceType)) {
195         codebase = "codebase";
196         uniqueParamNames.add(codebase.impl()); // pretend we found it in a PARAM already
197     }
198     
199     // Turn the attributes of the <object> element into arrays, but don't override <param> values.
200     NamedNodeMap* attributes = this->attributes(true);
201     if (attributes) {
202         for (unsigned i = 0; i < attributes->length(); ++i) {
203             Attribute* it = attributes->attributeItem(i);
204             const AtomicString& name = it->name().localName();
205             if (!uniqueParamNames.contains(name.impl())) {
206                 paramNames.append(name.string());
207                 paramValues.append(it->value().string());
208             }
209         }
210     }
211     
212     mapDataParamToSrc(&paramNames, &paramValues);
213     
214     // HTML5 says that an object resource's URL is specified by the object's data
215     // attribute, not by a param element. However, for compatibility, allow the
216     // resource's URL to be given by a param named "src", "movie", "code" or "url"
217     // if we know that resource points to a plug-in.
218     if (url.isEmpty() && !urlParameter.isEmpty()) {
219         SubframeLoader* loader = document()->frame()->loader()->subframeLoader();
220         if (loader->resourceWillUsePlugin(urlParameter, serviceType))
221             url = urlParameter;
222     }
223 }
224
225     
226 bool HTMLObjectElement::hasFallbackContent() const
227 {
228     for (Node* child = firstChild(); child; child = child->nextSibling()) {
229         // Ignore whitespace-only text, and <param> tags, any other content is fallback content.
230         if (child->isTextNode()) {
231             if (!static_cast<Text*>(child)->containsOnlyWhitespace())
232                 return true;
233         } else if (!child->hasTagName(paramTag))
234             return true;
235     }
236     return false;
237 }
238     
239 bool HTMLObjectElement::hasValidClassId()
240 {
241     // HTML5 says that fallback content should be rendered if a non-empty
242     // classid is specified for which the UA can't find a suitable plug-in.
243     // WebKit supports no classids, with the exception of Qt plug-ins, which use
244     // classid to specify which QObject to load.
245 #if PLATFORM(QT)
246     return classId().isEmpty() || equalIgnoringCase(serviceType(), "application/x-qt-plugin");
247 #else
248     return classId().isEmpty();
249 #endif
250 }
251
252 // FIXME: This should be unified with HTMLEmbedElement::updateWidget and
253 // moved down into HTMLPluginImageElement.cpp
254 void HTMLObjectElement::updateWidget(bool onlyCreateNonNetscapePlugins)
255 {
256     ASSERT(!renderEmbeddedObject()->pluginCrashedOrWasMissing());
257     // FIXME: We should ASSERT(needsWidgetUpdate()), but currently
258     // FrameView::updateWidget() calls updateWidget(false) without checking if
259     // the widget actually needs updating!
260     setNeedsWidgetUpdate(false);
261     // FIXME: This should ASSERT isFinishedParsingChildren() instead.
262     if (!isFinishedParsingChildren())
263         return;
264     
265     String url = this->url();
266     String serviceType = this->serviceType();
267
268     // FIXME: These should be joined into a PluginParameters class.
269     Vector<String> paramNames;
270     Vector<String> paramValues;
271     parametersForPlugin(paramNames, paramValues, url, serviceType);
272
273     // Note: url is modified above by parametersForPlugin.
274     if (!allowedToLoadFrameURL(url))
275         return;
276
277     bool fallbackContent = hasFallbackContent();
278     renderEmbeddedObject()->setHasFallbackContent(fallbackContent);
279
280     if (onlyCreateNonNetscapePlugins && wouldLoadAsNetscapePlugin(url, serviceType))
281         return;
282
283     ASSERT(!m_inBeforeLoadEventHandler);
284     m_inBeforeLoadEventHandler = true;
285     bool beforeLoadAllowedLoad = dispatchBeforeLoadEvent(url);
286     m_inBeforeLoadEventHandler = false;
287
288     // beforeload events can modify the DOM, potentially causing
289     // RenderWidget::destroy() to be called.  Ensure we haven't been
290     // destroyed before continuing.
291     // FIXME: Should this render fallback content?
292     if (!renderer())
293         return;
294
295     SubframeLoader* loader = document()->frame()->loader()->subframeLoader();
296     bool success = beforeLoadAllowedLoad && hasValidClassId() && loader->requestObject(this, url, getAttribute(nameAttr), serviceType, paramNames, paramValues);
297
298     if (!success && fallbackContent)
299         renderFallbackContent();
300 }
301
302 bool HTMLObjectElement::rendererIsNeeded(RenderStyle* style)
303 {
304     // FIXME: This check should not be needed, detached documents never render!
305     Frame* frame = document()->frame();
306     if (!frame)
307         return false;
308
309     return HTMLPlugInImageElement::rendererIsNeeded(style);
310 }
311
312 void HTMLObjectElement::insertedIntoDocument()
313 {
314     if (isDocNamedItem() && document()->isHTMLDocument()) {
315         HTMLDocument* document = static_cast<HTMLDocument*>(this->document());
316         document->addNamedItem(m_name);
317         document->addExtraNamedItem(m_id);
318     }
319
320     HTMLPlugInImageElement::insertedIntoDocument();
321 }
322
323 void HTMLObjectElement::removedFromDocument()
324 {
325     if (isDocNamedItem() && document()->isHTMLDocument()) {
326         HTMLDocument* document = static_cast<HTMLDocument*>(this->document());
327         document->removeNamedItem(m_name);
328         document->removeExtraNamedItem(m_id);
329     }
330
331     HTMLPlugInImageElement::removedFromDocument();
332 }
333
334 void HTMLObjectElement::attributeChanged(Attribute* attr, bool preserveDecls)
335 {
336     if (attr->name() == formAttr)
337         formAttributeChanged();
338     else
339         HTMLPlugInImageElement::attributeChanged(attr, preserveDecls);
340 }
341
342 void HTMLObjectElement::childrenChanged(bool changedByParser, Node* beforeChange, Node* afterChange, int childCountDelta)
343 {
344     updateDocNamedItem();
345     if (inDocument() && !useFallbackContent()) {
346         setNeedsWidgetUpdate(true);
347         setNeedsStyleRecalc();
348     }
349     HTMLPlugInImageElement::childrenChanged(changedByParser, beforeChange, afterChange, childCountDelta);
350 }
351
352 bool HTMLObjectElement::isURLAttribute(Attribute *attr) const
353 {
354     return (attr->name() == dataAttr || (attr->name() == usemapAttr && attr->value().string()[0] != '#'));
355 }
356
357 const QualifiedName& HTMLObjectElement::imageSourceAttributeName() const
358 {
359     return dataAttr;
360 }
361
362 void HTMLObjectElement::renderFallbackContent()
363 {
364     if (useFallbackContent())
365         return;
366     
367     if (!inDocument())
368         return;
369
370     // Before we give up and use fallback content, check to see if this is a MIME type issue.
371     if (m_imageLoader && m_imageLoader->image() && m_imageLoader->image()->status() != CachedResource::LoadError) {
372         m_serviceType = m_imageLoader->image()->response().mimeType();
373         if (!isImageType()) {
374             // If we don't think we have an image type anymore, then ditch the image loader.
375             m_imageLoader.clear();        
376             detach();
377             attach();
378             return;
379         }
380     }
381
382     m_useFallbackContent = true;
383
384     // FIXME: Style gets recalculated which is suboptimal.
385     detach();
386     attach();
387 }
388
389 // FIXME: This should be removed, all callers are almost certainly wrong.
390 static bool isRecognizedTagName(const QualifiedName& tagName)
391 {
392     DEFINE_STATIC_LOCAL(HashSet<AtomicStringImpl*>, tagList, ());
393     if (tagList.isEmpty()) {
394         size_t tagCount = 0;
395         QualifiedName** tags = HTMLNames::getHTMLTags(&tagCount);
396         for (size_t i = 0; i < tagCount; i++) {
397             if (*tags[i] == bgsoundTag
398                 || *tags[i] == commandTag
399                 || *tags[i] == detailsTag
400                 || *tags[i] == figcaptionTag
401                 || *tags[i] == figureTag
402                 || *tags[i] == summaryTag
403                 || *tags[i] == trackTag) {
404                 // Even though we have atoms for these tags, we don't want to
405                 // treat them as "recognized tags" for the purpose of parsing
406                 // because that changes how we parse documents.
407                 continue;
408             }
409             tagList.add(tags[i]->localName().impl());
410         }
411     }
412     return tagList.contains(tagName.localName().impl());
413 }
414
415 void HTMLObjectElement::updateDocNamedItem()
416 {
417     // The rule is "<object> elements with no children other than
418     // <param> elements, unknown elements and whitespace can be
419     // found by name in a document, and other <object> elements cannot."
420     bool wasNamedItem = m_docNamedItem;
421     bool isNamedItem = true;
422     Node* child = firstChild();
423     while (child && isNamedItem) {
424         if (child->isElementNode()) {
425             Element* element = static_cast<Element*>(child);
426             // FIXME: Use of isRecognizedTagName is almost certainly wrong here.
427             if (isRecognizedTagName(element->tagQName()) && !element->hasTagName(paramTag))
428                 isNamedItem = false;
429         } else if (child->isTextNode()) {
430             if (!static_cast<Text*>(child)->containsOnlyWhitespace())
431                 isNamedItem = false;
432         } else
433             isNamedItem = false;
434         child = child->nextSibling();
435     }
436     if (isNamedItem != wasNamedItem && document()->isHTMLDocument()) {
437         HTMLDocument* document = static_cast<HTMLDocument*>(this->document());
438         if (isNamedItem) {
439             document->addNamedItem(m_name);
440             document->addExtraNamedItem(m_id);
441         } else {
442             document->removeNamedItem(m_name);
443             document->removeExtraNamedItem(m_id);
444         }
445     }
446     m_docNamedItem = isNamedItem;
447 }
448
449 bool HTMLObjectElement::containsJavaApplet() const
450 {
451     if (MIMETypeRegistry::isJavaAppletMIMEType(getAttribute(typeAttr)))
452         return true;
453         
454     for (Element* child = firstElementChild(); child; child = child->nextElementSibling()) {
455         if (child->hasTagName(paramTag)
456                 && equalIgnoringCase(child->getAttribute(nameAttr), "type")
457                 && MIMETypeRegistry::isJavaAppletMIMEType(child->getAttribute(valueAttr).string()))
458             return true;
459         if (child->hasTagName(objectTag)
460                 && static_cast<HTMLObjectElement*>(child)->containsJavaApplet())
461             return true;
462         if (child->hasTagName(appletTag))
463             return true;
464     }
465     
466     return false;
467 }
468
469 void HTMLObjectElement::addSubresourceAttributeURLs(ListHashSet<KURL>& urls) const
470 {
471     HTMLPlugInImageElement::addSubresourceAttributeURLs(urls);
472
473     addSubresourceURL(urls, document()->completeURL(getAttribute(dataAttr)));
474
475     // FIXME: Passing a string that starts with "#" to the completeURL function does
476     // not seem like it would work. The image element has similar but not identical code.
477     const AtomicString& useMap = getAttribute(usemapAttr);
478     if (useMap.startsWith("#"))
479         addSubresourceURL(urls, document()->completeURL(useMap));
480 }
481
482 void HTMLObjectElement::insertedIntoTree(bool deep)
483 {
484     FormAssociatedElement::insertedIntoTree();
485     HTMLPlugInImageElement::insertedIntoTree(deep);
486 }
487
488 void HTMLObjectElement::removedFromTree(bool deep)
489 {
490     FormAssociatedElement::removedFromTree();
491     HTMLPlugInImageElement::removedFromTree(deep);
492 }
493
494 bool HTMLObjectElement::appendFormData(FormDataList&, bool)
495 {
496     // FIXME: Implements this function.
497     return false;
498 }
499
500 const AtomicString& HTMLObjectElement::formControlName() const
501 {
502     return m_name.isNull() ? emptyAtom : m_name;
503 }
504
505 }