Refactored the custom scheme handling to support asynchronous handlers + make it possible to override the HTTP response headers.

Author: perlun

CefSharp/CefSharp.h

@@ -9,7 +9,7 @@
 #include "include/cef_task.h"
 #include "CookieVisitor.h"
 #include "Settings.h"
-#include "SchemeHandler.h"
+#include "SchemeHandlerWrapper.h"
 #include "StringUtil.h"
 
 using namespace System;

CefSharp/CefSharp.vcxproj

@@ -132,7 +132,8 @@
     <ClCompile Include="Request.cpp" />
     <ClCompile Include="RequestResponse.cpp" />
     <ClCompile Include="RtzCountdownEvent.cpp" />
-    <ClCompile Include="SchemeHandler.cpp" />
+    <ClCompile Include="SchemeHandlerResponse.cpp" />
+    <ClCompile Include="SchemeHandlerWrapper.cpp" />
     <ClCompile Include="ScriptCore.cpp" />
     <ClCompile Include="Stdafx.cpp">
       <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">Create</PrecompiledHeader>
@@ -169,7 +170,8 @@
     <ClInclude Include="Request.h" />
     <ClInclude Include="RequestResponse.h" />
     <ClInclude Include="RtzCountdownEvent.h" />
-    <ClInclude Include="SchemeHandler.h" />
+    <ClInclude Include="SchemeHandlerWrapper.h" />
+    <ClInclude Include="SchemeHandlerResponse.h" />
     <ClInclude Include="ScriptCore.h" />
     <ClInclude Include="ScriptException.h" />
     <ClInclude Include="Settings.h" />

CefSharp/CefSharp.vcxproj.filters

@@ -53,9 +53,6 @@
     <ClCompile Include="RtzCountdownEvent.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
-    <ClCompile Include="SchemeHandler.cpp">
-      <Filter>Source Files</Filter>
-    </ClCompile>
     <ClCompile Include="ScriptCore.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
@@ -74,6 +71,12 @@
     <ClCompile Include="Internals\JavascriptBinding\BindingHandler.cpp">
       <Filter>Source Files\Internals\JavascriptBinding</Filter>
     </ClCompile>
+    <ClCompile Include="SchemeHandlerWrapper.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
+    <ClCompile Include="SchemeHandlerResponse.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="BrowserCore.h">
@@ -139,9 +142,6 @@
     <ClInclude Include="RtzCountdownEvent.h">
       <Filter>Header Files</Filter>
     </ClInclude>
-    <ClInclude Include="SchemeHandler.h">
-      <Filter>Header Files</Filter>
-    </ClInclude>
     <ClInclude Include="ScriptCore.h">
       <Filter>Header Files</Filter>
     </ClInclude>
@@ -181,5 +181,11 @@
     <ClInclude Include="IJsDialogHandler.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="SchemeHandlerWrapper.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="SchemeHandlerResponse.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
 </Project>

CefSharp/Request.cpp

@@ -69,7 +69,7 @@ namespace CefSharp
         {
             String^ name = toClr(it->first);
             String^ value = toClr(it->second);
-            headers->Add(name, value);
+            headers[name] = value;
         }
 
         return headers;

CefSharp/Request.h

@@ -1,24 +1,30 @@
+#pragma once
+
 #include "Stdafx.h"
 #include "IRequest.h"
-#pragma once
+#include "SchemeHandlerResponse.h"
 
 using namespace System;
 using namespace System::Collections::Generic;
 
 namespace CefSharp
 {
+    class SchemeHandlerWrapper;
+
     ref class CefRequestWrapper : public IRequest
     {
         MCefRefPtr<CefRequest> _wrappedRequest;
     internal:
         CefRequestWrapper(CefRefPtr<CefRequest> cefRequest) : _wrappedRequest(cefRequest) {}
+        //void (SchemeHandlerWrapper::* RequestCompletedCallback)(SchemeResponse^);
+
+        //void OnRequestCompleted(SchemeResponse^ response);
 
     public:
         virtual property String^ Url { String^ get(); void set(String^ url); }
         virtual property String^ Method { String^ get(); }
         virtual property String^ Body { String^ get(); }
         virtual IDictionary<String^, String^>^ GetHeaders();
         virtual void SetHeaders(IDictionary<String^, String^>^ headers);
-
     };
 }

CefSharp/RequestResponse.h

@@ -12,12 +12,17 @@ namespace CefSharp
     {
         /// cancel the request, return nothing
         void Cancel();
+
         /// the current request
         property IRequest^ Request { IRequest^ get(); };
+
         /// respond with redirection to the provided URL
         void Redirect(String^ url);
+
         /// respond with data from Stream
         void RespondWith(Stream^ stream, String^ mimeType);
+
+        void RespondWith(Stream^ stream, String^ mimeType, String^ statusText, int statusCode, IDictionary<String^, String^>^ responseHeaders);
     };
 
     enum class ResponseAction
@@ -59,5 +64,4 @@ namespace CefSharp
         virtual void RespondWith(Stream^ stream, String^ mimeType);
         virtual void RespondWith(Stream^ stream, String^ mimeType, String^ statusText, int statusCode, IDictionary<String^, String^>^ responseHeaders);
     };
-
 }

CefSharp/SchemeHandlerResponse.cpp

@@ -0,0 +1,10 @@
+#include "Stdafx.h"
+#include "SchemeHandlerWrapper.h"
+
+namespace CefSharp
+{
+    void SchemeHandlerResponse::OnRequestCompleted()
+    {
+        _schemeHandlerWrapper->ProcessRequestCallback(this);
+    }
+}

CefSharp/SchemeHandlerResponse.h

@@ -0,0 +1,34 @@
+#pragma once
+
+#include "Stdafx.h"
+#include "SchemeHandlerWrapper.h"
+
+using namespace System;
+using namespace System::Collections::Generic;
+using namespace System::IO;
+
+namespace CefSharp
+{
+    class SchemeHandlerWrapper;
+
+    public ref class SchemeHandlerResponse
+    {
+    internal:
+        SchemeHandlerWrapper* _schemeHandlerWrapper;
+        void OnRequestCompleted();
+        
+    public:
+        /// <summary>
+        /// A Stream with the response data. If the request didn't return any response, leave this property as null.
+        /// </summary>
+        property Stream^ ResponseStream;
+
+        property String^ MimeType;
+        property IDictionary<String^, String^>^ ResponseHeaders;
+
+        SchemeHandlerResponse(SchemeHandlerWrapper* schemeHandlerWrapper)
+        {
+            _schemeHandlerWrapper = schemeHandlerWrapper;
+        }
+    };
+};

CefSharp/SchemeHandler.cpp renamed to CefSharp/SchemeHandlerWrapper.cpp

@@ -1,37 +1,66 @@
 #include "Stdafx.h"
 
-#include "SchemeHandler.h"
+#include "SchemeHandlerWrapper.h"
+
+using namespace System::Runtime::InteropServices;
 
 namespace CefSharp
 {
-    void SchemeHandlerWrapper::GetResponseHeaders(CefRefPtr<CefResponse> response, int64& response_length, CefString& redirectUrl)
+    namespace
     {
-        response->SetMimeType(_mime_type);
-        response->SetStatus(200);
-        response_length = SizeFromStream();
-    }
+        CefResponse::HeaderMap ToHeaderMap(IDictionary<String^, String^>^ headers)
+        {
+            CefResponse::HeaderMap result;
+
+            for each (KeyValuePair<String^, String^> header in headers)
+            {
+                result.insert(std::pair<CefString,CefString>(toNative(header.Key), toNative(header.Value)));
+            }
+
+            return result;
+        }
+    };
 
     bool SchemeHandlerWrapper::ProcessRequest(CefRefPtr<CefRequest> request, CefRefPtr<CefSchemeHandlerCallback> callback)
     {
+        _callback = callback;
+
         bool handled = false;
         Stream^ stream;
         String^ mimeType;
 
         AutoLock lock_scope(this);
 
-        IRequest^ requestWrapper = gcnew CefRequestWrapper(request);
-        if (_handler->ProcessRequest(requestWrapper, mimeType, stream))
-        {
-            _mime_type = toNative(mimeType);
-            _stream = stream;
-            callback->HeadersAvailable();
+        auto schemeResponse = gcnew SchemeHandlerResponse(this);
+        auto onRequestCompleted = gcnew OnRequestCompletedHandler(schemeResponse, &SchemeHandlerResponse::OnRequestCompleted);
 
+        auto requestWrapper = gcnew CefRequestWrapper(request);
+        if (_handler->ProcessRequestAsync(requestWrapper, schemeResponse, onRequestCompleted))
+        {
             handled = true;
         }
 
         return handled;
     }
 
+    void SchemeHandlerWrapper::ProcessRequestCallback(SchemeHandlerResponse^ response)
+    {
+        _mime_type = toNative(response->MimeType);
+        _stream = response->ResponseStream;
+
+        _headers = ToHeaderMap(response->ResponseHeaders);
+
+        _callback->HeadersAvailable();
+    }
+
+    void SchemeHandlerWrapper::GetResponseHeaders(CefRefPtr<CefResponse> response, int64& response_length, CefString& redirectUrl)
+    {
+        response->SetMimeType(_mime_type);
+        response->SetStatus(200);
+        response->SetHeaderMap(_headers);
+        response_length = SizeFromStream();
+    }
+
     bool SchemeHandlerWrapper::ReadResponse(void* data_out, int bytes_to_read, int& bytes_read, CefRefPtr<CefSchemeHandlerCallback> callback)
     {
         bool has_data = false;

CefSharp/SchemeHandler.h renamed to CefSharp/SchemeHandlerWrapper.h

@@ -9,29 +9,37 @@ using namespace System::IO;
 
 namespace CefSharp
 {
+    ref class SchemeHandlerResponse;
+
+    public delegate void OnRequestCompletedHandler();
+
     public interface class ISchemeHandler
     {
         /// <summary>
-        /// if request is handled return true and set mimeType and stream accordingly.
-        /// if no data the leave stream null
+        /// Processes a custom scheme-based request asynchronously. The implementing method should call the callback whenever the
+        /// request is completed.
         /// </summary>
-        bool ProcessRequest(IRequest^ request, String^% mimeType, Stream^% stream);
+        /// <returns>true if the request is handled, false otherwise.</returns>
+        bool ProcessRequestAsync(IRequest^ request, SchemeHandlerResponse^ response, OnRequestCompletedHandler^ callback);
     };
 
     public interface class ISchemeHandlerFactory
     {
         ISchemeHandler^ Create();
     };
 
-    class SchemeHandlerWrapper : public CefSchemeHandler
+    public class SchemeHandlerWrapper : public CefSchemeHandler
     {
         gcroot<ISchemeHandler^> _handler;
         gcroot<Stream^> _stream;
         CefString _mime_type;
+        CefResponse::HeaderMap _headers;
+        CefRefPtr<CefSchemeHandlerCallback> _callback;
 
         int SizeFromStream();
 
     public:
+
         SchemeHandlerWrapper(ISchemeHandler^ handler) : _handler(handler)
         {
             if(!_handler)
@@ -41,6 +49,7 @@ namespace CefSharp
         }
 
         virtual bool ProcessRequest(CefRefPtr<CefRequest> request, CefRefPtr<CefSchemeHandlerCallback> callback);
+        virtual void ProcessRequestCallback(SchemeHandlerResponse^ handlerResponse);
         virtual void GetResponseHeaders(CefRefPtr<CefResponse> response, int64& response_length, CefString& redirectUrl);
         virtual bool ReadResponse(void* data_out, int bytes_to_read, int& bytes_read, CefRefPtr<CefSchemeHandlerCallback> callback);
         virtual void Cancel();