26bc8cb1db9bda4750d943e9f7af4ceeeffbbef0
[WebKit-https.git] / Source / WebCore / loader / TextTrackLoader.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
30 #include "TextTrackLoader.h"
31
32 #include "CachedResourceLoader.h"
33 #include "CachedResourceRequest.h"
34 #include "CachedTextTrack.h"
35 #include "CrossOriginAccessControl.h"
36 #include "Document.h"
37 #include "Logging.h"
38 #include "ResourceBuffer.h"
39 #include "ResourceHandle.h"
40 #include "ScriptCallStack.h"
41 #include "SecurityOrigin.h"
42 #include "WebVTTParser.h"
43
44 namespace WebCore {
45     
46 TextTrackLoader::TextTrackLoader(TextTrackLoaderClient* client, ScriptExecutionContext* context)
47     : m_client(client)
48     , m_scriptExecutionContext(context)
49     , m_cueLoadTimer(this, &TextTrackLoader::cueLoadTimerFired)
50     , m_state(Idle)
51     , m_parseOffset(0)
52     , m_newCuesAvailable(false)
53 {
54 }
55
56 TextTrackLoader::~TextTrackLoader()
57 {
58     if (m_cachedCueData)
59         m_cachedCueData->removeClient(this);
60 }
61
62 void TextTrackLoader::cueLoadTimerFired(Timer<TextTrackLoader>* timer)
63 {
64     ASSERT_UNUSED(timer, timer == &m_cueLoadTimer);
65     
66     if (m_newCuesAvailable) {
67         m_newCuesAvailable = false;
68         m_client->newCuesAvailable(this); 
69     }
70     
71     if (m_state >= Finished)
72         m_client->cueLoadingCompleted(this, m_state == Failed);
73 }
74
75 void TextTrackLoader::cancelLoad()
76 {
77     if (m_cachedCueData) {
78         m_cachedCueData->removeClient(this);
79         m_cachedCueData = 0;
80     }
81 }
82
83 void TextTrackLoader::processNewCueData(CachedResource* resource)
84 {
85     ASSERT(m_cachedCueData == resource);
86     
87     if (m_state == Failed || !resource->resourceBuffer())
88         return;
89     
90     ResourceBuffer* buffer = resource->resourceBuffer();
91     if (m_parseOffset == buffer->size())
92         return;
93
94     if (!m_cueParser)
95         m_cueParser = WebVTTParser::create(this, m_scriptExecutionContext);
96
97     const char* data;
98     unsigned length;
99
100     while ((length = buffer->getSomeData(data, m_parseOffset))) {
101         m_cueParser->parseBytes(data, length);
102         m_parseOffset += length;
103     }
104 }
105
106 // FIXME: This is a very unusual pattern, no other CachedResourceClient does this. Refactor to use notifyFinished() instead.
107 void TextTrackLoader::deprecatedDidReceiveCachedResource(CachedResource* resource)
108 {
109     ASSERT(m_cachedCueData == resource);
110     
111     if (!resource->resourceBuffer())
112         return;
113     
114     processNewCueData(resource);
115 }
116
117 void TextTrackLoader::corsPolicyPreventedLoad()
118 {
119     DEFINE_STATIC_LOCAL(String, consoleMessage, (ASCIILiteral("Cross-origin text track load denied by Cross-Origin Resource Sharing policy.")));
120     Document* document = static_cast<Document*>(m_scriptExecutionContext);
121     document->addConsoleMessage(SecurityMessageSource, ErrorMessageLevel, consoleMessage);
122     m_state = Failed;
123 }
124
125 void TextTrackLoader::notifyFinished(CachedResource* resource)
126 {
127     ASSERT(m_cachedCueData == resource);
128
129     Document* document = static_cast<Document*>(m_scriptExecutionContext);
130     if (!m_crossOriginMode.isNull()
131         && !document->securityOrigin()->canRequest(resource->response().url())
132         && !resource->passesAccessControlCheck(document->securityOrigin())) {
133
134         corsPolicyPreventedLoad();
135     }
136
137     if (m_state != Failed) {
138         processNewCueData(resource);
139         if (m_state != Failed)
140             m_state = resource->errorOccurred() ? Failed : Finished;
141     }
142
143     if (!m_cueLoadTimer.isActive())
144         m_cueLoadTimer.startOneShot(0);
145     
146     cancelLoad();
147 }
148
149 bool TextTrackLoader::load(const KURL& url, const String& crossOriginMode)
150 {
151     cancelLoad();
152
153     if (!m_client->shouldLoadCues(this))
154         return false;
155
156     ASSERT(m_scriptExecutionContext->isDocument());
157     Document* document = static_cast<Document*>(m_scriptExecutionContext);
158     CachedResourceRequest cueRequest(ResourceRequest(document->completeURL(url)));
159
160     if (!crossOriginMode.isNull()) {
161         m_crossOriginMode = crossOriginMode;
162         StoredCredentials allowCredentials = equalIgnoringCase(crossOriginMode, "use-credentials") ? AllowStoredCredentials : DoNotAllowStoredCredentials;
163         updateRequestForAccessControl(cueRequest.mutableResourceRequest(), document->securityOrigin(), allowCredentials);
164     } else {
165         // Cross-origin resources that are not suitably CORS-enabled may not load.
166         if (!document->securityOrigin()->canRequest(url)) {
167             corsPolicyPreventedLoad();
168             return false;
169         }
170     }
171
172     CachedResourceLoader* cachedResourceLoader = document->cachedResourceLoader();
173     m_cachedCueData = cachedResourceLoader->requestTextTrack(cueRequest);
174     if (m_cachedCueData)
175         m_cachedCueData->addClient(this);
176     
177     m_client->cueLoadingStarted(this);
178     
179     return true;
180 }
181
182 void TextTrackLoader::newCuesParsed()
183 {
184     if (m_cueLoadTimer.isActive())
185         return;
186
187     m_newCuesAvailable = true;
188     m_cueLoadTimer.startOneShot(0);
189 }
190
191 void TextTrackLoader::fileFailedToParse()
192 {
193     LOG(Media, "TextTrackLoader::fileFailedToParse");
194
195     m_state = Failed;
196
197     if (!m_cueLoadTimer.isActive())
198         m_cueLoadTimer.startOneShot(0);
199
200     cancelLoad();
201 }
202
203 void TextTrackLoader::getNewCues(Vector<RefPtr<TextTrackCue> >& outputCues)
204 {
205     ASSERT(m_cueParser);
206     if (m_cueParser)
207         m_cueParser->getNewCues(outputCues);
208 }
209
210 }
211
212 #endif