40e9ad5f4629a2cf8b13cb055f5e80676783cefb
[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 "SecurityOrigin.h"
40 #include "SharedBuffer.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()
63 {
64     if (m_newCuesAvailable) {
65         m_newCuesAvailable = false;
66         m_client.newCuesAvailable(this);
67     }
68     
69     if (m_state >= Finished)
70         m_client.cueLoadingCompleted(this, m_state == Failed);
71 }
72
73 void TextTrackLoader::cancelLoad()
74 {
75     if (m_resource) {
76         m_resource->removeClient(this);
77         m_resource = nullptr;
78     }
79 }
80
81 void TextTrackLoader::processNewCueData(CachedResource* resource)
82 {
83     ASSERT(m_resource == resource);
84     
85     if (m_state == Failed || !resource->resourceBuffer())
86         return;
87     
88     auto* buffer = resource->resourceBuffer();
89     if (m_parseOffset == buffer->size())
90         return;
91
92     if (!m_cueParser)
93         m_cueParser = std::make_unique<WebVTTParser>(static_cast<WebVTTParserClient*>(this), m_scriptExecutionContext);
94
95     const char* data;
96     unsigned length;
97
98     while ((length = buffer->getSomeData(data, m_parseOffset))) {
99         m_cueParser->parseBytes(data, length);
100         m_parseOffset += length;
101     }
102 }
103
104 // FIXME: This is a very unusual pattern, no other CachedResourceClient does this. Refactor to use notifyFinished() instead.
105 void TextTrackLoader::deprecatedDidReceiveCachedResource(CachedResource* resource)
106 {
107     ASSERT(m_resource == resource);
108     
109     if (!resource->resourceBuffer())
110         return;
111     
112     processNewCueData(resource);
113 }
114
115 void TextTrackLoader::corsPolicyPreventedLoad()
116 {
117     DEPRECATED_DEFINE_STATIC_LOCAL(String, consoleMessage, (ASCIILiteral("Cross-origin text track load denied by Cross-Origin Resource Sharing policy.")));
118     Document* document = downcast<Document>(m_scriptExecutionContext);
119     document->addConsoleMessage(MessageSource::Security, MessageLevel::Error, consoleMessage);
120     m_state = Failed;
121 }
122
123 void TextTrackLoader::notifyFinished(CachedResource* resource)
124 {
125     ASSERT(m_resource == resource);
126
127     Document* document = downcast<Document>(m_scriptExecutionContext);
128     if (!m_crossOriginMode.isNull() && !resource->passesSameOriginPolicyCheck(*document->securityOrigin()))
129         corsPolicyPreventedLoad();
130
131     if (m_state != Failed) {
132         processNewCueData(resource);
133         if (m_cueParser)
134             m_cueParser->fileFinished();
135         if (m_state != Failed)
136             m_state = resource->errorOccurred() ? Failed : Finished;
137     }
138
139     if (m_state == Finished && m_cueParser)
140         m_cueParser->flush();
141
142     if (!m_cueLoadTimer.isActive())
143         m_cueLoadTimer.startOneShot(0);
144     
145     cancelLoad();
146 }
147
148 bool TextTrackLoader::load(const URL& url, const String& crossOriginMode, bool isInitiatingElementInUserAgentShadowTree)
149 {
150     cancelLoad();
151
152     ASSERT(is<Document>(m_scriptExecutionContext));
153     Document* document = downcast<Document>(m_scriptExecutionContext);
154
155     ResourceLoaderOptions options = CachedResourceLoader::defaultCachedResourceOptions();
156     options.setContentSecurityPolicyImposition(isInitiatingElementInUserAgentShadowTree ? ContentSecurityPolicyImposition::SkipPolicyCheck : ContentSecurityPolicyImposition::DoPolicyCheck);
157
158     CachedResourceRequest cueRequest(ResourceRequest(document->completeURL(url)), options);
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     m_resource = document->cachedResourceLoader().requestTextTrack(cueRequest);
173     if (!m_resource)
174         return false;
175
176     m_resource->addClient(this);
177     
178     return true;
179 }
180
181 void TextTrackLoader::newCuesParsed()
182 {
183     if (m_cueLoadTimer.isActive())
184         return;
185
186     m_newCuesAvailable = true;
187     m_cueLoadTimer.startOneShot(0);
188 }
189
190 void TextTrackLoader::newRegionsParsed()
191 {
192     m_client.newRegionsAvailable(this);
193 }
194
195 void TextTrackLoader::fileFailedToParse()
196 {
197     LOG(Media, "TextTrackLoader::fileFailedToParse");
198
199     m_state = Failed;
200
201     if (!m_cueLoadTimer.isActive())
202         m_cueLoadTimer.startOneShot(0);
203
204     cancelLoad();
205 }
206
207 void TextTrackLoader::getNewCues(Vector<RefPtr<TextTrackCue>>& outputCues)
208 {
209     ASSERT(m_cueParser);
210     if (m_cueParser) {
211         Vector<RefPtr<WebVTTCueData>> newCues;
212         m_cueParser->getNewCues(newCues);
213
214         for (auto& cueData : newCues)
215             outputCues.append(VTTCue::create(*m_scriptExecutionContext, *cueData));
216     }
217 }
218
219 void TextTrackLoader::getNewRegions(Vector<RefPtr<VTTRegion>>& outputRegions)
220 {
221     ASSERT(m_cueParser);
222     if (m_cueParser)
223         m_cueParser->getNewRegions(outputRegions);
224 }
225
226 }
227
228 #endif