env_create.go 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. //go:build windows && !native_webview2loader
  2. package webviewloader
  3. import (
  4. "fmt"
  5. "os"
  6. "path/filepath"
  7. "syscall"
  8. "unsafe"
  9. "github.com/wailsapp/go-webview2/pkg/combridge"
  10. "golang.org/x/sys/windows"
  11. )
  12. func init() {
  13. UsingGoWebview2Loader = true
  14. preventEnvAndRegistryOverrides()
  15. }
  16. type webView2RunTimeType int32
  17. const (
  18. webView2RunTimeTypeInstalled webView2RunTimeType = 0x00
  19. webView2RunTimeTypeRedistributable webView2RunTimeType = 0x01
  20. )
  21. // CreateCoreWebView2Environment creates an evergreen WebView2 Environment using the installed WebView2 Runtime version.
  22. //
  23. // This is equivalent to running CreateCoreWebView2EnvironmentWithOptions without any options.
  24. // For more information, see CreateCoreWebView2EnvironmentWithOptions.
  25. func CreateCoreWebView2Environment(environmentCompletedHandler ICoreWebView2CreateCoreWebView2EnvironmentCompletedHandler) error {
  26. return CreateCoreWebView2EnvironmentWithOptions(environmentCompletedHandler)
  27. }
  28. // CreateCoreWebView2EnvironmentWithOptions creates an environment with a custom version of WebView2 Runtime,
  29. // user data folder, and with or without additional options.
  30. //
  31. // See https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/webview2-idl?#createcorewebview2environmentwithoptions
  32. func CreateCoreWebView2EnvironmentWithOptions(environmentCompletedHandler ICoreWebView2CreateCoreWebView2EnvironmentCompletedHandler, opts ...option) error {
  33. var params environmentOptions
  34. for _, opt := range opts {
  35. opt(&params)
  36. }
  37. var err error
  38. var dllPath string
  39. var runtimeType webView2RunTimeType
  40. if browserExecutableFolder := params.browserExecutableFolder; browserExecutableFolder != "" {
  41. runtimeType = webView2RunTimeTypeRedistributable
  42. dllPath, err = findEmbeddedClientDll(browserExecutableFolder)
  43. } else {
  44. runtimeType = webView2RunTimeTypeInstalled
  45. dllPath, _, err = findInstalledClientDll(params.preferCanary)
  46. }
  47. if err != nil {
  48. return err
  49. }
  50. return createWebViewEnvironmentWithClientDll(dllPath, runtimeType, params.userDataFolder,
  51. &params, environmentCompletedHandler)
  52. }
  53. func createWebViewEnvironmentWithClientDll(lpLibFileName string, runtimeType webView2RunTimeType, userDataFolder string,
  54. envOptions *environmentOptions, envCompletedHandler ICoreWebView2CreateCoreWebView2EnvironmentCompletedHandler) error {
  55. if !filepath.IsAbs(lpLibFileName) {
  56. return fmt.Errorf("lpLibFileName must be absolute")
  57. }
  58. dll, err := windows.LoadDLL(lpLibFileName)
  59. if err != nil {
  60. return fmt.Errorf("Loading DLL failed: %w", err)
  61. }
  62. defer func() {
  63. canUnloadProc, err := dll.FindProc("DllCanUnloadNow")
  64. if err != nil {
  65. return
  66. }
  67. if r1, _, _ := canUnloadProc.Call(); r1 != windows.NO_ERROR {
  68. return
  69. }
  70. dll.Release()
  71. }()
  72. createProc, err := dll.FindProc("CreateWebViewEnvironmentWithOptionsInternal")
  73. if err != nil {
  74. return fmt.Errorf("Unable to find CreateWebViewEnvironmentWithOptionsInternal entrypoint: %w", err)
  75. }
  76. userDataPtr, err := windows.UTF16PtrFromString(userDataFolder)
  77. if err != nil {
  78. return err
  79. }
  80. envOptionsCom := combridge.New2[iCoreWebView2EnvironmentOptions, iCoreWebView2EnvironmentOptions2](
  81. envOptions, envOptions)
  82. defer envOptionsCom.Close()
  83. envCompletedHandler = &environmentCreatedHandler{envCompletedHandler}
  84. envCompletedCom := combridge.New[iCoreWebView2CreateCoreWebView2EnvironmentCompletedHandler](envCompletedHandler)
  85. defer envCompletedCom.Close()
  86. preventEnvAndRegistryOverrides()
  87. const unknown = 1
  88. hr, _, err := createProc.Call(
  89. uintptr(unknown),
  90. uintptr(runtimeType),
  91. uintptr(unsafe.Pointer(userDataPtr)),
  92. uintptr(envOptionsCom.Ref()),
  93. uintptr(envCompletedCom.Ref()))
  94. if hr != 0 {
  95. if err == nil || err == windows.ERROR_SUCCESS {
  96. err = syscall.Errno(hr)
  97. }
  98. return err
  99. }
  100. return nil
  101. }
  102. type environmentCreatedHandler struct {
  103. originalHandler ICoreWebView2CreateCoreWebView2EnvironmentCompletedHandler
  104. }
  105. func (r *environmentCreatedHandler) EnvironmentCompleted(errorCode HRESULT, createdEnvironment *ICoreWebView2Environment) HRESULT {
  106. // The OpenWebview2Loader has some retry logic and retries once, didn't encounter any case when this would have been
  107. // needed during the development: https://github.com/jchv/OpenWebView2Loader/blob/master/Source/WebView2Loader.cpp#L202
  108. if createdEnvironment != nil {
  109. // May or may not be necessary, but the official WebView2Loader seems to do it.
  110. iidICoreWebView2Environment := windows.GUID{
  111. Data1: 0xb96d755e,
  112. Data2: 0x0319,
  113. Data3: 0x4e92,
  114. Data4: [8]byte{0xa2, 0x96, 0x23, 0x43, 0x6f, 0x46, 0xa1, 0xfc},
  115. }
  116. if err := createdEnvironment.QueryInterface(&iidICoreWebView2Environment, &createdEnvironment); err != nil {
  117. createdEnvironment = nil
  118. errNo, ok := err.(syscall.Errno)
  119. if !ok {
  120. errNo = syscall.Errno(windows.E_FAIL)
  121. }
  122. errorCode = HRESULT(errNo)
  123. }
  124. }
  125. r.originalHandler.EnvironmentCompleted(errorCode, createdEnvironment)
  126. if createdEnvironment != nil {
  127. createdEnvironment.Release()
  128. }
  129. return HRESULT(windows.S_OK)
  130. }
  131. func preventEnvAndRegistryOverrides() {
  132. // Setting these env variables to empty string also prevents registry overrides because webview2
  133. // checks for existence and not for empty value
  134. os.Setenv("WEBVIEW2_PIPE_FOR_SCRIPT_DEBUGGER", "")
  135. os.Setenv("WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS", "")
  136. os.Setenv("WEBVIEW2_RELEASE_CHANNEL_PREFERENCE", "0")
  137. // The following seems not be be required because those are only used by the webview2loader which
  138. // in this case is implemented on our own. But nevertheless set them to empty to be consistent.
  139. os.Setenv("WEBVIEW2_BROWSER_EXECUTABLE_FOLDER", "")
  140. os.Setenv("WEBVIEW2_USER_DATA_FOLDER", "")
  141. }