-
-
Notifications
You must be signed in to change notification settings - Fork 63
/
browser.py
165 lines (137 loc) · 5.18 KB
/
browser.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
import logging
import os
import platform
import subprocess
import tempfile
from collections.abc import Iterable
from enum import Enum
from functools import partial
from threading import Thread
from typing import List, Tuple, Union
from uuid import uuid4
log = logging.getLogger('harvester')
# TODO: simplify since we are only supporting chrome now
browsers = {
'chrome': 'Google Chrome',
}
restart_commands = {
'Darwin': 'killall "{app}"',
'Windows': 'TASKKILL /IM {browser}.exe /F'
}
class BrowserEnum(Enum):
CHROME = 'chrome'
def read_osx_defults(plist: str, binary: str) -> str:
"""
Looks for the preferences files that indicate from which location
the specified browser was launched last.
"""
import plistlib # pylint: disable=import-error
plist_file = f'{os.environ["HOME"]}/Library/Preferences/{plist}.plist'
if os.path.exists(plist_file):
with open(plist_file, 'rb') as f:
binary_path = plistlib.load(f).get('LastRunAppBundlePath')
if binary_path is not None:
return os.path.join(binary_path, 'Contents', 'MacOS', binary)
def read_windows_registry(browser: str) -> str:
"""
Reads the Windows registry to find the paths to the specified browser.
"""
import winreg as reg # pylint: disable=import-error
reg_path = f'SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\{browser}.exe'
exe_path = None
for install_type in reg.HKEY_CURRENT_USER, reg.HKEY_LOCAL_MACHINE:
try:
reg_key = reg.OpenKey(install_type, reg_path, 0, reg.KEY_READ)
exe_path = reg.QueryValue(reg_key, None)
reg_key.Close()
if not os.path.isfile(exe_path):
continue
except WindowsError: # pylint:disable=undefined-variable
pass
else:
break
return exe_path
registry = {
'Darwin': {
'chrome': partial(read_osx_defults, 'com.google.Chrome', 'Google Chrome'),
},
'Windows': {
'chrome': partial(read_windows_registry, 'chrome'),
}
}
def get_browser_binary_location(browser: str) -> str:
"""
Generalized function to find the default installs of popular browsers
regardless of running OS
"""
try:
return registry.get(platform.system())[browser]()
except KeyError:
return None
def launch(domain: Union[str, List[str]], server_address: Tuple[str, int], browser: Union[BrowserEnum, str] = BrowserEnum.CHROME,
restart: bool = False, width: int = 400, height: int = 580, browser_args: List[str] = [],
extensions: str = None, verbose: bool = False):
domain = domain if isinstance(domain, Iterable) else[domain]
server = f'{server_address[0]}:{server_address[1]}'
if browser is not BrowserEnum:
try:
browser = BrowserEnum(browser)
execute_path = False
except ValueError:
execute_path = True
if not execute_path:
browser = browser.value
system = platform.system()
browser_command = []
if not execute_path:
binary_location = get_browser_binary_location(browser)
if binary_location:
browser_command.append(binary_location)
else:
raise RuntimeError(
'Automatic broswer functinality only avalible on MacOS and Windows for now.\n'
'If you are running one of the above OS\'s then the harvester wasn\'t able to '
'find the browser in it\'s default location.\n'
'Try passing the full path to a browser executeable or the command you\'d use '
'to launch it instead.')
else:
browser_command.append(browser)
temp_dir = tempfile.TemporaryDirectory()
user_data_dir = f'--user-data-dir={os.path.join(temp_dir.name, "Profiles")}'
if restart:
if not execute_path:
try:
os.system(restart_commands[system].format(
browser=browser,
app=browsers[browser]
))
except KeyError:
raise RuntimeError('Can not automatically restart your browser on your system.\n'
'(Psst! Open an issue if you\'d like to see this functionality in the future.'
)
raise RuntimeError(
'Cannot restart browser when passing path as browser parameter.')
else:
browser_command.append(user_data_dir)
if extensions:
browser_command.append(f'--load-extension={extensions}')
host_rules = []
for d in domain:
host_rules.append(
f'MAP {d} {server}')
browser_command.extend(browser_args)
browser_command.extend((
'--no-default-browser-check',
'--no-check-default-browser',
'--no-first-run',
f'--host-rules={",".join(host_rules)}',
f"--window-size={width},{height}",
))
if len(domain) == 1:
browser_command.append(f'--app=http://{domain[0]}')
else:
browser_command.append(f'--app=http://{server}/domains')
thread = Thread(target=subprocess.run, args=(
browser_command,), kwargs={'capture_output': not verbose}, daemon=True)
thread.start()
return thread