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