<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[14514] CalendarServer/trunk/txdav/common/datastore/podding/conduit.py</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/14514">14514</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2015-03-05 13:26:24 -0800 (Thu, 05 Mar 2015)</dd>
</dl>
<h3>Log Message</h3>
<pre>lint</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunktxdavcommondatastorepoddingconduitpy">CalendarServer/trunk/txdav/common/datastore/podding/conduit.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunktxdavcommondatastorepoddingconduitpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/txdav/common/datastore/podding/conduit.py (14513 => 14514)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/txdav/common/datastore/podding/conduit.py 2015-03-05 21:08:20 UTC (rev 14513)
+++ CalendarServer/trunk/txdav/common/datastore/podding/conduit.py 2015-03-05 21:26:24 UTC (rev 14514)
</span><span class="lines">@@ -19,10 +19,14 @@
</span><span class="cx"> from txdav.common.idirectoryservice import DirectoryRecordNotFoundError
</span><span class="cx"> from txdav.common.datastore.podding.attachments import AttachmentsConduitMixin
</span><span class="cx"> from txdav.common.datastore.podding.base import FailedCrossPodRequestError
</span><del>-from txdav.common.datastore.podding.directory import DirectoryPoddingConduitMixin
</del><ins>+from txdav.common.datastore.podding.directory import (
+ DirectoryPoddingConduitMixin
+)
</ins><span class="cx"> from txdav.common.datastore.podding.store_api import StoreAPIConduitMixin
</span><span class="cx"> from txdav.common.datastore.podding.request import ConduitRequest
</span><del>-from txdav.common.datastore.podding.sharing_invites import SharingInvitesConduitMixin
</del><ins>+from txdav.common.datastore.podding.sharing_invites import (
+ SharingInvitesConduitMixin
+)
</ins><span class="cx">
</span><span class="cx"> from twisted.internet.defer import inlineCallbacks, returnValue
</span><span class="cx"> from twisted.python.reflect import namedClass
</span><span class="lines">@@ -40,29 +44,33 @@
</span><span class="cx"> """
</span><span class="cx"> This class is the API/RPC bridge between cross-pod requests and the store.
</span><span class="cx">
</span><del>- Each cross-pod request/response is described by a Python C{dict} that is serialized
- to JSON for the HTTP request/response.
</del><ins>+ Each cross-pod request/response is described by a Python C{dict} that is
+ serialized to JSON for the HTTP request/response.
</ins><span class="cx">
</span><del>- Each request C{dict} has an "action" key that indicates what call is being made, and
- the other keys are arguments to that call.
</del><ins>+ Each request C{dict} has an "action" key that indicates what call is being
+ made, and the other keys are arguments to that call.
</ins><span class="cx">
</span><del>- Each response C{dict} has a "result" key that indicates the call result, and other
- optional keys for any values returned by the call.
</del><ins>+ Each response C{dict} has a "result" key that indicates the call result,
+ and other optional keys for any values returned by the call.
</ins><span class="cx">
</span><del>- The conduit provides two methods for each action: one for the sending side and one for
- the receiving side, called "send_{action}" and "recv_{action}", respectively, where
- {action} is the action value.
</del><ins>+ The conduit provides two methods for each action: one for the sending side
+ and one for the receiving side, called "send_{action}" and "recv_{action}",
+ respectively, where {action} is the action value.
</ins><span class="cx">
</span><del>- The "send_{action}" calls each have a set of arguments specific to the call itself. The
- code takes care of packing that into a C{dict} and sending to the appropriate pod.
</del><ins>+ The "send_{action}" calls each have a set of arguments specific to the call
+ itself.
+ The code takes care of packing that into a C{dict} and sending to the
+ appropriate pod.
</ins><span class="cx">
</span><del>- The "recv_{action}" calls take a single C{dict} argument that is the deserialized JSON
- data from the incoming request. The return value is a C{dict} with the result.
</del><ins>+ The "recv_{action}" calls take a single C{dict} argument that is the
+ deserialized JSON data from the incoming request. The return value is a
+ C{dict} with the result.
</ins><span class="cx">
</span><del>- Some simple forms of send_/recv_ methods can be auto-generated to simplify coding.
</del><ins>+ Some simple forms of send_/recv_ methods can be auto-generated to simplify
+ coding.
</ins><span class="cx">
</span><del>- Actual implementations of this will be done via mix-ins for the different sub-systems using
- the conduit.
</del><ins>+ Actual implementations of this will be done via mix-ins for the different
+ sub-systems using the conduit.
</ins><span class="cx"> """
</span><span class="cx">
</span><span class="cx"> conduitRequestClass = ConduitRequest
</span><span class="lines">@@ -80,9 +88,12 @@
</span><span class="cx"> Verify that the specified uids are valid for the request and return the
</span><span class="cx"> matching directory records.
</span><span class="cx">
</span><del>- @param source_uid: UID for the user on whose behalf the request is being made
</del><ins>+ @param source_uid: UID for the user on whose behalf the request is
+ being made
</ins><span class="cx"> @type source_uid: C{str}
</span><del>- @param destination_uid: UID for the user to whom the request is being sent
</del><ins>+
+ @param destination_uid: UID for the user to whom the request is being
+ sent
</ins><span class="cx"> @type destination_uid: C{str}
</span><span class="cx">
</span><span class="cx"> @return: L{Deferred} resulting in C{tuple} of L{IStoreDirectoryRecord}
</span><span class="lines">@@ -90,35 +101,55 @@
</span><span class="cx">
</span><span class="cx"> source = yield self.store.directoryService().recordWithUID(source_uid)
</span><span class="cx"> if source is None:
</span><del>- raise DirectoryRecordNotFoundError("Cross-pod source: {}".format(source_uid))
</del><ins>+ raise DirectoryRecordNotFoundError(
+ "Cross-pod source: {}".format(source_uid)
+ )
</ins><span class="cx"> if not source.thisServer():
</span><del>- raise FailedCrossPodRequestError("Cross-pod source not on this server: {}".format(source_uid))
</del><ins>+ raise FailedCrossPodRequestError(
+ "Cross-pod source not on this server: {}".format(source_uid)
+ )
</ins><span class="cx">
</span><del>- destination = yield self.store.directoryService().recordWithUID(destination_uid)
</del><ins>+ destination = yield self.store.directoryService().recordWithUID(
+ destination_uid
+ )
</ins><span class="cx"> if destination is None:
</span><del>- raise DirectoryRecordNotFoundError("Cross-pod destination: {}".format(destination_uid))
</del><ins>+ raise DirectoryRecordNotFoundError(
+ "Cross-pod destination: {}".format(destination_uid)
+ )
</ins><span class="cx"> if destination.thisServer():
</span><del>- raise FailedCrossPodRequestError("Cross-pod destination on this server: {}".format(destination_uid))
</del><ins>+ raise FailedCrossPodRequestError(
+ "Cross-pod destination on this server: {}".format(
+ destination_uid
+ )
+ )
</ins><span class="cx">
</span><span class="cx"> returnValue((source, destination,))
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> def sendRequest(self, txn, recipient, data, stream=None, streamType=None):
</span><del>- return self.sendRequestToServer(txn, recipient.server(), data, stream, streamType)
</del><ins>+ return self.sendRequestToServer(
+ txn, recipient.server(), data, stream, streamType
+ )
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx"> @inlineCallbacks
</span><del>- def sendRequestToServer(self, txn, server, data, stream=None, streamType=None):
</del><ins>+ def sendRequestToServer(
+ self, txn, server, data, stream=None, streamType=None
+ ):
</ins><span class="cx">
</span><span class="cx"> request = self.conduitRequestClass(server, data, stream, streamType)
</span><span class="cx"> try:
</span><span class="cx"> response = (yield request.doRequest(txn))
</span><span class="cx"> except Exception as e:
</span><del>- raise FailedCrossPodRequestError("Failed cross-pod request: {}".format(e))
</del><ins>+ raise FailedCrossPodRequestError(
+ "Failed cross-pod request: {}".format(e)
+ )
</ins><span class="cx"> if response["result"] == "exception":
</span><span class="cx"> raise namedClass(response["class"])(response["details"])
</span><span class="cx"> elif response["result"] != "ok":
</span><del>- raise FailedCrossPodRequestError("Cross-pod request failed: {}".format(response))
</del><ins>+ raise FailedCrossPodRequestError(
+ "Cross-pod request failed: {}".format(response)
+ )
</ins><span class="cx"> else:
</span><span class="cx"> returnValue(response.get("value"))
</span><span class="cx">
</span><span class="lines">@@ -135,8 +166,15 @@
</span><span class="cx"> try:
</span><span class="cx"> action = data["action"]
</span><span class="cx"> except (KeyError, TypeError) as e:
</span><del>- log.error("JSON data must have an object as its root with an 'action' attribute: {ex}\n{json}", ex=e, json=data)
- raise FailedCrossPodRequestError("JSON data must have an object as its root with an 'action' attribute: {}\n{}".format(e, data,))
</del><ins>+ log.error(
+ "JSON data must have an object as its root with an 'action' "
+ "attribute: {ex}\n{json}",
+ ex=e, json=data
+ )
+ raise FailedCrossPodRequestError(
+ "JSON data must have an object as its root with an 'action' "
+ "attribute: {}\n{}".format(e, data,)
+ )
</ins><span class="cx">
</span><span class="cx"> if action == "ping":
</span><span class="cx"> result = {"result": "ok"}
</span><span class="lines">@@ -145,7 +183,9 @@
</span><span class="cx"> method = "recv_{}".format(action.replace("-", "_"))
</span><span class="cx"> if not hasattr(self, method):
</span><span class="cx"> log.error("Unsupported action: {action}", action=action)
</span><del>- raise FailedCrossPodRequestError("Unsupported action: {}".format(action))
</del><ins>+ raise FailedCrossPodRequestError(
+ "Unsupported action: {}".format(action)
+ )
</ins><span class="cx">
</span><span class="cx"> # Need a transaction to work with
</span><span class="cx"> txn = self.store.newTransaction(repr("Conduit request"))
</span><span class="lines">@@ -163,7 +203,9 @@
</span><span class="cx"> log.error("Failed action: {action}, {ex}", action=action, ex=e)
</span><span class="cx"> result = {
</span><span class="cx"> "result": "exception",
</span><del>- "class": ".".join((e.__class__.__module__, e.__class__.__name__,)),
</del><ins>+ "class": ".".join((
+ e.__class__.__module__, e.__class__.__name__,
+ )),
</ins><span class="cx"> "details": str(e),
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>