HTMLMediaElement::configureTextTracks should configure all text tracks
[WebKit-https.git] / Source / WebCore / html / HTMLTrackElement.cpp
index 9207d7a..377fc65 100644 (file)
 #if ENABLE(VIDEO_TRACK)
 #include "HTMLTrackElement.h"
 
+#include "ContentSecurityPolicy.h"
 #include "Event.h"
 #include "HTMLMediaElement.h"
 #include "HTMLNames.h"
 #include "Logging.h"
+#include "RuntimeEnabledFeatures.h"
+#include "ScriptCallStack.h"
+#include "ScriptEventListener.h"
 
 using namespace std;
 
@@ -39,6 +43,17 @@ namespace WebCore {
 
 using namespace HTMLNames;
 
+#if !LOG_DISABLED
+static String urlForLogging(const KURL& url)
+{
+    static const unsigned maximumURLLengthForLogging = 128;
+    
+    if (url.string().length() < maximumURLLengthForLogging)
+        return url.string();
+    return url.string().substring(0, maximumURLLengthForLogging) + "...";
+}
+#endif
+    
 inline HTMLTrackElement::HTMLTrackElement(const QualifiedName& tagName, Document* document)
     : HTMLElement(tagName, document)
 {
@@ -48,6 +63,8 @@ inline HTMLTrackElement::HTMLTrackElement(const QualifiedName& tagName, Document
 
 HTMLTrackElement::~HTMLTrackElement()
 {
+    if (m_track)
+        m_track->clearClient();
 }
 
 PassRefPtr<HTMLTrackElement> HTMLTrackElement::create(const QualifiedName& tagName, Document* document)
@@ -55,24 +72,52 @@ PassRefPtr<HTMLTrackElement> HTMLTrackElement::create(const QualifiedName& tagNa
     return adoptRef(new HTMLTrackElement(tagName, document));
 }
 
-void HTMLTrackElement::insertedIntoTree(bool deep)
+Node::InsertionNotificationRequest HTMLTrackElement::insertedInto(ContainerNode* insertionPoint)
 {
-    HTMLElement::insertedIntoTree(deep);
-    Element* parent = parentElement();
-    if (parent && parent->isMediaElement()) {
-        // TODO(annacc):
-        // static_cast<HTMLMediaElement*>(parentNode())->trackWasAdded(this);
+    HTMLElement::insertedInto(insertionPoint);
+    if (insertionPoint->inDocument()) {
+        if (HTMLMediaElement* parent = mediaElement())
+            parent->didAddTrack(this);
     }
+
+    return InsertionDone;
 }
 
-void HTMLTrackElement::willRemove()
+void HTMLTrackElement::removedFrom(ContainerNode* insertionPoint)
 {
-    Element* parent = parentElement();
-    if (parent && parent->isMediaElement()) {
-        // TODO(annacc):
-        // static_cast<HTMLMediaElement*>(parentNode())->trackWillBeRemoved(this);
+    HTMLMediaElement* parent = mediaElement();
+    if (!parent && WebCore::isMediaElement(insertionPoint))
+        parent = toMediaElement(insertionPoint);
+    if (parent)
+        parent->willRemoveTrack(this);
+
+    HTMLElement::removedFrom(insertionPoint);
+}
+
+void HTMLTrackElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
+{
+    if (RuntimeEnabledFeatures::webkitVideoTrackEnabled()) {
+        if (name == srcAttr) {
+            if (!value.isEmpty() && mediaElement())
+                scheduleLoad();
+            // 4.8.10.12.3 Sourcing out-of-band text tracks
+            // As the kind, label, and srclang attributes are set, changed, or removed, the text track must update accordingly...
+        } else if (name == kindAttr)
+            track()->setKind(value);
+        else if (name == labelAttr)
+            track()->setLabel(value);
+        else if (name == srclangAttr)
+            track()->setLanguage(value);
+        else if (name == defaultAttr)
+            track()->setIsDefault(!value.isNull());
     }
-    HTMLElement::willRemove();
+
+    if (name == onloadAttr)
+        setAttributeEventListener(eventNames().loadEvent, createAttributeEventListener(this, name, value));
+    else if (name == onerrorAttr)
+        setAttributeEventListener(eventNames().errorEvent, createAttributeEventListener(this, name, value));
+    else
+        HTMLElement::parseAttribute(name, value);
 }
 
 KURL HTMLTrackElement::src() const
@@ -85,9 +130,9 @@ void HTMLTrackElement::setSrc(const String& url)
     setAttribute(srcAttr, url);
 }
 
-String HTMLTrackElement::kind() const
+String HTMLTrackElement::kind()
 {
-    return getAttribute(kindAttr);
+    return track()->kind();
 }
 
 void HTMLTrackElement::setKind(const String& kind)
@@ -117,7 +162,7 @@ void HTMLTrackElement::setLabel(const String& label)
 
 bool HTMLTrackElement::isDefault() const
 {
-    return hasAttribute(defaultAttr);
+    return fastHasAttribute(defaultAttr);
 }
 
 void HTMLTrackElement::setIsDefault(bool isDefault)
@@ -125,30 +170,179 @@ void HTMLTrackElement::setIsDefault(bool isDefault)
     setBooleanAttribute(defaultAttr, isDefault);
 }
 
-TextTrack* HTMLTrackElement::track() const
+LoadableTextTrack* HTMLTrackElement::ensureTrack()
 {
-    if (m_track)
-        return m_track.get();
-    return 0;
+    if (!m_track) {
+        // The kind attribute is an enumerated attribute, limited only to know values. It defaults to 'subtitles' if missing or invalid.
+        String kind = getAttribute(kindAttr);
+        if (!TextTrack::isValidKindKeyword(kind))
+            kind = TextTrack::subtitlesKeyword();
+        m_track = LoadableTextTrack::create(this, kind, label(), srclang());
+    }
+    return m_track.get();
+}
+
+TextTrack* HTMLTrackElement::track()
+{
+    return ensureTrack();
 }
 
-bool HTMLTrackElement::isURLAttribute(Attribute* attribute) const
+bool HTMLTrackElement::isURLAttribute(const Attribute& attribute) const
 {
-    return attribute->name() == srcAttr;
+    return attribute.name() == srcAttr || HTMLElement::isURLAttribute(attribute);
 }
 
-void HTMLTrackElement::load(ScriptExecutionContext* context, TextTrackClient* trackClient)
+void HTMLTrackElement::scheduleLoad()
 {
-    m_track = LoadableTextTrack::create(trackClient, this, kind(), label(), srclang(), isDefault());
+    if (!RuntimeEnabledFeatures::webkitVideoTrackEnabled())
+        return;
+
+    if (!mediaElement())
+        return;
+
+    if (!fastHasAttribute(srcAttr))
+        return;
+
+    // 4.8.10.12.3 Sourcing out-of-band text tracks
+
+    // 1. Set the text track readiness state to loading.
+    setReadyState(HTMLTrackElement::LOADING);
 
-    if (hasAttribute(srcAttr))
-        m_track->load(getNonEmptyURLAttribute(srcAttr), context);
+    KURL url = getNonEmptyURLAttribute(srcAttr);
+    if (!canLoadUrl(url)) {
+        didCompleteLoad(ensureTrack(), HTMLTrackElement::Failure);
+        return;
+    }
+
+    ensureTrack()->scheduleLoad(url);
 }
 
-void HTMLTrackElement::textTrackLoadingCompleted(LoadableTextTrack*, bool loadingFailed)
+bool HTMLTrackElement::canLoadUrl(const KURL& url)
+{
+    if (!RuntimeEnabledFeatures::webkitVideoTrackEnabled())
+        return false;
+
+    HTMLMediaElement* parent = mediaElement();
+    if (!parent)
+        return false;
+
+    // 4.8.10.12.3 Sourcing out-of-band text tracks
+
+    // 4. Download: If URL is not the empty string, perform a potentially CORS-enabled fetch of URL, with the
+    // mode being the state of the media element's crossorigin content attribute, the origin being the
+    // origin of the media element's Document, and the default origin behaviour set to fail.
+    if (url.isEmpty())
+        return false;
+
+    if (!document()->contentSecurityPolicy()->allowMediaFromSource(url)) {
+        DEFINE_STATIC_LOCAL(String, consoleMessage, (ASCIILiteral("Text track load denied by Content Security Policy.")));
+        document()->addConsoleMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, consoleMessage);
+        LOG(Media, "HTMLTrackElement::canLoadUrl(%s) -> rejected by Content Security Policy", urlForLogging(url).utf8().data());
+        return false;
+    }
+    
+    return dispatchBeforeLoadEvent(url.string());
+}
+
+void HTMLTrackElement::didCompleteLoad(LoadableTextTrack*, LoadStatus status)
 {
     ExceptionCode ec = 0;
-    dispatchEvent(Event::create(loadingFailed ? eventNames().errorEvent : eventNames().loadEvent, false, false), ec);
+
+    // 4.8.10.12.3 Sourcing out-of-band text tracks (continued)
+    
+    // 4. Download: ...
+    // If the fetching algorithm fails for any reason (network error, the server returns an error 
+    // code, a cross-origin check fails, etc), or if URL is the empty string or has the wrong origin 
+    // as determined by the condition at the start of this step, or if the fetched resource is not in
+    // a supported format, then queue a task to first change the text track readiness state to failed
+    // to load and then fire a simple event named error at the track element; and then, once that task
+    // is queued, move on to the step below labeled monitoring.
+
+    if (status == Failure) {
+        setReadyState(HTMLTrackElement::TRACK_ERROR);
+        dispatchEvent(Event::create(eventNames().errorEvent, false, false), ec);
+        return;
+    }
+
+    // If the fetching algorithm does not fail, then the final task that is queued by the networking
+    // task source must run the following steps:
+    //     1. Change the text track readiness state to loaded.
+    setReadyState(HTMLTrackElement::LOADED);
+
+    //     2. If the file was successfully processed, fire a simple event named load at the 
+    //        track element.
+    dispatchEvent(Event::create(eventNames().loadEvent, false, false), ec);
+}
+
+// NOTE: The values in the TextTrack::ReadinessState enum must stay in sync with those in HTMLTrackElement::ReadyState.
+COMPILE_ASSERT(HTMLTrackElement::NONE == static_cast<HTMLTrackElement::ReadyState>(TextTrack::NotLoaded), TextTrackEnumNotLoaded_Is_Wrong_Should_Be_HTMLTrackElementEnumNONE);
+COMPILE_ASSERT(HTMLTrackElement::LOADING == static_cast<HTMLTrackElement::ReadyState>(TextTrack::Loading), TextTrackEnumLoadingIsWrong_ShouldBe_HTMLTrackElementEnumLOADING);
+COMPILE_ASSERT(HTMLTrackElement::LOADED == static_cast<HTMLTrackElement::ReadyState>(TextTrack::Loaded), TextTrackEnumLoaded_Is_Wrong_Should_Be_HTMLTrackElementEnumLOADED);
+COMPILE_ASSERT(HTMLTrackElement::TRACK_ERROR == static_cast<HTMLTrackElement::ReadyState>(TextTrack::FailedToLoad), TextTrackEnumFailedToLoad_Is_Wrong_Should_Be_HTMLTrackElementEnumTRACK_ERROR);
+
+void HTMLTrackElement::setReadyState(ReadyState state)
+{
+    ensureTrack()->setReadinessState(static_cast<TextTrack::ReadinessState>(state));
+    if (HTMLMediaElement* parent = mediaElement())
+        return parent->textTrackReadyStateChanged(m_track.get());
+}
+
+HTMLTrackElement::ReadyState HTMLTrackElement::readyState() 
+{
+    return static_cast<ReadyState>(ensureTrack()->readinessState());
+}
+
+const AtomicString& HTMLTrackElement::mediaElementCrossOriginAttribute() const
+{
+    if (HTMLMediaElement* parent = mediaElement())
+        return parent->fastGetAttribute(HTMLNames::crossoriginAttr);
+    
+    return nullAtom;
+}
+
+void HTMLTrackElement::textTrackKindChanged(TextTrack* track)
+{
+    if (HTMLMediaElement* parent = mediaElement())
+        return parent->textTrackKindChanged(track);
+}
+
+void HTMLTrackElement::textTrackModeChanged(TextTrack* track)
+{
+    if (HTMLMediaElement* parent = mediaElement())
+        return parent->textTrackModeChanged(track);
+}
+
+void HTMLTrackElement::textTrackAddCues(TextTrack* track, const TextTrackCueList* cues)
+{
+    if (HTMLMediaElement* parent = mediaElement())
+        return parent->textTrackAddCues(track, cues);
+}
+    
+void HTMLTrackElement::textTrackRemoveCues(TextTrack* track, const TextTrackCueList* cues)
+{
+    if (HTMLMediaElement* parent = mediaElement())
+        return parent->textTrackRemoveCues(track, cues);
+}
+    
+void HTMLTrackElement::textTrackAddCue(TextTrack* track, PassRefPtr<TextTrackCue> cue)
+{
+    if (HTMLMediaElement* parent = mediaElement())
+        return parent->textTrackAddCue(track, cue);
+}
+    
+void HTMLTrackElement::textTrackRemoveCue(TextTrack* track, PassRefPtr<TextTrackCue> cue)
+{
+    if (HTMLMediaElement* parent = mediaElement())
+        return parent->textTrackRemoveCue(track, cue);
+}
+
+HTMLMediaElement* HTMLTrackElement::mediaElement() const
+{
+    Element* parent = parentElement();
+    if (parent && parent->isMediaElement())
+        return static_cast<HTMLMediaElement*>(parentNode());
+
+    return 0;
 }
 
 #if ENABLE(MICRODATA)
@@ -157,9 +351,9 @@ String HTMLTrackElement::itemValueText() const
     return getURLAttribute(srcAttr);
 }
 
-void HTMLTrackElement::setItemValueText(const String& value, ExceptionCode& ec)
+void HTMLTrackElement::setItemValueText(const String& value, ExceptionCode&)
 {
-    setAttribute(srcAttr, value, ec);
+    setAttribute(srcAttr, value);
 }
 #endif