Add SetRequestContextPreferenceAsync

- Ability to set RequestContext preference
- Upgrade StreamJsonRpc version

Author: amaitland

CefSharp.OutOfProcess.BrowserProcess/BrowserProcessHandler.cs

@@ -4,9 +4,9 @@
 using System;
 using System.Linq;
 using System.Collections.Generic;
-using System.Diagnostics;
-using CefSharp.OutOfProcess.Interface;
 using System.Threading.Tasks;
+using CefSharp.OutOfProcess.Model;
+using System.Diagnostics;
 
 namespace CefSharp.OutOfProcess.BrowserProcess
 {
@@ -124,5 +124,46 @@ void IOutOfProcessClientRpc.SetFocus(int browserId, bool focus)
 
             browser?.GetBrowserHost().SetFocus(focus);
         }
+
+        /// <inheritdoc />
+        Task<SetPreferenceResponse> IOutOfProcessClientRpc.SetRequestContextPreferenceAsync(int browserId, string name, object value)
+        {
+            //Debugger.Break();
+
+            if (CefThread.HasShutdown)
+            {
+                return Task.FromResult(new SetPreferenceResponse(false, "Cef.Shutdown has already been called, it is no longer possible to call SetPreferenceAsync."));
+            }
+
+            var browser = _browsers.FirstOrDefault(x => x.Id == browserId);
+
+            if (browser == null)
+            {
+                return Task.FromResult(new SetPreferenceResponse(false, $"Browser with Id {browserId} was null."));
+            }
+
+            return CefThread.ExecuteOnUiThread(() =>
+            {
+                var ctx = browser?.GetRequestContext();
+
+                if (ctx == null)
+                {
+                    return new SetPreferenceResponse(false, "RequestContext was null.");
+                }
+
+                // StreamJsonRpc is converting ints to long which makes sense as we accept
+                // object. CefValue doesn't support Int64, so we just convert to int
+                // This should hopefully be fine as it's unliklely any preference requires
+                // an Int64 value.
+                if (value?.GetType() == typeof(long))
+                {
+                    value = Convert.ToInt32(value);
+                }
+
+                var success = ctx.SetPreference(name, value, out string error);
+
+                return new SetPreferenceResponse(success, error);
+            });
+        }
     }
 }

CefSharp.OutOfProcess.BrowserProcess/CefSharp.OutOfProcess.BrowserProcess.csproj

@@ -13,7 +13,7 @@
   <ItemGroup>
     <PackageReference Include="PInvoke.Kernel32" Version="0.7.104" />
     <PackageReference Include="PInvoke.User32" Version="0.7.104" />
-    <PackageReference Include="StreamJsonRpc" Version="2.11.35" />
+    <PackageReference Include="StreamJsonRpc" Version="2.14.24" />
     <PackageReference Include="CefSharp.Common" Version="110.0.250" />
   </ItemGroup>
 

CefSharp.OutOfProcess.BrowserProcess/OutOfProcessChromiumWebBrowser.cs

@@ -5,10 +5,7 @@
 using System.ComponentModel;
 using CefSharp.Callback;
 using System.IO;
-using CefSharp.OutOfProcess.Interface;
 using System.Runtime.InteropServices;
-using PInvoke;
-using System.Diagnostics;
 
 namespace CefSharp.OutOfProcess.BrowserProcess
 {

CefSharp.OutOfProcess.Core/CefSharp.OutOfProcess.Core.csproj

@@ -8,7 +8,7 @@
   <ItemGroup>
     <PackageReference Include="PInvoke.Kernel32" Version="0.7.104" />
     <PackageReference Include="PInvoke.User32" Version="0.7.104" />
-    <PackageReference Include="StreamJsonRpc" Version="2.11.35" />
+    <PackageReference Include="StreamJsonRpc" Version="2.14.24" />
     <ProjectReference Include="..\CefSharp.OutOfProcess.Interface\CefSharp.OutOfProcess.Interface.csproj" />
 
     <ProjectReference Include="..\CefSharp.Dom\lib\PuppeteerSharp\CefSharp.Dom.OutOfProcess.csproj" />

CefSharp.OutOfProcess.Core/IChromiumWebBrowser.cs

@@ -1,4 +1,5 @@
 using CefSharp.Dom;
+using CefSharp.OutOfProcess.Model;
 using System;
 using System.Threading.Tasks;
 
@@ -203,5 +204,16 @@ public interface IChromiumWebBrowser : IDisposable
         /// the navigation will resolve with the response of the last redirect. If can not go forward, resolves to null.</returns>
         /// <param name="options">Navigation parameters.</param>
         Task<Response> GoForwardAsync(NavigationOptions options = null);
+
+        /// <summary>
+        /// Set the value associated with preference name. If value is null the
+        /// preference will be restored to its default value. If setting the preference
+        /// fails then <see cref="SetPreferenceResponse.ErrorMessage"/> will be populated
+        /// with a detailed description of the problem.
+        /// Preferences set via the command-line usually cannot be modified.
+        /// </summary>
+        /// <param name="name">The preference name</param>
+        /// <param name="value">The preference value</param>
+        Task<SetPreferenceResponse> SetRequestContextPreferenceAsync(string name, object value);
     }
 }

CefSharp.OutOfProcess.Core/OutOfProcessHost.cs

@@ -1,5 +1,5 @@
-using CefSharp.OutOfProcess.Interface;
-using CefSharp.OutOfProcess.Internal;
+using CefSharp.OutOfProcess.Internal;
+using CefSharp.OutOfProcess.Model;
 using PInvoke;
 using StreamJsonRpc;
 using System;
@@ -243,6 +243,21 @@ public void CloseBrowser(int id)
             _ = _outOfProcessClient.CloseBrowser(id);
         }
 
+        /// <summary>
+        /// Set the value associated with preference name. If value is null the
+        /// preference will be restored to its default value. If setting the preference
+        /// fails then <see cref="SetPreferenceResponse.ErrorMessage"/> will be populated
+        /// with a detailed description of the problem.
+        /// Preferences set via the command-line usually cannot be modified.
+        /// </summary>
+        /// <param name="id">The browser id.</param>
+        /// <param name="name">The preference name</param>
+        /// <param name="value">The preference value</param>
+        public Task<SetPreferenceResponse> SetRequestContextPreferenceAsync(int id, string name, object value)
+        {
+            return _outOfProcessClient.SetRequestContextPreferenceAsync(id, name, value);
+        }
+
         public void Dispose()
         {
             _ = _outOfProcessClient.CloseHost();

CefSharp.OutOfProcess.Interface/CefSharp.OutOfProcess.Interface.csproj

@@ -2,6 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
+    <RootNamespace>CefSharp.OutOfProcess</RootNamespace>
   </PropertyGroup>
 
 </Project>

CefSharp.OutOfProcess.Interface/IOutOfProcessClientRpc.cs

@@ -1,7 +1,8 @@
-using System;
+using CefSharp.OutOfProcess.Model;
+using System;
 using System.Threading.Tasks;
 
-namespace CefSharp.OutOfProcess.Interface
+namespace CefSharp.OutOfProcess
 {
     /// <summary>
     /// Send messages to the Remote Host (Browser process)
@@ -51,5 +52,17 @@ public interface IOutOfProcessClientRpc
         /// <param name="id">browser id</param>
         /// <param name="focus">set focus</param>
         void SetFocus(int browserId, bool focus);
+
+        /// <summary>
+        /// Set the value associated with preference name. If value is null the
+        /// preference will be restored to its default value. If setting the preference
+        /// fails then <see cref="SetPreferenceResponse.ErrorMessage"/> will be populated
+        /// with a detailed description of the problem.
+        /// Preferences set via the command-line usually cannot be modified.
+        /// </summary>
+        /// <param name="browserId">The browser id.</param>
+        /// <param name="name">The preference name</param>
+        /// <param name="value">The preference value</param>
+        Task<SetPreferenceResponse> SetRequestContextPreferenceAsync(int browserId, string name, object value);
     }
 }

CefSharp.OutOfProcess.Interface/IOutOfProcessHostRpc.cs

@@ -1,6 +1,6 @@
 using System;
 
-namespace CefSharp.OutOfProcess.Interface
+namespace CefSharp.OutOfProcess
 {
     /// <summary>
     /// Receive messages from the Remote Host (Browser process).

CefSharp.OutOfProcess.Interface/Model/SetPreferenceResponse.cs

@@ -0,0 +1,29 @@
+namespace CefSharp.OutOfProcess.Model
+{
+    /// <summary>
+    /// Response when setting a Preference
+    /// </summary>
+    public class SetPreferenceResponse
+    {
+        /// <summary>
+        /// Success
+        /// </summary>
+        public bool Success { get; private set; }
+
+        /// <summary>
+        /// Error Message
+        /// </summary>
+        public string ErrorMessage { get; private set; }
+
+        /// <summary>
+        /// Initializes a new instance of the SetPreferenceResponse class.
+        /// </summary>
+        /// <param name="success">success</param>
+        /// <param name="errorMessage">error message</param>
+        public SetPreferenceResponse(bool success, string errorMessage)
+        {
+            Success = success;
+            ErrorMessage = errorMessage;
+        }
+    }
+}