Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-23 00:01:36 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1743 from cortesi/viewsig

Browse Source 
addons.view: clarify modification events
This commit is contained in:
Aldo Cortesi 2016-11-15 10:42:23 +13:00 committed by GitHub
commit 92607c2109
4 changed files with 56 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
mitmproxy/addons/view.py
View File

@ -45,7 +45,7 @@ class _OrderKey:
self.view._view.remove(f) self.view._view.remove(f)
self.view.settings[f][k] = new self.view.settings[f][k] = new
self.view._view.add(f) self.view._view.add(f)
self.view.sig_refresh.send(self.view) self.view.sig_view_refresh.send(self.view)
def _key(self): def _key(self):
return "_order_%s" % id(self) return "_order_%s" % id(self)
@ -120,14 +120,22 @@ class View(collections.Sequence):
self._view = sortedcontainers.SortedListWithKey(key = self.order_key) self._view = sortedcontainers.SortedListWithKey(key = self.order_key)
# These signals broadcast events that affect the view. That is, an # The sig_view* signals broadcast events that affect the view. That is,
# update to a flow in the store but not in the view does not trigger a # an update to a flow in the store but not in the view does not trigger
# signal. All signals are called after the view has been updated. # a signal. All signals are called after the view has been updated.
self.sig_update = blinker.Signal() self.sig_view_update = blinker.Signal()
self.sig_add = blinker.Signal() self.sig_view_add = blinker.Signal()
self.sig_remove = blinker.Signal() self.sig_view_remove = blinker.Signal()
# Signals that the view should be refreshed completely # Signals that the view should be refreshed completely
self.sig_refresh = blinker.Signal() self.sig_view_refresh = blinker.Signal()
# The sig_store* signals broadcast events that affect the underlying
# store. If a flow is removed from just the view, sig_view_remove is
# triggered. If it is removed from the store while it is also in the
# view, both sig_store_remove and sig_view_remove are triggered.
self.sig_store_remove = blinker.Signal()
# Signals that the store should be refreshed completely
self.sig_store_refresh = blinker.Signal()
self.focus = Focus(self) self.focus = Focus(self)
self.settings = Settings(self) self.settings = Settings(self)
@ -186,7 +194,7 @@ class View(collections.Sequence):
continue continue
if self.filter(i): if self.filter(i):
self._base_add(i) self._base_add(i)
self.sig_refresh.send(self) self.sig_view_refresh.send(self)
# API # API
def toggle_marked(self): def toggle_marked(self):
@ -195,7 +203,7 @@ class View(collections.Sequence):
def set_reversed(self, value: bool): def set_reversed(self, value: bool):
self.order_reversed = value self.order_reversed = value
self.sig_refresh.send(self) self.sig_view_refresh.send(self)
def set_order(self, order_key: typing.Callable): def set_order(self, order_key: typing.Callable):
""" """
@ -215,12 +223,12 @@ class View(collections.Sequence):
def clear(self): def clear(self):
""" """
Clears both the state and view. Clears both the store and view.
""" """
self._store.clear() self._store.clear()
self._view.clear() self._view.clear()
self.settings.clear() self.sig_view_refresh.send(self)
self.sig_refresh.send(self) self.sig_store_refresh.send(self)
def add(self, f: mitmproxy.flow.Flow) -> bool: def add(self, f: mitmproxy.flow.Flow) -> bool:
""" """
@ -233,7 +241,7 @@ class View(collections.Sequence):
self._base_add(f) self._base_add(f)
if self.focus_follow: if self.focus_follow:
self.focus.flow = f self.focus.flow = f
self.sig_add.send(self, flow=f) self.sig_view_add.send(self, flow=f)
def remove(self, f: mitmproxy.flow.Flow): def remove(self, f: mitmproxy.flow.Flow):
""" """
@ -242,8 +250,9 @@ class View(collections.Sequence):
if f.id in self._store: if f.id in self._store:
if f in self._view: if f in self._view:
self._view.remove(f) self._view.remove(f)
self.sig_remove.send(self, flow=f) self.sig_view_remove.send(self, flow=f)
del self._store[f.id] del self._store[f.id]
self.sig_store_remove.send(self, flow=f)
def update(self, f: mitmproxy.flow.Flow): def update(self, f: mitmproxy.flow.Flow):
""" """
@ -255,18 +264,18 @@ class View(collections.Sequence):
self._base_add(f) self._base_add(f)
if self.focus_follow: if self.focus_follow:
self.focus.flow = f self.focus.flow = f
self.sig_add.send(self, flow=f) self.sig_view_add.send(self, flow=f)
else: else:
# This is a tad complicated. The sortedcontainers # This is a tad complicated. The sortedcontainers
# implementation assumes that the order key is stable. If # implementation assumes that the order key is stable. If
# it changes mid-way Very Bad Things happen. We detect when # it changes mid-way Very Bad Things happen. We detect when
# this happens, and re-fresh the item. # this happens, and re-fresh the item.
self.order_key.refresh(f) self.order_key.refresh(f)
self.sig_update.send(self, flow=f) self.sig_view_update.send(self, flow=f)
else: else:
try: try:
self._view.remove(f) self._view.remove(f)
self.sig_remove.send(self, flow=f) self.sig_view_remove.send(self, flow=f)
except ValueError: except ValueError:
# The value was not in the view # The value was not in the view
pass pass
@ -322,9 +331,9 @@ class Focus:
self.sig_change = blinker.Signal() self.sig_change = blinker.Signal()
if len(self.view): if len(self.view):
self.flow = self.view[0] self.flow = self.view[0]
v.sig_add.connect(self._sig_add) v.sig_view_add.connect(self._sig_view_add)
v.sig_remove.connect(self._sig_remove) v.sig_view_remove.connect(self._sig_view_remove)
v.sig_refresh.connect(self._sig_refresh) v.sig_view_refresh.connect(self._sig_view_refresh)
@property @property
def flow(self) -> typing.Optional[mitmproxy.flow.Flow]: def flow(self) -> typing.Optional[mitmproxy.flow.Flow]:
@ -351,13 +360,13 @@ class Focus:
def _nearest(self, f, v): def _nearest(self, f, v):
return min(v._bisect(f), len(v) - 1) return min(v._bisect(f), len(v) - 1)
def _sig_remove(self, view, flow): def _sig_view_remove(self, view, flow):
if len(view) == 0: if len(view) == 0:
self.flow = None self.flow = None
elif flow is self.flow: elif flow is self.flow:
self.flow = view[self._nearest(self.flow, view)] self.flow = view[self._nearest(self.flow, view)]
def _sig_refresh(self, view): def _sig_view_refresh(self, view):
if len(view) == 0: if len(view) == 0:
self.flow = None self.flow = None
elif self.flow is None: elif self.flow is None:
@ -365,7 +374,7 @@ class Focus:
elif self.flow not in view: elif self.flow not in view:
self.flow = view[self._nearest(self.flow, view)] self.flow = view[self._nearest(self.flow, view)]
def _sig_add(self, view, flow): def _sig_view_add(self, view, flow):
# We only have to act if we don't have a focus element # We only have to act if we don't have a focus element
if not self.flow: if not self.flow:
self.flow = flow self.flow = flow
@ -375,11 +384,8 @@ class Settings(collections.Mapping):
def __init__(self, view: View) -> None: def __init__(self, view: View) -> None:
self.view = view self.view = view
self._values = {} # type: typing.MutableMapping[str, mitmproxy.flow.Flow] self._values = {} # type: typing.MutableMapping[str, mitmproxy.flow.Flow]
view.sig_remove.connect(self._sig_remove) view.sig_store_remove.connect(self._sig_store_remove)
view.sig_refresh.connect(self._sig_refresh) view.sig_store_refresh.connect(self._sig_store_refresh)
def clear(self):
self._values.clear()
def __iter__(self) -> typing.Iterator: def __iter__(self) -> typing.Iterator:
return iter(self._values) return iter(self._values)
@ -392,11 +398,11 @@ class Settings(collections.Mapping):
raise KeyError raise KeyError
return self._values.setdefault(f.id, {}) return self._values.setdefault(f.id, {})
def _sig_remove(self, view, flow): def _sig_store_remove(self, view, flow):
if flow.id in self._values: if flow.id in self._values:
del self._values[flow.id] del self._values[flow.id]
def _sig_refresh(self, view): def _sig_store_refresh(self, view):
for fid in list(self._values.keys()): for fid in list(self._values.keys()):
if fid not in view._store: if fid not in view._store:
del self._values[fid] del self._values[fid]

8
mitmproxy/tools/console/flowlist.py
View File

@ -263,10 +263,10 @@ class FlowListWalker(urwid.ListWalker):
def __init__(self, master): def __init__(self, master):
self.master = master self.master = master
self.master.view.sig_refresh.connect(self.sig_mod) self.master.view.sig_view_refresh.connect(self.sig_mod)
self.master.view.sig_add.connect(self.sig_mod) self.master.view.sig_view_add.connect(self.sig_mod)
self.master.view.sig_remove.connect(self.sig_mod) self.master.view.sig_view_remove.connect(self.sig_mod)
self.master.view.sig_update.connect(self.sig_mod) self.master.view.sig_view_update.connect(self.sig_mod)
self.master.view.focus.sig_change.connect(self.sig_mod) self.master.view.focus.sig_change.connect(self.sig_mod)
signals.flowlist_change.connect(self.sig_mod) signals.flowlist_change.connect(self.sig_mod)

8
mitmproxy/tools/web/master.py
View File

@ -90,10 +90,10 @@ class WebMaster(master.Master):
def __init__(self, options, server): def __init__(self, options, server):
super().__init__(options, server) super().__init__(options, server)
self.view = view.View() self.view = view.View()
self.view.sig_add.connect(self._sig_add) self.view.sig_view_add.connect(self._sig_add)
self.view.sig_remove.connect(self._sig_remove) self.view.sig_view_remove.connect(self._sig_remove)
self.view.sig_update.connect(self._sig_update) self.view.sig_view_update.connect(self._sig_update)
self.view.sig_refresh.connect(self._sig_refresh) self.view.sig_view_refresh.connect(self._sig_refresh)
self.addons.add(*addons.default_addons()) self.addons.add(*addons.default_addons())
self.addons.add(self.view, intercept.Intercept()) self.addons.add(self.view, intercept.Intercept())

16
test/mitmproxy/addons/test_view.py
View File

@ -38,7 +38,7 @@ def test_order_refresh():
def save(*args, **kwargs): def save(*args, **kwargs):
sargs.extend([args, kwargs]) sargs.extend([args, kwargs])
v.sig_refresh.connect(save) v.sig_view_refresh.connect(save)
tf = tflow.tflow(resp=True) tf = tflow.tflow(resp=True)
with taddons.context(options=Options()) as tctx: with taddons.context(options=Options()) as tctx:
@ -217,10 +217,10 @@ def test_signals():
rec_remove.calls = [] rec_remove.calls = []
rec_refresh.calls = [] rec_refresh.calls = []
v.sig_add.connect(rec_add) v.sig_view_add.connect(rec_add)
v.sig_update.connect(rec_update) v.sig_view_update.connect(rec_update)
v.sig_remove.connect(rec_remove) v.sig_view_remove.connect(rec_remove)
v.sig_refresh.connect(rec_refresh) v.sig_view_refresh.connect(rec_refresh)
assert not any([rec_add, rec_update, rec_remove, rec_refresh]) assert not any([rec_add, rec_update, rec_remove, rec_refresh])
@ -363,6 +363,12 @@ def test_settings():
tutils.raises(KeyError, v.settings.__getitem__, f) tutils.raises(KeyError, v.settings.__getitem__, f)
assert not v.settings.keys() assert not v.settings.keys()
v.add(f)
v.settings[f]["foo"] = "bar"
assert v.settings.keys()
v.clear()
assert not v.settings.keys()
def test_configure(): def test_configure():
v = view.View() v = view.View()