<!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>[13491] 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/13491">13491</a></dd>
<dt>Author</dt> <dd>sagen@apple.com</dd>
<dt>Date</dt> <dd>2014-05-16 12:51:07 -0700 (Fri, 16 May 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Allow suppression of system records from OpenDirectory service</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#twexttrunktwextwhoopendirectory_constantspy">twext/trunk/twext/who/opendirectory/_constants.py</a></li>
<li><a href="#twexttrunktwextwhoopendirectory_servicepy">twext/trunk/twext/who/opendirectory/_service.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="twexttrunktwextwhoopendirectory_constantspy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/opendirectory/_constants.py (13490 => 13491)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/opendirectory/_constants.py 2014-05-16 18:35:25 UTC (rev 13490)
+++ twext/trunk/twext/who/opendirectory/_constants.py 2014-05-16 19:51:07 UTC (rev 13491)
</span><span class="lines">@@ -172,6 +172,11 @@
</span><span class="cx"> nestedGroups = ValueConstant(u"dsAttrTypeStandard:NestedGroups")
</span><span class="cx"> nestedGroups.fieldName = FieldName.nestedGroupsUIDs
</span><span class="cx">
</span><ins>+ # For determining whether it's a system record
+ uniqueId = ValueConstant(u"dsAttrTypeStandard:UniqueID")
+ primaryGroupId = ValueConstant(u"dsAttrTypeStandard:PrimaryGroupID")
+ isHidden = ValueConstant(u"dsAttrTypeNative:IsHidden")
+
</ins><span class="cx"> # # Single value fields
</span><span class="cx"> # AdminLimits = ValueConstant(u"dsAttrTypeStandard:AdminLimits")
</span><span class="cx"> # AppleAliasData = ValueConstant(u"dsAttrTypeStandard:AppleAliasData")
</span><span class="lines">@@ -230,7 +235,6 @@
</span><span class="cx"> # PresetUserIsAdmin = ValueConstant(u"dsAttrTypeStandard:PresetUserIsAdmin")
</span><span class="cx"> # PrimaryComputerGUID = ValueConstant(u"dsAttrTypeStandard:PrimaryComputerGUID")
</span><span class="cx"> # PrimaryComputerList = ValueConstant(u"dsAttrTypeStandard:PrimaryComputerList")
</span><del>- # PrimaryGroupID = ValueConstant(u"dsAttrTypeStandard:PrimaryGroupID")
</del><span class="cx"> # Printer1284DeviceID = ValueConstant(u"dsAttrTypeStandard:Printer1284DeviceID")
</span><span class="cx"> # PrinterLPRHost = ValueConstant(u"dsAttrTypeStandard:PrinterLPRHost")
</span><span class="cx"> # PrinterLPRQueue = ValueConstant(u"dsAttrTypeStandard:PrinterLPRQueue")
</span><span class="lines">@@ -263,7 +267,6 @@
</span><span class="cx"> # SetupAssistantLocation = ValueConstant(u"dsAttrTypeStandard:SetupAssistantLocation")
</span><span class="cx"> # Occupation = ValueConstant(u"dsAttrTypeStandard:Occupation")
</span><span class="cx"> # TimeToLive = ValueConstant(u"dsAttrTypeStandard:TimeToLive")
</span><del>- # UniqueID = ValueConstant(u"dsAttrTypeStandard:UniqueID")
</del><span class="cx"> # UserCertificate = ValueConstant(u"dsAttrTypeStandard:UserCertificate")
</span><span class="cx"> # UserPKCS12Data = ValueConstant(u"dsAttrTypeStandard:UserPKCS12Data")
</span><span class="cx"> # UserShell = ValueConstant(u"dsAttrTypeStandard:UserShell")
</span></span></pre></div>
<a id="twexttrunktwextwhoopendirectory_servicepy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/opendirectory/_service.py (13490 => 13491)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/opendirectory/_service.py 2014-05-16 18:35:25 UTC (rev 13490)
+++ twext/trunk/twext/who/opendirectory/_service.py 2014-05-16 19:51:07 UTC (rev 13491)
</span><span class="lines">@@ -111,12 +111,21 @@
</span><span class="cx"> fieldName = ConstantsContainer((BaseDirectoryService.fieldName, FieldName))
</span><span class="cx">
</span><span class="cx">
</span><del>- def __init__(self, nodeName=ODSearchPath.search.value):
</del><ins>+ def __init__(
+ self,
+ nodeName=ODSearchPath.search.value,
+ suppressSystemRecords=False
+ ):
</ins><span class="cx"> """
</span><span class="cx"> @param nodeName: the OpenDirectory node to query against.
</span><span class="cx"> @type nodeName: bytes
</span><ins>+
+ @parm suppressSystemRecords: If True, any results returned from this
+ service will not contain Mac OS X "system" records.
+ @type suppressSystemRecords: C{Boolean}
</ins><span class="cx"> """
</span><span class="cx"> self._nodeName = nodeName
</span><ins>+ self._suppressSystemRecords = suppressSystemRecords
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx"> @property
</span><span class="lines">@@ -505,6 +514,69 @@
</span><span class="cx"> return query
</span><span class="cx">
</span><span class="cx">
</span><ins>+ def _isSystemRecord(self, odRecord):
+ """
+ Examines the OD record to see if it's a Mac OS X system account record.
+
+ @param odRecord: an OD record object
+
+ @return: True if system account record, False otherwise
+ @rtype: C{Boolean}
+ """
+ details, error = odRecord.recordDetailsForAttributes_error_(None, None)
+
+ if error:
+ self.log.error(
+ "Error while reading OpenDirectory record: {error}",
+ error=error
+ )
+ raise OpenDirectoryDataError(
+ "Unable to read OpenDirectory record", error
+ )
+
+ # GeneratedUID matches a special pattern
+ guid = details.get(ODAttribute.guid.value, (u"",))[0]
+ if guid.lower().startswith("ffffeeee-dddd-cccc-bbbb-aaaa"):
+ return True
+
+ # ISHidden is True
+ isHidden = details.get(ODAttribute.isHidden.value, False)
+ if isHidden:
+ return True
+
+ # Record-type specific indicators...
+ recType = details.get(ODAttribute.recordType.value, (u"",))[0]
+
+ # ...users with UniqueID <= 500
+ if recType == ODRecordType.user.value:
+ uniqueId = int(
+ details.get(ODAttribute.uniqueId.value, (u"0",))[0]
+ )
+ if uniqueId <= 500:
+ return True
+
+ # ...groups with PrimaryGroupID <= 500
+ elif recType == ODRecordType.group.value:
+ primaryGroupId = int(
+ details.get(ODAttribute.primaryGroupId.value, (u"0",))[0]
+ )
+ if primaryGroupId <= 500:
+ return True
+
+ # RecordName matches specific prefixes; if *all* RecordName values for
+ # a record start with either of these prefixes, it's a system record.
+ shortNames = details.get(ODAttribute.shortName.value, (u"",))
+ for shortName in shortNames:
+ if not (
+ shortName.startswith("_") or shortName.startswith("com.apple.")
+ ):
+ break
+ else:
+ return True
+
+ return False
+
+
</ins><span class="cx"> def _recordsFromQuery(self, query):
</span><span class="cx"> """
</span><span class="cx"> Executes a query and generates directory records from it.
</span><span class="lines">@@ -536,6 +608,11 @@
</span><span class="cx">
</span><span class="cx"> result = []
</span><span class="cx"> for odRecord in odRecords:
</span><ins>+
+ # Conditionally suppress system records
+ if self._suppressSystemRecords and self._isSystemRecord(odRecord):
+ continue
+
</ins><span class="cx"> try:
</span><span class="cx"> record = DirectoryRecord(self, odRecord)
</span><span class="cx"> except InvalidDirectoryRecordError as e:
</span><span class="lines">@@ -759,8 +836,14 @@
</span><span class="cx">
</span><span class="cx"> fields = {}
</span><span class="cx"> for name, values in details.iteritems():
</span><del>- if name == ODAttribute.metaRecordName.value:
</del><ins>+ if name in (
</ins><span class="cx"> # We get this field even though we did not ask for it...
</span><ins>+ ODAttribute.metaRecordName.value,
+ # We fetch these records to look for system accounts...
+ ODAttribute.uniqueId.value,
+ ODAttribute.primaryGroupId.value,
+ ODAttribute.isHidden.value,
+ ):
</ins><span class="cx"> continue
</span><span class="cx">
</span><span class="cx"> try:
</span></span></pre>
</div>
</div>
</body>
</html>