36370b40dda076bcd9f8c0bfb24c785a06767f3b
[WebKit-https.git] / Source / WebCore / loader / TextTrackLoader.cpp
1 /*
2  * Copyright (C) 2011 Google Inc.  All rights reserved.
3  * Copyright (C) 2014-2017 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 #include <wtf/NeverDestroyed.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_UNUSED(resource, m_resource == &resource);
84
85     if (m_state == Failed || !m_resource->resourceBuffer())
86         return;
87
88     auto* buffer = m_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     while (m_parseOffset < buffer->size()) {
96         auto data = buffer->getSomeData(m_parseOffset);
97         m_cueParser->parseBytes(data.data(), data.size());
98         m_parseOffset += data.size();
99     }
100 }
101
102 // FIXME: This is a very unusual pattern, no other CachedResourceClient does this. Refactor to use notifyFinished() instead.
103 void TextTrackLoader::deprecatedDidReceiveCachedResource(CachedResource& resource)
104 {
105     ASSERT_UNUSED(resource, m_resource == &resource);
106
107     if (!m_resource->resourceBuffer())
108         return;
109
110     processNewCueData(*m_resource);
111 }
112
113 void TextTrackLoader::corsPolicyPreventedLoad()
114 {
115     static NeverDestroyed<String> consoleMessage(MAKE_STATIC_STRING_IMPL("Cross-origin text track load denied by Cross-Origin Resource Sharing policy."));
116     Document* document = downcast<Document>(m_scriptExecutionContext);
117     document->addConsoleMessage(MessageSource::Security, MessageLevel::Error, consoleMessage);
118     m_state = Failed;
119 }
120
121 void TextTrackLoader::notifyFinished(CachedResource& resource)
122 {
123     ASSERT_UNUSED(resource, m_resource == &resource);
124
125     if (m_resource->resourceError().isAccessControl())
126         corsPolicyPreventedLoad();
127
128     if (m_state != Failed) {
129         processNewCueData(*m_resource);
130         if (m_cueParser)
131             m_cueParser->fileFinished();
132         if (m_state != Failed)
133             m_state = m_resource->errorOccurred() ? Failed : Finished;
134     }
135
136     if (m_state == Finished && m_cueParser)
137         m_cueParser->flush();
138
139     if (!m_cueLoadTimer.isActive())
140         m_cueLoadTimer.startOneShot(0_s);
141
142     cancelLoad();
143 }
144
145 bool TextTrackLoader::load(const URL& url, const String& crossOriginMode, bool isInitiatingElementInUserAgentShadowTree)
146 {
147     cancelLoad();
148
149     ASSERT(is<Document>(m_scriptExecutionContext));
150     Document* document = downcast<Document>(m_scriptExecutionContext);
151
152     ResourceLoaderOptions options = CachedResourceLoader::defaultCachedResourceOptions();
153     options.contentSecurityPolicyImposition = isInitiatingElementInUserAgentShadowTree ? ContentSecurityPolicyImposition::SkipPolicyCheck : ContentSecurityPolicyImposition::DoPolicyCheck;
154
155     CachedResourceRequest cueRequest(ResourceRequest(document->completeURL(url)), options);
156     cueRequest.setAsPotentiallyCrossOrigin(crossOriginMode, *document);
157
158     m_resource = document->cachedResourceLoader().requestTextTrack(WTFMove(cueRequest));
159     if (!m_resource)
160         return false;
161
162     m_resource->addClient(*this);
163
164     return true;
165 }
166
167 void TextTrackLoader::newCuesParsed()
168 {
169     if (m_cueLoadTimer.isActive())
170         return;
171
172     m_newCuesAvailable = true;
173     m_cueLoadTimer.startOneShot(0_s);
174 }
175
176 void TextTrackLoader::newRegionsParsed()
177 {
178     m_client.newRegionsAvailable(this);
179 }
180
181 void TextTrackLoader::fileFailedToParse()
182 {
183     LOG(Media, "TextTrackLoader::fileFailedToParse");
184
185     m_state = Failed;
186
187     if (!m_cueLoadTimer.isActive())
188         m_cueLoadTimer.startOneShot(0_s);
189
190     cancelLoad();
191 }
192
193 void TextTrackLoader::getNewCues(Vector<RefPtr<TextTrackCue>>& outputCues)
194 {
195     ASSERT(m_cueParser);
196     if (m_cueParser) {
197         Vector<RefPtr<WebVTTCueData>> newCues;
198         m_cueParser->getNewCues(newCues);
199
200         for (auto& cueData : newCues)
201             outputCues.append(VTTCue::create(*m_scriptExecutionContext, *cueData));
202     }
203 }
204
205 void TextTrackLoader::getNewRegions(Vector<RefPtr<VTTRegion>>& outputRegions)
206 {
207     ASSERT(m_cueParser);
208     if (m_cueParser)
209         m_cueParser->getNewRegions(outputRegions);
210 }
211
212 }
213
214 #endif