<!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>jsonrpc.server — JSONRPC v1.0 documentation</title>
<link rel="stylesheet" href="../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.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="JSONRPC v1.0 documentation" href="../../index.html" />
<link rel="up" title="Module code" href="../index.html" />
</head>
<body>
<div class="related">
<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><a href="../../index.html">JSONRPC v1.0 documentation</a> »</li>
<li><a href="../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for jsonrpc.server</h1><div class="highlight"><pre>
<span class="c"># $Id: server.py,v 1.8 2011/05/26 19:34:19 edwlan Exp $</span>
<span class="kn">import</span> <span class="nn">cgi</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">import</span> <span class="nn">jsonrpc.jsonutil</span>
<span class="c"># Twisted imports</span>
<span class="kn">from</span> <span class="nn">twisted.web</span> <span class="kn">import</span> <span class="n">server</span>
<span class="kn">from</span> <span class="nn">twisted.internet</span> <span class="kn">import</span> <span class="n">threads</span>
<span class="kn">from</span> <span class="nn">twisted.web.resource</span> <span class="kn">import</span> <span class="n">Resource</span>
<span class="kn">import</span> <span class="nn">UserDict</span><span class="o">,</span> <span class="nn">collections</span>
<span class="n">collections</span><span class="o">.</span><span class="n">Mapping</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">UserDict</span><span class="o">.</span><span class="n">DictMixin</span><span class="p">)</span>
<div class="viewcode-block" id="ServerEvents"><a class="viewcode-back" href="../../server.html#jsonrpc.server.ServerEvents">[docs]</a><span class="k">class</span> <span class="nc">ServerEvents</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">'''Subclass this and pass to :py:meth:`jsonrpc.customize` to customize the jsonrpc server'''</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">jsonrpc</span><span class="p">):</span>
<span class="c">#: A link to the JSON-RPC server instance</span>
<span class="bp">self</span><span class="o">.</span><span class="n">server</span> <span class="o">=</span> <span class="n">jsonrpc</span>
<div class="viewcode-block" id="ServerEvents.callmethod"><a class="viewcode-back" href="../../server.html#jsonrpc.server.ServerEvents.callmethod">[docs]</a> <span class="k">def</span> <span class="nf">callmethod</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="sd">'''Override to implement the methods the server will make available'''</span>
<span class="k">return</span> <span class="s">'Test Result'</span>
</div>
<div class="viewcode-block" id="ServerEvents.processrequest"><a class="viewcode-back" href="../../server.html#jsonrpc.server.ServerEvents.processrequest">[docs]</a> <span class="k">def</span> <span class="nf">processrequest</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="sd">'''Override to implement custom handling of the method result and request'''</span>
<span class="k">return</span> <span class="n">result</span>
</div>
<div class="viewcode-block" id="ServerEvents.logerror"><a class="viewcode-back" href="../../server.html#jsonrpc.server.ServerEvents.logerror">[docs]</a> <span class="k">def</span> <span class="nf">logerror</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
<span class="sd">'''Override to implement custom error handling'''</span>
<span class="k">pass</span>
<span class="c">## Base class providing a JSON-RPC 2.0 implementation with 2 customizable hooks</span></div></div>
<div class="viewcode-block" id="JSON_RPC"><a class="viewcode-back" href="../../server.html#jsonrpc.server.JSON_RPC">[docs]</a><span class="k">class</span> <span class="nc">JSON_RPC</span><span class="p">(</span><span class="n">Resource</span><span class="p">):</span>
<span class="sd">'''This class implements a JSON-RPC 2.0 server as a Twisted Resource'''</span>
<span class="n">isLeaf</span> <span class="o">=</span> <span class="bp">True</span>
<span class="c">#: set by :py:meth:`customize` used to change the behavior of the server</span>
<span class="n">eventhandler</span> <span class="o">=</span> <span class="n">ServerEvents</span>
<div class="viewcode-block" id="JSON_RPC.customize"><a class="viewcode-back" href="../../server.html#jsonrpc.server.JSON_RPC.customize">[docs]</a> <span class="k">def</span> <span class="nf">customize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">eventhandler</span><span class="p">):</span>
<span class="sd">'''customize the behavior of the server'''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">eventhandler</span> <span class="o">=</span> <span class="n">eventhandler</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span>
</div>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">customize</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">eventhandler</span><span class="p">)</span>
<span class="n">Resource</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_parse_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">content</span><span class="p">):</span>
<span class="k">if</span> <span class="n">content</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'jsonrpc'</span><span class="p">)</span> <span class="o">!=</span> <span class="s">'2.0'</span><span class="p">:</span> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="s">'wrong JSON-RPC version'</span>
<span class="n">method</span> <span class="o">=</span> <span class="n">content</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'method'</span><span class="p">)</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">content</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'params'</span><span class="p">,</span> <span class="p">{})</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">kwargs</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="n">args</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s">'__args'</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">k</span><span class="p">),</span> <span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span><span class="n">v</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> <span class="p">)</span>
<span class="k">return</span> <span class="n">method</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">,</span> <span class="n">args</span>
<span class="k">def</span> <span class="nf">_cbRender</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
<span class="n">request</span><span class="o">.</span><span class="n">setHeader</span><span class="p">(</span><span class="s">"content-type"</span><span class="p">,</span> <span class="s">'application/json'</span><span class="p">)</span>
<span class="n">request</span><span class="o">.</span><span class="n">setResponseCode</span><span class="p">(</span><span class="mi">200</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">jsonrpc</span><span class="o">.</span><span class="n">jsonutil</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">result</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">'utf-8'</span><span class="p">)</span>
<span class="n">request</span><span class="o">.</span><span class="n">setHeader</span><span class="p">(</span><span class="s">"content-length"</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">result</span><span class="p">))</span>
<span class="n">request</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
<span class="n">request</span><span class="o">.</span><span class="n">finish</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_ebRender</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">content</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">result_template</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">jsonrpc</span><span class="o">=</span><span class="s">'2.0'</span><span class="p">,</span>
<span class="n">error</span><span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">code</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
<span class="n">message</span><span class="o">=</span><span class="s">'Stub Message'</span><span class="p">,</span>
<span class="n">data</span> <span class="o">=</span> <span class="s">'Stub Data'</span>
<span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">request</span><span class="o">.</span><span class="n">setHeader</span><span class="p">(</span><span class="s">"X-Error"</span><span class="p">,</span> <span class="n">result</span><span class="o">.</span><span class="n">getErrorMessage</span><span class="p">())</span>
<span class="n">result_template</span><span class="p">[</span><span class="s">'error'</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
<span class="n">code</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
<span class="n">message</span><span class="o">=</span><span class="s">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">result</span><span class="o">.</span><span class="n">value</span><span class="p">),</span>
<span class="n">data</span><span class="o">=</span><span class="n">content</span>
<span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">content</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
<span class="n">result_template</span><span class="p">[</span><span class="s">'id'</span><span class="p">]</span> <span class="o">=</span> <span class="n">content</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'id'</span><span class="p">,</span> <span class="s">'<NULL>'</span><span class="p">)</span>
<span class="n">result_template</span> <span class="o">=</span> <span class="p">[</span><span class="n">result</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span> <span class="n">result_template</span><span class="p">[</span><span class="s">'id'</span><span class="p">]</span> <span class="o">=</span> <span class="n">content</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'id'</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="n">result_template</span><span class="p">[</span><span class="s">'error'</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
<span class="n">code</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">message</span> <span class="o">=</span> <span class="s">'Error in errorpage: </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="n">e</span><span class="p">,</span>
<span class="n">data</span> <span class="o">=</span> <span class="s">''</span>
<span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">result_template</span>
<span class="n">result</span><span class="p">[</span><span class="s">'error'</span><span class="p">][</span><span class="s">'message'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cgi</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s">'error'</span><span class="p">][</span><span class="s">'message'</span><span class="p">])</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">jsonrpc</span><span class="o">.</span><span class="n">jsonutil</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">'utf-8'</span><span class="p">)</span>
<span class="n">request</span><span class="o">.</span><span class="n">setHeader</span><span class="p">(</span><span class="s">"content-length"</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">result</span><span class="p">))</span>
<span class="n">request</span><span class="o">.</span><span class="n">setResponseCode</span><span class="p">(</span><span class="mi">500</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">eventhandler</span><span class="o">.</span><span class="n">logerror</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">request</span><span class="p">)</span>
<span class="n">request</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
<span class="n">request</span><span class="o">.</span><span class="n">finish</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">render</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
<span class="n">ctxid</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">getCookie</span><span class="p">(</span><span class="s">"ctxid"</span><span class="p">)</span> <span class="ow">or</span> <span class="n">request</span><span class="o">.</span><span class="n">args</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"ctxid"</span><span class="p">,</span> <span class="p">[</span><span class="bp">None</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">host</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">getClientIP</span><span class="p">()</span>
<span class="n">request</span><span class="o">.</span><span class="n">content</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">content</span> <span class="o">=</span> <span class="n">jsonrpc</span><span class="o">.</span><span class="n">jsonutil</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">content</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">threads</span><span class="o">.</span><span class="n">deferToThread</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_action</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">content</span><span class="p">,</span> <span class="n">ctxid</span><span class="o">=</span><span class="n">ctxid</span><span class="p">,</span> <span class="n">host</span><span class="o">=</span><span class="n">host</span><span class="p">)</span>
<span class="n">d</span><span class="o">.</span><span class="n">addCallback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cbRender</span><span class="p">,</span> <span class="n">request</span><span class="p">)</span>
<span class="n">d</span><span class="o">.</span><span class="n">addErrback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_ebRender</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">content</span><span class="p">)</span>
<span class="k">return</span> <span class="n">server</span><span class="o">.</span><span class="n">NOT_DONE_YET</span>
<span class="k">def</span> <span class="nf">_action</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">contents</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">ol</span> <span class="o">=</span> <span class="p">(</span><span class="bp">True</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">contents</span><span class="p">,</span> <span class="nb">list</span><span class="p">)</span> <span class="k">else</span> <span class="bp">False</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">ol</span><span class="p">:</span>
<span class="n">contents</span> <span class="o">=</span> <span class="p">[</span><span class="n">contents</span><span class="p">]</span>
<span class="k">for</span> <span class="n">content</span> <span class="ow">in</span> <span class="n">contents</span><span class="p">:</span>
<span class="n">res</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">jsonrpc</span> <span class="o">=</span> <span class="s">'2.0'</span><span class="p">,</span>
<span class="nb">id</span> <span class="o">=</span> <span class="n">content</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'id'</span><span class="p">),</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">eventhandler</span><span class="o">.</span><span class="n">callmethod</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">_parse_data</span><span class="p">(</span><span class="n">content</span><span class="p">),</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
<span class="p">)</span>
<span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">eventhandler</span><span class="o">.</span><span class="n">processrequest</span><span class="p">(</span><span class="n">res</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">args</span><span class="p">)</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span> <span class="n">result</span> <span class="k">if</span> <span class="n">ol</span> <span class="k">else</span> <span class="n">result</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="p">)</span>
</div>
<span class="n">__version__</span> <span class="o">=</span> <span class="s">"$Revision: 1.8 $"</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">":"</span><span class="p">)[</span><span class="mi">1</span><span class="p">][:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" size="18" />
<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">
<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><a href="../../index.html">JSONRPC v1.0 documentation</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2011, Edward Langley.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>