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
|
# Copyright (c) 2017 crocoite contributors
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""
Chrome browser interactions.
"""
import logging
from urllib.parse import urlsplit
class Item:
"""
Simple wrapper containing Chrome request and response
"""
def __init__ (self):
self.chromeRequest = None
self.chromeResponse = None
self.encodedDataLength = 0
def __repr__ (self):
return '<Item {}>'.format (self.request['url'])
@property
def request (self):
return self.chromeRequest['request']
@property
def response (self):
return self.chromeResponse['response']
@property
def initiator (self):
return self.chromeRequest['initiator']
@property
def id (self):
return self.chromeRequest['requestId']
def setRequest (self, req):
self.chromeRequest = req
def setResponse (self, resp):
self.chromeResponse = resp
class SiteLoader:
"""
Load site in Chrome and monitor network requests
XXX: track popup windows/new tabs and close them
"""
allowedSchemes = {'http', 'https'}
def __init__ (self, browser, url, logger=logging.getLogger(__name__)):
self.requests = {}
self.browser = browser
self.url = url
self.logger = logger
self.tab = browser.new_tab()
def __enter__ (self):
tab = self.tab
# setup callbacks
tab.Network.requestWillBeSent = self._requestWillBeSent
tab.Network.responseReceived = self._responseReceived
tab.Network.loadingFinished = self._loadingFinished
tab.Network.loadingFailed = self._loadingFailed
#tab.Page.loadEventFired = loadEventFired
# start the tab
tab.start()
# enable events
tab.Network.enable()
tab.Page.enable ()
tab.Network.clearBrowserCache ()
if tab.Network.canClearBrowserCookies ()['result']:
tab.Network.clearBrowserCookies ()
return self
def __len__ (self):
return len (self.requests)
def start (self):
self.tab.Page.navigate(url=self.url)
def wait (self, timeout=1):
self.tab.wait (timeout)
def waitIdle (self, idleTimeout=1, maxTimeout=60):
step = 0
for i in range (0, maxTimeout):
self.wait (1)
if len (self) == 0:
step += 1
if step > idleTimeout:
break
else:
step = 0
def stop (self):
"""
Stop loading site
XXX: stop executing scripts
"""
tab = self.tab
tab.Page.stopLoading ()
tab.Network.disable ()
tab.Page.disable ()
tab.Network.requestWillBeSent = None
tab.Network.responseReceived = None
tab.Network.loadingFinished = None
tab.Network.loadingFailed = None
tab.Page.loadEventFired = None
def __exit__ (self, exc_type, exc_value, traceback):
self.tab.stop ()
self.browser.close_tab(self.tab)
return False
def loadingFinished (self, item):
self.logger.debug ('item finished {}'.format (item))
# internal chrome callbacks
def _requestWillBeSent (self, **kwargs):
reqId = kwargs['requestId']
req = kwargs['request']
url = urlsplit (req['url'])
if url.scheme not in self.allowedSchemes:
return
item = self.requests.get (reqId)
if item:
# redirects never “finish” loading, but yield another requestWillBeSent with this key set
redirectResp = kwargs.get ('redirectResponse')
if redirectResp:
resp = {'requestId': reqId, 'response': redirectResp, 'timestamp': kwargs['timestamp']}
item.setResponse (resp)
self.loadingFinished (item, redirect=True)
self.logger.debug ('redirected request {} has url {}'.format (reqId, req['url']))
else:
self.logger.warn ('request {} already exists, overwriting.'.format (reqId))
item = Item ()
item.setRequest (kwargs)
self.requests[reqId] = item
def _responseReceived (self, **kwargs):
reqId = kwargs['requestId']
item = self.requests.get (reqId)
if item is None:
return
resp = kwargs['response']
url = urlsplit (resp['url'])
if url.scheme in self.allowedSchemes:
self.logger.debug ('response {} {}'.format (reqId, resp['url']))
item.setResponse (kwargs)
else:
self.logger.warn ('response: ignoring scheme {}'.format (url.scheme))
def _loadingFinished (self, **kwargs):
"""
Item was fully loaded. For some items the request body is not available
when responseReceived is fired, thus move everything here.
"""
reqId = kwargs['requestId']
item = self.requests.pop (reqId, None)
if item is None:
# we never recorded this request (blacklisted scheme, for example)
return
req = item.request
resp = item.response
assert req['url'] == resp['url'], 'req and resp urls are not the same {} vs {}'.format (req['url'], resp['url'])
url = urlsplit (resp['url'])
if url.scheme in self.allowedSchemes:
self.logger.debug ('finished {} {}'.format (reqId, req['url']))
item.encodedDataLength = kwargs['encodedDataLength']
self.loadingFinished (item)
def _loadingFailed (self, **kwargs):
reqId = kwargs['requestId']
self.logger.debug ('failed {} {}'.format (reqId, kwargs['errorText'], kwargs.get ('blockedReason')))
item = self.requests.pop (reqId, None)
|
