[CalendarServer-changes] [13649] twext/branches/users/sagen/recordtypes/twext/who
source_changes at macosforge.org
source_changes at macosforge.org
Tue Jun 17 14:55:05 PDT 2014
Revision: 13649
http://trac.calendarserver.org//changeset/13649
Author: sagen at apple.com
Date: 2014-06-17 14:55:05 -0700 (Tue, 17 Jun 2014)
Log Message:
-----------
Starting to add recordTypes arg
Modified Paths:
--------------
twext/branches/users/sagen/recordtypes/twext/who/aggregate.py
twext/branches/users/sagen/recordtypes/twext/who/directory.py
twext/branches/users/sagen/recordtypes/twext/who/idirectory.py
twext/branches/users/sagen/recordtypes/twext/who/index.py
twext/branches/users/sagen/recordtypes/twext/who/ldap/_service.py
twext/branches/users/sagen/recordtypes/twext/who/test/test_directory.py
twext/branches/users/sagen/recordtypes/twext/who/test/test_index.py
twext/branches/users/sagen/recordtypes/twext/who/test/test_xml.py
Modified: twext/branches/users/sagen/recordtypes/twext/who/aggregate.py
===================================================================
--- twext/branches/users/sagen/recordtypes/twext/who/aggregate.py 2014-06-17 19:13:35 UTC (rev 13648)
+++ twext/branches/users/sagen/recordtypes/twext/who/aggregate.py 2014-06-17 21:55:05 UTC (rev 13649)
@@ -108,9 +108,10 @@
return d
- def recordsFromExpression(self, expression, records=None):
+ def recordsFromExpression(self, expression, recordTypes=None, records=None):
return self._gatherFromSubServices(
- "recordsFromExpression", expression, records=None
+ "recordsFromExpression", expression, recordTypes=recordTypes,
+ records=None
)
Modified: twext/branches/users/sagen/recordtypes/twext/who/directory.py
===================================================================
--- twext/branches/users/sagen/recordtypes/twext/who/directory.py 2014-06-17 19:13:35 UTC (rev 13648)
+++ twext/branches/users/sagen/recordtypes/twext/who/directory.py 2014-06-17 21:55:05 UTC (rev 13649)
@@ -122,7 +122,9 @@
return self.recordType.iterconstants()
- def recordsFromNonCompoundExpression(self, expression, records=None):
+ def recordsFromNonCompoundExpression(
+ self, expression, recordTypes=None, records=None
+ ):
"""
Finds records matching a non-compound expression.
@@ -139,6 +141,10 @@
@param expression: an expression to apply
@type expression: L{object}
+ @param recordTypes: the record types to match
+ @type recordTypes: an iterable of L{NamedConstant}, or None for no
+ filtering
+
@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
@@ -165,7 +171,9 @@
@inlineCallbacks
- def recordsFromCompoundExpression(self, expression, records=None):
+ def recordsFromCompoundExpression(
+ self, expression, recordTypes=None, records=None
+ ):
"""
Finds records matching a compound expression.
@@ -178,6 +186,10 @@
@param expression: an expression to apply
@type expression: L{CompoundExpression}
+ @param recordTypes: the record types to match
+ @type recordTypes: an iterable of L{NamedConstant}, or None for no
+ filtering
+
@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
@@ -201,7 +213,9 @@
returnValue(())
results = set((
- yield self.recordsFromExpression(subExpression, records=records)
+ yield self.recordsFromExpression(
+ subExpression, recordTypes=recordTypes, records=records
+ )
))
for subExpression in subExpressions:
@@ -216,7 +230,7 @@
recordsMatchingExpression = frozenset((
yield self.recordsFromExpression(
- subExpression, records=records
+ subExpression, recordTypes=recordTypes, records=records
)
))
@@ -232,16 +246,20 @@
returnValue(results)
- def recordsFromExpression(self, expression, records=None):
+ def recordsFromExpression(self, expression, recordTypes=None, records=None):
"""
@note: This interface is the same as
L{IDirectoryService.recordsFromExpression}, except for the
additional C{records} argument.
"""
if isinstance(expression, CompoundExpression):
- return self.recordsFromCompoundExpression(expression)
+ return self.recordsFromCompoundExpression(
+ expression, recordTypes=recordTypes
+ )
else:
- return self.recordsFromNonCompoundExpression(expression)
+ return self.recordsFromNonCompoundExpression(
+ expression, recordTypes=recordTypes
+ )
def recordsWithFieldValue(self, fieldName, value):
Modified: twext/branches/users/sagen/recordtypes/twext/who/idirectory.py
===================================================================
--- twext/branches/users/sagen/recordtypes/twext/who/idirectory.py 2014-06-17 19:13:35 UTC (rev 13648)
+++ twext/branches/users/sagen/recordtypes/twext/who/idirectory.py 2014-06-17 21:55:05 UTC (rev 13649)
@@ -278,13 +278,17 @@
"""
- def recordsFromExpression(expression):
+ def recordsFromExpression(expression, recordTypes=None):
"""
Find records matching an expression.
@param expression: an expression to apply
@type expression: L{object}
+ @param recordTypes: the record types to match
+ @type recordTypes: an iterable of L{NamedConstant}, or None for no
+ filtering
+
@return: The matching records.
@rtype: deferred iterable of L{IDirectoryRecord}s
Modified: twext/branches/users/sagen/recordtypes/twext/who/index.py
===================================================================
--- twext/branches/users/sagen/recordtypes/twext/who/index.py 2014-06-17 19:13:35 UTC (rev 13648)
+++ twext/branches/users/sagen/recordtypes/twext/who/index.py 2014-06-17 21:55:05 UTC (rev 13649)
@@ -226,7 +226,9 @@
self._index = index
- def indexedRecordsFromMatchExpression(self, expression, records=None):
+ def indexedRecordsFromMatchExpression(
+ self, expression, recordTypes=None, records=None
+ ):
"""
Finds records in the internal indexes matching a single expression.
@@ -286,10 +288,17 @@
# if records is not None:
# matchingRecords &= records
+ if recordTypes is not None:
+ for record in list(matchingRecords):
+ if record.recordType not in recordTypes:
+ matchingRecords.remove(record)
+
return succeed(matchingRecords)
- def unIndexedRecordsFromMatchExpression(self, expression, records=None):
+ def unIndexedRecordsFromMatchExpression(
+ self, expression, recordTypes=None, records=None
+ ):
"""
Finds records not in the internal indexes matching a single expression.
@@ -312,6 +321,11 @@
)
for record in records:
+
+ if recordTypes is not None:
+ if record.recordType not in recordTypes:
+ continue
+
fieldValues = record.fields.get(expression.fieldName, None)
if fieldValues is None:
@@ -324,7 +338,9 @@
return succeed(result)
- def recordsFromNonCompoundExpression(self, expression, records=None):
+ def recordsFromNonCompoundExpression(
+ self, expression, recordTypes=None, records=None
+ ):
"""
This implementation can handle L{MatchExpression} expressions; other
expressions are passed up to the superclass.
@@ -332,15 +348,15 @@
if isinstance(expression, MatchExpression):
if expression.fieldName in self.indexedFields:
return self.indexedRecordsFromMatchExpression(
- expression, records=records
+ expression, recordTypes=recordTypes, records=records
)
else:
return self.unIndexedRecordsFromMatchExpression(
- expression, records=records
+ expression, recordTypes=recordTypes, records=records
)
else:
return BaseDirectoryService.recordsFromNonCompoundExpression(
- self, expression, records=records
+ self, expression, recordTypes=recordTypes, records=records
)
Modified: twext/branches/users/sagen/recordtypes/twext/who/ldap/_service.py
===================================================================
--- twext/branches/users/sagen/recordtypes/twext/who/ldap/_service.py 2014-06-17 19:13:35 UTC (rev 13648)
+++ twext/branches/users/sagen/recordtypes/twext/who/ldap/_service.py 2014-06-17 21:55:05 UTC (rev 13649)
@@ -408,7 +408,7 @@
@inlineCallbacks
- def _recordsFromQueryString(self, queryString):
+ def _recordsFromQueryString(self, queryString, recordTypes=None):
connection = yield self._connect()
self.log.info("Performing LDAP query: {query}", query=queryString)
@@ -428,7 +428,7 @@
)
raise LDAPQueryError("Unable to perform query", e)
- records = yield self._recordsFromReply(reply)
+ records = yield self._recordsFromReply(reply, recordTypes=recordTypes)
returnValue(records)
@@ -455,7 +455,7 @@
returnValue(None)
- def _recordsFromReply(self, reply):
+ def _recordsFromReply(self, reply, recordTypes=None):
records = []
for dn, recordData in reply:
@@ -474,6 +474,9 @@
)
continue
+ if recordTypes is not None and recordType not in recordTypes:
+ continue
+
# Populate a fields dictionary
fields = {}
@@ -527,20 +530,26 @@
return records
- def recordsFromNonCompoundExpression(self, expression, records=None):
+ def recordsFromNonCompoundExpression(
+ self, expression, recordTypes=None, records=None
+ ):
if isinstance(expression, MatchExpression):
queryString = ldapQueryStringFromMatchExpression(
expression,
self._fieldNameToAttributesMap, self._recordTypeSchemas
)
- return self._recordsFromQueryString(queryString)
+ return self._recordsFromQueryString(
+ queryString, recordTypes=recordTypes
+ )
return BaseDirectoryService.recordsFromNonCompoundExpression(
self, expression, records=records
)
- def recordsFromCompoundExpression(self, expression, records=None):
+ def recordsFromCompoundExpression(
+ self, expression, recordTypes=None, records=None
+ ):
if not expression.expressions:
return succeed(())
@@ -548,7 +557,9 @@
expression,
self._fieldNameToAttributesMap, self._recordTypeSchemas
)
- return self._recordsFromQueryString(queryString)
+ return self._recordsFromQueryString(
+ queryString, recordTypes=recordTypes
+ )
# def updateRecords(self, records, create=False):
Modified: twext/branches/users/sagen/recordtypes/twext/who/test/test_directory.py
===================================================================
--- twext/branches/users/sagen/recordtypes/twext/who/test/test_directory.py 2014-06-17 19:13:35 UTC (rev 13648)
+++ twext/branches/users/sagen/recordtypes/twext/who/test/test_directory.py 2014-06-17 21:55:05 UTC (rev 13649)
@@ -62,15 +62,17 @@
self.seenExpressions = []
- def recordsFromExpression(self, expression, records=None):
+ def recordsFromExpression(self, expression, recordTypes=None, records=None):
self.seenExpressions.append(expression)
return (
super(StubDirectoryService, self)
- .recordsFromExpression(expression)
+ .recordsFromExpression(expression, recordTypes=recordTypes)
)
- def recordsFromNonCompoundExpression(self, expression, records=None):
+ def recordsFromNonCompoundExpression(
+ self, expression, recordTypes=None, records=None
+ ):
"""
This implementation handles three expressions:
@@ -94,7 +96,9 @@
return (
super(StubDirectoryService, self)
- .recordsFromNonCompoundExpression(expression, records=records)
+ .recordsFromNonCompoundExpression(
+ expression, recordTypes=recordTypes, records=records
+ )
)
@@ -1149,7 +1153,23 @@
],
)
+ self.addGroup(
+ shortNames=[u"calendar-dev"],
+ fullNames=[u"Calendar Developers"],
+ emailAddresses=[
+ u"calendar-dev at example.com",
+ ],
+ )
+ self.addGroup(
+ shortNames=[u"developers"],
+ fullNames=[u"Developers"],
+ emailAddresses=[
+ u"developers at example.com",
+ ],
+ )
+
+
def addUser(self, shortNames, fullNames, emailAddresses=[]):
"""
Add a user record with the given field information.
@@ -1177,6 +1197,32 @@
}))
+ def addGroup(self, shortNames, fullNames, emailAddresses=[]):
+ """
+ Add a group record with the given field information.
+
+ @param shortNames: Record short names.
+ @type shortNames: L{list} of L{unicode}s
+
+ @param fullNames: Record full names.
+ @type fullNames: L{list} of L{unicode}s
+
+ @param emailAddresses: Record email addresses.
+ @type emailAddresses: L{list} of L{unicode}s
+ """
+ service = self.service
+ fieldName = service.fieldName
+ recordType = service.recordType
+
+ self.records.append(self.recordClass(self.service, {
+ fieldName.recordType: recordType.group,
+ fieldName.uid: u"__{0}__".format(shortNames[0]),
+ fieldName.shortNames: shortNames,
+ fieldName.fullNames: fullNames,
+ fieldName.emailAddresses: emailAddresses,
+ }))
+
+
def __iter__(self):
return iter(self.records)
Modified: twext/branches/users/sagen/recordtypes/twext/who/test/test_index.py
===================================================================
--- twext/branches/users/sagen/recordtypes/twext/who/test/test_index.py 2014-06-17 19:13:35 UTC (rev 13648)
+++ twext/branches/users/sagen/recordtypes/twext/who/test/test_index.py 2014-06-17 21:55:05 UTC (rev 13649)
@@ -149,6 +149,7 @@
@inlineCallbacks
def _test_indexedRecordsFromMatchExpression(
self, inOut, matchType, fieldName=BaseFieldName.shortNames,
+ recordTypes=None
):
service = self.noLoadServicePopulated()
@@ -157,7 +158,8 @@
MatchExpression(
fieldName, subString,
matchType
- )
+ ),
+ recordTypes=recordTypes,
)
self.assertEquals(
set((record.uid for record in records)),
@@ -238,9 +240,25 @@
self.assertFailure(result, NotImplementedError)
+ def test_indexedRecordsFromMatchExpression_recordTypes(self):
+ """
+ L{DirectoryService.indexedRecordsFromMatchExpression} with recordTypes
+ """
+ return self._test_indexedRecordsFromMatchExpression(
+ (
+ (u"c", (u"__calendar-dev__",)), # only groups
+ (u"d", (u"__developers__",)),
+ (u"j", ()),
+ ),
+ MatchType.startsWith,
+ recordTypes=(BaseRecordType.group,)
+ )
+
+
@inlineCallbacks
def _test_unIndexedRecordsFromMatchExpression(
self, inOut, matchType, fieldName=BaseFieldName.fullNames,
+ recordTypes=None
):
service = self.noLoadServicePopulated()
@@ -249,7 +267,8 @@
MatchExpression(
fieldName, subString,
matchType
- )
+ ),
+ recordTypes=recordTypes
)
self.assertEquals(
set((record.uid for record in records)),
Modified: twext/branches/users/sagen/recordtypes/twext/who/test/test_xml.py
===================================================================
--- twext/branches/users/sagen/recordtypes/twext/who/test/test_xml.py 2014-06-17 19:13:35 UTC (rev 13648)
+++ twext/branches/users/sagen/recordtypes/twext/who/test/test_xml.py 2014-06-17 21:55:05 UTC (rev 13649)
@@ -557,7 +557,28 @@
self.assertRecords(records, (u"__wsanchez__",))
+ @inlineCallbacks
+ def test_queryWithRecordTypes(self):
+ """
+ Verify that results are limited to the requested recordTypes
+ """
+ service = self.service()
+ records = yield service.recordsFromExpression(
+ service.query(
+ u"fullNames", u"e",
+ matchType=MatchType.contains,
+ ),
+ recordTypes=(service.recordType.group,)
+ )
+ # Note: only contains groups; the users that would normally match
+ # have been filtered out
+ self.assertRecords(
+ records,
+ (u"__calendar-dev__", u"__developers__", u"__twisted__")
+ )
+
+
class DirectoryServiceMutableTestMixIn(object):
@inlineCallbacks
def test_updateRecord(self):
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20140617/d34e3922/attachment-0001.html>
More information about the calendarserver-changes
mailing list