Add Streams API support to XMLHttpRequest

Source/core/xml/XMLHttpRequest.cpp

 /*
  *  Copyright (C) 2004, 2006, 2008 Apple Inc. All rights reserved.
  *  Copyright (C) 2005-2007 Alexey Proskuryakov <ap@webkit.org>
  *  Copyright (C) 2007, 2008 Julien Chaffraix <jchaffraix@webkit.org>
  *  Copyright (C) 2008, 2011 Google Inc. All rights reserved.
  *  Copyright (C) 2012 Intel Corporation
  *
  *  This library is free software; you can redistribute it and/or
  *  modify it under the terms of the GNU Lesser General Public
  *  License as published by the Free Software Foundation; either
  *  version 2 of the License, or (at your option) any later version.
  *
  *  This library is distributed in the hope that it will be useful,
  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  *  Lesser General Public License for more details.
  *
  *  You should have received a copy of the GNU Lesser General Public
  *  License along with this library; if not, write to the Free Software
  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
 #include "config.h"
 #include "core/xml/XMLHttpRequest.h"
 
-#include <wtf/ArrayBuffer.h>
-#include <wtf/ArrayBufferView.h>
-#include <wtf/RefCountedLeakCounter.h>
-#include <wtf/StdLibExtras.h>
-#include <wtf/text/CString.h>
-#include <wtf/UnusedParam.h>
+#include "RuntimeEnabledFeatures.h"
 #include "core/dom/ContextFeatures.h"
 #include "core/dom/DOMImplementation.h"
 #include "core/dom/Event.h"
 #include "core/dom/EventListener.h"
 #include "core/dom/EventNames.h"
 #include "core/dom/ExceptionCode.h"
 #include "core/dom/WebCoreMemoryInstrumentation.h"
 #include "core/editing/markup.h"
 #include "core/fileapi/Blob.h"
 #include "core/fileapi/File.h"
+#include "core/fileapi/Stream.h"
 #include "core/html/DOMFormData.h"
 #include "core/html/HTMLDocument.h"
 #include "core/inspector/InspectorInstrumentation.h"
 #include "core/loader/CrossOriginAccessControl.h"
 #include "core/loader/TextResourceDecoder.h"
 #include "core/loader/ThreadableLoader.h"
 #include "core/loader/cache/CachedResourceRequestInitiators.h"
 #include "core/page/ContentSecurityPolicy.h"
 #include "core/page/Settings.h"
 #include "core/platform/HistogramSupport.h"
 #include "core/platform/SharedBuffer.h"
 #include "core/platform/network/BlobData.h"
 #include "core/platform/network/HTTPParsers.h"
 #include "core/platform/network/ParsedContentType.h"
 #include "core/platform/network/ResourceError.h"
 #include "core/platform/network/ResourceRequest.h"
 #include "core/xml/XMLHttpRequestProgressEvent.h"
 #include "core/xml/XMLHttpRequestUpload.h"
 #include "weborigin/SecurityOrigin.h"
+#include "wtf/ArrayBuffer.h"
+#include "wtf/ArrayBufferView.h"
+#include "wtf/RefCountedLeakCounter.h"
+#include "wtf/StdLibExtras.h"
+#include "wtf/UnusedParam.h"
+#include "wtf/text/CString.h"
 
 namespace WebCore {
 
 DEFINE_DEBUG_ONLY_GLOBAL(WTF::RefCountedLeakCounter, xmlHttpRequestCounter, ("XMLHttpRequest"));
 
 // Histogram enum to see when we can deprecate xhr.send(ArrayBuffer).
 enum XMLHttpRequestSendArrayBufferOrView {
     XMLHttpRequestSendArrayBuffer,
     XMLHttpRequestSendArrayBufferView,
     XMLHttpRequestSendArrayBufferOrViewMax,
@@ skipping 235 matching lines @@
         return 0;
 
     if (!m_responseArrayBuffer.get() && m_binaryResponseBuilder.get() && m_binaryResponseBuilder->size() > 0) {
         m_responseArrayBuffer = m_binaryResponseBuilder->getAsArrayBuffer();
         m_binaryResponseBuilder.clear();
     }
 
     return m_responseArrayBuffer.get();
 }
 
+Stream* XMLHttpRequest::responseStream(ExceptionCode& ec)
+{
+    if (m_responseTypeCode != ResponseTypeStream) {
+        ec = InvalidStateError;
+        return 0;
+    }
+
+    if (m_error || (m_state != LOADING && m_state != DONE))
+        return 0;
+
+    return m_responseStream.get();
+}
+
 void XMLHttpRequest::setTimeout(unsigned long timeout, ExceptionCode& ec)
 {
     // FIXME: Need to trigger or update the timeout Timer here, if needed. http://webkit.org/b/98156
     // XHR2 spec, 4.7.3. "This implies that the timeout attribute can be set while fetching is in progress. If that occurs it will still be measured relative to the start of fetching."
     if (scriptExecutionContext()->isDocument() && !m_async) {
         logConsoleError(scriptExecutionContext(), "XMLHttpRequest.timeout cannot be set for synchronous HTTP(S) requests made from the window context.");
         ec = InvalidAccessError;
         return;
     }
     m_timeoutMilliseconds = timeout;
@@ skipping 19 matching lines @@
     if (responseType == "")
         m_responseTypeCode = ResponseTypeDefault;
     else if (responseType == "text")
         m_responseTypeCode = ResponseTypeText;
     else if (responseType == "document")
         m_responseTypeCode = ResponseTypeDocument;
     else if (responseType == "blob")
         m_responseTypeCode = ResponseTypeBlob;
     else if (responseType == "arraybuffer")
         m_responseTypeCode = ResponseTypeArrayBuffer;
+    else if (RuntimeEnabledFeatures::streamEnabled() && responseType == "stream")
+        m_responseTypeCode = ResponseTypeStream;
     else
         ASSERT_NOT_REACHED();

[abarth-chromium, 2013/07/09 17:58:21]

Can this ASSERT be reached if RuntimeEnabledFeatures::streamEnabled() is false? 
Maybe we need to set m_responseTypeCode = ResponseTypeDefault in the default
case.

[tyoshino (SeeGerritForStatus), 2013/07/09 19:48:22]

Oh, right. As I added "stream" to the enum in the IDL file, this case can be
reached.

It's still good to ASSERT_NOT_REACHED() for the unexpected input. I moved the
flag to
L371 and made it just return when it's false as well as the generated binding
code.
https://code.google.com/p/chromium/codesearch#chromium/src/out/Debug/obj/gen/...

 }
 
 String XMLHttpRequest::responseType()
 {
     switch (m_responseTypeCode) {
     case ResponseTypeDefault:
         return "";
     case ResponseTypeText:
         return "text";
     case ResponseTypeDocument:
         return "document";
     case ResponseTypeBlob:
         return "blob";
     case ResponseTypeArrayBuffer:
         return "arraybuffer";
+    case ResponseTypeStream:
+        return "stream";
     }
     return "";

[abarth-chromium, 2013/07/09 17:58:21]

Can you wrap all these strings in ASCIILiteral(..) ?

[tyoshino (SeeGerritForStatus), 2013/07/09 19:48:22]

Done.

 }
 
 XMLHttpRequestUpload* XMLHttpRequest::upload()
 {
     if (!m_upload)
         m_upload = XMLHttpRequestUpload::create(this);
     return m_upload.get();
 }
 
 void XMLHttpRequest::changeState(State newState)
@@ skipping 695 matching lines @@
         return;
 
     if (m_state < HEADERS_RECEIVED)
         changeState(HEADERS_RECEIVED);
 
     if (m_decoder)
         m_responseText = m_responseText.concatenateWith(m_decoder->flush());
 
     InspectorInstrumentation::didFinishXHRLoading(scriptExecutionContext(), this, identifier, m_responseText, m_url, m_lastSendURL, m_lastSendLineNumber);
 
+    if (m_responseStream)
+        m_responseStream->finalize();
+
     bool hadLoader = m_loader;
     m_loader = 0;
 
     changeState(DONE);
     m_decoder = 0;
 
     if (hadLoader)
         dropProtection();
 }
 
@@ skipping 56 matching lines @@
     if (len == -1)
         len = strlen(data);
 
     if (useDecoder)
         m_responseText = m_responseText.concatenateWith(m_decoder->decode(data, len));
     else if (m_responseTypeCode == ResponseTypeArrayBuffer || m_responseTypeCode == ResponseTypeBlob) {
         // Buffer binary data.
         if (!m_binaryResponseBuilder)
             m_binaryResponseBuilder = SharedBuffer::create();
         m_binaryResponseBuilder->append(data, len);
+    } else if (m_responseTypeCode == ResponseTypeStream) {
+        if (!m_responseStream)
+            m_responseStream = Stream::create(responseMIMEType());
+        m_responseStream->addData(data, len);
     }
 
     if (!m_error) {
         long long expectedLength = m_response.expectedContentLength();
         m_receivedLength += len;
 
         if (m_async) {
             bool lengthComputable = expectedLength > 0 && m_receivedLength <= expectedLength;
             unsigned long long total = lengthComputable ? expectedLength : 0;
             m_progressEventThrottle.dispatchProgressEvent(lengthComputable, m_receivedLength, total);
@@ skipping 101 matching lines @@
     info.addMember(m_responseDocument, "responseDocument");
     info.addMember(m_binaryResponseBuilder, "binaryResponseBuilder");
     info.addMember(m_responseArrayBuffer, "responseArrayBuffer");
     info.addMember(m_lastSendURL, "lastSendURL");
     info.addMember(m_eventTargetData, "eventTargetData");
     info.addMember(m_progressEventThrottle, "progressEventThrottle");
     info.addMember(m_securityOrigin, "securityOrigin");
 }
 
 } // namespace WebCore