[WTF] Clean up StringStatics.cpp by using LazyNeverDestroyed<> for Atoms
[WebKit-https.git] / Source / WebCore / html / MediaDocument.cpp
1 /*
2  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "MediaDocument.h"
28
29 #if ENABLE(VIDEO)
30
31 #include "Chrome.h"
32 #include "ChromeClient.h"
33 #include "DocumentLoader.h"
34 #include "EventNames.h"
35 #include "Frame.h"
36 #include "FrameLoader.h"
37 #include "FrameLoaderClient.h"
38 #include "HTMLBodyElement.h"
39 #include "HTMLEmbedElement.h"
40 #include "HTMLHeadElement.h"
41 #include "HTMLHtmlElement.h"
42 #include "HTMLMetaElement.h"
43 #include "HTMLNames.h"
44 #include "HTMLSourceElement.h"
45 #include "HTMLVideoElement.h"
46 #include "KeyboardEvent.h"
47 #include "NodeList.h"
48 #include "Page.h"
49 #include "RawDataDocumentParser.h"
50 #include "RuntimeEnabledFeatures.h"
51 #include "ScriptController.h"
52 #include "ShadowRoot.h"
53 #include "TypedElementDescendantIterator.h"
54 #include <wtf/text/StringBuilder.h>
55
56 namespace WebCore {
57
58 using namespace HTMLNames;
59
60 // FIXME: Share more code with PluginDocumentParser.
61 class MediaDocumentParser final : public RawDataDocumentParser {
62 public:
63     static Ref<MediaDocumentParser> create(MediaDocument& document)
64     {
65         return adoptRef(*new MediaDocumentParser(document));
66     }
67     
68 private:
69     MediaDocumentParser(MediaDocument& document)
70         : RawDataDocumentParser { document }
71         , m_outgoingReferrer { document.outgoingReferrer() }
72     {
73     }
74
75     void appendBytes(DocumentWriter&, const char*, size_t) final;
76     void createDocumentStructure();
77
78     HTMLMediaElement* m_mediaElement { nullptr };
79     String m_outgoingReferrer;
80 };
81     
82 void MediaDocumentParser::createDocumentStructure()
83 {
84     auto& document = *this->document();
85
86     auto rootElement = HTMLHtmlElement::create(document);
87     document.appendChild(rootElement);
88     document.setCSSTarget(rootElement.ptr());
89     rootElement->insertedByParser();
90
91     if (document.frame())
92         document.frame()->injectUserScripts(InjectAtDocumentStart);
93
94 #if PLATFORM(IOS)
95     auto headElement = HTMLHeadElement::create(document);
96     rootElement->appendChild(headElement);
97
98     auto metaElement = HTMLMetaElement::create(document);
99     metaElement->setAttributeWithoutSynchronization(nameAttr, AtomicString("viewport", AtomicString::ConstructFromLiteral));
100     metaElement->setAttributeWithoutSynchronization(contentAttr, AtomicString("width=device-width,initial-scale=1", AtomicString::ConstructFromLiteral));
101     headElement->appendChild(metaElement);
102 #endif
103
104     auto body = HTMLBodyElement::create(document);
105     rootElement->appendChild(body);
106
107     auto videoElement = HTMLVideoElement::create(document);
108     m_mediaElement = videoElement.ptr();
109     videoElement->setAttributeWithoutSynchronization(controlsAttr, emptyAtom());
110     videoElement->setAttributeWithoutSynchronization(autoplayAttr, emptyAtom());
111     videoElement->setAttributeWithoutSynchronization(playsinlineAttr, emptyAtom());
112     videoElement->setAttributeWithoutSynchronization(srcAttr, document.url().string());
113     if (auto* loader = document.loader())
114         videoElement->setAttributeWithoutSynchronization(typeAttr, loader->responseMIMEType());
115
116     if (!RuntimeEnabledFeatures::sharedFeatures().modernMediaControlsEnabled()) {
117         StringBuilder elementStyle;
118         elementStyle.appendLiteral("max-width: 100%; max-height: 100%;");
119 #if PLATFORM(IOS)
120         elementStyle.appendLiteral("width: 100%; height: auto;");
121 #endif
122         videoElement->setAttribute(styleAttr, elementStyle.toString());
123     }
124
125     body->appendChild(videoElement);
126
127     Frame* frame = document.frame();
128     if (!frame)
129         return;
130
131     frame->loader().activeDocumentLoader()->setMainResourceDataBufferingPolicy(DoNotBufferData);
132     frame->loader().setOutgoingReferrer(document.completeURL(m_outgoingReferrer));
133 }
134
135 void MediaDocumentParser::appendBytes(DocumentWriter&, const char*, size_t)
136 {
137     if (m_mediaElement)
138         return;
139
140     createDocumentStructure();
141     finish();
142 }
143     
144 MediaDocument::MediaDocument(Frame* frame, const URL& url)
145     : HTMLDocument(frame, url, MediaDocumentClass)
146     , m_replaceMediaElementTimer(*this, &MediaDocument::replaceMediaElementTimerFired)
147 {
148     setCompatibilityMode(DocumentCompatibilityMode::QuirksMode);
149     lockCompatibilityMode();
150     if (frame)
151         m_outgoingReferrer = frame->loader().outgoingReferrer();
152 }
153
154 MediaDocument::~MediaDocument()
155 {
156     ASSERT(!m_replaceMediaElementTimer.isActive());
157 }
158
159 Ref<DocumentParser> MediaDocument::createParser()
160 {
161     return MediaDocumentParser::create(*this);
162 }
163
164 static inline HTMLVideoElement* descendantVideoElement(ContainerNode& node)
165 {
166     if (is<HTMLVideoElement>(node))
167         return downcast<HTMLVideoElement>(&node);
168
169     return descendantsOfType<HTMLVideoElement>(node).first();
170 }
171
172 static inline HTMLVideoElement* ancestorVideoElement(Node* node)
173 {
174     while (node && !is<HTMLVideoElement>(*node))
175         node = node->parentOrShadowHostNode();
176
177     return downcast<HTMLVideoElement>(node);
178 }
179
180 void MediaDocument::defaultEventHandler(Event& event)
181 {
182     // Modern media controls have their own event handling to determine when to
183     // pause or resume playback.
184     if (RuntimeEnabledFeatures::sharedFeatures().modernMediaControlsEnabled())
185         return;
186     
187     // Match the default Quicktime plugin behavior to allow
188     // clicking and double-clicking to pause and play the media.
189     Node* targetNode = event.target()->toNode();
190     if (!targetNode)
191         return;
192
193     if (HTMLVideoElement* video = ancestorVideoElement(targetNode)) {
194         if (event.type() == eventNames().clickEvent) {
195             if (!video->canPlay()) {
196                 video->pause();
197                 event.setDefaultHandled();
198             }
199         } else if (event.type() == eventNames().dblclickEvent) {
200             if (video->canPlay()) {
201                 video->play();
202                 event.setDefaultHandled();
203             }
204         }
205     }
206
207     if (!is<ContainerNode>(*targetNode))
208         return;
209     ContainerNode& targetContainer = downcast<ContainerNode>(*targetNode);
210     if (event.type() == eventNames().keydownEvent && is<KeyboardEvent>(event)) {
211         HTMLVideoElement* video = descendantVideoElement(targetContainer);
212         if (!video)
213             return;
214
215         KeyboardEvent& keyboardEvent = downcast<KeyboardEvent>(event);
216         if (keyboardEvent.keyIdentifier() == "U+0020") { // space
217             if (video->paused()) {
218                 if (video->canPlay())
219                     video->play();
220             } else
221                 video->pause();
222             keyboardEvent.setDefaultHandled();
223         }
224     }
225 }
226
227 void MediaDocument::mediaElementSawUnsupportedTracks()
228 {
229     // The HTMLMediaElement was told it has something that the underlying 
230     // MediaPlayer cannot handle so we should switch from <video> to <embed> 
231     // and let the plugin handle this. Don't do it immediately as this 
232     // function may be called directly from a media engine callback, and 
233     // replaceChild will destroy the element, media player, and media engine.
234     m_replaceMediaElementTimer.startOneShot(0_s);
235 }
236
237 void MediaDocument::replaceMediaElementTimerFired()
238 {
239     auto* htmlBody = bodyOrFrameset();
240     if (!htmlBody)
241         return;
242
243     // Set body margin width and height to 0 as that is what a PluginDocument uses.
244     htmlBody->setAttributeWithoutSynchronization(marginwidthAttr, AtomicString("0", AtomicString::ConstructFromLiteral));
245     htmlBody->setAttributeWithoutSynchronization(marginheightAttr, AtomicString("0", AtomicString::ConstructFromLiteral));
246
247     if (auto* videoElement = descendantVideoElement(*htmlBody)) {
248         auto embedElement = HTMLEmbedElement::create(*this);
249
250         embedElement->setAttributeWithoutSynchronization(widthAttr, AtomicString("100%", AtomicString::ConstructFromLiteral));
251         embedElement->setAttributeWithoutSynchronization(heightAttr, AtomicString("100%", AtomicString::ConstructFromLiteral));
252         embedElement->setAttributeWithoutSynchronization(nameAttr, AtomicString("plugin", AtomicString::ConstructFromLiteral));
253         embedElement->setAttributeWithoutSynchronization(srcAttr, url().string());
254
255         ASSERT(loader());
256         if (auto* loader = this->loader())
257             embedElement->setAttributeWithoutSynchronization(typeAttr, loader->writer().mimeType());
258
259         videoElement->parentNode()->replaceChild(embedElement, *videoElement);
260     }
261 }
262
263 void MediaDocument::mediaElementNaturalSizeChanged(const IntSize& newSize)
264 {
265     if (ownerElement())
266         return;
267
268     if (newSize.isZero())
269         return;
270
271     if (page())
272         page()->chrome().client().imageOrMediaDocumentSizeChanged(newSize);
273 }
274
275 }
276
277 #endif