You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
624 lines
57 KiB
624 lines
57 KiB
9 years ago
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
|
||
|
|
<title>Writing Plugins for the Pappy Proxy — Pappy Proxy 0.2.0 documentation</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT: './',
|
||
|
|
VERSION: '0.2.0',
|
||
|
|
COLLAPSE_INDEX: false,
|
||
|
|
FILE_SUFFIX: '.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
|
|
<link rel="top" title="Pappy Proxy 0.2.0 documentation" href="index.html" />
|
||
|
|
<link rel="prev" title="The Pappy Proxy Tutorial" href="tutorial.html" />
|
||
|
|
</head>
|
||
|
|
<body role="document">
|
||
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
accesskey="I">index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="tutorial.html" title="The Pappy Proxy Tutorial"
|
||
|
|
accesskey="P">previous</a> |</li>
|
||
|
|
<li class="nav-item nav-item-0"><a href="index.html">Pappy Proxy 0.2.0 documentation</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body" role="main">
|
||
|
|
|
||
|
|
<div class="section" id="writing-plugins-for-the-pappy-proxy">
|
||
|
|
<h1>Writing Plugins for the Pappy Proxy<a class="headerlink" href="#writing-plugins-for-the-pappy-proxy" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<div class="contents local topic" id="table-of-contents">
|
||
|
|
<p class="topic-title first">Table of Contents</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li><a class="reference internal" href="#introduction" id="id1">Introduction</a><ul>
|
||
|
|
<li><a class="reference internal" href="#should-i-write-a-plugin-or-a-macro" id="id2">Should I Write a Plugin or a Macro?</a></li>
|
||
|
|
<li><a class="reference internal" href="#plugins-get-merged" id="id3">Plugins Get Merged</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a class="reference internal" href="#creating-a-plugin" id="id4">Creating a Plugin</a><ul>
|
||
|
|
<li><a class="reference internal" href="#writing-a-hello-world-plugin" id="id5">Writing a Hello World Plugin</a></li>
|
||
|
|
<li><a class="reference internal" href="#passing-arguments-to-your-function" id="id6">Passing Arguments to Your Function</a></li>
|
||
|
|
<li><a class="reference internal" href="#adding-more-aliases" id="id7">Adding More Aliases</a></li>
|
||
|
|
<li><a class="reference internal" href="#adding-another-command" id="id8">Adding Another Command</a></li>
|
||
|
|
<li><a class="reference internal" href="#adding-autocompletion" id="id9">Adding Autocompletion</a></li>
|
||
|
|
<li><a class="reference internal" href="#adding-help" id="id10">Adding Help</a></li>
|
||
|
|
<li><a class="reference internal" href="#using-defer-inlinecallbacks-with-a-command" id="id11">Using defer.inlineCallbacks With a Command</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a class="reference internal" href="#plugin-api" id="id12">Plugin API</a><ul>
|
||
|
|
<li><a class="reference internal" href="#api-functions" id="id13">API Functions</a></li>
|
||
|
|
<li><a class="reference internal" href="#storing-data-on-disk" id="id14">Storing Data on Disk</a></li>
|
||
|
|
<li><a class="reference internal" href="#storing-custom-request-metadata" id="id15">Storing Custom Request Metadata</a></li>
|
||
|
|
<li><a class="reference internal" href="#useful-functions" id="id16">Useful Functions</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a class="reference internal" href="#built-in-plugins-as-examples" id="id17">Built In Plugins As Examples</a><ul>
|
||
|
|
<li><a class="reference internal" href="#built-in-plugins" id="id18">Built In Plugins</a></li>
|
||
|
|
<li><a class="reference internal" href="#interceptor-and-repeater" id="id19">Interceptor and Repeater</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="introduction">
|
||
|
|
<h2><a class="toc-backref" href="#id1">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Are macros not powerful enough? Want to make something reusable? Want to add console commands?! Then you might want to write yourself a plugin. Some quick highlights about plugins:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>Python scripts stored in <code class="docutils literal"><span class="pre">~/.pappy/plugins</span></code></li>
|
||
|
|
<li>Can add console commands</li>
|
||
|
|
<li>For actions which aren’t specific to one project</li>
|
||
|
|
<li>Harder to write than macros</li>
|
||
|
|
</ul>
|
||
|
|
<p>Since macros can also use the plugin API, plugins aren’t any more powerful than macros (besides adding console commands). However, if you find yourself copying a useful macro to more than one project, it may be worth it to just bind it to some commands, put the script in one place, and stop worrying about copying it around. Plus then you can put it on GitHub for some sweet sweet nerd cred.</p>
|
||
|
|
<div class="section" id="should-i-write-a-plugin-or-a-macro">
|
||
|
|
<h3><a class="toc-backref" href="#id2">Should I Write a Plugin or a Macro?</a><a class="headerlink" href="#should-i-write-a-plugin-or-a-macro" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>A lot of the time, you can get away with writing a macro. However, you may consider writing a plugin if:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>You find yourself copying one macro to multiple projects</li>
|
||
|
|
<li>You want to write a general tool that can be applied to any website</li>
|
||
|
|
<li>You need to maintain state during the Pappy session</li>
|
||
|
|
</ul>
|
||
|
|
<p>My guess is that if you need one quick thing for a project, you’re better off writing a macro first and seeing if you end up using it in future projects. Then if you find yourself needing it a lot, write a plugin for it. You may also consider keeping a <code class="docutils literal"><span class="pre">mine.py</span></code> plugin where you can write out commands that you use regularly but may not be worth creating a dedicated plugin for.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="plugins-get-merged">
|
||
|
|
<h3><a class="toc-backref" href="#id3">Plugins Get Merged</a><a class="headerlink" href="#plugins-get-merged" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>If you write a useful plugin, as long as it isn’t uber niche, I’ll try and merge it into the core project.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="creating-a-plugin">
|
||
|
|
<h2><a class="toc-backref" href="#id4">Creating a Plugin</a><a class="headerlink" href="#creating-a-plugin" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Whenever you make a macro, you’ll have to bind some functions to some console commands. To do this, you’ll have to define a <code class="docutils literal"><span class="pre">load_cmds</span></code> function in your plugin. This function should take one argument. When the plugin is loaded, this function will be called and the console object will be passed to this function. You can then use <code class="docutils literal"><span class="pre">set_cmds</span></code> and <code class="docutils literal"><span class="pre">add_aliases</span></code> to bind functions to console commands.</p>
|
||
|
|
<div class="section" id="writing-a-hello-world-plugin">
|
||
|
|
<h3><a class="toc-backref" href="#id5">Writing a Hello World Plugin</a><a class="headerlink" href="#writing-a-hello-world-plugin" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>It’s probably easiest to explain how to write a plugin by writing one. Here is a simple plugin that defines a <code class="docutils literal"><span class="pre">hello</span></code> command and gives an alias <code class="docutils literal"><span class="pre">hlo</span></code> (we’ll go over all the parts in a second):</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="c">## hello.py</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">hello_world</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
|
||
|
|
<span class="k">print</span> <span class="s">"Hello, world!"</span>
|
||
|
|
|
||
|
|
<span class="c">###############</span>
|
||
|
|
<span class="c">## Plugin hooks</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">load_cmds</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">set_cmds</span><span class="p">({</span>
|
||
|
|
<span class="s">'hello'</span><span class="p">:</span> <span class="p">(</span><span class="n">hello_world</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||
|
|
<span class="p">})</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">add_aliases</span><span class="p">([</span>
|
||
|
|
<span class="p">(</span><span class="s">'hello'</span><span class="p">,</span> <span class="s">'hlo'</span><span class="p">),</span>
|
||
|
|
<span class="p">])</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Save this as <code class="docutils literal"><span class="pre">~/.pappy/plugins/hello.py</span></code> and run Pappy. You should have a new <code class="docutils literal"><span class="pre">hello</span></code> command that prints your message:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre>$ cp hello.py ~/.pappy/plugins/
|
||
|
|
$ pappy -l
|
||
|
|
Temporary datafile is /tmp/tmp1Myw6q
|
||
|
|
Proxy is listening on port 8000
|
||
|
|
pappy> hello
|
||
|
|
Hello, world!
|
||
|
|
pappy> hlo
|
||
|
|
Hello, world!
|
||
|
|
pappy>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Awesome! So let’s go over the code. Here are the important parts of the code:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>We define a function that we want to call</li>
|
||
|
|
<li>We define <code class="docutils literal"><span class="pre">load_cmds(cmd)</span></code> to be called when our plugin is loaded to bind our function to a command</li>
|
||
|
|
<li>We use <code class="docutils literal"><span class="pre">cmd.set_cmds</span></code> to set all our commands</li>
|
||
|
|
<li>We use <code class="docutils literal"><span class="pre">cmd.add_aliases</span></code> to add aliases for commands</li>
|
||
|
|
</ul>
|
||
|
|
<p>Now let’s go over it in detail</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="passing-arguments-to-your-function">
|
||
|
|
<h3><a class="toc-backref" href="#id6">Passing Arguments to Your Function</a><a class="headerlink" href="#passing-arguments-to-your-function" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>Each command gets bound to one function which takes one argument. That argument is all the text that was entered after the name of the command in the console. For example if we run <code class="docutils literal"><span class="pre">hello</span> <span class="pre">foo</span> <span class="pre">bar</span></code>, in our function line would be “foo bar”. <strong>I suggest using shlex.split(line) to parse multiple arguments</strong>. So let’s update our script to take some arguments:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="c">## hello.py</span>
|
||
|
|
<span class="kn">import</span> <span class="nn">shlex</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">hello_world</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
|
||
|
|
<span class="k">if</span> <span class="n">line</span><span class="p">:</span>
|
||
|
|
<span class="n">args</span> <span class="o">=</span> <span class="n">shlex</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
|
||
|
|
<span class="k">print</span> <span class="s">'Hello, </span><span class="si">%s</span><span class="s">!'</span> <span class="o">%</span> <span class="p">(</span><span class="s">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
|
||
|
|
<span class="k">else</span><span class="p">:</span>
|
||
|
|
<span class="k">print</span> <span class="s">"Hello, world!"</span>
|
||
|
|
|
||
|
|
<span class="c">###############</span>
|
||
|
|
<span class="c">## Plugin hooks</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">load_cmds</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">set_cmds</span><span class="p">({</span>
|
||
|
|
<span class="s">'hello'</span><span class="p">:</span> <span class="p">(</span><span class="n">hello_world</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||
|
|
<span class="p">})</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">add_aliases</span><span class="p">([</span>
|
||
|
|
<span class="p">(</span><span class="s">'hello'</span><span class="p">,</span> <span class="s">'hlo'</span><span class="p">),</span>
|
||
|
|
<span class="p">])</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Save your changes and restart pappy to reload the plugin:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre>$ pappy -l
|
||
|
|
Temporary datafile is /tmp/tmpBOXyJ3
|
||
|
|
Proxy is listening on port 8000
|
||
|
|
pappy> hello
|
||
|
|
Hello, world!
|
||
|
|
pappy> hello foo bar baz
|
||
|
|
Hello, foo, bar, baz!
|
||
|
|
pappy> hello foo bar "baz lihtyur"
|
||
|
|
Hello, foo, bar, baz lihtyur!
|
||
|
|
pappy>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="adding-more-aliases">
|
||
|
|
<h3><a class="toc-backref" href="#id7">Adding More Aliases</a><a class="headerlink" href="#adding-more-aliases" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>So now let’s add some more aliases to our command. If we want to add a new alias, we just add another tuple to the list passed into <code class="docutils literal"><span class="pre">cmd.add_aliases</span></code>. The first element is the real name of the command (what you set with <code class="docutils literal"><span class="pre">set_cmds</span></code>) and the second value is the alias you want to type. So let’s make it so we can just type <code class="docutils literal"><span class="pre">ho</span></code> to say hello:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="c">## hello.py</span>
|
||
|
|
<span class="kn">import</span> <span class="nn">shlex</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">hello_world</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
|
||
|
|
<span class="k">if</span> <span class="n">line</span><span class="p">:</span>
|
||
|
|
<span class="n">args</span> <span class="o">=</span> <span class="n">shlex</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
|
||
|
|
<span class="k">print</span> <span class="s">'Hello, </span><span class="si">%s</span><span class="s">!'</span> <span class="o">%</span> <span class="p">(</span><span class="s">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
|
||
|
|
<span class="k">else</span><span class="p">:</span>
|
||
|
|
<span class="k">print</span> <span class="s">"Hello, world!"</span>
|
||
|
|
|
||
|
|
<span class="c">###############</span>
|
||
|
|
<span class="c">## Plugin hooks</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">load_cmds</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">set_cmds</span><span class="p">({</span>
|
||
|
|
<span class="s">'hello'</span><span class="p">:</span> <span class="p">(</span><span class="n">hello_world</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||
|
|
<span class="p">})</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">add_aliases</span><span class="p">([</span>
|
||
|
|
<span class="p">(</span><span class="s">'hello'</span><span class="p">,</span> <span class="s">'hlo'</span><span class="p">),</span>
|
||
|
|
<span class="p">(</span><span class="s">'hello'</span><span class="p">,</span> <span class="s">'ho'</span><span class="p">),</span>
|
||
|
|
<span class="p">])</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">You must use the actual name of the command that you used in <code class="docutils literal"><span class="pre">set_cmds</span></code>. You can’t “chain” alieases. As a result, in our example we couldn’t add the alias <code class="docutils literal"><span class="pre">('hlo',</span> <span class="pre">'ho')</span></code> to add <code class="docutils literal"><span class="pre">ho</span></code> as our alias.</p>
|
||
|
|
</div>
|
||
|
|
<p>Then reload the plugin:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre>$ pappy -l
|
||
|
|
Temporary datafile is /tmp/tmpBOXyJ3
|
||
|
|
Proxy is listening on port 8000
|
||
|
|
pappy> ho
|
||
|
|
Hello, world!
|
||
|
|
pappy> ho foo bar baz
|
||
|
|
Hello, foo, bar, baz!
|
||
|
|
pappy> ho foo bar "baz lihtyur"
|
||
|
|
Hello, foo, bar, baz lihtyur!
|
||
|
|
pappy>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="adding-another-command">
|
||
|
|
<h3><a class="toc-backref" href="#id8">Adding Another Command</a><a class="headerlink" href="#adding-another-command" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>So now let’s add a <code class="docutils literal"><span class="pre">robe_and_wizard_hat</span></code> command. To do this, we will define another function, then add another entry in the dict that is passed to <code class="docutils literal"><span class="pre">set_cmds</span></code>. The second value in the tuple is the autocomplete function, but we’ll get to that later. For now, just put in <code class="docutils literal"><span class="pre">None</span></code> to say we don’t have one. We will also add a <code class="docutils literal"><span class="pre">wh</span></code> alias to it:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre>$ pappy -l
|
||
|
|
Temporary datafile is /tmp/tmpyl2cEZ
|
||
|
|
Proxy is listening on port 8000
|
||
|
|
pappy> wh
|
||
|
|
I put on my robe and wizard hat
|
||
|
|
pappy>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="adding-autocompletion">
|
||
|
|
<h3><a class="toc-backref" href="#id9">Adding Autocompletion</a><a class="headerlink" href="#adding-autocompletion" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>You can also define a function to handle autocompletion for your command. In order to do this, you define a function that takes 4 arguments: <code class="docutils literal"><span class="pre">text</span></code>, <code class="docutils literal"><span class="pre">line</span></code>, <code class="docutils literal"><span class="pre">begidx</span></code>, and <code class="docutils literal"><span class="pre">endidx</span></code>. From the <a class="reference external" href="https://docs.python.org/2/library/cmd.html">Cmd docs</a>, this is what the arguments mean:</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><code class="docutils literal"><span class="pre">text</span></code> is the string prefix we are attempting to match: all returned matches must begin with it. <code class="docutils literal"><span class="pre">line</span></code> is the current input line with leading whitespace removed, <code class="docutils literal"><span class="pre">begidx</span></code> and <code class="docutils literal"><span class="pre">endidx</span></code> are the beginning and ending indexes of the prefix text, which could be used to provide different completion depending upon which position the argument is in.</div></blockquote>
|
||
|
|
<p>Let’s let the user to autocomplete some names in our plugin:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">shlex</span>
|
||
|
|
|
||
|
|
<span class="n">_AUTOCOMPLETE_NAMES</span> <span class="o">=</span> <span class="p">[</span><span class="s">'alice'</span><span class="p">,</span> <span class="s">'allie'</span><span class="p">,</span> <span class="s">'sarah'</span><span class="p">,</span> <span class="s">'mallory'</span><span class="p">,</span> <span class="s">'slagathor'</span><span class="p">]</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">hello_world</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
|
||
|
|
<span class="k">if</span> <span class="n">line</span><span class="p">:</span>
|
||
|
|
<span class="n">args</span> <span class="o">=</span> <span class="n">shlex</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
|
||
|
|
<span class="k">print</span> <span class="s">'Hello, </span><span class="si">%s</span><span class="s">!'</span> <span class="o">%</span> <span class="p">(</span><span class="s">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
|
||
|
|
<span class="k">else</span><span class="p">:</span>
|
||
|
|
<span class="k">print</span> <span class="s">"Hello, world!"</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">put_on_rope_and_wizard_hat</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
|
||
|
|
<span class="k">if</span> <span class="n">line</span><span class="p">:</span>
|
||
|
|
<span class="k">print</span> <span class="s">'</span><span class="si">%s</span><span class="s"> puts on their robe and wizard hat'</span> <span class="o">%</span> <span class="n">line</span>
|
||
|
|
<span class="k">else</span><span class="p">:</span>
|
||
|
|
<span class="k">print</span> <span class="s">'I put on my robe and wizard hat'</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">complete_hello_world</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">line</span><span class="p">,</span> <span class="n">begidx</span><span class="p">,</span> <span class="n">endidx</span><span class="p">):</span>
|
||
|
|
<span class="k">return</span> <span class="p">[</span><span class="n">n</span> <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">_AUTOCOMPLETE_NAMES</span> <span class="k">if</span> <span class="n">n</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">text</span><span class="p">)]</span>
|
||
|
|
|
||
|
|
<span class="c">###############</span>
|
||
|
|
<span class="c">## Plugin hooks</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">load_cmds</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">set_cmds</span><span class="p">({</span>
|
||
|
|
<span class="s">'hello'</span><span class="p">:</span> <span class="p">(</span><span class="n">hello_world</span><span class="p">,</span> <span class="n">complete_hello_world</span><span class="p">),</span>
|
||
|
|
<span class="s">'wizard_hat'</span><span class="p">:</span> <span class="p">(</span><span class="n">put_on_rope_and_wizard_hat</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||
|
|
<span class="p">})</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">add_aliases</span><span class="p">([</span>
|
||
|
|
<span class="p">(</span><span class="s">'hello'</span><span class="p">,</span> <span class="s">'hlo'</span><span class="p">),</span>
|
||
|
|
<span class="p">(</span><span class="s">'wizard_hat'</span><span class="p">,</span> <span class="s">'wh'</span><span class="p">),</span>
|
||
|
|
<span class="p">])</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Then restart and run:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre>$ pappy -l
|
||
|
|
Temporary datafile is /tmp/tmp3J97rE
|
||
|
|
Proxy is listening on port 8000
|
||
|
|
pappy> hello
|
||
|
|
alice allie mallory sarah slagathor
|
||
|
|
pappy> hello allie
|
||
|
|
Hello, allie!
|
||
|
|
pappy>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>You can’t see it, but I hit tab twice after typing hello to get the completions to appear.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="adding-help">
|
||
|
|
<h3><a class="toc-backref" href="#id10">Adding Help</a><a class="headerlink" href="#adding-help" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>Now let’s say we want to add some help to the command so that when the user runs <code class="docutils literal"><span class="pre">help</span> <span class="pre">hello</span></code> they get something useful. To do that, just add a docstring to your function:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">shlex</span>
|
||
|
|
|
||
|
|
<span class="n">_AUTOCOMPLETE_NAMES</span> <span class="o">=</span> <span class="p">[</span><span class="s">'alice'</span><span class="p">,</span> <span class="s">'allie'</span><span class="p">,</span> <span class="s">'sarah'</span><span class="p">,</span> <span class="s">'mallory'</span><span class="p">,</span> <span class="s">'slagathor'</span><span class="p">]</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">hello_world</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
|
||
|
|
<span class="sd">"""</span>
|
||
|
|
<span class="sd"> Say hello to the world. Usage: hello [name]</span>
|
||
|
|
<span class="sd"> """</span>
|
||
|
|
|
||
|
|
<span class="k">if</span> <span class="n">line</span><span class="p">:</span>
|
||
|
|
<span class="n">args</span> <span class="o">=</span> <span class="n">shlex</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
|
||
|
|
<span class="k">print</span> <span class="s">'Hello, </span><span class="si">%s</span><span class="s">!'</span> <span class="o">%</span> <span class="p">(</span><span class="s">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
|
||
|
|
<span class="k">else</span><span class="p">:</span>
|
||
|
|
<span class="k">print</span> <span class="s">"Hello, world!"</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">put_on_rope_and_wizard_hat</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
|
||
|
|
<span class="k">if</span> <span class="n">line</span><span class="p">:</span>
|
||
|
|
<span class="k">print</span> <span class="s">'</span><span class="si">%s</span><span class="s"> puts on their robe and wizard hat'</span> <span class="o">%</span> <span class="n">line</span>
|
||
|
|
<span class="k">else</span><span class="p">:</span>
|
||
|
|
<span class="k">print</span> <span class="s">'I put on my robe and wizard hat'</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">complete_hello_world</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">line</span><span class="p">,</span> <span class="n">begidx</span><span class="p">,</span> <span class="n">endidx</span><span class="p">):</span>
|
||
|
|
<span class="k">return</span> <span class="p">[</span><span class="n">n</span> <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">_AUTOCOMPLETE_NAMES</span> <span class="k">if</span> <span class="n">n</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">text</span><span class="p">)]</span>
|
||
|
|
|
||
|
|
<span class="c">###############</span>
|
||
|
|
<span class="c">## Plugin hooks</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">load_cmds</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">set_cmds</span><span class="p">({</span>
|
||
|
|
<span class="s">'hello'</span><span class="p">:</span> <span class="p">(</span><span class="n">hello_world</span><span class="p">,</span> <span class="n">complete_hello_world</span><span class="p">),</span>
|
||
|
|
<span class="s">'wizard_hat'</span><span class="p">:</span> <span class="p">(</span><span class="n">put_on_rope_and_wizard_hat</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||
|
|
<span class="p">})</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">add_aliases</span><span class="p">([</span>
|
||
|
|
<span class="p">(</span><span class="s">'hello'</span><span class="p">,</span> <span class="s">'hlo'</span><span class="p">),</span>
|
||
|
|
<span class="p">(</span><span class="s">'wizard_hat'</span><span class="p">,</span> <span class="s">'wh'</span><span class="p">),</span>
|
||
|
|
<span class="p">])</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="using-defer-inlinecallbacks-with-a-command">
|
||
|
|
<h3><a class="toc-backref" href="#id11">Using defer.inlineCallbacks With a Command</a><a class="headerlink" href="#using-defer-inlinecallbacks-with-a-command" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">If you are using inlineCallbacks, you can’t use any functions which are blocking versions of async functions. For example, you cannot use <a class="reference internal" href="pappyproxy.html#pappyproxy.http.Request.save" title="pappyproxy.http.Request.save"><code class="xref py py-func docutils literal"><span class="pre">pappyproxy.http.Request.save()</span></code></a> and must instead use <a class="reference internal" href="pappyproxy.html#pappyproxy.http.Request.async_deep_save" title="pappyproxy.http.Request.async_deep_save"><code class="xref py py-func docutils literal"><span class="pre">pappyproxy.http.Request.async_deep_save()</span></code></a>.</p>
|
||
|
|
</div>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This tutorial won’t tell you how to use inlineCallbacks in general. Type “twisted inline callbacks” into google to figure out what they are. This is mainly just a reminder to use the <code class="docutils literal"><span class="pre">crochet</span></code> wrapper for console commands and warning you that some functions may return deferreds that you may have to deal with.</p>
|
||
|
|
</div>
|
||
|
|
<p>Since you’re writing a plugin, you’ll probably be using functions which return a deferred. And to keep things readable, you’ll want to use the <code class="docutils literal"><span class="pre">defer.inlineCallbacks</span></code> function wrapper. Unfortunately, you can’t bind async functions to commands. Luckily, there’s a library called <a class="reference external" href="https://pypi.python.org/pypi/crochet">crochet</a> which lets you add another wrapper to the function that lets it be used like a blocking function. Rather than talking about it, let’s write a plugin to call <a class="reference internal" href="pappyproxy.html#pappyproxy.console.load_reqlist" title="pappyproxy.console.load_reqlist"><code class="xref py py-func docutils literal"><span class="pre">pappyproxy.console.load_reqlist()</span></code></a> to print out some requests’ hosts. Let’s start by pretending it’s a normal function:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">shlex</span>
|
||
|
|
<span class="kn">from</span> <span class="nn">pappyproxy.console</span> <span class="kn">import</span> <span class="n">load_reqlist</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">print_hosts</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
|
||
|
|
<span class="n">args</span> <span class="o">=</span> <span class="n">shlex</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
|
||
|
|
<span class="n">reqs</span> <span class="o">=</span> <span class="n">load_reqlist</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="c"># It's supposed to return a list of requests, right?</span>
|
||
|
|
<span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">reqs</span><span class="p">:</span>
|
||
|
|
<span class="k">print</span> <span class="s">'The host for request </span><span class="si">%s</span><span class="s"> is: </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">reqid</span><span class="p">,</span> <span class="n">r</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>
|
||
|
|
|
||
|
|
<span class="c">###############</span>
|
||
|
|
<span class="c">## Plugin hooks</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">load_cmds</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">set_cmds</span><span class="p">({</span>
|
||
|
|
<span class="s">'print_hosts'</span><span class="p">:</span> <span class="p">(</span><span class="n">print_hosts</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||
|
|
<span class="p">})</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">add_aliases</span><span class="p">([</span>
|
||
|
|
<span class="p">])</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>And we run it:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre>pappy> print_hosts 1
|
||
|
|
Traceback (most recent call last):
|
||
|
|
File "/usr/local/lib/python2.7/dist-packages/cmd2.py", line 788, in onecmd_plus_hooks
|
||
|
|
stop = self.onecmd(statement)
|
||
|
|
File "/usr/local/lib/python2.7/dist-packages/cmd2.py", line 871, in onecmd
|
||
|
|
stop = func(statement)
|
||
|
|
File "/home/supahacker/pappy/pappyproxy/console.py", line 15, in catch
|
||
|
|
func(*args, **kwargs)
|
||
|
|
File "/home/supahacker/.pappy/plugins/hosts.py", line 7, in print_hosts
|
||
|
|
for r in reqs:
|
||
|
|
TypeError: iteration over non-sequence
|
||
|
|
iteration over non-sequence
|
||
|
|
pappy>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Iteration over a non-sequence? what? Well, <a class="reference internal" href="pappyproxy.html#pappyproxy.console.load_reqlist" title="pappyproxy.console.load_reqlist"><code class="xref py py-func docutils literal"><span class="pre">pappyproxy.console.load_reqlist()</span></code></a> doesn’t actually return a list of requests. It returns a deferred which returns a list of requests. I’m not going into the details (look up some stuff on using inline callbacks with Twisted if you want more info), but the way to fix it is to slap an <code class="docutils literal"><span class="pre">inlineCallbacks</span></code> wrapper on the function and <code class="docutils literal"><span class="pre">yield</span></code> the result of the function. Now it looks like this:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">shlex</span>
|
||
|
|
<span class="kn">from</span> <span class="nn">pappyproxy.console</span> <span class="kn">import</span> <span class="n">load_reqlist</span>
|
||
|
|
<span class="kn">from</span> <span class="nn">twisted.internet</span> <span class="kn">import</span> <span class="n">defer</span>
|
||
|
|
|
||
|
|
<span class="nd">@defer.inlineCallbacks</span>
|
||
|
|
<span class="k">def</span> <span class="nf">print_hosts</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
|
||
|
|
<span class="n">args</span> <span class="o">=</span> <span class="n">shlex</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
|
||
|
|
<span class="n">reqs</span> <span class="o">=</span> <span class="k">yield</span> <span class="n">load_reqlist</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
|
||
|
|
<span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">reqs</span><span class="p">:</span>
|
||
|
|
<span class="k">print</span> <span class="s">'The host for request </span><span class="si">%s</span><span class="s"> is: </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">reqid</span><span class="p">,</span> <span class="n">r</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>
|
||
|
|
|
||
|
|
<span class="c">###############</span>
|
||
|
|
<span class="c">## Plugin hooks</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">load_cmds</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">set_cmds</span><span class="p">({</span>
|
||
|
|
<span class="s">'print_hosts'</span><span class="p">:</span> <span class="p">(</span><span class="n">print_hosts</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||
|
|
<span class="p">})</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">add_aliases</span><span class="p">([</span>
|
||
|
|
<span class="p">])</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>However, the console assumes that any functions it calls will be blocking. As a result, we need to add the <code class="docutils literal"><span class="pre">crochet.wait_for</span></code> wrapper:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">shlex</span>
|
||
|
|
<span class="kn">import</span> <span class="nn">crochet</span>
|
||
|
|
<span class="kn">from</span> <span class="nn">pappyproxy.console</span> <span class="kn">import</span> <span class="n">load_reqlist</span>
|
||
|
|
<span class="kn">from</span> <span class="nn">twisted.internet</span> <span class="kn">import</span> <span class="n">defer</span>
|
||
|
|
|
||
|
|
<span class="nd">@crochet.wait_for</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span>
|
||
|
|
<span class="nd">@defer.inlineCallbacks</span>
|
||
|
|
<span class="k">def</span> <span class="nf">print_hosts</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
|
||
|
|
<span class="n">args</span> <span class="o">=</span> <span class="n">shlex</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
|
||
|
|
<span class="n">reqs</span> <span class="o">=</span> <span class="k">yield</span> <span class="n">load_reqlist</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
|
||
|
|
<span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">reqs</span><span class="p">:</span>
|
||
|
|
<span class="k">print</span> <span class="s">'The host for request </span><span class="si">%s</span><span class="s"> is: </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">reqid</span><span class="p">,</span> <span class="n">r</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>
|
||
|
|
|
||
|
|
<span class="c">###############</span>
|
||
|
|
<span class="c">## Plugin hooks</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">load_cmds</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">set_cmds</span><span class="p">({</span>
|
||
|
|
<span class="s">'print_hosts'</span><span class="p">:</span> <span class="p">(</span><span class="n">print_hosts</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||
|
|
<span class="p">})</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">add_aliases</span><span class="p">([</span>
|
||
|
|
<span class="p">])</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>And now we’re good! If you run it without the crochet wrapper, it may still work. However, since the console assumes any functions it calls will be blocking, not having the wrapper could lead to weird errors.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="plugin-api">
|
||
|
|
<h2><a class="toc-backref" href="#id12">Plugin API</a><a class="headerlink" href="#plugin-api" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>There are also some useful functions that you can use to interact with the request history and the context. It’s somewhat limited for now, but for now you can at least look through history and create/send new requests. Hopefully the API will expand as people find themselves wanting to do new things. That means <strong>if you’re writing a plugin, let me know and I’ll add any APIs you need</strong>. For now at least, plugins will let you maintain state over the course of the session and let you define commands.</p>
|
||
|
|
<p>The best way to learn what you can do is to go through the <span class="xref std std-ref">pappyproxy-package</span> and look at all the available functions.</p>
|
||
|
|
<div class="section" id="api-functions">
|
||
|
|
<h3><a class="toc-backref" href="#id13">API Functions</a><a class="headerlink" href="#api-functions" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>See <a class="reference internal" href="pappyproxy.html#module-pappyproxy.plugin" title="pappyproxy.plugin"><code class="xref py py-mod docutils literal"><span class="pre">pappyproxy.plugin</span></code></a> for docs on all the functions you can use. You can also use any of the functions provided for writing macros (and vice-versa).</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="storing-data-on-disk">
|
||
|
|
<h3><a class="toc-backref" href="#id14">Storing Data on Disk</a><a class="headerlink" href="#storing-data-on-disk" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>Unfortunately, you’re on your own if you want to store plugin specific stuff on disk. It’s also important that you store any data that is specific to a project in the same directory as the data file. This is to make sure that if you encrypt your project folder, you can be sure that no sensitive data about the test can be found anywhere else. The only time you should store anything outside of the current directory is to store global plugin settings, and even then it would probably be better to parse options from <code class="docutils literal"><span class="pre">config.config_dict</span></code>. Pappy doesn’t even store data outside of the project directory except for its CA certificates.</p>
|
||
|
|
<p>However, if your plugin is a special snowflake that needs to store unencrypted, global settings, you should create a directory for your plugin in <code class="docutils literal"><span class="pre">{config.DATA_DIR}/plugindata</span></code> and put your files there. But again, avoid this if you can.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">Any project-specific data (ie anything that contains info about requests) should be stored in the project directory unless you have a really really good reason. This is because it must be possible to secure any sensitive data by encrypting the project folder and storing data outside of the directory will add complications.</p>
|
||
|
|
</div>
|
||
|
|
<div class="admonition warning">
|
||
|
|
<p class="first admonition-title">Warning</p>
|
||
|
|
<p class="last">Do not modify the data file schema. There is a good chance the schema will break in future versions of Pappy.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="storing-custom-request-metadata">
|
||
|
|
<h3><a class="toc-backref" href="#id15">Storing Custom Request Metadata</a><a class="headerlink" href="#storing-custom-request-metadata" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p><a class="reference internal" href="pappyproxy.html#pappyproxy.http.Request" title="pappyproxy.http.Request"><code class="xref py py-class docutils literal"><span class="pre">pappyproxy.http.Request</span></code></a> objects have a <code class="docutils literal"><span class="pre">plugin_data</span></code> attribute. It is a dictionary that is intended to be used by plugins to give the request custom metadata. If you want to store metadata about a request, it is suggested that you add a key to this dictionary and store any metadata you want under that key. You can use <code class="xref py py-func docutils literal"><span class="pre">pappyproxy.http.Request.get_plugin_dict()</span></code> to get a dictionary for a specific name. It will create an entry for that name if it doesn’t exist. I also suggest defining a function plugin-wide for getting the plugin’s data dict from a specific request. Since dictionaries are always passed by reference, any modifications you make to the returned dict will be applied to the request as well.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">You will need to save the request using something like <a class="reference internal" href="pappyproxy.html#pappyproxy.http.Request.save" title="pappyproxy.http.Request.save"><code class="xref py py-func docutils literal"><span class="pre">pappyproxy.http.Request.save()</span></code></a> or <a class="reference internal" href="pappyproxy.html#pappyproxy.http.Request.async_deep_save" title="pappyproxy.http.Request.async_deep_save"><code class="xref py py-func docutils literal"><span class="pre">pappyproxy.http.Request.async_deep_save()</span></code></a> in order to store the changes in the data file.</p>
|
||
|
|
</div>
|
||
|
|
<p>Here is an example plugin for storing the user-agent (if it exists) in the <code class="docutils literal"><span class="pre">plugin_data</span></code> dict of a request under the key <code class="docutils literal"><span class="pre">agent</span></code>:</p>
|
||
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">crochet</span>
|
||
|
|
<span class="kn">import</span> <span class="nn">shlex</span>
|
||
|
|
<span class="kn">from</span> <span class="nn">twisted.internet</span> <span class="kn">import</span> <span class="n">defer</span>
|
||
|
|
|
||
|
|
<span class="kn">from</span> <span class="nn">pappyproxy.console</span> <span class="kn">import</span> <span class="n">load_reqlist</span>
|
||
|
|
<span class="kn">from</span> <span class="nn">pappyproxy.plugin</span> <span class="kn">import</span> <span class="n">main_context</span>
|
||
|
|
<span class="kn">from</span> <span class="nn">pappyproxy.util</span> <span class="kn">import</span> <span class="n">PappyException</span>
|
||
|
|
|
||
|
|
<span class="n">DATA_KEY</span> <span class="o">=</span> <span class="s">'agent'</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">get_data</span><span class="p">(</span><span class="n">r</span><span class="p">):</span>
|
||
|
|
<span class="k">return</span> <span class="n">r</span><span class="o">.</span><span class="n">get_plugin_dict</span><span class="p">(</span><span class="n">DATA_KEY</span><span class="p">)</span>
|
||
|
|
|
||
|
|
<span class="nd">@crochet.wait_for</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span>
|
||
|
|
<span class="nd">@defer.inlineCallbacks</span>
|
||
|
|
<span class="k">def</span> <span class="nf">update_agent_metadata</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
|
||
|
|
<span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">main_context</span><span class="p">()</span><span class="o">.</span><span class="n">active_requests</span><span class="p">:</span>
|
||
|
|
<span class="k">if</span> <span class="s">'user-agent'</span> <span class="ow">in</span> <span class="n">r</span><span class="o">.</span><span class="n">headers</span><span class="p">:</span>
|
||
|
|
<span class="n">get_data</span><span class="p">(</span><span class="n">r</span><span class="p">)[</span><span class="s">'agent'</span><span class="p">]</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'user-agent'</span><span class="p">]</span>
|
||
|
|
<span class="k">yield</span> <span class="n">r</span><span class="o">.</span><span class="n">async_deep_save</span><span class="p">()</span>
|
||
|
|
|
||
|
|
<span class="nd">@crochet.wait_for</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span>
|
||
|
|
<span class="nd">@defer.inlineCallbacks</span>
|
||
|
|
<span class="k">def</span> <span class="nf">view_agent</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
|
||
|
|
<span class="n">args</span> <span class="o">=</span> <span class="n">shlex</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
|
||
|
|
<span class="n">reqs</span> <span class="o">=</span> <span class="k">yield</span> <span class="n">load_reqlist</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
|
||
|
|
<span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">reqs</span><span class="p">:</span>
|
||
|
|
<span class="k">if</span> <span class="s">'agent'</span> <span class="ow">in</span> <span class="n">get_data</span><span class="p">(</span><span class="n">r</span><span class="p">):</span>
|
||
|
|
<span class="k">print</span> <span class="s">'The user agent for </span><span class="si">%s</span><span class="s"> is "</span><span class="si">%s</span><span class="s">"'</span> <span class="o">%</span> <span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">reqid</span><span class="p">,</span> <span class="n">get_data</span><span class="p">(</span><span class="n">r</span><span class="p">)[</span><span class="s">'agent'</span><span class="p">])</span>
|
||
|
|
<span class="k">else</span><span class="p">:</span>
|
||
|
|
<span class="k">print</span> <span class="s">'Request </span><span class="si">%s</span><span class="s"> has no user agent data'</span> <span class="o">%</span> <span class="n">r</span><span class="o">.</span><span class="n">reqid</span>
|
||
|
|
|
||
|
|
<span class="c">###############</span>
|
||
|
|
<span class="c">## Plugin hooks</span>
|
||
|
|
|
||
|
|
<span class="k">def</span> <span class="nf">load_cmds</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">set_cmds</span><span class="p">({</span>
|
||
|
|
<span class="s">'agent_update'</span><span class="p">:</span> <span class="p">(</span><span class="n">update_agent_metadata</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||
|
|
<span class="s">'view_agent'</span><span class="p">:</span> <span class="p">(</span><span class="n">view_agent</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||
|
|
<span class="p">})</span>
|
||
|
|
<span class="n">cmd</span><span class="o">.</span><span class="n">add_aliases</span><span class="p">([</span>
|
||
|
|
<span class="p">])</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="useful-functions">
|
||
|
|
<h3><a class="toc-backref" href="#id16">Useful Functions</a><a class="headerlink" href="#useful-functions" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>Load a request by id: <a class="reference internal" href="pappyproxy.html#pappyproxy.http.Request.load_request" title="pappyproxy.http.Request.load_request"><code class="xref py py-func docutils literal"><span class="pre">pappyproxy.http.Request.load_request()</span></code></a></li>
|
||
|
|
<li>Create a filter from a filter string: <a class="reference internal" href="pappyproxy.html#pappyproxy.context.Filter.from_filter_string" title="pappyproxy.context.Filter.from_filter_string"><code class="xref py py-func docutils literal"><span class="pre">pappyproxy.context.Filter.from_filter_string()</span></code></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="built-in-plugins-as-examples">
|
||
|
|
<h2><a class="toc-backref" href="#id17">Built In Plugins As Examples</a><a class="headerlink" href="#built-in-plugins-as-examples" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<div class="section" id="built-in-plugins">
|
||
|
|
<h3><a class="toc-backref" href="#id18">Built In Plugins</a><a class="headerlink" href="#built-in-plugins" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>All the commands in Pappy are implemented as plugins. I have done what I could to avoid using internal functions as much as I could, but there are still some instances where I had to implement an internal function in order to get the functions I needed. However, you can still look them over to see how things are structured and see some examples of semi-complicated plugins.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="interceptor-and-repeater">
|
||
|
|
<h3><a class="toc-backref" href="#id19">Interceptor and Repeater</a><a class="headerlink" href="#interceptor-and-repeater" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>Pappy’s interceptor and repeater are fully implemented as a plugin. It defines an intercepting macro that handles saving then editing messages and commands that read those files and edit them. It relies on Twisted to switch between the macro handling the request and the command modifying it, so if you want to make something similar, you’ll have to learn how to use deferreds.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
|
|
<div class="sphinxsidebarwrapper">
|
||
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference internal" href="#">Writing Plugins for the Pappy Proxy</a><ul>
|
||
|
|
<li><a class="reference internal" href="#introduction">Introduction</a><ul>
|
||
|
|
<li><a class="reference internal" href="#should-i-write-a-plugin-or-a-macro">Should I Write a Plugin or a Macro?</a></li>
|
||
|
|
<li><a class="reference internal" href="#plugins-get-merged">Plugins Get Merged</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a class="reference internal" href="#creating-a-plugin">Creating a Plugin</a><ul>
|
||
|
|
<li><a class="reference internal" href="#writing-a-hello-world-plugin">Writing a Hello World Plugin</a></li>
|
||
|
|
<li><a class="reference internal" href="#passing-arguments-to-your-function">Passing Arguments to Your Function</a></li>
|
||
|
|
<li><a class="reference internal" href="#adding-more-aliases">Adding More Aliases</a></li>
|
||
|
|
<li><a class="reference internal" href="#adding-another-command">Adding Another Command</a></li>
|
||
|
|
<li><a class="reference internal" href="#adding-autocompletion">Adding Autocompletion</a></li>
|
||
|
|
<li><a class="reference internal" href="#adding-help">Adding Help</a></li>
|
||
|
|
<li><a class="reference internal" href="#using-defer-inlinecallbacks-with-a-command">Using defer.inlineCallbacks With a Command</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a class="reference internal" href="#plugin-api">Plugin API</a><ul>
|
||
|
|
<li><a class="reference internal" href="#api-functions">API Functions</a></li>
|
||
|
|
<li><a class="reference internal" href="#storing-data-on-disk">Storing Data on Disk</a></li>
|
||
|
|
<li><a class="reference internal" href="#storing-custom-request-metadata">Storing Custom Request Metadata</a></li>
|
||
|
|
<li><a class="reference internal" href="#useful-functions">Useful Functions</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a class="reference internal" href="#built-in-plugins-as-examples">Built In Plugins As Examples</a><ul>
|
||
|
|
<li><a class="reference internal" href="#built-in-plugins">Built In Plugins</a></li>
|
||
|
|
<li><a class="reference internal" href="#interceptor-and-repeater">Interceptor and Repeater</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h4>Previous topic</h4>
|
||
|
|
<p class="topless"><a href="tutorial.html"
|
||
|
|
title="previous chapter">The Pappy Proxy Tutorial</a></p>
|
||
|
|
<div role="note" aria-label="source link">
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="_sources/pappyplugins.txt"
|
||
|
|
rel="nofollow">Show Source</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div id="searchbox" style="display: none" role="search">
|
||
|
|
<h3>Quick search</h3>
|
||
|
|
<form class="search" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" />
|
||
|
|
<input type="submit" value="Go" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
<p class="searchtip" style="font-size: 90%">
|
||
|
|
Enter search terms or a module, class or function name.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearer"></div>
|
||
|
|
</div>
|
||
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
>index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="tutorial.html" title="The Pappy Proxy Tutorial"
|
||
|
|
>previous</a> |</li>
|
||
|
|
<li class="nav-item nav-item-0"><a href="index.html">Pappy Proxy 0.2.0 documentation</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="footer" role="contentinfo">
|
||
|
|
© Copyright 2015, Rob Glew.
|
||
|
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.3.
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|