Update HTMLMediaElement's index of cues when TextTrack.mode changes to
[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 "ScriptEventListener.h"
38
39 using namespace std;
40
41 namespace WebCore {
42
43 using namespace HTMLNames;
44
45 #if !LOG_DISABLED
46 static String urlForLogging(const KURL& url)
47 {
48     static const unsigned maximumURLLengthForLogging = 128;
49     
50     if (url.string().length() < maximumURLLengthForLogging)
51         return url.string();
52     return url.string().substring(0, maximumURLLengthForLogging) + "...";
53 }
54 #endif
55     
56 inline HTMLTrackElement::HTMLTrackElement(const QualifiedName& tagName, Document* document)
57     : HTMLElement(tagName, document)
58     , m_hasBeenConfigured(false)
59 {
60     LOG(Media, "HTMLTrackElement::HTMLTrackElement - %p", this);
61     ASSERT(hasTagName(trackTag));
62 }
63
64 HTMLTrackElement::~HTMLTrackElement()
65 {
66     if (m_track)
67         m_track->clearClient();
68 }
69
70 PassRefPtr<HTMLTrackElement> HTMLTrackElement::create(const QualifiedName& tagName, Document* document)
71 {
72     return adoptRef(new HTMLTrackElement(tagName, document));
73 }
74
75 void HTMLTrackElement::insertedIntoTree(bool deep)
76 {
77     HTMLElement::insertedIntoTree(deep);
78
79     if (HTMLMediaElement* parent = mediaElement())
80         parent->didAddTrack(this);
81 }
82
83 void HTMLTrackElement::willRemove()
84 {
85     if (HTMLMediaElement* parent = mediaElement())
86         parent->willRemoveTrack(this);
87
88     HTMLElement::willRemove();
89 }
90
91 void HTMLTrackElement::parseAttribute(Attribute* attribute)
92 {
93     const QualifiedName& attrName = attribute->name();
94
95     if (RuntimeEnabledFeatures::webkitVideoTrackEnabled()) {
96         if (attrName == srcAttr) {
97             if (!attribute->isEmpty() && mediaElement())
98                 scheduleLoad();
99             // 4.8.10.12.3 Sourcing out-of-band text tracks
100             // As the kind, label, and srclang attributes are set, changed, or removed, the text track must update accordingly...
101         } else if (attrName == kindAttr)
102             track()->setKind(attribute->value());
103         else if (attrName == labelAttr)
104             track()->setLabel(attribute->value());
105         else if (attrName == srclangAttr)
106             track()->setLanguage(attribute->value());
107     }
108
109     if (attrName == onloadAttr)
110         setAttributeEventListener(eventNames().loadEvent, createAttributeEventListener(this, attribute));
111     else if (attrName == onerrorAttr)
112         setAttributeEventListener(eventNames().errorEvent, createAttributeEventListener(this, attribute));
113     else
114         HTMLElement::parseAttribute(attribute);
115 }
116
117 KURL HTMLTrackElement::src() const
118 {
119     return document()->completeURL(getAttribute(srcAttr));
120 }
121
122 void HTMLTrackElement::setSrc(const String& url)
123 {
124     setAttribute(srcAttr, url);
125 }
126
127 String HTMLTrackElement::kind()
128 {
129     return track()->kind();
130 }
131
132 void HTMLTrackElement::setKind(const String& kind)
133 {
134     setAttribute(kindAttr, kind);
135 }
136
137 String HTMLTrackElement::srclang() const
138 {
139     return getAttribute(srclangAttr);
140 }
141
142 void HTMLTrackElement::setSrclang(const String& srclang)
143 {
144     setAttribute(srclangAttr, srclang);
145 }
146
147 String HTMLTrackElement::label() const
148 {
149     return getAttribute(labelAttr);
150 }
151
152 void HTMLTrackElement::setLabel(const String& label)
153 {
154     setAttribute(labelAttr, label);
155 }
156
157 bool HTMLTrackElement::isDefault() const
158 {
159     return fastHasAttribute(defaultAttr);
160 }
161
162 void HTMLTrackElement::setIsDefault(bool isDefault)
163 {
164     setBooleanAttribute(defaultAttr, isDefault);
165 }
166
167 LoadableTextTrack* HTMLTrackElement::ensureTrack()
168 {
169     if (!m_track) {
170         // The kind attribute is an enumerated attribute, limited only to know values. It defaults to 'subtitles' if missing or invalid.
171         String kind = getAttribute(kindAttr);
172         if (!TextTrack::isValidKindKeyword(kind))
173             kind = TextTrack::subtitlesKeyword();
174         m_track = LoadableTextTrack::create(this, kind, label(), srclang(), isDefault());
175     }
176     return m_track.get();
177 }
178
179 TextTrack* HTMLTrackElement::track()
180 {
181     return ensureTrack();
182 }
183
184 bool HTMLTrackElement::isURLAttribute(Attribute* attribute) const
185 {
186     return attribute->name() == srcAttr || HTMLElement::isURLAttribute(attribute);
187 }
188
189 void HTMLTrackElement::scheduleLoad()
190 {
191     if (!RuntimeEnabledFeatures::webkitVideoTrackEnabled())
192         return;
193
194     if (!mediaElement())
195         return;
196
197     if (!fastHasAttribute(srcAttr))
198         return;
199
200     // 4.8.10.12.3 Sourcing out-of-band text tracks
201
202     // 1. Set the text track readiness state to loading.
203     setReadyState(HTMLTrackElement::LOADING);
204
205     KURL url = getNonEmptyURLAttribute(srcAttr);
206     if (!canLoadUrl(url)) {
207         didCompleteLoad(ensureTrack(), HTMLTrackElement::Failure);
208         return;
209     }
210
211     ensureTrack()->scheduleLoad(url);
212 }
213
214 bool HTMLTrackElement::canLoadUrl(const KURL& url)
215 {
216     if (!RuntimeEnabledFeatures::webkitVideoTrackEnabled())
217         return false;
218
219     HTMLMediaElement* parent = mediaElement();
220     if (!parent)
221         return false;
222
223     // 4.8.10.12.3 Sourcing out-of-band text tracks
224
225     // 4. Download: If URL is not the empty string, perform a potentially CORS-enabled fetch of URL, with the
226     // mode being the state of the media element's crossorigin content attribute, the origin being the
227     // origin of the media element's Document, and the default origin behaviour set to fail.
228     if (url.isEmpty())
229         return false;
230
231     if (!document()->contentSecurityPolicy()->allowMediaFromSource(url)) {
232         DEFINE_STATIC_LOCAL(String, consoleMessage, ("Text track load denied by Content Security Policy."));
233         document()->addConsoleMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, consoleMessage);
234         LOG(Media, "HTMLTrackElement::canLoadUrl(%s) -> rejected by Content Security Policy", urlForLogging(url).utf8().data());
235         return false;
236     }
237     
238     return dispatchBeforeLoadEvent(url.string());
239 }
240
241 void HTMLTrackElement::didCompleteLoad(LoadableTextTrack*, LoadStatus status)
242 {
243     ExceptionCode ec = 0;
244
245     // 4.8.10.12.3 Sourcing out-of-band text tracks (continued)
246     
247     // 4. Download: ...
248     // If the fetching algorithm fails for any reason (network error, the server returns an error 
249     // code, a cross-origin check fails, etc), or if URL is the empty string or has the wrong origin 
250     // as determined by the condition at the start of this step, or if the fetched resource is not in
251     // a supported format, then queue a task to first change the text track readiness state to failed
252     // to load and then fire a simple event named error at the track element; and then, once that task
253     // is queued, move on to the step below labeled monitoring.
254
255     if (status == Failure) {
256         setReadyState(HTMLTrackElement::TRACK_ERROR);
257         dispatchEvent(Event::create(eventNames().errorEvent, false, false), ec);
258         return;
259     }
260
261     // If the fetching algorithm does not fail, then the final task that is queued by the networking
262     // task source must run the following steps:
263     //     1. Change the text track readiness state to loaded.
264     setReadyState(HTMLTrackElement::LOADED);
265
266     //     2. If the file was successfully processed, fire a simple event named load at the 
267     //        track element.
268     dispatchEvent(Event::create(eventNames().loadEvent, false, false), ec);
269 }
270
271 // NOTE: The values in the TextTrack::ReadinessState enum must stay in sync with those in HTMLTrackElement::ReadyState.
272 COMPILE_ASSERT(HTMLTrackElement::NONE == static_cast<HTMLTrackElement::ReadyState>(TextTrack::NotLoaded), TextTrackEnumNotLoaded_Is_Wrong_Should_Be_HTMLTrackElementEnumNONE);
273 COMPILE_ASSERT(HTMLTrackElement::LOADING == static_cast<HTMLTrackElement::ReadyState>(TextTrack::Loading), TextTrackEnumLoadingIsWrong_ShouldBe_HTMLTrackElementEnumLOADING);
274 COMPILE_ASSERT(HTMLTrackElement::LOADED == static_cast<HTMLTrackElement::ReadyState>(TextTrack::Loaded), TextTrackEnumLoaded_Is_Wrong_Should_Be_HTMLTrackElementEnumLOADED);
275 COMPILE_ASSERT(HTMLTrackElement::TRACK_ERROR == static_cast<HTMLTrackElement::ReadyState>(TextTrack::FailedToLoad), TextTrackEnumFailedToLoad_Is_Wrong_Should_Be_HTMLTrackElementEnumTRACK_ERROR);
276
277 void HTMLTrackElement::setReadyState(ReadyState state)
278 {
279     ensureTrack()->setReadinessState(static_cast<TextTrack::ReadinessState>(state));
280     if (HTMLMediaElement* parent = mediaElement())
281         return parent->textTrackReadyStateChanged(m_track.get());
282 }
283
284 HTMLTrackElement::ReadyState HTMLTrackElement::readyState() 
285 {
286     return static_cast<ReadyState>(ensureTrack()->readinessState());
287 }
288
289 const AtomicString& HTMLTrackElement::mediaElementCrossOriginAttribute() const
290 {
291     if (HTMLMediaElement* parent = mediaElement())
292         return parent->fastGetAttribute(HTMLNames::crossoriginAttr);
293     
294     return nullAtom;
295 }
296
297 void HTMLTrackElement::textTrackKindChanged(TextTrack* track)
298 {
299     if (HTMLMediaElement* parent = mediaElement())
300         return parent->textTrackKindChanged(track);
301 }
302
303 void HTMLTrackElement::textTrackModeChanged(TextTrack* track)
304 {
305     if (HTMLMediaElement* parent = mediaElement())
306         return parent->textTrackModeChanged(track);
307 }
308
309 void HTMLTrackElement::textTrackAddCues(TextTrack* track, const TextTrackCueList* cues)
310 {
311     if (HTMLMediaElement* parent = mediaElement())
312         return parent->textTrackAddCues(track, cues);
313 }
314     
315 void HTMLTrackElement::textTrackRemoveCues(TextTrack* track, const TextTrackCueList* cues)
316 {
317     if (HTMLMediaElement* parent = mediaElement())
318         return parent->textTrackRemoveCues(track, cues);
319 }
320     
321 void HTMLTrackElement::textTrackAddCue(TextTrack* track, PassRefPtr<TextTrackCue> cue)
322 {
323     if (HTMLMediaElement* parent = mediaElement())
324         return parent->textTrackAddCue(track, cue);
325 }
326     
327 void HTMLTrackElement::textTrackRemoveCue(TextTrack* track, PassRefPtr<TextTrackCue> cue)
328 {
329     if (HTMLMediaElement* parent = mediaElement())
330         return parent->textTrackRemoveCue(track, cue);
331 }
332
333 HTMLMediaElement* HTMLTrackElement::mediaElement() const
334 {
335     Element* parent = parentElement();
336     if (parent && parent->isMediaElement())
337         return static_cast<HTMLMediaElement*>(parentNode());
338
339     return 0;
340 }
341
342 #if ENABLE(MICRODATA)
343 String HTMLTrackElement::itemValueText() const
344 {
345     return getURLAttribute(srcAttr);
346 }
347
348 void HTMLTrackElement::setItemValueText(const String& value, ExceptionCode&)
349 {
350     setAttribute(srcAttr, value);
351 }
352 #endif
353
354 }
355
356 #endif