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