-
-
Notifications
You must be signed in to change notification settings - Fork 534
/
util.py
397 lines (298 loc) · 11.8 KB
/
util.py
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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
"""
(C) 2014-2019 Roman Sirokov and contributors
Licensed under BSD license
http://github.com/r0x0r/pywebview/
"""
from __future__ import annotations
import inspect
import json
import logging
import os
import re
import sys
import traceback
from http.cookies import SimpleCookie
from platform import architecture
from threading import Thread
from typing import TYPE_CHECKING, Any
from uuid import uuid4
import webview
from webview.js import api, dom_json, events, npo, polyfill
from webview.dom import _dnd_state
from webview.errors import WebViewException
if TYPE_CHECKING:
from webview.window import Window
_TOKEN = uuid4().hex
DEFAULT_HTML = """
<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.0, user-scalable=0">
</head>
<body></body>
</html>
"""
logger = logging.getLogger('pywebview')
def is_app(url: str | None) -> bool:
"""Returns true if 'url' is a WSGI or ASGI app."""
return callable(url)
def is_local_url(url: str | None) -> bool:
return not ((is_app(url)) or (
(not url) or (url.startswith('http://')) or (url.startswith('https://')) or url.startswith('file://')))
def needs_server(urls: list[str]) -> bool:
return bool([url for url in urls if (is_app(url) or is_local_url(url))])
def get_app_root() -> str:
"""
Gets the file root of the application.
"""
if hasattr(sys, '_MEIPASS'): # Pyinstaller
return sys._MEIPASS
if getattr(sys, 'frozen', False): # cx_freeze
return os.path.dirname(sys.executable)
if 'pytest' in sys.modules:
root_dir = [arg.split('=')[1] for arg in sys.argv if arg.startswith('--rootdir')]
if root_dir:
return root_dir[0]
for arg in reversed(sys.argv):
path = os.path.realpath(arg.split('::')[0])
if os.path.exists(path):
return path if os.path.isdir(path) else os.path.dirname(path)
if hasattr(sys, 'getandroidapilevel'):
return os.getenv('ANDROID_APP_PATH')
return os.path.dirname(os.path.realpath(sys.argv[0]))
def abspath(path: str) -> str:
"""
Make path absolute, using the application root
"""
path = os.fspath(path)
if not os.path.isabs(path):
path = os.path.join(get_app_root(), path)
return os.path.normpath(path)
def base_uri(relative_path: str = '') -> str:
"""Get absolute path to resource, works for dev and for PyInstaller"""
base_path = get_app_root()
if not os.path.exists(base_path):
raise ValueError(f'Path {base_path} does not exist')
return f'file://{os.path.join(base_path, relative_path)}'
def create_cookie(input_: dict[Any, Any] | str) -> SimpleCookie[str]:
if isinstance(input_, dict):
cookie = SimpleCookie[str]()
name = input_['name']
cookie[name] = input_['value']
cookie[name]['path'] = input_['path']
cookie[name]['domain'] = input_['domain']
cookie[name]['expires'] = input_['expires']
cookie[name]['secure'] = input_['secure']
cookie[name]['httponly'] = input_['httponly']
if sys.version_info.major >= 3 and sys.version_info.minor >= 8:
cookie[name]['samesite'] = input_.get('samesite')
return cookie
if isinstance(input_, str):
return SimpleCookie(input_)
raise WebViewException('Unknown input to create_cookie')
def parse_file_type(file_type: str) -> tuple[str, str]:
"""
:param file_type: file type string 'description (*.file_extension1;*.file_extension2)' as required by file filter in create_file_dialog
:return: (description, file extensions) tuple
"""
valid_file_filter = r'^([\w ]+)\((\*(?:\.(?:\w+|\*))*(?:;\*\.\w+)*)\)$'
match = re.search(valid_file_filter, file_type)
if match:
return match.group(1).rstrip(), match.group(2)
raise ValueError(f'{file_type} is not a valid file filter')
def inject_pywebview(window: Window, platform: str, uid: str = '') -> str:
""""
Injects a global window.pywebview object
"""
exposed_objects = set()
def get_args(func: object):
params = list(inspect.getfullargspec(func).args)
return params
def get_functions(obj: object, base_name: str = '', functions: dict[str, object] = None):
if obj in exposed_objects:
return functions
else:
exposed_objects.add(obj)
if functions is None:
functions = {}
for name in dir(obj):
full_name = f"{base_name}.{name}" if base_name else name
if name.startswith('_'):
continue
attr = getattr(obj, name)
if inspect.ismethod(attr):
functions[full_name] = get_args(attr)[1:]
# If the attribute is a class or a non-callable object, make a recursive call
elif inspect.isclass(attr) or (isinstance(attr, object) and not callable(attr) and hasattr(attr, "__module__")):
get_functions(attr, full_name, functions)
return functions
def generate_func():
functions = get_functions(window._js_api)
if len(window._functions) > 0:
expose_functions = {name: get_args(f) for name, f in window._functions.items()}
else:
expose_functions = {}
functions.update(expose_functions)
return [{'func': name, 'params': params} for name, params in functions.items()]
try:
func_list = generate_func()
except Exception as e:
logger.exception(e)
func_list = []
js_code = (
npo.src
+ polyfill.src
+ api.src
% {
'token': _TOKEN,
'platform': platform,
'uid': uid,
'func_list': func_list,
'js_api_endpoint': window.js_api_endpoint,
}
+ dom_json.src
+ events.src
% {
'drag_selector': webview.DRAG_REGION_SELECTOR,
'zoomable': str(window.zoomable).lower(),
'draggable': str(window.draggable).lower(),
'easy_drag': str(platform == 'chromium' and window.easy_drag and window.frameless).lower(),
}
)
return js_code
def js_bridge_call(window: Window, func_name: str, param: Any, value_id: str) -> None:
def _call():
try:
result = func(*func_params)
result = json.dumps(result).replace('\\', '\\\\').replace("'", "\\'")
code = f'window.pywebview._returnValues["{func_name}"]["{value_id}"] = {{value: \'{result}\'}}'
except Exception as e:
logger.error(traceback.format_exc())
error = {'message': str(e), 'name': type(e).__name__, 'stack': traceback.format_exc()}
result = json.dumps(error).replace('\\', '\\\\').replace("'", "\\'")
code = f'window.pywebview._returnValues["{func_name}"]["{value_id}"] = {{isError: true, value: \'{result}\'}}'
window.evaluate_js(code)
def get_nested_attribute(obj: object, attr_str: str):
attributes = attr_str.split('.')
for attr in attributes:
obj = getattr(obj, attr, None)
if obj is None:
return None
return obj
if func_name == 'pywebviewMoveWindow':
window.move(*param)
return
if func_name == 'pywebviewEventHandler':
event = param['event']
node_id = param['nodeId']
element = window.dom._elements.get(node_id)
if not element:
return
if event['type'] == 'drop':
files = event['dataTransfer'].get('files', [])
for file in files:
path = [item for item in _dnd_state['paths'] if item[0] == file['name']]
if len(path) == 0:
continue
file['pywebviewFullPath'] = path[0][1]
_dnd_state['paths'].remove(path[0])
for handler in element._event_handlers.get(event['type'], []):
thread = Thread(target=handler, args=(event,))
thread.start()
return
if func_name == 'pywebviewAsyncCallback':
value = json.loads(param) if param is not None else None
if callable(window._callbacks[value_id]):
window._callbacks[value_id](value)
else:
logger.error(
'Async function executed and callback is not callable. Returned value {0}'.format(
value
)
)
del window._callbacks[value_id]
return
func = window._functions.get(func_name) or get_nested_attribute(window._js_api, func_name)
if func is not None:
try:
func_params = param
thread = Thread(target=_call)
thread.start()
except Exception:
logger.exception('Error occurred while evaluating function %s', func_name)
else:
logger.error('Function %s() does not exist', func_name)
def escape_string(string: str) -> str:
return (
string.replace('\\', '\\\\').replace('"', r"\"").replace('\n', r'\n').replace('\r', r'\r')
)
def escape_quotes(string: str) -> str:
if isinstance(string, str):
return string.replace('"', r"\"").replace("'", r"\'")
else:
return string
def escape_line_breaks(string: str) -> str:
return string.replace('\\n', '\\\\n').replace('\\r', '\\\\r')
def inject_base_uri(content: str, base_uri: str) -> str:
pattern = r'<%s(?:[\s]+[^>]*|)>'
base_tag = f'<base href="{base_uri}">'
match = re.search(pattern % 'base', content)
if match:
return content
match = re.search(pattern % 'head', content)
if match:
tag = match.group()
return content.replace(tag, tag + base_tag)
match = re.search(pattern % 'html', content)
if match:
tag = match.group()
return content.replace(tag, tag + base_tag)
match = re.search(pattern % 'body', content)
if match:
tag = match.group()
return content.replace(tag, base_tag + tag)
return base_tag + content
def interop_dll_path(dll_name: str) -> str:
if dll_name == 'WebBrowserInterop.dll':
dll_name = (
'WebBrowserInterop.x64.dll'
if architecture()[0] == '64bit'
else 'WebBrowserInterop.x86.dll'
)
# Unfrozen path
dll_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'lib', dll_name)
if os.path.exists(dll_path):
return dll_path
dll_path = os.path.join(
os.path.dirname(os.path.realpath(__file__)), 'lib', 'runtimes', dll_name, 'native'
)
if os.path.exists(dll_path):
return dll_path
# Frozen path, dll in the same dir as the executable
dll_path = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), dll_name)
if os.path.exists(dll_path):
return dll_path
try:
# Frozen path packed as onefile
if hasattr(sys, '_MEIPASS'): # Pyinstaller
dll_path = os.path.join(sys._MEIPASS, dll_name)
elif getattr(sys, 'frozen', False): # cx_freeze
dll_path = os.path.join(sys.executable, dll_name)
if os.path.exists(dll_path):
return dll_path
except Exception:
pass
raise FileNotFoundError(f'Cannot find {dll_name}')
def environ_append(key: str, *values: str, sep=' ') -> None:
'''Append values to an environment variable, separated by sep'''
values = list(values)
existing = os.environ.get(key, '')
if existing:
values = [existing] + values
os.environ[key] = sep.join(values)
def css_to_camel(css_case_string: str) -> str:
words = css_case_string.split('-')
camel_case_string = words[0] + ''.join(word.capitalize() for word in words[1:])
return camel_case_string
def android_jar_path() -> str:
return os.path.join(os.path.dirname(os.path.realpath(__file__)), 'lib', 'pywebview-android.jar')