<!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>[15040] 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/15040">15040</a></dd>
<dt>Author</dt> <dd>sagen@apple.com</dd>
<dt>Date</dt> <dd>2015-08-14 19:13:52 -0700 (Fri, 14 Aug 2015)</dd>
</dl>
<h3>Log Message</h3>
<pre>Allow multiple LDAP attributes to be the source for a single record field</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 (15039 => 15040)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/ldap/_service.py 2015-08-13 17:14:58 UTC (rev 15039)
+++ twext/trunk/twext/who/ldap/_service.py 2015-08-15 02:13:52 UTC (rev 15040)
</span><span class="lines">@@ -776,74 +776,68 @@
</span><span class="cx"> # Populate a fields dictionary
</span><span class="cx"> fields = {}
</span><span class="cx">
</span><del>- for attribute, values in recordData.iteritems():
- fieldNames = self._attributeToFieldNameMap.get(attribute, ())
- for fieldName in fieldNames:
- attributeRules = self._fieldNameToAttributesMap[fieldName]
</del><ins>+ for fieldName, attributeRules in self._fieldNameToAttributesMap.iteritems():
+ valueType = self.fieldName.valueType(fieldName)
</ins><span class="cx">
</span><del>- if fieldName is None:
- # self.log.debug(
- # "Unmapped LDAP attribute {attribute!r} in record "
- # "data: {recordData!r}",
- # attribute=attribute, recordData=recordData,
- # )
- continue
</del><ins>+ for attributeRule in attributeRules:
+ attributeName = attributeRule.split(":")[0]
+ if attributeName in recordData:
+ values = recordData[attributeName]
</ins><span class="cx">
</span><del>- valueType = self.fieldName.valueType(fieldName)
</del><ins>+ if valueType in (unicode, UUID):
+ if not isinstance(values, list):
+ values = [values]
</ins><span class="cx">
</span><del>- if valueType in (unicode, UUID):
- if not isinstance(values, list):
- values = [values]
</del><ins>+ if valueType is unicode:
+ newValues = []
+ for v in values:
+ if isinstance(v, unicode):
+ # because the ldap unit test produces
+ # unicode values (?)
+ newValues.append(v)
+ else:
+ newValues.append(unicode(v, "utf-8"))
+ else:
+ try:
+ newValues = [valueType(v) for v in values]
+ except Exception, e:
+ self.log.warn(
+ "Can't parse value {name} {values} ({error})",
+ name=fieldName, values=values, error=str(e)
+ )
+ continue
</ins><span class="cx">
</span><del>- if valueType is unicode:
- newValues = []
- for v in values:
- if isinstance(v, unicode):
- # because the ldap unit test produces
- # unicode values (?)
- newValues.append(v)
</del><ins>+ if self.fieldName.isMultiValue(fieldName):
+ if fieldName in fields:
+ fields[fieldName].extend(newValues)
</ins><span class="cx"> else:
</span><del>- newValues.append(unicode(v, "utf-8"))
- else:
- try:
- newValues = [valueType(v) for v in values]
- except Exception, e:
- self.log.warn(
- "Can't parse value {name} {values} ({error})",
- name=fieldName, values=values, error=str(e)
- )
- continue
</del><ins>+ fields[fieldName] = newValues
+ else:
+ # First one in the list wins
+ if fieldName not in fields:
+ fields[fieldName] = newValues[0]
</ins><span class="cx">
</span><del>- if self.fieldName.isMultiValue(fieldName):
- fields[fieldName] = newValues
- else:
- fields[fieldName] = newValues[0]
</del><ins>+ elif valueType is bool:
+ if not isinstance(values, list):
+ values = [values]
+ if ":" in attributeRule:
+ ignored, trueValue = attributeRule.split(":")
+ else:
+ trueValue = "true"
</ins><span class="cx">
</span><del>- elif valueType is bool:
- if not isinstance(values, list):
- values = [values]
</del><ins>+ for value in values:
+ if value == trueValue:
+ fields[fieldName] = True
+ break
+ else:
+ fields[fieldName] = False
</ins><span class="cx">
</span><ins>+ elif issubclass(valueType, Names):
+ if not isinstance(values, list):
+ values = [values]
</ins><span class="cx">
</span><del>- rule = attributeRules[0] # there is only one true value
- if ":" in rule:
- ignored, trueValue = rule.split(":")
- else:
- trueValue = "true"
</del><ins>+ attribute, attributeValue, fieldValue = attributeRule.split(":")
</ins><span class="cx">
</span><del>- for value in values:
- if value == trueValue:
- fields[fieldName] = True
- break
- else:
- fields[fieldName] = False
-
- elif issubclass(valueType, Names):
- if not isinstance(values, list):
- values = [values]
-
- for rule in attributeRules:
- attribute, attributeValue, fieldValue = rule.split(":")
-
</del><span class="cx"> for value in values:
</span><span class="cx"> if value == attributeValue:
</span><span class="cx"> # convert to a constant
</span><span class="lines">@@ -854,12 +848,12 @@
</span><span class="cx"> pass
</span><span class="cx"> break
</span><span class="cx">
</span><del>- else:
- raise LDAPConfigurationError(
- "Unknown value type {0} for field {1}".format(
- valueType, fieldName
</del><ins>+ else:
+ raise LDAPConfigurationError(
+ "Unknown value type {0} for field {1}".format(
+ valueType, fieldName
+ )
</ins><span class="cx"> )
</span><del>- )
</del><span class="cx">
</span><span class="cx"> # Skip any results missing the uid, which is a required field
</span><span class="cx"> if self.fieldName.uid not in fields:
</span></span></pre></div>
<a id="twexttrunktwextwholdaptesttest_servicepy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/ldap/test/test_service.py (15039 => 15040)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/ldap/test/test_service.py 2015-08-13 17:14:58 UTC (rev 15039)
+++ twext/trunk/twext/who/ldap/test/test_service.py 2015-08-15 02:13:52 UTC (rev 15040)
</span><span class="lines">@@ -121,8 +121,10 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> TEST_FIELDNAME_MAP = dict(DEFAULT_FIELDNAME_ATTRIBUTE_MAP)
</span><del>-TEST_FIELDNAME_MAP[BaseFieldName.uid] = (u"__who_uid__",)
</del><ins>+TEST_FIELDNAME_MAP[BaseFieldName.uid] = (u"__who_uid__", u"altuid")
</ins><span class="cx">
</span><ins>+TEST_FIELDNAME_MAP[BaseFieldName.fullNames] = (u"altname", u"cn")
+
</ins><span class="cx"> TEST_FIELDNAME_MAP[TestFieldName.multiChoice] = (
</span><span class="cx"> u"testField:One:one",
</span><span class="cx"> u"testField:Two:two",
</span><span class="lines">@@ -524,6 +526,61 @@
</span><span class="cx"> self.assertFalse(service.fieldName.multiChoice in records[1].fields)
</span><span class="cx">
</span><span class="cx">
</span><ins>+ def test_multipleAttributes(self):
+ """
+ Multiple LDAP attributes can be the source for a single record field.
+ If it's a single-value field, the *first* attribute in the map that
+ is in the results will be used for the field value. If it's a multi
+ value field, then the value will be a list extended from the values
+ in each associated LDAP attribute, in the order of the map entry.
+
+ For example, in the test map above, the uid field is mapped to __who_uid__
+ and altuid in that order. When the LDAP results are parsed, the __who_uid__
+ attribute is checked first, and if it has a value it is used; otherwise
+ the value from altuid would be used.
+
+ In the case of "fullNames" which is multi-value, because the order in the test
+ map is "altname" then "cn", when the LDAP results are parsed, fullNames
+ will end up being set to a list comprising of first the altname values
+ then the cn values.
+ """
+ service = self.service()
+ reply = (
+ (
+ "dn",
+ {
+ "__who_uid__": u"zero",
+ "altuid": u"altzero",
+ "cn": [u"cn-name", "another-cn"],
+ "altname": [u"alt-name", "another-alt"],
+ }
+ ),
+ (
+ "dn",
+ {
+ "altuid": u"one",
+ "altname": [u"alt-name"],
+ "cn": [u"cn-name"],
+ }
+ ),
+ (
+ "dn",
+ {
+ "__who_uid__": u"two",
+ "cn": [u"cn-name"],
+ }
+ ),
+ )
+ records = service._recordsFromReply(reply, recordType=RecordType.user)
+
+ self.assertEquals(records[0].uid, "zero")
+ self.assertEquals(records[0].fullNames, ["alt-name", "another-alt", "cn-name", "another-cn"])
+ self.assertEquals(records[1].uid, "one")
+ self.assertEquals(records[1].fullNames, ["alt-name", "cn-name"])
+ self.assertEquals(records[2].uid, "two")
+ self.assertEquals(records[2].fullNames, ["cn-name"])
+
+
</ins><span class="cx"> def mockDirectoryDataFromXMLService(service):
</span><span class="cx"> dc0 = u"org"
</span><span class="cx"> dc1 = u"calendarserver"
</span></span></pre>
</div>
</div>
</body>
</html>