Notify the UI delegate when a MediaDocument's natural size changes
[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
28 #if ENABLE(VIDEO)
29 #include "MediaDocument.h"
30
31 #include "Chrome.h"
32 #include "ChromeClient.h"
33 #include "DocumentLoader.h"
34 #include "EventNames.h"
35 #include "ExceptionCodePlaceholder.h"
36 #include "Frame.h"
37 #include "FrameLoader.h"
38 #include "FrameLoaderClient.h"
39 #include "HTMLEmbedElement.h"
40 #include "HTMLHtmlElement.h"
41 #include "HTMLNames.h"
42 #include "HTMLSourceElement.h"
43 #include "HTMLVideoElement.h"
44 #include "KeyboardEvent.h"
45 #include "NodeList.h"
46 #include "RawDataDocumentParser.h"
47 #include "ScriptController.h"
48 #include "ShadowRoot.h"
49
50 namespace WebCore {
51
52 using namespace HTMLNames;
53
54 // FIXME: Share more code with PluginDocumentParser.
55 class MediaDocumentParser final : public RawDataDocumentParser {
56 public:
57     static Ref<MediaDocumentParser> create(MediaDocument& document)
58     {
59         return adoptRef(*new MediaDocumentParser(document));
60     }
61     
62 private:
63     MediaDocumentParser(MediaDocument& document)
64         : RawDataDocumentParser(document)
65         , m_mediaElement(0)
66     {
67         m_outgoingReferrer = document.outgoingReferrer();
68     }
69
70     virtual void appendBytes(DocumentWriter&, const char*, size_t) override;
71
72     void createDocumentStructure();
73
74     HTMLMediaElement* m_mediaElement;
75     String m_outgoingReferrer;
76 };
77     
78 void MediaDocumentParser::createDocumentStructure()
79 {
80     RefPtr<Element> rootElement = document()->createElement(htmlTag, false);
81     document()->appendChild(rootElement, IGNORE_EXCEPTION);
82     document()->setCSSTarget(rootElement.get());
83     downcast<HTMLHtmlElement>(*rootElement).insertedByParser();
84
85     if (document()->frame())
86         document()->frame()->injectUserScripts(InjectAtDocumentStart);
87
88 #if PLATFORM(IOS)
89     RefPtr<Element> headElement = document()->createElement(headTag, false);
90     rootElement->appendChild(headElement, IGNORE_EXCEPTION);
91
92     RefPtr<Element> metaElement = document()->createElement(metaTag, false);
93     metaElement->setAttribute(nameAttr, "viewport");
94     metaElement->setAttribute(contentAttr, "width=device-width,initial-scale=1,user-scalable=no");
95     headElement->appendChild(metaElement, IGNORE_EXCEPTION);
96 #endif
97
98     RefPtr<Element> body = document()->createElement(bodyTag, false);
99     rootElement->appendChild(body, IGNORE_EXCEPTION);
100
101     RefPtr<Element> mediaElement = document()->createElement(videoTag, false);
102
103     m_mediaElement = downcast<HTMLVideoElement>(mediaElement.get());
104     m_mediaElement->setAttribute(controlsAttr, emptyAtom);
105     m_mediaElement->setAttribute(autoplayAttr, emptyAtom);
106
107     m_mediaElement->setAttribute(nameAttr, "media");
108
109     StringBuilder elementStyle;
110     elementStyle.appendLiteral("max-width: 100%; max-height: 100%;");
111 #if PLATFORM(IOS)
112     elementStyle.appendLiteral("width: 100%; height: 100%;");
113 #endif
114     m_mediaElement->setAttribute(styleAttr, elementStyle.toString());
115
116     RefPtr<Element> sourceElement = document()->createElement(sourceTag, false);
117     HTMLSourceElement& source = downcast<HTMLSourceElement>(*sourceElement);
118     source.setSrc(document()->url());
119
120     if (DocumentLoader* loader = document()->loader())
121         source.setType(loader->responseMIMEType());
122
123     m_mediaElement->appendChild(sourceElement, IGNORE_EXCEPTION);
124     body->appendChild(mediaElement, IGNORE_EXCEPTION);
125
126     Frame* frame = document()->frame();
127     if (!frame)
128         return;
129
130     frame->loader().activeDocumentLoader()->setMainResourceDataBufferingPolicy(DoNotBufferData);
131     frame->loader().setOutgoingReferrer(frame->document()->completeURL(m_outgoingReferrer));
132 }
133
134 void MediaDocumentParser::appendBytes(DocumentWriter&, const char*, size_t)
135 {
136     if (m_mediaElement)
137         return;
138
139     createDocumentStructure();
140     finish();
141 }
142     
143 MediaDocument::MediaDocument(Frame* frame, const URL& url)
144     : HTMLDocument(frame, url, MediaDocumentClass)
145     , m_replaceMediaElementTimer(*this, &MediaDocument::replaceMediaElementTimerFired)
146 {
147     setCompatibilityMode(DocumentCompatibilityMode::QuirksMode);
148     lockCompatibilityMode();
149     if (frame)
150         m_outgoingReferrer = frame->loader().outgoingReferrer();
151 }
152
153 MediaDocument::~MediaDocument()
154 {
155     ASSERT(!m_replaceMediaElementTimer.isActive());
156 }
157
158 Ref<DocumentParser> MediaDocument::createParser()
159 {
160     return MediaDocumentParser::create(*this);
161 }
162
163 static inline HTMLVideoElement* descendentVideoElement(ContainerNode& node)
164 {
165     if (is<HTMLVideoElement>(node))
166         return downcast<HTMLVideoElement>(&node);
167
168     RefPtr<NodeList> nodeList = node.getElementsByTagNameNS(videoTag.namespaceURI(), videoTag.localName());
169    
170     if (nodeList->length() > 0)
171         return downcast<HTMLVideoElement>(nodeList->item(0));
172
173     return nullptr;
174 }
175
176 static inline HTMLVideoElement* ancestorVideoElement(Node* node)
177 {
178     while (node && !is<HTMLVideoElement>(*node))
179         node = node->parentOrShadowHostNode();
180
181     return downcast<HTMLVideoElement>(node);
182 }
183
184 void MediaDocument::defaultEventHandler(Event* event)
185 {
186     // Match the default Quicktime plugin behavior to allow 
187     // clicking and double-clicking to pause and play the media.
188     Node* targetNode = event->target()->toNode();
189     if (!targetNode)
190         return;
191
192     if (HTMLVideoElement* video = ancestorVideoElement(targetNode)) {
193         if (event->type() == eventNames().clickEvent) {
194             if (!video->canPlay()) {
195                 video->pause();
196                 event->setDefaultHandled();
197             }
198         } else if (event->type() == eventNames().dblclickEvent) {
199             if (video->canPlay()) {
200                 video->play();
201                 event->setDefaultHandled();
202             }
203         }
204     }
205
206     if (!is<ContainerNode>(*targetNode))
207         return;
208     ContainerNode& targetContainer = downcast<ContainerNode>(*targetNode);
209     if (event->type() == eventNames().keydownEvent && is<KeyboardEvent>(*event)) {
210         HTMLVideoElement* video = descendentVideoElement(targetContainer);
211         if (!video)
212             return;
213
214         KeyboardEvent& keyboardEvent = downcast<KeyboardEvent>(*event);
215         if (keyboardEvent.keyIdentifier() == "U+0020") { // space
216             if (video->paused()) {
217                 if (video->canPlay())
218                     video->play();
219             } else
220                 video->pause();
221             keyboardEvent.setDefaultHandled();
222         }
223     }
224 }
225
226 void MediaDocument::mediaElementSawUnsupportedTracks()
227 {
228     // The HTMLMediaElement was told it has something that the underlying 
229     // MediaPlayer cannot handle so we should switch from <video> to <embed> 
230     // and let the plugin handle this. Don't do it immediately as this 
231     // function may be called directly from a media engine callback, and 
232     // replaceChild will destroy the element, media player, and media engine.
233     m_replaceMediaElementTimer.startOneShot(0);
234 }
235
236 void MediaDocument::replaceMediaElementTimerFired()
237 {
238     auto* htmlBody = bodyOrFrameset();
239     if (!htmlBody)
240         return;
241
242     // Set body margin width and height to 0 as that is what a PluginDocument uses.
243     htmlBody->setAttribute(marginwidthAttr, "0");
244     htmlBody->setAttribute(marginheightAttr, "0");
245
246     if (HTMLVideoElement* videoElement = descendentVideoElement(*htmlBody)) {
247         RefPtr<Element> element = Document::createElement(embedTag, false);
248         HTMLEmbedElement& embedElement = downcast<HTMLEmbedElement>(*element);
249
250         embedElement.setAttribute(widthAttr, "100%");
251         embedElement.setAttribute(heightAttr, "100%");
252         embedElement.setAttribute(nameAttr, "plugin");
253         embedElement.setAttribute(srcAttr, url().string());
254
255         DocumentLoader* documentLoader = loader();
256         ASSERT(documentLoader);
257         if (documentLoader)
258             embedElement.setAttribute(typeAttr, documentLoader->writer().mimeType());
259
260         videoElement->parentNode()->replaceChild(&embedElement, videoElement, IGNORE_EXCEPTION);
261     }
262 }
263
264 void MediaDocument::mediaElementNaturalSizeChanged(const IntSize& newSize)
265 {
266     if (ownerElement())
267         return;
268
269     if (newSize.isZero())
270         return;
271
272     if (page())
273         page()->chrome().client().mediaDocumentNaturalSizeChanged(newSize);
274 }
275
276 }
277 #endif