onload callback for <track> element attached to <video> does not fire
[WebKit-https.git] / Source / WebCore / html / HTMLTrackElement.cpp
1 /*
2  * Copyright (C) 2011 Google 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 COMPUTER, 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 COMPUTER, 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_TRACK)
29 #include "HTMLTrackElement.h"
30
31 #include "ContentSecurityPolicy.h"
32 #include "Event.h"
33 #include "HTMLMediaElement.h"
34 #include "HTMLNames.h"
35 #include "Logging.h"
36 #include "RuntimeEnabledFeatures.h"
37 #include "ScriptCallStack.h"
38 #include "ScriptEventListener.h"
39 using namespace std;
40
41
42 namespace WebCore {
43
44 using namespace HTMLNames;
45
46 #if !LOG_DISABLED
47 static String urlForLoggingTrack(const KURL& 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 #endif
56     
57 inline HTMLTrackElement::HTMLTrackElement(const QualifiedName& tagName, Document* document)
58     : HTMLElement(tagName, document)
59     , m_loadTimer(this, &HTMLTrackElement::loadTimerFired)
60 {
61     LOG(Media, "HTMLTrackElement::HTMLTrackElement - %p", this);
62     ASSERT(hasTagName(trackTag));
63 }
64
65 HTMLTrackElement::~HTMLTrackElement()
66 {
67     if (m_track)
68         m_track->clearClient();
69 }
70
71 PassRefPtr<HTMLTrackElement> HTMLTrackElement::create(const QualifiedName& tagName, Document* document)
72 {
73     return adoptRef(new HTMLTrackElement(tagName, document));
74 }
75
76 Node::InsertionNotificationRequest HTMLTrackElement::insertedInto(ContainerNode* insertionPoint)
77 {
78     // Since we've moved to a new parent, we may now be able to load.
79     scheduleLoad();
80
81     HTMLElement::insertedInto(insertionPoint);
82     HTMLMediaElement* parent = mediaElement();
83     if (insertionPoint == parent)
84         parent->didAddTrack(this);
85     return InsertionDone;
86 }
87
88 void HTMLTrackElement::removedFrom(ContainerNode* insertionPoint)
89 {
90     if (!parentNode() && WebCore::isMediaElement(insertionPoint))
91         toMediaElement(insertionPoint)->didRemoveTrack(this);
92     HTMLElement::removedFrom(insertionPoint);
93 }
94
95 void HTMLTrackElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
96 {
97     if (RuntimeEnabledFeatures::webkitVideoTrackEnabled()) {
98         if (name == srcAttr) {
99             if (!value.isEmpty())
100                 scheduleLoad();
101             else if (m_track)
102                 m_track->removeAllCues();
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()->setKind(value.lower());
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
116     if (name == onloadAttr)
117         setAttributeEventListener(eventNames().loadEvent, createAttributeEventListener(this, name, value));
118     else if (name == onerrorAttr)
119         setAttributeEventListener(eventNames().errorEvent, createAttributeEventListener(this, name, value));
120     else
121         HTMLElement::parseAttribute(name, value);
122 }
123
124 KURL HTMLTrackElement::src() const
125 {
126     return document()->completeURL(getAttribute(srcAttr));
127 }
128
129 void HTMLTrackElement::setSrc(const String& url)
130 {
131     setAttribute(srcAttr, url);
132 }
133
134 String HTMLTrackElement::kind()
135 {
136     return track()->kind();
137 }
138
139 void HTMLTrackElement::setKind(const String& kind)
140 {
141     setAttribute(kindAttr, kind);
142 }
143
144 String HTMLTrackElement::srclang() const
145 {
146     return getAttribute(srclangAttr);
147 }
148
149 void HTMLTrackElement::setSrclang(const String& srclang)
150 {
151     setAttribute(srclangAttr, srclang);
152 }
153
154 String HTMLTrackElement::label() const
155 {
156     return getAttribute(labelAttr);
157 }
158
159 void HTMLTrackElement::setLabel(const String& label)
160 {
161     setAttribute(labelAttr, label);
162 }
163
164 bool HTMLTrackElement::isDefault() const
165 {
166     return fastHasAttribute(defaultAttr);
167 }
168
169 void HTMLTrackElement::setIsDefault(bool isDefault)
170 {
171     setBooleanAttribute(defaultAttr, isDefault);
172 }
173
174 LoadableTextTrack* HTMLTrackElement::ensureTrack()
175 {
176     if (!m_track) {
177         // The kind attribute is an enumerated attribute, limited only to know values. It defaults to 'subtitles' if missing or invalid.
178         String kind = getAttribute(kindAttr).lower();
179         if (!TextTrack::isValidKindKeyword(kind))
180             kind = TextTrack::subtitlesKeyword();
181         m_track = LoadableTextTrack::create(this, kind, label(), srclang());
182     }
183     return m_track.get();
184 }
185
186 TextTrack* HTMLTrackElement::track()
187 {
188     return ensureTrack();
189 }
190
191 bool HTMLTrackElement::isURLAttribute(const Attribute& attribute) const
192 {
193     return attribute.name() == srcAttr || HTMLElement::isURLAttribute(attribute);
194 }
195
196 void HTMLTrackElement::scheduleLoad()
197 {
198     // 1. If another occurrence of this algorithm is already running for this text track and its track element,
199     // abort these steps, letting that other algorithm take care of this element.
200     if (m_loadTimer.isActive())
201         return;
202
203     if (!RuntimeEnabledFeatures::webkitVideoTrackEnabled())
204         return;
205
206     // 2. If the text track's text track mode is not set to one of hidden or showing, abort these steps.
207     if (ensureTrack()->mode() != TextTrack::hiddenKeyword() && ensureTrack()->mode() != TextTrack::showingKeyword())
208         return;
209
210     // 3. If the text track's track element does not have a media element as a parent, abort these steps.
211     if (!mediaElement())
212         return;
213
214     // 4. Run the remainder of these steps asynchronously, allowing whatever caused these steps to run to continue.
215     m_loadTimer.startOneShot(0);
216 }
217
218 void HTMLTrackElement::loadTimerFired(Timer<HTMLTrackElement>*)
219 {
220     if (!fastHasAttribute(srcAttr))
221         return;
222
223     // 6. Set the text track readiness state to loading.
224     setReadyState(HTMLTrackElement::LOADING);
225
226     // 7. Let URL be the track URL of the track element.
227     KURL url = getNonEmptyURLAttribute(srcAttr);
228
229     // 8. If the track element's parent is a media element then let CORS mode be the state of the parent media
230     // element's crossorigin content attribute. Otherwise, let CORS mode be No CORS.
231     if (!canLoadUrl(url)) {
232         didCompleteLoad(ensureTrack(), HTMLTrackElement::Failure);
233         return;
234     }
235
236     ensureTrack()->scheduleLoad(url);
237 }
238
239 bool HTMLTrackElement::canLoadUrl(const KURL& url)
240 {
241     if (!RuntimeEnabledFeatures::webkitVideoTrackEnabled())
242         return false;
243
244     HTMLMediaElement* parent = mediaElement();
245     if (!parent)
246         return false;
247
248     // 4.8.10.12.3 Sourcing out-of-band text tracks
249
250     // 4. Download: If URL is not the empty string, perform a potentially CORS-enabled fetch of URL, with the
251     // mode being the state of the media element's crossorigin content attribute, the origin being the
252     // origin of the media element's Document, and the default origin behaviour set to fail.
253     if (url.isEmpty())
254         return false;
255
256     if (!document()->contentSecurityPolicy()->allowMediaFromSource(url)) {
257         DEFINE_STATIC_LOCAL(String, consoleMessage, (ASCIILiteral("Text track load denied by Content Security Policy.")));
258         document()->addConsoleMessage(JSMessageSource, ErrorMessageLevel, consoleMessage);
259         LOG(Media, "HTMLTrackElement::canLoadUrl(%s) -> rejected by Content Security Policy", urlForLoggingTrack(url).utf8().data());
260         return false;
261     }
262     
263     return dispatchBeforeLoadEvent(url.string());
264 }
265
266 void HTMLTrackElement::didCompleteLoad(LoadableTextTrack*, LoadStatus status)
267 {
268     ExceptionCode ec = 0;
269
270     // 4.8.10.12.3 Sourcing out-of-band text tracks (continued)
271     
272     // 4. Download: ...
273     // If the fetching algorithm fails for any reason (network error, the server returns an error 
274     // code, a cross-origin check fails, etc), or if URL is the empty string or has the wrong origin 
275     // as determined by the condition at the start of this step, or if the fetched resource is not in
276     // a supported format, then queue a task to first change the text track readiness state to failed
277     // to load and then fire a simple event named error at the track element; and then, once that task
278     // is queued, move on to the step below labeled monitoring.
279
280     if (status == Failure) {
281         setReadyState(HTMLTrackElement::TRACK_ERROR);
282         dispatchEvent(Event::create(eventNames().errorEvent, false, false), ec);
283         return;
284     }
285
286     // If the fetching algorithm does not fail, then the final task that is queued by the networking
287     // task source must run the following steps:
288     //     1. Change the text track readiness state to loaded.
289     setReadyState(HTMLTrackElement::LOADED);
290
291     //     2. If the file was successfully processed, fire a simple event named load at the 
292     //        track element.
293     dispatchEvent(Event::create(eventNames().loadEvent, false, false), ec);
294 }
295
296 // NOTE: The values in the TextTrack::ReadinessState enum must stay in sync with those in HTMLTrackElement::ReadyState.
297 COMPILE_ASSERT(HTMLTrackElement::NONE == static_cast<HTMLTrackElement::ReadyState>(TextTrack::NotLoaded), TextTrackEnumNotLoaded_Is_Wrong_Should_Be_HTMLTrackElementEnumNONE);
298 COMPILE_ASSERT(HTMLTrackElement::LOADING == static_cast<HTMLTrackElement::ReadyState>(TextTrack::Loading), TextTrackEnumLoadingIsWrong_ShouldBe_HTMLTrackElementEnumLOADING);
299 COMPILE_ASSERT(HTMLTrackElement::LOADED == static_cast<HTMLTrackElement::ReadyState>(TextTrack::Loaded), TextTrackEnumLoaded_Is_Wrong_Should_Be_HTMLTrackElementEnumLOADED);
300 COMPILE_ASSERT(HTMLTrackElement::TRACK_ERROR == static_cast<HTMLTrackElement::ReadyState>(TextTrack::FailedToLoad), TextTrackEnumFailedToLoad_Is_Wrong_Should_Be_HTMLTrackElementEnumTRACK_ERROR);
301
302 void HTMLTrackElement::setReadyState(ReadyState state)
303 {
304     ensureTrack()->setReadinessState(static_cast<TextTrack::ReadinessState>(state));
305     if (HTMLMediaElement* parent = mediaElement())
306         return parent->textTrackReadyStateChanged(m_track.get());
307 }
308
309 HTMLTrackElement::ReadyState HTMLTrackElement::readyState() 
310 {
311     return static_cast<ReadyState>(ensureTrack()->readinessState());
312 }
313
314 const AtomicString& HTMLTrackElement::mediaElementCrossOriginAttribute() const
315 {
316     if (HTMLMediaElement* parent = mediaElement())
317         return parent->fastGetAttribute(HTMLNames::crossoriginAttr);
318     
319     return nullAtom;
320 }
321
322 void HTMLTrackElement::textTrackKindChanged(TextTrack* track)
323 {
324     if (HTMLMediaElement* parent = mediaElement())
325         return parent->textTrackKindChanged(track);
326 }
327
328 void HTMLTrackElement::textTrackModeChanged(TextTrack* track)
329 {
330     // Since we've moved to a new parent, we may now be able to load.
331     if (readyState() == HTMLTrackElement::NONE)
332         scheduleLoad();
333
334     if (HTMLMediaElement* parent = mediaElement())
335         return parent->textTrackModeChanged(track);
336 }
337
338 void HTMLTrackElement::textTrackAddCues(TextTrack* track, const TextTrackCueList* cues)
339 {
340     if (HTMLMediaElement* parent = mediaElement())
341         return parent->textTrackAddCues(track, cues);
342 }
343     
344 void HTMLTrackElement::textTrackRemoveCues(TextTrack* track, const TextTrackCueList* cues)
345 {
346     if (HTMLMediaElement* parent = mediaElement())
347         return parent->textTrackRemoveCues(track, cues);
348 }
349     
350 void HTMLTrackElement::textTrackAddCue(TextTrack* track, PassRefPtr<TextTrackCue> cue)
351 {
352     if (HTMLMediaElement* parent = mediaElement())
353         return parent->textTrackAddCue(track, cue);
354 }
355     
356 void HTMLTrackElement::textTrackRemoveCue(TextTrack* track, PassRefPtr<TextTrackCue> cue)
357 {
358     if (HTMLMediaElement* parent = mediaElement())
359         return parent->textTrackRemoveCue(track, cue);
360 }
361
362 HTMLMediaElement* HTMLTrackElement::mediaElement() const
363 {
364     Element* parent = parentElement();
365     if (parent && parent->isMediaElement())
366         return static_cast<HTMLMediaElement*>(parentNode());
367
368     return 0;
369 }
370
371 #if ENABLE(MICRODATA)
372 String HTMLTrackElement::itemValueText() const
373 {
374     return getURLAttribute(srcAttr);
375 }
376
377 void HTMLTrackElement::setItemValueText(const String& value, ExceptionCode&)
378 {
379     setAttribute(srcAttr, value);
380 }
381 #endif
382
383 }
384
385 #endif