<!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>[12162] twext/trunk/twext/who</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/12162">12162</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2013-12-19 18:31:41 -0800 (Thu, 19 Dec 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>recordsFromCompoundExpression() calls recordsFromExpression() instead of recordsFromNonCompoundExpression() so as to handle nested CompoundExpressions.
This means we need to add the records argument to recordsFromExpression()...</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#twexttrunktwextwhoaggregatepy">twext/trunk/twext/who/aggregate.py</a></li>
<li><a href="#twexttrunktwextwhodirectorypy">twext/trunk/twext/who/directory.py</a></li>
<li><a href="#twexttrunktwextwhoopendirectory_servicepy">twext/trunk/twext/who/opendirectory/_service.py</a></li>
<li><a href="#twexttrunktwextwhotesttest_directorypy">twext/trunk/twext/who/test/test_directory.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="twexttrunktwextwhoaggregatepy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/aggregate.py (12161 => 12162)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/aggregate.py        2013-12-20 02:06:01 UTC (rev 12161)
+++ twext/trunk/twext/who/aggregate.py        2013-12-20 02:31:41 UTC (rev 12162)
</span><span class="lines">@@ -78,10 +78,10 @@
</span><span class="cx"> return self._recordType
</span><span class="cx">
</span><span class="cx">
</span><del>- def recordsFromExpression(self, expression):
</del><ins>+ def recordsFromExpression(self, expression, records=None):
</ins><span class="cx"> ds = []
</span><span class="cx"> for service in self.services:
</span><del>- d = service.recordsFromExpression(expression)
</del><ins>+ d = service.recordsFromExpression(expression, records=records)
</ins><span class="cx"> ds.append(d)
</span><span class="cx">
</span><span class="cx"> def unwrapFirstError(f):
</span></span></pre></div>
<a id="twexttrunktwextwhodirectorypy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/directory.py (12161 => 12162)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/directory.py        2013-12-20 02:06:01 UTC (rev 12161)
+++ twext/trunk/twext/who/directory.py        2013-12-20 02:31:41 UTC (rev 12162)
</span><span class="lines">@@ -157,16 +157,27 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> @inlineCallbacks
</span><del>- def recordsFromCompoundExpression(self, expression):
</del><ins>+ def recordsFromCompoundExpression(self, expression, records=None):
</ins><span class="cx"> """
</span><span class="cx"> Finds records matching a compound expression.
</span><span class="cx">
</span><span class="cx"> @note: This method is called by L{recordsFromExpression} to handle
</span><span class="cx"> all L{CompoundExpression}s.
</span><span class="cx">
</span><ins>+ @note: This interface is the same as L{recordsFromExpression}, except
+ for the additional C{records} argument.
+
</ins><span class="cx"> @param expression: an expression to apply
</span><span class="cx"> @type expression: L{CompoundExpression}
</span><span class="cx">
</span><ins>+ @param records: a set of records to limit the search to. C{None} if
+ the whole directory should be searched.
+ This is provided by L{recordsFromExpression} when it has already
+ narrowed down results to a set of records.
+ That is, it's a performance optimization; ignoring this and
+ searching the entire directory will also work.
+ @type records: L{set} or L{frozenset}
+
</ins><span class="cx"> @return: The matching records.
</span><span class="cx"> @rtype: deferred iterable of L{IDirectoryRecord}s
</span><span class="cx">
</span><span class="lines">@@ -182,7 +193,7 @@
</span><span class="cx"> returnValue(())
</span><span class="cx">
</span><span class="cx"> results = set((
</span><del>- yield self.recordsFromNonCompoundExpression(subExpression)
</del><ins>+ yield self.recordsFromExpression(subExpression, records=records)
</ins><span class="cx"> ))
</span><span class="cx">
</span><span class="cx"> for subExpression in subExpressions:
</span><span class="lines">@@ -196,9 +207,8 @@
</span><span class="cx"> records = None
</span><span class="cx">
</span><span class="cx"> recordsMatchingExpression = frozenset((
</span><del>- yield self.recordsFromNonCompoundExpression(
- subExpression,
- records=records
</del><ins>+ yield self.recordsFromExpression(
+ subExpression, records=records
</ins><span class="cx"> )
</span><span class="cx"> ))
</span><span class="cx">
</span><span class="lines">@@ -214,16 +224,18 @@
</span><span class="cx"> returnValue(results)
</span><span class="cx">
</span><span class="cx">
</span><del>- @inlineCallbacks
- def recordsFromExpression(self, expression):
</del><ins>+ def recordsFromExpression(self, expression, records=None):
+ """
+ @note: This interface is the same as
+ L{IDirectoryService.recordsFromExpression}, except for the
+ additional C{records} argument.
+ """
</ins><span class="cx"> if isinstance(expression, CompoundExpression):
</span><del>- results = yield self.recordsFromCompoundExpression(expression)
</del><ins>+ return self.recordsFromCompoundExpression(expression)
</ins><span class="cx"> else:
</span><del>- results = yield self.recordsFromNonCompoundExpression(expression)
</del><ins>+ return self.recordsFromNonCompoundExpression(expression)
</ins><span class="cx">
</span><del>- returnValue(results)
</del><span class="cx">
</span><del>-
</del><span class="cx"> def recordsWithFieldValue(self, fieldName, value):
</span><span class="cx"> return self.recordsFromExpression(
</span><span class="cx"> MatchExpression(fieldName, value)
</span></span></pre></div>
<a id="twexttrunktwextwhoopendirectory_servicepy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/opendirectory/_service.py (12161 => 12162)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/opendirectory/_service.py        2013-12-20 02:06:01 UTC (rev 12161)
+++ twext/trunk/twext/who/opendirectory/_service.py        2013-12-20 02:31:41 UTC (rev 12162)
</span><span class="lines">@@ -532,7 +532,7 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx">
</span><del>- def recordsFromExpression(self, expression):
</del><ins>+ def recordsFromExpression(self, expression, records=None):
</ins><span class="cx"> """
</span><span class="cx"> @param expression: an expression to apply
</span><span class="cx"> @type expression: L{MatchExpression} or L{CompoundExpression}
</span></span></pre></div>
<a id="twexttrunktwextwhotesttest_directorypy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/test/test_directory.py (12161 => 12162)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/test/test_directory.py        2013-12-20 02:06:01 UTC (rev 12161)
+++ twext/trunk/twext/who/test/test_directory.py        2013-12-20 02:31:41 UTC (rev 12162)
</span><span class="lines">@@ -54,11 +54,11 @@
</span><span class="cx"> super(StubDirectoryService, self).__init__(realmName)
</span><span class="cx">
</span><span class="cx"> self.records = RecordStorage(self, DirectoryRecord)
</span><del>-
-
- def recordsFromExpression(self, expression):
</del><span class="cx"> self.seenExpressions = []
</span><span class="cx">
</span><ins>+
+ def recordsFromExpression(self, expression, records=None):
+ self.seenExpressions.append(expression)
</ins><span class="cx"> return (
</span><span class="cx"> super(StubDirectoryService, self)
</span><span class="cx"> .recordsFromExpression(expression)
</span><span class="lines">@@ -75,8 +75,6 @@
</span><span class="cx"> will match records that have an email address ending with the
</span><span class="cx"> given expression.
</span><span class="cx"> """
</span><del>- self.seenExpressions.append(expression)
-
</del><span class="cx"> if expression == u"None":
</span><span class="cx"> return succeed([])
</span><span class="cx">
</span><span class="lines">@@ -368,24 +366,24 @@
</span><span class="cx"> """
</span><span class="cx"> service = self.service()
</span><span class="cx">
</span><del>- result = yield service.recordsFromExpression(
- CompoundExpression(
- (
- u"twistedmatrix.com",
- u"None",
- u"calendarserver.org",
- ),
- Operand.AND
- )
</del><ins>+ compoundExpression = CompoundExpression(
+ (
+ u"twistedmatrix.com",
+ u"None",
+ u"calendarserver.org",
+ ),
+ Operand.AND
</ins><span class="cx"> )
</span><span class="cx">
</span><ins>+ result = yield service.recordsFromExpression(compoundExpression)
+
</ins><span class="cx"> self.assertEquals(
</span><span class="cx"> set(()),
</span><span class="cx"> set((record.uid for record in result))
</span><span class="cx"> )
</span><span class="cx">
</span><span class="cx"> self.assertEquals(
</span><del>- [u"twistedmatrix.com", u"None"],
</del><ins>+ [compoundExpression, u"twistedmatrix.com", u"None"],
</ins><span class="cx"> service.seenExpressions
</span><span class="cx"> )
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>