<!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>[12122] twext/trunk/twext/who/opendirectory</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/12122">12122</a></dd>
<dt>Author</dt> <dd>sagen@apple.com</dd>
<dt>Date</dt> <dd>2013-12-17 14:15:26 -0800 (Tue, 17 Dec 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Adds support for compound expressions in OD</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#twexttrunktwextwhoopendirectoryservicepy">twext/trunk/twext/who/opendirectory/service.py</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#twexttrunktwextwhoopendirectorytesttest_servicepy">twext/trunk/twext/who/opendirectory/test/test_service.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="twexttrunktwextwhoopendirectoryservicepy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/opendirectory/service.py (12121 => 12122)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/opendirectory/service.py 2013-12-17 19:25:31 UTC (rev 12121)
+++ twext/trunk/twext/who/opendirectory/service.py 2013-12-17 22:15:26 UTC (rev 12122)
</span><span class="lines">@@ -1,4 +1,4 @@
</span><del>-# -*- test-case-name: twext.who.test.test_util -*-
</del><ins>+# -*- test-case-name: twext.who.opendirectory.test.test_service -*-
</ins><span class="cx"> ##
</span><span class="cx"> # Copyright (c) 2013 Apple Inc. All rights reserved.
</span><span class="cx"> #
</span><span class="lines">@@ -328,6 +328,87 @@
</span><span class="cx"> self._node = node
</span><span class="cx">
</span><span class="cx">
</span><ins>+ def _queryStringFromExpression(self, expression):
+ """
+ Converts either a MatchExpression or a CompoundExpression into a native
+ OpenDirectory query string.
+
+ @param expression: The expression
+ @type expression: Either L{MatchExpression} or L{CompoundExpression}
+
+ @return: A native OpenDirectory query string
+ @rtype: C{unicode}
+ """
+
+ if isinstance(expression, MatchExpression):
+ matchType = ODMatchType.fromMatchType(expression.matchType)
+ if matchType is None:
+ raise QueryNotSupportedError(
+ "Unknown match type: {0}".format(matchType)
+ )
+ odAttr = ODAttribute.fromFieldName(expression.fieldName).value
+ queryString = {
+ ODMatchType.equals.value : u"(%s=%s)",
+ ODMatchType.startsWith.value : u"(%s=%s*)",
+ ODMatchType.endsWith.value : u"(%s=*%s)",
+ ODMatchType.contains.value : u"(%s=*%s*)",
+ ODMatchType.lessThan.value : u"(%s<%s)",
+ ODMatchType.greaterThan.value : u"(%s>%s)",
+ }.get(matchType.value, u"(%s=*%s*)") % (odAttr, expression.fieldValue,)
+
+ elif isinstance(expression, CompoundExpression):
+ queryString = u""
+ operand = u"&" if expression.operand is Operand.AND else u"|"
+ if len(expression.expressions) > 1:
+ queryString += u"("
+ queryString += operand
+ for subExpression in expression.expressions:
+ queryString += self._queryStringFromExpression(subExpression)
+ if len(expression.expressions) > 1:
+ queryString += u")"
+
+ return queryString
+
+
+ def _queryFromCompoundExpression(self, expression):
+ """
+ Form an OpenDirectory query from a compound expression.
+
+ @param expression: The compound expression.
+ @type expression: L{CompoundExpression}
+
+ @return: A native OpenDirectory query.
+ @rtype: L{ODQuery}
+ """
+
+ queryString = self._queryStringFromExpression(expression)
+
+ recordTypes = [t.value for t in ODRecordType.iterconstants()]
+ attributes = [a.value for a in ODAttribute.iterconstants()]
+ maxResults = 0
+
+ query, error = ODQuery.queryWithNode_forRecordTypes_attribute_matchType_queryValues_returnAttributes_maximumResults_error_(
+ self.node,
+ recordTypes,
+ None,
+ 0x210B, # kODMatchCompoundExpression
+ queryString,
+ attributes,
+ maxResults,
+ None
+ )
+
+ if error:
+ self.log.error(
+ "Error while forming OpenDirectory query: {error}",
+ error=error
+ )
+ raise OpenDirectoryQueryError(error)
+
+ return query
+
+
+
</ins><span class="cx"> def _queryFromMatchExpression(self, expression):
</span><span class="cx"> """
</span><span class="cx"> Form an OpenDirectory query from a match expression.
</span><span class="lines">@@ -447,6 +528,7 @@
</span><span class="cx"> @return: The records produced by executing the query.
</span><span class="cx"> @rtype: iterable of L{DirectoryRecord}
</span><span class="cx"> """
</span><ins>+
</ins><span class="cx"> odRecords, error = query.resultsAllowingPartial_error_(False, None)
</span><span class="cx">
</span><span class="cx"> if error:
</span><span class="lines">@@ -460,12 +542,11 @@
</span><span class="cx"> yield self._adaptODRecord(odRecord)
</span><span class="cx">
</span><span class="cx">
</span><del>- def recordsFromMatchExpression(self, expression):
</del><ins>+
+ def recordsFromExpression(self, expression):
</ins><span class="cx"> """
</span><del>- Find records matching a match expression.
-
</del><span class="cx"> @param expression: an expression to apply
</span><del>- @type expression: L{MatchExpression}
</del><ins>+ @type expression: L{MatchExpression} or L{CompoundExpression}
</ins><span class="cx">
</span><span class="cx"> @return: The matching records.
</span><span class="cx"> @rtype: deferred iterable of L{IDirectoryRecord}s
</span><span class="lines">@@ -473,16 +554,15 @@
</span><span class="cx"> @raises: L{QueryNotSupportedError} if the expression is not
</span><span class="cx"> supported by this directory service.
</span><span class="cx"> """
</span><del>- query = self._queryFromMatchExpression(expression)
- return self._recordsFromQuery(query)
</del><span class="cx">
</span><del>-
- def recordsFromExpression(self, expression):
</del><span class="cx"> try:
</span><span class="cx"> if isinstance(expression, CompoundExpression):
</span><del>- raise NotImplementedError(Operand)
</del><ins>+ query = self._queryFromCompoundExpression(expression)
+ return self._recordsFromQuery(query)
+
</ins><span class="cx"> elif isinstance(expression, MatchExpression):
</span><del>- return self.recordsFromMatchExpression(expression)
</del><ins>+ query = self._queryFromMatchExpression(expression)
+ return self._recordsFromQuery(query)
</ins><span class="cx">
</span><span class="cx"> except QueryNotSupportedError:
</span><span class="cx"> pass
</span></span></pre></div>
<a id="twexttrunktwextwhoopendirectorytesttest_servicepy"></a>
<div class="addfile"><h4>Added: twext/trunk/twext/who/opendirectory/test/test_service.py (0 => 12122)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/opendirectory/test/test_service.py (rev 0)
+++ twext/trunk/twext/who/opendirectory/test/test_service.py 2013-12-17 22:15:26 UTC (rev 12122)
</span><span class="lines">@@ -0,0 +1,67 @@
</span><ins>+##
+# Copyright (c) 2013 Apple Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+##
+
+"""
+OpenDirectory service tests.
+"""
+
+from twisted.trial import unittest
+from twext.who.opendirectory import DirectoryService
+from twext.who.expression import (
+ CompoundExpression, MatchExpression, MatchType, Operand
+)
+
+
+
+
+
+class OpenDirectoryServiceTestCase(unittest.TestCase):
+ """
+ Tests for L{DirectoryService}.
+ """
+
+ def test_queryFromExpression(self):
+ service = DirectoryService()
+ expression = MatchExpression(
+ service.fieldName.shortNames, u"xyzzy",
+ matchType=MatchType.equals
+ )
+ query = service._queryStringFromExpression(expression)
+ self.assertEquals(query, u"(dsAttrTypeStandard:RecordName=xyzzy)")
+
+ expression = CompoundExpression(
+ [
+ MatchExpression(
+ service.fieldName.shortNames, u"xyzzy",
+ matchType=MatchType.contains
+ ),
+ MatchExpression(
+ service.fieldName.emailAddresses, u"plugh",
+ matchType=MatchType.startsWith
+ ),
+ MatchExpression(
+ service.fieldName.fullNames, u"foo",
+ matchType=MatchType.equals
+ ),
+ ],
+ Operand.AND
+ )
+ query = service._queryStringFromExpression(expression)
+ self.assertEquals(query,
+ u"(&(dsAttrTypeStandard:RecordName=*xyzzy*)"
+ "(dsAttrTypeStandard:EMailAddress=plugh*)"
+ "(dsAttrTypeStandard:RealName=foo))"
+ )
</ins></span></pre>
</div>
</div>
</body>
</html>