1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
|
import json
import logging
import os
import shutil
import webbrowser
import winreg
from threading import Semaphore
import clr
from webview import Window, _state
from webview import settings as webview_settings
from webview.dom import _dnd_state
from webview.models import Request, Response
from webview.util import (
DEFAULT_HTML,
create_cookie,
get_app_root,
inject_pywebview,
interop_dll_path,
js_bridge_call,
)
clr.AddReference('System.Windows.Forms')
clr.AddReference('System.Collections')
clr.AddReference('System.Threading')
import System.Windows.Forms as WinForms
from System import Action, Convert, Func, Object, String, Type, Uri
from System.Collections.Generic import List
from System.Diagnostics import Process
from System.Drawing import Color
from System.Globalization import CultureInfo
from System.Threading.Tasks import Task, TaskScheduler
clr.AddReference(interop_dll_path('Microsoft.Web.WebView2.Core.dll'))
clr.AddReference(interop_dll_path('Microsoft.Web.WebView2.WinForms.dll'))
from Microsoft.Web.WebView2.Core import (
CoreWebView2Cookie,
CoreWebView2ServerCertificateErrorAction,
CoreWebView2WebResourceContext,
)
from Microsoft.Web.WebView2.WinForms import CoreWebView2CreationProperties, WebView2
for platform in ('win-arm64', 'win-x64', 'win-x86'):
os.environ['Path'] += ';' + interop_dll_path(platform)
logger = logging.getLogger('pywebview')
renderer = 'edgechromium'
class EdgeChrome:
def __init__(self, form: WinForms.Form, window: Window, cache_dir: str):
self.pywebview_window = window
self.webview = WebView2()
props = CoreWebView2CreationProperties()
runtime_path = webview_settings['WEBVIEW2_RUNTIME_PATH']
if runtime_path:
# Support relative paths
if not os.path.isabs(runtime_path):
runtime_path = os.path.join(get_app_root(), runtime_path)
# Validate path exists
if os.path.exists(runtime_path):
props.BrowserExecutableFolder = runtime_path
logger.debug(f'Using custom WebView2 runtime: {runtime_path}')
else:
logger.warning(f'Custom WebView2 runtime path does not exist: {runtime_path}. Using system WebView2.')
props.UserDataFolder = cache_dir
self.user_data_folder = props.UserDataFolder
props.set_IsInPrivateModeEnabled(_state['private_mode'])
props.AdditionalBrowserArguments = '--disable-features=ElasticOverscroll'
if webview_settings['ALLOW_FILE_URLS']:
props.AdditionalBrowserArguments += ' --allow-file-access-from-files'
if webview_settings['REMOTE_DEBUGGING_PORT'] is not None:
props.AdditionalBrowserArguments += (
f' --remote-debugging-port={webview_settings["REMOTE_DEBUGGING_PORT"]}'
)
self.webview.CreationProperties = props
self.form = form
form.Controls.Add(self.webview)
self.js_results = {}
self.js_result_semaphore = Semaphore(0)
self.webview.Dock = WinForms.DockStyle.Fill
self.webview.BringToFront()
self.webview.CoreWebView2InitializationCompleted += self.on_webview_ready
self.webview.NavigationStarting += self.on_navigation_start
self.webview.NavigationCompleted += self.on_navigation_completed
self.webview.WebMessageReceived += self.on_script_notify
self.syncContextTaskScheduler = TaskScheduler.FromCurrentSynchronizationContext()
self.webview.DefaultBackgroundColor = Color.FromArgb(
255,
int(window.background_color.lstrip('#')[0:2], 16),
int(window.background_color.lstrip('#')[2:4], 16),
int(window.background_color.lstrip('#')[4:6], 16),
)
if window.transparent:
self.webview.DefaultBackgroundColor = Color.Transparent
self.url = None
self.ishtml = False
self.html = DEFAULT_HTML
self.webview.EnsureCoreWebView2Async(None)
def clear_user_data(self):
if not _state['private_mode']:
return
process_id = Convert.ToInt32(self.webview.CoreWebView2.BrowserProcessId)
process = Process.GetProcessById(process_id)
self.webview.Dispose()
process.WaitForExit(3000)
try:
shutil.rmtree(self.user_data_folder)
except Exception as e:
logger.warning(f'Failed to delete user data folder: {e}')
def evaluate_js(self, script: str, parse_json: bool):
def _callback(res):
nonlocal result
if parse_json and res is not None:
try:
result = json.loads(res)
except Exception:
result = res
else:
result = res
semaphore.release()
result = None
semaphore = Semaphore(0)
try:
self.webview.Invoke(
Func[Object](
lambda: self.webview.ExecuteScriptAsync(script).ContinueWith(
Action[Task[String]](lambda task: _callback(json.loads(task.Result))),
self.syncContextTaskScheduler,
)
)
)
semaphore.acquire()
except Exception:
logger.exception('Error occurred in script')
semaphore.release()
return result
def clear_cookies(self):
self.webview.CoreWebView2.CookieManager.DeleteAllCookies()
def get_cookies(self, cookies, semaphore):
def _callback(task):
for c in task.Result:
_cookies.append(c)
self.webview.Invoke(Func[Type](_parse_cookies))
def _parse_cookies():
# cookies must be accessed in the main thread, otherwise an exception is thrown
# https://github.com/MicrosoftEdge/WebView2Feedback/issues/1976
for c in _cookies:
same_site = None if c.SameSite == 0 else str(c.SameSite).lower()
try:
data = {
'name': c.Name,
'value': c.Value,
'path': c.Path,
'domain': c.Domain,
'expires': c.Expires.ToString('r', CultureInfo.GetCultureInfo('en-US')),
'secure': c.IsSecure,
'httponly': c.IsHttpOnly,
'samesite': same_site,
}
cookie = create_cookie(data)
cookies.append(cookie)
except Exception as e:
logger.exception(e)
semaphore.release()
_cookies = []
self.webview.CoreWebView2.CookieManager.GetCookiesAsync(self.url).ContinueWith(
Action[Task[List[CoreWebView2Cookie]]](_callback), self.syncContextTaskScheduler
)
def get_current_url(self):
return self.url
def load_html(self, content, _):
self.html = content
self.ishtml = True
if self.webview.CoreWebView2:
self.webview.CoreWebView2.NavigateToString(self.html)
else:
self.webview.EnsureCoreWebView2Async(None)
def load_url(self, url: str):
self.ishtml = False
self.webview.Source = Uri(url)
def on_certificate_error(self, _, args):
args.set_Action(CoreWebView2ServerCertificateErrorAction.AlwaysAllow)
def on_script_notify(self, _, args):
try:
return_value = args.get_WebMessageAsJson()
if return_value == '"FilesDropped"':
if _dnd_state['num_listeners'] == 0:
return
additionalObjects = args.get_AdditionalObjects()
if additionalObjects is None:
return
files = [
(os.path.basename(file.Path), file.Path)
for file in list(additionalObjects)
if 'CoreWebView2File' in str(type(file))
]
_dnd_state['paths'] += files
return
func_name, func_param, value_id = json.loads(return_value)
func_param = json.loads(func_param)
if func_name == '_pywebviewAlert':
WinForms.MessageBox.Show(str(func_param))
elif func_name == 'console':
print(func_param)
else:
js_bridge_call(self.pywebview_window, func_name, func_param, value_id)
except Exception:
logger.exception('Exception occurred during on_script_notify')
def on_new_window_request(self, sender, args):
args.set_Handled(True)
if webview_settings['OPEN_EXTERNAL_LINKS_IN_BROWSER']:
webbrowser.open(str(args.get_Uri()))
else:
self.load_url(str(args.get_Uri()))
def on_source_changed(self, sender, args):
self.url = sender.Source
self.ishtml = False
def on_webview_ready(self, sender, args):
if not args.IsSuccess:
logger.error(
'WebView2 initialization failed with exception:\n '
+ str(args.InitializationException)
)
return
self.webview.CoreWebView2.SourceChanged += self.on_source_changed
sender.CoreWebView2.NewWindowRequested += self.on_new_window_request
sender.CoreWebView2.AddWebResourceRequestedFilter('*', CoreWebView2WebResourceContext.All)
sender.CoreWebView2.WebResourceResponseReceived += self.on_web_resource_response
sender.CoreWebView2.WebResourceRequested += self.on_web_resource_request
if _state['ssl'] or webview_settings['IGNORE_SSL_ERRORS']:
sender.CoreWebView2.ServerCertificateErrorDetected += self.on_certificate_error
sender.CoreWebView2.DownloadStarting += self.on_download_starting
settings = sender.CoreWebView2.Settings
settings.AreBrowserAcceleratorKeysEnabled = _state['debug']
settings.AreDefaultContextMenusEnabled = _state['debug']
settings.AreDefaultScriptDialogsEnabled = True
settings.AreDevToolsEnabled = _state['debug']
settings.IsBuiltInErrorPageEnabled = True
settings.IsScriptEnabled = True
settings.IsWebMessageEnabled = True
settings.IsStatusBarEnabled = _state['debug']
settings.IsSwipeNavigationEnabled = False
settings.IsZoomControlEnabled = True
if _state['user_agent']:
settings.UserAgent = _state['user_agent']
if _state['private_mode']:
# cookies persist even if UserDataFolder is in memory. We have to delete cookies manually.
sender.CoreWebView2.CookieManager.DeleteAllCookies()
if self.pywebview_window.real_url:
self.load_url(self.pywebview_window.real_url)
elif self.pywebview_window.html:
self.html = self.pywebview_window.html
self.load_html(self.pywebview_window.html, '')
else:
self.load_html(DEFAULT_HTML, '')
if _state['debug'] and webview_settings['OPEN_DEVTOOLS_IN_DEBUG']:
sender.CoreWebView2.OpenDevToolsWindow()
def on_download_starting(self, sender, args):
if not webview_settings['ALLOW_DOWNLOADS']:
args.Cancel = True
return
dialog = WinForms.SaveFileDialog()
try:
with winreg.OpenKey(
winreg.HKEY_CURRENT_USER,
r'Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders',
) as windows_key:
dialog.InitialDirectory = winreg.QueryValueEx(
windows_key, '{374DE290-123F-4565-9164-39C4925E467B}'
)[0]
except Exception as e:
logger.exception(e)
dialog.Filter = (
self.pywebview_window.localization['windows.fileFilter.allFiles'] + ' (*.*)|*.*'
)
dialog.RestoreDirectory = True
dialog.FileName = os.path.basename(args.ResultFilePath)
result = dialog.ShowDialog(self.form)
if result == WinForms.DialogResult.OK:
args.ResultFilePath = dialog.FileName
else:
args.Cancel = True
def on_navigation_start(self, sender, args):
if self.pywebview_window.transparent:
self.form.Show()
self.form.Activate()
def on_web_resource_response(self, sender, args):
headers = {}
for header in args.Response.Headers.GetEnumerator():
headers[header.Key] = header.Value
response = Response(str(args.Request.Uri), args.Response.StatusCode, headers)
self.pywebview_window.events.response_received.set(response)
def on_web_resource_request(self, sender, args):
original_headers = {}
for header in args.Request.Headers.GetEnumerator():
original_headers[header.Key] = header.Value
request = Request(str(args.Request.Uri), args.Request.Method, original_headers)
self.pywebview_window.events.request_sent.set(request)
if request.headers == original_headers:
return
extra_headers = {
k: v
for k, v in request.headers.items()
if k not in original_headers or original_headers[k] != v
}
missing_headers = {
k: str(v) for k, v in original_headers.items() if k not in request.headers
}
for k, v in extra_headers.items():
args.Request.Headers.SetHeader(k, v)
for k in missing_headers:
args.Request.Headers.RemoveHeader(k)
def on_navigation_completed(self, sender, _):
url = str(sender.Source)
self.url = None if self.ishtml else url
inject_pywebview(renderer, self.pywebview_window)
|