improve dumper addon text alignment (#1415)

mitmproxy/builtins/dumper.py

@@ -5,6 +5,8 @@ import traceback
 
 import click
 
+import typing  # noqa
+
 from mitmproxy import contentviews
 from mitmproxy import ctx
 from mitmproxy import exceptions
@@ -19,12 +21,25 @@ def indent(n, text):
     return "\n".join(pad + i for i in l)
 
 
-class Dumper():
+class Dumper(object):
     def __init__(self):
+        self.filter = None  # type: filt.TFilter
+        self.flow_detail = None  # type: int
+        self.outfp = None  # type: typing.io.TextIO
+        self.showhost = None  # type: bool
+
+    def configure(self, options, updated):
+        if options.filtstr:
+            self.filter = filt.parse(options.filtstr)
+            if not self.filter:
+                raise exceptions.OptionsError(
+                    "Invalid filter expression: %s" % options.filtstr
+                )
+        else:
             self.filter = None
-        self.flow_detail = None
-        self.outfp = None
-        self.showhost = None
+        self.flow_detail = options.flow_detail
+        self.outfp = options.tfile
+        self.showhost = options.showhost
 
     def echo(self, text, ident=None, **style):
         if ident:
@@ -59,7 +74,7 @@ class Dumper():
                 self.echo("")
 
                 try:
-                    type, lines = contentviews.get_content_view(
+                    _, lines = contentviews.get_content_view(
                         contentviews.get("Auto"),
                         content,
                         headers=getattr(message, "headers", None)
@@ -67,7 +82,7 @@ class Dumper():
                 except exceptions.ContentViewException:
                     s = "Content viewer failed: \n" + traceback.format_exc()
                     ctx.log.debug(s)
-                    type, lines = contentviews.get_content_view(
+                    _, lines = contentviews.get_content_view(
                         contentviews.get("Raw"),
                         content,
                         headers=getattr(message, "headers", None)
@@ -114,9 +129,8 @@ class Dumper():
         if flow.client_conn:
             client = click.style(
                 strutils.escape_control_characters(
-                    flow.client_conn.address.host
-                ),
-                bold=True
+                    repr(flow.client_conn.address)
+                )
             )
         elif flow.request.is_replay:
             client = click.style("[replay]", fg="yellow", bold=True)
@@ -139,17 +153,23 @@ class Dumper():
             url = flow.request.url
         url = click.style(strutils.escape_control_characters(url), bold=True)
 
-        httpversion = ""
+        http_version = ""
         if flow.request.http_version not in ("HTTP/1.1", "HTTP/1.0"):
             # We hide "normal" HTTP 1.
-            httpversion = " " + flow.request.http_version
+            http_version = " " + flow.request.http_version
 
-        line = "{stickycookie}{client} {method} {url}{httpversion}".format(
-            stickycookie=stickycookie,
+        if self.flow_detail >= 2:
+            linebreak = "\n    "
+        else:
+            linebreak = ""
+
+        line = "{client}: {linebreak}{stickycookie}{method} {url}{http_version}".format(
             client=client,
+            stickycookie=stickycookie,
+            linebreak=linebreak,
             method=method,
             url=url,
-            httpversion=httpversion
+            http_version=http_version
         )
         self.echo(line)
 
@@ -186,6 +206,11 @@ class Dumper():
         size = click.style(size, bold=True)
 
         arrows = click.style(" <<", bold=True)
+        if self.flow_detail == 1:
+            # This aligns the HTTP response code with the HTTP request method:
+            # 127.0.0.1:59519: GET http://example.com/
+            #               << 304 Not Modified 0b
+            arrows = " " * (len(repr(flow.client_conn.address)) - 2) + arrows
 
         line = "{replay}{arrows} {code} {reason} {size}".format(
             replay=replay,
@@ -211,25 +236,12 @@ class Dumper():
     def match(self, f):
         if self.flow_detail == 0:
             return False
-        if not self.filt:
+        if not self.filter:
             return True
-        elif f.match(self.filt):
+        elif f.match(self.filter):
             return True
         return False
 
-    def configure(self, options, updated):
-        if options.filtstr:
-            self.filt = filt.parse(options.filtstr)
-            if not self.filt:
-                raise exceptions.OptionsError(
-                    "Invalid filter expression: %s" % options.filtstr
-                )
-        else:
-            self.filt = None
-        self.flow_detail = options.flow_detail
-        self.outfp = options.tfile
-        self.showhost = options.showhost
-
     def response(self, f):
         if self.match(f):
             self.echo_flow(f)
@@ -239,8 +251,7 @@ class Dumper():
             self.echo_flow(f)
 
     def tcp_message(self, f):
-        # FIXME: Filter should be applied here
-        if self.options.flow_detail == 0:
+        if not self.match(f):
             return
         message = f.messages[-1]
         direction = "->" if message.from_client else "<-"

mitmproxy/ctx.py

@@ -1,4 +1,4 @@
 from typing import Callable  # noqa
 
 master = None  # type: "mitmproxy.flow.FlowMaster"
-log = None  # type: Callable[[str], None]
+log = None  # type: "mitmproxy.controller.Log"

mitmproxy/filt.py

@@ -39,9 +39,12 @@ import functools
 
 from mitmproxy.models.http import HTTPFlow
 from mitmproxy.models.tcp import TCPFlow
+from mitmproxy.models.flow import Flow
+
 from netlib import strutils
 
 import pyparsing as pp
+from typing import Callable
 
 
 def only(*types):
@@ -471,7 +474,11 @@ def _make():
 bnf = _make()
 
 
+TFilter = Callable[[Flow], bool]
+
+
 def parse(s):
+    # type: (str) -> TFilter
     try:
         filt = bnf.parseString(s, parseAll=True)[0]
         filt.pattern = s

netlib/strutils.py

@@ -51,8 +51,7 @@ else:
 
 def escape_control_characters(text, keep_spacing=True):
     """
-    Replace all unicode C1 control characters from the given text with their respective control pictures.
-    For example, a null byte is replaced with the unicode character "\u2400".
+    Replace all unicode C1 control characters from the given text with a single "."
 
     Args:
         keep_spacing: If True, tabs and newlines will not be replaced.