Unreviewed, rolling out r212944.
[WebKit-https.git] / Source / WebCore / page / EventSource.cpp
1 /*
2  * Copyright (C) 2009, 2012 Ericsson AB. All rights reserved.
3  * Copyright (C) 2010, 2016 Apple Inc. All rights reserved.
4  * Copyright (C) 2011, Code Aurora Forum. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer
14  *    in the documentation and/or other materials provided with the
15  *    distribution.
16  * 3. Neither the name of Ericsson nor the names of its contributors
17  *    may be used to endorse or promote products derived from this
18  *    software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #include "config.h"
34 #include "EventSource.h"
35
36 #include "ContentSecurityPolicy.h"
37 #include "EventNames.h"
38 #include "ExceptionCode.h"
39 #include "MessageEvent.h"
40 #include "ResourceError.h"
41 #include "ResourceRequest.h"
42 #include "ResourceResponse.h"
43 #include "ScriptExecutionContext.h"
44 #include "SecurityOrigin.h"
45 #include "TextResourceDecoder.h"
46 #include "ThreadableLoader.h"
47
48 namespace WebCore {
49
50 const uint64_t EventSource::defaultReconnectDelay = 3000;
51
52 inline EventSource::EventSource(ScriptExecutionContext& context, const URL& url, const Init& eventSourceInit)
53     : ActiveDOMObject(&context)
54     , m_url(url)
55     , m_withCredentials(eventSourceInit.withCredentials)
56     , m_decoder(TextResourceDecoder::create(ASCIILiteral("text/plain"), "UTF-8"))
57     , m_connectTimer(*this, &EventSource::connect)
58 {
59 }
60
61 ExceptionOr<Ref<EventSource>> EventSource::create(ScriptExecutionContext& context, const String& url, const Init& eventSourceInit)
62 {
63     if (url.isEmpty())
64         return Exception { SYNTAX_ERR };
65
66     URL fullURL = context.completeURL(url);
67     if (!fullURL.isValid())
68         return Exception { SYNTAX_ERR };
69
70     // FIXME: Convert this to check the isolated world's Content Security Policy once webkit.org/b/104520 is resolved.
71     if (!context.shouldBypassMainWorldContentSecurityPolicy() && !context.contentSecurityPolicy()->allowConnectToSource(fullURL)) {
72         // FIXME: Should this be throwing an exception?
73         return Exception { SECURITY_ERR };
74     }
75
76     auto source = adoptRef(*new EventSource(context, fullURL, eventSourceInit));
77     source->setPendingActivity(source.ptr());
78     source->scheduleInitialConnect();
79     source->suspendIfNeeded();
80     return WTFMove(source);
81 }
82
83 EventSource::~EventSource()
84 {
85     ASSERT(m_state == CLOSED);
86     ASSERT(!m_requestInFlight);
87 }
88
89 void EventSource::connect()
90 {
91     ASSERT(m_state == CONNECTING);
92     ASSERT(!m_requestInFlight);
93
94     ResourceRequest request { m_url };
95     request.setHTTPMethod("GET");
96     request.setHTTPHeaderField(HTTPHeaderName::Accept, "text/event-stream");
97     request.setHTTPHeaderField(HTTPHeaderName::CacheControl, "no-cache");
98     if (!m_lastEventId.isEmpty())
99         request.setHTTPHeaderField(HTTPHeaderName::LastEventID, m_lastEventId);
100
101     ThreadableLoaderOptions options;
102     options.sendLoadCallbacks = SendCallbacks;
103     options.credentials = m_withCredentials ? FetchOptions::Credentials::Include : FetchOptions::Credentials::SameOrigin;
104     options.preflightPolicy = PreventPreflight;
105     options.mode = FetchOptions::Mode::Cors;
106     options.cache = FetchOptions::Cache::NoStore;
107     options.dataBufferingPolicy = DoNotBufferData;
108     options.contentSecurityPolicyEnforcement = scriptExecutionContext()->shouldBypassMainWorldContentSecurityPolicy() ? ContentSecurityPolicyEnforcement::DoNotEnforce : ContentSecurityPolicyEnforcement::EnforceConnectSrcDirective;
109
110     ASSERT(scriptExecutionContext());
111     m_loader = ThreadableLoader::create(*scriptExecutionContext(), *this, WTFMove(request), options);
112
113     // FIXME: Can we just use m_loader for this, null it out when it's no longer in flight, and eliminate the m_requestInFlight member?
114     if (m_loader)
115         m_requestInFlight = true;
116 }
117
118 void EventSource::networkRequestEnded()
119 {
120     ASSERT(m_requestInFlight);
121
122     m_requestInFlight = false;
123
124     if (m_state != CLOSED)
125         scheduleReconnect();
126     else
127         unsetPendingActivity(this);
128 }
129
130 void EventSource::scheduleInitialConnect()
131 {
132     ASSERT(m_state == CONNECTING);
133     ASSERT(!m_requestInFlight);
134
135     m_connectTimer.startOneShot(0);
136 }
137
138 void EventSource::scheduleReconnect()
139 {
140     m_state = CONNECTING;
141     m_connectTimer.startOneShot(m_reconnectDelay / 1000.0);
142     dispatchEvent(Event::create(eventNames().errorEvent, false, false));
143 }
144
145 void EventSource::close()
146 {
147     if (m_state == CLOSED) {
148         ASSERT(!m_requestInFlight);
149         return;
150     }
151
152     // Stop trying to connect/reconnect if EventSource was explicitly closed or if ActiveDOMObject::stop() was called.
153     if (m_connectTimer.isActive())
154         m_connectTimer.stop();
155
156     if (m_requestInFlight)
157         m_loader->cancel();
158     else {
159         m_state = CLOSED;
160         unsetPendingActivity(this);
161     }
162 }
163
164 bool EventSource::responseIsValid(const ResourceResponse& response) const
165 {
166     // Logs to the console as a side effect.
167
168     // To keep the signal-to-noise ratio low, we don't log anything if the status code is not 200.
169     if (response.httpStatusCode() != 200)
170         return false;
171
172     if (!equalLettersIgnoringASCIICase(response.mimeType(), "text/event-stream")) {
173         auto message = makeString("EventSource's response has a MIME type (\"", response.mimeType(), "\") that is not \"text/event-stream\". Aborting the connection.");
174         // FIXME: Console message would be better with a source code location; where would we get that?
175         scriptExecutionContext()->addConsoleMessage(MessageSource::JS, MessageLevel::Error, WTFMove(message));
176         return false;
177     }
178
179     // If we have a charset, the only allowed value is UTF-8 (case-insensitive).
180     auto& charset = response.textEncodingName();
181     if (!charset.isEmpty() && !equalLettersIgnoringASCIICase(charset, "utf-8")) {
182         auto message = makeString("EventSource's response has a charset (\"", charset, "\") that is not UTF-8. Aborting the connection.");
183         // FIXME: Console message would be better with a source code location; where would we get that?
184         scriptExecutionContext()->addConsoleMessage(MessageSource::JS, MessageLevel::Error, WTFMove(message));
185         return false;
186     }
187
188     return true;
189 }
190
191 void EventSource::didReceiveResponse(unsigned long, const ResourceResponse& response)
192 {
193     ASSERT(m_state == CONNECTING);
194     ASSERT(m_requestInFlight);
195
196     if (!responseIsValid(response)) {
197         m_loader->cancel();
198         dispatchEvent(Event::create(eventNames().errorEvent, false, false));
199         return;
200     }
201
202     m_eventStreamOrigin = SecurityOrigin::create(response.url())->toString();
203     m_state = OPEN;
204     dispatchEvent(Event::create(eventNames().openEvent, false, false));
205 }
206
207 void EventSource::didReceiveData(const char* data, int length)
208 {
209     ASSERT(m_state == OPEN);
210     ASSERT(m_requestInFlight);
211
212     append(m_receiveBuffer, m_decoder->decode(data, length));
213     parseEventStream();
214 }
215
216 void EventSource::didFinishLoading(unsigned long, double)
217 {
218     ASSERT(m_state == OPEN);
219     ASSERT(m_requestInFlight);
220
221     append(m_receiveBuffer, m_decoder->flush());
222     parseEventStream();
223
224     // Discard everything that has not been dispatched by now.
225     // FIXME: Why does this need to be done?
226     // If this is important, why isn't it important to clear other data members: m_decoder, m_lastEventId, m_loader?
227     m_receiveBuffer.clear();
228     m_data.clear();
229     m_eventName = { };
230     m_currentlyParsedEventId = { };
231
232     networkRequestEnded();
233 }
234
235 void EventSource::didFail(const ResourceError& error)
236 {
237     ASSERT(m_state != CLOSED);
238
239     if (error.isAccessControl()) {
240         String message = makeString("EventSource cannot load ", error.failingURL().string(), ". ", error.localizedDescription());
241         scriptExecutionContext()->addConsoleMessage(MessageSource::JS, MessageLevel::Error, message);
242
243         abortConnectionAttempt();
244         return;
245     }
246
247     ASSERT(m_requestInFlight);
248
249     if (error.isCancellation())
250         m_state = CLOSED;
251
252     // FIXME: Why don't we need to clear data members here as in didFinishLoading?
253
254     networkRequestEnded();
255 }
256
257 void EventSource::abortConnectionAttempt()
258 {
259     ASSERT(m_state == CONNECTING);
260
261     if (m_requestInFlight)
262         m_loader->cancel();
263     else {
264         m_state = CLOSED;
265         unsetPendingActivity(this);
266     }
267
268     ASSERT(m_state == CLOSED);
269     dispatchEvent(Event::create(eventNames().errorEvent, false, false));
270 }
271
272 void EventSource::parseEventStream()
273 {
274     unsigned position = 0;
275     unsigned size = m_receiveBuffer.size();
276     while (position < size) {
277         if (m_discardTrailingNewline) {
278             if (m_receiveBuffer[position] == '\n')
279                 ++position;
280             m_discardTrailingNewline = false;
281         }
282
283         std::optional<unsigned> lineLength;
284         std::optional<unsigned> fieldLength;
285         for (unsigned i = position; !lineLength && i < size; ++i) {
286             switch (m_receiveBuffer[i]) {
287             case ':':
288                 if (!fieldLength)
289                     fieldLength = i - position;
290                 break;
291             case '\r':
292                 m_discardTrailingNewline = true;
293                 FALLTHROUGH;
294             case '\n':
295                 lineLength = i - position;
296                 break;
297             }
298         }
299
300         if (!lineLength)
301             break;
302
303         parseEventStreamLine(position, fieldLength, lineLength.value());
304         position += lineLength.value() + 1;
305
306         // EventSource.close() might've been called by one of the message event handlers.
307         // Per spec, no further messages should be fired after that.
308         if (m_state == CLOSED)
309             break;
310     }
311
312     // FIXME: The following operation makes it clear that m_receiveBuffer should be some other type,
313     // perhaps a Deque or a circular buffer of some sort.
314     if (position == size)
315         m_receiveBuffer.clear();
316     else if (position)
317         m_receiveBuffer.remove(0, position);
318 }
319
320 void EventSource::parseEventStreamLine(unsigned position, std::optional<unsigned> fieldLength, unsigned lineLength)
321 {
322     if (!lineLength) {
323         if (!m_data.isEmpty())
324             dispatchMessageEvent();
325         m_eventName = { };
326         return;
327     }
328
329     if (fieldLength && !fieldLength.value())
330         return;
331
332     StringView field { &m_receiveBuffer[position], fieldLength ? fieldLength.value() : lineLength };
333
334     unsigned step;
335     if (!fieldLength)
336         step = lineLength;
337     else if (m_receiveBuffer[position + fieldLength.value() + 1] != ' ')
338         step = fieldLength.value() + 1;
339     else
340         step = fieldLength.value() + 2;
341     position += step;
342     unsigned valueLength = lineLength - step;
343
344     if (field == "data") {
345         m_data.append(&m_receiveBuffer[position], valueLength);
346         m_data.append('\n');
347     } else if (field == "event")
348         m_eventName = { &m_receiveBuffer[position], valueLength };
349     else if (field == "id")
350         m_currentlyParsedEventId = { &m_receiveBuffer[position], valueLength };
351     else if (field == "retry") {
352         if (!valueLength)
353             m_reconnectDelay = defaultReconnectDelay;
354         else {
355             // FIXME: Do we really want to ignore trailing garbage here? Should we be using the strict version instead?
356             // FIXME: If we can't parse the value, should we leave m_reconnectDelay alone or set it to defaultReconnectDelay?
357             bool ok;
358             auto reconnectDelay = charactersToUInt64(&m_receiveBuffer[position], valueLength, &ok);
359             if (ok)
360                 m_reconnectDelay = reconnectDelay;
361         }
362     }
363 }
364
365 void EventSource::stop()
366 {
367     close();
368 }
369
370 const char* EventSource::activeDOMObjectName() const
371 {
372     return "EventSource";
373 }
374
375 bool EventSource::canSuspendForDocumentSuspension() const
376 {
377     // FIXME: We should return true here when we can because this object is not actually currently active.
378     return false;
379 }
380
381 void EventSource::dispatchMessageEvent()
382 {
383     if (!m_currentlyParsedEventId.isNull())
384         m_lastEventId = WTFMove(m_currentlyParsedEventId);
385
386     auto& name = m_eventName.isEmpty() ? eventNames().messageEvent : m_eventName;
387
388     // Omit the trailing "\n" character.
389     ASSERT(!m_data.isEmpty());
390     unsigned size = m_data.size() - 1;
391     auto data = SerializedScriptValue::create({ m_data.data(), size });
392     m_data = { };
393
394     dispatchEvent(MessageEvent::create(name, WTFMove(data), m_eventStreamOrigin, m_lastEventId));
395 }
396
397 } // namespace WebCore