/// <summary>
/// <para>Executes initialization necessary for using <see cref="BaseDesktopClient{C}"/> in an application.
/// This method (any overload of this method) must be called once during application lifecycle,
/// before using <see cref="EntClient"/> for the first time.</para>
/// <para><see cref="EntClient"/> uses <see cref="https://github.com/cefsharp/CefSharp"/> for displaying
/// an embedded browser window for operations that require displaying server-side user interface,
/// especially a sign-on window. <see cref="EntClient"/> supports using <c>AnyCPU</c> as target architecture,
/// and with <c>CefSharp</c> this means that loading unmanaged CefSharp resources is required. This
/// method assumes that the required CefSharp dependencies can be found under <c>x84</c> or <c>x64</c>
/// subdirectories.</para>
/// <para>This overload uses the default settings, using
/// <see cref="AppDomain.CurrentDomain.SetupInformation.ApplicationBase"/> as the base directory
/// under which the architecture dependent CefSharp resource subdirectories must be found.</para>
/// </summary>
/// <param name="cefSettings">CefSharp initialization parameters. In many cases it is sufficient to
/// pass an empty instance of a derived class suitable for the use case. Must not be <c>null</c>.</param>
public static void Initialize(CefSettingsBase cefSettings)
{
Initialize(cefSettings, new CefSharpResolverArgs()
{
BaseDir = Path.GetDirectoryName(Assembly.GetEntryAssembly().Location)
});
}
/// <summary>
/// Populates default settings in the given settings object.
/// </summary>
/// <param name="cefSettings">CefSharp initialization parameter object.</param>
protected static void PopulateDefaultCefSettings(CefSettingsBase cefSettings)
{
cefSettings.CefCommandLineArgs.Remove("enable-system-flash");
// Disable GPU settings because on some GPUs these cause incorrect rendering when display is scaled
cefSettings.CefCommandLineArgs.Add("disable-gpu", "1"); // Disable GPU acceleration
cefSettings.CefCommandLineArgs.Add("disable-gpu-vsync", "1"); //Disable GPU vsync
}
public static void InitializeCefSharp(CefSettingsBase cefSettings, CefSharpResolverArgs resolverArgs = null)
{
var resolverArgsOrDefault = resolverArgs == null?BuildDefaultCefSharpResolverArgs() : resolverArgs;
if (resolverArgsOrDefault.BaseDir != null)
{
var browserSubprocessFileName = "CefSharp.BrowserSubprocess.exe";
var archSpecificBrowserSubprocessPath = Path.Combine(resolverArgsOrDefault.BaseDir,
Environment.Is64BitProcess ? "x64" : "x86",
browserSubprocessFileName);
if (File.Exists(archSpecificBrowserSubprocessPath))
{
cefSettings.BrowserSubprocessPath = archSpecificBrowserSubprocessPath;
}
else
{
var flatBrowserSubprocessPath = Path.Combine(resolverArgsOrDefault.BaseDir,
browserSubprocessFileName);
cefSettings.BrowserSubprocessPath = flatBrowserSubprocessPath;
}
}
Cef.Initialize(cefSettings, performDependencyCheck: false, browserProcessHandler: null);
}
public static void Init(CefSettingsBase settings, IBrowserProcessHandler browserProcessHandler)
{
// Set Google API keys, used for Geolocation requests sans GPS. See http://www.chromium.org/developers/how-tos/api-keys
// Environment.SetEnvironmentVariable("GOOGLE_API_KEY", "");
// Environment.SetEnvironmentVariable("GOOGLE_DEFAULT_CLIENT_ID", "");
// Environment.SetEnvironmentVariable("GOOGLE_DEFAULT_CLIENT_SECRET", "");
// Widevine CDM registration - pass in directory where Widevine CDM binaries and manifest.json are located.
// For more information on support for DRM content with Widevine see: https://github.com/cefsharp/CefSharp/issues/1934
//Cef.RegisterWidevineCdm(@".\WidevineCdm");
//Chromium Command Line args
//http://peter.sh/experiments/chromium-command-line-switches/
//NOTE: Not all relevant in relation to `CefSharp`, use for reference purposes only.
//CEF specific command line args
//https://bitbucket.org/chromiumembedded/cef/src/master/libcef/common/cef_switches.cc?fileviewer=file-view-default
//IMPORTANT: For enabled/disabled command line arguments like disable-gpu specifying a value of "0" like
//settings.CefCommandLineArgs.Add("disable-gpu", "0"); will have no effect as the second argument is ignored.
settings.RemoteDebuggingPort = 8088;
//The location where cache data will be stored on disk. If empty an in-memory cache will be used for some features and a temporary disk cache for others.
//HTML5 databases such as localStorage will only persist across sessions if a cache path is specified.
settings.CachePath = "cache";
//settings.UserAgent = "CefSharp Browser" + Cef.CefSharpVersion; // Example User Agent
//settings.CefCommandLineArgs.Add("renderer-process-limit", "1");
//settings.CefCommandLineArgs.Add("renderer-startup-dialog");
//settings.CefCommandLineArgs.Add("enable-media-stream"); //Enable WebRTC
//settings.CefCommandLineArgs.Add("no-proxy-server"); //Don't use a proxy server, always make direct connections. Overrides any other proxy server flags that are passed.
//settings.CefCommandLineArgs.Add("debug-plugin-loading"); //Dumps extra logging about plugin loading to the log file.
//settings.CefCommandLineArgs.Add("disable-plugins-discovery"); //Disable discovering third-party plugins. Effectively loading only ones shipped with the browser plus third-party ones as specified by --extra-plugin-dir and --load-plugin switches
//settings.CefCommandLineArgs.Add("enable-system-flash"); //Automatically discovered and load a system-wide installation of Pepper Flash.
//settings.CefCommandLineArgs.Add("allow-running-insecure-content"); //By default, an https page cannot run JavaScript, CSS or plugins from http URLs. This provides an override to get the old insecure behavior. Only available in 47 and above.
//https://peter.sh/experiments/chromium-command-line-switches/#disable-site-isolation-trials
//settings.CefCommandLineArgs.Add("disable-site-isolation-trials");
//settings.CefCommandLineArgs.Add("enable-logging"); //Enable Logging for the Renderer process (will open with a cmd prompt and output debug messages - use in conjunction with setting LogSeverity = LogSeverity.Verbose;)
//settings.LogSeverity = LogSeverity.Verbose; // Needed for enable-logging to output messages
//settings.CefCommandLineArgs.Add("disable-extensions"); //Extension support can be disabled
//settings.CefCommandLineArgs.Add("disable-pdf-extension"); //The PDF extension specifically can be disabled
//Load the pepper flash player that comes with Google Chrome - may be possible to load these values from the registry and query the dll for it's version info (Step 2 not strictly required it seems)
//settings.CefCommandLineArgs.Add("ppapi-flash-path", @"C:\Program Files (x86)\Google\Chrome\Application\47.0.2526.106\PepperFlash\pepflashplayer.dll"); //Load a specific pepper flash version (Step 1 of 2)
//settings.CefCommandLineArgs.Add("ppapi-flash-version", "20.0.0.228"); //Load a specific pepper flash version (Step 2 of 2)
//Audo play example
//settings.CefCommandLineArgs["autoplay-policy"] = "no-user-gesture-required";
//NOTE: For OSR best performance you should run with GPU disabled:
// `--disable-gpu --disable-gpu-compositing --enable-begin-frame-scheduling`
// (you'll loose WebGL support but gain increased FPS and reduced CPU usage).
// http://magpcss.org/ceforum/viewtopic.php?f=6&t=13271#p27075
//https://bitbucket.org/chromiumembedded/cef/commits/e3c1d8632eb43c1c2793d71639f3f5695696a5e8
//NOTE: The following function will set all three params
//settings.SetOffScreenRenderingBestPerformanceArgs();
//settings.CefCommandLineArgs.Add("disable-gpu");
//settings.CefCommandLineArgs.Add("disable-gpu-compositing");
//settings.CefCommandLineArgs.Add("enable-begin-frame-scheduling");
//settings.CefCommandLineArgs.Add("disable-gpu-vsync"); //Disable Vsync
// The following options control accessibility state for all frames.
// These options only take effect if accessibility state is not set by IBrowserHost.SetAccessibilityState call.
// --force-renderer-accessibility enables browser accessibility.
// --disable-renderer-accessibility completely disables browser accessibility.
//settings.CefCommandLineArgs.Add("force-renderer-accessibility");
//settings.CefCommandLineArgs.Add("disable-renderer-accessibility");
//Enables Uncaught exception handler
settings.UncaughtExceptionStackSize = 10;
//Disable WebAssembly
//settings.JavascriptFlags = "--noexpose_wasm";
// Off Screen rendering (WPF/Offscreen)
if (settings.WindowlessRenderingEnabled)
{
//Disable Direct Composition to test https://github.com/cefsharp/CefSharp/issues/1634
//settings.CefCommandLineArgs.Add("disable-direct-composition");
// DevTools doesn't seem to be working when this is enabled
// http://magpcss.org/ceforum/viewtopic.php?f=6&t=14095
//settings.CefCommandLineArgs.Add("enable-begin-frame-scheduling");
}
var proxy = ProxyConfig.GetProxyInformation();
switch (proxy.AccessType)
{
case InternetOpenType.Direct:
{
//Don't use a proxy server, always make direct connections.
settings.CefCommandLineArgs.Add("no-proxy-server");
break;
}
case InternetOpenType.Proxy:
{
settings.CefCommandLineArgs.Add("proxy-server", proxy.ProxyAddress);
break;
}
case InternetOpenType.PreConfig:
{
settings.CefCommandLineArgs.Add("proxy-auto-detect");
break;
}
}
//settings.LogSeverity = LogSeverity.Verbose;
if (DebuggingSubProcess)
{
var architecture = Environment.Is64BitProcess ? "x64" : "x86";
settings.BrowserSubprocessPath = "..\\..\\..\\..\\CefSharp.BrowserSubprocess\\bin\\" + architecture + "\\Debug\\CefSharp.BrowserSubprocess.exe";
}
settings.RegisterScheme(new CefCustomScheme
{
SchemeName = CefSharpSchemeHandlerFactory.SchemeName,
SchemeHandlerFactory = new CefSharpSchemeHandlerFactory(),
IsSecure = true, //treated with the same security rules as those applied to "https" URLs
});
settings.RegisterScheme(new CefCustomScheme
{
SchemeName = "https",
SchemeHandlerFactory = new CefSharpSchemeHandlerFactory(),
DomainName = "cefsharp.example"
});
settings.RegisterScheme(new CefCustomScheme
{
SchemeName = CefSharpSchemeHandlerFactory.SchemeNameTest,
SchemeHandlerFactory = new CefSharpSchemeHandlerFactory(),
IsSecure = true //treated with the same security rules as those applied to "https" URLs
});
//You can use the http/https schemes - best to register for a specific domain
settings.RegisterScheme(new CefCustomScheme
{
SchemeName = "https",
SchemeHandlerFactory = new CefSharpSchemeHandlerFactory(),
DomainName = "cefsharp.com",
IsSecure = true //treated with the same security rules as those applied to "https" URLs
});
settings.RegisterScheme(new CefCustomScheme
{
SchemeName = "localfolder",
SchemeHandlerFactory = new FolderSchemeHandlerFactory(rootFolder: @"..\..\..\..\CefSharp.Example\Resources",
schemeName: "localfolder", //Optional param no schemename checking if null
hostName: "cefsharp", //Optional param no hostname checking if null
defaultPage: "home.html") //Optional param will default to index.html
});
settings.RegisterExtension(new V8Extension("cefsharp/example", Resources.extension));
//This must be set before Cef.Initialized is called
CefSharpSettings.FocusedNodeChangedEnabled = true;
//Async Javascript Binding - methods are queued on TaskScheduler.Default.
//Set this to true to when you have methods that return Task<T>
//CefSharpSettings.ConcurrentTaskExecution = true;
//Legacy Binding Behaviour - Same as Javascript Binding in version 57 and below
//See issue https://github.com/cefsharp/CefSharp/issues/1203 for details
//CefSharpSettings.LegacyJavascriptBindingEnabled = true;
//Exit the subprocess if the parent process happens to close
//This is optional at the moment
//https://github.com/cefsharp/CefSharp/pull/2375/
CefSharpSettings.SubprocessExitIfParentProcessClosed = true;
//NOTE: Set this before any calls to Cef.Initialize to specify a proxy with username and password
//One set this cannot be changed at runtime. If you need to change the proxy at runtime (dynamically) then
//see https://github.com/cefsharp/CefSharp/wiki/General-Usage#proxy-resolution
//CefSharpSettings.Proxy = new ProxyOptions(ip: "127.0.0.1", port: "8080", username: "******", password: "******");
if (!Cef.Initialize(settings, performDependencyCheck: !DebuggingSubProcess, browserProcessHandler: browserProcessHandler))
{
throw new Exception("Unable to Initialize Cef");
}
Cef.AddCrossOriginWhitelistEntry(BaseUrl, "https", "cefsharp.com", false);
}
public static void InitializeCefSharp(CefSettingsBase cefSettings)
{
InitializeCefSharp(cefSettings, BuildDefaultCefSharpResolverArgs());
}
public static void Init(CefSettingsBase settings, IBrowserProcessHandler browserProcessHandler)
{
// Set Google API keys, used for Geolocation requests sans GPS. See http://www.chromium.org/developers/how-tos/api-keys
// Environment.SetEnvironmentVariable("GOOGLE_API_KEY", "");
// Environment.SetEnvironmentVariable("GOOGLE_DEFAULT_CLIENT_ID", "");
// Environment.SetEnvironmentVariable("GOOGLE_DEFAULT_CLIENT_SECRET", "");
//Chromium Command Line args
//http://peter.sh/experiments/chromium-command-line-switches/
//NOTE: Not all relevant in relation to `CefSharp`, use for reference purposes only.
//CEF specific command line args
//https://bitbucket.org/chromiumembedded/cef/src/master/libcef/common/cef_switches.cc?fileviewer=file-view-default
//**IMPORTANT**: For enabled/disabled command line arguments like disable-gpu specifying a value of "0" like
//settings.CefCommandLineArgs.Add("disable-gpu", "0"); will have no effect as the second argument is ignored.
//**IMPORTANT**: When using command line arguments the behaviour may change between Chromium versions, if you are experiencing
//issues after upgrading to a newer version, you should remove all custom command line arguments and add test them in
//isolation to determine if they are causing issues.
//The command line arguments shown here are here as a reference only and are not tested to confirm they work with each version
settings.RemoteDebuggingPort = 8088;
//The location where cache data will be stored on disk. If empty an in-memory cache will be used for some features and a temporary disk cache for others.
//HTML5 databases such as localStorage will only persist across sessions if a cache path is specified.
settings.RootCachePath = Path.GetFullPath("cache");
//If non-null then CachePath must be equal to or a child of RootCachePath
//We're using a sub folder.
//
settings.CachePath = Path.GetFullPath("cache\\global");
//settings.UserAgent = "CefSharp Browser" + Cef.CefSharpVersion; // Example User Agent
//settings.CefCommandLineArgs.Add("renderer-startup-dialog");
//settings.CefCommandLineArgs.Add("enable-media-stream"); //Enable WebRTC
//settings.CefCommandLineArgs.Add("no-proxy-server"); //Don't use a proxy server, always make direct connections. Overrides any other proxy server flags that are passed.
//settings.CefCommandLineArgs.Add("allow-running-insecure-content"); //By default, an https page cannot run JavaScript or CSS from http URLs. This provides an override to get the old insecure behavior. Only available in 47 and above.
//https://peter.sh/experiments/chromium-command-line-switches/#disable-site-isolation-trials
//settings.CefCommandLineArgs.Add("disable-site-isolation-trials");
//NOTE: Running the Network Service in Process is not something CEF officially supports
//It may or may not work for newer versions.
//settings.CefCommandLineArgs.Add("enable-features", "CastMediaRouteProvider,NetworkServiceInProcess");
//settings.CefCommandLineArgs.Add("enable-logging"); //Enable Logging for the Renderer process (will open with a cmd prompt and output debug messages - use in conjunction with setting LogSeverity = LogSeverity.Verbose;)
//settings.LogSeverity = LogSeverity.Verbose; // Needed for enable-logging to output messages
//settings.CefCommandLineArgs.Add("disable-extensions"); //Extension support can be disabled
//settings.CefCommandLineArgs.Add("disable-pdf-extension"); //The PDF extension specifically can be disabled
//Audo play example
//settings.CefCommandLineArgs["autoplay-policy"] = "no-user-gesture-required";
//NOTE: For OSR best performance you should run with GPU disabled:
// `--disable-gpu --disable-gpu-compositing --enable-begin-frame-scheduling`
// (you'll loose WebGL support but gain increased FPS and reduced CPU usage).
// http://magpcss.org/ceforum/viewtopic.php?f=6&t=13271#p27075
//https://bitbucket.org/chromiumembedded/cef/commits/e3c1d8632eb43c1c2793d71639f3f5695696a5e8
//NOTE: The following function will set all three params
//settings.SetOffScreenRenderingBestPerformanceArgs();
//settings.CefCommandLineArgs.Add("disable-gpu");
//settings.CefCommandLineArgs.Add("disable-gpu-compositing");
//settings.CefCommandLineArgs.Add("enable-begin-frame-scheduling");
//settings.CefCommandLineArgs.Add("disable-gpu-vsync"); //Disable Vsync
// The following options control accessibility state for all frames.
// These options only take effect if accessibility state is not set by IBrowserHost.SetAccessibilityState call.
// --force-renderer-accessibility enables browser accessibility.
// --disable-renderer-accessibility completely disables browser accessibility.
//settings.CefCommandLineArgs.Add("force-renderer-accessibility");
//settings.CefCommandLineArgs.Add("disable-renderer-accessibility");
//Enables Uncaught exception handler
settings.UncaughtExceptionStackSize = 10;
//Disable WebAssembly
//settings.JavascriptFlags = "--noexpose_wasm";
// Off Screen rendering (WPF/Offscreen)
if (settings.WindowlessRenderingEnabled)
{
//Disable Direct Composition to test https://github.com/cefsharp/CefSharp/issues/1634
//settings.CefCommandLineArgs.Add("disable-direct-composition");
// DevTools doesn't seem to be working when this is enabled
// http://magpcss.org/ceforum/viewtopic.php?f=6&t=14095
//settings.CefCommandLineArgs.Add("enable-begin-frame-scheduling");
}
var proxy = ProxyConfig.GetProxyInformation();
switch (proxy.AccessType)
{
case InternetOpenType.Direct:
{
//Don't use a proxy server, always make direct connections.
settings.CefCommandLineArgs.Add("no-proxy-server");
break;
}
case InternetOpenType.Proxy:
{
settings.CefCommandLineArgs.Add("proxy-server", proxy.ProxyAddress);
break;
}
case InternetOpenType.PreConfig:
{
settings.CefCommandLineArgs.Add("proxy-auto-detect");
break;
}
}
//settings.LogSeverity = LogSeverity.Verbose;
//Experimental setting see https://bitbucket.org/chromiumembedded/cef/issues/2969/support-chrome-windows-with-cef-callbacks
//for details
//settings.ChromeRuntime = true;
if (DebuggingSubProcess)
{
var architecture = RuntimeInformation.ProcessArchitecture.ToString().ToLowerInvariant();
#if NETCOREAPP
settings.BrowserSubprocessPath = Path.GetFullPath("..\\..\\..\\..\\..\\..\\CefSharp.BrowserSubprocess\\bin.netcore\\" + architecture + "\\Debug\\netcoreapp3.1\\CefSharp.BrowserSubprocess.exe");
#else
settings.BrowserSubprocessPath = Path.GetFullPath("..\\..\\..\\..\\CefSharp.BrowserSubprocess\\bin\\" + architecture + "\\Debug\\CefSharp.BrowserSubprocess.exe");
#endif
}
settings.CookieableSchemesList = "custom";
settings.RegisterScheme(new CefCustomScheme
{
SchemeName = CefSharpSchemeHandlerFactory.SchemeName,
SchemeHandlerFactory = new CefSharpSchemeHandlerFactory(),
IsSecure = true, //treated with the same security rules as those applied to "https" URLs
});
settings.RegisterScheme(new CefCustomScheme
{
SchemeName = "https",
SchemeHandlerFactory = new CefSharpSchemeHandlerFactory(),
DomainName = ExampleDomain
});
settings.RegisterScheme(new CefCustomScheme
{
SchemeName = CefSharpSchemeHandlerFactory.SchemeNameTest,
SchemeHandlerFactory = new CefSharpSchemeHandlerFactory(),
IsSecure = true //treated with the same security rules as those applied to "https" URLs
});
//You can use the http/https schemes - best to register for a specific domain
settings.RegisterScheme(new CefCustomScheme
{
SchemeName = "https",
SchemeHandlerFactory = new CefSharpSchemeHandlerFactory(),
DomainName = "cefsharp.com",
IsSecure = true //treated with the same security rules as those applied to "https" URLs
});
const string cefSharpExampleResourcesFolder =
#if !NETCOREAPP
@"..\..\..\..\CefSharp.Example\Resources";
#else
@"..\..\..\..\..\..\CefSharp.Example\Resources";
#endif
settings.RegisterScheme(new CefCustomScheme
{
SchemeName = "localfolder",
SchemeHandlerFactory = new FolderSchemeHandlerFactory(rootFolder: cefSharpExampleResourcesFolder,
schemeName: "localfolder", //Optional param no schemename checking if null
hostName: "cefsharp", //Optional param no hostname checking if null
defaultPage: "home.html") //Optional param will default to index.html
});
//This must be set before Cef.Initialized is called
CefSharpSettings.FocusedNodeChangedEnabled = true;
//Async Javascript Binding - methods are queued on TaskScheduler.Default.
//Set this to true to when you have methods that return Task<T>
//CefSharpSettings.ConcurrentTaskExecution = true;
//Legacy Binding Behaviour - Same as Javascript Binding in version 57 and below
//See issue https://github.com/cefsharp/CefSharp/issues/1203 for details
//CefSharpSettings.LegacyJavascriptBindingEnabled = true;
//Exit the subprocess if the parent process happens to close
//This is optional at the moment
//https://github.com/cefsharp/CefSharp/pull/2375/
CefSharpSettings.SubprocessExitIfParentProcessClosed = true;
//NOTE: Set this before any calls to Cef.Initialize to specify a proxy with username and password
//One set this cannot be changed at runtime. If you need to change the proxy at runtime (dynamically) then
//see https://github.com/cefsharp/CefSharp/wiki/General-Usage#proxy-resolution
//CefSharpSettings.Proxy = new ProxyOptions(ip: "127.0.0.1", port: "8080", username: "******", password: "******");
bool performDependencyCheck = !DebuggingSubProcess;
if (!Cef.Initialize(settings, performDependencyCheck: performDependencyCheck, browserProcessHandler: browserProcessHandler))
{
throw new Exception("Unable to Initialize Cef");
}
Cef.AddCrossOriginWhitelistEntry(BaseUrl, "https", "cefsharp.com", false);
}
/// <summary>
/// <para>Executes initialization necessary for using <see cref="BaseDesktopClient{C}"/> in an application.
/// This method (any overload of this method) must be called once during application lifecycle,
/// before using <see cref="EntClient"/> for the first time.</para>
/// <para><see cref="EntClient"/> uses <see cref="https://github.com/cefsharp/CefSharp"/> for displaying
/// an embedded browser window for operations that require displaying server-side user interface,
/// especially a sign-on window. <see cref="EntClient"/> supports using <c>AnyCPU</c> as target architecture,
/// and with <c>CefSharp</c> this means that loading unmanaged CefSharp resources is required. This
/// method assumes that the required CefSharp dependencies can be found under <c>x84</c> or <c>x64</c>
/// subdirectories.</para>
/// </summary>
/// <param name="cefSettings">CefSharp initialization parameters. In many cases it is sufficient to
/// pass an empty instance of a derived class suitable for the use case. Must not be <c>null</c>.</param>
/// <param name="resolverArgs">Arguments for customizing how CefSharp / cef resources are searched,
/// or <c>null</c> for default behavior.</param>
public static void Initialize(CefSettingsBase cefSettings, CefSharpResolverArgs resolverArgs = null)
{
CefSharpUtil.InitializeCefSharp(cefSettings, resolverArgs);
cefSharpInitialized = true;
}
public static void RegisterOwinSchemeHandlerFactory(this CefSettingsBase settings, string schemeName, AppFunc appFunc)
{
settings.RegisterScheme(new CefCustomScheme {
SchemeName = schemeName, SchemeHandlerFactory = new OwinSchemeHandlerFactory(appFunc)
});
}
