<!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>[14114] twext/trunk/twext/who/ldap</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/14114">14114</a></dd>
<dt>Author</dt> <dd>sagen@apple.com</dd>
<dt>Date</dt> <dd>2014-10-28 11:07:22 -0700 (Tue, 28 Oct 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Support per recordType filters; work with new mockldap</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#twexttrunktwextwholdap_servicepy">twext/trunk/twext/who/ldap/_service.py</a></li>
<li><a href="#twexttrunktwextwholdaptesttest_servicepy">twext/trunk/twext/who/ldap/test/test_service.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="twexttrunktwextwholdap_servicepy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/ldap/_service.py (14113 => 14114)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/ldap/_service.py 2014-10-28 15:26:59 UTC (rev 14113)
+++ twext/trunk/twext/who/ldap/_service.py 2014-10-28 18:07:22 UTC (rev 14114)
</span><span class="lines">@@ -229,7 +229,7 @@
</span><span class="cx"> useTLS=False,
</span><span class="cx"> fieldNameToAttributesMap=DEFAULT_FIELDNAME_ATTRIBUTE_MAP,
</span><span class="cx"> recordTypeSchemas=DEFAULT_RECORDTYPE_SCHEMAS,
</span><del>- extraFilter=None,
</del><ins>+ extraFilters=None,
</ins><span class="cx"> ownThreadpool=True,
</span><span class="cx"> threadPoolMax=10,
</span><span class="cx"> connectionMax=10,
</span><span class="lines">@@ -267,9 +267,9 @@
</span><span class="cx"> @type recordTypeSchemas: mapping from L{NamedConstant} to
</span><span class="cx"> L{RecordTypeSchema}
</span><span class="cx">
</span><del>- @param extraFilter: An extra filter fragment to AND in to any generated
- queries.
- @type extraFilter: L{unicode}
</del><ins>+ @param extraFilters: A dict (keyed off recordType) of extra filter
+ fragments to AND in to any generated queries.
+ @type extraFilters: L{dicts} of L{unicode}
</ins><span class="cx">
</span><span class="cx"> """
</span><span class="cx">
</span><span class="lines">@@ -277,7 +277,7 @@
</span><span class="cx"> self._baseDN = baseDN
</span><span class="cx"> self._credentials = credentials
</span><span class="cx"> self._timeout = timeout
</span><del>- self._extraFilter = extraFilter
</del><ins>+ self._extraFilters = extraFilters
</ins><span class="cx">
</span><span class="cx"> if tlsCACertificateFile is None:
</span><span class="cx"> self._tlsCACertificateFile = None
</span><span class="lines">@@ -587,10 +587,10 @@
</span><span class="cx"> )
</span><span class="cx">
</span><span class="cx">
</span><del>- def _addExtraFilter(self, queryString):
- if self._extraFilter:
</del><ins>+ def _addExtraFilter(self, recordType, queryString):
+ if self._extraFilters and self._extraFilters.get(recordType, ""):
</ins><span class="cx"> queryString = "(&{extra}{query})".format(
</span><del>- extra=self._extraFilter, query=queryString
</del><ins>+ extra=self._extraFilters[recordType], query=queryString
</ins><span class="cx"> )
</span><span class="cx"> return queryString
</span><span class="cx">
</span><span class="lines">@@ -603,8 +603,6 @@
</span><span class="cx"> This method is always called in a thread.
</span><span class="cx"> """
</span><span class="cx">
</span><del>- queryString = self._addExtraFilter(queryString)
-
</del><span class="cx"> records = []
</span><span class="cx">
</span><span class="cx"> with DirectoryService.Connection(self) as connection:
</span><span class="lines">@@ -629,10 +627,11 @@
</span><span class="cx"> ldap.dn.str2dn(rdn.lower()) +
</span><span class="cx"> ldap.dn.str2dn(self._baseDN.lower())
</span><span class="cx"> )
</span><ins>+ filteredQuery=self._addExtraFilter(recordType, queryString)
</ins><span class="cx"> self.log.debug(
</span><span class="cx"> "Performing LDAP query: {rdn} {query} {recordType}{limit}{timeout}",
</span><span class="cx"> rdn=rdn,
</span><del>- query=queryString,
</del><ins>+ query=filteredQuery,
</ins><span class="cx"> recordType=recordType,
</span><span class="cx"> limit=" limit={}".format(limitResults) if limitResults else "",
</span><span class="cx"> timeout=" timeout={}".format(timeoutSeconds) if timeoutSeconds else "",
</span><span class="lines">@@ -642,7 +641,7 @@
</span><span class="cx"> s.startSearch(
</span><span class="cx"> ldap.dn.dn2str(rdn),
</span><span class="cx"> ldap.SCOPE_SUBTREE,
</span><del>- queryString,
</del><ins>+ filteredQuery,
</ins><span class="cx"> attrList=self._attributesToFetch,
</span><span class="cx"> timeout=timeoutSeconds if timeoutSeconds else -1,
</span><span class="cx"> sizelimit=limitResults if limitResults else 0
</span></span></pre></div>
<a id="twexttrunktwextwholdaptesttest_servicepy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/ldap/test/test_service.py (14113 => 14114)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/ldap/test/test_service.py 2014-10-28 15:26:59 UTC (rev 14113)
+++ twext/trunk/twext/who/ldap/test/test_service.py 2014-10-28 18:07:22 UTC (rev 14114)
</span><span class="lines">@@ -443,22 +443,28 @@
</span><span class="cx"> self.assertEquals(repr(service), u"<TestService u'ldap://localhost/'>")
</span><span class="cx">
</span><span class="cx">
</span><del>-class ExtraFilterTest(BaseTestCase, unittest.TestCase):
</del><ins>+class ExtraFiltersTest(BaseTestCase, unittest.TestCase):
</ins><span class="cx">
</span><del>- def test_extra(self):
- service = self.service(extraFilter="(foo=1)")
</del><ins>+ def test_extraFilters(self):
+ extraFilters = {
+ RecordType.user: "(foo=1)",
+ }
+ service = self.service(extraFilters=extraFilters)
</ins><span class="cx"> self.assertEquals(
</span><span class="cx"> "(&(foo=1)(bar=2))",
</span><del>- service._addExtraFilter("(bar=2)")
</del><ins>+ service._addExtraFilter(RecordType.user, "(bar=2)")
</ins><span class="cx"> )
</span><ins>+ self.assertEquals(
+ "(bar=2)",
+ service._addExtraFilter(RecordType.group, "(bar=2)")
+ )
</ins><span class="cx">
</span><del>- service = self.service(extraFilter=None)
</del><ins>+ service = self.service(extraFilters=None)
</ins><span class="cx"> self.assertEquals(
</span><span class="cx"> "(bar=2)",
</span><del>- service._addExtraFilter("(bar=2)")
</del><ins>+ service._addExtraFilter(RecordType.group, "(bar=2)")
</ins><span class="cx"> )
</span><span class="cx">
</span><del>-
</del><span class="cx"> class RecordsFromReplyTest(BaseTestCase, unittest.TestCase):
</span><span class="cx">
</span><span class="cx"> def test_boolean(self):
</span><span class="lines">@@ -548,6 +554,11 @@
</span><span class="cx"> return schema.attributes
</span><span class="cx">
</span><span class="cx"> else:
</span><ins>+
+ # mockldap requires data in this structure: {dn: {attr: [values]}}
+ if not isinstance(fieldValue, (tuple, list)):
+ fieldValue = [fieldValue]
+
</ins><span class="cx"> # Question: why convert to unicode? We get utf-8 encoded strings
</span><span class="cx"> # back from a real LDAP server, don't we?
</span><span class="cx"> value = toUnicode(fieldValue)
</span></span></pre>
</div>
</div>
</body>
</html>