Use is<>() / downcast<>() for Element
[WebKit-https.git] / Source / 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, 2011 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 "CachedImage.h"
30 #include "Chrome.h"
31 #include "ChromeClient.h"
32 #include "ElementIterator.h"
33 #include "EventNames.h"
34 #include "ExceptionCode.h"
35 #include "FormDataList.h"
36 #include "Frame.h"
37 #include "HTMLDocument.h"
38 #include "HTMLFormElement.h"
39 #include "HTMLImageLoader.h"
40 #include "HTMLMetaElement.h"
41 #include "HTMLNames.h"
42 #include "HTMLParamElement.h"
43 #include "HTMLParserIdioms.h"
44 #include "MIMETypeRegistry.h"
45 #include "NodeList.h"
46 #include "Page.h"
47 #include "PluginViewBase.h"
48 #include "RenderEmbeddedObject.h"
49 #include "RenderImage.h"
50 #include "RenderWidget.h"
51 #include "Settings.h"
52 #include "SubframeLoader.h"
53 #include "Text.h"
54 #include "Widget.h"
55 #include <wtf/Ref.h>
56
57 #if PLATFORM(IOS)
58 #include "RuntimeApplicationChecksIOS.h"
59 #include "WebCoreSystemInterface.h"
60 #endif
61
62 namespace WebCore {
63
64 using namespace HTMLNames;
65
66 inline HTMLObjectElement::HTMLObjectElement(const QualifiedName& tagName, Document& document, HTMLFormElement* form, bool createdByParser)
67     : HTMLPlugInImageElement(tagName, document, createdByParser, ShouldNotPreferPlugInsForImages)
68     , m_docNamedItem(true)
69     , m_useFallbackContent(false)
70 {
71     ASSERT(hasTagName(objectTag));
72     setForm(form ? form : HTMLFormElement::findClosestFormAncestor(*this));
73 }
74
75 inline HTMLObjectElement::~HTMLObjectElement()
76 {
77 }
78
79 PassRefPtr<HTMLObjectElement> HTMLObjectElement::create(const QualifiedName& tagName, Document& document, HTMLFormElement* form, bool createdByParser)
80 {
81     return adoptRef(new HTMLObjectElement(tagName, document, form, createdByParser));
82 }
83
84 RenderWidget* HTMLObjectElement::renderWidgetLoadingPlugin() const
85 {
86     // Needs to load the plugin immediatedly because this function is called
87     // when JavaScript code accesses the plugin.
88     // FIXME: <rdar://16893708> Check if dispatching events here is safe.
89     document().updateLayoutIgnorePendingStylesheets(Document::RunPostLayoutTasks::Synchronously);
90     return renderWidget(); // This will return 0 if the renderer is not a RenderWidget.
91 }
92
93 bool HTMLObjectElement::isPresentationAttribute(const QualifiedName& name) const
94 {
95     if (name == borderAttr)
96         return true;
97     return HTMLPlugInImageElement::isPresentationAttribute(name);
98 }
99
100 void HTMLObjectElement::collectStyleForPresentationAttribute(const QualifiedName& name, const AtomicString& value, MutableStyleProperties& style)
101 {
102     if (name == borderAttr)
103         applyBorderAttributeToStyle(value, style);
104     else
105         HTMLPlugInImageElement::collectStyleForPresentationAttribute(name, value, style);
106 }
107
108 void HTMLObjectElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
109 {
110     if (name == formAttr)
111         formAttributeChanged();
112     else if (name == typeAttr) {
113         m_serviceType = value.string().left(value.find(';')).lower();
114         setNeedsWidgetUpdate(true);
115     } else if (name == dataAttr) {
116         m_url = stripLeadingAndTrailingHTMLSpaces(value);
117         setNeedsWidgetUpdate(true);
118         document().updateStyleIfNeeded();
119         if (renderer()) {
120             if (isImageType()) {
121                 if (!m_imageLoader)
122                     m_imageLoader = std::make_unique<HTMLImageLoader>(*this);
123                 m_imageLoader->updateFromElementIgnoringPreviousError();
124             }
125         }
126     } else if (name == classidAttr)
127         setNeedsWidgetUpdate(true);
128     else if (name == onbeforeloadAttr)
129         setAttributeEventListener(eventNames().beforeloadEvent, name, value);
130     else
131         HTMLPlugInImageElement::parseAttribute(name, value);
132 }
133
134 static void mapDataParamToSrc(Vector<String>* paramNames, Vector<String>* paramValues)
135 {
136     // Some plugins don't understand the "data" attribute of the OBJECT tag (i.e. Real and WMP
137     // require "src" attribute).
138     int srcIndex = -1, dataIndex = -1;
139     for (unsigned int i = 0; i < paramNames->size(); ++i) {
140         if (equalIgnoringCase((*paramNames)[i], "src"))
141             srcIndex = i;
142         else if (equalIgnoringCase((*paramNames)[i], "data"))
143             dataIndex = i;
144     }
145     
146     if (srcIndex == -1 && dataIndex != -1) {
147         paramNames->append("src");
148         paramValues->append((*paramValues)[dataIndex]);
149     }
150 }
151
152 #if PLATFORM(IOS)
153 static bool shouldNotPerformURLAdjustment()
154 {
155     static bool shouldNotPerformURLAdjustment = applicationIsNASAHD() && !iosExecutableWasLinkedOnOrAfterVersion(wkIOSSystemVersion_5_0);
156     return shouldNotPerformURLAdjustment;
157 }
158 #endif
159
160 // FIXME: This function should not deal with url or serviceType!
161 void HTMLObjectElement::parametersForPlugin(Vector<String>& paramNames, Vector<String>& paramValues, String& url, String& serviceType)
162 {
163     HashSet<StringImpl*, CaseFoldingHash> uniqueParamNames;
164     String urlParameter;
165     
166     // Scan the PARAM children and store their name/value pairs.
167     // Get the URL and type from the params if we don't already have them.
168     for (auto& param : childrenOfType<HTMLParamElement>(*this)) {
169         String name = param.name();
170         if (name.isEmpty())
171             continue;
172
173         uniqueParamNames.add(name.impl());
174         paramNames.append(param.name());
175         paramValues.append(param.value());
176
177         // FIXME: url adjustment does not belong in this function.
178         if (url.isEmpty() && urlParameter.isEmpty() && (equalIgnoringCase(name, "src") || equalIgnoringCase(name, "movie") || equalIgnoringCase(name, "code") || equalIgnoringCase(name, "url")))
179             urlParameter = stripLeadingAndTrailingHTMLSpaces(param.value());
180         // FIXME: serviceType calculation does not belong in this function.
181         if (serviceType.isEmpty() && equalIgnoringCase(name, "type")) {
182             serviceType = param.value();
183             size_t pos = serviceType.find(';');
184             if (pos != notFound)
185                 serviceType = serviceType.left(pos);
186         }
187     }
188     
189     // When OBJECT is used for an applet via Sun's Java plugin, the CODEBASE attribute in the tag
190     // points to the Java plugin itself (an ActiveX component) while the actual applet CODEBASE is
191     // in a PARAM tag. See <http://java.sun.com/products/plugin/1.2/docs/tags.html>. This means
192     // we have to explicitly suppress the tag's CODEBASE attribute if there is none in a PARAM,
193     // else our Java plugin will misinterpret it. [4004531]
194     String codebase;
195     if (MIMETypeRegistry::isJavaAppletMIMEType(serviceType)) {
196         codebase = "codebase";
197         uniqueParamNames.add(codebase.impl()); // pretend we found it in a PARAM already
198     }
199     
200     // Turn the attributes of the <object> element into arrays, but don't override <param> values.
201     if (hasAttributes()) {
202         for (const Attribute& attribute : attributesIterator()) {
203             const AtomicString& name = attribute.name().localName();
204             if (!uniqueParamNames.contains(name.impl())) {
205                 paramNames.append(name.string());
206                 paramValues.append(attribute.value().string());
207             }
208         }
209     }
210     
211     mapDataParamToSrc(&paramNames, &paramValues);
212     
213     // HTML5 says that an object resource's URL is specified by the object's data
214     // attribute, not by a param element. However, for compatibility, allow the
215     // resource's URL to be given by a param named "src", "movie", "code" or "url"
216     // if we know that resource points to a plug-in.
217 #if PLATFORM(IOS)
218     if (shouldNotPerformURLAdjustment())
219         return;
220 #endif
221
222     if (url.isEmpty() && !urlParameter.isEmpty()) {
223         SubframeLoader& loader = document().frame()->loader().subframeLoader();
224         if (loader.resourceWillUsePlugin(urlParameter, serviceType, shouldPreferPlugInsForImages()))
225             url = urlParameter;
226     }
227 }
228
229     
230 bool HTMLObjectElement::hasFallbackContent() const
231 {
232     for (Node* child = firstChild(); child; child = child->nextSibling()) {
233         // Ignore whitespace-only text, and <param> tags, any other content is fallback content.
234         if (is<Text>(child)) {
235             if (!downcast<Text>(*child).containsOnlyWhitespace())
236                 return true;
237         } else if (!is<HTMLParamElement>(child))
238             return true;
239     }
240     return false;
241 }
242     
243 bool HTMLObjectElement::shouldAllowQuickTimeClassIdQuirk()
244 {
245     // This site-specific hack maintains compatibility with Mac OS X Wiki Server,
246     // which embeds QuickTime movies using an object tag containing QuickTime's
247     // ActiveX classid. Treat this classid as valid only if OS X Server's unique
248     // 'generator' meta tag is present. Only apply this quirk if there is no
249     // fallback content, which ensures the quirk will disable itself if Wiki
250     // Server is updated to generate an alternate embed tag as fallback content.
251
252     if (!document().page()
253         || !document().page()->settings().needsSiteSpecificQuirks()
254         || hasFallbackContent()
255         || !equalIgnoringCase(fastGetAttribute(classidAttr), "clsid:02BF25D5-8C17-4B23-BC80-D3488ABDDC6B"))
256         return false;
257
258     for (auto& metaElement : descendantsOfType<HTMLMetaElement>(document())) {
259         if (equalIgnoringCase(metaElement.name(), "generator") && metaElement.content().startsWith("Mac OS X Server Web Services Server", false))
260             return true;
261     }
262
263     return false;
264 }
265     
266 bool HTMLObjectElement::hasValidClassId()
267 {
268     if (MIMETypeRegistry::isJavaAppletMIMEType(serviceType()) && fastGetAttribute(classidAttr).startsWith("java:", false))
269         return true;
270     
271     if (shouldAllowQuickTimeClassIdQuirk())
272         return true;
273
274     // HTML5 says that fallback content should be rendered if a non-empty
275     // classid is specified for which the UA can't find a suitable plug-in.
276     return fastGetAttribute(classidAttr).isEmpty();
277 }
278
279 // FIXME: This should be unified with HTMLEmbedElement::updateWidget and
280 // moved down into HTMLPluginImageElement.cpp
281 void HTMLObjectElement::updateWidget(PluginCreationOption pluginCreationOption)
282 {
283     ASSERT(!renderEmbeddedObject()->isPluginUnavailable());
284     ASSERT(needsWidgetUpdate());
285     setNeedsWidgetUpdate(false);
286     // FIXME: This should ASSERT isFinishedParsingChildren() instead.
287     if (!isFinishedParsingChildren())
288         return;
289
290     // FIXME: I'm not sure it's ever possible to get into updateWidget during a
291     // removal, but just in case we should avoid loading the frame to prevent
292     // security bugs.
293     if (!SubframeLoadingDisabler::canLoadFrame(*this))
294         return;
295
296     String url = this->url();
297     String serviceType = this->serviceType();
298
299     // FIXME: These should be joined into a PluginParameters class.
300     Vector<String> paramNames;
301     Vector<String> paramValues;
302     parametersForPlugin(paramNames, paramValues, url, serviceType);
303
304     // Note: url is modified above by parametersForPlugin.
305     if (!allowedToLoadFrameURL(url))
306         return;
307
308     // FIXME: It's sadness that we have this special case here.
309     //        See http://trac.webkit.org/changeset/25128 and
310     //        plugins/netscape-plugin-setwindow-size.html
311     if (pluginCreationOption == CreateOnlyNonNetscapePlugins && wouldLoadAsNetscapePlugin(url, serviceType)) {
312         // Ensure updateWidget() is called again during layout to create the Netscape plug-in.
313         setNeedsWidgetUpdate(true);
314         return;
315     }
316
317     Ref<HTMLObjectElement> protect(*this); // beforeload and plugin loading can make arbitrary DOM mutations.
318     bool beforeLoadAllowedLoad = guardedDispatchBeforeLoadEvent(url);
319     if (!renderer()) // Do not load the plugin if beforeload removed this element or its renderer.
320         return;
321
322     bool success = beforeLoadAllowedLoad && hasValidClassId();
323     if (success)
324         success = requestObject(url, serviceType, paramNames, paramValues);
325     if (!success && hasFallbackContent())
326         renderFallbackContent();
327 }
328
329 Node::InsertionNotificationRequest HTMLObjectElement::insertedInto(ContainerNode& insertionPoint)
330 {
331     HTMLPlugInImageElement::insertedInto(insertionPoint);
332     FormAssociatedElement::insertedInto(insertionPoint);
333     return InsertionDone;
334 }
335
336 void HTMLObjectElement::removedFrom(ContainerNode& insertionPoint)
337 {
338     HTMLPlugInImageElement::removedFrom(insertionPoint);
339     FormAssociatedElement::removedFrom(insertionPoint);
340 }
341
342 void HTMLObjectElement::childrenChanged(const ChildChange& change)
343 {
344     updateDocNamedItem();
345     if (inDocument() && !useFallbackContent()) {
346         setNeedsWidgetUpdate(true);
347         setNeedsStyleRecalc();
348     }
349     HTMLPlugInImageElement::childrenChanged(change);
350 }
351
352 bool HTMLObjectElement::isURLAttribute(const Attribute& attribute) const
353 {
354     return attribute.name() == dataAttr || (attribute.name() == usemapAttr && attribute.value().string()[0] != '#') || HTMLPlugInImageElement::isURLAttribute(attribute);
355 }
356
357 const AtomicString& HTMLObjectElement::imageSourceURL() const
358 {
359     return fastGetAttribute(dataAttr);
360 }
361
362 void HTMLObjectElement::renderFallbackContent()
363 {
364     if (useFallbackContent())
365         return;
366     
367     if (!inDocument())
368         return;
369
370     setNeedsStyleRecalc(ReconstructRenderTree);
371
372     // Before we give up and use fallback content, check to see if this is a MIME type issue.
373     auto* loader = imageLoader();
374     if (loader && loader->image() && loader->image()->status() != CachedResource::LoadError) {
375         m_serviceType = loader->image()->response().mimeType();
376         if (!isImageType()) {
377             // If we don't think we have an image type anymore, then clear the image from the loader.
378             loader->setImage(nullptr);
379             return;
380         }
381     }
382
383     m_useFallbackContent = true;
384
385     // This was added to keep Acid 2 non-flaky. A style recalc is required to make fallback resources load.
386     // Without forcing, this may happen after all the other resources have been loaded and the document is already
387     // considered complete. FIXME: Would be better to address this with incrementLoadEventDelayCount instead
388     // or disentangle loading from style entirely.
389     document().updateStyleIfNeeded();
390 }
391
392 // FIXME: This should be removed, all callers are almost certainly wrong.
393 static bool isRecognizedTagName(const QualifiedName& tagName)
394 {
395     DEPRECATED_DEFINE_STATIC_LOCAL(HashSet<AtomicStringImpl*>, tagList, ());
396     if (tagList.isEmpty()) {
397         auto* tags = HTMLNames::getHTMLTags();
398         for (size_t i = 0; i < HTMLNames::HTMLTagsCount; i++) {
399             if (*tags[i] == bgsoundTag
400                 || *tags[i] == commandTag
401                 || *tags[i] == detailsTag
402                 || *tags[i] == figcaptionTag
403                 || *tags[i] == figureTag
404                 || *tags[i] == summaryTag
405                 || *tags[i] == trackTag) {
406                 // Even though we have atoms for these tags, we don't want to
407                 // treat them as "recognized tags" for the purpose of parsing
408                 // because that changes how we parse documents.
409                 continue;
410             }
411             tagList.add(tags[i]->localName().impl());
412         }
413     }
414     return tagList.contains(tagName.localName().impl());
415 }
416
417 void HTMLObjectElement::updateDocNamedItem()
418 {
419     // The rule is "<object> elements with no children other than
420     // <param> elements, unknown elements and whitespace can be
421     // found by name in a document, and other <object> elements cannot."
422     bool wasNamedItem = m_docNamedItem;
423     bool isNamedItem = true;
424     Node* child = firstChild();
425     while (child && isNamedItem) {
426         if (is<Element>(child)) {
427             Element& element = downcast<Element>(*child);
428             // FIXME: Use of isRecognizedTagName is almost certainly wrong here.
429             if (isRecognizedTagName(element.tagQName()) && !element.hasTagName(paramTag))
430                 isNamedItem = false;
431         } else if (is<Text>(child)) {
432             if (!downcast<Text>(*child).containsOnlyWhitespace())
433                 isNamedItem = false;
434         } else
435             isNamedItem = false;
436         child = child->nextSibling();
437     }
438     if (isNamedItem != wasNamedItem && inDocument() && is<HTMLDocument>(document())) {
439         HTMLDocument& document = downcast<HTMLDocument>(this->document());
440
441         const AtomicString& id = getIdAttribute();
442         if (!id.isEmpty()) {
443             if (isNamedItem)
444                 document.addDocumentNamedItem(*id.impl(), *this);
445             else
446                 document.removeDocumentNamedItem(*id.impl(), *this);
447         }
448
449         const AtomicString& name = getNameAttribute();
450         if (!name.isEmpty() && id != name) {
451             if (isNamedItem)
452                 document.addDocumentNamedItem(*name.impl(), *this);
453             else
454                 document.removeDocumentNamedItem(*name.impl(), *this);
455         }
456     }
457     m_docNamedItem = isNamedItem;
458 }
459
460 bool HTMLObjectElement::containsJavaApplet() const
461 {
462     if (MIMETypeRegistry::isJavaAppletMIMEType(getAttribute(typeAttr)))
463         return true;
464
465     for (auto& child : childrenOfType<Element>(*this)) {
466         if (child.hasTagName(paramTag) && equalIgnoringCase(child.getNameAttribute(), "type")
467             && MIMETypeRegistry::isJavaAppletMIMEType(child.getAttribute(valueAttr).string()))
468             return true;
469         if (child.hasTagName(objectTag) && downcast<HTMLObjectElement>(child).containsJavaApplet())
470             return true;
471         if (child.hasTagName(appletTag))
472             return true;
473     }
474     
475     return false;
476 }
477
478 void HTMLObjectElement::addSubresourceAttributeURLs(ListHashSet<URL>& urls) const
479 {
480     HTMLPlugInImageElement::addSubresourceAttributeURLs(urls);
481
482     addSubresourceURL(urls, document().completeURL(fastGetAttribute(dataAttr)));
483
484     // FIXME: Passing a string that starts with "#" to the completeURL function does
485     // not seem like it would work. The image element has similar but not identical code.
486     const AtomicString& useMap = fastGetAttribute(usemapAttr);
487     if (useMap.startsWith('#'))
488         addSubresourceURL(urls, document().completeURL(useMap));
489 }
490
491 void HTMLObjectElement::didMoveToNewDocument(Document* oldDocument)
492 {
493     FormAssociatedElement::didMoveToNewDocument(oldDocument);
494     HTMLPlugInImageElement::didMoveToNewDocument(oldDocument);
495 }
496
497 bool HTMLObjectElement::appendFormData(FormDataList& encoding, bool)
498 {
499     if (name().isEmpty())
500         return false;
501
502     Widget* widget = pluginWidget();
503     if (!widget || !widget->isPluginViewBase())
504         return false;
505     String value;
506     if (!toPluginViewBase(widget)->getFormValue(value))
507         return false;
508     encoding.appendData(name(), value);
509     return true;
510 }
511
512 HTMLFormElement* HTMLObjectElement::virtualForm() const
513 {
514     return FormAssociatedElement::form();
515 }
516
517 bool HTMLObjectElement::canContainRangeEndPoint() const
518 {
519     // Call through to HTMLElement because we need to skip HTMLPlugInElement
520     // when calling through to the derived class since returns false unconditionally.
521     // An object element with fallback content should basically be treated like
522     // a generic HTML element.
523     return m_useFallbackContent && HTMLElement::canContainRangeEndPoint();
524 }
525
526 }