From 0ad505ed7de8f3f9215d441c93cf75c49a67b88e Mon Sep 17 00:00:00 2001
From: "Jason A. Novak" <janovak@uchicago.edu>
Date: Sun, 21 Apr 2013 12:40:03 -0500
Subject: Begin work on documenting adding a new view

---
 doc-src/_layout.html               |  1 +
 doc-src/mitmproxy.html             |  2 +-
 doc-src/scripting/addingviews.html | 27 +++++++++++++++++++++++++++
 doc-src/scripting/index.py         |  3 ++-
 4 files changed, 31 insertions(+), 2 deletions(-)
 create mode 100644 doc-src/scripting/addingviews.html

(limited to 'doc-src')

diff --git a/doc-src/_layout.html b/doc-src/_layout.html
index 71b15fd2..69a28010 100644
--- a/doc-src/_layout.html
+++ b/doc-src/_layout.html
@@ -58,6 +58,7 @@
             <li class="nav-header">Scripting mitmproxy</li>
                 $!nav("scripting/inlinescripts.html", this, state)!$
                 $!nav("scripting/libmproxy.html", this, state)!$
+                $!nav("scripting/addingviews.html", this, state)!$
         </ul>
       </div>
     </div>
diff --git a/doc-src/mitmproxy.html b/doc-src/mitmproxy.html
index 678d41b5..e83c0f55 100644
--- a/doc-src/mitmproxy.html
+++ b/doc-src/mitmproxy.html
@@ -25,7 +25,7 @@ flow pane.
 - __8__: Various information on mitmproxy's state. In this case, we have an
 interception pattern set to ".*".
 - __9__: Bind address indicator - mitmproxy is listening on port 8080 of all
-interfaces.
+interfaces.<a name="flowview"></a>
 
 
 ## Flow view
diff --git a/doc-src/scripting/addingviews.html b/doc-src/scripting/addingviews.html
new file mode 100644
index 00000000..34c59a91
--- /dev/null
+++ b/doc-src/scripting/addingviews.html
@@ -0,0 +1,27 @@
+As discussed in [the Flow View section of the mitmproxy overview](@!urlTo("mitmproxy.html")!@) allows you to inspect and manipulate flows.  When inspecting a single flow, mitmproxy uses a number of heuristics to show a friendly view of various content types; if mitmproxy cannot show a friendly view, mitmproxy defaults to a __raw__ view.
+
+By default, mitmproxy has support for displaying the following content types in a friendly view:
+
+- __1__: Hex
+- __2__: HTML
+- __3__: Image
+- __4__: JavaScript
+- __5__: JSON
+- __6__: URL-encoded data
+- __7__: XML
+- __8__: AMF (requires PyAMF)
+
+Each content type invokes a different flow viewer to parse the data and display the friendly view.  Users can add support for custom views by:
+
+- __1__: Adding a new View class to contentview.py; and
+- __2__: Adding the hotkey to new view to flowview.py 
+
+## Adding a View class to contentview.py
+
+The viewers used by mitmproxy to present a friendly view of various content types are stored in contentview.py.  Reviewing this file shows a number of classes named ViewSomeDataType, each with the properties: name, prompt, and content-type and a function named "\_\_call\_\_".
+
+Adding code to parse additional data types is as simple as writing a new View class.  It should have the same properties and function as the other View classes.  The name property should be a string describing the contents and view; the prompt property should be a two item tuple where the first item is a string that will be used to display the View's type and the second item is a one character string that will be the hotkey used to select the view; the content-type property should be a list of strings of content\_types that the view can parse.  Note that mitmproxy will use the content\_types to try and heuristically show a friendly view of content and that you can override the built-in views by populating content\_types with values for content\_types that are already parsed -- e.g. "image/png".
+
+After defining the name, prompt, and content\_type properties of the class, you should write the \_\_call\_\_ function, which will parse the request/response data and provide a friendly view of the data.  The \_\_call\_\_ function should take the following arguments: self, hdrs, content, limit; hdrs is a ODict of the headers of the request/response; content is the content of the request/response, and limit is XXXXX.
+
+The \_\_call\_\_ function returns two values: (1) a string describing the parsed data; and (2) the parsed data for friendly display.  
diff --git a/doc-src/scripting/index.py b/doc-src/scripting/index.py
index 94c71a76..00608d56 100644
--- a/doc-src/scripting/index.py
+++ b/doc-src/scripting/index.py
@@ -2,5 +2,6 @@ from countershape import Page
 
 pages = [
     Page("inlinescripts.html", "Inline Scripts"),
-    Page("libmproxy.html", "libmproxy")
+    Page("libmproxy.html", "libmproxy"),
+    Page("addingviews.html","Adding Views")
 ]
-- 
cgit v1.2.3


From 52a4a8bbdeb2784625694cd7d6c1af9f2a6ab6ca Mon Sep 17 00:00:00 2001
From: "Jason A. Novak" <janovak@uchicago.edu>
Date: Sun, 21 Apr 2013 12:40:35 -0500
Subject: Continue work on documentation of adding views

---
 doc-src/index.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'doc-src')

diff --git a/doc-src/index.py b/doc-src/index.py
index 7b65adb9..6b541731 100644
--- a/doc-src/index.py
+++ b/doc-src/index.py
@@ -5,7 +5,8 @@ import countershape.template
 sys.path.insert(0, "..")
 from libmproxy import filt
 
-MITMPROXY_SRC = "~/git/public/mitmproxy"
+#MITMPROXY_SRC = "~/git/public/mitmproxy"
+MITMPROXY_SRC = "/Users/jason/Development/virtualenvs/mitmproxy-github/mitmproxy"
 
 if ns.options.website:
     this.layout = countershape.Layout("_websitelayout.html")
-- 
cgit v1.2.3


From e951b86c21daae36211d475f9074d6430afeda67 Mon Sep 17 00:00:00 2001
From: "Jason A. Novak" <janovak@uchicago.edu>
Date: Sun, 21 Apr 2013 13:36:05 -0500
Subject: More documentation

---
 doc-src/scripting/addingviews.html | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'doc-src')

diff --git a/doc-src/scripting/addingviews.html b/doc-src/scripting/addingviews.html
index 34c59a91..b5595570 100644
--- a/doc-src/scripting/addingviews.html
+++ b/doc-src/scripting/addingviews.html
@@ -10,6 +10,7 @@ By default, mitmproxy has support for displaying the following content types in
 - __6__: URL-encoded data
 - __7__: XML
 - __8__: AMF (requires PyAMF)
+- __9__: Protobuf (requires protobuf library)
 
 Each content type invokes a different flow viewer to parse the data and display the friendly view.  Users can add support for custom views by:
 
@@ -18,10 +19,11 @@ Each content type invokes a different flow viewer to parse the data and display
 
 ## Adding a View class to contentview.py
 
-The viewers used by mitmproxy to present a friendly view of various content types are stored in contentview.py.  Reviewing this file shows a number of classes named ViewSomeDataType, each with the properties: name, prompt, and content-type and a function named "\_\_call\_\_".
+The viewers used by mitmproxy to present a friendly view of various content types are stored in contentview.py.  Reviewing this file shows a number of classes named ViewSomeDataType, each with the properties: name, prompt, and content\_types and a function named "\_\_call\_\_".
 
 Adding code to parse additional data types is as simple as writing a new View class.  It should have the same properties and function as the other View classes.  The name property should be a string describing the contents and view; the prompt property should be a two item tuple where the first item is a string that will be used to display the View's type and the second item is a one character string that will be the hotkey used to select the view; the content-type property should be a list of strings of content\_types that the view can parse.  Note that mitmproxy will use the content\_types to try and heuristically show a friendly view of content and that you can override the built-in views by populating content\_types with values for content\_types that are already parsed -- e.g. "image/png".
 
-After defining the name, prompt, and content\_type properties of the class, you should write the \_\_call\_\_ function, which will parse the request/response data and provide a friendly view of the data.  The \_\_call\_\_ function should take the following arguments: self, hdrs, content, limit; hdrs is a ODict of the headers of the request/response; content is the content of the request/response, and limit is XXXXX.
+After defining the name, prompt, and content\_type properties of the class, you should write the \_\_call\_\_ function, which will parse the request/response data and provide a friendly view of the data.  The \_\_call\_\_ function should take the following arguments: self, hdrs, content, limit; hdrs is a ODictCaseless object containing the headers of the request/response; content is the content of the request/response, and limit is an integer representing the amount of data to display in the view window.
+
+The \_\_call\_\_ function returns two values: (1) a string describing the parsed data; and (2) the parsed data for friendly display.  The parsed data to be displayed should be a list of strings formatted for display.  You can use the \_view\_text function in contentview.py to format text for display.  Alternatively, you can display content as a series of key-value pairs; to do so, prepare a list of lists, where each list item is a two item list -- a key that describes the data, and then the data itself; after preparing the list of lists, run common.format_keyvals against it to prepare it as text for display.  
 
-The \_\_call\_\_ function returns two values: (1) a string describing the parsed data; and (2) the parsed data for friendly display.  
-- 
cgit v1.2.3


From 1400880d5885d30775400c6432ecbfb54a41ea55 Mon Sep 17 00:00:00 2001
From: "Jason A. Novak" <janovak@uchicago.edu>
Date: Sun, 21 Apr 2013 13:58:08 -0500
Subject: More documentation

---
 doc-src/scripting/addingviews.html | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)

(limited to 'doc-src')

diff --git a/doc-src/scripting/addingviews.html b/doc-src/scripting/addingviews.html
index b5595570..37d8b3c2 100644
--- a/doc-src/scripting/addingviews.html
+++ b/doc-src/scripting/addingviews.html
@@ -12,18 +12,15 @@ By default, mitmproxy has support for displaying the following content types in
 - __8__: AMF (requires PyAMF)
 - __9__: Protobuf (requires protobuf library)
 
-Each content type invokes a different flow viewer to parse the data and display the friendly view.  Users can add support for custom views by:
-
-- __1__: Adding a new View class to contentview.py; and
-- __2__: Adding the hotkey to new view to flowview.py 
+Each content type invokes a different flow viewer to parse the data and display the friendly view.  Users can add support for custom viewers by adding a view class to contentview.py, discussed below.
 
 ## Adding a View class to contentview.py
 
 The viewers used by mitmproxy to present a friendly view of various content types are stored in contentview.py.  Reviewing this file shows a number of classes named ViewSomeDataType, each with the properties: name, prompt, and content\_types and a function named "\_\_call\_\_".
 
-Adding code to parse additional data types is as simple as writing a new View class.  It should have the same properties and function as the other View classes.  The name property should be a string describing the contents and view; the prompt property should be a two item tuple where the first item is a string that will be used to display the View's type and the second item is a one character string that will be the hotkey used to select the view; the content-type property should be a list of strings of content\_types that the view can parse.  Note that mitmproxy will use the content\_types to try and heuristically show a friendly view of content and that you can override the built-in views by populating content\_types with values for content\_types that are already parsed -- e.g. "image/png".
+Adding code to parse additional data types is as simple as writing a new View class.  It should have the same properties and function as the other View classes.  The name property should be a string describing the contents and view; the prompt property should be a two item tuple where the first item is a string that will be used to display the View's type and the second item is a one character string that will be the hotkey used to select the view from the Flow View screen; the content-type property should be a list of strings of content\_types that the view can parse.  Note that mitmproxy will use the content\_types to try and heuristically show a friendly view of content and that you can override the built-in views by populating content\_types with values for content\_types that are already parsed -- e.g. "image/png".
 
 After defining the name, prompt, and content\_type properties of the class, you should write the \_\_call\_\_ function, which will parse the request/response data and provide a friendly view of the data.  The \_\_call\_\_ function should take the following arguments: self, hdrs, content, limit; hdrs is a ODictCaseless object containing the headers of the request/response; content is the content of the request/response, and limit is an integer representing the amount of data to display in the view window.
 
-The \_\_call\_\_ function returns two values: (1) a string describing the parsed data; and (2) the parsed data for friendly display.  The parsed data to be displayed should be a list of strings formatted for display.  You can use the \_view\_text function in contentview.py to format text for display.  Alternatively, you can display content as a series of key-value pairs; to do so, prepare a list of lists, where each list item is a two item list -- a key that describes the data, and then the data itself; after preparing the list of lists, run common.format_keyvals against it to prepare it as text for display.  
+The \_\_call\_\_ function returns two values: (1) a string describing the parsed data; and (2) the parsed data for friendly display.  The parsed data to be displayed should be a list of strings formatted for display.  You can use the __\_view\_text__ function in contentview.py to format text for display.  Alternatively, you can display content as a series of key-value pairs; to do so, prepare a list of lists, where each list item is a two item list -- a key that describes the data, and then the data itself; after preparing the list of lists, use the __common.format\_keyvals__ function on it to prepare it as text for display.  
 
-- 
cgit v1.2.3


From d48d3d4eb3eefa7601027437784440c408573f80 Mon Sep 17 00:00:00 2001
From: "Jason A. Novak" <janovak@uchicago.edu>
Date: Sun, 21 Apr 2013 14:20:51 -0500
Subject: More documentation cleanup and formatting

---
 doc-src/scripting/addingviews.html | 21 +++++++++++++++------
 doc-src/scripting/index.py         |  2 +-
 2 files changed, 16 insertions(+), 7 deletions(-)

(limited to 'doc-src')

diff --git a/doc-src/scripting/addingviews.html b/doc-src/scripting/addingviews.html
index 37d8b3c2..4cbf702c 100644
--- a/doc-src/scripting/addingviews.html
+++ b/doc-src/scripting/addingviews.html
@@ -1,4 +1,4 @@
-As discussed in [the Flow View section of the mitmproxy overview](@!urlTo("mitmproxy.html")!@) allows you to inspect and manipulate flows.  When inspecting a single flow, mitmproxy uses a number of heuristics to show a friendly view of various content types; if mitmproxy cannot show a friendly view, mitmproxy defaults to a __raw__ view.
+As discussed in [the Flow View section of the mitmproxy overview](@!urlTo("mitmproxy.html")!@), mitmproxy allows you to inspect and manipulate flows.  When inspecting a single flow, mitmproxy uses a number of heuristics to show a friendly view of various content types; if mitmproxy cannot show a friendly view, mitmproxy defaults to a __raw__ view.
 
 By default, mitmproxy has support for displaying the following content types in a friendly view:
 
@@ -14,13 +14,22 @@ By default, mitmproxy has support for displaying the following content types in
 
 Each content type invokes a different flow viewer to parse the data and display the friendly view.  Users can add support for custom viewers by adding a view class to contentview.py, discussed below.
 
-## Adding a View class to contentview.py
+## Adding a new View class to contentview.py
 
-The viewers used by mitmproxy to present a friendly view of various content types are stored in contentview.py.  Reviewing this file shows a number of classes named ViewSomeDataType, each with the properties: name, prompt, and content\_types and a function named "\_\_call\_\_".
+The viewers used by mitmproxy to present a friendly view of various content types are stored in contentview.py.  Reviewing this file shows a number of classes named ViewSomeDataType, each with the properties: __name__, __prompt__, and __content\_types__ and a function named __\_\_call\_\___.
 
-Adding code to parse additional data types is as simple as writing a new View class.  It should have the same properties and function as the other View classes.  The name property should be a string describing the contents and view; the prompt property should be a two item tuple where the first item is a string that will be used to display the View's type and the second item is a one character string that will be the hotkey used to select the view from the Flow View screen; the content-type property should be a list of strings of content\_types that the view can parse.  Note that mitmproxy will use the content\_types to try and heuristically show a friendly view of content and that you can override the built-in views by populating content\_types with values for content\_types that are already parsed -- e.g. "image/png".
+Adding code to parse additional data types is as simple as writing a new View class.  Your new View class should have the same properties as the other View classes: __name__, __prompt__, and __content\_types__ and a __\_\_call\_\___ function to parse the content of the request/response. 
 
-After defining the name, prompt, and content\_type properties of the class, you should write the \_\_call\_\_ function, which will parse the request/response data and provide a friendly view of the data.  The \_\_call\_\_ function should take the following arguments: self, hdrs, content, limit; hdrs is a ODictCaseless object containing the headers of the request/response; content is the content of the request/response, and limit is an integer representing the amount of data to display in the view window.
+* The __name__ property should be a string describing the contents and new View; 
+* The __prompt__ property should be a two item tuple:
 
-The \_\_call\_\_ function returns two values: (1) a string describing the parsed data; and (2) the parsed data for friendly display.  The parsed data to be displayed should be a list of strings formatted for display.  You can use the __\_view\_text__ function in contentview.py to format text for display.  Alternatively, you can display content as a series of key-value pairs; to do so, prepare a list of lists, where each list item is a two item list -- a key that describes the data, and then the data itself; after preparing the list of lists, use the __common.format\_keyvals__ function on it to prepare it as text for display.  
+  - __1__: A string that will be used to display the new View's type; and
+  - __2__: A one character string that will be the hotkey used to select the new View from the Flow View screen; 
+
+* The __content\_types__ property should be a list of strings of HTTP Content\-Types that the new View class can parse.  
+  * Note that mitmproxy will use the content\_types to try and heuristically show a friendly view of content and that you can override the built-in views by populating content\_types with values for content\_types that are already parsed -- e.g. "image/png".
+
+After defining the __name__, __prompt__, and __content\_types__ properties of the class, you should write the __\_\_call\_\___ function, which will parse the request/response data and provide a friendly view of the data.  The __\_\_call\_\___ function should take the following arguments: __self__, __hdrs__, __content__, __limit__; __hdrs__ is a ODictCaseless object containing the headers of the request/response; __content__ is the content of the request/response, and __limit__ is an integer representing the amount of data to display in the view window.
+
+The __\_\_call\_\___ function returns two values: (1) a string describing the parsed data; and (2) the parsed data for friendly display.  The parsed data to be displayed should be a list of strings formatted for display.  You can use the __\_view\_text__ function in contentview.py to format text for display.  Alternatively, you can display content as a series of key-value pairs; to do so, prepare a list of lists, where each list item is a two item list -- a key that describes the data, and then the data itself; after preparing the list of lists, use the __common.format\_keyvals__ function on it to prepare it as text for display.  
 
diff --git a/doc-src/scripting/index.py b/doc-src/scripting/index.py
index 00608d56..f485bcbb 100644
--- a/doc-src/scripting/index.py
+++ b/doc-src/scripting/index.py
@@ -3,5 +3,5 @@ from countershape import Page
 pages = [
     Page("inlinescripts.html", "Inline Scripts"),
     Page("libmproxy.html", "libmproxy"),
-    Page("addingviews.html","Adding Views")
+    Page("addingviews.html","Adding new content Views")
 ]
-- 
cgit v1.2.3


From 208204d33a3d279267b5460c5cde8667a2e7a7df Mon Sep 17 00:00:00 2001
From: "Jason A. Novak" <janovak@uchicago.edu>
Date: Sun, 21 Apr 2013 14:28:00 -0500
Subject: Further cleanup of documentation

---
 doc-src/scripting/addingviews.html | 15 ++++++++-------
 doc-src/scripting/index.py         |  2 +-
 2 files changed, 9 insertions(+), 8 deletions(-)

(limited to 'doc-src')

diff --git a/doc-src/scripting/addingviews.html b/doc-src/scripting/addingviews.html
index 4cbf702c..2191cae7 100644
--- a/doc-src/scripting/addingviews.html
+++ b/doc-src/scripting/addingviews.html
@@ -12,24 +12,25 @@ By default, mitmproxy has support for displaying the following content types in
 - __8__: AMF (requires PyAMF)
 - __9__: Protobuf (requires protobuf library)
 
-Each content type invokes a different flow viewer to parse the data and display the friendly view.  Users can add support for custom viewers by adding a view class to contentview.py, discussed below.
+Each content type invokes a different flow viewer to parse the data and display the friendly view.  Users can add custom content viewers by adding a view class to contentview.py, discussed below.
 
 ## Adding a new View class to contentview.py
 
-The viewers used by mitmproxy to present a friendly view of various content types are stored in contentview.py.  Reviewing this file shows a number of classes named ViewSomeDataType, each with the properties: __name__, __prompt__, and __content\_types__ and a function named __\_\_call\_\___.
+The content viewers used by mitmproxy to present a friendly view of various content types are stored in contentview.py.  Reviewing this file shows a number of classes named ViewSomeDataType, each with the properties: __name__, __prompt__, and __content\_types__ and a function named __\_\_call\_\___.
 
-Adding code to parse additional data types is as simple as writing a new View class.  Your new View class should have the same properties as the other View classes: __name__, __prompt__, and __content\_types__ and a __\_\_call\_\___ function to parse the content of the request/response. 
+Adding a new content viewer to parse a data type is as simple as writing a new View class.  Your new content viewer View class should have the same properties as the other View classes: __name__, __prompt__, and __content\_types__ and a __\_\_call\_\___ function to parse the content of the request/response. 
 
-* The __name__ property should be a string describing the contents and new View; 
+* The __name__ property should be a string describing the contents and new content viewer; 
 * The __prompt__ property should be a two item tuple:
 
-  - __1__: A string that will be used to display the new View's type; and
-  - __2__: A one character string that will be the hotkey used to select the new View from the Flow View screen; 
+  - __1__: A string that will be used to display the new content viewer's type; and
+  - __2__: A one character string that will be the hotkey used to select the new content viewer from the Flow View screen; 
 
-* The __content\_types__ property should be a list of strings of HTTP Content\-Types that the new View class can parse.  
+* The __content\_types__ property should be a list of strings of HTTP Content\-Types that the new content viewer can parse.  
   * Note that mitmproxy will use the content\_types to try and heuristically show a friendly view of content and that you can override the built-in views by populating content\_types with values for content\_types that are already parsed -- e.g. "image/png".
 
 After defining the __name__, __prompt__, and __content\_types__ properties of the class, you should write the __\_\_call\_\___ function, which will parse the request/response data and provide a friendly view of the data.  The __\_\_call\_\___ function should take the following arguments: __self__, __hdrs__, __content__, __limit__; __hdrs__ is a ODictCaseless object containing the headers of the request/response; __content__ is the content of the request/response, and __limit__ is an integer representing the amount of data to display in the view window.
 
 The __\_\_call\_\___ function returns two values: (1) a string describing the parsed data; and (2) the parsed data for friendly display.  The parsed data to be displayed should be a list of strings formatted for display.  You can use the __\_view\_text__ function in contentview.py to format text for display.  Alternatively, you can display content as a series of key-value pairs; to do so, prepare a list of lists, where each list item is a two item list -- a key that describes the data, and then the data itself; after preparing the list of lists, use the __common.format\_keyvals__ function on it to prepare it as text for display.  
 
+If the new content viewer fails or throws an exception, mitmproxy will default to a __raw__ view.
diff --git a/doc-src/scripting/index.py b/doc-src/scripting/index.py
index f485bcbb..27dc6f00 100644
--- a/doc-src/scripting/index.py
+++ b/doc-src/scripting/index.py
@@ -3,5 +3,5 @@ from countershape import Page
 pages = [
     Page("inlinescripts.html", "Inline Scripts"),
     Page("libmproxy.html", "libmproxy"),
-    Page("addingviews.html","Adding new content Views")
+    Page("addingviews.html","Adding new content viewers")
 ]
-- 
cgit v1.2.3


From bfb3828f37842c8b99c539910f18fa87fb29a637 Mon Sep 17 00:00:00 2001
From: "Jason A. Novak" <janovak@uchicago.edu>
Date: Sun, 21 Apr 2013 14:30:30 -0500
Subject: Finalizing documentation

---
 doc-src/index.py       | 3 +--
 doc-src/mitmproxy.html | 2 +-
 2 files changed, 2 insertions(+), 3 deletions(-)

(limited to 'doc-src')

diff --git a/doc-src/index.py b/doc-src/index.py
index 6b541731..7b65adb9 100644
--- a/doc-src/index.py
+++ b/doc-src/index.py
@@ -5,8 +5,7 @@ import countershape.template
 sys.path.insert(0, "..")
 from libmproxy import filt
 
-#MITMPROXY_SRC = "~/git/public/mitmproxy"
-MITMPROXY_SRC = "/Users/jason/Development/virtualenvs/mitmproxy-github/mitmproxy"
+MITMPROXY_SRC = "~/git/public/mitmproxy"
 
 if ns.options.website:
     this.layout = countershape.Layout("_websitelayout.html")
diff --git a/doc-src/mitmproxy.html b/doc-src/mitmproxy.html
index e83c0f55..678d41b5 100644
--- a/doc-src/mitmproxy.html
+++ b/doc-src/mitmproxy.html
@@ -25,7 +25,7 @@ flow pane.
 - __8__: Various information on mitmproxy's state. In this case, we have an
 interception pattern set to ".*".
 - __9__: Bind address indicator - mitmproxy is listening on port 8080 of all
-interfaces.<a name="flowview"></a>
+interfaces.
 
 
 ## Flow view
-- 
cgit v1.2.3


From db43f1ffccfb006c6856888b8f31c0745aacebb4 Mon Sep 17 00:00:00 2001
From: Aldo Cortesi <aldo@nullcube.com>
Date: Sun, 16 Jun 2013 13:59:01 +1200
Subject: Version bump, doc extension, URLs to github.com/mitmproxy/*

---
 doc-src/_layout.html               |  5 +++-
 doc-src/dev/addingviews.html       | 52 ++++++++++++++++++++++++++++++++++++++
 doc-src/dev/index.py               |  6 +++++
 doc-src/dev/testing.html           | 43 +++++++++++++++++++++++++++++++
 doc-src/howmitmproxy.html          |  2 +-
 doc-src/index.py                   |  2 +-
 doc-src/install.html               |  2 +-
 doc-src/scripting/addingviews.html | 36 --------------------------
 doc-src/scripting/index.py         |  1 -
 9 files changed, 108 insertions(+), 41 deletions(-)
 create mode 100644 doc-src/dev/addingviews.html
 create mode 100644 doc-src/dev/index.py
 create mode 100644 doc-src/dev/testing.html
 delete mode 100644 doc-src/scripting/addingviews.html

(limited to 'doc-src')

diff --git a/doc-src/_layout.html b/doc-src/_layout.html
index a361f764..72b27cd3 100644
--- a/doc-src/_layout.html
+++ b/doc-src/_layout.html
@@ -58,7 +58,10 @@
             <li class="nav-header">Scripting mitmproxy</li>
                 $!nav("scripting/inlinescripts.html", this, state)!$
                 $!nav("scripting/libmproxy.html", this, state)!$
-                $!nav("scripting/addingviews.html", this, state)!$
+
+            <li class="nav-header">Hacking</li>
+                $!nav("dev/testing.html", this, state)!$
+
         </ul>
       </div>
     </div>
diff --git a/doc-src/dev/addingviews.html b/doc-src/dev/addingviews.html
new file mode 100644
index 00000000..12623a31
--- /dev/null
+++ b/doc-src/dev/addingviews.html
@@ -0,0 +1,52 @@
+As discussed in [the Flow View section of the mitmproxy
+overview](@!urlTo("mitmproxy.html")!@), mitmproxy allows you to inspect and
+manipulate flows.  When inspecting a single flow, mitmproxy uses a number of
+heuristics to show a friendly view of various content types; if mitmproxy
+cannot show a friendly view, mitmproxy defaults to a __raw__ view.
+
+Each content type invokes a different flow viewer to parse the data and display
+the friendly view. Users can add custom content viewers by adding a view class
+to contentview.py, discussed below.
+
+## Adding a new View class to contentview.py
+
+The content viewers used by mitmproxy to present a friendly view of various
+content types are stored in contentview.py.  Reviewing this file shows a number
+of classes named ViewSomeDataType, each with the properties: __name__,
+__prompt__, and __content\_types__ and a function named __\_\_call\_\___.
+
+Adding a new content viewer to parse a data type is as simple as writing a new
+View class.  Your new content viewer View class should have the same properties
+as the other View classes: __name__, __prompt__, and __content\_types__ and a
+__\_\_call\_\___ function to parse the content of the request/response. 
+
+* The __name__ property should be a string describing the contents and new content viewer; 
+* The __prompt__ property should be a two item tuple:
+
+  - __1__: A string that will be used to display the new content viewer's type; and
+  - __2__: A one character string that will be the hotkey used to select the new content viewer from the Flow View screen; 
+
+* The __content\_types__ property should be a list of strings of HTTP Content\-Types that the new content viewer can parse.  
+  * Note that mitmproxy will use the content\_types to try and heuristically show a friendly view of content and that you can override the built-in views by populating content\_types with values for content\_types that are already parsed -- e.g. "image/png".
+
+After defining the __name__, __prompt__, and __content\_types__ properties of
+the class, you should write the __\_\_call\_\___ function, which will parse the
+request/response data and provide a friendly view of the data.  The
+__\_\_call\_\___ function should take the following arguments: __self__,
+__hdrs__, __content__, __limit__; __hdrs__ is a ODictCaseless object containing
+the headers of the request/response; __content__ is the content of the
+request/response, and __limit__ is an integer representing the amount of data
+to display in the view window.
+
+The __\_\_call\_\___ function returns two values: (1) a string describing the
+parsed data; and (2) the parsed data for friendly display.  The parsed data to
+be displayed should be a list of strings formatted for display.  You can use
+the __\_view\_text__ function in contentview.py to format text for display.
+Alternatively, you can display content as a series of key-value pairs; to do
+so, prepare a list of lists, where each list item is a two item list -- a key
+that describes the data, and then the data itself; after preparing the list of
+lists, use the __common.format\_keyvals__ function on it to prepare it as text
+for display.  
+
+If the new content viewer fails or throws an exception, mitmproxy will default
+to a __raw__ view.
diff --git a/doc-src/dev/index.py b/doc-src/dev/index.py
new file mode 100644
index 00000000..001c2b89
--- /dev/null
+++ b/doc-src/dev/index.py
@@ -0,0 +1,6 @@
+from countershape import Page
+
+pages = [
+     Page("testing.html", "Testing"),
+#    Page("addingviews.html", "Writing Content Views"),
+]
diff --git a/doc-src/dev/testing.html b/doc-src/dev/testing.html
new file mode 100644
index 00000000..4cee29e8
--- /dev/null
+++ b/doc-src/dev/testing.html
@@ -0,0 +1,43 @@
+
+All the mitmproxy projects strive to maintain 100% code coverage. In general,
+patches and pull requests will be declined unless they're accompanied by a
+suitable extension to the test suite. 
+
+Our tests are written for the [nose](https://nose.readthedocs.org/en/latest/).
+At the point where you send your pull request, a command like this:
+
+<pre class="terminal">
+> nosetests --with-cov --cov-report term-missing ./test
+</pre>
+
+Should give output something like this:
+
+<pre class="terminal">
+> ---------- coverage: platform darwin, python 2.7.2-final-0 --
+> Name                   Stmts   Miss  Cover   Missing
+> ----------------------------------------------------
+> libmproxy/__init__         0      0   100%
+> libmproxy/app              4      0   100%
+> libmproxy/cmdline        100      0   100%
+> libmproxy/controller      69      0   100%
+> libmproxy/dump           150      0   100%
+> libmproxy/encoding        39      0   100%
+> libmproxy/filt           201      0   100%
+> libmproxy/flow           891      0   100%
+> libmproxy/proxy          427      0   100%
+> libmproxy/script          27      0   100%
+> libmproxy/utils          133      0   100%
+> libmproxy/version          4      0   100%
+> ----------------------------------------------------
+> TOTAL                   2045      0   100%
+> ----------------------------------------------------
+> Ran 251 tests in 11.864s
+</pre>
+
+
+There are exceptions to the coverage requirement - for instance, much of the
+console interface code can't sensibly be unit tested. These portions are
+excluded from coverage analysis either in the **.coveragerc** file, or using
+**#pragma no-cover** directives. To keep our coverage analysis relevant, we use
+these measures as sparingly as possible.
+
diff --git a/doc-src/howmitmproxy.html b/doc-src/howmitmproxy.html
index 09a69ec2..94afd522 100644
--- a/doc-src/howmitmproxy.html
+++ b/doc-src/howmitmproxy.html
@@ -246,7 +246,7 @@ mechanism has a different way of exposing this data, so this introduces the
 second component required for working transparent proxying: a host module that
 knows how to retrieve the original destination address from the router. In
 mitmproxy, this takes the form of a built-in set of
-[modules](https://github.com/cortesi/mitmproxy/tree/master/libmproxy/platform)
+[modules](https://github.com/mitmproxy/mitmproxy/tree/master/libmproxy/platform)
 that know how to talk to each platform's redirection mechanism.  Once we have
 this information, the process is fairly straight-forward.
 
diff --git a/doc-src/index.py b/doc-src/index.py
index 7b84f982..6880bcae 100644
--- a/doc-src/index.py
+++ b/doc-src/index.py
@@ -5,7 +5,7 @@ import countershape.template
 sys.path.insert(0, "..")
 from libmproxy import filt
 
-MITMPROXY_SRC = "~/git/public/mitmproxy"
+MITMPROXY_SRC = "~/mitmproxy/mitmproxy"
 
 if ns.options.website:
     ns.idxpath = "doc/index.html"
diff --git a/doc-src/install.html b/doc-src/install.html
index 30e2774d..70003d60 100644
--- a/doc-src/install.html
+++ b/doc-src/install.html
@@ -25,7 +25,7 @@ pip install /path/to/source
 </pre>
 
 Note that if you're installing current git master, you will also have to
-install the current git master of [netlib](http://github.com/cortesi/netlib) by
+install the current git master of [netlib](http://github.com/mitmproxy/netlib) by
 hand.
 
 ## OSX
diff --git a/doc-src/scripting/addingviews.html b/doc-src/scripting/addingviews.html
deleted file mode 100644
index 2191cae7..00000000
--- a/doc-src/scripting/addingviews.html
+++ /dev/null
@@ -1,36 +0,0 @@
-As discussed in [the Flow View section of the mitmproxy overview](@!urlTo("mitmproxy.html")!@), mitmproxy allows you to inspect and manipulate flows.  When inspecting a single flow, mitmproxy uses a number of heuristics to show a friendly view of various content types; if mitmproxy cannot show a friendly view, mitmproxy defaults to a __raw__ view.
-
-By default, mitmproxy has support for displaying the following content types in a friendly view:
-
-- __1__: Hex
-- __2__: HTML
-- __3__: Image
-- __4__: JavaScript
-- __5__: JSON
-- __6__: URL-encoded data
-- __7__: XML
-- __8__: AMF (requires PyAMF)
-- __9__: Protobuf (requires protobuf library)
-
-Each content type invokes a different flow viewer to parse the data and display the friendly view.  Users can add custom content viewers by adding a view class to contentview.py, discussed below.
-
-## Adding a new View class to contentview.py
-
-The content viewers used by mitmproxy to present a friendly view of various content types are stored in contentview.py.  Reviewing this file shows a number of classes named ViewSomeDataType, each with the properties: __name__, __prompt__, and __content\_types__ and a function named __\_\_call\_\___.
-
-Adding a new content viewer to parse a data type is as simple as writing a new View class.  Your new content viewer View class should have the same properties as the other View classes: __name__, __prompt__, and __content\_types__ and a __\_\_call\_\___ function to parse the content of the request/response. 
-
-* The __name__ property should be a string describing the contents and new content viewer; 
-* The __prompt__ property should be a two item tuple:
-
-  - __1__: A string that will be used to display the new content viewer's type; and
-  - __2__: A one character string that will be the hotkey used to select the new content viewer from the Flow View screen; 
-
-* The __content\_types__ property should be a list of strings of HTTP Content\-Types that the new content viewer can parse.  
-  * Note that mitmproxy will use the content\_types to try and heuristically show a friendly view of content and that you can override the built-in views by populating content\_types with values for content\_types that are already parsed -- e.g. "image/png".
-
-After defining the __name__, __prompt__, and __content\_types__ properties of the class, you should write the __\_\_call\_\___ function, which will parse the request/response data and provide a friendly view of the data.  The __\_\_call\_\___ function should take the following arguments: __self__, __hdrs__, __content__, __limit__; __hdrs__ is a ODictCaseless object containing the headers of the request/response; __content__ is the content of the request/response, and __limit__ is an integer representing the amount of data to display in the view window.
-
-The __\_\_call\_\___ function returns two values: (1) a string describing the parsed data; and (2) the parsed data for friendly display.  The parsed data to be displayed should be a list of strings formatted for display.  You can use the __\_view\_text__ function in contentview.py to format text for display.  Alternatively, you can display content as a series of key-value pairs; to do so, prepare a list of lists, where each list item is a two item list -- a key that describes the data, and then the data itself; after preparing the list of lists, use the __common.format\_keyvals__ function on it to prepare it as text for display.  
-
-If the new content viewer fails or throws an exception, mitmproxy will default to a __raw__ view.
diff --git a/doc-src/scripting/index.py b/doc-src/scripting/index.py
index 27dc6f00..b8312083 100644
--- a/doc-src/scripting/index.py
+++ b/doc-src/scripting/index.py
@@ -3,5 +3,4 @@ from countershape import Page
 pages = [
     Page("inlinescripts.html", "Inline Scripts"),
     Page("libmproxy.html", "libmproxy"),
-    Page("addingviews.html","Adding new content viewers")
 ]
-- 
cgit v1.2.3


From 826a1fdaa264a0dfaafe238fec96170c699ca7ae Mon Sep 17 00:00:00 2001
From: Aldo Cortesi <aldo@nullcube.com>
Date: Sun, 16 Jun 2013 16:59:28 +1200
Subject: Minor adjustment for website docs pages.

---
 doc-src/_websitelayout.html | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'doc-src')

diff --git a/doc-src/_websitelayout.html b/doc-src/_websitelayout.html
index f65ee059..13d71fcb 100644
--- a/doc-src/_websitelayout.html
+++ b/doc-src/_websitelayout.html
@@ -64,6 +64,9 @@
             <li class="nav-header">Scripting mitmproxy</li>
                 $!nav("scripting/inlinescripts.html", this, state)!$
                 $!nav("scripting/libmproxy.html", this, state)!$
+
+            <li class="nav-header">Hacking</li>
+                $!nav("dev/testing.html", this, state)!$
         </ul>
       </div>
     </div>
-- 
cgit v1.2.3