Merge 4d66ce6 into cdc694e

Author: Geevo

CefSharp.BrowserSubprocess.Core/CefAppUnmanagedWrapper.cpp

@@ -86,6 +86,9 @@ namespace CefSharp
                 }
             }
         }
+
+        _jsBindingPropertyName = extraInfo->GetString("JsBindingPropertyName");
+        _jsBindingPropertyNameCamelCase = extraInfo->GetString("JsBindingPropertyNameCamelCase");
     }
 
     void CefAppUnmanagedWrapper::OnBrowserDestroyed(CefRefPtr<CefBrowser> browser)
@@ -124,11 +127,11 @@ namespace CefSharp
         auto browserWrapper = FindBrowserWrapper(browser->GetIdentifier());
 
         auto cefSharpObj = CefV8Value::CreateObject(NULL, NULL);
-        global->SetValue("CefSharp", cefSharpObj, CefV8Value::PropertyAttribute::V8_PROPERTY_ATTRIBUTE_READONLY);
+        global->SetValue(_jsBindingPropertyName, cefSharpObj, CefV8Value::PropertyAttribute::V8_PROPERTY_ATTRIBUTE_READONLY);
 
         //We'll support both CefSharp and cefSharp, for those who prefer the JS style
         auto cefSharpObjCamelCase = CefV8Value::CreateObject(NULL, NULL);
-        global->SetValue("cefSharp", cefSharpObjCamelCase, CefV8Value::PropertyAttribute::V8_PROPERTY_ATTRIBUTE_READONLY);
+        global->SetValue(_jsBindingPropertyNameCamelCase, cefSharpObjCamelCase, CefV8Value::PropertyAttribute::V8_PROPERTY_ATTRIBUTE_READONLY);
 
         //TODO: JSB: Split functions into their own classes
         //Browser wrapper is only used for BindObjectAsync

CefSharp.BrowserSubprocess.Core/CefAppUnmanagedWrapper.h

@@ -28,6 +28,10 @@ namespace CefSharp
         bool _focusedNodeChangedEnabled;
         bool _legacyBindingEnabled;
 
+        // The property names used to call binded objects
+        CefString _jsBindingPropertyName;
+        CefString _jsBindingPropertyNameCamelCase;
+
         // The serialized registered object data waiting to be used.
         gcroot<Dictionary<String^, JavascriptObject^>^> _javascriptObjects;
 

CefSharp.Core/ManagedCefBrowserAdapter.cpp

@@ -48,7 +48,7 @@ void ManagedCefBrowserAdapter::CreateBrowser(IWindowInfo^ windowInfo, BrowserSet
 
         legacyBindingEnabled = objectRepository->HasBoundObjects;
 
-        //For legacy binding we only add values if we have bond objects
+        //For legacy binding we only add values if we have bond objects.
         if (legacyBindingEnabled)
         {
             auto listValue = CefListValue::Create();
@@ -61,6 +61,17 @@ void ManagedCefBrowserAdapter::CreateBrowser(IWindowInfo^ windowInfo, BrowserSet
 
     extraInfo->SetBool("LegacyBindingEnabled", legacyBindingEnabled);
 
+    // Retrieve the configurable binding property names, throw exception if empty or illegal characters
+    auto jsBindingPropertyName = CefSharpSettings::JavascriptBindingPropertyName;
+    auto jsBindingPropertyNameCamelCase = CefSharpSettings::JavascriptBindingPropertyNameCamelCase;
+    if (!StringCheck::EnsureLettersAndNumbers(jsBindingPropertyName) || !StringCheck::EnsureLettersAndNumbers(jsBindingPropertyNameCamelCase))
+    {
+        throw gcnew InvalidOperationException("CefBrowserHost::CreateBrowser invalid or illegal characters used for binding property names. Alphanumeric and underscores characters only.");
+    }
+
+    extraInfo->SetString("JsBindingPropertyName", StringUtils::ToNative(jsBindingPropertyName));
+    extraInfo->SetString("JsBindingPropertyNameCamelCase", StringUtils::ToNative(jsBindingPropertyNameCamelCase));
+
     if (!CefBrowserHost::CreateBrowser(*cefWindowInfoWrapper->GetWindowInfo(), _clientAdapter.get(), addressNative,
         *browserSettings->_browserSettings, extraInfo, static_cast<CefRefPtr<CefRequestContext>>(requestContext)))
     {

CefSharp/CefSharp.csproj

@@ -111,6 +111,7 @@
     <Compile Include="Internals\CookieManagerDecorator.cs" />
     <Compile Include="Internals\ParentProcessMonitor.cs" />
     <Compile Include="Internals\HeaderNameValueCollection.cs" />
+    <Compile Include="Internals\StringCheck.cs" />
     <Compile Include="Internals\TaskScheduler\LimitedConcurrencyLevelTaskScheduler.cs" />
     <Compile Include="IUrlRequest.cs" />
     <Compile Include="IUrlRequestClient.cs" />

CefSharp/CefSharpSettings.cs

@@ -20,8 +20,30 @@ static CefSharpSettings()
             LegacyJavascriptBindingEnabled = false;
             WcfTimeout = TimeSpan.FromSeconds(2);
             SubprocessExitIfParentProcessClosed = true;
+            JavascriptBindingPropertyName = "CefSharp";
+            JavascriptBindingPropertyNameCamelCase = "cefSharp";
         }
 
+        /// <summary>
+        /// Configure the browser binding property name.
+        /// Use a custom property name when calling registred objects, example 'CefSharp.BindObjectAsync'.
+        /// Alphanumeric and underscores characters only.
+        /// The default value is 'CefSharp'
+        ///
+        /// NOTE: There are two properties to be mindful of, this and <see cref="JavascriptBindingPropertyNameCamelCase"/>
+        /// </summary>
+        public static string JavascriptBindingPropertyName { get; set; }
+
+        /// <summary>
+        /// Configure the browser binding property name with camel case.
+        /// Use a custom property name when calling registred objects, example 'cefSharp.BindObjectAsync'
+        /// Alphanumeric and underscores characters only.
+        /// The default value is 'cefSharp'.
+        ///
+        /// NOTE: There are two properties to be mindful of, this and <see cref="JavascriptBindingPropertyName"/>
+        /// </summary>
+        public static string JavascriptBindingPropertyNameCamelCase { get; set; }
+
         /// <summary>
         /// Objects registered using RegisterJsObject and RegisterAsyncJsObject
         /// will be automatically bound when a V8Context is created. (Soon as the Javascript

CefSharp/Internals/StringCheck.cs

@@ -0,0 +1,30 @@
+// Copyright © 2020 The CefSharp Authors. All rights reserved.
+//
+// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
+
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Text.RegularExpressions;
+
+namespace CefSharp.Internals
+{
+    public static class StringCheck
+    {
+        /// <summary>
+        /// Regex check to ensure string contains only letters, numbers and underscores.
+        /// </summary>
+        /// <param name="stringToCheck"></param>
+        /// <returns></returns>
+        public static bool EnsureLettersAndNumbers(string stringToCheck)
+        {
+            if (!string.IsNullOrWhiteSpace(stringToCheck))
+            {
+                return Regex.IsMatch(stringToCheck, @"^\w+$");
+            }
+
+            return false;
+        }
+    }
+}