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