<!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>[13652] twext/branches/users/sagen/recordtypes/twext/who/opendirectory/_service.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/13652">13652</a></dd>
<dt>Author</dt> <dd>sagen@apple.com</dd>
<dt>Date</dt> <dd>2014-06-18 13:26:18 -0700 (Wed, 18 Jun 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Support for recordTypes arg</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#twextbranchesuserssagenrecordtypestwextwhoopendirectory_servicepy">twext/branches/users/sagen/recordtypes/twext/who/opendirectory/_service.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="twextbranchesuserssagenrecordtypestwextwhoopendirectory_servicepy"></a>
<div class="modfile"><h4>Modified: twext/branches/users/sagen/recordtypes/twext/who/opendirectory/_service.py (13651 => 13652)</h4>
<pre class="diff"><span>
<span class="info">--- twext/branches/users/sagen/recordtypes/twext/who/opendirectory/_service.py 2014-06-18 18:06:15 UTC (rev 13651)
+++ twext/branches/users/sagen/recordtypes/twext/who/opendirectory/_service.py 2014-06-18 20:26:18 UTC (rev 13652)
</span><span class="lines">@@ -390,7 +390,7 @@
</span><span class="cx"> )
</span><span class="cx">
</span><span class="cx">
</span><del>- def _queryFromCompoundExpression(self, expression, local=False):
</del><ins>+ def _queryFromCompoundExpression(self, expression, recordTypes=None, local=False):
</ins><span class="cx"> """
</span><span class="cx"> Form an OpenDirectory query from a compound expression.
</span><span class="cx">
</span><span class="lines">@@ -410,22 +410,24 @@
</span><span class="cx"> else:
</span><span class="cx"> node = self.node
</span><span class="cx">
</span><del>- queryString, recordTypes = (
</del><ins>+ queryString, expressionRecordTypes = (
</ins><span class="cx"> self._queryStringAndRecordTypesFromExpression(expression)
</span><span class="cx"> )
</span><del>- if not recordTypes:
- return None
</del><span class="cx">
</span><span class="cx"> # Scrub unsupported recordTypes
</span><span class="cx"> supportedODRecordTypes = []
</span><del>- for rt in self.recordTypes():
- odRecordType = ODRecordType.fromRecordType(rt)
</del><ins>+ for recordType in self.recordTypes():
+ odRecordType = ODRecordType.fromRecordType(recordType)
</ins><span class="cx"> if odRecordType is not None:
</span><span class="cx"> supportedODRecordTypes.append(odRecordType.value)
</span><del>- scrubbedRecordTypes = []
- for recordType in recordTypes:
- if recordType in supportedODRecordTypes:
- scrubbedRecordTypes.append(recordType)
</del><ins>+ if recordTypes is not None:
+ scrubbedRecordTypes = []
+ for recordType in recordTypes:
+ recordType = ODRecordType.fromRecordType(recordType).value
+ if recordType in supportedODRecordTypes:
+ scrubbedRecordTypes.append(recordType)
+ else:
+ scrubbedRecordTypes = supportedODRecordTypes
</ins><span class="cx">
</span><span class="cx"> if not scrubbedRecordTypes:
</span><span class="cx"> # None of the requested recordTypes are supported.
</span><span class="lines">@@ -464,7 +466,7 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> def _queryFromMatchExpression(
</span><del>- self, expression, recordType=None, local=False
</del><ins>+ self, expression, recordTypes=None, local=False
</ins><span class="cx"> ):
</span><span class="cx"> """
</span><span class="cx"> Form an OpenDirectory query from a match expression.
</span><span class="lines">@@ -472,8 +474,8 @@
</span><span class="cx"> @param expression: A match expression.
</span><span class="cx"> @type expression: L{MatchExpression}
</span><span class="cx">
</span><del>- @param recordType: A record type to insert into the query.
- @type recordType: L{NamedConstant}
</del><ins>+ @param recordTypes: Record types to insert into the query; None for no filtering.
+ @type recordTypes: iterable of L{NamedConstant}, or None
</ins><span class="cx">
</span><span class="cx"> @param local: Whether to restrict the query to the local node
</span><span class="cx"> @type local: C{Boolean}
</span><span class="lines">@@ -506,47 +508,27 @@
</span><span class="cx"> expression.fieldName = self.fieldName.guid
</span><span class="cx">
</span><span class="cx"> if expression.fieldName is self.fieldName.recordType:
</span><del>- if (
- recordType is not None and
- expression.fieldValue is not recordType
- ):
- raise ValueError(
- "recordType argument does not match expression"
- )
</del><ins>+ raise QueryNotSupportedError("RecordType match not supported")
</ins><span class="cx">
</span><del>- recordTypes = [
- ODRecordType.fromRecordType(expression.fieldValue).value
- ]
- if MatchFlags.NOT in flags:
- recordTypes = list(
- set([t.value for t in ODRecordType.iterconstants()]) -
- recordTypes
- )
</del><ins>+ if MatchFlags.NOT in flags:
+ raise NotImplementedError()
</ins><span class="cx">
</span><del>- matchType = ODMatchType.any.value
- queryAttribute = None
- queryValue = None
-
</del><ins>+ if recordTypes is None:
+ odRecordTypes = [t.value for t in ODRecordType.iterconstants()]
</ins><span class="cx"> else:
</span><del>- if MatchFlags.NOT in flags:
- raise NotImplementedError()
</del><ins>+ odRecordTypes = [ODRecordType.fromRecordType(r).value for r in recordTypes]
</ins><span class="cx">
</span><del>- if recordType is None:
- recordTypes = [t.value for t in ODRecordType.iterconstants()]
- else:
- recordTypes = [ODRecordType.fromRecordType(recordType).value]
</del><ins>+ queryAttribute = ODAttribute.fromFieldName(
+ expression.fieldName
+ ).value
</ins><span class="cx">
</span><del>- queryAttribute = ODAttribute.fromFieldName(
- expression.fieldName
- ).value
</del><ins>+ # TODO: Add support other value types:
+ valueType = self.fieldName.valueType(expression.fieldName)
+ if valueType == UUID:
+ queryValue = unicode(expression.fieldValue).upper()
+ else:
+ queryValue = unicode(expression.fieldValue)
</ins><span class="cx">
</span><del>- # TODO: Add support other value types:
- valueType = self.fieldName.valueType(expression.fieldName)
- if valueType == UUID:
- queryValue = unicode(expression.fieldValue).upper()
- else:
- queryValue = unicode(expression.fieldValue)
-
</del><span class="cx"> if local:
</span><span class="cx"> node = self.localNode
</span><span class="cx"> else:
</span><span class="lines">@@ -559,9 +541,9 @@
</span><span class="cx"> if odRecordType is not None:
</span><span class="cx"> supportedODRecordTypes.append(odRecordType.value)
</span><span class="cx"> scrubbedRecordTypes = []
</span><del>- for recordType in recordTypes:
- if recordType in supportedODRecordTypes:
- scrubbedRecordTypes.append(recordType)
</del><ins>+ for odRecordType in odRecordTypes:
+ if odRecordType in supportedODRecordTypes:
+ scrubbedRecordTypes.append(odRecordType)
</ins><span class="cx">
</span><span class="cx"> if not scrubbedRecordTypes:
</span><span class="cx"> # None of the requested recordTypes are supported.
</span><span class="lines">@@ -704,10 +686,10 @@
</span><span class="cx"> return succeed(result)
</span><span class="cx">
</span><span class="cx">
</span><del>- def recordsFromNonCompoundExpression(self, expression, records=None):
</del><ins>+ def recordsFromNonCompoundExpression(self, expression, recordTypes=None, records=None):
</ins><span class="cx"> if isinstance(expression, MatchExpression):
</span><span class="cx"> try:
</span><del>- query = self._queryFromMatchExpression(expression)
</del><ins>+ query = self._queryFromMatchExpression(expression, recordTypes=recordTypes)
</ins><span class="cx"> return self._recordsFromQuery(query)
</span><span class="cx">
</span><span class="cx"> except QueryNotSupportedError:
</span><span class="lines">@@ -722,7 +704,7 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> @inlineCallbacks
</span><del>- def recordsFromCompoundExpression(self, expression, records=None):
</del><ins>+ def recordsFromCompoundExpression(self, expression, recordTypes=None, records=None):
</ins><span class="cx"> """
</span><span class="cx"> Returns records matching the CompoundExpression. Because the
</span><span class="cx"> local node doesn't perform Compound queries in a case insensitive
</span><span class="lines">@@ -733,13 +715,13 @@
</span><span class="cx"> """
</span><span class="cx">
</span><span class="cx"> try:
</span><del>- query = self._queryFromCompoundExpression(expression)
</del><ins>+ query = self._queryFromCompoundExpression(expression, recordTypes=recordTypes)
</ins><span class="cx">
</span><span class="cx"> except QueryNotSupportedError:
</span><span class="cx"> returnValue(
</span><span class="cx"> (
</span><span class="cx"> yield BaseDirectoryService.recordsFromCompoundExpression(
</span><del>- self, expression
</del><ins>+ self, expression, recordTypes=recordTypes
</ins><span class="cx"> )
</span><span class="cx"> )
</span><span class="cx"> )
</span><span class="lines">@@ -749,7 +731,7 @@
</span><span class="cx"> if self.localNode is not None:
</span><span class="cx">
</span><span class="cx"> localRecords = yield self.localRecordsFromCompoundExpression(
</span><del>- expression
</del><ins>+ expression, recordTypes=recordTypes
</ins><span class="cx"> )
</span><span class="cx"> for localRecord in localRecords:
</span><span class="cx"> if localRecord not in results:
</span><span class="lines">@@ -760,7 +742,7 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> @inlineCallbacks
</span><del>- def localRecordsFromCompoundExpression(self, expression):
</del><ins>+ def localRecordsFromCompoundExpression(self, expression, recordTypes=None):
</ins><span class="cx"> """
</span><span class="cx"> Takes a CompoundExpression, and recursively goes through each
</span><span class="cx"> MatchExpression, passing those specifically to the local node, and
</span><span class="lines">@@ -778,13 +760,13 @@
</span><span class="cx">
</span><span class="cx"> if isinstance(subExpression, CompoundExpression):
</span><span class="cx"> subRecords = yield self.localRecordsFromCompoundExpression(
</span><del>- subExpression
</del><ins>+ subExpression, recordTypes=recordTypes
</ins><span class="cx"> )
</span><span class="cx">
</span><span class="cx"> elif isinstance(subExpression, MatchExpression):
</span><span class="cx"> try:
</span><span class="cx"> subQuery = self._queryFromMatchExpression(
</span><del>- subExpression, local=True
</del><ins>+ subExpression, recordTypes=recordTypes, local=True
</ins><span class="cx"> )
</span><span class="cx"> except UnsupportedRecordTypeError:
</span><span class="cx"> continue
</span><span class="lines">@@ -857,7 +839,7 @@
</span><span class="cx"> try:
</span><span class="cx"> query = self._queryFromMatchExpression(
</span><span class="cx"> MatchExpression(self.fieldName.shortNames, shortName),
</span><del>- recordType=recordType
</del><ins>+ recordTypes=(recordType,)
</ins><span class="cx"> )
</span><span class="cx"> results = yield self._recordsFromQuery(query)
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>