b67c54dc44ca37d1a1ad6b5934f5e24398346ad3
[WebKit-https.git] / Source / WebCore / html / HTMLTrackElement.cpp
1 /*
2  * Copyright (C) 2011, 2013 Google Inc. All rights reserved.
3  * Copyright (C) 2011-2017 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #include "config.h"
28 #include "HTMLTrackElement.h"
29
30 #if ENABLE(VIDEO_TRACK)
31
32 #include "ContentSecurityPolicy.h"
33 #include "Event.h"
34 #include "EventNames.h"
35 #include "HTMLMediaElement.h"
36 #include "HTMLNames.h"
37 #include "Logging.h"
38 #include "RuntimeEnabledFeatures.h"
39 #include <wtf/text/CString.h>
40
41 namespace WebCore {
42
43 using namespace HTMLNames;
44
45 #if !LOG_DISABLED
46
47 static String urlForLoggingTrack(const URL& url)
48 {
49     static const unsigned maximumURLLengthForLogging = 128;
50     
51     if (url.string().length() < maximumURLLengthForLogging)
52         return url.string();
53     return url.string().substring(0, maximumURLLengthForLogging) + "...";
54 }
55
56 #endif
57     
58 inline HTMLTrackElement::HTMLTrackElement(const QualifiedName& tagName, Document& document)
59     : HTMLElement(tagName, document)
60     , m_loadTimer(*this, &HTMLTrackElement::loadTimerFired)
61 {
62     LOG(Media, "HTMLTrackElement::HTMLTrackElement - %p", this);
63     ASSERT(hasTagName(trackTag));
64 }
65
66 HTMLTrackElement::~HTMLTrackElement()
67 {
68     if (m_track) {
69         m_track->clearElement();
70         m_track->clearClient();
71     }
72 }
73
74 Ref<HTMLTrackElement> HTMLTrackElement::create(const QualifiedName& tagName, Document& document)
75 {
76     return adoptRef(*new HTMLTrackElement(tagName, document));
77 }
78
79 Node::InsertionNotificationRequest HTMLTrackElement::insertedInto(ContainerNode& insertionPoint)
80 {
81     HTMLElement::insertedInto(insertionPoint);
82
83     if (is<HTMLMediaElement>(insertionPoint))
84         downcast<HTMLMediaElement>(insertionPoint).didAddTextTrack(*this);
85
86     // Since we've moved to a new parent, we may now be able to load.
87     scheduleLoad();
88
89     return InsertionDone;
90 }
91
92 void HTMLTrackElement::removedFrom(ContainerNode& insertionPoint)
93 {
94     HTMLElement::removedFrom(insertionPoint);
95
96     if (is<HTMLMediaElement>(insertionPoint))
97         downcast<HTMLMediaElement>(insertionPoint).didRemoveTextTrack(*this);
98 }
99
100 void HTMLTrackElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
101 {
102     if (name == srcAttr) {
103         if (!value.isEmpty())
104             scheduleLoad();
105         else if (m_track)
106             m_track->removeAllCues();
107
108     // 4.8.10.12.3 Sourcing out-of-band text tracks
109     // As the kind, label, and srclang attributes are set, changed, or removed, the text track must update accordingly...
110     } else if (name == kindAttr)
111         track().setKindKeywordIgnoringASCIICase(value.string());
112     else if (name == labelAttr)
113         track().setLabel(value);
114     else if (name == srclangAttr)
115         track().setLanguage(value);
116     else if (name == defaultAttr)
117         track().setIsDefault(!value.isNull());
118
119     HTMLElement::parseAttribute(name, value);
120 }
121
122 const AtomicString& HTMLTrackElement::kind()
123 {
124     return track().kindKeyword();
125 }
126
127 void HTMLTrackElement::setKind(const AtomicString& kind)
128 {
129     setAttributeWithoutSynchronization(kindAttr, kind);
130 }
131
132 const AtomicString& HTMLTrackElement::srclang() const
133 {
134     return attributeWithoutSynchronization(srclangAttr);
135 }
136
137 const AtomicString& HTMLTrackElement::label() const
138 {
139     return attributeWithoutSynchronization(labelAttr);
140 }
141
142 bool HTMLTrackElement::isDefault() const
143 {
144     return hasAttributeWithoutSynchronization(defaultAttr);
145 }
146
147 LoadableTextTrack& HTMLTrackElement::track()
148 {
149     // FIXME: There is no practical value in lazily initializing this.
150     // Instead this should be created in the constructor.
151     if (!m_track) {
152         // The kind attribute is an enumerated attribute, limited only to known values. It defaults to 'subtitles' if missing or invalid.
153         String kind = attributeWithoutSynchronization(kindAttr).convertToASCIILowercase();
154         if (!TextTrack::isValidKindKeyword(kind))
155             kind = TextTrack::subtitlesKeyword();
156         m_track = LoadableTextTrack::create(*this, kind, label(), srclang());
157     }
158     ASSERT(m_track->trackElement() == this);
159
160     return *m_track;
161 }
162
163 bool HTMLTrackElement::isURLAttribute(const Attribute& attribute) const
164 {
165     return attribute.name() == srcAttr || HTMLElement::isURLAttribute(attribute);
166 }
167
168 void HTMLTrackElement::scheduleLoad()
169 {
170     // 1. If another occurrence of this algorithm is already running for this text track and its track element,
171     // abort these steps, letting that other algorithm take care of this element.
172     if (m_loadTimer.isActive())
173         return;
174
175     // 2. If the text track's text track mode is not set to one of hidden or showing, abort these steps.
176     if (track().mode() != TextTrack::Mode::Hidden && track().mode() != TextTrack::Mode::Showing)
177         return;
178
179     // 3. If the text track's track element does not have a media element as a parent, abort these steps.
180     if (!mediaElement())
181         return;
182
183     // 4. Run the remainder of these steps asynchronously, allowing whatever caused these steps to run to continue.
184     m_loadTimer.startOneShot(0_s);
185 }
186
187 void HTMLTrackElement::loadTimerFired()
188 {
189     if (!hasAttributeWithoutSynchronization(srcAttr))
190         return;
191
192     // 6. Set the text track readiness state to loading.
193     setReadyState(HTMLTrackElement::LOADING);
194
195     // 7. Let URL be the track URL of the track element.
196     URL url = getNonEmptyURLAttribute(srcAttr);
197
198     // 8. If the track element's parent is a media element then let CORS mode be the state of the parent media
199     // element's crossorigin content attribute. Otherwise, let CORS mode be No CORS.
200     if (!canLoadURL(url)) {
201         didCompleteLoad(HTMLTrackElement::Failure);
202         return;
203     }
204
205     track().scheduleLoad(url);
206 }
207
208 bool HTMLTrackElement::canLoadURL(const URL& url)
209 {
210     HTMLMediaElement* parent = mediaElement();
211     if (!parent)
212         return false;
213
214     // 4.8.10.12.3 Sourcing out-of-band text tracks
215
216     // 4. Download: If URL is not the empty string, perform a potentially CORS-enabled fetch of URL, with the
217     // mode being the state of the media element's crossorigin content attribute, the origin being the
218     // origin of the media element's Document, and the default origin behaviour set to fail.
219     if (url.isEmpty())
220         return false;
221
222     ASSERT(document().contentSecurityPolicy());
223     // Elements in user agent show tree should load whatever the embedding document policy is.
224     if (!isInUserAgentShadowTree() && !document().contentSecurityPolicy()->allowMediaFromSource(url)) {
225         LOG(Media, "HTMLTrackElement::canLoadURL(%s) -> rejected by Content Security Policy", urlForLoggingTrack(url).utf8().data());
226         return false;
227     }
228
229     return dispatchBeforeLoadEvent(url.string());
230 }
231
232 void HTMLTrackElement::didCompleteLoad(LoadStatus status)
233 {
234     // 4.8.10.12.3 Sourcing out-of-band text tracks (continued)
235     
236     // 4. Download: ...
237     // If the fetching algorithm fails for any reason (network error, the server returns an error 
238     // code, a cross-origin check fails, etc), or if URL is the empty string or has the wrong origin 
239     // as determined by the condition at the start of this step, or if the fetched resource is not in
240     // a supported format, then queue a task to first change the text track readiness state to failed
241     // to load and then fire a simple event named error at the track element; and then, once that task
242     // is queued, move on to the step below labeled monitoring.
243
244     if (status == Failure) {
245         setReadyState(HTMLTrackElement::TRACK_ERROR);
246         dispatchEvent(Event::create(eventNames().errorEvent, false, false));
247         return;
248     }
249
250     // If the fetching algorithm does not fail, then the final task that is queued by the networking
251     // task source must run the following steps:
252     //     1. Change the text track readiness state to loaded.
253     setReadyState(HTMLTrackElement::LOADED);
254
255     //     2. If the file was successfully processed, fire a simple event named load at the 
256     //        track element.
257     dispatchEvent(Event::create(eventNames().loadEvent, false, false));
258 }
259
260 // NOTE: The values in the TextTrack::ReadinessState enum must stay in sync with those in HTMLTrackElement::ReadyState.
261 COMPILE_ASSERT(HTMLTrackElement::NONE == static_cast<HTMLTrackElement::ReadyState>(TextTrack::NotLoaded), TextTrackEnumNotLoaded_Is_Wrong_Should_Be_HTMLTrackElementEnumNONE);
262 COMPILE_ASSERT(HTMLTrackElement::LOADING == static_cast<HTMLTrackElement::ReadyState>(TextTrack::Loading), TextTrackEnumLoadingIsWrong_ShouldBe_HTMLTrackElementEnumLOADING);
263 COMPILE_ASSERT(HTMLTrackElement::LOADED == static_cast<HTMLTrackElement::ReadyState>(TextTrack::Loaded), TextTrackEnumLoaded_Is_Wrong_Should_Be_HTMLTrackElementEnumLOADED);
264 COMPILE_ASSERT(HTMLTrackElement::TRACK_ERROR == static_cast<HTMLTrackElement::ReadyState>(TextTrack::FailedToLoad), TextTrackEnumFailedToLoad_Is_Wrong_Should_Be_HTMLTrackElementEnumTRACK_ERROR);
265
266 void HTMLTrackElement::setReadyState(ReadyState state)
267 {
268     track().setReadinessState(static_cast<TextTrack::ReadinessState>(state));
269     if (HTMLMediaElement* parent = mediaElement())
270         parent->textTrackReadyStateChanged(m_track.get());
271 }
272
273 HTMLTrackElement::ReadyState HTMLTrackElement::readyState() 
274 {
275     return static_cast<ReadyState>(track().readinessState());
276 }
277
278 const AtomicString& HTMLTrackElement::mediaElementCrossOriginAttribute() const
279 {
280     if (HTMLMediaElement* parent = mediaElement())
281         return parent->attributeWithoutSynchronization(HTMLNames::crossoriginAttr);
282     return nullAtom;
283 }
284
285 void HTMLTrackElement::textTrackKindChanged(TextTrack& track)
286 {
287     if (auto* parent = mediaElement())
288         parent->textTrackKindChanged(track);
289 }
290
291 void HTMLTrackElement::textTrackModeChanged(TextTrack& track)
292 {
293     // Since we've moved to a new parent, we may now be able to load.
294     if (readyState() == HTMLTrackElement::NONE)
295         scheduleLoad();
296
297     if (auto* parent = mediaElement())
298         parent->textTrackModeChanged(track);
299 }
300
301 void HTMLTrackElement::textTrackAddCues(TextTrack& track, const TextTrackCueList& cues)
302 {
303     if (auto* parent = mediaElement())
304         parent->textTrackAddCues(track, cues);
305 }
306     
307 void HTMLTrackElement::textTrackRemoveCues(TextTrack& track, const TextTrackCueList& cues)
308 {
309     if (auto* parent = mediaElement())
310         parent->textTrackRemoveCues(track, cues);
311 }
312     
313 void HTMLTrackElement::textTrackAddCue(TextTrack& track, TextTrackCue& cue)
314 {
315     if (auto* parent = mediaElement())
316         parent->textTrackAddCue(track, cue);
317 }
318     
319 void HTMLTrackElement::textTrackRemoveCue(TextTrack& track, TextTrackCue& cue)
320 {
321     if (auto* parent = mediaElement())
322         parent->textTrackRemoveCue(track, cue);
323 }
324
325 HTMLMediaElement* HTMLTrackElement::mediaElement() const
326 {
327     auto* parent = parentElement();
328     if (!is<HTMLMediaElement>(parent))
329         return nullptr;
330     return downcast<HTMLMediaElement>(parent);
331 }
332
333 }
334
335 #endif