22157e9b2235c1fef4c5067cfdaa529e35502349
[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 "SharedBuffer.h"
40 #include "VTTCue.h"
41 #include "WebVTTParser.h"
42
43 namespace WebCore {
44     
45 TextTrackLoader::TextTrackLoader(TextTrackLoaderClient& client, ScriptExecutionContext* context)
46     : m_client(client)
47     , m_scriptExecutionContext(context)
48     , m_cueLoadTimer(*this, &TextTrackLoader::cueLoadTimerFired)
49     , m_state(Idle)
50     , m_parseOffset(0)
51     , m_newCuesAvailable(false)
52 {
53 }
54
55 TextTrackLoader::~TextTrackLoader()
56 {
57     if (m_resource)
58         m_resource->removeClient(*this);
59 }
60
61 void TextTrackLoader::cueLoadTimerFired()
62 {
63     if (m_newCuesAvailable) {
64         m_newCuesAvailable = false;
65         m_client.newCuesAvailable(this);
66     }
67     
68     if (m_state >= Finished)
69         m_client.cueLoadingCompleted(this, m_state == Failed);
70 }
71
72 void TextTrackLoader::cancelLoad()
73 {
74     if (m_resource) {
75         m_resource->removeClient(*this);
76         m_resource = nullptr;
77     }
78 }
79
80 void TextTrackLoader::processNewCueData(CachedResource& resource)
81 {
82     ASSERT_UNUSED(resource, m_resource == &resource);
83
84     if (m_state == Failed || !m_resource->resourceBuffer())
85         return;
86
87     auto* buffer = m_resource->resourceBuffer();
88     if (m_parseOffset == buffer->size())
89         return;
90
91     if (!m_cueParser)
92         m_cueParser = std::make_unique<WebVTTParser>(static_cast<WebVTTParserClient*>(this), m_scriptExecutionContext);
93
94     auto bytesToSkip = m_parseOffset;
95     for (const auto& segment : *buffer) {
96         if (bytesToSkip > segment->size()) {
97             bytesToSkip -= segment->size();
98             continue;
99         }
100         auto bytesToUse = segment->size() - bytesToSkip;
101         m_cueParser->parseBytes(segment->data() + bytesToSkip, bytesToUse);
102         bytesToSkip = 0;
103         m_parseOffset += bytesToUse;
104     }
105 }
106
107 // FIXME: This is a very unusual pattern, no other CachedResourceClient does this. Refactor to use notifyFinished() instead.
108 void TextTrackLoader::deprecatedDidReceiveCachedResource(CachedResource& resource)
109 {
110     ASSERT_UNUSED(resource, m_resource == &resource);
111
112     if (!m_resource->resourceBuffer())
113         return;
114
115     processNewCueData(*m_resource);
116 }
117
118 void TextTrackLoader::corsPolicyPreventedLoad()
119 {
120     static NeverDestroyed<String> consoleMessage(ASCIILiteral("Cross-origin text track load denied by Cross-Origin Resource Sharing policy."));
121     Document* document = downcast<Document>(m_scriptExecutionContext);
122     document->addConsoleMessage(MessageSource::Security, MessageLevel::Error, consoleMessage);
123     m_state = Failed;
124 }
125
126 void TextTrackLoader::notifyFinished(CachedResource& resource)
127 {
128     ASSERT_UNUSED(resource, m_resource == &resource);
129
130     if (m_resource->resourceError().isAccessControl())
131         corsPolicyPreventedLoad();
132
133     if (m_state != Failed) {
134         processNewCueData(*m_resource);
135         if (m_cueParser)
136             m_cueParser->fileFinished();
137         if (m_state != Failed)
138             m_state = m_resource->errorOccurred() ? Failed : Finished;
139     }
140
141     if (m_state == Finished && m_cueParser)
142         m_cueParser->flush();
143
144     if (!m_cueLoadTimer.isActive())
145         m_cueLoadTimer.startOneShot(0_s);
146
147     cancelLoad();
148 }
149
150 bool TextTrackLoader::load(const URL& url, const String& crossOriginMode, bool isInitiatingElementInUserAgentShadowTree)
151 {
152     cancelLoad();
153
154     ASSERT(is<Document>(m_scriptExecutionContext));
155     Document* document = downcast<Document>(m_scriptExecutionContext);
156
157     ResourceLoaderOptions options = CachedResourceLoader::defaultCachedResourceOptions();
158     options.contentSecurityPolicyImposition = isInitiatingElementInUserAgentShadowTree ? ContentSecurityPolicyImposition::SkipPolicyCheck : ContentSecurityPolicyImposition::DoPolicyCheck;
159
160     CachedResourceRequest cueRequest(ResourceRequest(document->completeURL(url)), options);
161     cueRequest.setAsPotentiallyCrossOrigin(crossOriginMode, *document);
162
163     m_resource = document->cachedResourceLoader().requestTextTrack(WTFMove(cueRequest));
164     if (!m_resource)
165         return false;
166
167     m_resource->addClient(*this);
168
169     return true;
170 }
171
172 void TextTrackLoader::newCuesParsed()
173 {
174     if (m_cueLoadTimer.isActive())
175         return;
176
177     m_newCuesAvailable = true;
178     m_cueLoadTimer.startOneShot(0_s);
179 }
180
181 void TextTrackLoader::newRegionsParsed()
182 {
183     m_client.newRegionsAvailable(this);
184 }
185
186 void TextTrackLoader::fileFailedToParse()
187 {
188     LOG(Media, "TextTrackLoader::fileFailedToParse");
189
190     m_state = Failed;
191
192     if (!m_cueLoadTimer.isActive())
193         m_cueLoadTimer.startOneShot(0_s);
194
195     cancelLoad();
196 }
197
198 void TextTrackLoader::getNewCues(Vector<RefPtr<TextTrackCue>>& outputCues)
199 {
200     ASSERT(m_cueParser);
201     if (m_cueParser) {
202         Vector<RefPtr<WebVTTCueData>> newCues;
203         m_cueParser->getNewCues(newCues);
204
205         for (auto& cueData : newCues)
206             outputCues.append(VTTCue::create(*m_scriptExecutionContext, *cueData));
207     }
208 }
209
210 void TextTrackLoader::getNewRegions(Vector<RefPtr<VTTRegion>>& outputRegions)
211 {
212     ASSERT(m_cueParser);
213     if (m_cueParser)
214         m_cueParser->getNewRegions(outputRegions);
215 }
216
217 }
218
219 #endif