Replace some auto* with RefPtr within WebCore/html
[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::InsertedIntoAncestorResult HTMLTrackElement::insertedIntoAncestor(InsertionType insertionType, ContainerNode& parentOfInsertedTree)
80 {
81     HTMLElement::insertedIntoAncestor(insertionType, parentOfInsertedTree);
82
83     if (parentNode() == &parentOfInsertedTree && is<HTMLMediaElement>(parentOfInsertedTree)) {
84         downcast<HTMLMediaElement>(parentOfInsertedTree).didAddTextTrack(*this);
85         scheduleLoad();
86     }
87
88     return InsertedIntoAncestorResult::Done;
89 }
90
91 void HTMLTrackElement::removedFromAncestor(RemovalType removalType, ContainerNode& oldParentOfRemovedTree)
92 {
93     HTMLElement::removedFromAncestor(removalType, oldParentOfRemovedTree);
94
95     if (!parentNode() && is<HTMLMediaElement>(oldParentOfRemovedTree))
96         downcast<HTMLMediaElement>(oldParentOfRemovedTree).didRemoveTextTrack(*this);
97 }
98
99 void HTMLTrackElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
100 {
101     if (name == srcAttr) {
102         scheduleLoad();
103
104     // 4.8.10.12.3 Sourcing out-of-band text tracks
105     // As the kind, label, and srclang attributes are set, changed, or removed, the text track must update accordingly...
106     } else if (name == kindAttr)
107         track().setKindKeywordIgnoringASCIICase(value.string());
108     else if (name == labelAttr)
109         track().setLabel(value);
110     else if (name == srclangAttr)
111         track().setLanguage(value);
112     else if (name == defaultAttr)
113         track().setIsDefault(!value.isNull());
114
115     HTMLElement::parseAttribute(name, value);
116 }
117
118 const AtomicString& HTMLTrackElement::kind()
119 {
120     return track().kindKeyword();
121 }
122
123 void HTMLTrackElement::setKind(const AtomicString& kind)
124 {
125     setAttributeWithoutSynchronization(kindAttr, kind);
126 }
127
128 const AtomicString& HTMLTrackElement::srclang() const
129 {
130     return attributeWithoutSynchronization(srclangAttr);
131 }
132
133 const AtomicString& HTMLTrackElement::label() const
134 {
135     return attributeWithoutSynchronization(labelAttr);
136 }
137
138 bool HTMLTrackElement::isDefault() const
139 {
140     return hasAttributeWithoutSynchronization(defaultAttr);
141 }
142
143 LoadableTextTrack& HTMLTrackElement::track()
144 {
145     // FIXME: There is no practical value in lazily initializing this.
146     // Instead this should be created in the constructor.
147     if (!m_track) {
148         // The kind attribute is an enumerated attribute, limited only to known values. It defaults to 'subtitles' if missing or invalid.
149         String kind = attributeWithoutSynchronization(kindAttr).convertToASCIILowercase();
150         if (!TextTrack::isValidKindKeyword(kind))
151             kind = TextTrack::subtitlesKeyword();
152         m_track = LoadableTextTrack::create(*this, kind, label(), srclang());
153     }
154     ASSERT(m_track->trackElement() == this);
155
156     return *m_track;
157 }
158
159 bool HTMLTrackElement::isURLAttribute(const Attribute& attribute) const
160 {
161     return attribute.name() == srcAttr || HTMLElement::isURLAttribute(attribute);
162 }
163
164 void HTMLTrackElement::scheduleLoad()
165 {
166     // 1. If another occurrence of this algorithm is already running for this text track and its track element,
167     // abort these steps, letting that other algorithm take care of this element.
168     if (m_loadTimer.isActive())
169         return;
170
171     // 2. If the text track's text track mode is not set to one of hidden or showing, abort these steps.
172     if (track().mode() != TextTrack::Mode::Hidden && track().mode() != TextTrack::Mode::Showing)
173         return;
174
175     // 3. If the text track's track element does not have a media element as a parent, abort these steps.
176     if (!mediaElement())
177         return;
178
179     // 4. Run the remainder of these steps asynchronously, allowing whatever caused these steps to run to continue.
180     m_loadTimer.startOneShot(0_s);
181 }
182
183 void HTMLTrackElement::loadTimerFired()
184 {
185     if (!hasAttributeWithoutSynchronization(srcAttr)) {
186         track().removeAllCues();
187         return;
188     }
189
190     // 6. Set the text track readiness state to loading.
191     setReadyState(HTMLTrackElement::LOADING);
192
193     // 7. Let URL be the track URL of the track element.
194     URL url = getNonEmptyURLAttribute(srcAttr);
195
196     // ... if URL is the empty string, then queue a task to first change the text track readiness state
197     // to failed to load and then fire an event named error at the track element.
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 (url.isEmpty() || !canLoadURL(url)) {
201         track().removeAllCues();
202         didCompleteLoad(HTMLTrackElement::Failure);
203         return;
204     }
205
206     track().scheduleLoad(url);
207 }
208
209 bool HTMLTrackElement::canLoadURL(const URL& url)
210 {
211     auto parent = mediaElement();
212     if (!parent)
213         return false;
214
215     // 4.8.10.12.3 Sourcing out-of-band text tracks
216
217     // 4. Download: If URL is not the empty string, perform a potentially CORS-enabled fetch of URL, with the
218     // mode being the state of the media element's crossorigin content attribute, the origin being the
219     // origin of the media element's Document, and the default origin behaviour set to fail.
220     if (url.isEmpty())
221         return false;
222
223     ASSERT(document().contentSecurityPolicy());
224     // Elements in user agent show tree should load whatever the embedding document policy is.
225     if (!isInUserAgentShadowTree() && !document().contentSecurityPolicy()->allowMediaFromSource(url)) {
226         LOG(Media, "HTMLTrackElement::canLoadURL(%s) -> rejected by Content Security Policy", urlForLoggingTrack(url).utf8().data());
227         return false;
228     }
229
230     return dispatchBeforeLoadEvent(url.string());
231 }
232
233 void HTMLTrackElement::didCompleteLoad(LoadStatus status)
234 {
235     // 4.8.10.12.3 Sourcing out-of-band text tracks (continued)
236     
237     // 4. Download: ...
238     // If the fetching algorithm fails for any reason (network error, the server returns an error 
239     // code, a cross-origin check fails, etc), or if URL is the empty string or has the wrong origin 
240     // as determined by the condition at the start of this step, or if the fetched resource is not in
241     // a supported format, then queue a task to first change the text track readiness state to failed
242     // to load and then fire a simple event named error at the track element; and then, once that task
243     // is queued, move on to the step below labeled monitoring.
244
245     if (status == Failure) {
246         setReadyState(HTMLTrackElement::TRACK_ERROR);
247         dispatchEvent(Event::create(eventNames().errorEvent, false, false));
248         return;
249     }
250
251     // If the fetching algorithm does not fail, then the final task that is queued by the networking
252     // task source must run the following steps:
253     //     1. Change the text track readiness state to loaded.
254     setReadyState(HTMLTrackElement::LOADED);
255
256     //     2. If the file was successfully processed, fire a simple event named load at the 
257     //        track element.
258     dispatchEvent(Event::create(eventNames().loadEvent, false, false));
259 }
260
261 // NOTE: The values in the TextTrack::ReadinessState enum must stay in sync with those in HTMLTrackElement::ReadyState.
262 COMPILE_ASSERT(HTMLTrackElement::NONE == static_cast<HTMLTrackElement::ReadyState>(TextTrack::NotLoaded), TextTrackEnumNotLoaded_Is_Wrong_Should_Be_HTMLTrackElementEnumNONE);
263 COMPILE_ASSERT(HTMLTrackElement::LOADING == static_cast<HTMLTrackElement::ReadyState>(TextTrack::Loading), TextTrackEnumLoadingIsWrong_ShouldBe_HTMLTrackElementEnumLOADING);
264 COMPILE_ASSERT(HTMLTrackElement::LOADED == static_cast<HTMLTrackElement::ReadyState>(TextTrack::Loaded), TextTrackEnumLoaded_Is_Wrong_Should_Be_HTMLTrackElementEnumLOADED);
265 COMPILE_ASSERT(HTMLTrackElement::TRACK_ERROR == static_cast<HTMLTrackElement::ReadyState>(TextTrack::FailedToLoad), TextTrackEnumFailedToLoad_Is_Wrong_Should_Be_HTMLTrackElementEnumTRACK_ERROR);
266
267 void HTMLTrackElement::setReadyState(ReadyState state)
268 {
269     track().setReadinessState(static_cast<TextTrack::ReadinessState>(state));
270     if (auto parent = mediaElement())
271         parent->textTrackReadyStateChanged(m_track.get());
272 }
273
274 HTMLTrackElement::ReadyState HTMLTrackElement::readyState() 
275 {
276     return static_cast<ReadyState>(track().readinessState());
277 }
278
279 const AtomicString& HTMLTrackElement::mediaElementCrossOriginAttribute() const
280 {
281     if (auto parent = mediaElement())
282         return parent->attributeWithoutSynchronization(HTMLNames::crossoriginAttr);
283     return nullAtom();
284 }
285
286 void HTMLTrackElement::textTrackKindChanged(TextTrack& track)
287 {
288     if (auto parent = mediaElement())
289         parent->textTrackKindChanged(track);
290 }
291
292 void HTMLTrackElement::textTrackModeChanged(TextTrack& track)
293 {
294     // Since we've moved to a new parent, we may now be able to load.
295     if (readyState() == HTMLTrackElement::NONE)
296         scheduleLoad();
297
298     if (auto parent = mediaElement())
299         parent->textTrackModeChanged(track);
300 }
301
302 void HTMLTrackElement::textTrackAddCues(TextTrack& track, const TextTrackCueList& cues)
303 {
304     if (auto parent = mediaElement())
305         parent->textTrackAddCues(track, cues);
306 }
307     
308 void HTMLTrackElement::textTrackRemoveCues(TextTrack& track, const TextTrackCueList& cues)
309 {
310     if (auto parent = mediaElement())
311         parent->textTrackRemoveCues(track, cues);
312 }
313     
314 void HTMLTrackElement::textTrackAddCue(TextTrack& track, TextTrackCue& cue)
315 {
316     if (auto parent = mediaElement())
317         parent->textTrackAddCue(track, cue);
318 }
319     
320 void HTMLTrackElement::textTrackRemoveCue(TextTrack& track, TextTrackCue& cue)
321 {
322     if (auto parent = mediaElement())
323         parent->textTrackRemoveCue(track, cue);
324 }
325
326 RefPtr<HTMLMediaElement> HTMLTrackElement::mediaElement() const
327 {
328     auto parent = makeRefPtr(parentElement());
329     if (!is<HTMLMediaElement>(parent))
330         return nullptr;
331     return downcast<HTMLMediaElement>(parent.get());
332 }
333
334 }
335
336 #endif