ec3c3bb34139a7e93158242ff79c6d2e06e6baf4
[WebKit-https.git] / Source / WebCore / loader / TextTrackLoader.cpp
1 /*
2  * Copyright (C) 2011 Google Inc.  All rights reserved.
3  * Copyright (C) 2014 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #include "config.h"
28
29 #if ENABLE(VIDEO_TRACK)
30
31 #include "TextTrackLoader.h"
32
33 #include "CachedResourceLoader.h"
34 #include "CachedResourceRequest.h"
35 #include "CachedTextTrack.h"
36 #include "CrossOriginAccessControl.h"
37 #include "Document.h"
38 #include "Logging.h"
39 #include "ResourceBuffer.h"
40 #include "SecurityOrigin.h"
41 #include "VTTCue.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_resource)
59         m_resource->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_resource) {
78         m_resource->removeClient(this);
79         m_resource = nullptr;
80     }
81 }
82
83 void TextTrackLoader::processNewCueData(CachedResource* resource)
84 {
85     ASSERT(m_resource == 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 = std::make_unique<WebVTTParser>(static_cast<WebVTTParserClient*>(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_resource == resource);
110     
111     if (!resource->resourceBuffer())
112         return;
113     
114     processNewCueData(resource);
115 }
116
117 void TextTrackLoader::corsPolicyPreventedLoad()
118 {
119     DEPRECATED_DEFINE_STATIC_LOCAL(String, consoleMessage, (ASCIILiteral("Cross-origin text track load denied by Cross-Origin Resource Sharing policy.")));
120     Document* document = toDocument(m_scriptExecutionContext);
121     document->addConsoleMessage(MessageSource::Security, MessageLevel::Error, consoleMessage);
122     m_state = Failed;
123 }
124
125 void TextTrackLoader::notifyFinished(CachedResource* resource)
126 {
127     ASSERT(m_resource == resource);
128
129     Document* document = toDocument(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_cueParser)
140             m_cueParser->fileFinished();
141         if (m_state != Failed)
142             m_state = resource->errorOccurred() ? Failed : Finished;
143     }
144
145     if (m_state == Finished && m_cueParser)
146         m_cueParser->flush();
147
148     if (!m_cueLoadTimer.isActive())
149         m_cueLoadTimer.startOneShot(0);
150     
151     cancelLoad();
152 }
153
154 bool TextTrackLoader::load(const URL& url, const String& crossOriginMode)
155 {
156     cancelLoad();
157
158     ASSERT(m_scriptExecutionContext->isDocument());
159     Document* document = toDocument(m_scriptExecutionContext);
160     CachedResourceRequest cueRequest(ResourceRequest(document->completeURL(url)));
161
162     if (!crossOriginMode.isNull()) {
163         m_crossOriginMode = crossOriginMode;
164         StoredCredentials allowCredentials = equalIgnoringCase(crossOriginMode, "use-credentials") ? AllowStoredCredentials : DoNotAllowStoredCredentials;
165         updateRequestForAccessControl(cueRequest.mutableResourceRequest(), document->securityOrigin(), allowCredentials);
166     } else {
167         // Cross-origin resources that are not suitably CORS-enabled may not load.
168         if (!document->securityOrigin()->canRequest(url)) {
169             corsPolicyPreventedLoad();
170             return false;
171         }
172     }
173
174     CachedResourceLoader* cachedResourceLoader = document->cachedResourceLoader();
175     m_resource = cachedResourceLoader->requestTextTrack(cueRequest);
176     if (!m_resource)
177         return false;
178
179     m_resource->addClient(this);
180     
181     return true;
182 }
183
184 void TextTrackLoader::newCuesParsed()
185 {
186     if (m_cueLoadTimer.isActive())
187         return;
188
189     m_newCuesAvailable = true;
190     m_cueLoadTimer.startOneShot(0);
191 }
192
193 #if ENABLE(WEBVTT_REGIONS)
194 void TextTrackLoader::newRegionsParsed()
195 {
196     m_client.newRegionsAvailable(this);
197 }
198 #endif
199
200 void TextTrackLoader::fileFailedToParse()
201 {
202     LOG(Media, "TextTrackLoader::fileFailedToParse");
203
204     m_state = Failed;
205
206     if (!m_cueLoadTimer.isActive())
207         m_cueLoadTimer.startOneShot(0);
208
209     cancelLoad();
210 }
211
212 void TextTrackLoader::getNewCues(Vector<RefPtr<TextTrackCue>>& outputCues)
213 {
214     ASSERT(m_cueParser);
215     if (m_cueParser) {
216         Vector<RefPtr<WebVTTCueData>> newCues;
217         m_cueParser->getNewCues(newCues);
218         for (size_t i = 0; i < newCues.size(); ++i) {
219             RefPtr<WebVTTCueData> data = newCues[i];
220             RefPtr<VTTCue> cue = VTTCue::create(*m_scriptExecutionContext, data->startTime(), data->endTime(), data->content());
221             cue->setId(data->id());
222             cue->setCueSettings(data->settings());
223             outputCues.append(cue);
224         }
225     }
226 }
227
228 #if ENABLE(WEBVTT_REGIONS)
229 void TextTrackLoader::getNewRegions(Vector<RefPtr<VTTRegion>>& outputRegions)
230 {
231     ASSERT(m_cueParser);
232     if (m_cueParser)
233         m_cueParser->getNewRegions(outputRegions);
234 }
235 #endif
236 }
237
238 #endif