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