feat: allow defining RequestContext params

Author: jodett

CefSharp.OutOfProcess.BrowserProcess/BrowserProcessHandler.cs

@@ -87,13 +87,23 @@ Task IOutOfProcessClientRpc.CloseHost()
             });
         }
 
-        Task IOutOfProcessClientRpc.CreateBrowser(IntPtr parentHwnd, string url, int id)
+        Task IOutOfProcessClientRpc.CreateBrowser(IntPtr parentHwnd, string url, int id, IDictionary<string, object> requestContextPreferences)
         {
             //Debugger.Break();
 
             return CefThread.ExecuteOnUiThread(() =>
             {
-                var browser = new OutOfProcessChromiumWebBrowser(_outOfProcessServer, id, url);
+                IRequestContext requestContext = null;
+                if (requestContextPreferences != null)
+                {
+                    requestContext = new RequestContext();
+                    foreach (KeyValuePair<string, object> pref in requestContextPreferences)
+                    {
+                        requestContext.SetPreference(pref.Key, pref.Value, out _);
+                    }
+                }
+
+                var browser = new OutOfProcessChromiumWebBrowser(_outOfProcessServer, id, url, requestContext);
 
                 var windowInfo = new WindowInfo();
                 windowInfo.WindowName = "CefSharpBrowserProcess";
@@ -124,5 +134,48 @@ void IOutOfProcessClientRpc.SetFocus(int browserId, bool focus)
 
             browser?.GetBrowserHost().SetFocus(focus);
         }
+
+        /// <summary>
+        /// Update Request Context Preferences of the browser.
+        /// </summary>
+        /// <param name="browserId">The browser id.</param>
+        /// <param name="preferences">The preferences.</param>
+        void IOutOfProcessClientRpc.UpdateRequestContextPreferences(int browserId, IDictionary<string, object> preferences)
+        {
+            var browser = _browsers.FirstOrDefault(x => x.Id == browserId);
+
+            CefThread.ExecuteOnUiThread(() =>
+            {
+                if (browser?.GetRequestContext() is IRequestContext requestContext)
+                {
+                    foreach (KeyValuePair<string, object> pref in preferences)
+                    {
+                        requestContext?.SetPreference(pref.Key, pref.Value, out _);
+                    }
+                }
+
+                return true;
+            });
+        }
+
+        /// <summary>
+        /// Update Global Request Context Preferences for all browsers.
+        /// </summary>
+        /// <param name="preferences">The preferences.</param>
+        void IOutOfProcessClientRpc.UpdateGlobalRequestContextPreferences(IDictionary<string, object> preferences)
+        {
+            CefThread.ExecuteOnUiThread(() =>
+            {
+                if (Cef.GetGlobalRequestContext() is IRequestContext requestContext)
+                {
+                    foreach (KeyValuePair<string, object> pref in preferences)
+                    {
+                        requestContext?.SetPreference(pref.Key, pref.Value, out _);
+                    }
+                }
+
+                return true;
+            });
+        }
     }
 }

CefSharp.OutOfProcess.Core/OutOfProcessHost.cs

@@ -4,6 +4,7 @@
 using StreamJsonRpc;
 using System;
 using System.Collections.Concurrent;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
 using System.Threading.Tasks;
@@ -85,11 +86,12 @@ public string ChromiumVersion
         /// <param name="handle">handle used to host the control</param>
         /// <param name="url"></param>
         /// <param name="id"></param>
+        /// <param name="requestContextPreferences">request context preference.</param>
         /// <returns></returns>
-        public bool CreateBrowser(IChromiumWebBrowserInternal browser, IntPtr handle, string url, out int id)
+        public bool CreateBrowser(IChromiumWebBrowserInternal browser, IntPtr handle, string url, out int id, IDictionary<string, object> requestContextPreferences = null)
         {
             id = _browserIdentifier++;
-            _ = _outOfProcessClient.CreateBrowser(handle, url, id);
+            _ = _outOfProcessClient.CreateBrowser(handle, url, id, requestContextPreferences);
 
             return _browsers.TryAdd(id, browser);
         }
@@ -253,6 +255,25 @@ public static Task<OutOfProcessHost> CreateAsync(string path = HostExeName, stri
             host.Init();            
 
             return host.InitializedTask;
-        }        
+        }
+
+        /// <summary>
+        /// Update Request Context Preferences of the browser.
+        /// </summary>
+        /// <param name="browserId">The browser id.</param>
+        /// <param name="preferences">The preferences.</param>
+        public void UpdateRequestContextPreferences(int browserId, IDictionary<string, object> preferences)
+        {
+            _outOfProcessClient.UpdateRequestContextPreferences(browserId, preferences);
+        }
+
+        /// <summary>
+        /// Update Global Request Context Preferences for all browsers.
+        /// </summary>
+        /// <param name="preferences">The preferences.</param>
+        public void UpdateGlobalRequestContextPreferences(IDictionary<string, object> preferences)
+        {
+            _outOfProcessClient.UpdateGlobalRequestContextPreferences(preferences);
+        }
     }
 }

CefSharp.OutOfProcess.Interface/IOutOfProcessClientRpc.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Threading.Tasks;
+using System.Collections.Generic;
 
 namespace CefSharp.OutOfProcess.Interface
 {
@@ -35,8 +36,22 @@ public interface IOutOfProcessClientRpc
         /// <param name="parentHwnd">parent Hwnd</param>
         /// <param name="url">start url</param>
         /// <param name="browserId">browser id</param>
+        /// <param name="requestContextPreferences">Request Context Preferences to set.</param>
         /// <returns>Task</returns>
-        Task CreateBrowser(IntPtr parentHwnd, string url, int browserId);
+        Task CreateBrowser(IntPtr parentHwnd, string url, int browserId, IDictionary<string, object> requestContextPreferences);
+
+        /// <summary>
+        /// Modify RequestContext-Preferences for an existing browser.
+        /// </summary>
+        /// <param name="browserId">browser id</param>
+        /// <param name="requestContextPreferences">Request Context Preferences to set.</param>
+        void UpdateRequestContextPreferences(int browserId, IDictionary<string, object> requestContextPreferences);
+
+        /// <summary>
+        /// Modify Global RequestContext-Preferences
+        /// </summary>
+        /// /// <param name="requestContextPreferences">Request Context Preferences to set.</param>
+        void UpdateGlobalRequestContextPreferences(IDictionary<string, object> requestContextPreferences);
 
         /// <summary>
         /// Notify the browser that the window hosting it is about to be moved or resized.

CefSharp.OutOfProcess.Wpf.HwndHost/ChromiumWebBrowser.cs

@@ -17,6 +17,7 @@
 using System.Windows.Interop;
 using System.Windows.Threading;
 using Window = System.Windows.Window;
+using System.Collections.Generic;
 
 namespace CefSharp.OutOfProcess.Wpf.HwndHost
 {
@@ -319,6 +320,18 @@ public ChromiumWebBrowser(OutOfProcessHost host, string initialAddress = null)
             UseLayoutRounding = true;
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ChromiumWebBrowser"/> instance.
+        /// </summary>
+        /// <param name="host">Out of process host</param>
+        /// <param name="initialAddress">address to load initially</param>
+        /// <param name="requestContextPreferences">requestContextPreferences to set</param>
+        public ChromiumWebBrowser(OutOfProcessHost host, string initialAddress = null, IDictionary<string, object> requestContextPreferences = null)
+            : this(host, initialAddress)
+        {
+            this.requestContextPreferences = requestContextPreferences;
+        }
+
         /// <inheritdoc/>
         int IChromiumWebBrowserInternal.Id
         {
@@ -418,6 +431,15 @@ public Task<Response> GoForwardAsync(NavigationOptions options = null)
             return _devToolsContext.GoForwardAsync(options);
         }
 
+        /// <summary>
+        /// Update Global Request Context Preferences for all browsers.
+        /// </summary>
+        /// <param name="preferences">The preferences.</param>
+        public void UpdateRequestContextPreferences(IDictionary<string, object> preferences)
+        {
+            _host.UpdateRequestContextPreferences(this._id, preferences);
+        }
+
         private void PresentationSourceChangedHandler(object sender, SourceChangedEventArgs args)
         {
             if (args.NewSource != null)
@@ -492,7 +514,7 @@ protected override HandleRef BuildWindowCore(HandleRef hwndParent)
                             0);
             }
 
-            _host.CreateBrowser(this, _hwndHost, url: _initialAddress, out _id);
+            _host.CreateBrowser(this, _hwndHost, url: _initialAddress, out _id, requestContextPreferences);
 
             _devToolsContextConnectionTransport = new OutOfProcessConnectionTransport(_id, _host);
 
@@ -1070,6 +1092,11 @@ public IChromiumWebBrowser WebBrowser
         public static readonly DependencyProperty WebBrowserProperty =
             DependencyProperty.Register(nameof(WebBrowser), typeof(IChromiumWebBrowser), typeof(ChromiumWebBrowser), new UIPropertyMetadata(defaultValue: null));
 
+        /// <summary>
+        /// The requestContextPreferences used for the RequestContext.
+        /// </summary>
+        private readonly IDictionary<string, object> requestContextPreferences;
+
         /// <summary>
         /// Runs the specific Action on the Dispatcher in an async fashion
         /// </summary>